@dxos/plugin-assistant 0.8.4-main.67995b8 → 0.8.4-main.69d29f4

package/src/processor/processor.ts

@@ -0,0 +1,275 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { Atom, Registry } from '@effect-atom/atom-react';
+import * as Cause from 'effect/Cause';
+import * as Effect from 'effect/Effect';
+import * as Exit from 'effect/Exit';
+import * as Fiber from 'effect/Fiber';
+import * as Option from 'effect/Option';
+import * as Runtime from 'effect/Runtime';
+
+import {
+  AiService,
+  DEFAULT_EDGE_MODEL,
+  type ModelName,
+  type ModelRegistry,
+  type ToolExecutionService,
+  type ToolResolverService,
+} from '@dxos/ai';
+import {
+  type AiConversation,
+  type AiConversationRunProps,
+  ArtifactDiffResolver,
+  GenerationObserver,
+  createSystemPrompt,
+} from '@dxos/assistant';
+import { type Blueprint } from '@dxos/blueprints';
+import { Obj } from '@dxos/echo';
+import { type Database } from '@dxos/echo';
+import { runAndForwardErrors, throwCause } from '@dxos/effect';
+import {
+  type CredentialsService,
+  type FunctionInvocationService,
+  type QueueService,
+  type TracingService,
+} from '@dxos/functions';
+import { log } from '@dxos/log';
+import { type ContentBlock, Message } from '@dxos/types';
+
+import { type Assistant } from '../types';
+
+import { updateName } from './update-name';
+
+export type AiChatServices =
+  | CredentialsService
+  | Database.Service
+  | QueueService
+  | FunctionInvocationService
+  | AiService.AiService
+  | ToolExecutionService
+  | ToolResolverService
+  | TracingService;
+
+export type AiChatProcessorOptions = {
+  model?: ModelName;
+  modelRegistry?: ModelRegistry;
+  blueprintRegistry?: Blueprint.Registry;
+  observableRegistry?: Registry.Registry;
+  extensions?: ToolContextExtensions;
+} & Pick<AiConversationRunProps, 'system'>;
+
+const defaultOptions: Partial<AiChatProcessorOptions> = {
+  model: DEFAULT_EDGE_MODEL,
+};
+
+// TODO(burdon): Retry, timeout?
+export type AiRequestOptions = {};
+
+export type AiRequest = {
+  message: string;
+  options?: AiRequestOptions;
+};
+
+/**
+ * Handles interactions with the AI service.
+ * Handles streaming responses from the conversation.
+ */
+export class AiChatProcessor {
+  private readonly _registry: Registry.Registry;
+
+  /** External observer. */
+  private readonly _observer: GenerationObserver;
+
+  /** Pending messages (incl. the current user request). */
+  private readonly _pending = Atom.make<Message.Message[]>([]);
+
+  /** Currently streaming message (from the AI service). */
+  private readonly _streaming = Atom.make<Option.Option<Message.Message>>(Option.none());
+
+  /** Currently active request fiber. */
+  private _fiber: Fiber.Fiber<void, any> | undefined;
+
+  /** Last request (for retries). */
+  private _lastRequest: AiRequest | undefined;
+
+  /** Streaming state. */
+  public readonly streaming = Atom.make<boolean>((get) => Option.isSome(get(this._streaming)));
+
+  /** Active state. */
+  public readonly active = Atom.make(false);
+
+  /** Array of Messages (incl. the current message being streamed). */
+  public readonly messages = Atom.make<Message.Message[]>((get) =>
+    Option.match(get(this._streaming), {
+      onNone: () => get(this._pending),
+      onSome: (streaming) => [...get(this._pending), streaming],
+    }),
+  );
+
+  /** Last error. */
+  public readonly error = Atom.make<Option.Option<Error>>(Option.none());
+
+  constructor(
+    private readonly _conversation: AiConversation,
+    // TODO(dmaretskyi): Replace this with effect's ManagedRuntime wrapping this layer.
+    private readonly _services: () => Promise<Runtime.Runtime<AiChatServices>>,
+    private readonly _options: AiChatProcessorOptions = defaultOptions,
+  ) {
+    // Initialize registries and defaults before using in other logic.
+    this._registry = this._options.observableRegistry ?? Registry.make();
+    this._observer = GenerationObserver.make({
+      onBlock: this._onBlock,
+      onMessage: this._onMessage,
+    });
+    if (this._options.model && !this._options.system) {
+      const capabilities = this._options.modelRegistry?.getCapabilities(this._options.model) ?? {};
+      this._options.system = createSystemPrompt(capabilities);
+    }
+  }
+
+  get context() {
+    return this._conversation.context;
+  }
+
+  get conversation() {
+    return this._conversation;
+  }
+
+  get blueprintRegistry() {
+    return this._options.blueprintRegistry;
+  }
+
+  /**
+   * Initiates a new request.
+   */
+  async request(requestProp: AiRequest): Promise<void> {
+    if (this._fiber) {
+      await this.cancel();
+    }
+
+    try {
+      this._lastRequest = requestProp;
+      this._registry.set(this.error, Option.none());
+      this._registry.set(this.active, true);
+
+      const services = await this._services();
+
+      // Create request.
+      const request = this._conversation.createRequest({
+        system: this._options.system,
+        prompt: requestProp.message,
+        observer: this._observer,
+      });
+
+      // Create fiber.
+      this._fiber = request.pipe(
+        Effect.provide(AiService.model(this._options.model ?? DEFAULT_EDGE_MODEL)),
+        // TODO(dmaretskyi): Move ArtifactDiffResolver upstream.
+        Effect.provideService(ArtifactDiffResolver, this._artifactDiffResolver),
+        Effect.asVoid,
+        Runtime.runFork(services), // Runs in the background.
+      );
+
+      // Execute request.
+      const response = await this._fiber.pipe(Fiber.join, Effect.runPromiseExit);
+      if (!Exit.isSuccess(response) && !Cause.isInterruptedOnly(response.cause)) {
+        throwCause(response.cause);
+      }
+
+      this._registry.set(this.error, Option.none());
+      this._lastRequest = undefined;
+      this._fiber = undefined;
+    } catch (err) {
+      log.error('request failed', { error: err });
+      this._registry.set(this.error, Option.some(new Error('AI service error', { cause: err })));
+    } finally {
+      this._registry.set(this.active, false);
+      this._fiber = undefined;
+    }
+  }
+
+  /**
+   * Cancels the current request.
+   */
+  async cancel(): Promise<void> {
+    await runAndForwardErrors(
+      Effect.gen(this, function* () {
+        if (this._fiber) {
+          yield* this._fiber.pipe(Fiber.interrupt);
+        }
+      }),
+    );
+
+    this._fiber = undefined;
+    this._registry.set(this.active, false);
+  }
+
+  /**
+   * Retry last failed request.
+   */
+  async retry(): Promise<void> {
+    if (this._lastRequest) {
+      return this.request(this._lastRequest);
+    }
+  }
+
+  /**
+   * Update the current chat's name.
+   */
+  async updateName(chat: Assistant.Chat): Promise<void> {
+    const runtime = await this._services();
+    await updateName(runtime, this._conversation, chat, this._options.model);
+  }
+
+  // TODO(burdon): Fix/factor out.
+  private _artifactDiffResolver: ArtifactDiffResolver.Service = {
+    resolve: async (_artifacts) => {
+      const versions = new Map();
+      // await Promise.all(
+      //   artifacts.map(async (artifact) => {
+      //     const {
+      //       objects: [object],
+      //     } = await space.db.query(Filter.id(artifact.id)).run();
+      //     if (!object) {
+      //       return;
+      //     }
+
+      //     versions.set(artifact.id, {
+      //       version: getVersion(object),
+      //       diff: `Current state: ${JSON.stringify(object)}`,
+      //     });
+      //   }),
+      // );
+
+      return versions;
+    },
+  };
+
+  private _onMessage = Effect.fn(
+    function* (this: AiChatProcessor, message: Message.Message) {
+      this._registry.set(this._streaming, Option.none());
+      this._registry.update(this._pending, (pending) => [...pending, message]);
+    }.bind(this),
+  );
+
+  private _onBlock = Effect.fn(
+    function* (this: AiChatProcessor, block: ContentBlock.Any) {
+      this._registry.update(this._streaming, (streaming) => {
+        const blocks = streaming.pipe(
+          Option.map((streaming) => streaming.blocks.filter((b: ContentBlock.Any) => !b.pending)),
+          Option.getOrElse(() => []),
+        );
+
+        return Option.some(
+          Obj.make(Message.Message, {
+            created: new Date().toISOString(),
+            sender: { role: 'assistant' },
+            blocks: [...blocks, block],
+          }),
+        );
+      });
+    }.bind(this),
+  );
+}

