chore: add a flag for signals try/catch fix

salesforce · Jan 9, 2025 · ec650b7 · ec650b7
1 parent a2c74f2
commit ec650b7
Show file tree

Hide file tree

Showing 4 changed files with 58 additions and 8 deletions.
diff --git a/packages/@lwc/engine-core/src/framework/mutation-tracker.ts b/packages/@lwc/engine-core/src/framework/mutation-tracker.ts
@@ -42,9 +42,13 @@ export function componentValueObserved(vm: VM, key: PropertyKey, target: any = {
         lwcRuntimeFlags.ENABLE_EXPERIMENTAL_SIGNALS &&
         isObject(target) &&
         !isNull(target) &&
-        safeHasProp(target, 'value') &&
-        safeHasProp(target, 'subscribe') &&
-        isFunction(target.subscribe) &&
+        (lwcRuntimeFlags.USE_TRY_CATCH_FOR_SIGNALS_CHECK
+            ? safeHasProp(target, 'value')
+            : 'value' in target) &&
+        (lwcRuntimeFlags.USE_TRY_CATCH_FOR_SIGNALS_CHECK
+            ? safeHasProp(target, 'subscribe')
+            : 'subscribe' in target) &&
+        isFunction((target as any).subscribe) &&
         isTrustedSignal(target) &&
         // Only subscribe if a template is being rendered by the engine
         tro.isObserving()

diff --git a/packages/@lwc/features/src/index.ts b/packages/@lwc/features/src/index.ts
@@ -20,6 +20,7 @@ const features: FeatureFlagMap = {
     ENABLE_FORCE_SHADOW_MIGRATE_MODE: null,
     ENABLE_EXPERIMENTAL_SIGNALS: null,
     DISABLE_SYNTHETIC_SHADOW: null,
+    USE_TRY_CATCH_FOR_SIGNALS_CHECK: null,
 };
 
 if (!(globalThis as any).lwcRuntimeFlags) {

diff --git a/packages/@lwc/features/src/types.ts b/packages/@lwc/features/src/types.ts
@@ -75,6 +75,11 @@ export interface FeatureFlagMap {
      * native shadow mode.
      */
     DISABLE_SYNTHETIC_SHADOW: FeatureFlagValue;
+
+    /**
+     * Use a try/catch when sniffing for whether an object is a signal or not
+     */
+    USE_TRY_CATCH_FOR_SIGNALS_CHECK: FeatureFlagValue;
 }
 
 export type FeatureFlagName = keyof FeatureFlagMap;
diff --git a/packages/@lwc/integration-karma/test/signal/protocol/index.spec.js b/packages/@lwc/integration-karma/test/signal/protocol/index.spec.js
@@ -1,4 +1,5 @@
 import { createElement, setFeatureFlagForTest } from 'lwc';
+import { catchUnhandledRejectionsAndErrors } from 'test-utils';
 import Reactive from 'x/reactive';
 import NonReactive from 'x/nonReactive';
 import Container from 'x/container';
@@ -214,13 +215,52 @@ describe('signal protocol', () => {
         expect(subscribe).not.toHaveBeenCalled();
     });
 
-    it('does not throw an error for objects that throw upon "in" checks', async () => {
-        const elm = createElement('x-throws', { is: Throws });
-        document.body.appendChild(elm);
+    describe('try/catch for the signals check', () => {
+        describe('flag on', () => {
+            beforeAll(() => {
+                setFeatureFlagForTest('USE_TRY_CATCH_FOR_SIGNALS_CHECK', true);
+            });
 
-        await Promise.resolve();
+            afterAll(() => {
+                setFeatureFlagForTest('USE_TRY_CATCH_FOR_SIGNALS_CHECK', false);
+            });
+
+            it('does not throw an error for objects that throw upon "in" checks', async () => {
+                const elm = createElement('x-throws', { is: Throws });
+                document.body.appendChild(elm);
+
+                await Promise.resolve();
+
+                expect(elm.shadowRoot.querySelector('h1').textContent).toBe('hello');
+            });
+        });
 
-        expect(elm.shadowRoot.querySelector('h1').textContent).toBe('hello');
+        describe('flag off', () => {
+            let caughtError;
+
+            catchUnhandledRejectionsAndErrors((error) => {
+                caughtError = error;
+            });
+
+            afterEach(() => {
+                caughtError = undefined;
+            });
+
+            it('does throw an error for objects that throw upon "in" checks', async () => {
+                const elm = createElement('x-throws', { is: Throws });
+                document.body.appendChild(elm);
+
+                // wait 2 ticks for all errors to be caught
+                await new Promise(setTimeout);
+                await new Promise(setTimeout);
+
+                // still renders
+                expect(elm.shadowRoot.querySelector('h1').textContent).toBe('hello');
+
+                // throws error
+                expect(caughtError).not.toBeUndefined();
+            });
+        });
     });
 });