@dxos/plugin-assistant 0.8.4-main.fd6878d → 0.8.4-staging.60fe92afc8

package/src/testing/index.ts

@@ -2,6 +2,8 @@
 // Copyright 2024 DXOS.org
 //
 
+export * from './test-generator';
 export * from './test-sequence';
-export * from './test-functions';
 export * from './test-services';
+export * from './test-trace';
+export * from './snapshot';

package/src/testing/snapshot.ts

@@ -0,0 +1,35 @@
+//
+// Copyright 2026 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+
+import type { Client } from '@dxos/client';
+
+/**
+ * Initializes a client from a space snapshot.
+ * Creates and identity and imports a space from a snapshot.
+ *
+ * To be used with `onClientInitialized` in `ClientPlugin`.
+ *
+ * @example
+ * ```ts
+ * ClientPlugin({
+ *   onClientInitialized: initClientFromSpaceSnapshot(() => import('../../testing/data/trace-timeline.dx.json')),
+ * }),
+ * ```
+ */
+export const initClientFromSpaceSnapshot: {
+  (loadSnapshotJson: () => Promise<unknown>): (opts: { client: Client }) => Effect.Effect<void>;
+} =
+  (loadSnapshotJson) =>
+  ({ client }) =>
+    Effect.promise(async () => {
+      await client.halo.createIdentity();
+      const data = await loadSnapshotJson();
+      const space = await client.spaces.import({
+        filename: 'snapshot.dx.json',
+        contents: new TextEncoder().encode(JSON.stringify(data)),
+      });
+      await space.db.flush();
+    });

package/src/testing/test-generator.test.ts

@@ -0,0 +1,71 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Context from 'effect/Context';
+import * as Effect from 'effect/Effect';
+import * as Layer from 'effect/Layer';
+import { describe, test } from 'vitest';
+
+import { Database, Feed, Obj } from '@dxos/echo';
+import { EffectEx } from '@dxos/effect';
+import { type Message } from '@dxos/types';
+
+import { createMessageGenerator } from './test-generator';
+
+/**
+ * In-memory FeedService that records appends and emits a change event whenever
+ * `append` is called. Used to verify the streaming-message generator emits
+ * per-chunk updates.
+ */
+const makeRecordingFeedLayer = () => {
+  const items: Message.Message[] = [];
+  const subscribers = new Set<() => void>();
+
+  const feedService: Context.Tag.Service<Feed.FeedService> = {
+    append: async (_feed: Feed.Feed, newItems) => {
+      items.push(...(newItems as Message.Message[]));
+      for (const fn of subscribers) {
+        fn();
+      }
+    },
+    remove: async () => {},
+    query: () =>
+      ({
+        subscribe: () => () => {},
+        results: [],
+        run: async () => [],
+      }) as any,
+    sync: async () => {},
+    getSyncState: async () => ({ blocksToPull: 0, blocksToPush: 0, totalBlocks: 0 }),
+  };
+
+  return {
+    items,
+    onAppend: (cb: () => void) => subscribers.add(cb),
+    layer: Layer.succeed(Feed.FeedService, feedService),
+  };
+};
+
+describe('createMessageGenerator', () => {
+  test('streaming message publishes updates for chunk mutations', async ({ expect }) => {
+    const recording = makeRecordingFeedLayer();
+    let updates = 0;
+    recording.onAppend(() => updates++);
+
+    const feed = Obj.make(Feed.Feed, { name: 'recording' });
+
+    // The streaming step is the third entry (index 2) — earlier indices are the initial
+    // user prompt and an assistant message with an Organization link (which requires
+    // `Database.Service`, unavailable in this unit-test layer).
+    await EffectEx.runAndForwardErrors(
+      createMessageGenerator()[2]!.pipe(
+        Effect.provide(Layer.mergeAll(Feed.ContextFeedService.layer(feed), recording.layer, Database.notAvailable)),
+      ),
+    );
+
+    expect(recording.items).toHaveLength(1);
+    expect(updates).toBeGreaterThan(1);
+    expect(recording.items[0].blocks[0]).toMatchObject({ pending: false });
+  });
+});

package/src/testing/test-generator.ts