package/src/processor/update-name.ts

@@ -0,0 +1,59 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+import * as Exit from 'effect/Exit';
+import * as Fiber from 'effect/Fiber';
+import * as Runtime from 'effect/Runtime';
+
+import { AiService, DEFAULT_EDGE_MODEL, type ModelName } from '@dxos/ai';
+import { type AiConversation, AiSession } from '@dxos/assistant';
+import { Obj } from '@dxos/echo';
+import { throwCause } from '@dxos/effect';
+import { trim } from '@dxos/util';
+
+import { type Assistant } from '../types';
+
+import { type AiChatServices } from './processor';
+
+/**
+ * Update the current chat's name.
+ */
+// TODO(burdon): Convert this into a plugin tool.
+export const updateName = async (
+  runtime: Runtime.Runtime<AiChatServices>,
+  conversation: AiConversation,
+  chat: Assistant.Chat,
+  model: ModelName = DEFAULT_EDGE_MODEL,
+): Promise<void> => {
+  const history = await conversation.getHistory();
+  const system = trim`
+    It is extremely important that you respond only with the title and nothing else.
+    If you cannot do this effectively respond with "New Chat".
+  `;
+  const prompt = 'Suggest a name for this chat';
+
+  const fiber = Effect.gen(this, function* () {
+    const session = new AiSession();
+    return yield* session.run({ system, prompt, history });
+  }).pipe(
+    Effect.provide(AiService.model(model)),
+    Effect.tap((messages) => {
+      // TODO(burdon): Parse response (should update via tool).
+      const message = messages.find((message) => message.sender.role === 'assistant');
+      const title = message?.blocks.find((block) => block._tag === 'text')?.text;
+      if (title) {
+        Obj.change(chat, (c) => {
+          c.name = title;
+        });
+      }
+    }),
+    Runtime.runFork(runtime), // Run in the background.
+  );
+
+  const response = await fiber.pipe(Fiber.join, Effect.runPromiseExit);
+  if (!Exit.isSuccess(response)) {
+    throwCause(response.cause);
+  }
+};

