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.

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

Jump to bottom

fix(devtools): fix prod devtools detection + handle late devtools hook injection #4653

Merged
merged 5 commits into from
Sep 22, 2021
Merged

fix(devtools): fix prod devtools detection + handle late devtools hook injection #4653

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
38a6b8d
fix(devtools): fix devtools detection in prod
yyx990803 Sep 21, 2021
225d109
feat: implement devtools hook buffer
Akryum Sep 21, 2021
cb4108b
chore(playground): add devtools defaultSelectedAppId
Akryum Sep 21, 2021
b9a9385
chore(playground): enable devtools in production
Akryum Sep 21, 2021
390d368
test: fix appContext null
Akryum Sep 22, 2021
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
2 changes: 1 addition & 1 deletion packages/runtime-core/__tests__/helpers/renderSlot.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ describe('renderSlot', () => {
return [createVNode('div', null, 'foo', PatchFlags.TEXT)]
},
// mock instance
{ type: {} } as any
{ type: {}, appContext: {} } as any
) as Slot

// manual invocation should not track
Expand Down
47 changes: 28 additions & 19 deletions packages/runtime-core/src/devtools.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ const enum DevtoolsHooks {
}

interface DevtoolsHook {
enabled?: boolean
emit: (event: string, ...payload: any[]) => void
on: (event: string, handler: Function) => void
once: (event: string, handler: Function) => void
Expand All @@ -30,14 +31,33 @@ interface DevtoolsHook {

export let devtools: DevtoolsHook

export function setDevtoolsHook(hook: DevtoolsHook) {
let buffer: { event: string; args: any[] }[] = []

function emit(event: string, ...args: any[]) {
if (devtools) {
devtools.emit(event, ...args)
} else {
buffer.push({ event, args })
}
}

export function setDevtoolsHook(hook: DevtoolsHook, target: any) {
devtools = hook
if (devtools) {
devtools.enabled = true
buffer.forEach(({ event, args }) => devtools.emit(event, ...args))
buffer = []
} else {
const replay = (target.__VUE_DEVTOOLS_HOOK_REPLAY__ =
target.__VUE_DEVTOOLS_HOOK_REPLAY__ || [])
replay.push((newHook: DevtoolsHook) => {
setDevtoolsHook(newHook, target)
})
}
}

export function devtoolsInitApp(app: App, version: string) {
// TODO queue if devtools is undefined
if (!devtools) return
devtools.emit(DevtoolsHooks.APP_INIT, app, version, {
emit(DevtoolsHooks.APP_INIT, app, version, {
Fragment,
Text,
Comment,
Expand All @@ -46,8 +66,7 @@ export function devtoolsInitApp(app: App, version: string) {
}

export function devtoolsUnmountApp(app: App) {
if (!devtools) return
devtools.emit(DevtoolsHooks.APP_UNMOUNT, app)
emit(DevtoolsHooks.APP_UNMOUNT, app)
}

export const devtoolsComponentAdded = /*#__PURE__*/ createDevtoolsComponentHook(
Expand All @@ -62,8 +81,7 @@ export const devtoolsComponentRemoved =

function createDevtoolsComponentHook(hook: DevtoolsHooks) {
return (component: ComponentInternalInstance) => {
if (!devtools) return
devtools.emit(
emit(
hook,
component.appContext.app,
component.uid,
Expand All @@ -83,15 +101,7 @@ export const devtoolsPerfEnd = /*#__PURE__*/ createDevtoolsPerformanceHook(

function createDevtoolsPerformanceHook(hook: DevtoolsHooks) {
return (component: ComponentInternalInstance, type: string, time: number) => {
if (!devtools) return
devtools.emit(
hook,
component.appContext.app,
component.uid,
component,
type,
time
)
emit(hook, component.appContext.app, component.uid, component, type, time)
}
}

Expand All @@ -100,8 +110,7 @@ export function devtoolsComponentEmit(
event: string,
params: any[]
) {
if (!devtools) return
devtools.emit(
emit(
DevtoolsHooks.COMPONENT_EMIT,
component.appContext.app,
component,
Expand Down
6 changes: 3 additions & 3 deletions packages/runtime-core/src/renderer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -340,10 +340,10 @@ function baseCreateRenderer(
initFeatureFlags()
}

const target = getGlobalThis()
target.__VUE__ = true
if (__DEV__ || __FEATURE_PROD_DEVTOOLS__) {
const target = getGlobalThis()
target.__VUE__ = true
setDevtoolsHook(target.__VUE_DEVTOOLS_GLOBAL_HOOK__)
setDevtoolsHook(target.__VUE_DEVTOOLS_GLOBAL_HOOK__, target)
}

const {
Expand Down
5 changes: 5 additions & 0 deletions packages/sfc-playground/src/main.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,9 @@ import { createApp } from 'vue'
import App from './App.vue'
import '@vue/repl/style.css'

// @ts-expect-error Custom window property
window.VUE_DEVTOOLS_CONFIG = {
defaultSelectedAppId: 'id:repl'
}

createApp(App).mount('#app')
3 changes: 2 additions & 1 deletion packages/sfc-playground/vite.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@ const commit = execa.sync('git', ['rev-parse', 'HEAD']).stdout.slice(0, 7)
export default defineConfig({
plugins: [vue(), copyVuePlugin()],
define: {
__COMMIT__: JSON.stringify(commit)
__COMMIT__: JSON.stringify(commit),
__VUE_PROD_DEVTOOLS__: JSON.stringify(true)
},
optimizeDeps: {
exclude: ['@vue/repl']
Expand Down