-
-
Notifications
You must be signed in to change notification settings - Fork 2.2k
fix(portal): replay queued portal operations in order #5048
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.
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
Open
giaBaoJS
wants to merge
1
commit into
callstack:main
Choose a base branch
from
giaBaoJS:fix/portal-host-queue-order
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+104
−2
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,9 +1,14 @@ | ||
| import * as React from 'react'; | ||
| import { Text } from 'react-native'; | ||
|
|
||
| import { expect, it, jest } from '@jest/globals'; | ||
|
|
||
| import { render, screen } from '../../test-utils'; | ||
| import Dialog from '../Dialog/Dialog'; | ||
| import Modal from '../Modal'; | ||
| import Portal from '../Portal/Portal'; | ||
| import PortalHost, { PortalContext } from '../Portal/PortalHost'; | ||
| import type { PortalMethods } from '../Portal/PortalHost'; | ||
|
|
||
| jest.useRealTimers(); | ||
|
|
||
|
|
@@ -21,3 +26,98 @@ it('renders portal with siblings', async () => { | |
|
|
||
| expect(toJSON()).toMatchSnapshot(); | ||
| }); | ||
|
|
||
| it('renders portals in source order when mounted in the same commit', async () => { | ||
| await render( | ||
| <Portal.Host> | ||
| <Portal> | ||
| <Text testID="portal-content">first</Text> | ||
| </Portal> | ||
| <Portal> | ||
| <Text testID="portal-content">second</Text> | ||
| </Portal> | ||
| <Portal> | ||
| <Text testID="portal-content">third</Text> | ||
| </Portal> | ||
| </Portal.Host> | ||
| ); | ||
|
|
||
| const portals = screen.getAllByTestId('portal-content'); | ||
|
|
||
| expect(portals).toHaveLength(3); | ||
| expect(portals[0]).toBe(screen.getByText('first')); | ||
| expect(portals[1]).toBe(screen.getByText('second')); | ||
| expect(portals[2]).toBe(screen.getByText('third')); | ||
| }); | ||
|
|
||
| it('stacks components mounted in the same commit in source order', async () => { | ||
| await render( | ||
| <Portal.Host> | ||
| <Portal> | ||
| <Modal visible onDismiss={() => {}}> | ||
| <Text testID="layer">modal</Text> | ||
| </Modal> | ||
| </Portal> | ||
| <Portal> | ||
| <Dialog visible onDismiss={() => {}}> | ||
| <Text testID="layer">dialog</Text> | ||
| </Dialog> | ||
| </Portal> | ||
| </Portal.Host> | ||
| ); | ||
|
|
||
| // The last portal in source order is painted on top, so `dialog` has to come | ||
| // after `modal` in the rendered tree. | ||
| const layers = await screen.findAllByTestId('layer'); | ||
|
|
||
| expect(layers).toHaveLength(2); | ||
| expect(layers[0]).toBe(screen.getByText('modal')); | ||
| expect(layers[1]).toBe(screen.getByText('dialog')); | ||
| }); | ||
|
|
||
| it('keeps queued mounts of other portals when one of them is updated', async () => { | ||
| // Mirrors `PortalConsumer`: mounts from `componentDidMount`, then updates its | ||
| // own key. Both calls land before `PortalHost` attaches its manager, so they | ||
| // go through the queue. | ||
| class QueuedConsumer extends React.Component<{ | ||
| manager: PortalMethods; | ||
| label: string; | ||
| update?: boolean; | ||
| }> { | ||
| componentDidMount() { | ||
| const key = this.props.manager.mount( | ||
| <Text testID="queued">{this.props.label}</Text> | ||
| ); | ||
|
|
||
| if (this.props.update) { | ||
| this.props.manager.update( | ||
| key, | ||
| <Text testID="queued">{`${this.props.label} (updated)`}</Text> | ||
| ); | ||
| } | ||
| } | ||
|
|
||
| render() { | ||
| return null; | ||
| } | ||
| } | ||
|
|
||
| await render( | ||
| <PortalHost> | ||
| <PortalContext.Consumer> | ||
| {(manager) => ( | ||
| <> | ||
| <QueuedConsumer manager={manager} label="first" /> | ||
| <QueuedConsumer manager={manager} label="second" update /> | ||
| </> | ||
| )} | ||
| </PortalContext.Consumer> | ||
| </PortalHost> | ||
| ); | ||
|
|
||
| // Deliberately order-independent: this asserts that no portal is lost, which | ||
| // is a separate concern from the order the queue is replayed in. | ||
| expect(screen.getAllByTestId('queued')).toHaveLength(2); | ||
| expect(screen.getByText('first')).toBeTruthy(); | ||
| expect(screen.getByText('second (updated)')).toBeTruthy(); | ||
| }); | ||
|
Comment on lines
+77
to
+123
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. this is testing implementation details. please update it to use public behavior by checking what's rendered and performing operations with a normal protal without consuming the portal context directly |
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.