package/src/queue-logger.ts

@@ -2,17 +2,13 @@
 // Copyright 2025 DXOS.org
 //
 
-import { getSpace, Ref, type Queue, type Space } from '@dxos/client/echo';
+import { type Queue, Ref, type Space, getSpace } from '@dxos/client/echo';
 import { type Sequence, type SequenceEvent, type SequenceLogger } from '@dxos/conductor';
 import { DXN, Key, Obj } from '@dxos/echo';
-import {
-  InvocationOutcome,
-  InvocationTraceEndEvent,
-  InvocationTraceEventType,
-  InvocationTraceStartEvent,
-  TraceEvent,
-  type InvocationTraceEvent,
-} from '@dxos/functions';
+import { InvocationTraceEndEvent, InvocationTraceEventType, InvocationTraceStartEvent } from '@dxos/functions-runtime';
+import { TraceEvent } from '@dxos/functions-runtime';
+import { InvocationOutcome } from '@dxos/functions-runtime';
+import { type InvocationTraceEvent } from '@dxos/functions-runtime';
 import { invariant } from '@dxos/invariant';
 import { QueueSubspaceTags } from '@dxos/keys';
 
@@ -27,7 +23,10 @@ export class QueueLogger implements SequenceLogger {
     let dxn = this._space.properties.invocationTraceQueue?.dxn;
     if (!dxn) {
       dxn = DXN.fromQueue(QueueSubspaceTags.TRACE, this._space.id, Key.ObjectId.random());
-      this._space.properties.invocationTraceQueue = Ref.fromDXN(dxn);
+      const newDxn = dxn;
+      Obj.change(this._space.properties, (p) => {
+        p.invocationTraceQueue = Ref.fromDXN(newDxn);
+      });
     }
     this._invocationTraceQueue = this._space.queues.get(dxn);
   }
