Adopt custom rel_type for command results

Author: lukemelia

packages/ai-bot/helpers.ts

@@ -23,6 +23,7 @@ import {
   APP_BOXEL_COMMAND_REQUESTS_KEY,
   APP_BOXEL_COMMAND_DEFINITIONS_MSGTYPE,
   APP_BOXEL_COMMAND_RESULT_EVENT_TYPE,
+  APP_BOXEL_COMMAND_RESULT_REL_TYPE,
   APP_BOXEL_COMMAND_RESULT_WITH_OUTPUT_MSGTYPE,
 } from '../runtime-common/matrix-constants';
 import {
@@ -794,7 +795,8 @@ export function isCommandResultEvent(
   }
   return (
     event.type === APP_BOXEL_COMMAND_RESULT_EVENT_TYPE &&
-    event.content['m.relates_to']?.rel_type === 'm.annotation'
+    event.content['m.relates_to']?.rel_type ===
+      APP_BOXEL_COMMAND_RESULT_REL_TYPE
   );
 }
 

packages/ai-bot/tests/chat-titling-test.ts

@@ -416,7 +416,7 @@ module('shouldSetRoomTitle', () => {
         'm.relates_to': {
           event_id: '1',
           key: 'applied',
-          rel_type: 'm.annotation',
+          rel_type: APP_BOXEL_COMMAND_RESULT_REL_TYPE,
         },
         msgtype: APP_BOXEL_COMMAND_RESULT_WITH_NO_OUTPUT_MSGTYPE,
       },

packages/ai-bot/tests/prompt-construction-test.ts

@@ -1678,7 +1678,7 @@ test('Return host result of tool call back to open ai', async () => {
       content: {
         'm.relates_to': {
           event_id: 'command-event-id-1',
-          rel_type: 'm.annotation',
+          rel_type: APP_BOXEL_COMMAND_RESULT_REL_TYPE,
           key: 'applied',
         },
         msgtype: APP_BOXEL_COMMAND_RESULT_WITH_OUTPUT_MSGTYPE,

packages/ai-bot/tests/resources/chats/connect-tool-calls-to-results.json

@@ -420,7 +420,7 @@
       "m.relates_to": {
         "event_id": "$VyCYG0DAuudwMGN8hStuSVfXrjMVZu2ZcJgIs9sIwLE",
         "key": "applied",
-        "rel_type": "m.annotation"
+        "rel_type": "app.boxel.commandAnnotation"
       },
       "commandRequestId": "call_or0qFTa8y9Ef8ZVyRDNR2P1T",
       "data": "{\"cardEventId\":\"$dKXYGWZLmS42Yib6sDHwP1surO2PiGCr5t2XHFIGFmc\"}"

packages/ai-bot/tests/resources/chats/required-tools-multiple-messages.json

@@ -355,7 +355,7 @@
       "m.relates_to": {
         "event_id": "$pZ5t1hj93dVwVcrh60-XFNeSL4ztErK6J0wAYr9hI_0",
         "key": "applied",
-        "rel_type": "m.annotation"
+        "rel_type": "app.boxel.commandAnnotation"
       }
     },
     "origin_server_ts": 1734900014044,
@@ -674,7 +674,7 @@
       "m.relates_to": {
         "event_id": "$BQ3wE7TxtE38oid1xynRFTglU2_2P5jJ8k01uXrHj1U",
         "key": "applied",
-        "rel_type": "m.annotation"
+        "rel_type": "app.boxel.commandAnnotation"
       }
     },
     "origin_server_ts": 1734900100494,

packages/ai-bot/tests/resources/chats/two-tool-calls-one-result.json

@@ -428,7 +428,7 @@
       "m.relates_to": {
         "event_id": "$VyCYG0DAuudwMGN8hStuSVfXrjMVZu2ZcJgIs9sIwLE",
         "key": "applied",
-        "rel_type": "m.annotation"
+        "rel_type": "app.boxel.commandAnnotation"
       },
       "commandRequestId": "call_or0qFTa8y9Ef8ZVyRDNR2P1T",
       "data": "{\"cardEventId\":\"$dKXYGWZLmS42Yib6sDHwP1surO2PiGCr5t2XHFIGFmc\"}"

packages/ai-bot/tests/resources/chats/two-tool-calls-two-results.json

@@ -428,7 +428,7 @@
       "m.relates_to": {
         "event_id": "$VyCYG0DAuudwMGN8hStuSVfXrjMVZu2ZcJgIs9sIwLE",
         "key": "applied",
-        "rel_type": "m.annotation"
+        "rel_type": "app.boxel.commandAnnotation"
       },
       "commandRequestId": "call_or0qFTa8y9Ef8ZVyRDNR2P1T",
       "data": "{\"cardEventId\":\"$dKXYGWZLmS42Yib6sDHwP1surO2PiGCr5t2XHFIGFmc\"}"
@@ -469,7 +469,7 @@
       "m.relates_to": {
         "event_id": "$VyCYG0DAuudwMGN8hStuSVfXrjMVZu2ZcJgIs9sIwLE",
         "key": "applied",
-        "rel_type": "m.annotation"
+        "rel_type": "app.boxel.commandAnnotation"
       },
       "commandRequestId": "call_or1e5Ta8y9Ef8ZVyRDNRabcd",
       "data": "{\"cardEventId\":\"$aBcYGWZLmS42Yib6sDHwP1surO2PiGCr5t2XHFIGF12\"}"

packages/base/matrix-event.gts

@@ -250,7 +250,7 @@ export interface CommandDefinitionsContent {
 }
 export interface CommandResultWithOutputContent {
   'm.relates_to': {
-    rel_type: 'm.annotation';
+    rel_type: APP_BOXEL_COMMAND_RESULT_REL_TYPE;
     key: string;
     event_id: string;
   };
@@ -265,7 +265,7 @@ export interface CommandResultWithOutputContent {
 
 export interface CommandResultWithNoOutputContent {
   'm.relates_to': {
-    rel_type: 'm.annotation';
+    rel_type: APP_BOXEL_COMMAND_RESULT_REL_TYPE;
     key: string;
     event_id: string;
   };

packages/host/app/lib/matrix-classes/message-builder.ts

@@ -227,7 +227,7 @@ export default class MessageBuilder {
         let r = e.content['m.relates_to'];
         return (
           e.type === APP_BOXEL_COMMAND_RESULT_EVENT_TYPE &&
-          r.rel_type === 'm.annotation' &&
+          r.rel_type === APP_BOXEL_COMMAND_RESULT_REL_TYPE &&
           (r.event_id === this.event.event_id ||
             r.event_id === this.builderContext.effectiveEventId) &&
           e.content.commandRequestId === commandRequest.id

packages/host/app/resources/room.ts

@@ -452,7 +452,8 @@ export class RoomResource extends Resource<Args> {
     event: MessageEvent | CardMessageEvent | CommandResultEvent,
   ) {
     return event.content['m.relates_to']?.rel_type === 'm.replace' ||
-      event.content['m.relates_to']?.rel_type === 'm.annotation'
+      event.content['m.relates_to']?.rel_type ===
+        APP_BOXEL_COMMAND_RESULT_REL_TYPE
       ? event.content['m.relates_to'].event_id
       : event.event_id;
   }

packages/host/app/services/matrix-service.ts

@@ -559,7 +559,7 @@ export default class MatrixService extends Service {
         'm.relates_to': {
           event_id: invokedToolFromEventId,
           key: 'applied',
-          rel_type: 'm.annotation',
+          rel_type: APP_BOXEL_COMMAND_RESULT_REL_TYPE,
         },
       };
     } else {
@@ -568,7 +568,7 @@ export default class MatrixService extends Service {
         'm.relates_to': {
           event_id: invokedToolFromEventId,
           key: 'applied',
-          rel_type: 'm.annotation',
+          rel_type: APP_BOXEL_COMMAND_RESULT_REL_TYPE,
         },
         commandRequestId: toolCallId,
         data: {

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

@@ -938,7 +938,7 @@ module('Acceptance | Commands tests', function (hooks) {
     );
     assert.strictEqual(
       message.content['m.relates_to']?.rel_type,
-      'm.annotation',
+      APP_BOXEL_COMMAND_RESULT_REL_TYPE,
     );
     assert.strictEqual(message.content['m.relates_to']?.key, 'applied');
     assert.strictEqual(message.content.commandRequestId, 'abc123');
@@ -1125,7 +1125,8 @@ module('Acceptance | Commands tests', function (hooks) {
     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']?.rel_type ===
+          APP_BOXEL_COMMAND_RESULT_REL_TYPE &&
         event.content['m.relates_to']?.key === 'applied',
     );
     assert.equal(

packages/host/tests/helpers/mock-matrix/_server-state.ts

@@ -230,43 +230,6 @@ export class ServerState {
     return matrixEvent.event_id;
   }
 
-  addReactionEvent(
-    sender: string,
-    roomId: string,
-    eventId: string,
-    status: string,
-  ) {
-    let room = this.#rooms.get(roomId);
-    if (!room) {
-      throw new Error(`room ${roomId} does not exist`);
-    }
-
-    let content = {
-      'm.relates_to': {
-        event_id: eventId,
-        key: status,
-        rel_type: 'm.annotation' as MatrixSDK.RelationType.Annotation,
-      },
-    };
-
-    let reactionEvent = {
-      event_id: this.eventId(),
-      origin_server_ts: this.#now(),
-      room_id: roomId,
-      type: 'm.reaction' as MatrixSDK.EventType.Reaction,
-      sender,
-      content,
-      state_key: '',
-      unsigned: { age: 0 },
-      status: 'sent' as MatrixSDK.EventStatus.SENT,
-    };
-
-    room.events.push(reactionEvent);
-    this.#listeners.forEach((listener) => listener(reactionEvent));
-
-    return reactionEvent;
-  }
-
   addReceiptEvent(
     roomId: string,
     eventId: string,

packages/host/tests/integration/components/ai-assistant-panel-test.gts

@@ -2258,7 +2258,8 @@ module('Integration | ai-assistant-panel', function (hooks) {
     let commandResultEvents = 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']?.rel_type ===
+          APP_BOXEL_COMMAND_RESULT_REL_TYPE &&
         event.content['m.relates_to']?.key === 'applied',
     );
     assert.equal(
@@ -2282,7 +2283,8 @@ module('Integration | ai-assistant-panel', function (hooks) {
     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']?.rel_type ===
+          APP_BOXEL_COMMAND_RESULT_REL_TYPE &&
         event.content['m.relates_to']?.key === 'applied',
     );
     assert.equal(

packages/runtime-common/matrix-constants.ts

@@ -3,6 +3,7 @@ export const APP_BOXEL_MESSAGE_MSGTYPE = 'app.boxel.message';
 export const APP_BOXEL_CARD_FORMAT = 'app.boxel.card';
 export const APP_BOXEL_COMMAND_REQUESTS_KEY = 'app.boxel.commandRequests';
 export const APP_BOXEL_COMMAND_RESULT_EVENT_TYPE = 'app.boxel.commandResult';
+export const APP_BOXEL_COMMAND_RESULT_REL_TYPE = 'app.boxel.commandAnnotation';
 export const APP_BOXEL_COMMAND_DEFINITIONS_MSGTYPE =
   'app.boxel.commandDefinitions';
 export const APP_BOXEL_COMMAND_RESULT_WITH_OUTPUT_MSGTYPE =