Skip to content

fix: shortcuts not rebound after server restart #21166

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.

Sign up for GitHub

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
sapphi-red merged 2 commits into from
Dec 1, 2025
Merged

fix: shortcuts not rebound after server restart #21166

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e3f6fd4
fix: shortcuts not rebound after server restart
edmundhung Nov 28, 2025
46cefc1
chore: tweak
sapphi-red Dec 1, 2025
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
45 changes: 45 additions & 0 deletions packages/vite/src/node/__tests__/shortcuts.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,4 +67,49 @@ describe('bindCLIShortcuts', () => {
await server.close()
}
})

test('rebinds shortcuts after server restart', async () => {
const server = await createServer()

try {
const action = vi.fn()

bindCLIShortcuts(
server,
{
customShortcuts: [{ key: 'x', description: 'test', action }],
},
true,
)

// Verify shortcut works initially
const initialReadline = server._rl

expect.assert(
initialReadline,
'The readline interface should be defined after binding shortcuts.',
)

initialReadline.emit('line', 'x')

await vi.waitFor(() => expect(action).toHaveBeenCalledOnce())

// Restart the server
action.mockClear()
await server.restart()

Copy link
Member

@sapphi-red sapphi-red Dec 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was not expecting the binding state to be preserved across the server restart (i.e. I was thinking that bindCLIShortcuts should be called at this line as well). But it seems that behavior exists since the beginning #13675 and I guess it's fine to keep it as-is.

const newReadline = server._rl

expect.assert(
newReadline && newReadline !== initialReadline,
'A new readline interface should be created after server restart.',
)

// Shortcuts should still work after restart
newReadline.emit('line', 'x')
await vi.waitFor(() => expect(action).toHaveBeenCalledOnce())
} finally {
await server.close()
}
})
})
5 changes: 4 additions & 1 deletion packages/vite/src/node/server/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1252,6 +1252,8 @@ async function restartServer(server: ViteDevServer) {
const middlewares = server.middlewares
newServer._configServerPort = server._configServerPort
newServer._currentServerPort = server._currentServerPort
// Ensure the new server has no stale readline reference
newServer._rl = undefined
Object.assign(server, newServer)

// Keep the same connect instance so app.use(vite.middlewares) works
Expand All @@ -1278,7 +1280,8 @@ async function restartServer(server: ViteDevServer) {

if (shortcutsOptions) {
shortcutsOptions.print = false
bindCLIShortcuts(server, shortcutsOptions)
// Skip environment checks since shortcuts were bound before restart
bindCLIShortcuts(server, shortcutsOptions, true)
}
}

Expand Down