fix: ensured that history does not notify twice for certain actions and has index in state #3017
Conversation
…nd has index in state
☁️ Nx Cloud ReportCI is running/has finished running commands for commit c5cf0a9. As they complete they will appear below. Click to see the status, the terminal output, and the build insights. 📂 See all runs for this CI Pipeline Execution
Sent with 💌 from NxCloud. |
packages/history/src/index.ts
Outdated
| // This is a fallback for when updating the router and there are history entries without index | ||
| // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition | ||
| const currentIndex = location.state.index ?? 0 | ||
| state = assignKey({ ...state, index: currentIndex + 1 }) |
There was a problem hiding this comment.
can we put this logic into assigKey()?
packages/history/src/index.ts
Outdated
| // This is a fallback for when updating the router and there are history entries without index | ||
| // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition | ||
| const currentIndex = location.state.index ?? 0 | ||
| state = assignKey({ ...state, index: currentIndex }) |
There was a problem hiding this comment.
same as above, can we put this logic into assigKey()?
packages/history/src/index.ts
Outdated
| @@ -551,6 +568,7 @@ export function createMemoryHistory( | |||
| entries[index] = path | |||
| }, | |||
| back: () => { | |||
| console.log('back', index) | |||
add canGoBack history method and useCanGoBack hook
packages/history/src/index.ts
Outdated
| @@ -51,17 +52,12 @@ export interface ParsedPath { | |||
|
|
|||
| export interface HistoryState { | |||
| key?: string | |||
| index: number | |||
There was a problem hiding this comment.
shouldn't this be index?: number as the index is not set for the initial entry?
also, i think we should use a more ... obscure name to not collide with user data
e.g. __TSR_index ?
There was a problem hiding this comment.
It's always available after we run through parseHref, this is because, if the route has no state (should be valid only for initial route), we default it to { index: 0 }. About the naming, sure, but by that logic, shouldn't the key also be renamed?
There was a problem hiding this comment.
ideally, yes. but the key has been there since the beginning, but adding an index now could introduce a breaking change
| return { router } | ||
| } | ||
|
|
||
| describe('history: History gives correct notifcations and state', () => { |
There was a problem hiding this comment.
| describe('history: History gives correct notifcations and state', () => { | |
| describe('history: History gives correct notifications and state', () => { |
| }) | ||
|
|
||
| const router = createRouter({ | ||
| routeTree: rootRoute.addChildren([indexRoute, postsRoute]), |
There was a problem hiding this comment.
we should run the same test for all history types
| subscriber({ location, action: { type: 'ROLLBACK' } }), | ||
| ) | ||
| const handleIndexChange = (action: SubscriberHistoryAction) => { | ||
| if (opts.notifyOnIndexChange ?? true) notify(action) |
There was a problem hiding this comment.
can you please always use { } even for one liners?
| @@ -375,9 +377,10 @@ export function createBrowserHistory(opts?: { | |||
| } | |||
| } | |||
|
|
|||
| const onPushPop = () => { | |||
| // NOTE: this function can probably be removed | |||
There was a problem hiding this comment.
so can we remove it?
No description provided.