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

package/src/containers/RegistryPanel/RegistryPanel.tsx

@@ -0,0 +1,150 @@
+//
+// Copyright 2026 DXOS.org
+//
+
+import React, { useCallback, useEffect, useMemo, useState } from 'react';
+
+import { Operation } from '@dxos/compute';
+import { JsonView, PanelContainer, Placeholder, Searchbar } from '@dxos/devtools';
+import { Entity, Format, Obj, Type } from '@dxos/echo';
+import { useClient } from '@dxos/react-client';
+import { Toolbar } from '@dxos/react-ui';
+import { DynamicTable, type TableFeatures } from '@dxos/react-ui-table';
+import { mx } from '@dxos/ui-theme';
+
+type RegistryRow = {
+  id: string;
+  kind: string;
+  label: string;
+  _entity: Entity.Unknown;
+};
+
+const textFilter = (text?: string) => {
+  if (!text) {
+    return () => true;
+  }
+
+  const matcher = new RegExp(text, 'i');
+  return (entity: Entity.Unknown) => {
+    const typename = Entity.getTypename(entity) ?? '';
+    const metaKey = Obj.isObject(entity) ? (Obj.getMeta(entity).key ?? '') : '';
+    const uri = Type.isType(entity) ? (Type.getURI(entity)?.toString() ?? '') : '';
+    const operationKey =
+      Obj.isObject(entity) && Obj.instanceOf(Operation.PersistentOperation, entity)
+        ? (Operation.getKey(entity) ?? '')
+        : '';
+    const name = Obj.isObject(entity) && Obj.instanceOf(Operation.PersistentOperation, entity) ? entity.name : '';
+    return [typename, metaKey, uri, operationKey, name, getEntityId(entity)].some((value) => value.match(matcher));
+  };
+};
+
+const getEntityId = (entity: Entity.Unknown): string => {
+  if (entity.id) {
+    return entity.id;
+  }
+  if (Type.isType(entity)) {
+    return Type.getURI(entity)?.toString() ?? Type.getTypename(entity) ?? 'unknown-type';
+  }
+  return Entity.getTypename(entity) ?? 'unknown';
+};
+
+const getKind = (entity: Entity.Unknown): string => {
+  if (Type.isType(entity)) {
+    return 'type';
+  }
+  if (Obj.isObject(entity) && Obj.instanceOf(Operation.PersistentOperation, entity)) {
+    return 'operation';
+  }
+  return 'other';
+};
+
+const getLabel = (entity: Entity.Unknown): string => {
+  if (Obj.isObject(entity) && Obj.instanceOf(Operation.PersistentOperation, entity)) {
+    return entity.name || Operation.getKey(entity) || getEntityId(entity);
+  }
+  if (Type.isType(entity)) {
+    return Type.getTypename(entity) ?? getEntityId(entity);
+  }
+  return getEntityId(entity);
+};
+
+const toDetailJson = (entity: Entity.Unknown): object => {
+  if (Type.isType(entity)) {
+    return {
+      id: getEntityId(entity),
+      typename: Type.getTypename(entity),
+      uri: Type.getURI(entity)?.toString(),
+      version: Type.getVersion(entity),
+      jsonSchema: entity.jsonSchema,
+    };
+  }
+  if (Obj.isObject(entity)) {
+    return Obj.toJSON(entity);
+  }
+  return { id: getEntityId(entity), typename: Entity.getTypename(entity) };
+};
+
+export const RegistryPanel = () => {
+  const client = useClient();
+  const [entities, setEntities] = useState<Entity.Unknown[]>([]);
+  const [filter, setFilter] = useState('');
+  const [selected, setSelected] = useState<Entity.Unknown>();
+
+  useEffect(() => {
+    const registry = client.graph.registry;
+    const refresh = () => setEntities([...registry.list()]);
+    refresh();
+    return registry.changed.on(refresh);
+  }, [client]);
+
+  const properties = useMemo(
+    () => [
+      { name: 'kind', format: Format.TypeFormat.String, size: 100 },
+      { name: 'label', format: Format.TypeFormat.String },
+      { name: 'id', format: Format.TypeFormat.String, size: 280 },
+    ],
+    [],
+  );
+
+  const rows = useMemo((): RegistryRow[] => {
+    return entities
+      .filter(textFilter(filter))
+      .map((entity) => ({
+        id: getEntityId(entity),
+        kind: getKind(entity),
+        label: getLabel(entity),
+        _entity: entity,
+      }))
+      .toSorted((left, right) => left.label.localeCompare(right.label));
+  }, [entities, filter]);
+
+  const handleRowClicked = useCallback((row: RegistryRow | undefined) => {
+    if (!row?._entity) {
+      return;
+    }
+    setSelected(row._entity);
+  }, []);
+
+  const detailJson = useMemo(() => (selected ? toDetailJson(selected) : undefined), [selected]);
+
+  const features: Partial<TableFeatures> = useMemo(() => ({ selection: { enabled: true, mode: 'single' } }), []);
+
+  return (
+    <PanelContainer
+      toolbar={
+        <Toolbar.Root>
+          <Searchbar placeholder='Filter...' onChange={setFilter} />
+        </Toolbar.Root>
+      }
+    >
+      <div className={mx('h-full grid grid-cols-[2fr_1fr] overflow-hidden')}>
+        <div className={mx('flex flex-col min-h-0 overflow-hidden')}>
+          <DynamicTable properties={properties} rows={rows} features={features} onRowClick={handleRowClicked} />
+        </div>
+        <div className={mx('min-h-0 h-full overflow-auto border-s border-separator text-sm')}>
+          {detailJson ? <JsonView data={detailJson} /> : <Placeholder label='Details' />}
+        </div>
+      </div>
+    </PanelContainer>
+  );
+};