@@ -39,7 +38,7 @@ export class QueueLogger implements SequenceLogger {
           Obj.make(InvocationTraceStartEvent, {
             type: InvocationTraceEventType.START,
             invocationId: event.invocationId,
-            timestampMs: Date.now(),
+            timestamp: Date.now(),
             input: {},
             invocationTraceQueue: Ref.fromDXN(this._getTraceQueueDxn(event.invocationId)),
             invocationTarget: Ref.make(this.sequence),
@@ -51,7 +50,7 @@ export class QueueLogger implements SequenceLogger {
           Obj.make(InvocationTraceEndEvent, {
             type: InvocationTraceEventType.END,
             invocationId: event.invocationId,
-            timestampMs: Date.now(),
+            timestamp: Date.now(),
             outcome: InvocationOutcome.SUCCESS,
           }),
         ]);
@@ -62,10 +61,10 @@ export class QueueLogger implements SequenceLogger {
           Obj.make(TraceEvent, {
             outcome: event.type,
             truncated: false,
-            ingestionTimestampMs: Date.now(),
+            ingestionTimestamp: Date.now(),
             logs: [
               {
-                timestampMs: Date.now(),
+                timestamp: Date.now(),
                 level: 'info',
                 message: event.type,
                 context: { step: event.step },
@@ -80,10 +79,10 @@ export class QueueLogger implements SequenceLogger {
           Obj.make(TraceEvent, {
             outcome: event.type,
             truncated: false,
-            ingestionTimestampMs: Date.now(),
+            ingestionTimestamp: Date.now(),
             logs: [
               {
-                timestampMs: Date.now(),
+                timestamp: Date.now(),
                 level: 'info',
                 message: event.type,
                 context: { message: event.message },
@@ -98,10 +97,10 @@ export class QueueLogger implements SequenceLogger {
           Obj.make(TraceEvent, {
             outcome: event.type,
             truncated: false,
-            ingestionTimestampMs: Date.now(),
+            ingestionTimestamp: Date.now(),
             logs: [
               {
-                timestampMs: Date.now(),
+                timestamp: Date.now(),
                 level: 'info',
                 message: event.type,
                 context: { block: event.block },

package/src/testing/index.ts

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

package/src/testing/test-generator.ts

@@ -0,0 +1,262 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+
+import { Obj } from '@dxos/echo';
+import { Database } from '@dxos/echo';
+import { ContextQueueService } from '@dxos/functions';
+import { faker } from '@dxos/random';
+import { renderObjectLink } from '@dxos/react-ui-components';
+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 | ContextQueueService>;
+
+export const createMessageGenerator = (): MessageGenerator[] => [
+  Effect.gen(function* () {
+    const { queue } = yield* ContextQueueService;
+    yield* Effect.promise(() =>
+      queue.append([
+        createMessage('user', [
+          {
+            _tag: 'text',
+            text: faker.lorem.sentence(5),
+          },
+        ]),
+      ]),
+    );
+  }),
+
+  Effect.gen(function* () {
+    const { queue } = yield* ContextQueueService;
+    yield* Effect.promise(() =>
+      queue.append([
+        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:
+              [
+                faker.lorem.paragraph(),
+                '',
+                ...Array.from({
+                  length: faker.number.int({ min: 3, max: 5 }),
+                }).map((_, idx) => `${idx + 1}. ${faker.lorem.paragraph()}`),
+              ].join('\n') + '\n',
+          },
+        ]),
+      ]),
+    );
+  }),
+
+  Effect.gen(function* () {
+    const { queue } = yield* ContextQueueService;
+    yield* Effect.promise(() =>
+      queue.append([
+        createMessage('assistant', [
+          {
+            _tag: 'text',
+            text: 'How can I help?',
+          },
+          {
+            _tag: 'suggestion',
+            text: 'List tools',
+          },
+          {
+            _tag: 'suggestion',
+            text: 'Show info',
+          },
+          {
+            _tag: 'suggestion',
+            text: faker.lorem.paragraph(),
+          },
+        ]),
+        createMessage('assistant', [
+          {
+            _tag: 'text',
+            text: 'Select an option:',
+          },
+          {
+            _tag: 'select',
+            options: ['Option 1', 'Option 2', 'Option 3'],
+          },
+        ]),
+      ]),
+    );
+  }),
+
+  Effect.gen(function* () {
+    const { queue } = yield* ContextQueueService;
+    yield* Effect.promise(() =>
+      queue.append([
+        createMessage('assistant', [
+          {
+            _tag: 'toolkit',
+          },
+        ]),
+      ]),
+    );
+  }),
+
+  Effect.gen(function* () {
+    const { queue } = yield* ContextQueueService;
+    yield* Effect.promise(() =>
+      queue.append([
+        createMessage('user', [
+          {
+            _tag: 'text',
+            text: faker.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' }));
+    // 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: [faker.lorem.paragraph(), renderObjectLink(obj1), faker.lorem.paragraph(), '\n'].join(' '),
+          },
+
+          // Inline cards.
+          // ...[obj1, obj2, obj3, obj4].map(
+          //   (obj) =>
+          //     ({
+          //       _tag: 'text',
+          //       text: renderObjectLink(obj, true) + '\n',
+          //     }) satisfies ContentBlock.Text,
+          // ),
+        ]),
+      ]),
+    );
+  }),
+
+  Effect.gen(function* () {
+    const { queue } = yield* ContextQueueService;
+    yield* Effect.promise(() =>
+      queue.append([
+        createMessage('assistant', [
+          {
+            _tag: 'text',
+            text: faker.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 { queue } = yield* ContextQueueService;
+    yield* Effect.promise(() =>
+      queue.append([
+        createMessage('assistant', [
+          {
+            _tag: 'text',
+            text: faker.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: faker.number.int({ min: 2, max: 3 }) })
+                .map(() => faker.lorem.paragraph())
+                .join('\n\n') + '\n',
+          },
+        ]),
+      ]),
+    );
+  }),
+
+  Effect.gen(function* () {
+    const { queue } = yield* ContextQueueService;
+    yield* Effect.promise(() =>
+      queue.append([
+        createMessage('assistant', [
+          {
+            _tag: 'text',
+            text: faker.lorem.paragraph(),
+          },
+        ]),
+      ]),
+    );
+  }),
+];