Skip to content

Commit c7097ea

Browse files
webfansplzwebfansplz
authored
fix(kit): deconfliction variable-naming with legacy devtools (#300)
1 parent 842ab8e commit c7097ea

File tree

9 files changed

+29
-29
lines changed

9 files changed

+29
-29
lines changed

‎packages/devtools-kit/global.d.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ declare global {
55
var __VUE_DEVTOOLS_GLOBAL_HOOK__: DevToolsHook
66
var __VUE_DEVTOOLS_GLOBAL_STATE__: DevToolsState
77
var __VUE_DEVTOOLS_CONTEXT__: DevToolsContext
8-
var __VUE_DEVTOOLS_APP_RECROD_INFO__: {
8+
var __VUE_DEVTOOLS_NEXT_APP_RECROD_INFO__: {
99
id: number
1010
appIds: Set<string>
1111
}

‎packages/devtools-kit/src/api/api.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ export class DevToolsPluginApi {
145145
}
146146

147147
async getComponentInstances(app: VueAppInstance) {
148-
const appRecord = app.__VUE_DEVTOOLS_APP_RECORD__
148+
const appRecord = app.__VUE_DEVTOOLS_NEXT_APP_RECORD__
149149
const appId = appRecord.id.toString()
150150
const instances = [...appRecord.instanceMap]
151151
.filter(([key]) => key.split(':')[0] === appId)

‎packages/devtools-kit/src/core/app-record/index.ts‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@ function getAppRootInstance(app: VueAppInstance['appContext']['app']) {
1818
}
1919

2020
function getAppRecordId(app: VueAppInstance['appContext']['app'], defaultId?: string): string {
21-
if (app.__VUE_DEVTOOLS_APP_RECORD_ID__ != null)
22-
return app.__VUE_DEVTOOLS_APP_RECORD_ID__
21+
if (app.__VUE_DEVTOOLS_NEXT_APP_RECORD_ID__ != null)
22+
return app.__VUE_DEVTOOLS_NEXT_APP_RECORD_ID__
2323

2424
let id = defaultId ?? (appRecordInfo.id++).toString()
2525

@@ -32,7 +32,7 @@ function getAppRecordId(app: VueAppInstance['appContext']['app'], defaultId?: st
3232

3333
appRecordInfo.appIds.add(id)
3434

35-
app.__VUE_DEVTOOLS_APP_RECORD_ID__ = id
35+
app.__VUE_DEVTOOLS_NEXT_APP_RECORD_ID__ = id
3636
return id
3737
}
3838

@@ -50,10 +50,10 @@ export function createAppRecord(app: VueAppInstance['appContext']['app']): AppRe
5050
rootInstance,
5151
}
5252

53-
app.__VUE_DEVTOOLS_APP_RECORD__ = record
53+
app.__VUE_DEVTOOLS_NEXT_APP_RECORD__ = record
5454
const rootId = `${record.id}:root`
5555
record.instanceMap.set(rootId, record.rootInstance)
56-
record.rootInstance.__VUE_DEVTOOLS_UID__ = rootId
56+
record.rootInstance.__VUE_DEVTOOLS_NEXT_UID__ = rootId
5757

5858
return record
5959
}

‎packages/devtools-kit/src/core/component/state/custom.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,7 @@ export function getInstanceDetails(instance) {
164164
return {
165165
_custom: {
166166
type: 'component',
167-
id: instance.__VUE_DEVTOOLS_UID__,
167+
id: instance.__VUE_DEVTOOLS_NEXT_UID__,
168168
displayText: getInstanceName(instance),
169169
tooltipText: 'Component instance',
170170
value: reduceStateList(state),

‎packages/devtools-kit/src/core/component/tree/walker.ts‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -51,8 +51,8 @@ export class ComponentWalker {
5151
// instance.uid is not reliable in devtools as there
5252
// may be 2 roots with same uid which causes unexpected
5353
// behaviour
54-
const id = instance.__VUE_DEVTOOLS_UID__ != null ? instance.__VUE_DEVTOOLS_UID__ : getUniqueComponentId(instance)
55-
instance.__VUE_DEVTOOLS_UID__ = id
54+
const id = instance.__VUE_DEVTOOLS_NEXT_UID__ != null ? instance.__VUE_DEVTOOLS_NEXT_UID__ : getUniqueComponentId(instance)
55+
instance.__VUE_DEVTOOLS_NEXT_UID__ = id
5656

5757
// Dedupe
5858
if (this.captureIds.has(id))
@@ -119,9 +119,9 @@ export class ComponentWalker {
119119
// keep-alive
120120
if (this.isKeepAlive(instance)) {
121121
const cachedComponents = this.getKeepAliveCachedInstances(instance)
122-
const childrenIds = children.map(child => child.__VUE_DEVTOOLS_UID__)
122+
const childrenIds = children.map(child => child.__VUE_DEVTOOLS_NEXT_UID__)
123123
for (const cachedChild of cachedComponents) {
124-
if (!childrenIds.includes(cachedChild.__VUE_DEVTOOLS_UID__)) {
124+
if (!childrenIds.includes(cachedChild.__VUE_DEVTOOLS_NEXT_UID__)) {
125125
const node = await this.capture({ ...cachedChild, isDeactivated: true }, depth + 1)
126126
if (node)
127127
treeNode.children.push(node)
@@ -241,8 +241,8 @@ export class ComponentWalker {
241241
*/
242242
private mark(instance: VueAppInstance, force = false) {
243243
const instanceMap = getAppRecord(instance)!.instanceMap
244-
if (force || !instanceMap.has(instance.__VUE_DEVTOOLS_UID__)) {
245-
instanceMap.set(instance.__VUE_DEVTOOLS_UID__, instance)
244+
if (force || !instanceMap.has(instance.__VUE_DEVTOOLS_NEXT_UID__)) {
245+
instanceMap.set(instance.__VUE_DEVTOOLS_NEXT_UID__, instance)
246246

247247
// force sync appRecord instanceMap
248248
devtoolsAppRecords.active.instanceMap = instanceMap

‎packages/devtools-kit/src/core/component/utils/index.ts‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -26,17 +26,17 @@ function saveComponentGussedName(instance: VueAppInstance, name: string) {
2626
}
2727

2828
export function getAppRecord(instance: VueAppInstance) {
29-
if (instance.__VUE_DEVTOOLS_APP_RECORD__)
30-
return instance.__VUE_DEVTOOLS_APP_RECORD__
29+
if (instance.__VUE_DEVTOOLS_NEXT_APP_RECORD__)
30+
return instance.__VUE_DEVTOOLS_NEXT_APP_RECORD__
3131
else if (instance.root)
32-
return instance.appContext.app.__VUE_DEVTOOLS_APP_RECORD__
32+
return instance.appContext.app.__VUE_DEVTOOLS_NEXT_APP_RECORD__
3333
}
3434

3535
export async function getComponentId(options: { app: VueAppInstance, uid: number, instance: VueAppInstance }) {
3636
const { app, uid, instance } = options
3737
try {
38-
if (instance.__VUE_DEVTOOLS_UID__)
39-
return instance.__VUE_DEVTOOLS_UID__
38+
if (instance.__VUE_DEVTOOLS_NEXT_UID__)
39+
return instance.__VUE_DEVTOOLS_NEXT_UID__
4040

4141
const appRecord = await getAppRecord(app)
4242
if (!appRecord)
@@ -100,7 +100,7 @@ export function getInstanceName(instance: VueAppInstance) {
100100
* @param {Vue} instance
101101
*/
102102
export function getUniqueComponentId(instance: VueAppInstance) {
103-
const appId = instance?.appContext?.app?.__VUE_DEVTOOLS_APP_RECORD_ID__ ?? 0
103+
const appId = instance?.appContext?.app?.__VUE_DEVTOOLS_NEXT_APP_RECORD_ID__ ?? 0
104104
const instanceId = instance === instance.root ? 'root' : instance.uid
105105
return `${appId}:${instanceId}`
106106
}

‎packages/devtools-kit/src/plugins/component.ts‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -113,8 +113,8 @@ export function registerComponentDevToolsPlugin(app: VueAppInstance) {
113113
const appRecord = await getAppRecord(app)
114114

115115
if (component) {
116-
if (component.__VUE_DEVTOOLS_UID__ == null)
117-
component.__VUE_DEVTOOLS_UID__ = id
116+
if (component.__VUE_DEVTOOLS_NEXT_UID__ == null)
117+
component.__VUE_DEVTOOLS_NEXT_UID__ = id
118118

119119
if (!appRecord?.instanceMap.has(id)) {
120120
appRecord?.instanceMap.set(id, component)
@@ -147,8 +147,8 @@ export function registerComponentDevToolsPlugin(app: VueAppInstance) {
147147
const appRecord = await getAppRecord(app)
148148

149149
if (component) {
150-
if (component.__VUE_DEVTOOLS_UID__ == null)
151-
component.__VUE_DEVTOOLS_UID__ = id
150+
if (component.__VUE_DEVTOOLS_NEXT_UID__ == null)
151+
component.__VUE_DEVTOOLS_NEXT_UID__ = id
152152

153153
if (!appRecord?.instanceMap.has(id)) {
154154
// force sync appRecord instanceMap

‎packages/devtools-kit/src/state/app-record.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ export const devtoolsAppRecords = new Proxy<DevToolsAppRecords>(devtoolsState.ap
5252
},
5353
})
5454

55-
export const appRecordInfo = target.__VUE_DEVTOOLS_APP_RECROD_INFO__ ??= {
55+
export const appRecordInfo = target.__VUE_DEVTOOLS_NEXT_APP_RECROD_INFO__ ??= {
5656
id: 0,
5757
appIds: new Set<string>(),
5858
}

‎packages/devtools-kit/src/types/app.ts‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ export type VueAppInstance = ComponentInternalInstance & {
5959
computed: Record<string, unknown>
6060
}
6161
__v_cache: Cache
62-
__VUE_DEVTOOLS_UID__: string
62+
__VUE_DEVTOOLS_NEXT_UID__: string
6363
_isBeingDestroyed: boolean
6464
_instance: VueAppInstance
6565
_container: {
@@ -71,11 +71,11 @@ export type VueAppInstance = ComponentInternalInstance & {
7171
parent: VueAppInstance
7272
appContext: {
7373
app: VueAppInstance & App & {
74-
__VUE_DEVTOOLS_APP_RECORD_ID__: string
75-
__VUE_DEVTOOLS_APP_RECORD__: AppRecord
74+
__VUE_DEVTOOLS_NEXT_APP_RECORD_ID__: string
75+
__VUE_DEVTOOLS_NEXT_APP_RECORD__: AppRecord
7676
}
7777
}
78-
__VUE_DEVTOOLS_APP_RECORD__: AppRecord
78+
__VUE_DEVTOOLS_NEXT_APP_RECORD__: AppRecord
7979
suspense: SuspenseBoundary & { suspenseKey: string }
8080
renderContext: Record<string, unknown>
8181
devtoolsRawSetupState: Record<string, unknown>

0 commit comments

Comments
 (0)