package/src/containers/RegistryPanel/index.ts

@@ -0,0 +1,5 @@
+//
+// Copyright 2026 DXOS.org
+//
+
+export { RegistryPanel as default, RegistryPanel } from './RegistryPanel';

package/src/containers/SpaceGenerator/SpaceGenerator.tsx

@@ -0,0 +1,127 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import React, { useCallback, useMemo, useState } from 'react';
+
+import { useOperationInvoker } from '@dxos/app-framework/ui';
+import { ComputeGraph } from '@dxos/conductor';
+import { Filter, Obj, Type } from '@dxos/echo';
+import { Markdown } from '@dxos/plugin-markdown';
+import { Sheet } from '@dxos/plugin-sheet';
+import { Sketch } from '@dxos/plugin-sketch';
+import { useClient } from '@dxos/react-client';
+import { type Space } from '@dxos/react-client/echo';
+import { IconButton, Input, Panel, ScrollArea, Toolbar, useAsyncEffect } from '@dxos/react-ui';
+import { composable, composableProps } from '@dxos/react-ui';
+import { Organization, Person, Task } from '@dxos/types';
+import { sortKeys } from '@dxos/util';
+
+import { type ObjectGenerator, SchemaTable, createGenerator, generator, staticGenerators } from '#components';
+
+// TODO(burdon): Make extensible.
+const staticTypes = [Markdown.Document, Sketch.Sketch, Sheet.Sheet, ComputeGraph];
+const recordTypes: Type.AnyObj[] = [Organization.Organization, Person.Person, Task.Task];
+
+export type SpaceGeneratorProps = {
+  space: Space;
+  onCreateObjects?: (objects: Obj.Unknown[]) => void;
+};
+
+export const SpaceGenerator = composable<HTMLDivElement, SpaceGeneratorProps>(
+  ({ space, onCreateObjects, children, ...props }, forwardedRef) => {
+    const { invokePromise } = useOperationInvoker();
+    const client = useClient();
+    const [count, setCount] = useState(1);
+    const [info, setInfo] = useState<any>({});
+    const presets = useMemo(() => generator(), []);
+
+    // Register types.
+    useAsyncEffect(async () => {
+      await client.addTypes([...staticTypes, ...recordTypes, ...presets.schemas]);
+    }, [client, presets]);
+
+    // Create type generators.
+    const typeMap = useMemo(() => {
+      const recordGenerators = new Map<string, ObjectGenerator<any>>(
+        recordTypes.map((type) => [Type.getTypename(type), createGenerator(client, invokePromise, type)]),
+      );
+
+      return new Map([...staticGenerators, ...presets.items, ...recordGenerators]);
+    }, [client, invokePromise, presets]);
+
+    // Query space to get info.
+    const updateInfo = useCallback(async () => {
+      const allSchema = [...space.db.graph.registry.list().filter(Type.isType)];
+      const echoSchema = allSchema.filter((t) => Type.isTypeKind(t));
+      const staticSchema = allSchema.filter((t) => !Type.isTypeKind(t));
+
+      const objects = await space.db.query(Filter.everything()).run();
+      const objectMap = sortKeys(
+        objects.reduce<Record<string, number>>((map, obj) => {
+          const type = Obj.getTypename(obj);
+          if (type) {
+            const count = map[type] ?? 0;
+            map[type] = count + 1;
+          }
+
+          return map;
+        }, {}),
+      );
+
+      setInfo({
+        schema: {
+          static: staticSchema.length,
+          mutable: echoSchema.length,
+        },
+        objects: objectMap,
+      });
+    }, [space]);
+
+    useAsyncEffect(updateInfo, [updateInfo]);
+
+    const handleCreateData = useCallback(
+      async (typename: string) => {
+        const constructor = typeMap.get(typename);
+        if (constructor) {
+          // TODO(burdon): Input to specify number of objects.
+          await constructor(space, count, onCreateObjects);
+          await updateInfo();
+        }
+      },
+      [typeMap, count, space, onCreateObjects, updateInfo],
+    );
+
+    return (
+      <Panel.Root {...composableProps(props)} ref={forwardedRef}>
+        <Panel.Toolbar asChild>
+          <Toolbar.Root>
+            <IconButton icon='ph--arrow-clockwise--regular' iconOnly label='Refresh' onClick={updateInfo} />
+            <Toolbar.Separator />
+            <Input.Root>
+              <Input.TextInput
+                type='number'
+                placeholder='Count'
+                classNames='w-[4rem] text-right'
+                min={1}
+                max={100}
+                size={8}
+                value={count}
+                onChange={(event) => setCount(parseInt(event.target.value))}
+              />
+            </Input.Root>
+          </Toolbar.Root>
+        </Panel.Toolbar>
+        <Panel.Content asChild>
+          <ScrollArea.Root thin orientation='vertical'>
+            <ScrollArea.Viewport classNames='dx-document gap-4 divide-y divide-subdued-separator'>
+              <SchemaTable types={staticTypes} objects={info.objects} label='Static Types' onClick={handleCreateData} />
+              <SchemaTable types={recordTypes} objects={info.objects} label='Record Types' onClick={handleCreateData} />
+              <SchemaTable types={presets.types} objects={info.objects} label='Presets' onClick={handleCreateData} />
+            </ScrollArea.Viewport>
+          </ScrollArea.Root>
+        </Panel.Content>
+      </Panel.Root>
+    );
+  },
+);

