@dxos/plugin-assistant 0.8.4-main.406dc2a → 0.8.4-main.422d1c7879

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

@@ -0,0 +1,81 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+import * as Layer from 'effect/Layer';
+import { describe, test } from 'vitest';
+
+import { Database } from '@dxos/echo';
+import { runAndForwardErrors } from '@dxos/effect';
+import { ContextQueueService } from '@dxos/functions';
+import { DXN, ObjectId, SpaceId } from '@dxos/keys';
+import { type Queue } from '@dxos/react-client/echo';
+import { type Message } from '@dxos/types';
+
+import { createMessageGenerator } from './test-generator';
+
+class RecordingQueue implements Queue<Message.Message> {
+  readonly dxn = new DXN(DXN.kind.QUEUE, [SpaceId.random(), ObjectId.random()]);
+  readonly #subscribers = new Set<() => void>();
+
+  objects: Message.Message[] = [];
+  isLoading = false;
+  error = null;
+
+  declare query: Queue<Message.Message>['query'];
+
+  subscribe(callback: () => void) {
+    this.#subscribers.add(callback);
+    return () => this.#subscribers.delete(callback);
+  }
+
+  async append(objects: Message.Message[]) {
+    this.objects = [...this.objects, ...objects];
+    this.#emit();
+  }
+
+  async delete(ids: string[]) {
+    this.objects = this.objects.filter((object) => !ids.includes(object.id));
+    this.#emit();
+  }
+
+  async sync() {}
+
+  async queryObjects() {
+    return this.objects;
+  }
+
+  async getObjectsById(ids: ObjectId[]) {
+    return ids.map((id) => this.objects.find((object) => object.id === id));
+  }
+
+  async refresh() {}
+
+  #emit() {
+    for (const subscriber of this.#subscribers) {
+      subscriber();
+    }
+  }
+}
+
+describe('createMessageGenerator', () => {
+  test('streaming message publishes updates for chunk mutations', async ({ expect }) => {
+    const queue = new RecordingQueue();
+    let updates = 0;
+    queue.subscribe(() => updates++);
+
+    // 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 runAndForwardErrors(
+      createMessageGenerator()[2]!.pipe(
+        Effect.provide(Layer.mergeAll(ContextQueueService.layer(queue), Database.notAvailable)),
+      ),
+    );
+
+    expect(queue.objects).toHaveLength(1);
+    expect(updates).toBeGreaterThan(1);
+    expect(queue.objects[0].blocks[0]).toMatchObject({ pending: false });
+  });
+});

package/src/testing/test-generator.ts

@@ -5,21 +5,23 @@
 import * as Effect from 'effect/Effect';
 
 import { Obj } from '@dxos/echo';
-import { ContextQueueService, DatabaseService } from '@dxos/functions';
-import { faker } from '@dxos/random';
-import { renderObjectLink } from '@dxos/react-ui-components';
-import { type ContentBlock, DataType } from '@dxos/schema';
+import { Database } from '@dxos/echo';
+import { type Mutable } from '@dxos/echo/internal';
+import { ContextQueueService } from '@dxos/functions';
+import { random } from '@dxos/random';
+import { renderObjectLink, textStream } from '@dxos/react-ui-components';
+import { type Actor, type ContentBlock, Message, Organization } from '@dxos/types';
 import { trim } from '@dxos/util';
 
