@dxos/plugin-debug 0.8.4-main.c85a9c8dae → 0.8.4-main.d9fc60f731

package/src/capabilities/{react-surface/react-surface.tsx → react-surface.tsx}

@@ -3,12 +3,13 @@
 //
 
 import * as Effect from 'effect/Effect';
+import * as Option from 'effect/Option';
 import React, { useCallback } from 'react';
 
 import { Capabilities, Capability } from '@dxos/app-framework';
-import { Surface, useCapability, useOperationInvoker, useSettingsState } from '@dxos/app-framework/ui';
-import { AppCapabilities, LayoutOperation } from '@dxos/app-toolkit';
-import { useLayout } from '@dxos/app-toolkit/ui';
+import { Surface, useOperationInvoker, useSettingsState } from '@dxos/app-framework/ui';
+import { AppCapabilities, LayoutOperation, RootCollectionAnnotation, getObjectPathFromObject } from '@dxos/app-toolkit';
+import { AppSurface, useActiveSpace } from '@dxos/app-toolkit/ui';
 import {
   AutomergePanel,
   ConfigPanel,
@@ -33,32 +34,33 @@ import {
   StoragePanel,
   SwarmPanel,
   TestingPanel,
-  TracingPanel,
   WorkflowPanel,
 } from '@dxos/devtools';
-import { Obj } from '@dxos/echo';
-import { Collection } from '@dxos/echo';
-import { type LogBuffer } from '@dxos/log';
+import { Annotation, Collection, Feed, Obj } from '@dxos/echo';
 import { log } from '@dxos/log';
-import { ClientCapabilities } from '@dxos/plugin-client';
+import { type IdbLogStore } from '@dxos/log-store-idb';
 import { type Graph } from '@dxos/plugin-graph';
-import { ScriptOperation } from '@dxos/plugin-script/types';
-import { SpaceOperation } from '@dxos/plugin-space/types';
-import { type Space, SpaceState, isSpace, parseId } from '@dxos/react-client/echo';
-import { Panel } from '@dxos/react-ui';
+import { ScriptOperation } from '@dxos/plugin-script';
+import { SpaceOperation } from '@dxos/plugin-space';
+import { type Space, SpaceState, isSpace } from '@dxos/react-client/echo';
+import { ToolsExplorer } from '@dxos/react-ui-introspect';
 
+import { DebugSettings } from '#components';
 import {
   DebugGraph,
   DebugObjectPanel,
-  DebugSettings,
   DebugSpaceObjectsPanel,
   DebugStatus,
   DevtoolsOverviewContainer,
+  RegistryPanel,
   SpaceGenerator,
   Wireframe,
-} from '../../containers';
-import { meta } from '../../meta';
-import { DebugCapabilities, type DebugSettingsProps, Devtools } from '../../types';
+} from '#containers';
+import { meta } from '#meta';
+import { DebugCapabilities, type Settings, Devtools } from '#types';
+
+// TODO(burdon): Move to config.
+const MCP_SERVER_URL = 'https://introspect-service-labs.dxos.workers.dev/mcp';
 
 type SpaceDebug = {
   type: string;
@@ -70,7 +72,7 @@ type GraphDebug = {
   root: string;
 };
 
-const isSpaceDebug = (data: any): data is SpaceDebug => data?.type === `${meta.id}/space` && isSpace(data.space);
+const isSpaceDebug = (data: any): data is SpaceDebug => data?.type === `${meta.id}.space` && isSpace(data.space);
 const isGraphDebug = (data: any): data is GraphDebug => {
   const graph = data?.graph;
   return (
@@ -78,38 +80,35 @@ const isGraphDebug = (data: any): data is GraphDebug => {
   );
 };
 
-// TODO(wittjosiah): Factor out?
-const useCurrentSpace = () => {
-  const layout = useLayout();
-  const client = useCapability(ClientCapabilities.Client);
-  const { spaceId } = parseId(layout.workspace);
-  const space = spaceId ? client.spaces.get(spaceId) : undefined;
-  return space;
-};
-
 type ReactSurfaceOptions = {
-  logBuffer: LogBuffer;
+  logStore?: IdbLogStore;
 };
 
 export default Capability.makeModule(
-  Effect.fnUntraced(function* ({ logBuffer }: ReactSurfaceOptions) {
+  Effect.fnUntraced(function* ({ logStore }: ReactSurfaceOptions) {
     const capabilities = yield* Capability.Service;
     const registry = capabilities.get(Capabilities.AtomRegistry);
     const settingsAtom = capabilities.get(DebugCapabilities.Settings);
+    const fileUploader = capabilities.getAll(AppCapabilities.FileUploader)[0];
 
     return Capability.contributes(Capabilities.ReactSurface, [
       Surface.create({
-        id: `${meta.id}/plugin-settings`,
-        role: 'article',
-        filter: (data): data is { subject: AppCapabilities.Settings } =>
-          AppCapabilities.isSettings(data.subject) && data.subject.prefix === meta.id,
+        id: 'pluginSettings',
+        filter: AppSurface.settings(AppSurface.Article, meta.id),
         component: ({ data: { subject } }) => {
-          const { settings, updateSettings } = useSettingsState<DebugSettingsProps>(subject.atom);
-          return <DebugSettings settings={settings} onSettingsChange={updateSettings} logBuffer={logBuffer} />;
+          const { settings, updateSettings } = useSettingsState<Settings.Settings>(subject.atom);
+          return (
+            <DebugSettings
+              settings={settings}
+              onSettingsChange={updateSettings}
+              logStore={logStore}
+              onUpload={fileUploader}
+            />
+          );
         },
       }),
       Surface.create({
-        id: `${meta.id}/space`,
+        id: 'space',
         role: 'article',
         filter: (data): data is { subject: SpaceDebug } => isSpaceDebug(data.subject),
         component: ({ role, data }) => {
@@ -123,7 +122,8 @@ export default Capability.makeModule(
 
               const collection =
                 data.subject.space.state.get() === SpaceState.SPACE_READY &&
-                data.subject.space.properties[Collection.Collection.typename]?.target;
+                Annotation.get(data.subject.space.properties, RootCollectionAnnotation).pipe(Option.getOrUndefined)
+                  ?.target;
               if (!Obj.instanceOf(Collection.Collection, collection)) {
                 return;
               }
@@ -138,27 +138,30 @@ export default Capability.makeModule(
             [data.subject.space, invokePromise],
           );
 
-          return (
-            <Panel.Root role={role} className='dx-article'>
-              <Panel.Content asChild>
-                <Panel.Content asChild>
-                  <SpaceGenerator space={data.subject.space} onCreateObjects={handleCreateObject} />
-                </Panel.Content>
-              </Panel.Content>
-            </Panel.Root>
-          );
+          return <SpaceGenerator role={role} space={data.subject.space} onCreateObjects={handleCreateObject} />;
         },
       }),
       Surface.create({
-        id: `${meta.id}/app-graph`,
+        id: 'appGraph',
         role: 'article',
         filter: (data): data is { subject: GraphDebug } => isGraphDebug(data.subject),
         component: ({ data }) => <DebugGraph graph={data.subject.graph} root={data.subject.root} />,
       }),
       Surface.create({
-        id: `${meta.id}/wireframe`,
+        id: 'toolsExplorer',
+        filter: AppSurface.literal(AppSurface.Article, Devtools.ToolsExplorer),
+        component: () => <ToolsExplorer serverUrl={MCP_SERVER_URL} />,
+      }),
+      Surface.create({
+        id: 'registry',
+        filter: AppSurface.literal(AppSurface.Article, Devtools.Echo.Registry),
+        component: () => <RegistryPanel />,
+      }),
+      Surface.create({
+        id: 'wireframe',
+        // TODO(wittjosiah): Split into multiple surfaces if this filter proves too strict for non-article roles.
         role: ['article', 'section'],
-        position: 'hoist',
+        position: 'first',
         filter: (data): data is { subject: Obj.Unknown } => {
           const settings = registry.get(settingsAtom);
           return Obj.isObject(data.subject) && !!settings.wireframe;
@@ -168,95 +171,95 @@ export default Capability.makeModule(
         ),
       }),
       Surface.create({
-        id: `${meta.id}/object-debug`,
-        role: 'article',
-        filter: (data): data is { companionTo: Obj.Unknown } =>
-          data.subject === 'debug' && Obj.isObject(data.companionTo),
-        component: ({ data }) => <DebugObjectPanel object={data.companionTo} />,
+        id: 'objectDebug',
+        filter: AppSurface.allOf(
+          AppSurface.literal(AppSurface.Article, 'debug'),
+          AppSurface.companion(AppSurface.Article),
+        ),
+        component: ({ role, data }) => <DebugObjectPanel role={role} companionTo={data.companionTo} />,
       }),
       Surface.create({
-        id: `${meta.id}/devtools-overview`,
-        role: 'deck-companion--devtools',
-        filter: (data): data is { subject: 'devtools' } => data.subject === 'devtools',
+        id: 'devtoolsOverview',
+        filter: AppSurface.literal(Surface.makeType<{ subject: string }>('deck-companion--devtools'), 'devtools'),
         component: () => <DevtoolsOverviewContainer />,
       }),
       Surface.create({
-        id: `${meta.id}/space-objects`,
-        role: 'deck-companion--space-objects',
-        filter: (data): data is { subject: 'space-objects' } => data.subject === 'space-objects',
-        component: () => <DebugSpaceObjectsPanel />,
+        id: 'spaceObjects',
+        filter: AppSurface.literal(
+          Surface.makeType<{ subject: string }>('deck-companion--space-objects'),
+          'space-objects',
+        ),
+        component: () => {
+          const space = useActiveSpace();
+          if (!space) {
+            return null;
+          }
+
+          return <DebugSpaceObjectsPanel space={space} />;
+        },
       }),
 
       Surface.create({
-        id: `${meta.id}/status`,
-        role: 'status',
+        id: 'debugStatus',
+        role: 'status-indicator',
+        position: 'first',
         component: () => <DebugStatus />,
       }),
+
       //
       // Devtools
       //
 
       Surface.create({
-        id: `${meta.id}/client/config`,
-        role: 'article',
-        filter: (data): data is any => data.subject === Devtools.Client.Config,
+        id: 'client.config',
+        filter: AppSurface.literal(AppSurface.Article, Devtools.Client.Config),
         component: () => <ConfigPanel vaultSelector={false} />,
       }),
       Surface.create({
-        id: `${meta.id}/client/storage`,
-        role: 'article',
-        filter: (data): data is any => data.subject === Devtools.Client.Storage,
+        id: 'client.storage',
+        filter: AppSurface.literal(AppSurface.Article, Devtools.Client.Storage),
         component: () => <StoragePanel />,
       }),
       Surface.create({
-        id: `${meta.id}/client/logs`,
-        role: 'article',
-        filter: (data): data is any => data.subject === Devtools.Client.Logs,
+        id: 'client.logs',
+        filter: AppSurface.literal(AppSurface.Article, Devtools.Client.Logs),
         component: () => <LoggingPanel />,
       }),
       Surface.create({
-        id: `${meta.id}/client/diagnostics`,
-        role: 'article',
-        filter: (data): data is any => data.subject === Devtools.Client.Diagnostics,
+        id: 'client.diagnostics',
+        filter: AppSurface.literal(AppSurface.Article, Devtools.Client.Diagnostics),
         component: () => <DiagnosticsPanel />,
       }),
       Surface.create({
-        id: `${meta.id}/client/tracing`,
-        role: 'article',
-        filter: (data): data is any => data.subject === Devtools.Client.Tracing,
-        component: () => <TracingPanel />,
-      }),
-      Surface.create({
-        id: `${meta.id}/halo/identity`,
-        role: 'article',
-        filter: (data): data is any => data.subject === Devtools.Halo.Identity,
+        id: 'halo.identity',
+        filter: AppSurface.literal(AppSurface.Article, Devtools.Halo.Identity),
         component: () => <IdentityPanel />,
       }),
       Surface.create({
-        id: `${meta.id}/halo/devices`,
-        role: 'article',
-        filter: (data): data is any => data.subject === Devtools.Halo.Devices,
+        id: 'halo.devices',
+        filter: AppSurface.literal(AppSurface.Article, Devtools.Halo.Devices),
         component: () => <DeviceListPanel />,
       }),
       Surface.create({
-        id: `${meta.id}/halo/keyring`,
-        role: 'article',
-        filter: (data): data is any => data.subject === Devtools.Halo.Keyring,
+        id: 'halo.keyring',
+        filter: AppSurface.literal(AppSurface.Article, Devtools.Halo.Keyring),
         component: () => <KeyringPanel />,
       }),
       Surface.create({
-        id: `${meta.id}/halo/credentials`,
-        role: 'article',
-        filter: (data): data is any => data.subject === Devtools.Halo.Credentials,
+        id: 'halo.credentials',
+        filter: AppSurface.literal(AppSurface.Article, Devtools.Halo.Credentials),
         component: () => {
-          const space = useCurrentSpace();
+          const space = useActiveSpace();
+          if (!space) {
+            return null;
+          }
+
           return <CredentialsPanel space={space} />;
         },
       }),
       Surface.create({
-        id: `${meta.id}/echo/spaces`,
-        role: 'article',
-        filter: (data): data is any => data.subject === Devtools.Echo.Spaces,
+        id: 'echo.spaces',
+        filter: AppSurface.literal(AppSurface.Article, Devtools.Echo.Spaces),
         component: () => {
           const { invokePromise } = useOperationInvoker();
           const handleSelect = useCallback(
@@ -267,133 +270,148 @@ export default Capability.makeModule(
         },
       }),
       Surface.create({
-        id: `${meta.id}/echo/space`,
-        role: 'article',
-        filter: (data): data is any => data.subject === Devtools.Echo.Space,
+        id: 'echo.space',
+        filter: AppSurface.literal(AppSurface.Article, Devtools.Echo.Space),
         component: () => {
-          const space = useCurrentSpace();
+          const space = useActiveSpace();
           const { invokePromise } = useOperationInvoker();
           const handleSelect = useCallback(
             () => invokePromise(LayoutOperation.Open, { subject: [Devtools.Echo.Feeds] }),
             [invokePromise],
           );
+          if (!space) {
+            return null;
+          }
+
           return <SpaceInfoPanel space={space} onSelectFeed={handleSelect} onSelectPipeline={handleSelect} />;
         },
       }),
       Surface.create({
-        id: `${meta.id}/echo/feeds`,
-        role: 'article',
-        filter: (data): data is any => data.subject === Devtools.Echo.Feeds,
+        id: 'echo.feeds',
+        filter: AppSurface.literal(AppSurface.Article, Devtools.Echo.Feeds),
         component: () => {
-          const space = useCurrentSpace();
+          const space = useActiveSpace();
+          if (!space) {
+            return null;
+          }
+
           return <FeedsPanel space={space} />;
         },
       }),
       Surface.create({
-        id: `${meta.id}/echo/objects`,
-        role: 'article',
-        filter: (data): data is any => data.subject === Devtools.Echo.Objects,
+        id: 'echo.objects',
+        filter: AppSurface.literal(AppSurface.Article, Devtools.Echo.Objects),
         component: () => {
-          const space = useCurrentSpace();
+          const space = useActiveSpace();
+          if (!space) {
+            return null;
+          }
+
           return <ObjectsPanel space={space} />;
         },
       }),
       Surface.create({
-        id: `${meta.id}/echo/schema`,
-        role: 'article',
-        filter: (data): data is any => data.subject === Devtools.Echo.Schema,
+        id: 'echo.schema',
+        filter: AppSurface.literal(AppSurface.Article, Devtools.Echo.Schema),
         component: () => {
-          const space = useCurrentSpace();
+          const space = useActiveSpace();
+          if (!space) {
+            return null;
+          }
+
           return <SchemaPanel space={space} />;
         },
       }),
       Surface.create({
-        id: `${meta.id}/echo/automerge`,
-        role: 'article',
-        filter: (data): data is any => data.subject === Devtools.Echo.Automerge,
+        id: 'echo.automerge',
+        filter: AppSurface.literal(AppSurface.Article, Devtools.Echo.Automerge),
         component: () => {
-          const space = useCurrentSpace();
+          const space = useActiveSpace();
+          if (!space) {
+            return null;
+          }
+
           return <AutomergePanel space={space} />;
         },
       }),
       Surface.create({
-        id: `${meta.id}/echo/queues`,
-        role: 'article',
-        filter: (data): data is any => data.subject === Devtools.Echo.Queues,
+        id: 'echo.queues',
+        filter: AppSurface.literal(AppSurface.Article, Devtools.Echo.Queues),
         component: () => <QueuesPanel />,
       }),
       Surface.create({
-        id: `${meta.id}/echo/members`,
-        role: 'article',
-        filter: (data): data is any => data.subject === Devtools.Echo.Members,
+        id: 'echo.members',
+        filter: AppSurface.literal(AppSurface.Article, Devtools.Echo.Members),
         component: () => {
-          const space = useCurrentSpace();
+          const space = useActiveSpace();
+          if (!space) {
+            return null;
+          }
+
           return <MembersPanel space={space} />;
         },
       }),
       Surface.create({
-        id: `${meta.id}/echo/metadata`,
-        role: 'article',
-        filter: (data): data is any => data.subject === Devtools.Echo.Metadata,
+        id: 'echo.metadata',
+        filter: AppSurface.literal(AppSurface.Article, Devtools.Echo.Metadata),
         component: () => <MetadataPanel />,
       }),
       Surface.create({
-        id: `${meta.id}/mesh/signal`,
-        role: 'article',
-        filter: (data): data is any => data.subject === Devtools.Mesh.Signal,
+        id: 'mesh.signal',
+        filter: AppSurface.literal(AppSurface.Article, Devtools.Mesh.Signal),
         component: () => <SignalPanel />,
       }),
       Surface.create({
-        id: `${meta.id}/mesh/swarm`,
-        role: 'article',
-        filter: (data): data is any => data.subject === Devtools.Mesh.Swarm,
+        id: 'mesh.swarm',
+        filter: AppSurface.literal(AppSurface.Article, Devtools.Mesh.Swarm),
         component: () => <SwarmPanel />,
       }),
       Surface.create({
-        id: `${meta.id}/mesh/network`,
-        role: 'article',
-        filter: (data): data is any => data.subject === Devtools.Mesh.Network,
+        id: 'mesh.network',
+        filter: AppSurface.literal(AppSurface.Article, Devtools.Mesh.Network),
         component: () => {
-          const space = useCurrentSpace();
+          const space = useActiveSpace();
+          if (!space) {
+            return null;
+          }
+
           return <NetworkPanel space={space} />;
         },
       }),
-      // TODO(wittjosiah): Remove?
-      // createSurface({
-      //   id: `${meta.id}/agent/dashboard`,
-      //   role: 'article',
-      //   filter: (data): data is any => data.subject === Devtools.Agent.Dashboard,
-      //   component: () => <DashboardPanel />,
-      // }),
       Surface.create({
-        id: `${meta.id}/edge/dashboard`,
-        role: 'article',
-        filter: (data): data is any => data.subject === Devtools.Edge.Dashboard,
+        id: 'edge.dashboard',
+        filter: AppSurface.literal(AppSurface.Article, Devtools.Edge.Dashboard),
         component: () => <EdgeDashboardPanel />,
       }),
       Surface.create({
-        id: `${meta.id}/edge/workflows`,
-        role: 'article',
-        filter: (data): data is any => data.subject === Devtools.Edge.Workflows,
+        id: 'edge.workflows',
+        filter: AppSurface.literal(AppSurface.Article, Devtools.Edge.Workflows),
         component: () => {
-          const space = useCurrentSpace();
+          const space = useActiveSpace();
+          if (!space) {
+            return null;
+          }
+
           return <WorkflowPanel space={space} />;
         },
       }),
       Surface.create({
-        id: `${meta.id}/edge/traces`,
-        role: 'article',
-        filter: (data): data is any => data.subject === Devtools.Edge.Traces,
+        id: 'edge.traces',
+        filter: AppSurface.literal(AppSurface.Article, Devtools.Edge.Traces),
         component: () => {
-          const space = useCurrentSpace();
-          const queueDxn = space?.properties.invocationTraceQueue?.dxn;
-          return <InvocationTraceContainer db={space?.db} queueDxn={queueDxn} detailAxis='block' />;
+          const space = useActiveSpace();
+          if (!space) {
+            return null;
+          }
+
+          const feed = space.properties.invocationTraceFeed?.target;
+          const feedDXN = feed ? Feed.getQueueUri(feed) : undefined;
+          return <InvocationTraceContainer db={space.db} feedDXN={feedDXN} detailAxis='block' />;
         },
       }),
       Surface.create({
-        id: `${meta.id}/edge/testing`,
-        role: 'article',
-        filter: (data): data is any => data.subject === Devtools.Edge.Testing,
+        id: 'edge.testing',
+        filter: AppSurface.literal(AppSurface.Article, Devtools.Edge.Testing),
         component: () => {
           const { invokePromise } = useOperationInvoker();
           const onSpaceCreate = useCallback(
@@ -412,9 +430,9 @@ export default Capability.makeModule(
                 await invokePromise(SpaceOperation.AddObject, { target: space.db, object: createResult.data.object });
               }
               log.info('script created', { result: createResult });
-              if (createResult.data?.object?.id) {
+              if (createResult.data?.object) {
                 await invokePromise(LayoutOperation.Open, {
-                  subject: [`${space.id}:${createResult.data.object.id}`],
+                  subject: [getObjectPathFromObject(createResult.data.object)],
                 });
               }
             },

package/src/capabilities/{settings/settings.ts → settings.ts}

@@ -8,14 +8,14 @@ import { Capability } from '@dxos/app-framework';
 import { AppCapabilities } from '@dxos/app-toolkit';
 import { createKvsStore } from '@dxos/effect';
 
-import { meta } from '../../meta';
-import { DebugCapabilities, DebugSettingsSchema } from '../../types';
+import { meta } from '#meta';
+import { DebugCapabilities, Settings } from '#types';
 
 export default Capability.makeModule(() =>
   Effect.sync(() => {
     const settingsAtom = createKvsStore({
       key: meta.id,
-      schema: DebugSettingsSchema,
+      schema: Settings.Settings,
       defaultValue: () => ({}),
     });
 
@@ -23,7 +23,7 @@ export default Capability.makeModule(() =>
       Capability.contributes(DebugCapabilities.Settings, settingsAtom),
       Capability.contributes(AppCapabilities.Settings, {
         prefix: meta.id,
-        schema: DebugSettingsSchema,
+        schema: Settings.Settings,
         atom: settingsAtom,
       }),
     ];

package/src/components/DebugSettings/DebugSettings.stories.tsx

@@ -0,0 +1,36 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { type Meta, type StoryObj } from '@storybook/react-vite';
+
+import { withClientProvider } from '@dxos/react-client/testing';
+import { withLayout, withTheme } from '@dxos/react-ui/testing';
+
+import { translations } from '#translations';
+
+import { DebugSettings } from './DebugSettings';
+
+const meta = {
+  title: 'plugins/plugin-debug/components/DebugSettings',
+  component: DebugSettings,
+  decorators: [withTheme(), withLayout({ layout: 'fullscreen' }), withClientProvider({ createIdentity: true })],
+  tags: ['settings'],
+  parameters: {
+    layout: 'fullscreen',
+    translations,
+  },
+} satisfies Meta<typeof DebugSettings>;
+
+export default meta;
+
+type Story = StoryObj<typeof meta>;
+
+export const Default: Story = {
+  args: {
+    settings: {
+      wireframe: false,
+    },
+    logStore: { export: async () => '' } as any,
+  },
+};