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): prevent duplicate registration of devtool plugin #457

Merged
merged 1 commit into from
Jun 18, 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
6 changes: 3 additions & 3 deletions packages/devtools-kit/src/core/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ import {
import { onLegacyDevToolsPluginApiAvailable } from '../compat'
import { DevToolsHooks } from '../types'
import { createAppRecord, removeAppRecordId } from './app'
import { callDevToolsPluginSetupFn, createComponentsDevToolsPlugin, registerDevToolsPlugin, setupDevToolsPlugin } from './plugin'
import { callDevToolsPluginSetupFn, createComponentsDevToolsPlugin, registerDevToolsPlugin, removeRegisteredPluginApp, setupDevToolsPlugin } from './plugin'
import { normalizeRouterInfo } from './router'

export function initDevTools() {
Expand Down Expand Up @@ -74,10 +74,9 @@ export function initDevTools() {
setActiveAppRecord(normalizedAppRecord)
setActiveAppRecordId(normalizedAppRecord.id)
normalizeRouterInfo(normalizedAppRecord, activeAppRecord)
registerDevToolsPlugin(normalizedAppRecord.app)
}

setupDevToolsPlugin(...createComponentsDevToolsPlugin(normalizedAppRecord.app))
registerDevToolsPlugin(normalizedAppRecord.app)

updateDevToolsState({
connected: true,
Expand All @@ -104,6 +103,7 @@ export function initDevTools() {
devtoolsContext.hooks.callHook(DevToolsMessagingHookKeys.SEND_ACTIVE_APP_UNMOUNTED_TO_CLIENT)
}
target.__VUE_DEVTOOLS_GLOBAL_HOOK__.apps.splice(target.__VUE_DEVTOOLS_GLOBAL_HOOK__.apps.indexOf(app), 1)
removeRegisteredPluginApp(app)
})

subscribeDevToolsHook()
Expand Down
18 changes: 15 additions & 3 deletions packages/devtools-kit/src/core/plugin/index.ts
Original file line number Diff line number Diff line change
@@ -1,19 +1,21 @@
import { target } from '@vue/devtools-shared'
import { App, PluginDescriptor, PluginSetupFunction } from '../../types'
import { hook } from '../../hook'
import { devtoolsContext, devtoolsPluginBuffer } from '../../ctx'
import { DevToolsPluginAPI } from '../../api'

export * from './components'

target.__VUE_DEVTOOLS_KIT__REGISTERED_PLUGIN_APPS__ ??= new Set<App>()

export function setupDevToolsPlugin(pluginDescriptor: PluginDescriptor, setupFn: PluginSetupFunction) {
return hook.setupDevToolsPlugin(pluginDescriptor, setupFn)
}

export function callDevToolsPluginSetupFn(plugin: [PluginDescriptor, PluginSetupFunction], app: App) {
const [pluginDescriptor, setupFn] = plugin
// @TODO: need check
// if (pluginDescriptor.app !== app)
// return
if (pluginDescriptor.app !== app)
return

const api = new DevToolsPluginAPI({
plugin: {
Expand All @@ -32,7 +34,17 @@ export function callDevToolsPluginSetupFn(plugin: [PluginDescriptor, PluginSetup

setupFn(api)
}

export function removeRegisteredPluginApp(app: App) {
target.__VUE_DEVTOOLS_KIT__REGISTERED_PLUGIN_APPS__.delete(app)
}

export function registerDevToolsPlugin(app: App) {
if (target.__VUE_DEVTOOLS_KIT__REGISTERED_PLUGIN_APPS__.has(app))
return

target.__VUE_DEVTOOLS_KIT__REGISTERED_PLUGIN_APPS__.add(app)

devtoolsPluginBuffer.forEach((plugin) => {
callDevToolsPluginSetupFn(plugin, app)
})
Expand Down
2 changes: 2 additions & 0 deletions packages/devtools-kit/src/ctx/api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import { getRootElementsFromComponentInstance } from '../core/component/tree/el'
import { openInEditor } from '../core/open-in-editor'
import { normalizeRouterInfo } from '../core/router'
import { getComponentInspector } from '../core/component-inspector'
import { registerDevToolsPlugin } from '../core/plugin'
import type { DevToolsContextHooks, DevToolsMessagingHooks, DevToolsV6PluginAPIHookPayloads } from './hook'
import { DevToolsContextHookKeys, DevToolsV6PluginAPIHookKeys } from './hook'
import { activeAppRecord, devtoolsAppRecords, setActiveAppRecord, setActiveAppRecordId } from './state'
Expand Down Expand Up @@ -108,6 +109,7 @@ export function createDevToolsApi(hooks: Hookable<DevToolsContextHooks & DevTool
setActiveAppRecord(appRecord)
normalizeRouterInfo(appRecord, activeAppRecord)
callInspectorUpdatedHook()
registerDevToolsPlugin(appRecord.app)
}
},
// inspect dom
Expand Down
1 change: 1 addition & 0 deletions packages/playground/basic/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
"dependencies": {
"@tanstack/vue-query": "^5.41.0",
"@vueuse/core": "^10.10.0",
"element-plus": "^2.7.5",
"pinia": "^2.1.7",
"unplugin-auto-import": "^0.17.6",
"vee-validate": "^4.13.1",
Expand Down
5 changes: 3 additions & 2 deletions packages/playground/basic/src/main.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,11 @@ import { createRouter, createWebHistory } from 'vue-router'
import { VueQueryPlugin } from '@tanstack/vue-query'
import { addCustomCommand } from '@vue/devtools-api'

import ElementPlus from 'element-plus'
import store from './stores/vuexStore'

import App from './App.vue'

import 'element-plus/dist/index.css'
import Home from './pages/Home.vue'
import Hey from './pages/Hey.vue'
import VueQuery from './pages/VueQuery.vue'
Expand All @@ -16,8 +17,8 @@ import './style.css'
import 'uno.css'

const pinia = createPinia()

const app = createApp(App)
app.use(ElementPlus)

// devtools.connect()

Expand Down
3 changes: 2 additions & 1 deletion packages/playground/basic/vite.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import commonjs from '@rollup/plugin-commonjs'
import Unocss from 'unocss/vite'
import AutoImport from 'unplugin-auto-import/vite'
import inspect from 'vite-plugin-inspect'

import { ElementPlusResolver } from 'unplugin-vue-components/resolvers'
// https://vitejs.dev/config/
export default defineConfig({
plugins: [
Expand All @@ -21,6 +21,7 @@ export default defineConfig({
'vue-router',
'@vueuse/core',
],
resolvers: [ElementPlusResolver()],
}),
inspect(),
],
Expand Down
Loading