@@ -0,0 +1,284 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+
+import { Database, Feed, Obj } from '@dxos/echo';
+import { type Mutable } from '@dxos/echo/Obj';
+import { random } from '@dxos/random';
+import { renderObjectLink, textStream } from '@dxos/react-ui-markdown';
+import { type Actor, type ContentBlock, Message, Organization } from '@dxos/types';
+import { trim } from '@dxos/util';
+
+export const createMessage = (role: Actor.Role, blocks: ContentBlock.Any[]): Message.Message => {
+  return Obj.make(Message.Message, {
+    created: new Date().toISOString(),
+    sender: { role },
+    blocks,
+  });
+};
+
+export type MessageGenerator = Effect.Effect<
+  void,
+  never,
+  Database.Service | Feed.ContextFeedService | Feed.FeedService
+>;
+
+export const createMessageGenerator = (): MessageGenerator[] => [
+  Effect.gen(function* () {
+    const { feed } = yield* Feed.ContextFeedService;
+    yield* Feed.append(feed, [
+      createMessage('user', [
+        {
+          _tag: 'text',
+          text: random.lorem.sentence(5),
+        },
+      ]),
+    ]);
+  }),
+
+  Effect.gen(function* () {
+    const { feed } = yield* Feed.ContextFeedService;
+    const { db } = yield* Database.Service;
+    const obj1 = db.add(
+      Obj.make(Organization.Organization, {
+        name: 'DXOS',
+        website: 'https://dxos.org',
+        description: 'DXOS is a decentralized network for collaborative applications.',
+      }),
+    );
+    // const obj2 = db.add(Obj.make(Person.Person, { fullName: 'Alice' }));
+    // const obj3 = db.add(Obj.make(Person.Person, { fullName: 'Bob' }));
+    // const obj4 = db.add(Obj.make(Person.Person, { fullName: 'Charlie' }));
+    yield* Feed.append(feed, [
+      createMessage('assistant', [
+        // Inline tag.
+        {
+          _tag: 'text',
+          text: [random.lorem.paragraph(), renderObjectLink(obj1), random.lorem.paragraph(), '\n'].join(' '),
+        },
+
+        // Inline cards.
+        // ...[obj1, obj2, obj3, obj4].map(
+        //   (obj) =>
+        //     ({
+        //       _tag: 'text',
+        //       text: renderObjectLink(obj, true) + '\n',
+        //     }) satisfies ContentBlock.Text,
+        // ),
+      ]),
+    ]);
+  }),
+
+  // Streaming text block: appends a pending text block, then mutates `text` in chunks
+  // so the syncer renders progressive deltas through the feed (not via the controller).
+  Effect.gen(function* () {
+    const { feed } = yield* Feed.ContextFeedService;
+    const feedService = yield* Feed.FeedService;
+    const message = createMessage('assistant', [{ _tag: 'text', text: '', pending: true }]);
+    yield* Feed.append(feed, [message]);
+
+    const fullText = [
+      'Streaming a response **word by word** through the feed:',
+      random.lorem.paragraph(),
+      random.lorem.paragraph(),
+    ].join('\n\n');
+
+    yield* Effect.promise(async () => {
+      for await (const chunk of textStream(fullText, { wordsPerChunk: 2, chunkDelay: 60 })) {
+        Obj.update(message, (message) => {
+          const block = message.blocks[0] as Mutable<ContentBlock.Text>;
+          block.text += chunk;
+        });
+        // Feed queries only react to feed-level updates, not in-place object mutations.
+        await feedService.append(feed, []);
+      }
+      Obj.update(message, (message) => {
+        const block = message.blocks[0] as Mutable<ContentBlock.Text>;
+        block.pending = false;
+      });
+      await feedService.append(feed, []);
+    });
+  }),
+
+  Effect.gen(function* () {
+    const { feed } = yield* Feed.ContextFeedService;
+    yield* Feed.append(feed, [
+      createMessage('assistant', [
+        {
+          _tag: 'text',
+          text:
+            trim`
+              ## Markdown
+              Here is a [link](https://dxos.org)
+
+              And some **bold** text.
+
+              And some JSON
+              \`\`\`json
+              {
+                "key": "value"
+              }
+              \`\`\`
+
+              And some code
+              \`\`\`js
+              const x = 1;
+              \`\`\`
+            ` + '\n',
+        },
+        {
+          _tag: 'text',
+          disposition: 'cot',
+          text:
+            [
+              random.lorem.paragraph(),
+              '',
+              ...Array.from({
+                length: random.number.int({ min: 3, max: 5 }),
+              }).map((_, idx) => `${idx + 1}. ${random.lorem.paragraph()}`),
+            ].join('\n') + '\n',
+        },
+      ]),
+    ]);
+  }),
+
+  Effect.gen(function* () {
+    const { feed } = yield* Feed.ContextFeedService;
+    yield* Feed.append(feed, [
+      createMessage('assistant', [
+        {
+          _tag: 'text',
+          text: 'How can I help?',
+        },
+        {
+          _tag: 'suggestion',
+          text: 'List tools',
+        },
+        {
+          _tag: 'suggestion',
+          text: 'Show info',
+        },
+        {
+          _tag: 'suggestion',
+          text: random.lorem.paragraph(),
+        },
+      ]),
+      createMessage('assistant', [
+        {
+          _tag: 'text',
+          text: 'Select an option:',
+        },
+        {
+          _tag: 'select',
+          options: ['Option 1', 'Option 2', 'Option 3'],
+        },
+      ]),
+    ]);
+  }),
+
+  Effect.gen(function* () {
+    const { feed } = yield* Feed.ContextFeedService;
+    yield* Feed.append(feed, [
+      createMessage('assistant', [
+        {
+          _tag: 'toolkit',
+        },
+      ]),
+    ]);
+  }),
+
+  Effect.gen(function* () {
+    const { feed } = yield* Feed.ContextFeedService;
+    yield* Feed.append(feed, [
+      createMessage('user', [
+        {
+          _tag: 'text',
+          text: random.lorem.sentence(5),
+        },
+      ]),
+    ]);
+  }),
+
+  Effect.gen(function* () {
+    const { feed } = yield* Feed.ContextFeedService;
+    yield* Feed.append(feed, [
+      createMessage('assistant', [
+        {
+          _tag: 'text',
+          text: random.lorem.paragraph() + '\n',
+        },
+      ]),
+      createMessage('assistant', [
+        {
+          _tag: 'toolCall',
+          toolCallId: '1234',
+          name: 'search',
+          input: JSON.stringify({}),
+          providerExecuted: false,
+        },
+      ]),
+      createMessage('user', [
+        {
+          _tag: 'toolResult',
+          toolCallId: '1234',
+          name: 'search',
+          result: 'This is a tool result.',
+          providerExecuted: false,
+        },
+      ]),
+    ]);
+  }),
+
+  Effect.gen(function* () {
+    const { feed } = yield* Feed.ContextFeedService;
+    yield* Feed.append(feed, [
+      createMessage('assistant', [
+        {
+          _tag: 'text',
+          text: random.lorem.paragraph() + '\n',
+        },
+      ]),
+      createMessage('assistant', [
+        {
+          _tag: 'toolCall',
+          toolCallId: '4567',
+          name: 'create',
+          input: JSON.stringify({}),
+          providerExecuted: false,
+        },
+      ]),
+      createMessage('user', [
+        {
+          _tag: 'toolResult',
+          toolCallId: '4567',
+          name: 'create',
+          result: 'This is a tool result.',
+          providerExecuted: false,
+        },
+      ]),
+      createMessage('assistant', [
+        {
+          _tag: 'text',
+          text:
+            Array.from({ length: random.number.int({ min: 2, max: 3 }) })
+              .map(() => random.lorem.paragraph())
+              .join('\n\n') + '\n',
+        },
+      ]),
+    ]);
+  }),
+
+  Effect.gen(function* () {
+    const { feed } = yield* Feed.ContextFeedService;
+    yield* Feed.append(feed, [
+      createMessage('assistant', [
+        {
+          _tag: 'text',
+          text: random.lorem.paragraph(),
+        },
+      ]),
+    ]);
+  }),
+];