-export const createMessage = (role: DataType.ActorRole, blocks: ContentBlock.Any[]): DataType.Message => {
-  return Obj.make(DataType.Message, {
+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, DatabaseService | ContextQueueService>;
+export type MessageGenerator = Effect.Effect<void, never, Database.Service | ContextQueueService>;
 
 export const createMessageGenerator = (): MessageGenerator[] => [
   Effect.gen(function* () {
@@ -29,13 +31,78 @@ export const createMessageGenerator = (): MessageGenerator[] => [
         createMessage('user', [
           {
             _tag: 'text',
-            text: faker.lorem.sentence(5),
+            text: random.lorem.sentence(5),
           },
         ]),
       ]),
     );
   }),
 
+  Effect.gen(function* () {
+    const { queue } = yield* ContextQueueService;
+    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* Effect.promise(() =>
+      queue.append([
+        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 queue (not via the controller).
+  Effect.gen(function* () {
+    const { queue } = yield* ContextQueueService;
+    const message = createMessage('assistant', [{ _tag: 'text', text: '', pending: true }]);
+    yield* Effect.promise(() => queue.append([message]));
+
+    const fullText = [
+      'Streaming a response **word by word** through the queue:',
+      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.change(message, (message) => {
+          const block = message.blocks[0] as Mutable<ContentBlock.Text>;
+          block.text += chunk;
+        });
+        // Queue queries only react to queue-level updates, not in-place object mutations.
+        await queue.append([]);
+      }
+      Obj.change(message, (message) => {
+        const block = message.blocks[0] as Mutable<ContentBlock.Text>;
+        block.pending = false;
+      });
+      await queue.append([]);
+    });
+  }),
+
   Effect.gen(function* () {
     const { queue } = yield* ContextQueueService;
     yield* Effect.promise(() =>
@@ -68,11 +135,11 @@ export const createMessageGenerator = (): MessageGenerator[] => [
             disposition: 'cot',
             text:
               [
-                faker.lorem.paragraph(),
+                random.lorem.paragraph(),
                 '',
-                ...Array.from({ length: faker.number.int({ min: 3, max: 5 }) }).map(
-                  (_, idx) => `${idx + 1}. ${faker.lorem.paragraph()}`,
-                ),
+                ...Array.from({
+                  length: random.number.int({ min: 3, max: 5 }),
+                }).map((_, idx) => `${idx + 1}. ${random.lorem.paragraph()}`),
               ].join('\n') + '\n',
           },
         ]),
@@ -99,7 +166,7 @@ export const createMessageGenerator = (): MessageGenerator[] => [
           },
           {
             _tag: 'suggestion',
-            text: faker.lorem.paragraph(),
+            text: random.lorem.paragraph(),
           },
         ]),
         createMessage('assistant', [
@@ -136,37 +203,8 @@ export const createMessageGenerator = (): MessageGenerator[] => [
         createMessage('user', [
           {
             _tag: 'text',
-            text: faker.lorem.sentence(5),
-          },
-        ]),
-      ]),
-    );
-  }),
-
-  Effect.gen(function* () {
-    const { queue } = yield* ContextQueueService;
-    const { db } = yield* DatabaseService;
-    const obj1 = db.add(Obj.make(DataType.Organization, { name: 'DXOS' }));
-    // const obj2 = db.add(Obj.make(DataType.Person, { fullName: 'Alice' }));
-    // const obj3 = db.add(Obj.make(DataType.Person, { fullName: 'Bob' }));
-    // const obj4 = db.add(Obj.make(DataType.Person, { fullName: 'Charlie' }));
-    yield* Effect.promise(() =>
-      queue.append([
-        createMessage('assistant', [
-          // Inline tag.
-          {
-            _tag: 'text',
-            text: [faker.lorem.paragraph(), renderObjectLink(obj1), faker.lorem.paragraph(), '\n'].join(' '),
+            text: random.lorem.sentence(5),
           },
-
-          // Inline cards.
-          // ...[obj1, obj2, obj3, obj4].map(
-          //   (obj) =>
-          //     ({
-          //       _tag: 'text',
-          //       text: renderObjectLink(obj, true) + '\n',
-          //     }) satisfies ContentBlock.Text,
-          // ),
         ]),
       ]),
     );
@@ -179,7 +217,7 @@ export const createMessageGenerator = (): MessageGenerator[] => [
         createMessage('assistant', [
           {
             _tag: 'text',
-            text: faker.lorem.paragraph() + '\n',
+            text: random.lorem.paragraph() + '\n',
           },
         ]),
         createMessage('assistant', [
@@ -211,7 +249,7 @@ export const createMessageGenerator = (): MessageGenerator[] => [
         createMessage('assistant', [
           {
             _tag: 'text',
-            text: faker.lorem.paragraph() + '\n',
+            text: random.lorem.paragraph() + '\n',
           },
         ]),
         createMessage('assistant', [
@@ -236,8 +274,8 @@ export const createMessageGenerator = (): MessageGenerator[] => [
           {
             _tag: 'text',
             text:
-              Array.from({ length: faker.number.int({ min: 2, max: 3 }) })
-                .map(() => faker.lorem.paragraph())
+              Array.from({ length: random.number.int({ min: 2, max: 3 }) })
+                .map(() => random.lorem.paragraph())
                 .join('\n\n') + '\n',
           },
         ]),
@@ -252,7 +290,7 @@ export const createMessageGenerator = (): MessageGenerator[] => [
         createMessage('assistant', [
           {
             _tag: 'text',
-            text: faker.lorem.paragraph(),
+            text: random.lorem.paragraph(),
           },
         ]),
       ]),

package/src/testing/test-sequence.ts

@@ -9,16 +9,16 @@ export const RESEARCH_SEQUENCE_DEFINITION: SequenceDefinition = {
   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')],
     },
   ],
 };

package/src/testing/test-services.ts

@@ -2,9 +2,11 @@
 // Copyright 2025 DXOS.org
 //
 
-import { Obj } from '@dxos/echo';
+import { Obj, type Type } from '@dxos/echo';
 
-import { type ApiAuthorization, type BaseServiceRegistry, ServiceType, categoryIcons } from '../types';
+import { type ApiAuthorization, type BaseServiceRegistry, ServiceType, categoryIcons } from '#types';
+
+const ServiceTypeSchema = ServiceType as unknown as Type.AnyObj;
 
 export class MockServiceRegistry implements BaseServiceRegistry {
   async queryServices(): Promise<ServiceType[]> {
@@ -48,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.',
@@ -62,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.',
@@ -76,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.',
@@ -91,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.',
@@ -109,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}`,