Navigator: remove location history, simplify internal logic #64675
There are no files selected for viewing
This file contains 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 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 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 |
|---|---|---|
|
|
@@ -37,110 +37,97 @@ type RouterAction = | |
| | { type: 'gotoparent'; options?: NavigateToParentOptions }; | ||
|
|
||
| type RouterState = { | ||
| initialPath: string; | ||
| screens: Screen[]; | ||
| currentLocation: NavigatorLocation; | ||
| matchedPath: MatchedPath; | ||
| focusSelectors: Map< string, string >; | ||
| }; | ||
|
|
||
| function addScreen( { screens }: RouterState, screen: Screen ) { | ||
| if ( screens.some( ( s ) => s.path === screen.path ) ) { | ||
| // eslint-disable-next-line no-console | ||
| console.warn( | ||
| `Navigator: a screen with path ${ screen.path } already exists. | ||
| The screen with id ${ screen.id } will not be added.` | ||
| ); | ||
| return screens; | ||
| } | ||
| return [ ...screens, screen ]; | ||
| } | ||
|
|
||
| function removeScreen( { screens }: RouterState, screen: Screen ) { | ||
| return screens.filter( ( s ) => s.id !== screen.id ); | ||
| } | ||
|
|
||
| function goTo( | ||
| state: RouterState, | ||
| path: string, | ||
| options: NavigateOptions = {} | ||
| ) { | ||
| const { currentLocation, focusSelectors } = state; | ||
|
|
||
| const { | ||
| // Default assignments | ||
| isBack = false, | ||
| skipFocus = false, | ||
| // Extract to avoid forwarding | ||
| replace, | ||
| focusTargetSelector, | ||
| // Rest | ||
| ...restOptions | ||
| } = options; | ||
|
|
||
| if ( currentLocation?.path === path ) { | ||
| return { currentLocation, focusSelectors }; | ||
| } | ||
|
|
||
| let focusSelectorsCopy; | ||
|
|
||
| // Set a focus selector that will be used when navigating | ||
| // back to the current location. | ||
| if ( focusTargetSelector && currentLocation?.path ) { | ||
| if ( ! focusSelectorsCopy ) { | ||
| focusSelectorsCopy = new Map( state.focusSelectors ); | ||
| } | ||
| focusSelectorsCopy.set( currentLocation.path, focusTargetSelector ); | ||
| } | ||
|
|
||
| // Get the focus selector for the new location. | ||
| let currentFocusSelector; | ||
| if ( isBack ) { | ||
| if ( ! focusSelectorsCopy ) { | ||
| focusSelectorsCopy = new Map( state.focusSelectors ); | ||
| } | ||
| currentFocusSelector = focusSelectorsCopy.get( path ); | ||
| focusSelectorsCopy.delete( path ); | ||
|
There was a problem hiding this comment. Here I would enhance the logic for the case when we navigate to the Also, a little optimization opportunity: create the copy only when you really found a selector to be deleted. Currently, if |
||
| } | ||
|
|
||
| return { | ||
| currentLocation: { | ||
| ...restOptions, | ||
| path, | ||
| isBack, | ||
| hasRestoredFocus: false, | ||
| focusTargetSelector: currentFocusSelector, | ||
| skipFocus, | ||
| }, | ||
ciampo marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| focusSelectors: focusSelectorsCopy ?? focusSelectors, | ||
| }; | ||
| } | ||
|
|
||
| function goToParent( | ||
| state: RouterState, | ||
| options: NavigateToParentOptions = {} | ||
| ) { | ||
| const { currentLocation, screens, focusSelectors } = state; | ||
| const currentPath = currentLocation?.path; | ||
| if ( currentPath === undefined ) { | ||
| return { currentLocation, focusSelectors }; | ||
| } | ||
| const parentPath = findParent( currentPath, screens ); | ||
| if ( parentPath === undefined ) { | ||
| return { currentLocation, focusSelectors }; | ||
| } | ||
| return goTo( state, parentPath, { | ||
| ...options, | ||
|
|
@@ -152,7 +139,13 @@ function routerReducer( | |
| state: RouterState, | ||
| action: RouterAction | ||
| ): RouterState { | ||
| let { | ||
| screens, | ||
| currentLocation, | ||
| matchedPath, | ||
| focusSelectors, | ||
| ...restState | ||
| } = state; | ||
| switch ( action.type ) { | ||
| case 'add': | ||
| screens = addScreen( state, action.screen ); | ||
|
|
@@ -161,26 +154,31 @@ function routerReducer( | |
| screens = removeScreen( state, action.screen ); | ||
| break; | ||
| case 'goto': | ||
| const goToNewState = goTo( state, action.path, action.options ); | ||
| currentLocation = goToNewState.currentLocation; | ||
| focusSelectors = goToNewState.focusSelectors; | ||
|
There was a problem hiding this comment. You can do a destructuring assignment in only you wrap it in parens so that it's not confused with a block: ( { currentLocation, focusSelection } = goTo() ); |
||
| break; | ||
| case 'gotoparent': | ||
| const goToParentNewState = goToParent( state, action.options ); | ||
| currentLocation = goToParentNewState.currentLocation; | ||
| focusSelectors = goToParentNewState.focusSelectors; | ||
| break; | ||
| } | ||
|
|
||
| if ( currentLocation?.path === state.initialPath ) { | ||
| currentLocation = { ...currentLocation, isInitial: true }; | ||
| } | ||
|
There was a problem hiding this comment. Do you really want to do this? There was a problem hiding this comment.
No, the logic is wrong. I had already noticed it while working on #64777. I'm going to extract and refine the fix, and apply it in a separate PR |
||
|
|
||
| // Return early in case there is no change | ||
| if ( | ||
| screens === state.screens && | ||
| currentLocation === state.currentLocation | ||
| ) { | ||
| return state; | ||
| } | ||
|
|
||
| // Compute the matchedPath | ||
| const currentPath = currentLocation?.path; | ||
| matchedPath = | ||
| currentPath !== undefined | ||
| ? patternMatch( currentPath, screens ) | ||
|
|
@@ -197,23 +195,35 @@ function routerReducer( | |
| matchedPath = state.matchedPath; | ||
| } | ||
|
|
||
| return { | ||
| ...restState, | ||
| screens, | ||
| currentLocation, | ||
| matchedPath, | ||
| focusSelectors, | ||
| }; | ||
| } | ||
|
|
||
| function UnconnectedNavigatorProvider( | ||
| props: WordPressComponentProps< NavigatorProviderProps, 'div' >, | ||
| forwardedRef: ForwardedRef< any > | ||
| ) { | ||
| const { | ||
| initialPath: initialPathProp, | ||
| children, | ||
| className, | ||
| ...otherProps | ||
| } = useContextSystem( props, 'NavigatorProvider' ); | ||
|
|
||
| const [ routerState, dispatch ] = useReducer( | ||
| routerReducer, | ||
| initialPathProp, | ||
| ( path ) => ( { | ||
| screens: [], | ||
| currentLocation: { path }, | ||
| matchedPath: undefined, | ||
| focusSelectors: new Map(), | ||
| initialPath: initialPathProp, | ||
| } ) | ||
| ); | ||
|
|
||
|
|
@@ -242,19 +252,16 @@ function UnconnectedNavigatorProvider( | |
| [] | ||
| ); | ||
|
|
||
| const { currentLocation, matchedPath } = routerState; | ||
|
|
||
| const navigatorContextValue: NavigatorContextType = useMemo( | ||
| () => ( { | ||
| location: currentLocation, | ||
| params: matchedPath?.params ?? {}, | ||
| match: matchedPath?.id, | ||
| ...methods, | ||
| } ), | ||
| [ currentLocation, matchedPath, methods ] | ||
| ); | ||
|
|
||
| const cx = useCx(); | ||
|
|
||
This file contains 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
Oops, something went wrong.
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.
Let's use
@wordpress/warningfor this, already used widely in the components package.