package/src/testing/test-sequence.ts

@@ -2,50 +2,25 @@
 // Copyright 2025 DXOS.org
 //
 
-import { ToolId, ToolRegistry } from '@dxos/ai';
-// import { createExaTool, createGraphWriterTool, createLocalSearchTool } from '@dxos/assistant';
-import { type Space } from '@dxos/client/echo';
-import { type SequenceDefinition, SequenceParser } from '@dxos/conductor';
-import { type DXN } from '@dxos/keys';
-import { isNonNullable } from '@dxos/util';
+import { ToolId } from '@dxos/ai';
+import { Sequence } from '@dxos/conductor';
 
-// TODO(dmaretskyi): make db available through services (same as function executor).
-// TODO(burdon): Can tools implement "aspects" so that variants can be used rather than an explicit reference?
-export const createToolRegistry = (space: Space, queueDxn?: DXN): ToolRegistry => {
-  return new ToolRegistry(
-    [
-      // createExaTool({ apiKey: EXA_API_KEY }),
-      // createLocalSearchTool(space.db, queueDxn && space.queues.get(queueDxn)),
-      // queueDxn &&
-      //   createGraphWriterTool({
-      //     db: space.db,
-      //     queue: space.queues.get(queueDxn),
-      //     schema: DataTypes,
-      //     onDone: async (objects) => {
-      //       const queue = space.queues.get(queueDxn);
-      //       await queue.append(objects);
-      //     },
-      //   }),
-    ].filter(isNonNullable),
-  );
-};
-
-export const RESEARCH_SEQUENCE_DEFINITION: SequenceDefinition = {
+export const RESEARCH_SEQUENCE_DEFINITION: Sequence.Definition = {
   steps: [
     {
       instructions: 'Research information and entities related to the selected objects.',
-      tools: [ToolId.make('search/web_search')],
+      tools: [ToolId.make('search/web-search')],
     },
     {
       instructions:
         'Based on your research find matching entires that are already in the graph. Do exaustive research.',
-      tools: [ToolId.make('search/local_search')],
+      tools: [ToolId.make('search/local-search')],
     },
     {
       instructions: 'Add researched data to the graph. Make connections to existing objects.',
-      tools: [ToolId.make('search/local_search'), ToolId.make('graph/writer')],
+      tools: [ToolId.make('search/local-search'), ToolId.make('graph/writer')],
     },
   ],
 };
 
-export const RESEARCH_SEQUENCE = SequenceParser.create().parse(RESEARCH_SEQUENCE_DEFINITION);
+export const RESEARCH_SEQUENCE = Sequence.Parser.create().parse(RESEARCH_SEQUENCE_DEFINITION);

package/src/testing/test-services.ts

@@ -2,18 +2,14 @@
 // Copyright 2025 DXOS.org
 //
 
-import { Obj } from '@dxos/echo';
+import { Obj, type Type } from '@dxos/echo';
 
-import {
-  type ApiAuthorization,
-  type BaseServiceRegistry,
-  type ServiceQuery,
-  ServiceType,
-  categoryIcons,
-} from '../types';
+import { type ApiAuthorization, type BaseServiceRegistry, ServiceType, categoryIcons } from '#types';
+
+const ServiceTypeSchema = ServiceType as unknown as Type.Obj<ServiceType>;
 
 export class MockServiceRegistry implements BaseServiceRegistry {
-  async queryServices(query?: ServiceQuery): Promise<ServiceType[]> {
+  async queryServices(): Promise<ServiceType[]> {
     return TEST_SERVICES;
   }
 }
@@ -54,7 +50,7 @@ const VISUAL_CROSSING_CREDENTIALS: ApiAuthorization = {
 //  - e.g., https://github.com/konfig-sdks/openapi-examples/blob/main/xkcd/openapi.yaml
 
 const TEST_SERVICES: ServiceType[] = [
-  Obj.make(ServiceType, {
+  Obj.make(ServiceTypeSchema, {
     serviceId: 'amadeus.com/service/FlightSearch',
     name: 'Amadeus Flight Search',
     description: 'Search for local and international flights.',
@@ -68,7 +64,7 @@ const TEST_SERVICES: ServiceType[] = [
     ],
   }),
 
-  Obj.make(ServiceType, {
+  Obj.make(ServiceTypeSchema, {
     serviceId: 'amadeus.com/service/HotelSearch',
     name: 'Amadeus Hotel Search',
     description: 'Search for local and international hotels.',
@@ -82,7 +78,7 @@ const TEST_SERVICES: ServiceType[] = [
     ],
   }),
 
-  Obj.make(ServiceType, {
+  Obj.make(ServiceTypeSchema, {
     serviceId: 'visualcrossing.com/service/Weather',
     name: 'Visual Crossing Weather',
     description: 'Search for global weather forecasts.',
@@ -97,7 +93,7 @@ const TEST_SERVICES: ServiceType[] = [
   }),
 
   // TODO(burdon): Needs auth.
-  Obj.make(ServiceType, {
+  Obj.make(ServiceTypeSchema, {
     serviceId: 'abstractapi.com/service/GeoLocation',
     name: 'Abstract GeoLocation',
     description: 'Get the location of any IP address.',
@@ -115,7 +111,7 @@ const TEST_SERVICES: ServiceType[] = [
   //
 
   ...Array.from({ length: 20 }, (_, i) =>
-    Obj.make(ServiceType, {
+    Obj.make(ServiceTypeSchema, {
       serviceId: `example.com/service/test-${i}`,
       name: `Test ${i}`,
       description: `Test ${i}`,

package/src/testing/test-trace.ts

@@ -0,0 +1,20 @@
+//
+// Copyright 2026 DXOS.org
+//
+
+import * as Option from 'effect/Option';
+
+import { Process } from '@dxos/compute';
+
+export const makeProcess = (
+  overrides: Partial<Process.Info> & Pick<Process.Info, 'pid' | 'state'> & { name: string },
+): Process.Info => ({
+  parentPid: null,
+  key: `test.process.${overrides.name}`,
+  params: { name: overrides.name, target: null },
+  error: null,
+  startedAt: Date.now() - 10_000,
+  completedAt: Option.none(),
+  metrics: { wallTime: 0, inputCount: 0, outputCount: 0 },
+  ...overrides,
+});