Skip to content

fix(devtools): handle RPC registration regardless of module order #217

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

Closed
nicokempe wants to merge 1 commit into from
Closed

fix(devtools): handle RPC registration regardless of module order #217

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
182 changes: 101 additions & 81 deletions src/devtools.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,94 +70,114 @@ export function setupDevToolsUI(options: ModuleOptions, moduleResolve: Resolver[
})
})

let isConnected = false
const viteServerWs = useViteWebSocket()
const rpc = new Promise<BirpcGroup<ClientFunctions, ServerFunctions>>((promiseResolve) => {
onDevToolsInitialized(async () => {
const rpc = extendServerRpc<ClientFunctions, ServerFunctions>(RPC_NAMESPACE, {
getOptions() {
return options
},
async reset() {
const ws = await viteServerWs
ws.send('nuxt-a11y:reset')
},
async connected() {
const ws = await viteServerWs
ws.send('nuxt-a11y:connected')
isConnected = true
},
async enableConstantScanning() {
const ws = await viteServerWs
ws.send('nuxt-a11y:enableConstantScanning')
},
async disableConstantScanning() {
const ws = await viteServerWs
ws.send('nuxt-a11y:disableConstantScanning')
},
async triggerScan() {
const ws = await viteServerWs
ws.send('nuxt-a11y:triggerScan')
},
async highlightElement(selector: string, id?: number, color?: string) {
const ws = await viteServerWs
ws.send('nuxt-a11y:highlightElement', { selector, id, color })
},
async unhighlightElement(selector: string) {
const ws = await viteServerWs
ws.send('nuxt-a11y:unhighlightElement', selector)
},
async unhighlightAll() {
const ws = await viteServerWs
ws.send('nuxt-a11y:unhighlightAll')
},
async updateElementId(selector: string, id: number) {
const ws = await viteServerWs
ws.send('nuxt-a11y:updateElementId', { selector, id })
},
async removeElementIdBadge(selector: string) {
const ws = await viteServerWs
ws.send('nuxt-a11y:removeElementIdBadge', selector)
},
async scrollToElement(selector: string) {
const ws = await viteServerWs
ws.send('nuxt-a11y:scrollToElement', selector)
},
})
promiseResolve(rpc)
let isConnected: boolean = false
const viteServerWs: Promise<{ send: (event: string, payload?: unknown) => void, on: (event: string, handler: (payload: unknown) => void) => void }>
= useViteWebSocket()

const rpc: Promise<BirpcGroup<ClientFunctions, ServerFunctions>>
= new Promise<BirpcGroup<ClientFunctions, ServerFunctions>>((promiseResolve): void => {
let rpcRegistered: boolean = false

const registerRpc = (): void => {
if (rpcRegistered) return

const rpcGroup = extendServerRpc<ClientFunctions, ServerFunctions>(RPC_NAMESPACE, {
getOptions(): ModuleOptions {
return options
},
async reset(): Promise<void> {
const ws = await viteServerWs
ws.send('nuxt-a11y:reset')
},
async connected(): Promise<void> {
const ws = await viteServerWs
ws.send('nuxt-a11y:connected')
isConnected = true
},
async enableConstantScanning(): Promise<void> {
const ws = await viteServerWs
ws.send('nuxt-a11y:enableConstantScanning')
},
async disableConstantScanning(): Promise<void> {
const ws = await viteServerWs
ws.send('nuxt-a11y:disableConstantScanning')
},
async triggerScan(): Promise<void> {
const ws = await viteServerWs
ws.send('nuxt-a11y:triggerScan')
},
async highlightElement(selector: string, id?: number, color?: string): Promise<void> {
const ws = await viteServerWs
ws.send('nuxt-a11y:highlightElement', { selector, id, color })
},
async unhighlightElement(selector: string): Promise<void> {
const ws = await viteServerWs
ws.send('nuxt-a11y:unhighlightElement', selector)
},
async unhighlightAll(): Promise<void> {
const ws = await viteServerWs
ws.send('nuxt-a11y:unhighlightAll')
},
async updateElementId(selector: string, id: number): Promise<void> {
const ws = await viteServerWs
ws.send('nuxt-a11y:updateElementId', { selector, id })
},
async removeElementIdBadge(selector: string): Promise<void> {
const ws = await viteServerWs
ws.send('nuxt-a11y:removeElementIdBadge', selector)
},
async scrollToElement(selector: string): Promise<void> {
const ws = await viteServerWs
ws.send('nuxt-a11y:scrollToElement', selector)
},
})

rpcRegistered = true
promiseResolve(rpcGroup)
}

// Normal path: register when DevTools is initialized.
onDevToolsInitialized(registerRpc)

// Ordering edge case: DevTools may have already initialized before this module executed.
// Best-effort immediate attempt; if DevTools isn't ready yet, the hook above will register later.
try {
registerRpc()
}
catch {
console.warn('[nuxt-a11y] DevTools RPC registration deferred until DevTools is initialized.')
}
})
})

viteServerWs.then((ws) => {
ws.on('nuxt-a11y:showViolations', async (payload) => {
if (isConnected) {
const _rpc = await rpc
_rpc.broadcast.showViolations(payload).catch(() => {})
}
ws.on('nuxt-a11y:showViolations', async (payload: unknown) => {
if (!isConnected) return
const _rpc = await rpc
_rpc.broadcast.showViolations(payload as never).catch(() => {})
})
ws.on('nuxt-a11y:scanRunning', async (payload: boolean) => {
if (isConnected) {
const _rpc = await rpc
_rpc.broadcast.scanRunning(payload).catch(() => {})
}

ws.on('nuxt-a11y:scanRunning', async (payload: unknown) => {
if (!isConnected) return
const _rpc = await rpc
_rpc.broadcast.scanRunning(payload as never).catch(() => {})
})
ws.on('nuxt-a11y:constantScanningEnabled', async (payload: boolean) => {
if (isConnected) {
const _rpc = await rpc
_rpc.broadcast.constantScanningEnabled(payload).catch(() => {})
}

ws.on('nuxt-a11y:constantScanningEnabled', async (payload: unknown) => {
if (!isConnected) return
const _rpc = await rpc
_rpc.broadcast.constantScanningEnabled(payload as never).catch(() => {})
})
ws.on('nuxt-a11y:routeChanged', async (payload: string) => {
if (isConnected) {
const _rpc = await rpc
_rpc.broadcast.routeChanged(payload).catch(() => {})
}

ws.on('nuxt-a11y:routeChanged', async (payload: unknown) => {
if (!isConnected) return
const _rpc = await rpc
_rpc.broadcast.routeChanged(payload as never).catch(() => {})
})
ws.on('nuxt-a11y:activeTabChanged', async (payload: { tabId: string, isActive: boolean, totalTabCount: number }) => {
if (isConnected) {
const _rpc = await rpc
_rpc.broadcast.activeTabChanged(payload).catch(() => {})
}

ws.on('nuxt-a11y:activeTabChanged', async (payload: unknown) => {
if (!isConnected) return
const _rpc = await rpc
_rpc.broadcast.activeTabChanged(payload as never).catch(() => {})
})
})
}
Loading