Add test for serialising the command results when they are exported but not previously loaded

Author: IanCal

packages/host/tests/acceptance/commands-test.gts

@@ -19,6 +19,7 @@ import { baseRealm, Command } from '@cardstack/runtime-common';
 import {
   APP_BOXEL_COMMAND_MSGTYPE,
   APP_BOXEL_MESSAGE_MSGTYPE,
+  APP_BOXEL_COMMAND_RESULT_EVENT_TYPE,
 } from '@cardstack/runtime-common/matrix-constants';
 
 import CreateAIAssistantRoomCommand from '@cardstack/host/commands/create-ai-assistant-room';
@@ -362,6 +363,20 @@ module('Acceptance | Commands tests', function (hooks) {
         'person.gts': { Person, Meeting },
         'pet.gts': { Pet },
         'Pet/ringo.json': new Pet({ name: 'Ringo' }),
+        'AiCommandExample/london.json': {
+          data: {
+            type: 'card',
+            attributes: {
+              location: 'London',
+            },
+            meta: {
+              adoptsFrom: {
+                module: 'http://localhost:4202/test/ai-command-example',
+                name: 'AiCommandExample',
+              },
+            },
+          },
+        },
         'Person/hassan.json': new Person({
           firstName: 'Hassan',
           lastName: 'Abdel-Rahman',
@@ -867,4 +882,64 @@ module('Acceptance | Commands tests', function (hooks) {
       .dom('[data-test-message-idx="1"] [data-test-boxel-command-result]')
       .containsText('Submode: interact');
   });
+
+  test('command returns serialized result in room message', async function (assert) {
+    await visitOperatorMode({
+      stacks: [
+        [
+          {
+            id: `${testRealmURL}AiCommandExample/london`,
+            format: 'isolated',
+          },
+        ],
+      ],
+    });
+
+    await click('[data-test-get-weather]');
+    await waitUntil(() => getRoomIds().length > 0);
+
+    let roomId = getRoomIds().pop()!;
+    let message = getRoomEvents(roomId).pop()!;
+    assert.strictEqual(message.content.msgtype, APP_BOXEL_MESSAGE_MSGTYPE);
+
+    let boxelMessageData = JSON.parse(message.content.data);
+    assert.strictEqual(boxelMessageData.context.tools.length, 1);
+    assert.strictEqual(boxelMessageData.context.tools[0].type, 'function');
+    let toolName = boxelMessageData.context.tools[0].function.name;
+
+    simulateRemoteMessage(roomId, '@aibot:localhost', {
+      body: 'Getting weather information for London',
+      msgtype: APP_BOXEL_COMMAND_MSGTYPE,
+      formatted_body: 'Getting weather information for London',
+      format: 'org.matrix.custom.html',
+      data: JSON.stringify({
+        toolCall: {
+          name: toolName,
+          arguments: {
+            attributes: {
+              location: 'London',
+            },
+          },
+        },
+        eventId: '__EVENT_ID__',
+      }),
+      'm.relates_to': {
+        rel_type: 'm.replace',
+        event_id: '__EVENT_ID__',
+      },
+    });
+
+    await settled();
+    let commandResultEvents = await getRoomEvents(roomId).filter(
+      (event) =>
+        event.type === APP_BOXEL_COMMAND_RESULT_EVENT_TYPE &&
+        event.content['m.relates_to']?.rel_type === 'm.annotation' &&
+        event.content['m.relates_to']?.key === 'applied',
+    );
+    assert.equal(
+      commandResultEvents.length,
+      1,
+      'command result event is dispatched',
+    );
+  });
 });

packages/host/tests/cards/ai-command-example.gts

@@ -0,0 +1,83 @@
+import { on } from '@ember/modifier';
+
+import CreateAIAssistantRoomCommand from '@cardstack/boxel-host/commands/create-ai-assistant-room';
+import SendAiAssistantMessageCommand from '@cardstack/boxel-host/commands/send-ai-assistant-message';
+
+import { Button } from '@cardstack/boxel-ui/components';
+import { CardContainer } from '@cardstack/boxel-ui/components';
+
+import { Command } from '@cardstack/runtime-common';
+
+import {
+  CardDef,
+  Component,
+  StringField,
+  field,
+  contains,
+} from 'https://cardstack.com/base/card-api';
+
+export class WeatherLocationInput extends CardDef {
+  @field location = contains(StringField);
+}
+
+export class WeatherReport extends CardDef {
+  @field temperature = contains(StringField);
+  @field conditions = contains(StringField);
+}
+
+class GetWeatherCommand extends Command<WeatherLocationInput, WeatherReport> {
+  inputType = WeatherLocationInput;
+
+  async getInputType(): Promise<new (args: any) => WeatherLocationInput> {
+    return WeatherLocationInput;
+  }
+
+  protected async run(_input: WeatherLocationInput): Promise<WeatherReport> {
+    return new WeatherReport({
+      temperature: '25 C',
+      conditions: 'Sunny',
+    });
+  }
+}
+
+export class AiCommandExample extends CardDef {
+  static displayName = 'AI Command Example';
+
+  @field location = contains(StringField);
+
+  static isolated = class Isolated extends Component<typeof AiCommandExample> {
+    getWeather = async () => {
+      let commandContext = this.args.context?.commandContext;
+      if (!commandContext) {
+        throw new Error('No command context found');
+      }
+
+      let getWeatherCommand = new GetWeatherCommand(commandContext);
+
+      let createAIAssistantRoomCommand = new CreateAIAssistantRoomCommand(
+        commandContext,
+      );
+      let { roomId } = await createAIAssistantRoomCommand.execute({
+        name: 'Weather Assistant',
+      });
+
+      let sendMessageCommand = new SendAiAssistantMessageCommand(
+        commandContext,
+      );
+
+      await sendMessageCommand.execute({
+        roomId,
+        prompt: `What is the weather in ${this.args.model.location}?`,
+        commands: [{ command: getWeatherCommand, autoExecute: true }],
+      });
+    };
+
+    <template>
+      <CardContainer>
+        <Button data-test-get-weather {{on 'click' this.getWeather}}>
+          Get Weather
+        </Button>
+      </CardContainer>
+    </template>
+  };
+}