Skip to content
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

fix(kit): respect legacy devtools hook in nuxt app #292

Merged
merged 1 commit into from
Mar 25, 2024
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
8 changes: 6 additions & 2 deletions packages/devtools-kit/src/core/component/tree/walker.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import type { SuspenseBoundary, VNode } from 'vue'
import type { VueAppInstance } from '../../../types'
import type { ComponentTreeNode } from '../types'
import { getAppRecord, getInstanceName, getRenderKey, getUniqueComponentId, isBeingDestroyed, isFragment } from '../utils'
import { devtoolsContext } from '../../../state'
import { devtoolsAppRecords, devtoolsContext } from '../../../state'
import { getRootElementsFromComponentInstance } from './el'
import type { ComponentFilter } from './filter'
import { createComponentFilter } from './filter'
Expand Down Expand Up @@ -241,8 +241,12 @@ export class ComponentWalker {
*/
private mark(instance: VueAppInstance, force = false) {
const instanceMap = getAppRecord(instance)!.instanceMap
if (force || !instanceMap.has(instance.__VUE_DEVTOOLS_UID__))
if (force || !instanceMap.has(instance.__VUE_DEVTOOLS_UID__)) {
instanceMap.set(instance.__VUE_DEVTOOLS_UID__, instance)

// force sync appRecord instanceMap
devtoolsAppRecords.active.instanceMap = instanceMap
}
}

private isKeepAlive(instance: VueAppInstance) {
Expand Down
16 changes: 10 additions & 6 deletions packages/devtools-kit/src/core/index.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { target } from '@vue/devtools-shared'
import { isNuxtApp, target } from '@vue/devtools-shared'
import { createDevToolsHook, devtoolsHooks, hook, subscribeDevToolsHook } from '../hook'
import { DevToolsHooks } from '../types'
import { devtoolsAppRecords, devtoolsState, getDevToolsEnv } from '../state'
Expand All @@ -14,12 +14,16 @@ export function initDevTools() {
if (target.__VUE_DEVTOOLS_GLOBAL_HOOK__ && isDevToolsNext)
return

// compatible with old devtools
if (target.__VUE_DEVTOOLS_GLOBAL_HOOK__)
Object.assign(__VUE_DEVTOOLS_GLOBAL_HOOK__, createDevToolsHook())

else
if (!target.__VUE_DEVTOOLS_GLOBAL_HOOK__) {
target.__VUE_DEVTOOLS_GLOBAL_HOOK__ = createDevToolsHook()
}
else {
// respect old devtools hook in nuxt application
if (!isNuxtApp) {
// override devtools hook directly
Object.assign(__VUE_DEVTOOLS_GLOBAL_HOOK__, createDevToolsHook())
}
}

// setup old devtools plugin (compatible with pinia, router, etc)
hook.on.setupDevtoolsPlugin((pluginDescriptor, setupFn) => {
Expand Down
2 changes: 1 addition & 1 deletion packages/devtools-kit/src/hook/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ export function createDevToolsHook(): DevToolsHook {
id: 'vue-devtools-next',
enabled: false,
appRecords: [],
apps: {},
apps: [],
events: new Map(),
on(event, fn) {
if (!this.events.has(event))
Expand Down
15 changes: 12 additions & 3 deletions packages/devtools-kit/src/plugins/component.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { debounce } from 'perfect-debounce'
import { VueAppInstance } from '../types'
import { DevToolsEvents, apiHooks, setupDevToolsPlugin } from '../api'
import { devtoolsContext, devtoolsState } from '../state'
import { devtoolsAppRecords, devtoolsContext, devtoolsState } from '../state'
import { hook } from '../hook'
import { getAppRecord, getComponentId, getComponentInstance } from '../core/component/utils'
import { getComponentBoundingRect } from '../core/component/state/bounding-rect'
Expand Down Expand Up @@ -116,8 +116,11 @@ export function registerComponentDevToolsPlugin(app: VueAppInstance) {
if (component.__VUE_DEVTOOLS_UID__ == null)
component.__VUE_DEVTOOLS_UID__ = id

if (!appRecord?.instanceMap.has(id))
if (!appRecord?.instanceMap.has(id)) {
appRecord?.instanceMap.set(id, component)
// force sync appRecord instanceMap
devtoolsAppRecords.active.instanceMap = appRecord!.instanceMap
}
}

if (!appRecord)
Expand Down Expand Up @@ -147,8 +150,11 @@ export function registerComponentDevToolsPlugin(app: VueAppInstance) {
if (component.__VUE_DEVTOOLS_UID__ == null)
component.__VUE_DEVTOOLS_UID__ = id

if (!appRecord?.instanceMap.has(id))
if (!appRecord?.instanceMap.has(id)) {
// force sync appRecord instanceMap
appRecord?.instanceMap.set(id, component)
devtoolsAppRecords.active.instanceMap = appRecord!.instanceMap
}
}

if (!appRecord)
Expand Down Expand Up @@ -177,7 +183,10 @@ export function registerComponentDevToolsPlugin(app: VueAppInstance) {
uid,
instance: component,
}) as string

appRecord?.instanceMap.delete(id)
// force sync appRecord instanceMap
devtoolsAppRecords.active.instanceMap = appRecord.instanceMap

debounceSendInspectorTree()
})
Expand Down
2 changes: 2 additions & 0 deletions packages/shared/src/env.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,5 @@ export const target = (typeof globalThis !== 'undefined'
export const isInChromePanel = typeof target.chrome !== 'undefined' && !!target.chrome.devtools
export const isInIframe = isBrowser && target.self !== target.top
export const isInElectron = typeof navigator !== 'undefined' && navigator.userAgent.toLowerCase().includes('electron')
// @ts-expect-error skip type check
export const isNuxtApp = typeof window !== 'undefined' && !!window.__NUXT__
Loading