package/src/containers/SpaceGenerator/index.ts

@@ -0,0 +1,5 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+export { SpaceGenerator as default } from './SpaceGenerator';

package/src/{components → containers/Wireframe}/Wireframe.tsx

@@ -5,36 +5,31 @@
 import React from 'react';
 import { useResizeDetector } from 'react-resize-detector';
 
-import { type Obj } from '@dxos/echo';
-import { fullyQualifiedId } from '@dxos/react-client/echo';
+import { Obj } from '@dxos/echo';
 import { type ThemedClassName } from '@dxos/react-ui';
 import { useAttentionAttributes } from '@dxos/react-ui-attention';
-import { SyntaxHighlighter } from '@dxos/react-ui-syntax-highlighter';
-import { mx } from '@dxos/react-ui-theme';
+import { JsonHighlighter } from '@dxos/react-ui-syntax-highlighter';
+import { mx } from '@dxos/ui-theme';
 
 // TODO(burdon): Create generic container with wireframe mode.
 export type WireframeProps = ThemedClassName<{
+  object: Obj.Unknown;
   label?: string;
-  object: Obj.Any;
 }>;
 
 // TODO(burdon): Make focusable and attendable with input.
 export const Wireframe = ({ classNames, label, object }: WireframeProps) => {
-  const attentionAttrs = useAttentionAttributes(fullyQualifiedId(object));
+  const attentionAttrs = useAttentionAttributes(Obj.getURI(object));
   const { width, height, ref } = useResizeDetector();
 
   return (
-    <div ref={ref} className={mx('relative grow min-bs-96', classNames)} {...attentionAttrs}>
+    <div ref={ref} className={mx('relative grow min-h-96', classNames)} {...attentionAttrs}>
       <div className='absolute inset-2 flex flex-col gap-2 overflow-hidden font-mono'>
         <div className='flex justify-between'>
           <div>{label}</div>
           <div>{`[${width}x${height}]`}</div>
         </div>
-        {object && (
-          <SyntaxHighlighter language='json' classNames='text-xs opacity-75 rounded'>
-            {JSON.stringify(object, undefined, 2)}
-          </SyntaxHighlighter>
-        )}
+        {object && <JsonHighlighter data={object} classNames='text-xs opacity-75 rounded-sm' />}
       </div>
       <svg width={width} height={height} className='bg-transparent *:text-subdued'>
         <rect x={0} y={0} width={width} height={height} strokeWidth={1} fill='none' />

package/src/containers/Wireframe/index.ts

@@ -0,0 +1,5 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+export { Wireframe as default } from './Wireframe';

package/src/containers/index.ts

@@ -0,0 +1,15 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import { type ComponentType, lazy } from 'react';
+
+export const DebugGraph: ComponentType<any> = lazy(() => import('./DebugGraph'));
+export const DebugObjectPanel: ComponentType<any> = lazy(() => import('./DebugObjectPanel'));
+export const DebugStatus: ComponentType<any> = lazy(() => import('./DebugStatus'));
+export const DevtoolsOverviewContainer: ComponentType<any> = lazy(() => import('./DevtoolsOverviewContainer'));
+export const SpaceGenerator: ComponentType<any> = lazy(() => import('./SpaceGenerator'));
+export const Wireframe: ComponentType<any> = lazy(() => import('./Wireframe'));
+export const DebugSpaceObjectsPanel: ComponentType<any> = lazy(() => import('./DebugSpaceObjectsPanel'));
+export const GithubPanel: ComponentType<any> = lazy(() => import('./GithubPanel'));
+export const RegistryPanel: ComponentType<any> = lazy(() => import('./RegistryPanel'));

package/src/index.ts

@@ -2,5 +2,5 @@
 // Copyright 2023 DXOS.org
 //
 
-export * from './DebugPlugin';
 export * from './meta';
+export * from './types';

package/src/meta.ts

@@ -2,14 +2,37 @@
 // Copyright 2023 DXOS.org
 //
 
-import { type PluginMeta } from '@dxos/app-framework';
+import { Plugin } from '@dxos/app-framework';
+import { DXN } from '@dxos/keys';
+import { trim } from '@dxos/util';
 
-export const meta: PluginMeta = {
-  id: 'dxos.org/plugin/debug',
+export const meta = Plugin.makeMeta({
+  key: DXN.make('org.dxos.plugin.debug'),
   name: 'Debug',
-  description:
-    'The debug plugin is useful for troubleshooting inside of Composer. You can also use the Debug plugin to create test data inside of sheets or tables or explore pre-built automations. Non-technical users will likely not spend much time here, but this plugin is invaluable for developers and technical users.',
+  author: 'DXOS',
+  spec: 'PLUGIN.mdl',
+  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.
+
+    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.
+
+    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.
+  `,
   icon: 'ph--bug--regular',
   source: 'https://github.com/dxos/dxos/tree/main/packages/plugins/plugin-debug',
   screenshots: ['https://dxos.network/plugin-details-debug-dark.png'],
-};
+  tags: ['labs'],
+});

package/src/plugin.ts

@@ -0,0 +1,10 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import { Plugin } from '@dxos/app-framework';
+
+import { meta } from './meta';
+
+export const DebugPlugin = Plugin.lazy(meta, () => import('#plugin'));
+export type { DebugPluginOptions } from '#types';

package/src/translations.ts

@@ -3,71 +3,96 @@
 //
 
 import { type Resource } from '@dxos/react-ui';
+import { translations as introspectTranslations } from '@dxos/react-ui-introspect/translations';
 
-import { meta } from './meta';
+import { meta } from '#meta';
 
 export const translations = [
+  ...introspectTranslations,
   {
     'en-US': {
       [meta.id]: {
-        'plugin name': 'Debug',
-        'settings title': 'Debug settings',
-        'mutation count': 'Number of mutations',
-        'mutation period': 'Mutation period',
-        'open devtools label': 'Open DevTools',
-        'devtools label': 'DevTools',
-        'devtools overview label': 'DevTools Stats',
-        'debug label': 'Debug',
-        'debug app graph label': 'App Graph',
-        'settings show debug panel': 'Show Debug panel.',
-        'settings show devtools panel': 'Show DevTools panel.',
-        'settings wireframe': 'Show wireframes.',
-        'settings repair': 'Run repair tool.',
-        'settings download diagnostics': 'Download diagnostics.',
-        'settings uploaded': 'Uploaded to IPFS',
-        'settings uploaded to clipboard': 'URL copied to clipboard.',
-        'settings repair success': 'Repair succeeded',
-        'settings repair failed': 'Repair failed',
-        'settings choose storage adaptor': 'Storage adaptor (worker reload required).',
-        'settings storage adaptor idb label': 'IndexedDB',
-        'settings storage adaptor opfs label': 'OPFS',
-        'settings data store label': 'Data Store',
-        'settings storage adapter changed alert':
+        'plugin.name': 'Debug',
+        'settings.title': 'Debug settings',
+        'open-devtools.label': 'Open DevTools',
+        'devtools.label': 'DevTools',
+        'devtools-overview.label': 'Stats',
+        'space-objects.label': 'Database',
+        'debug.label': 'Debug',
+        'generate-objects.label': 'Generate Objects',
+        'debug-app-graph.label': 'App Graph',
+        'debug-tools-explorer.label': 'SDK Explorer',
+
+        'settings.wireframe.label': 'Show wireframes.',
+        'settings.wireframe.description': 'Overlay wireframe outlines on UI components for debugging layout.',
+        'settings.trace-all.label': 'Trace all requests (100% sampling).',
+        'settings.trace-all.description':
+          'Override the default 30% sampling rate to capture all traces. Requires page reload to take effect.',
+        'settings.tracing-panel.label': 'Open tracing panel.',
+        'settings.tracing-panel.description': 'Open the tracing dashboard to inspect captured spans.',
+        'settings.repair.label': 'Run repair tool.',
+        'settings.repair.description': 'Attempt to detect and fix inconsistencies in local data storage.',
+        'settings.download-diagnostics.label': 'Download diagnostics.',
+        'settings.download-diagnostics.description':
+          'Export a JSON file containing client diagnostics for troubleshooting.',
+        'settings.download-logs.label': 'Download log buffer.',
+        'settings.download-logs.description': 'Export the in-memory log buffer as an NDJSON file.',
+        'settings.uploaded.message': 'Settings uploaded.',
+        'settings.uploaded.description': 'URL copied to clipboard.',
+        'settings.choose-storage-adaptor.label': 'Storage adaptor (worker reload required).',
+        'settings.choose-storage-adaptor.description':
+          'Select the browser storage backend. Changing this requires a worker reload and may make existing data unavailable.',
+        'settings.repair-success.message': 'Repair succeeded',
+        'settings.repair-failed.message': 'Repair failed',
+
+        'settings.storage-adaptor.idb.label': 'IndexedDB',
+        'settings.storage-adaptor.opfs.label': 'OPFS',
+        'settings.storage-adapter.changed-alert.message':
           'Warning: Swapping the storage adapter will make your data unavailable.',
-        'settings space fragmentation': 'Enable AM space fragmentation',
-        'open debug panel label': 'Show Debug',
-        'client label': 'Client',
-        'config label': 'Config',
-        'storage label': 'Storage',
-        'logs label': 'Logs',
-        'diagnostics label': 'Diagnostics',
-        'tracing label': 'Tracing',
-        'halo label': 'HALO',
-        'identity label': 'Identity',
-        'devices label': 'Devices',
-        'keyring label': 'Keyring',
-        'credentials label': 'Credentials',
-        'echo label': 'ECHO',
-        'spaces label': 'Spaces',
-        'space label': 'Space',
-        'feeds label': 'Feeds',
-        'objects label': 'Objects',
-        'schema label': 'Schema',
-        'automerge label': 'Automerge',
-        'queues label': 'Queues',
-        'members label': 'Members',
-        'metadata label': 'Metadata',
-        'mesh label': 'MESH',
-        'signal label': 'Signal',
-        'swarm label': 'Swarm',
-        'network label': 'Network',
-        'agent label': 'Agent',
-        'dashboard label': 'Dashboard',
-        'search label': 'Search',
-        'edge label': 'EDGE',
-        'workflows label': 'Workflows',
-        'traces label': 'Traces',
-        'testing label': 'Testing',
+
+        'settings.data-store.label': 'Data Store',
+
+        'reset-data.label': 'Reset data (ERASES ALL DATA)',
+        'open-debug-panel.label': 'Show Debug',
+        'client.label': 'Client',
+        'config.label': 'Config',
+        'storage.label': 'Storage',
+        'logs.label': 'Logs',
+        'diagnostics.label': 'Diagnostics',
+        'tracing.label': 'Tracing',
+        'halo.label': 'HALO',
+        'identity.label': 'Identity',
+        'devices.label': 'Devices',
+        'keyring.label': 'Keyring',
+        'credentials.label': 'Credentials',
+        'echo.label': 'ECHO',
+        'spaces.label': 'Spaces',
+        'space.label': 'Space',
+        'feeds.label': 'Feeds',
+        'objects.label': 'Objects',
+        'schema.label': 'Schema',
+        'registry.label': 'Registry',
+        'automerge.label': 'Automerge',
+        'queues.label': 'Queues',
+        'members.label': 'Members',
+        'metadata.label': 'Metadata',
+        'mesh.label': 'MESH',
+        'signal.label': 'Signal',
+        'swarm.label': 'Swarm',
+        'network.label': 'Network',
+        'agent.label': 'Agent',
+        'dashboard.label': 'Dashboard',
+        'search.label': 'Search',
+        'edge.label': 'EDGE',
+        'workflows.label': 'Workflows',
+        'traces.label': 'Traces',
+        'testing.label': 'Testing',
+        // GitHub (deck-companion--github surface).
+        'github-loading.message': 'Loading…',
+        'github-unavailable.message': 'GitHub feed unavailable.',
+        'recent-prs.label_one': '{{count}} recent PR',
+        'recent-prs.label_other': '{{count}} recent PRs',
+        'view-on-github.button': 'View on GitHub',
       },
     },
   },

package/src/types/Settings.ts

@@ -0,0 +1,16 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+// @import-as-namespace
+
+import * as Schema from 'effect/Schema';
+
+export const Settings = Schema.mutable(
+  Schema.Struct({
+    wireframe: Schema.optional(Schema.Boolean),
+    traceAll: Schema.optional(Schema.Boolean),
+  }),
+);
+
+export interface Settings extends Schema.Schema.Type<typeof Settings> {}