Skip to content

fix(react/runtime): fix MainThreadRef modification failure in certain cases #1884

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Yradex merged 1 commit into from
Oct 16, 2025
Merged

fix(react/runtime): fix MainThreadRef modification failure in certain cases #1884

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/tall-symbols-drive.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@lynx-js/react": patch
---

fix: main thread functions created during the initial render cannot correctly modify `MainThreadRef`s after hydration
63 changes: 47 additions & 16 deletions packages/react/worklet-runtime/__test__/workletRef.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,9 @@ describe('WorkletRef', () => {
globalThis.lynxWorkletImpl._refImpl.updateWorkletRef({
_wvid: -2,
}, 'ref2-new');
expect(getFromWorkletRefMap({ _wvid: -2 }).current.element).toBe('ref2-new');
expect(getFromWorkletRefMap({ _wvid: -2 }).current.element).toBe(
'ref2-new',
);

globalThis.lynxWorkletImpl._refImpl.updateWorkletRef({
_wvid: -2,
Expand Down Expand Up @@ -118,7 +120,8 @@ describe('WorkletRef', () => {
expect(getFromWorkletRefMap({ _wvid: 1 })).toBeUndefined();
expect(getFromWorkletRefMap({ _wvid: 2 })).toBeUndefined();
expect(getFromWorkletRefMap({ _wvid: 3 })).toBeUndefined();
expect(globalThis.lynxWorkletImpl._refImpl._firstScreenWorkletRefMap).toMatchInlineSnapshot(`{}`);
expect(globalThis.lynxWorkletImpl._refImpl._firstScreenWorkletRefMap)
.toMatchInlineSnapshot(`{}`);

// If the refs are used in the first screen, they will be hydrated
globalThis.registerWorklet('main-thread', 'ctx1', function() {
Expand All @@ -139,12 +142,23 @@ describe('WorkletRef', () => {
_wvid: 5,
_initValue: 'background-thread-init-5',
}, 'background-thread-element-5');
expect(getFromWorkletRefMap({ _wvid: 1 }).current).toBe('main-thread-set-1');
expect(getFromWorkletRefMap({ _wvid: 2 }).current).toBe('main-thread-init-2');
expect(getFromWorkletRefMap({ _wvid: 3 }).current).toBe('main-thread-init-3');
expect(getFromWorkletRefMap({ _wvid: 4 }).current).toBe('background-thread-init-4');
expect(getFromWorkletRefMap({ _wvid: 5 }).current.element).toBe('background-thread-element-5');
expect(globalThis.lynxWorkletImpl._refImpl._firstScreenWorkletRefMap).toMatchInlineSnapshot(`
expect(getFromWorkletRefMap({ _wvid: 1 }).current).toBe(
'main-thread-set-1',
);
expect(getFromWorkletRefMap({ _wvid: 2 }).current).toBe(
'main-thread-init-2',
);
expect(getFromWorkletRefMap({ _wvid: 3 }).current).toBe(
'main-thread-init-3',
);
expect(getFromWorkletRefMap({ _wvid: 4 }).current).toBe(
'background-thread-init-4',
);
expect(getFromWorkletRefMap({ _wvid: 5 }).current.element).toBe(
'background-thread-element-5',
);
expect(globalThis.lynxWorkletImpl._refImpl._firstScreenWorkletRefMap)
.toMatchInlineSnapshot(`
{
"-1": {
"_wvid": -1,
Expand All @@ -160,7 +174,9 @@ describe('WorkletRef', () => {
},
"-5": {
"_wvid": -5,
"current": "main-thread-init-5",
"current": Element {
"element": "background-thread-element-5",
},
},
"-6": {
"_wvid": -6,
Expand All @@ -170,7 +186,8 @@ describe('WorkletRef', () => {
`);

globalThis.lynxWorkletImpl._refImpl.clearFirstScreenWorkletRefMap();
expect(globalThis.lynxWorkletImpl._refImpl._firstScreenWorkletRefMap).toMatchInlineSnapshot(`{}`);
expect(globalThis.lynxWorkletImpl._refImpl._firstScreenWorkletRefMap)
.toMatchInlineSnapshot(`{}`);
});

it('should hydrate in another ctx', () => {
Expand Down Expand Up @@ -226,10 +243,17 @@ describe('WorkletRef', () => {
ref2.current = 'main-thread-set-2';
});
globalThis.runWorklet(firstScreenWorklet, []);
updateWorkletRefInitValueChanges([[1, 'background-thread-init-1'], [2, 'background-thread-init-2']]);
updateWorkletRefInitValueChanges([[1, 'background-thread-init-1'], [
2,
'background-thread-init-2',
]]);
globalThis.lynxWorkletImpl._hydrateCtx(worklet, firstScreenWorklet);
expect(getFromWorkletRefMap({ _wvid: 1 }).current).toBe('main-thread-set-1');
expect(getFromWorkletRefMap({ _wvid: 2 }).current).toBe('main-thread-set-2');
expect(getFromWorkletRefMap({ _wvid: 1 }).current).toBe(
'main-thread-set-1',
);
expect(getFromWorkletRefMap({ _wvid: 2 }).current).toBe(
'main-thread-set-2',
);
});

it('should not hydrate different ctxs', () => {
Expand Down Expand Up @@ -285,9 +309,16 @@ describe('WorkletRef', () => {
ref2.current = 'main-thread-set-2';
});
globalThis.runWorklet(firstScreenWorklet, []);
updateWorkletRefInitValueChanges([[1, 'background-thread-init-1'], [2, 'background-thread-init-2']]);
updateWorkletRefInitValueChanges([[1, 'background-thread-init-1'], [
2,
'background-thread-init-2',
]]);
globalThis.lynxWorkletImpl._hydrateCtx(worklet, firstScreenWorklet);
expect(getFromWorkletRefMap({ _wvid: 1 }).current).toBe('main-thread-set-1');
expect(getFromWorkletRefMap({ _wvid: 2 }).current).toBe('background-thread-init-2');
expect(getFromWorkletRefMap({ _wvid: 1 }).current).toBe(
'main-thread-set-1',
);
expect(getFromWorkletRefMap({ _wvid: 2 }).current).toBe(
'background-thread-init-2',
);
});
});
5 changes: 2 additions & 3 deletions packages/react/worklet-runtime/src/hydrate.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,14 +69,13 @@ function hydrateCtxImpl(
*/
function hydrateMainThreadRef(
refId: WorkletRefId,
value: WorkletRefImpl<unknown> | { current: unknown },
value: WorkletRefImpl<unknown>,
) {
if ('_initValue' in value) {
// The ref has not been accessed yet.
return;
}
const ref = lynxWorkletImpl!._refImpl._workletRefMap[refId]!;
ref.current = value.current;
lynxWorkletImpl!._refImpl._workletRefMap[refId] = value;
}

/**
Expand Down
Loading