fix(ssr): make context providers work again (#5004)

wjhsf · jhefferman-sfdc · nolanlawson · web-flow · commit 77010690be2e · 2024-12-04T14:07:27.000-08:00
Co-authored-by: John Hefferman &lt;jhefferman@salesforce.com&gt;
Co-authored-by: Nolan Lawson &lt;nlawson@salesforce.com&gt;
diff --git a/packages/@lwc/engine-server/src/__tests__/fixtures/context-slotted/light/error.txt b/packages/@lwc/engine-server/src/__tests__/fixtures/context-slotted/light/error.txt
diff --git a/packages/@lwc/engine-server/src/__tests__/fixtures/context-slotted/light/expected.html b/packages/@lwc/engine-server/src/__tests__/fixtures/context-slotted/light/expected.html
@@ -0,0 +1,11 @@
+<x-root>
+  <x-provider>
+    <!---->
+    <x-consumer>
+      <div>
+        some context
+      </div>
+    </x-consumer>
+    <!---->
+  </x-provider>
+</x-root>
diff --git a/packages/@lwc/engine-server/src/__tests__/fixtures/context-slotted/light/index.js b/packages/@lwc/engine-server/src/__tests__/fixtures/context-slotted/light/index.js
diff --git a/packages/@lwc/engine-server/src/__tests__/fixtures/context-slotted/light/modules/x/consumer/consumer.html b/packages/@lwc/engine-server/src/__tests__/fixtures/context-slotted/light/modules/x/consumer/consumer.html
@@ -0,0 +1,3 @@
+<template lwc:render-mode="light">
+    <div>{foo}</div>
+</template>
diff --git a/packages/@lwc/engine-server/src/__tests__/fixtures/context-slotted/light/modules/x/consumer/consumer.js b/packages/@lwc/engine-server/src/__tests__/fixtures/context-slotted/light/modules/x/consumer/consumer.js
@@ -0,0 +1,7 @@
+import { LightningElement, wire } from 'lwc';
+import { WireAdapter } from '../../../wire-adapter';
+
+export default class SlottedConsumerComponent extends LightningElement {
+    static renderMode = 'light';
+    @wire(WireAdapter) foo;
+}
diff --git a/packages/@lwc/engine-server/src/__tests__/fixtures/context-slotted/light/modules/x/provider/provider.html b/packages/@lwc/engine-server/src/__tests__/fixtures/context-slotted/light/modules/x/provider/provider.html
@@ -0,0 +1,3 @@
+<template lwc:render-mode="light">
+    <slot></slot>
+</template>
diff --git a/packages/@lwc/engine-server/src/__tests__/fixtures/context-slotted/light/modules/x/provider/provider.js b/packages/@lwc/engine-server/src/__tests__/fixtures/context-slotted/light/modules/x/provider/provider.js
@@ -0,0 +1,15 @@
+import { LightningElement } from 'lwc';
+import { contextualizer } from '../../../wire-adapter';
+
+export default class ProviderComponent extends LightningElement {
+    static renderMode = 'light';
+    connectedCallback() {
+        contextualizer(this, {
+            consumerConnectedCallback(consumer) {
+                consumer.provide({
+                    value: 'some context',
+                });
+            },
+        });
+    }
+}
diff --git a/packages/@lwc/engine-server/src/__tests__/fixtures/context-slotted/light/modules/x/root/root.html b/packages/@lwc/engine-server/src/__tests__/fixtures/context-slotted/light/modules/x/root/root.html
@@ -0,0 +1,5 @@
+<template lwc:render-mode="light">
+    <x-provider>
+        <x-consumer></x-consumer>
+    </x-provider>
+</template>
diff --git a/packages/@lwc/engine-server/src/__tests__/fixtures/context-slotted/light/modules/x/root/root.js b/packages/@lwc/engine-server/src/__tests__/fixtures/context-slotted/light/modules/x/root/root.js
@@ -0,0 +1,5 @@
+import { LightningElement } from 'lwc';
+
+export default class Rootcomponent extends LightningElement {
+    static renderMode = 'light';
+}
diff --git a/packages/@lwc/engine-server/src/__tests__/fixtures/context-slotted/light/wire-adapter.js b/packages/@lwc/engine-server/src/__tests__/fixtures/context-slotted/light/wire-adapter.js
diff --git a/packages/@lwc/engine-server/src/__tests__/fixtures/context-slotted/scoped/error.txt b/packages/@lwc/engine-server/src/__tests__/fixtures/context-slotted/scoped/error.txt
diff --git a/packages/@lwc/engine-server/src/__tests__/fixtures/context-slotted/scoped/expected.html b/packages/@lwc/engine-server/src/__tests__/fixtures/context-slotted/scoped/expected.html
@@ -0,0 +1,16 @@
+<x-root>
+  <x-provider>
+    <!---->
+    <!---->
+    <x-consumer>
+      <span>
+        some context
+      </span>
+    </x-consumer>
+    <span>
+      id - name
+    </span>
+    <!---->
+    <!---->
+  </x-provider>
+</x-root>
diff --git a/packages/@lwc/engine-server/src/__tests__/fixtures/context-slotted/scoped/index.js b/packages/@lwc/engine-server/src/__tests__/fixtures/context-slotted/scoped/index.js
@@ -0,0 +1,3 @@
+export const tagName = 'x-root';
+export { default } from 'x/root';
+export * from 'x/root';
diff --git a/packages/@lwc/engine-server/src/__tests__/fixtures/context-slotted/scoped/modules/x/consumer/consumer.html b/packages/@lwc/engine-server/src/__tests__/fixtures/context-slotted/scoped/modules/x/consumer/consumer.html
@@ -0,0 +1,3 @@
+<template lwc:render-mode="light">
+    <span>{foo}</span>
+</template>
diff --git a/packages/@lwc/engine-server/src/__tests__/fixtures/context-slotted/scoped/modules/x/consumer/consumer.js b/packages/@lwc/engine-server/src/__tests__/fixtures/context-slotted/scoped/modules/x/consumer/consumer.js
@@ -0,0 +1,7 @@
+import { LightningElement, wire } from 'lwc';
+import { WireAdapter } from '../../../wire-adapter';
+
+export default class SlottedConsumerComponent extends LightningElement {
+    static renderMode = 'light';
+    @wire(WireAdapter) foo;
+}
diff --git a/packages/@lwc/engine-server/src/__tests__/fixtures/context-slotted/scoped/modules/x/provider/provider.html b/packages/@lwc/engine-server/src/__tests__/fixtures/context-slotted/scoped/modules/x/provider/provider.html
@@ -0,0 +1,3 @@
+<template lwc:render-mode="light">
+    <slot lwc:slot-bind={item}></slot>
+</template>
diff --git a/packages/@lwc/engine-server/src/__tests__/fixtures/context-slotted/scoped/modules/x/provider/provider.js b/packages/@lwc/engine-server/src/__tests__/fixtures/context-slotted/scoped/modules/x/provider/provider.js
@@ -0,0 +1,19 @@
+import { LightningElement } from 'lwc';
+import { contextualizer } from '../../../wire-adapter';
+
+export default class ProviderComponent extends LightningElement {
+    static renderMode = 'light';
+    item = {
+        id: 'id',
+        name: 'name',
+    };
+    connectedCallback() {
+        contextualizer(this, {
+            consumerConnectedCallback(consumer) {
+                consumer.provide({
+                    value: 'some context',
+                });
+            },
+        });
+    }
+}
diff --git a/packages/@lwc/engine-server/src/__tests__/fixtures/context-slotted/scoped/modules/x/root/root.html b/packages/@lwc/engine-server/src/__tests__/fixtures/context-slotted/scoped/modules/x/root/root.html
@@ -0,0 +1,8 @@
+<template lwc:render-mode="light">
+    <x-provider>
+        <template lwc:slot-data="data">
+            <x-consumer></x-consumer>
+            <span>{data.id} - {data.name}</span>
+        </template>
+    </x-provider>
+</template>
diff --git a/packages/@lwc/engine-server/src/__tests__/fixtures/context-slotted/scoped/modules/x/root/root.js b/packages/@lwc/engine-server/src/__tests__/fixtures/context-slotted/scoped/modules/x/root/root.js
@@ -0,0 +1,5 @@
+import { LightningElement } from 'lwc';
+
+export default class Rootcomponent extends LightningElement {
+    static renderMode = 'light';
+}
diff --git a/packages/@lwc/engine-server/src/__tests__/fixtures/context-slotted/scoped/wire-adapter.js b/packages/@lwc/engine-server/src/__tests__/fixtures/context-slotted/scoped/wire-adapter.js
@@ -0,0 +1,30 @@
+import { createContextProvider } from 'lwc';
+
+export class WireAdapter {
+    contextValue = { value: 'missing' };
+    static contextSchema = { value: 'required' };
+
+    constructor(callback) {
+        this._callback = callback;
+    }
+
+    connect() {
+        // noop
+    }
+
+    disconnect() {
+        // noop
+    }
+
+    update(_config, context) {
+        if (context) {
+            if (!context.hasOwnProperty('value')) {
+                throw new Error(`Invalid context provided`);
+            }
+            this.contextValue = context.value;
+            this._callback(this.contextValue);
+        }
+    }
+}
+
+export const contextualizer = createContextProvider(WireAdapter);
diff --git a/packages/@lwc/engine-server/src/__tests__/fixtures/context-slotted/shadow/error.txt b/packages/@lwc/engine-server/src/__tests__/fixtures/context-slotted/shadow/error.txt
diff --git a/packages/@lwc/engine-server/src/__tests__/fixtures/context-slotted/shadow/expected.html b/packages/@lwc/engine-server/src/__tests__/fixtures/context-slotted/shadow/expected.html
diff --git a/packages/@lwc/engine-server/src/__tests__/fixtures/context-slotted/shadow/index.js b/packages/@lwc/engine-server/src/__tests__/fixtures/context-slotted/shadow/index.js
@@ -0,0 +1,3 @@
+export const tagName = 'x-root';
+export { default } from 'x/root';
+export * from 'x/root';
diff --git a/packages/@lwc/engine-server/src/__tests__/fixtures/context-slotted/shadow/modules/x/consumer/consumer.html b/packages/@lwc/engine-server/src/__tests__/fixtures/context-slotted/shadow/modules/x/consumer/consumer.html
diff --git a/packages/@lwc/engine-server/src/__tests__/fixtures/context-slotted/shadow/modules/x/consumer/consumer.js b/packages/@lwc/engine-server/src/__tests__/fixtures/context-slotted/shadow/modules/x/consumer/consumer.js
diff --git a/packages/@lwc/engine-server/src/__tests__/fixtures/context-slotted/shadow/modules/x/provider/provider.html b/packages/@lwc/engine-server/src/__tests__/fixtures/context-slotted/shadow/modules/x/provider/provider.html
diff --git a/packages/@lwc/engine-server/src/__tests__/fixtures/context-slotted/shadow/modules/x/provider/provider.js b/packages/@lwc/engine-server/src/__tests__/fixtures/context-slotted/shadow/modules/x/provider/provider.js
diff --git a/packages/@lwc/engine-server/src/__tests__/fixtures/context-slotted/shadow/modules/x/root/root.html b/packages/@lwc/engine-server/src/__tests__/fixtures/context-slotted/shadow/modules/x/root/root.html
diff --git a/packages/@lwc/engine-server/src/__tests__/fixtures/context-slotted/shadow/modules/x/root/root.js b/packages/@lwc/engine-server/src/__tests__/fixtures/context-slotted/shadow/modules/x/root/root.js
diff --git a/packages/@lwc/engine-server/src/__tests__/fixtures/context-slotted/shadow/wire-adapter.js b/packages/@lwc/engine-server/src/__tests__/fixtures/context-slotted/shadow/wire-adapter.js
@@ -0,0 +1,30 @@
+import { createContextProvider } from 'lwc';
+
+export class WireAdapter {
+    contextValue = { value: 'missing' };
+    static contextSchema = { value: 'required' };
+
+    constructor(callback) {
+        this._callback = callback;
+    }
+
+    connect() {
+        // noop
+    }
+
+    disconnect() {
+        // noop
+    }
+
+    update(_config, context) {
+        if (context) {
+            if (!context.hasOwnProperty('value')) {
+                throw new Error(`Invalid context provided`);
+            }
+            this.contextValue = context.value;
+            this._callback(this.contextValue);
+        }
+    }
+}
+
+export const contextualizer = createContextProvider(WireAdapter);
diff --git a/packages/@lwc/ssr-compiler/src/__tests__/utils/expected-failures.ts b/packages/@lwc/ssr-compiler/src/__tests__/utils/expected-failures.ts
@@ -17,7 +17,6 @@ export const expectedFailures = new Set([
     'attribute-namespace/index.js',
     'attribute-style/basic/index.js',
     'attribute-style/dynamic/index.js',
-    'context-slotted/index.js',
     'exports/component-as-default/index.js',
     'known-boolean-attributes/default-def-html-attributes/static-on-component/index.js',
     'render-dynamic-value/index.js',
diff --git a/packages/@lwc/ssr-compiler/src/compile-js/generate-markup.ts b/packages/@lwc/ssr-compiler/src/compile-js/generate-markup.ts
@@ -37,7 +37,8 @@ const bGenerateMarkup = esTemplate`
             shadowSlottedContent,
             lightSlottedContent, 
             parent, 
-            scopeToken
+            scopeToken,
+            contextfulParent
     ) {
         tagName = tagName ?? ${/*component tag name*/ is.literal};
         attrs = attrs ?? Object.create(null);
@@ -51,7 +52,7 @@ const bGenerateMarkup = esTemplate`
             tagName: tagName.toUpperCase(),
         });
 
-        __establishContextfulRelationship(parent, instance);
+        __establishContextfulRelationship(contextfulParent, instance);
         ${/*connect wire*/ is.statement}
 
         instance[__SYMBOL__SET_INTERNALS](props, attrs);
diff --git a/packages/@lwc/ssr-compiler/src/compile-template/index.ts b/packages/@lwc/ssr-compiler/src/compile-template/index.ts
@@ -33,6 +33,10 @@ const bExportTemplate = esTemplate`
         let textContentBuffer = '';
         let didBufferTextContent = false;
 
+        // Establishes a contextual relationship between two components for ContextProviders.
+        // This variable will typically get overridden (shadowed) within slotted content.
+        const contextfulParent = instance;
+
         const isLightDom = Cmp.renderMode === 'light';
         if (!isLightDom) {
             yield \`<template shadowrootmode="open"\${Cmp.delegatesFocus ? ' shadowrootdelegatesfocus' : ''}>\`
@@ -55,7 +59,9 @@ const bExportTemplate = esTemplate`
         if (!isLightDom) {
             yield '</template>';
             if (shadowSlottedContent) {
-                yield* shadowSlottedContent();
+                // instance must be passed in; this is used to establish the contextful relationship
+                // between context provider (aka parent component) and context consumer (aka slotted content)
+                yield* shadowSlottedContent(contextfulParent);
             }
         }
     }
