fix: use Eugene's technique instead

salesforce · Apr 29, 2022 · 72afdc0 · 72afdc0
1 parent 76c66b6
commit 72afdc0
Show file tree

Hide file tree

Showing 8 changed files with 25 additions and 106 deletions.
diff --git a/packages/@lwc/engine-core/src/testFeatureFlag.ts b/packages/@lwc/engine-core/src/testFeatureFlag.ts
@@ -7,20 +7,8 @@
 
 import features from '@lwc/features';
 
-if (process.env.NODE_ENV !== 'production' && typeof window !== 'undefined') {
-    window.addEventListener('test-dummy-flag', () => {
-        let hasFlag = false;
-        if (features.DUMMY_TEST_FLAG) {
-            hasFlag = true;
-        }
-
-        window.dispatchEvent(
-            new CustomEvent('has-dummy-flag', {
-                detail: {
-                    package: '@lwc/engine-core',
-                    hasFlag,
-                },
-            })
-        );
-    });
+if (process.env.NODE_ENV !== 'production') {
+    if (features.ENABLE_TEST_EXCEPTION) {
+        throw new Error('Compile-time processing of feature flags is broken.');
+    }
 }
diff --git a/packages/@lwc/engine-dom/src/index.ts b/packages/@lwc/engine-dom/src/index.ts
@@ -5,15 +5,15 @@
  * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/MIT
  */
 
+// Tests -------------------------------------------------------------------------------------------
+import './testFeatureFlag.ts';
+
 // Polyfills ---------------------------------------------------------------------------------------
 import './polyfills/aria-properties/main';
 
 // Renderer initialization -------------------------------------------------------------------------
 import './initializeRenderer';
 
-// Tests -------------------------------------------------------------------------------------------
-import './testFeatureFlag.ts';
-
 // Engine-core public APIs -------------------------------------------------------------------------
 export {
     createContextProvider,

diff --git a/packages/@lwc/engine-dom/src/testFeatureFlag.ts b/packages/@lwc/engine-dom/src/testFeatureFlag.ts
@@ -7,20 +7,8 @@
 
 import features from '@lwc/features';
 
-if (process.env.NODE_ENV !== 'production' && typeof window !== 'undefined') {
-    window.addEventListener('test-dummy-flag', () => {
-        let hasFlag = false;
-        if (features.DUMMY_TEST_FLAG) {
-            hasFlag = true;
-        }
-
-        window.dispatchEvent(
-            new CustomEvent('has-dummy-flag', {
-                detail: {
-                    package: '@lwc/engine-dom',
-                    hasFlag,
-                },
-            })
-        );
-    });
+if (process.env.NODE_ENV !== 'production') {
+    if (features.ENABLE_TEST_EXCEPTION) {
+        throw new Error('Compile-time processing of feature flags is broken.');
+    }
 }
diff --git a/packages/@lwc/features/src/flags.ts b/packages/@lwc/features/src/flags.ts
@@ -8,7 +8,6 @@ import { create, keys, defineProperty, isUndefined, isBoolean, globalThis } from
 import { FeatureFlagMap, FeatureFlagName, FeatureFlagValue } from './types';
 
 const features: FeatureFlagMap = {
-    DUMMY_TEST_FLAG: null,
     ENABLE_ELEMENT_PATCH: null,
     ENABLE_FORCE_NATIVE_SHADOW_MODE_FOR_TEST: null,
     ENABLE_HMR: null,
@@ -19,6 +18,7 @@ const features: FeatureFlagMap = {
     ENABLE_NODE_PATCH: null,
     ENABLE_REACTIVE_SETTER: null,
     ENABLE_WIRE_SYNC_EMIT: null,
+    ENABLE_TEST_EXCEPTION: null,
 };
 
 if (!globalThis.lwcRuntimeFlags) {

diff --git a/packages/@lwc/features/src/types.ts b/packages/@lwc/features/src/types.ts
@@ -16,11 +16,6 @@
 export type FeatureFlagValue = boolean | null;
 
 export interface FeatureFlagMap {
-    /**
-     * This is only used to test that feature flags are actually working
-     */
-    DUMMY_TEST_FLAG: FeatureFlagValue;
-
     /**
      * LWC engine flag to enable mixed shadow mode. Setting this flag to `true` enables usage of
      * native shadow DOM even when the synthetic shadow polyfill is applied.
@@ -91,6 +86,12 @@ export interface FeatureFlagMap {
      * of next tick. It only affects wire configurations that depend on component values.
      */
     ENABLE_WIRE_SYNC_EMIT: FeatureFlagValue;
+
+    /**
+     * This is only used to test that feature flags are actually working. If set to true, it
+     * should throw an error.
+     */
+    ENABLE_TEST_EXCEPTION: FeatureFlagValue;
 }
 
 export type FeatureFlagName = keyof FeatureFlagMap;
diff --git a/packages/@lwc/synthetic-shadow/src/index.ts b/packages/@lwc/synthetic-shadow/src/index.ts
@@ -5,6 +5,9 @@
  * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/MIT
  */
 
+// Tests
+import './testFeatureFlag';
+
 // Collecting env references before patching anything
 import './env/node';
 import './env/element';
@@ -39,6 +42,3 @@ import './faux-shadow/html-element';
 import './faux-shadow/slot';
 import './faux-shadow/portal';
 import './faux-shadow/shadow-token';
-
-// Tests
-import './testFeatureFlag';
diff --git a/packages/@lwc/synthetic-shadow/src/testFeatureFlag.ts b/packages/@lwc/synthetic-shadow/src/testFeatureFlag.ts
@@ -7,20 +7,8 @@
 
 import features from '@lwc/features';
 
-if (process.env.NODE_ENV !== 'production' && typeof window !== 'undefined') {
-    window.addEventListener('test-dummy-flag', () => {
-        let hasFlag = false;
-        if (features.DUMMY_TEST_FLAG) {
-            hasFlag = true;
-        }
-
-        window.dispatchEvent(
-            new CustomEvent('has-dummy-flag', {
-                detail: {
-                    package: '@lwc/synthetic-shadow',
-                    hasFlag,
-                },
-            })
-        );
-    });
+if (process.env.NODE_ENV !== 'production') {
+    if (features.ENABLE_TEST_EXCEPTION) {
+        throw new Error('Compile-time processing of feature flags is broken.');
+    }
 }
diff --git a/packages/integration-karma/test/features/index.spec.js b/packages/integration-karma/test/features/index.spec.js