@dxos/plugin-debug 0.10.0 → 0.11.1

package/dx.config.ts

@@ -1,5 +1,5 @@
 //
-// Copyright 2025 DXOS.org
+// Copyright 2026 DXOS.org
 //
 
 import { Config2 } from '@dxos/app-framework/config';
@@ -11,29 +11,24 @@ export default Config2.make({
     name: 'Debug',
     author: 'DXOS',
     description: trim`
-      DebugPlugin is the developer toolkit for DXOS Composer. It adds a structured Devtools node
-      to the navigation graph — grouped into Client, HALO, ECHO, Mesh, and EDGE sub-sections —
-      exposing panel views for config, storage, logs, diagnostics, identity, devices, feeds,
-      objects, schemas, automerge internals, network topology, EDGE workflows, and invocation
-      traces, all driven by the @dxos/devtools component library.
-
-      The plugin contributes a Debug companion tab to every ECHO object in the deck so developers
-      can inspect raw field values and DXNs inline, and a Space Objects companion panel that lists
-      all objects in the active space with live reactive updates.
+      DebugPlugin bundles developer debugging utilities for DXOS Composer under a Debug node in the
+      SYSTEM navigation group (a sibling of the Devtools inspector).
 
       Test-data generation is available via a SpaceGenerator article surface: developers can
       create configurable batches of synthetic ECHO objects into any space collection, with a
       status indicator showing when generation is running.
 
+      The plugin contributes a Debug companion tab to every ECHO object in the deck so developers
+      can inspect raw field values and DXNs inline, and a Space Objects companion panel that lists
+      all objects in the active space with live reactive updates.
+
       Additional utilities include a wireframe overlay mode that draws labelled borders around
       every article and section surface, a log-capture and download facility backed by an
-      IdbLogStore, a ToolsExplorer connected to the DXOS MCP introspect service, and a
-      globalThis helper for manual storage-version testing.
+      IdbLogStore, and a transient-stats panel for live telemetry.
     `,
     source: 'https://github.com/dxos/dxos/tree/main/packages/plugins/plugin-debug',
     icon: { key: 'ph--bug--regular' },
     spec: 'PLUGIN.mdl',
     tags: ['labs'],
-    screenshots: [{ dark: 'https://dxos.network/plugin-details-debug-dark.png' }],
   },
 });

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@dxos/plugin-debug",
-  "version": "0.10.0",
-  "description": "DXOS Surface plugin for testing.",
+  "version": "0.11.1",
+  "description": "DXOS developer debugging utilities plugin.",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
   "repository": {
@@ -16,22 +16,22 @@
     "#capabilities": {
       "source": "./src/capabilities/index.ts",
       "types": "./dist/types/src/capabilities/index.d.ts",
-      "default": "./dist/lib/neutral/capabilities/index.mjs"
+      "default": "./dist/lib/capabilities.mjs"
     },
     "#components": {
       "source": "./src/components/index.ts",
       "types": "./dist/types/src/components/index.d.ts",
-      "default": "./dist/lib/neutral/components/index.mjs"
+      "default": "./dist/lib/components.mjs"
     },
     "#containers": {
       "source": "./src/containers/index.ts",
       "types": "./dist/types/src/containers/index.d.ts",
-      "default": "./dist/lib/neutral/containers/index.mjs"
+      "default": "./dist/lib/containers.mjs"
     },
     "#meta": {
       "source": "./src/meta.ts",
       "types": "./dist/types/src/meta.d.ts",
-      "default": "./dist/lib/neutral/meta.mjs"
+      "default": "./dist/lib/meta.mjs"
     },
     "#plugin": {
       "source": {
@@ -40,37 +40,37 @@
         "default": "./src/DebugPlugin.tsx"
       },
       "types": "./dist/types/src/DebugPlugin.d.ts",
-      "workerd": "./dist/lib/neutral/DebugPlugin.workerd.mjs",
-      "node": "./dist/lib/neutral/DebugPlugin.node.mjs",
-      "default": "./dist/lib/neutral/DebugPlugin.mjs"
+      "workerd": "./dist/lib/DebugPlugin.workerd.mjs",
+      "node": "./dist/lib/DebugPlugin.node.mjs",
+      "default": "./dist/lib/DebugPlugin.mjs"
     },
     "#translations": {
       "source": "./src/translations.ts",
       "types": "./dist/types/src/translations.d.ts",
-      "default": "./dist/lib/neutral/translations.mjs"
+      "default": "./dist/lib/translations.mjs"
     },
     "#types": {
       "source": "./src/types/index.ts",
       "types": "./dist/types/src/types/index.d.ts",
-      "default": "./dist/lib/neutral/types/index.mjs"
+      "default": "./dist/lib/types.mjs"
     }
   },
   "exports": {
     ".": {
       "source": "./src/index.ts",
       "types": "./dist/types/src/index.d.ts",
-      "default": "./dist/lib/neutral/index.mjs"
+      "import": "./dist/lib/index.mjs"
     },
     "./assets/PLUGIN.mdl": "./PLUGIN.mdl",
     "./plugin": {
       "source": "./src/plugin.ts",
       "types": "./dist/types/src/plugin.d.ts",
-      "default": "./dist/lib/neutral/plugin.mjs"
+      "import": "./dist/lib/plugin.mjs"
     },
     "./translations": {
       "source": "./src/translations.ts",
       "types": "./dist/types/src/translations.d.ts",
-      "default": "./dist/lib/neutral/translations.mjs"
+      "import": "./dist/lib/translations.mjs"
     }
   },
   "types": "dist/types/src/index.d.ts",
