Skip to content

Add ref to Offscreen component #25254

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
merged 6 commits into from
Sep 23, 2022
Merged

Add ref to Offscreen component #25254

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
a86f80d
Expose ref to Offscreen if mode is manual
sammy-SC Sep 13, 2022
d8611ac
Prepend private fields on OffscreenInstance with underscore
sammy-SC Sep 13, 2022
a8f7a96
Schedule Ref effect unconditionally on Offscreen
sammy-SC Sep 21, 2022
1608017
Make sure Offscreen's ref is detached when unmounted
sammy-SC Sep 21, 2022
4320341
Make sure ref is mounted/unmounted in all scenarious
sammy-SC Sep 21, 2022
c7e962f
Nit: pendingProps -> memoizedProps
acdlite Sep 23, 2022
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
Next Next commit
Expose ref to Offscreen if mode is manual
  • Loading branch information
@sammy-SC
sammy-SC committed Sep 13, 2022
commit a86f80df7d0517bd585443d4a4c3f2ac9cbafa3b
4 changes: 4 additions & 0 deletions packages/react-reconciler/src/ReactFiberBeginWork.new.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -677,6 +677,10 @@ function updateOffscreenComponent(
const prevState: OffscreenState | null =
current !== null ? current.memoizedState : null;

if (nextProps.mode === 'manual') {
markRef(current, workInProgress);
}

if (
nextProps.mode === 'hidden' ||
(enableLegacyHidden && nextProps.mode === 'unstable-defer-without-hiding')
Expand Down
4 changes: 4 additions & 0 deletions packages/react-reconciler/src/ReactFiberBeginWork.old.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -677,6 +677,10 @@ function updateOffscreenComponent(
const prevState: OffscreenState | null =
current !== null ? current.memoizedState : null;

if (nextProps.mode === 'manual') {
markRef(current, workInProgress);
}
Copy link
Collaborator

@acdlite acdlite Sep 14, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What if it switches from manual to something else? We need to schedule a Ref effect to detach it. I think the test you wrote happens to work because it also schedules a Visibility effect during the same render.

Copy link
Contributor Author

@sammy-SC sammy-SC Sep 21, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was playing around with this and couldn't come up with a test case to break this.

Anyway, I'm going to remove the condition to only call markRef if mode is manual.


if (
nextProps.mode === 'hidden' ||
(enableLegacyHidden && nextProps.mode === 'unstable-defer-without-hiding')
Expand Down
8 changes: 8 additions & 0 deletions packages/react-reconciler/src/ReactFiberCommitWork.new.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1116,6 +1116,14 @@ function commitLayoutEffectOnFiber(
offscreenSubtreeIsHidden = prevOffscreenSubtreeIsHidden;
offscreenSubtreeWasHidden = prevOffscreenSubtreeWasHidden;
}

if (finishedWork.pendingProps.mode === 'manual') {
if (flags & Ref) {
safelyAttachRef(finishedWork, finishedWork.return);
}
} else if (finishedWork.pendingProps.mode !== undefined) {
safelyDetachRef(finishedWork, finishedWork.return);
Copy link
Collaborator

@acdlite acdlite Sep 14, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This also needs to be wrapped in a Ref effect. Otherwise you might forget to schedule a Ref effect in the begin phase, but it sometimes works anyway accidentally because you happen to have another effect flag scheduled during the same commit.

Copy link
Collaborator

@acdlite acdlite Sep 14, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also I think this should be a regular else block. Not else if. Anything that's not manual should have its ref detached.

Copy link
Contributor Author

@sammy-SC sammy-SC Sep 21, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This also needs to be wrapped in a Ref effect. Otherwise you might forget to schedule a Ref effect in the begin phase, but it sometimes works anyway accidentally because you happen to have another effect flag scheduled during the same commit.

I don't follow this. What do you mean it needs to be wrapped in a Ref effect?

}
} else {
recursivelyTraverseLayoutEffects(
finishedRoot,
Expand Down
8 changes: 8 additions & 0 deletions packages/react-reconciler/src/ReactFiberCommitWork.old.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1116,6 +1116,14 @@ function commitLayoutEffectOnFiber(
offscreenSubtreeIsHidden = prevOffscreenSubtreeIsHidden;
offscreenSubtreeWasHidden = prevOffscreenSubtreeWasHidden;
}

if (finishedWork.pendingProps.mode === 'manual') {
if (flags & Ref) {
safelyAttachRef(finishedWork, finishedWork.return);
}
} else if (finishedWork.pendingProps.mode !== undefined) {
safelyDetachRef(finishedWork, finishedWork.return);
}
} else {
recursivelyTraverseLayoutEffects(
finishedRoot,
Expand Down
48 changes: 48 additions & 0 deletions packages/react-reconciler/src/__tests__/ReactOffscreen-test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ let useState;
let useLayoutEffect;
let useEffect;
let useMemo;
let useRef;
let startTransition;

describe('ReactOffscreen', () => {
Expand All @@ -24,6 +25,7 @@ describe('ReactOffscreen', () => {
useLayoutEffect = React.useLayoutEffect;
useEffect = React.useEffect;
useMemo = React.useMemo;
useRef = React.useRef;
startTransition = React.startTransition;
});

Expand Down Expand Up @@ -1259,4 +1261,50 @@ describe('ReactOffscreen', () => {
</div>,
);
});

describe('manual interactivity', () => {
// @gate enableOffscreen
it('should attach ref only for mode null', async () => {
let offscreenRef;

function App({mode}) {
offscreenRef = useRef(null);
return (
<Offscreen
mode={mode}
ref={ref => {
offscreenRef.current = ref;
}}>
<div />
</Offscreen>
);
}

const root = ReactNoop.createRoot();

await act(async () => {
root.render(<App mode={'manual'} />);
});

expect(offscreenRef.current).not.toBeNull();

await act(async () => {
root.render(<App mode={'visible'} />);
});

expect(offscreenRef.current).toBeNull();

await act(async () => {
root.render(<App mode={'hidden'} />);
});

expect(offscreenRef.current).toBeNull();

await act(async () => {
root.render(<App mode={'manual'} />);
});

expect(offscreenRef.current).not.toBeNull();
});
});
});
3 changes: 2 additions & 1 deletion packages/shared/ReactTypes.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,8 @@ export type Thenable<T> =
export type OffscreenMode =
| 'hidden'
| 'unstable-defer-without-hiding'
| 'visible';
| 'visible'
| 'manual';

export type StartTransitionOptions = {
name?: string,
Expand Down