Unverified Commit a8d18976 authored by Dominik K.'s avatar Dominik K. Committed by GitHub

fix: route info segment overrides not updating in dev overlay (#96968)

## Summary

Previously, when using the built-in route segment override in the
Next.js dev tools (Route Info panel), the UI was not updating: after
toggling a boundary (e.g. `loading.js` or `not-found.js`) you couldn't
switch back unless you closed the modal and reopened it, which slowed
down my workflow. It's not a huge issue, but I thought I'd fix it.

The cause was the segment explorer trie mutating nodes in place, so the
panel's memoized view never picked up insertions until remount. Trie
updates now copy the nodes along the mutated path (copy-on-write) so
changed nodes get fresh identities while untouched subtrees stay shared.

### Before

Switching from one override to another works, but the UI doesn't update
— you have to close and reopen the panel.


https://github.com/user-attachments/assets/39e43ad7-2f14-4b54-bdab-eba51c87a060

### After

Setting an override updates the DevTools UI immediately — no need to
close and reopen the panel.


https://github.com/user-attachments/assets/113887cf-fe07-4d9b-90a5-405b53692a07

## Verification

- `pnpm jest
packages/next/src/next-devtools/dev-overlay/segment-explorer-trie.test.tsx`
- `pnpm test-dev-turbo
test/development/app-dir/segment-explorer/segment-explorer.test.ts`
- Manually verified in a dev app: toggling boundary overrides and "Clear
Segment Overrides" now update the panel live.

<!-- NEXT_JS_LLM -->
parent 6685283f
...@@ -24,6 +24,7 @@ const createSegmentNode = ({ ...@@ -24,6 +24,7 @@ const createSegmentNode = ({
} }
describe('Segment Explorer', () => { describe('Segment Explorer', () => {
let act: typeof import('@testing-library/react').act
let cleanup: typeof import('@testing-library/react').cleanup let cleanup: typeof import('@testing-library/react').cleanup
let renderHook: typeof import('@testing-library/react').renderHook let renderHook: typeof import('@testing-library/react').renderHook
let useSegmentTree: typeof SegmentExplorer.useSegmentTree let useSegmentTree: typeof SegmentExplorer.useSegmentTree
...@@ -42,6 +43,7 @@ describe('Segment Explorer', () => { ...@@ -42,6 +43,7 @@ describe('Segment Explorer', () => {
const rtl = require('@testing-library/react/pure') const rtl = require('@testing-library/react/pure')
renderHook = rtl.renderHook renderHook = rtl.renderHook
cleanup = rtl.cleanup cleanup = rtl.cleanup
act = rtl.act
}) })
afterEach(() => { afterEach(() => {
...@@ -154,9 +156,11 @@ describe('Segment Explorer', () => { ...@@ -154,9 +156,11 @@ describe('Segment Explorer', () => {
value: undefined, value: undefined,
}) })
removeSegmentNode( act(() => {
createSegmentNode({ pagePath: '/constructor/page.js', type: 'page' }) removeSegmentNode(
) createSegmentNode({ pagePath: '/constructor/page.js', type: 'page' })
)
})
expect(result.current).toEqual({ expect(result.current).toEqual({
children: { children: {
...@@ -274,9 +278,11 @@ describe('Segment Explorer', () => { ...@@ -274,9 +278,11 @@ describe('Segment Explorer', () => {
value: undefined, value: undefined,
}) })
removeSegmentNode( act(() => {
createSegmentNode({ pagePath: '/a/b/layout.js', type: 'layout' }) removeSegmentNode(
) createSegmentNode({ pagePath: '/a/b/layout.js', type: 'layout' })
)
})
expect(result.current).toEqual({ expect(result.current).toEqual({
children: { children: {
...@@ -340,4 +346,38 @@ describe('Segment Explorer', () => { ...@@ -340,4 +346,38 @@ describe('Segment Explorer', () => {
value: undefined, value: undefined,
}) })
}) })
test('gives changed nodes a new identity so consumers can memoize on them', () => {
insertSegmentNode(
createSegmentNode({ pagePath: '/a/layout.js', type: 'layout' })
)
const { result } = renderHook(useSegmentTree)
// `pagePath` splits on '/', so the leading slash produces an empty segment.
const rootBefore = result.current
const aBefore = rootBefore.children['']!.children['a']!
act(() => {
insertSegmentNode(
createSegmentNode({ pagePath: '/a/page.js', type: 'page' })
)
})
const rootAfter = result.current
const aAfter = rootAfter.children['']!.children['a']!
// Consumers memoize on `node.children`, so every node along the mutated
// path must be a fresh object. Reusing them would leave newly inserted
// segments invisible until the consumer remounted.
expect(rootAfter).not.toBe(rootBefore)
expect(rootAfter.children).not.toBe(rootBefore.children)
expect(aAfter).not.toBe(aBefore)
expect(aAfter.children).not.toBe(aBefore.children)
expect(Object.keys(aAfter.children)).toEqual(['layout.js', 'page.js'])
// Untouched subtrees stay shared, and the previous snapshot is not mutated.
expect(Object.keys(aBefore.children)).toEqual(['layout.js'])
expect(aAfter.children['layout.js']).toBe(aBefore.children['layout.js'])
})
}) })
...@@ -75,55 +75,81 @@ function createTrie<Value = string>({ ...@@ -75,55 +75,81 @@ function createTrie<Value = string>({
} }
} }
function insert(value: Value) { function copyChildren(children: TrieNode<Value>['children']) {
let currentNode = root return Object.assign(Object.create(null), children)
const segments = getCharacters(value) }
// Snapshots must be immutable for `useSyncExternalStore` consumers, so
// updates copy the nodes along the mutated path instead of mutating them
// in place. Untouched subtrees stay shared.
function copyPath(segments: string[]): TrieNode<Value>[] {
const newRoot: TrieNode<Value> = {
value: root.value,
children: copyChildren(root.children),
}
const path: TrieNode<Value>[] = [newRoot]
let currentNode = newRoot
for (const segment of segments) { for (const segment of segments) {
if (!currentNode.children[segment]) { const existingNode = currentNode.children[segment]
currentNode.children[segment] = { const copiedNode: TrieNode<Value> = {
value: undefined, value: existingNode?.value,
// Skip value for intermediate nodes children: existingNode
children: Object.create(null), ? copyChildren(existingNode.children)
} : Object.create(null),
} }
currentNode = currentNode.children[segment] currentNode.children[segment] = copiedNode
currentNode = copiedNode
path.push(copiedNode)
} }
currentNode.value = value return path
}
root = { ...root } function insert(value: Value) {
const segments = getCharacters(value)
const path = copyPath(segments)
path[path.length - 1].value = value
root = path[0]
markUpdated() markUpdated()
} }
function remove(value: Value) { function remove(value: Value) {
let currentNode = root
const segments = getCharacters(value) const segments = getCharacters(value)
const stack: TrieNode<Value>[] = [] // Locate the node first, so a miss doesn't copy or notify.
let found = true let currentNode = root
for (const segment of segments) { for (const segment of segments) {
if (!currentNode.children[segment]) { const childNode = currentNode.children[segment]
found = false if (!childNode) {
break return
} }
stack.push(currentNode) currentNode = childNode
currentNode = currentNode.children[segment]!
} }
// If the value is not found, skip removal // If the value is not found, skip removal
if (!found || !compare(currentNode.value, value)) { if (!compare(currentNode.value, value)) {
return return
} }
currentNode.value = undefined
for (let i = stack.length - 1; i >= 0; i--) { const path = copyPath(segments)
const parentNode = stack[i] path[path.length - 1].value = undefined
// Prune nodes that no longer hold a value or any children.
for (let i = segments.length - 1; i >= 0; i--) {
const parentNode = path[i]
const segment = segments[i] const segment = segments[i]
if (Object.keys(parentNode.children[segment]!.children).length === 0) { const childNode = parentNode.children[segment]!
if (
childNode.value === undefined &&
Object.keys(childNode.children).length === 0
) {
delete parentNode.children[segment] delete parentNode.children[segment]
} }
} }
root = { ...root } root = path[0]
markUpdated() markUpdated()
} }
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment