fix(ssr): prohibit variable names in customer code from colliding wit…

…h SSR-internal variables (#5196) * fix(ssr): prohibit variable names in customer code from colliding with SSR-internal variables * chore: make generateMarkup inaccessible as a variable
salesforce · Feb 5, 2025 · e54ebff · e54ebff
1 parent 0777504
commit e54ebff
Show file tree

Hide file tree

Showing 9 changed files with 31 additions and 2 deletions.
diff --git a/packages/@lwc/engine-server/src/__tests__/fixtures/prohibited-variable-name/config.json b/packages/@lwc/engine-server/src/__tests__/fixtures/prohibited-variable-name/config.json
@@ -0,0 +1,6 @@
+{
+    "ssrFiles": {
+        "error": "error-ssr.txt",
+        "expected": "expected-ssr.html"
+    }
+}
diff --git a/packages/@lwc/engine-server/src/__tests__/fixtures/prohibited-variable-name/error-ssr.txt b/packages/@lwc/engine-server/src/__tests__/fixtures/prohibited-variable-name/error-ssr.txt
@@ -0,0 +1 @@
+LWCTODO: identifier name '__lwcThrowAnError__' cannot start with '__lwc'
diff --git a/packages/@lwc/engine-server/src/__tests__/fixtures/prohibited-variable-name/error.txt b/packages/@lwc/engine-server/src/__tests__/fixtures/prohibited-variable-name/error.txt
diff --git a/...ages/@lwc/engine-server/src/__tests__/fixtures/prohibited-variable-name/expected-ssr.html b/...ages/@lwc/engine-server/src/__tests__/fixtures/prohibited-variable-name/expected-ssr.html
diff --git a/packages/@lwc/engine-server/src/__tests__/fixtures/prohibited-variable-name/expected.html b/packages/@lwc/engine-server/src/__tests__/fixtures/prohibited-variable-name/expected.html
@@ -0,0 +1,4 @@
+<x-dont-do-it-stupid>
+  <template shadowrootmode="open">
+  </template>
+</x-dont-do-it-stupid>
diff --git a/packages/@lwc/engine-server/src/__tests__/fixtures/prohibited-variable-name/index.js b/packages/@lwc/engine-server/src/__tests__/fixtures/prohibited-variable-name/index.js
@@ -0,0 +1,3 @@
+export const tagName = 'x-dont-do-it-stupid';
+export { default } from 'x/dontDoItStupid';
+export * from 'x/dontDoItStupid';
diff --git a/...rc/__tests__/fixtures/prohibited-variable-name/modules/x/dontDoItStupid/dontDoItStupid.js b/...rc/__tests__/fixtures/prohibited-variable-name/modules/x/dontDoItStupid/dontDoItStupid.js
@@ -0,0 +1,9 @@
+import { LightningElement } from 'lwc';
+
+export default class TextStatic extends LightningElement {
+    connectedCallback() {
+        // This will throw a compile-time error in SSRv2!
+        const __lwcThrowAnError__ = 'yup';
+        console.log(__lwcThrowAnError__);
+    }
+}
diff --git a/packages/@lwc/ssr-compiler/src/compile-js/generate-markup.ts b/packages/@lwc/ssr-compiler/src/compile-js/generate-markup.ts
@@ -20,7 +20,7 @@ const bGenerateMarkup = esTemplate`
     const __lwcPublicProperties__ = new Set(${/*public properties*/ is.arrayExpression}.concat(__lwcSuperPublicProperties__));
     const __lwcPrivateProperties__ = new Set(${/*private properties*/ is.arrayExpression});
 
-    async function* generateMarkup(
+    ${/* component class */ 0}[__SYMBOL__GENERATE_MARKUP] = async function* generateMarkup(
             tagName, 
             props, 
             attrs, 
@@ -75,7 +75,6 @@ const bGenerateMarkup = esTemplate`
         );
         yield \`</\${tagName}>\`;
     }
-    ${/* component class */ 0}[__SYMBOL__GENERATE_MARKUP] = generateMarkup;
     ${/* component class */ 0}.__lwcPublicProperties__ = __lwcPublicProperties__;
 `<[Statement]>;
 

diff --git a/packages/@lwc/ssr-compiler/src/compile-js/index.ts b/packages/@lwc/ssr-compiler/src/compile-js/index.ts
@@ -261,6 +261,13 @@ const visitors: Visitors = {
             }
         },
     },
+    Identifier(path, _state) {
+        const { node } = path;
+        if (node?.name.startsWith('__lwc') && node.name.endsWith('__')) {
+            // TODO [#5032]: Harmonize errors thrown in `@lwc/ssr-compiler`
+            throw new Error(`LWCTODO: identifier name '${node.name}' cannot start with '__lwc'`);
+        }
+    },
 };
 
 function validateUniqueDecorator(decorators: EsDecorator[]) {
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		LWCTODO: identifier name '__lwcThrowAnError__' cannot start with '__lwc'