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(client, bridge): update pinia status when module loaded #244

Merged
merged 5 commits into from
Feb 23, 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
29 changes: 20 additions & 9 deletions packages/client/src/pages/pinia.vue
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import { useDevToolsBridgeRpc } from '@vue/devtools-core'
import { type InspectorNodeTag, type InspectorState } from '@vue/devtools-kit'
import { Pane, Splitpanes } from 'splitpanes'

const inspectorId = 'pinia'
const bridgeRpc = useDevToolsBridgeRpc()

const selected = ref('')
Expand All @@ -16,7 +17,7 @@ const state = ref<{
}>({})

function getPiniaState(nodeId: string) {
bridgeRpc.getInspectorState({ inspectorId: 'pinia', nodeId }).then(({ data }) => {
bridgeRpc.getInspectorState({ inspectorId, nodeId }).then(({ data }) => {
state.value = data
})
}
Expand All @@ -33,12 +34,22 @@ watch(selected, () => {
createCollapseContext('inspector-state')

onDevToolsClientConnected(() => {
bridgeRpc.getInspectorTree({ inspectorId: 'pinia', filter: '' }).then(({ data }) => {
tree.value = data
if (!selected.value && data.length) {
selected.value = data[0].id
const getPiniaInspectorTree = () => {
bridgeRpc.getInspectorTree({ inspectorId, filter: '' }).then(({ data }) => {
tree.value = data
if (!selected.value && data.length)
selected.value = data[0].id
getPiniaState(data[0].id)
}
})
}
getPiniaInspectorTree()

bridgeRpc.on.componentUpdated((id) => {
if (id !== inspectorId)
webfansplz marked this conversation as resolved.
Show resolved Hide resolved
return
getPiniaInspectorTree()
}, {
inspectorId,
})

bridgeRpc.on.inspectorTreeUpdated((data) => {
Expand All @@ -50,7 +61,7 @@ onDevToolsClientConnected(() => {
getPiniaState(data.data[0].id)
}
}, {
inspectorId: 'pinia',
inspectorId,
})

bridgeRpc.on.inspectorStateUpdated((data) => {
Expand All @@ -59,7 +70,7 @@ onDevToolsClientConnected(() => {

state.value = data
}, {
inspectorId: 'pinia',
inspectorId,
})
})
</script>
Expand All @@ -77,7 +88,7 @@ onDevToolsClientConnected(() => {
<InspectorState
v-for="(item, key) in state" :id="key"
:key="key"
inspector-id="pinia"
:inspector-id="inspectorId"
:node-id="selected" :data="item" :name="`${key}`"
/>
</div>
Expand Down
5 changes: 5 additions & 0 deletions packages/core/src/bridge/devtools.ts
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,11 @@ export class BridgeRpc {
} as T)
})
},
componentUpdated(cb: (id?: string) => void, options: { inspectorId: string }) {
devtoolsBridge.value.on(BridgeEvents.COMPONENT_UPDATED, () => {
cb(options?.inspectorId)
})
},
devtoolsStateUpdated(cb) {
devtoolsBridge.value.on(BridgeEvents.DEVTOOLS_STATE_UPDATED, (payload) => {
cb(parse(payload))
Expand Down
2 changes: 2 additions & 0 deletions packages/core/src/bridge/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ export enum BridgeEvents {
SEND_INSPECTOR_TREE = 'inspector-tree:send',
// inspector state
SEND_INSPECTOR_STATE = 'inspector-state:send',
// component updated
COMPONENT_UPDATED = 'component:updated',

// edit related things (components/pinia/route, etc...) they are all fired the same event
// so that we can decouple the specific logic to the `devtools-kit` package.
Expand Down
5 changes: 5 additions & 0 deletions packages/core/src/bridge/user-app.ts
Original file line number Diff line number Diff line change
Expand Up @@ -175,6 +175,11 @@ export function registerBridgeRpc(bridge: BridgeInstanceType) {
bridge.emit(BridgeEvents.SEND_INSPECTOR_TREE, payload)
})

// component updated
devtools.api.on.componentUpdated(() => {
bridge.emit(BridgeEvents.COMPONENT_UPDATED)
})

// inspector state updated
devtools.api.on.sendInspectorState((payload) => {
bridge.emit(BridgeEvents.SEND_INSPECTOR_STATE, payload)
Expand Down
5 changes: 4 additions & 1 deletion packages/devtools-kit/src/api/api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,10 @@ export class DevToolsPluginApi {
apiHooks.callHook(DevToolsEvents.VISIT_COMPONENT_TREE, ...params)
}

notifyComponentUpdate() {}
notifyComponentUpdate() {
apiHooks.callHook(DevToolsEvents.COMPONENT_UPDATED)
}

now() {
return nowFn()
}
Expand Down
2 changes: 2 additions & 0 deletions packages/devtools-kit/src/api/hook.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ export enum DevToolsEvents {
DEVTOOLS_CONNECTED_UPDATED = 'devtools:connected-updated',
ROUTER_INFO_UPDATED = 'router-info:updated',
COMPONENT_STATE_INSPECT = 'component-state:inspect',
COMPONENT_UPDATED = 'component:updated',
TOGGLE_COMPONENT_HIGHLIGHTER = 'component-highlighter:toggle',
GET_COMPONENT_BOUNDING_RECT = 'component-bounding-rect:get',
SCROLL_TO_COMPONENT = 'scroll-to-component',
Expand Down Expand Up @@ -60,6 +61,7 @@ export interface DevToolsEvent {
[DevToolsEvents.CUSTOM_TABS_UPDATED]: (payload: CustomTab[]) => void
// custom command
[DevToolsEvents.CUSTOM_COMMANDS_UPDATED]: (payload: CustomCommand[]) => void
[DevToolsEvents.COMPONENT_UPDATED]: () => void
}

export type DevToolsEventParams<T extends keyof DevToolsEvent> = Parameters<DevToolsEvent[T]>
Expand Down
3 changes: 3 additions & 0 deletions packages/devtools-kit/src/api/on.ts
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,9 @@ export const on = {
apiHooks.hook(DevToolsEvents.EDIT_INSPECTOR_STATE, fn)
},
editComponentState() {},
componentUpdated(fn: DevToolsEvent[DevToolsEvents.COMPONENT_UPDATED]) {
apiHooks.hook(DevToolsEvents.COMPONENT_UPDATED, fn)
},
// #endregion compatible with old devtools

// router
Expand Down
Loading