|
| 1 | +import { createElement, setFeatureFlagForTest } from 'lwc'; |
| 2 | + |
| 3 | +import Test from 'x/test'; |
| 4 | +import { Signal } from 'x/signal'; |
| 5 | +import { spyConsole } from '../../../helpers/console.js'; |
| 6 | + |
| 7 | +const createElementSignalAndInsertIntoDom = async (object) => { |
| 8 | + const elm = createElement('x-test', { is: Test }); |
| 9 | + elm.object = object; |
| 10 | + document.body.appendChild(elm); |
| 11 | + await Promise.resolve(); |
| 12 | + return elm; |
| 13 | +}; |
| 14 | + |
| 15 | +describe('signal reaction in lwc', () => { |
| 16 | + let consoleSpy; |
| 17 | + |
| 18 | + beforeAll(() => setFeatureFlagForTest('ENABLE_EXPERIMENTAL_SIGNALS', true)); |
| 19 | + afterAll(() => setFeatureFlagForTest('ENABLE_EXPERIMENTAL_SIGNALS', false)); |
| 20 | + beforeEach(() => (consoleSpy = spyConsole())); |
| 21 | + afterEach(() => consoleSpy.reset()); |
| 22 | + |
| 23 | + describe('with trusted signal set', () => { |
| 24 | + describe('ENABLE_LEGACY_SIGNAL_CONTEXT_VALIDATION is enabled', () => { |
| 25 | + beforeAll(() => setFeatureFlagForTest('ENABLE_LEGACY_SIGNAL_CONTEXT_VALIDATION', true)); |
| 26 | + afterAll(() => setFeatureFlagForTest('ENABLE_LEGACY_SIGNAL_CONTEXT_VALIDATION', false)); |
| 27 | + it('will not warn if rendering non-signal objects ', async () => { |
| 28 | + const elm = await createElementSignalAndInsertIntoDom({ |
| 29 | + value: 'non signal value', |
| 30 | + }); |
| 31 | + expect(consoleSpy.calls.warn.length).toEqual(0); |
| 32 | + expect(elm.shadowRoot.textContent).toBe('non signal value'); |
| 33 | + }); |
| 34 | + it('will not warn if rendering signal objects', async () => { |
| 35 | + const signal = new Signal('signal value'); |
| 36 | + const elm = await createElementSignalAndInsertIntoDom(signal); |
| 37 | + expect(consoleSpy.calls.warn.length).toEqual(0); |
| 38 | + signal.value = 'new signal value'; |
| 39 | + await Promise.resolve(); |
| 40 | + expect(elm.shadowRoot.textContent).toBe('new signal value'); |
| 41 | + }); |
| 42 | + }); |
| 43 | + |
| 44 | + describe('ENABLE_LEGACY_SIGNAL_CONTEXT_VALIDATION is disabled', () => { |
| 45 | + beforeAll(() => |
| 46 | + setFeatureFlagForTest('ENABLE_LEGACY_SIGNAL_CONTEXT_VALIDATION', false) |
| 47 | + ); |
| 48 | + it('will not warn if rendering non-signal objects', async () => { |
| 49 | + const elm = await createElementSignalAndInsertIntoDom({ |
| 50 | + value: 'non signal value', |
| 51 | + }); |
| 52 | + expect(consoleSpy.calls.warn.length).toEqual(0); |
| 53 | + expect(elm.shadowRoot.textContent).toBe('non signal value'); |
| 54 | + }); |
| 55 | + it('will not warn if rendering signal objects', async () => { |
| 56 | + const signal = new Signal('signal value'); |
| 57 | + const elm = await createElementSignalAndInsertIntoDom(signal); |
| 58 | + expect(consoleSpy.calls.warn.length).toEqual(0); |
| 59 | + signal.value = 'new signal value'; |
| 60 | + await Promise.resolve(); |
| 61 | + expect(elm.shadowRoot.textContent).toBe('new signal value'); |
| 62 | + }); |
| 63 | + }); |
| 64 | + }); |
| 65 | + |
| 66 | + describe('without trusted signal set', () => { |
| 67 | + beforeAll(() => globalThis.__lwcResetTrustedSignalsSetForTest()); |
| 68 | + describe('ENABLE_LEGACY_SIGNAL_CONTEXT_VALIDATION is enabled', () => { |
| 69 | + beforeAll(() => setFeatureFlagForTest('ENABLE_LEGACY_SIGNAL_CONTEXT_VALIDATION', true)); |
| 70 | + afterAll(() => setFeatureFlagForTest('ENABLE_LEGACY_SIGNAL_CONTEXT_VALIDATION', false)); |
| 71 | + /** |
| 72 | + * The legacy validation behavior was that this check should only |
| 73 | + * be performed for runtimes that have provided a trustedSignals set. |
| 74 | + * However, this resulted in a bug as all object values were |
| 75 | + * being considered signals in environments where the trustedSignals |
| 76 | + * set had not been defined. The runtime flag has been added as a killswitch |
| 77 | + * in case the fix needs to be reverted. |
| 78 | + */ |
| 79 | + it('will warn if rendering non-signal objects ', async () => { |
| 80 | + const elm = await createElementSignalAndInsertIntoDom({ |
| 81 | + value: 'non signal value', |
| 82 | + }); |
| 83 | + expect(consoleSpy.calls.warn[0][0].message).toContain( |
| 84 | + 'Attempted to subscribe to an object that has the shape of a signal but received the following error: TypeError: signal.subscribe is not a function' |
| 85 | + ); |
| 86 | + expect(elm.shadowRoot.textContent).toBe('non signal value'); |
| 87 | + }); |
| 88 | + it('will not warn if rendering signal objects', async () => { |
| 89 | + const signal = new Signal('signal value'); |
| 90 | + const elm = await createElementSignalAndInsertIntoDom(signal); |
| 91 | + expect(consoleSpy.calls.warn.length).toEqual(0); |
| 92 | + signal.value = 'new signal value'; |
| 93 | + await Promise.resolve(); |
| 94 | + expect(elm.shadowRoot.textContent).toBe('new signal value'); |
| 95 | + }); |
| 96 | + }); |
| 97 | + |
| 98 | + describe('ENABLE_LEGACY_SIGNAL_CONTEXT_VALIDATION is disabled', () => { |
| 99 | + beforeAll(() => |
| 100 | + setFeatureFlagForTest('ENABLE_LEGACY_SIGNAL_CONTEXT_VALIDATION', false) |
| 101 | + ); |
| 102 | + it('will not warn if rendering non-signal objects', async () => { |
| 103 | + const elm = await createElementSignalAndInsertIntoDom({ |
| 104 | + value: 'non signal value', |
| 105 | + }); |
| 106 | + expect(consoleSpy.calls.warn.length).toEqual(0); |
| 107 | + expect(elm.shadowRoot.textContent).toBe('non signal value'); |
| 108 | + }); |
| 109 | + /** |
| 110 | + * Signals are designed to be used where trustedSignalSet has been defined via setTrustedSignalSet |
| 111 | + * This is because checking against the set is an efficient way to determine if an object is a Signal |
| 112 | + * This is acceptable as Signals is an internal API and designed to work where setTrustedSignalSet has been used. |
| 113 | + * Because of this, the signal value does not change here. |
| 114 | + * See #5347 for context. |
| 115 | + */ |
| 116 | + it('will not warn if rendering signal objects but it will not react', async () => { |
| 117 | + const signal = new Signal('signal value'); |
| 118 | + const elm = await createElementSignalAndInsertIntoDom(signal); |
| 119 | + expect(consoleSpy.calls.warn.length).toEqual(0); |
| 120 | + signal.value = 'new signal value'; |
| 121 | + await Promise.resolve(); |
| 122 | + expect(elm.shadowRoot.textContent).toBe('signal value'); |
| 123 | + }); |
| 124 | + }); |
| 125 | + }); |
| 126 | +}); |
0 commit comments