Skip to content

refactor(router-core): Verify changes are necessary before updating store #4964

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

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -104,12 +104,15 @@ async function run({ select }: ReturnType<typeof setup>) {
return after - before
}

function resolveAfter(ms: number, value: any) {
return new Promise<void>((resolve) => setTimeout(() => resolve(value), ms))
}

describe("Store doesn't update *too many* times during navigation", () => {
test('async loader, async beforeLoad, pendingMs', async () => {
const params = setup({
beforeLoad: () =>
new Promise<void>((resolve) => setTimeout(resolve, 100)),
loader: () => new Promise<void>((resolve) => setTimeout(resolve, 100)),
beforeLoad: () => resolveAfter(100, { foo: 'bar' }),
loader: () => resolveAfter(100, { hello: 'world' }),
defaultPendingMs: 100,
defaultPendingMinMs: 300,
})
Expand All @@ -119,7 +122,7 @@ describe("Store doesn't update *too many* times during navigation", () => {
// This number should be as small as possible to minimize the amount of work
// that needs to be done during a navigation.
// Any change that increases this number should be investigated.
expect(updates).toBe(14)
expect(updates).toBe(10)
})

test('redirection in preload', async () => {
Expand All @@ -137,13 +140,13 @@ describe("Store doesn't update *too many* times during navigation", () => {
// This number should be as small as possible to minimize the amount of work
// that needs to be done during a navigation.
// Any change that increases this number should be investigated.
expect(updates).toBe(6)
expect(updates).toBe(5)
})

test('sync beforeLoad', async () => {
const params = setup({
beforeLoad: () => ({ foo: 'bar' }),
loader: () => new Promise<void>((resolve) => setTimeout(resolve, 100)),
loader: () => resolveAfter(100, { hello: 'world' }),
defaultPendingMs: 100,
defaultPendingMinMs: 300,
})
Expand All @@ -153,7 +156,7 @@ describe("Store doesn't update *too many* times during navigation", () => {
// This number should be as small as possible to minimize the amount of work
// that needs to be done during a navigation.
// Any change that increases this number should be investigated.
expect(updates).toBe(13)
expect(updates).toBe(9)
})

test('nothing', async () => {
Expand All @@ -164,8 +167,8 @@ describe("Store doesn't update *too many* times during navigation", () => {
// This number should be as small as possible to minimize the amount of work
// that needs to be done during a navigation.
// Any change that increases this number should be investigated.
expect(updates).toBeGreaterThanOrEqual(10) // WARN: this is flaky, and sometimes (rarely) is 11
expect(updates).toBeLessThanOrEqual(11)
expect(updates).toBeGreaterThanOrEqual(6) // WARN: this is flaky, and sometimes (rarely) is 7
expect(updates).toBeLessThanOrEqual(7)
})

test('not found in beforeLoad', async () => {
Expand Down Expand Up @@ -205,6 +208,6 @@ describe("Store doesn't update *too many* times during navigation", () => {
// This number should be as small as possible to minimize the amount of work
// that needs to be done during a navigation.
// Any change that increases this number should be investigated.
expect(updates).toBe(19)
expect(updates).toBe(15)
})
})
47 changes: 26 additions & 21 deletions packages/router-core/src/router.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2697,10 +2697,12 @@ export class RouterCore<
this.getMatch(matchId),
loaderData,
)
innerLoadContext.updateMatch(matchId, (prev) => ({
...prev,
loaderData,
}))
if (loaderData !== undefined) {
innerLoadContext.updateMatch(matchId, (prev) => ({
...prev,
loaderData,
}))
}
}

// Lazy option can modify the route options,
Expand Down Expand Up @@ -2837,14 +2839,16 @@ export class RouterCore<
)
: shouldReloadOption

innerLoadContext.updateMatch(matchId, (prev) => {
prev._nonReactive.loaderPromise = createControlledPromise<void>()
return {
const nextPreload =
!!preload && !this.state.matches.some((d) => d.id === matchId)
const match = this.getMatch(matchId)!
match._nonReactive.loaderPromise = createControlledPromise<void>()
if (nextPreload !== match.preload) {
innerLoadContext.updateMatch(matchId, (prev) => ({
...prev,
preload:
!!preload && !this.state.matches.some((d) => d.id === matchId),
}
})
preload: nextPreload,
}))
}

// If the route is successful and still fresh, just resolve
const { status, invalid } = this.getMatch(matchId)!
Expand Down Expand Up @@ -2886,23 +2890,24 @@ export class RouterCore<
}
}
}
const match = this.getMatch(matchId)!
if (!loaderIsRunningAsync) {
const match = this.getMatch(matchId)!
match._nonReactive.loaderPromise?.resolve()
match._nonReactive.loadPromise?.resolve()
}

innerLoadContext.updateMatch(matchId, (prev) => {
clearTimeout(prev._nonReactive.pendingTimeout)
prev._nonReactive.pendingTimeout = undefined
if (!loaderIsRunningAsync) prev._nonReactive.loaderPromise = undefined
prev._nonReactive.dehydrated = undefined
return {
clearTimeout(match._nonReactive.pendingTimeout)
match._nonReactive.pendingTimeout = undefined
if (!loaderIsRunningAsync) match._nonReactive.loaderPromise = undefined
match._nonReactive.dehydrated = undefined
const nextIsFetching = loaderIsRunningAsync ? match.isFetching : false
if (nextIsFetching !== match.isFetching || match.invalid !== false) {
innerLoadContext.updateMatch(matchId, (prev) => ({
...prev,
isFetching: loaderIsRunningAsync ? prev.isFetching : false,
isFetching: nextIsFetching,
invalid: false,
}
})
}))
}
return this.getMatch(matchId)!
}

Expand Down