@@ -83,50 +83,48 @@
   "dependencies": {
     "@antv/graphlib": "^2.0.4",
     "@antv/layout": "^1.2.13",
+    "@effect-atom/atom": "^0.5.3",
     "@effect-atom/atom-react": "^0.5.0",
     "@tldraw/tldraw": "^3.0.0",
     "react-resize-detector": "^11.0.1",
-    "@dxos/app-framework": "0.10.0",
-    "@dxos/app-toolkit": "0.10.0",
-    "@dxos/assistant-toolkit": "0.10.0",
-    "@dxos/async": "0.10.0",
-    "@dxos/compute": "0.10.0",
-    "@dxos/client-services": "0.10.0",
-    "@dxos/compute-hyperformula": "0.10.0",
-    "@dxos/conductor": "0.10.0",
-    "@dxos/config": "0.10.0",
-    "@dxos/devtools": "0.10.0",
-    "@dxos/echo-host": "0.10.0",
-    "@dxos/effect": "0.10.0",
-    "@dxos/invariant": "0.10.0",
-    "@dxos/keys": "0.10.0",
-    "@dxos/echo": "0.10.0",
-    "@dxos/operation": "0.10.0",
-    "@dxos/plugin-graph": "0.10.0",
-    "@dxos/log-store-idb": "0.10.0",
-    "@dxos/log": "0.10.0",
-    "@dxos/plugin-markdown": "0.10.0",
-    "@dxos/plugin-inbox": "0.10.0",
-    "@dxos/plugin-sheet": "0.10.0",
-    "@dxos/plugin-script": "0.10.0",
-    "@dxos/plugin-sketch": "0.10.0",
-    "@dxos/plugin-space": "0.10.0",
-    "@dxos/plugin-status-bar": "0.10.0",
-    "@dxos/protocols": "0.10.0",
-    "@dxos/random": "0.10.0",
-    "@dxos/react-client": "0.10.0",
-    "@dxos/react-ui-attention": "0.10.0",
-    "@dxos/plugin-client": "0.10.0",
-    "@dxos/react-ui-canvas-compute": "0.10.0",
-    "@dxos/react-ui-form": "0.10.0",
-    "@dxos/react-ui-introspect": "0.10.0",
-    "@dxos/react-ui-table": "0.10.0",
-    "@dxos/react-ui-canvas-editor": "0.10.0",
-    "@dxos/react-ui-syntax-highlighter": "0.10.0",
-    "@dxos/schema": "0.10.0",
-    "@dxos/tracing": "0.10.0",
-    "@dxos/types": "0.10.0",
-    "@dxos/util": "0.10.0"
+    "@dxos/app-framework": "0.11.1",
+    "@dxos/assistant-toolkit": "0.11.1",
+    "@dxos/app-toolkit": "0.11.1",
+    "@dxos/async": "0.11.1",
+    "@dxos/compute": "0.11.1",
+    "@dxos/compute-hyperformula": "0.11.1",
+    "@dxos/conductor": "0.11.1",
+    "@dxos/config": "0.11.1",
+    "@dxos/devtools": "0.11.1",
+    "@dxos/echo": "0.11.1",
+    "@dxos/echo-react": "0.11.1",
+    "@dxos/effect": "0.11.1",
+    "@dxos/invariant": "0.11.1",
+    "@dxos/keys": "0.11.1",
+    "@dxos/log": "0.11.1",
+    "@dxos/log-store-idb": "0.11.1",
+    "@dxos/operation": "0.11.1",
+    "@dxos/plugin-graph": "0.11.1",
+    "@dxos/plugin-illustrator": "0.11.1",
+    "@dxos/plugin-inbox": "0.11.1",
+    "@dxos/plugin-sheet": "0.11.1",
+    "@dxos/plugin-markdown": "0.11.1",
+    "@dxos/plugin-tldraw": "0.11.1",
+    "@dxos/protocols": "0.11.1",
+    "@dxos/plugin-status-bar": "0.11.1",
+    "@dxos/plugin-space": "0.11.1",
+    "@dxos/random": "0.11.1",
+    "@dxos/react-client": "0.11.1",
+    "@dxos/react-ui-attention": "0.11.1",
+    "@dxos/react-ui-canvas-compute": "0.11.1",
+    "@dxos/react-ui-canvas-editor": "0.11.1",
+    "@dxos/react-ui-syntax-highlighter": "0.11.1",
+    "@dxos/react-ui-debug": "0.11.1",
+    "@dxos/react-ui-form": "0.11.1",
+    "@dxos/schema": "0.11.1",
+    "@dxos/tracing": "0.11.1",
+    "@dxos/types": "0.11.1",
+    "@dxos/util": "0.11.1"
   },
   "devDependencies": {
     "@effect-atom/atom-react": "^0.5.0",
@@ -136,11 +134,11 @@
     "effect": "3.21.4",
     "react": "~19.2.7",
     "react-dom": "~19.2.7",
-    "vite": "^8.0.16",
-    "@dxos/react-ui": "0.10.0",
-    "@dxos/storybook-utils": "0.10.0",
-    "@dxos/ui-theme": "0.10.0",
-    "@dxos/plugin-testing": "0.10.0"
+    "vite": "^8.1.4",
+    "@dxos/plugin-testing": "0.11.1",
+    "@dxos/react-ui": "0.11.1",
+    "@dxos/storybook-utils": "0.11.1",
+    "@dxos/ui-theme": "0.11.1"
   },
   "peerDependencies": {
     "@effect-atom/atom-react": "^0.5.0",
@@ -148,9 +146,9 @@
     "effect": "3.21.4",
     "react": "~19.2.7",
     "react-dom": "~19.2.7",
-    "@dxos/random": "0.10.0",
-    "@dxos/react-ui": "0.10.0",
-    "@dxos/ui-theme": "0.10.0"
+    "@dxos/random": "^0.11.1",
+    "@dxos/react-ui": "^0.11.1",
+    "@dxos/ui-theme": "^0.11.1"
   },
   "publishConfig": {
     "access": "public"

package/src/DebugPlugin.node.ts

@@ -1,5 +1,5 @@
 //
-// Copyright 2023 DXOS.org
+// Copyright 2026 DXOS.org
 //
 
 import { Plugin } from '@dxos/app-framework';

package/src/DebugPlugin.tsx

@@ -1,14 +1,11 @@
 //
-// Copyright 2023 DXOS.org
+// Copyright 2026 DXOS.org
 //
 
-import * as Effect from 'effect/Effect';
-
 import { ActivationEvents, Capability, Plugin } from '@dxos/app-framework';
 import { AppPlugin } from '@dxos/app-toolkit';
-import { type Client } from '@dxos/react-client';
 
-import { AppGraphBuilder, DebugSettings, ReactContext, ReactSurface } from '#capabilities';
+import { AppGraphBuilder, DebugSettings, LogRecording, ReactSurface, StatsPanel } from '#capabilities';
 import { meta } from '#meta';
 import { translations } from '#translations';
 import { type DebugPluginOptions } from '#types';
@@ -16,43 +13,29 @@ import { type DebugPluginOptions } from '#types';
 // eslint-disable-next-line import/no-relative-packages
 import pluginSpec from '../PLUGIN.mdl?raw';
 
-// TODO(wittjosiah): Factor out DevtoolsPlugin?
-
 export const DebugPlugin = Plugin.define<DebugPluginOptions>(meta).pipe(
   AppPlugin.addAppGraphModule({ activate: AppGraphBuilder }),
-  AppPlugin.addReactContextModule({ activate: ReactContext }),
   AppPlugin.addSettingsModule({ activate: DebugSettings }),
   Plugin.addModule(({ logStore }) => ({
     id: Capability.getModuleTag(ReactSurface) ?? 'surfaces',
     activatesOn: ActivationEvents.SetupReactSurface,
     activate: () => ReactSurface({ logStore }),
   })),
-  AppPlugin.addTranslationsModule({ translations }),
   Plugin.addModule({
-    id: 'setup-devtools',
+    id: 'log-recording',
     activatesOn: ActivationEvents.Startup,
-    activate: () => Effect.sync(() => setupDevtools()),
+    activate: LogRecording,
   }),
+  AppPlugin.addTranslationsModule({ translations }),
+  Plugin.addModule(({ persistStats }) => ({
+    id: 'stats-panel',
+    activatesOn: ActivationEvents.Startup,
+    activate: () => StatsPanel({ persist: persistStats ?? true }),
+  })),
   AppPlugin.addPluginAssetModule({
     asset: { pluginId: meta.profile.key, path: 'PLUGIN.mdl', content: pluginSpec, mimeType: 'application/x-mdl' },
   }),
   Plugin.make,
 );
 
-const setupDevtools = () => {
-  (globalThis as any).composer ??= {};
-
-  // Used to test how composer handles breaking protocol changes.
-  (globalThis as any).composer.changeStorageVersionInMetadata = async (version: number) => {
-    const { changeStorageVersionInMetadata } = await import('@dxos/echo-host/testing');
-    const { createStorageObjects } = await import('@dxos/client-services');
-    const client: Client = (window as any).dxos.client;
-    const config = client.config;
-    await client.destroy();
-    const { storage } = createStorageObjects(config.values?.runtime?.client?.storage ?? {});
-    await changeStorageVersionInMetadata(storage, version);
-    location.pathname = '/';
-  };
-};
-
 export default DebugPlugin;

package/src/DebugPlugin.workerd.ts

@@ -1,5 +1,5 @@
 //
-// Copyright 2023 DXOS.org
+// Copyright 2026 DXOS.org
 //
 
 import { Plugin } from '@dxos/app-framework';

package/src/capabilities/DebugSurfaces.tsx

@@ -0,0 +1,146 @@
+//
+// Copyright 2026 DXOS.org
+//
+
+// Surface components that cannot be expressed as a `props` mapper, because they call hooks or compose.
+
+import { useAtomValue } from '@effect-atom/atom-react';
+import * as Option from 'effect/Option';
+import React, { useCallback, useMemo } from 'react';
+
+import { useAtomCapability, useOperationInvoker, useSettingsState } from '@dxos/app-framework/ui';
+import { AppAnnotation, type AppCapabilities, GraphPath, LayoutOperation } from '@dxos/app-toolkit';
+import { useActiveSpace } from '@dxos/app-toolkit/ui';
+import { Annotation, Collection, Entity, Filter, Obj, Type } from '@dxos/echo';
+import { HiddenAnnotation } from '@dxos/echo/Annotation';
+import { type IdbLogStore } from '@dxos/log-store-idb';
+import { SpaceCapabilities, SpaceOperation } from '@dxos/plugin-space';
+import { useClient } from '@dxos/react-client';
+import { type Space, SpaceState } from '@dxos/react-client/echo';
+import { Panel } from '@dxos/react-ui';
+import { Logger } from '@dxos/react-ui-debug';
+
+import { DebugObjectPanel, DebugSettings, DebugSpaceObjectsPanel, SpaceGenerator } from '#containers';
+import { type Settings } from '#types';
+
+/** Returns `onOpen` and `canOpen` for the ObjectsTree "Open" action. */
+const useObjectOpenAction = (invokePromise: ReturnType<typeof useOperationInvoker>['invokePromise']) => {
+  const client = useClient();
+  const spaceSettings = useAtomCapability(SpaceCapabilities.Settings);
+  const showHidden = spaceSettings?.showHidden ?? false;
+
+  const allTypes = useAtomValue(useMemo(() => client.graph.registry.query(Filter.type(Type.Type)).atom, [client]));
+
+  const hiddenTypenames = useMemo(() => {
+    const result = new Set<string>();
+    for (const typeEntity of allTypes) {
+      const schema = Type.getSchema(typeEntity);
+      if (HiddenAnnotation.get(schema).pipe(Option.getOrElse(() => false))) {
+        result.add(Type.getTypename(typeEntity));
+      }
+    }
+    return result;
+  }, [allTypes]);
+
+  const onOpen = useCallback(
+    (object: Obj.Unknown) => {
+      void invokePromise(LayoutOperation.Open, { subject: [GraphPath.getObjectPathFromObject(object)] });
+    },
+    [invokePromise],
+  );
+
+  const canOpen = useCallback(
+    (entity: Entity.Snapshot) => {
+      if (showHidden) {
+        return true;
+      }
+      const typename = Entity.getTypename(entity);
+      return !hiddenTypenames.has(typename ?? '');
+    },
+    [showHidden, hiddenTypenames],
+  );
+
+  return { onOpen, canOpen };
+};
+
+export type DebugSettingsSurfaceProps = {
+  subject: AppCapabilities.Settings;
+  logStore?: IdbLogStore;
+  onUpload?: AppCapabilities.FileUploader;
+};
+
+export const DebugSettingsSurface = ({ subject, logStore, onUpload }: DebugSettingsSurfaceProps) => {
+  const { settings, updateSettings } = useSettingsState<Settings.Settings>(subject.atom);
+
+  return (
+    <DebugSettings settings={settings} onSettingsChange={updateSettings} logStore={logStore} onUpload={onUpload} />
+  );
+};
+
+export type SpaceGeneratorSurfaceProps = {
+  role: string;
+  space: Space;
+};
+
+/** Generated objects are added to the space's root collection, resolved at invocation time. */
+export const SpaceGeneratorSurface = ({ role, space }: SpaceGeneratorSurfaceProps) => {
+  const { invokePromise } = useOperationInvoker();
+  const handleCreateObjects = useCallback(
+    (objects: Obj.Unknown[]) => {
+      const collection =
+        space.state.get() === SpaceState.SPACE_READY &&
+        Annotation.get(space.properties, AppAnnotation.RootCollectionAnnotation).pipe(Option.getOrUndefined)?.target;
+      if (!Obj.instanceOf(Collection.Collection, collection)) {
+        return;
+      }
+
+      objects.forEach((object) => {
+        void invokePromise(SpaceOperation.AddObject, { target: collection, object });
+      });
+    },
+    [space, invokePromise],
+  );
+
+  return <SpaceGenerator role={role} space={space} onCreateObjects={handleCreateObjects} />;
+};
+
+export type ObjectDebugSurfaceProps = {
+  role: string;
+  companionTo: Obj.Unknown;
+};
+
+export const ObjectDebugSurface = ({ role, companionTo }: ObjectDebugSurfaceProps) => {
+  const { invokePromise } = useOperationInvoker();
+  const { onOpen, canOpen } = useObjectOpenAction(invokePromise);
+
+  return <DebugObjectPanel role={role} companionTo={companionTo} onOpen={onOpen} canOpen={canOpen} />;
+};
+
+export const SpaceObjectsSurface = () => {
+  const space = useActiveSpace();
+  const { invokePromise } = useOperationInvoker();
+  const { onOpen, canOpen } = useObjectOpenAction(invokePromise);
+  if (!space) {
+    return null;
+  }
+
+  return <DebugSpaceObjectsPanel space={space} onOpen={onOpen} canOpen={canOpen} />;
+};
+
+export const LoggerSurface = () => (
+  <Logger.Root>
+    <Panel.Root>
+      <Panel.Toolbar asChild>
+        <Logger.Toolbar />
+      </Panel.Toolbar>
+      <Panel.Content asChild>
+        <Logger.Content>
+          <Logger.List />
+        </Logger.Content>
+      </Panel.Content>
+      <Panel.Statusbar asChild>
+        <Logger.Filter />
+      </Panel.Statusbar>
+    </Panel.Root>
+  </Logger.Root>
+);