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

feat(kit): high-performance mode #280

Merged
merged 3 commits into from
Mar 16, 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/core/src/bridge-events/devtools-actions.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import type { InspectorStateEditorPayload } from '@vue/devtools-kit'
import { stringify } from '@vue/devtools-kit'
import { toggleHighPerfMode as _toggleHighPerfMode, stringify } from '@vue/devtools-kit'
import { defineDevToolsAction } from '../bridge'

export const checkVueInspectorDetected = defineDevToolsAction<boolean>('devtools:check-vue-inspector-detected', async (devtools) => {
Expand Down Expand Up @@ -54,7 +54,7 @@ export const updateInspectorTreeId = defineDevToolsAction('devtools:update-inspe
devtools.context.activeInspectorTreeId = payload
})

export const unhighlightElement = defineDevToolsAction('devtools:unhighlight-element', (devtools, payload) => {
export const unhighlightElement = defineDevToolsAction('devtools:unhighlight-element', (devtools) => {
return devtools.api.unhighlightElement()
})

Expand Down Expand Up @@ -98,3 +98,7 @@ export const getDevToolsState = defineDevToolsAction('devtools:get-state', (devt
activeAppRecordId: devtools.state.activeAppRecordId,
}
})

export const toggleHighPerfMode = defineDevToolsAction('devtools:toggle-high-perf-mode', (_, payload) => {
_toggleHighPerfMode(payload)
})
5 changes: 5 additions & 0 deletions packages/devtools-kit/src/core/high-perf-mode/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
import { devtoolsState } from '../../state'

export function toggleHighPerfMode(state?: boolean) {
devtoolsState.highPerfModeEnabled = state ?? !devtoolsState.highPerfModeEnabled
}
2 changes: 2 additions & 0 deletions packages/devtools-kit/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import { setupDevToolsPlugin } from './api'
import { addCustomTab } from './core/custom-tab'
import { addCustomCommand, removeCustomCommand } from './core/custom-command'
import { toggleComponentInspectorEnabled } from './core/component-inspector'
import { toggleHighPerfMode } from './core/high-perf-mode'

export type * from './core/custom-tab'
export type * from './core/custom-command'
Expand Down Expand Up @@ -48,4 +49,5 @@ export {
setupDevToolsPlugin,
setDevToolsEnv,
toggleComponentInspectorEnabled,
toggleHighPerfMode,
}
11 changes: 10 additions & 1 deletion 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 } from '../state'
import { 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 @@ -96,6 +96,9 @@ export function registerComponentDevToolsPlugin(app: VueAppInstance) {
}, 120)

const componentAddedCleanup = hook.on.componentAdded(async (app, uid, parentUid, component) => {
if (devtoolsState.highPerfModeEnabled)
return

if (app?._instance?.type?.devtools?.hide)
return

Expand Down Expand Up @@ -124,6 +127,9 @@ export function registerComponentDevToolsPlugin(app: VueAppInstance) {
})

const componentUpdatedCleanup = hook.on.componentUpdated(async (app, uid, parentUid, component) => {
if (devtoolsState.highPerfModeEnabled)
return

if (app?._instance?.type?.devtools?.hide)
return

Expand Down Expand Up @@ -152,6 +158,9 @@ export function registerComponentDevToolsPlugin(app: VueAppInstance) {
debounceSendInspectorState()
})
const componentRemovedCleanup = hook.on.componentRemoved(async (app, uid, parentUid, component) => {
if (devtoolsState.highPerfModeEnabled)
return

if (app?._instance?.type?.devtools?.hide)
return

Expand Down
1 change: 1 addition & 0 deletions packages/devtools-kit/src/state/state.ts
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ function initStateFactory() {
commands: [],
vitePluginDetected: false,
activeAppRecordId: null,
highPerfModeEnabled: false,
}
}

Expand Down
1 change: 1 addition & 0 deletions packages/devtools-kit/src/types/state.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,5 @@ export interface DevToolsState {
tabs: CustomTab[]
commands: CustomCommand[]
activeAppRecordId: string | null
highPerfModeEnabled: boolean
}
1 change: 1 addition & 0 deletions packages/vite/src/overlay.js
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ const head = document.getElementsByTagName('head')[0]
setDevToolsEnv({
vitePluginDetected: true,
})

const devtoolsClientUrl = `${vueDevToolsOptions.clientHost || ''}${vueDevToolsOptions.base || '/'}__devtools__/`
setDevToolsClientUrl(devtoolsClientUrl)

Expand Down
Loading