diff --git a/packages/@lwc/ssr-compiler/src/compile-template/transformers/component/component.ts b/packages/@lwc/ssr-compiler/src/compile-template/transformers/component/component.ts
@@ -40,6 +40,7 @@ const bYieldFromChildGenerator = esTemplateWithYield`
             lightSlottedContentMap,
             instance,
             scopeToken,
+            contextfulParent
         );
     }
 `<EsBlockStatement>;
diff --git a/packages/@lwc/ssr-compiler/src/compile-template/transformers/component/lwc-component.ts b/packages/@lwc/ssr-compiler/src/compile-template/transformers/component/lwc-component.ts
@@ -43,7 +43,9 @@ const bYieldFromDynamicComponentConstructorGenerator = esTemplateWithYield`
             childAttrs,
             shadowSlottedContent,
             lightSlottedContentMap,
-            scopeToken
+            instance,
+            scopeToken,
+            contextfulParent
         );
     }
 `<EsStatement[]>;
diff --git a/packages/@lwc/ssr-compiler/src/compile-template/transformers/component/slotted-content.ts b/packages/@lwc/ssr-compiler/src/compile-template/transformers/component/slotted-content.ts
@@ -35,7 +35,11 @@ import type { TransformerContext } from '../../types';
 
 const bGenerateSlottedContent = esTemplateWithYield`
         const shadowSlottedContent = ${/* hasShadowSlottedContent */ is.literal}
-            ? async function* generateShadowSlottedContent() {
+            ? async function* generateSlottedContent(contextfulParent) {
+                // The 'contextfulParent' variable is shadowed here so that a contextful relationship
+                // is established between components rendered in slotted content & the "parent"
+                // component that contains the <slot>.
+
                 ${/* shadow slot content */ is.statement}
             } 
             // Avoid creating the object unnecessarily
@@ -63,7 +67,7 @@ const bGenerateSlottedContent = esTemplateWithYield`
 // it may be repeated multiple times in the same scope, because it's a function _expression_ rather
 // than a function _declaration_, so it isn't available to be referenced anywhere.
 const bAddLightContent = esTemplate`
-    addLightContent(${/* slot name */ is.expression} ?? "", async function* generateSlottedContent(${
+    addLightContent(${/* slot name */ is.expression} ?? "", async function* generateSlottedContent(contextfulParent, ${
         /* scoped slot data variable */ isNullableOf(is.identifier)
     }) {
         // FIXME: make validation work again  
diff --git a/packages/@lwc/ssr-compiler/src/compile-template/transformers/slot.ts b/packages/@lwc/ssr-compiler/src/compile-template/transformers/slot.ts
@@ -35,7 +35,7 @@ const bConditionalSlot = esTemplateWithYield`
         const generators = lightSlottedContent?.[${/* slotName */ is.expression} ?? ""];
         if (generators) {
             for (const generator of generators) {
-                yield* generator(${/* scoped slot data */ isNullableOf(is.expression)});
+                yield* generator(contextfulParent, ${/* scoped slot data */ isNullableOf(is.expression)});
             }
         } else {
             // If we're in this else block, then the generator _must_ have yielded
diff --git a/packages/@lwc/ssr-runtime/src/render.ts b/packages/@lwc/ssr-runtime/src/render.ts
@@ -119,25 +119,40 @@ export type GenerateMarkupFn = (
     props: Properties | null,
     attrs: Attributes | null,
     shadowSlottedContent: AsyncGenerator<string> | null,
-    lightSlottedContent: Record<number | string, AsyncGenerator<string>> | null
+    lightSlottedContent: Record<number | string, AsyncGenerator<string>> | null,
+    // Not always null when invoked internally, but should always be
+    // null when invoked by ssr-runtime
+    parent: LightningElement | null,
+    scopeToken: string | null,
+    contextfulParent: LightningElement | null
 ) => AsyncGenerator<string>;
 
 export type GenerateMarkupFnAsyncNoGen = (
     emit: (segment: string) => void,
     tagName: string,
-    props: Record<string, any> | null,
+    props: Properties | null,
     attrs: Attributes | null,
     shadowSlottedContent: AsyncGenerator<string> | null,
-    lightSlottedContent: Record<number | string, AsyncGenerator<string>> | null
+    lightSlottedContent: Record<number | string, AsyncGenerator<string>> | null,
+    // Not always null when invoked internally, but should always be
+    // null when invoked by ssr-runtime
+    parent: LightningElement | null,
+    scopeToken: string | null,
+    contextfulParent: LightningElement | null
 ) => Promise<void>;
 
 export type GenerateMarkupFnSyncNoGen = (
     emit: (segment: string) => void,
     tagName: string,
-    props: Record<string, any> | null,
+    props: Properties | null,
     attrs: Attributes | null,
     shadowSlottedContent: AsyncGenerator<string> | null,
-    lightSlottedContent: Record<number | string, AsyncGenerator<string>> | null
+    lightSlottedContent: Record<number | string, AsyncGenerator<string>> | null,
+    // Not always null when invoked internally, but should always be
+    // null when invoked by ssr-runtime
+    parent: LightningElement | null,
+    scopeToken: string | null,
+    contextfulParent: LightningElement | null
 ) => void;
 
 type GenerateMarkupFnVariants =
@@ -172,6 +187,9 @@ export async function serverSideRenderComponent(
             props,
             null,
             null,
+            null,
+            null,
+            null,
             null
         )) {
             markup += segment;
@@ -183,10 +201,23 @@ export async function serverSideRenderComponent(
             props,
             null,
             null,
+            null,
+            null,
+            null,
             null
         );
     } else if (mode === 'sync') {
-        (generateMarkup as GenerateMarkupFnSyncNoGen)(emit, tagName, props, null, null, null);
+        (generateMarkup as GenerateMarkupFnSyncNoGen)(
+            emit,
+            tagName,
+            props,
+            null,
+            null,
+            null,
+            null,
+            null,
+            null
+        );
     } else {
         throw new Error(`Invalid mode: ${mode}`);
     }

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+<template lwc:render-mode="light">`
	`2`	`+ <div>{foo}</div>`
	`3`	`+</template>`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+<template lwc:render-mode="light">`
	`2`	`+ <slot></slot>`
	`3`	`+</template>`