Merge branch 'main' into crm-use-case

Author: tintinthong

.github/workflows/ci-host.yaml

@@ -29,11 +29,14 @@ jobs:
       - name: Build boxel-ui
         run: pnpm build
         working-directory: packages/boxel-ui/addon
-      - name: Build host dist/ for fastboot
-        run: pnpm build
+      - name: Start host to serve assets for fastboot
+        run: pnpm start &
         env:
           NODE_OPTIONS: --max_old_space_size=4096
         working-directory: packages/host
+      - name: Wait for ember-cli to be ready
+        run: pnpm npx wait-for-localhost 4200
+        working-directory: packages/host
       - name: Start realm servers
         run: pnpm start:all &
         working-directory: packages/realm-server

.github/workflows/ci.yaml

@@ -92,11 +92,14 @@ jobs:
       - name: Build boxel-motion
         run: pnpm build
         working-directory: packages/boxel-motion/addon
-      - name: Build host dist/ for fastboot
-        run: pnpm build
+      - name: Start host to serve assets for fastboot
+        run: pnpm start &
         env:
           NODE_OPTIONS: --max_old_space_size=4096
         working-directory: packages/host
+      - name: Wait for ember-cli to be ready
+        run: pnpm npx wait-for-localhost 4200
+        working-directory: packages/host
       - name: Start realm servers
         run: pnpm start:without-matrix &
         working-directory: packages/realm-server
@@ -112,6 +115,15 @@ jobs:
           path: packages/matrix/blob-report
           retention-days: 1
 
+      - name: Upload Playwright traces
+        if: ${{ !cancelled() }}
+        uses: actions/upload-artifact@v4
+        with:
+          name: playwright-traces-${{ matrix.shardIndex }}
+          path: packages/matrix/test-results/**/trace.zip
+          retention-days: 30
+          if-no-files-found: ignore
+
   matrix-client-merge-reports-and-publish:
     name: Merge Matrix reports and publish
     if: always()
@@ -198,11 +210,14 @@ jobs:
       - name: Build boxel-ui
         run: pnpm build
         working-directory: packages/boxel-ui/addon
-      - name: Build host dist/ for fastboot
-        run: pnpm build
+      - name: Start host to serve assets for fastboot
+        run: pnpm start &
         env:
           NODE_OPTIONS: --max_old_space_size=4096
         working-directory: packages/host
+      - name: Wait for ember-cli to be ready
+        run: pnpm npx wait-for-localhost 4200
+        working-directory: packages/realm-server
       - name: Start realm servers
         run: pnpm start:all &
         working-directory: packages/realm-server
@@ -234,37 +249,23 @@ jobs:
               - '.github/workflows/deploy-host.yml'
               - '.github/workflows/manual-deploy.yml'
               - '.github/workflows/ci.yaml'
+              - 'packages/ai-bot/**'
               - 'packages/base/**'
               - 'packages/boxel-ui/**'
               - 'packages/host/**'
               - 'packages/realm-server/**'
               - 'packages/runtime-common/**'
               - 'pnpm-lock.yaml'
-            ai-bot:
-              - '.github/workflows/manual-ai-bot.yml'
-              - '.github/workflows/ci.yaml'
-              - 'packages/runtime-common/**'
-              - 'packages/ai-bot/**'
-              - 'pnpm-lock.yaml'
 
   deploy:
     name: Deploy boxel to staging
     if: ${{ needs.change-check.outputs.boxel == 'true' }}
     needs:
       - change-check
+      - ai-bot-test
       - boxel-ui-test
       - realm-server-test
     uses: ./.github/workflows/manual-deploy.yml
     secrets: inherit
     with:
       environment: "staging"
-
-  deploy-ai-bot:
-    needs:
-      - ai-bot-test
-      - change-check
-    if: ${{ needs.change-check.outputs.ai-bot == 'true' }}
-    uses: ./.github/workflows/manual-ai-bot.yml
-    secrets: inherit
-    with:
-      environment: "staging"

.github/workflows/manual-ai-bot.yml

@@ -14,6 +14,27 @@ on:
         type: string
 
 jobs:
+  build-ai-bot:
+    name: Build ai-bot Docker image
+    uses: cardstack/gh-actions/.github/workflows/docker-ecr.yml@main
+    secrets: inherit
+    with:
+      repository: "boxel-ai-bot-${{ inputs.environment }}"
+      environment: ${{ inputs.environment }}
+      dockerfile: "packages/ai-bot/Dockerfile"
+
+  deploy-ai-bot:
+    needs: [build-ai-bot]
+    name: Deploy ai-bot to AWS ECS
+    uses: cardstack/gh-actions/.github/workflows/ecs-deploy.yml@main
+    secrets: inherit
+    with:
+      container-name: "boxel-ai-bot"
+      environment: ${{ inputs.environment }}
+      cluster: ${{ inputs.environment }}
+      service-name: "boxel-ai-bot-${{ inputs.environment }}"
+      image: ${{ needs.build-ai-bot.outputs.image }}
+
   build-host:
     name: Build host
     uses: ./.github/workflows/build-host.yml
@@ -44,7 +65,7 @@ jobs:
       environment: staging
 
   build-realm-server:
-    name: Build Docker image
+    name: Build realm-server Docker image
     uses: cardstack/gh-actions/.github/workflows/docker-ecr.yml@main
     secrets: inherit
     with:

.github/workflows/manual-deploy.yml

@@ -42,7 +42,7 @@ To build the entire repository and run the application, follow these steps:
 
    ```zsh
    cd ./packages/realm-server
-   pnpm start:all
+   DISABLE_MODULE_CACHING=true pnpm start:all
    ```
 
    Note: Ensure that the realm-server is completely started by looking out for tor the test-realm indexing output.
@@ -84,7 +84,10 @@ To build the entire repository and run the application, follow these steps:
 11. Validate email for login
 	- Visit SMTP UI at http://localhost:5001/
 	- Validate email
-	- Go back to Host and login
+	- Go back to Host http://localhost:4201/ and login 
+
+12. Trigger interact mode
+   - After you see a list of cards, Ctrl+ . OR Ctrl +, to "interact" with them 
 
 13. Run ai bot (Optional):
 

QUICKSTART.md

@@ -66,7 +66,7 @@ In order to run the realm server hosted app:
 
 You can visit the URL of each realm server to view that realm's app. So for instance, the base realm's app is available at `http://localhost:4201/base` and the draft realm's app is at `http://localhost:4201/draft`.
 
-Live reloads are not available in this mode, but you can just refresh the page to grab the latest code changes if you are running rebuilds (step #1 and #2 above).
+Live reloads are not available in this mode, however, if you use start the server with the environment variable `DISABLE_MODULE_CACHING=true` you can just refresh the page to grab the latest code changes if you are running rebuilds (step #1 and #2 above).
 
 #### Using `start:all`
 

README.md

@@ -20,7 +20,7 @@
   "pnpm": {
     "overrides": {
       "@types/eslint": "8.4.1",
-      "@embroider/util": "1.12.0",
+      "@embroider/util": "1.13.1",
       "@glimmer/tracking>@glimmer/validator": "0.84.3",
       "jsesc": "^3.0.0",
       "ember-modifier": "^4.1.0",

package.json

@@ -1,9 +1,12 @@
-import { type LooseSingleCardDocument } from '@cardstack/runtime-common';
+import type {
+  CardResource,
+  LooseSingleCardDocument,
+} from '@cardstack/runtime-common';
 import type {
   MatrixEvent as DiscreteMatrixEvent,
   CardFragmentContent,
   CommandEvent,
-} from 'https://cardstack.com/base/room';
+} from 'https://cardstack.com/base/matrix-event';
 import { MatrixEvent, type IRoomEvent } from 'matrix-js-sdk';
 
 const MODIFY_SYSTEM_MESSAGE =
@@ -23,6 +26,9 @@ If a user asks you about things in the world, use your existing knowledge to hel
 If you need access to the cards the user can see, you can ask them to attach the cards. \
 If you encounter JSON structures, please enclose them within backticks to ensure they are displayed stylishly in Markdown.';
 
+export const SKILL_INSTRUCTIONS_MESSAGE =
+  '\nThe user has given you the following instructions. You must obey these instructions when responding to the user:\n';
+
 type CommandMessage = {
   type: 'command';
   content: any;
@@ -62,14 +68,16 @@ export function constructHistory(history: IRoomEvent[]) {
       fragments.set(eventId, event.content);
       continue;
     } else if (event.content.msgtype === 'org.boxel.message') {
-      if (
-        event.content.data.attachedCardsEventIds &&
-        event.content.data.attachedCardsEventIds.length > 0
-      ) {
-        event.content.data.attachedCards =
-          event.content.data.attachedCardsEventIds!.map((id) =>
-            serializedCardFromFragments(id, fragments),
-          );
+      let { attachedCardsEventIds, attachedSkillEventIds } = event.content.data;
+      if (attachedCardsEventIds && attachedCardsEventIds.length > 0) {
+        event.content.data.attachedCards = attachedCardsEventIds.map((id) =>
+          serializedCardFromFragments(id, fragments),
+        );
+      }
+      if (attachedSkillEventIds && attachedSkillEventIds.length > 0) {
+        event.content.data.skillCards = attachedSkillEventIds.map((id) =>
+          serializedCardFromFragments(id, fragments),
+        );
       }
     }
 
@@ -142,35 +150,55 @@ export interface OpenAIPromptMessage {
   role: 'system' | 'user' | 'assistant';
 }
 
+function setRelevantCards(
+  cardMap: Map<string, CardResource> = new Map(),
+  cards: LooseSingleCardDocument[] = [],
+) {
+  for (let card of cards) {
+    if (card.data.id) {
+      cardMap.set(card.data.id, card.data as CardResource);
+    } else {
+      throw new Error(`bug: don't know how to handle card without ID`);
+    }
+  }
+  return cardMap;
+}
+
 export function getRelevantCards(
   history: DiscreteMatrixEvent[],
   aiBotUserId: string,
 ) {
-  let relevantCards: Map<string, any> = new Map();
+  let attachedCardMap = new Map<string, CardResource>();
+  let skillCardMap = new Map<string, CardResource>();
+  let latestMessageEventId = history
+    .filter((ev) => ev.sender !== aiBotUserId && ev.type === 'm.room.message')
+    .slice(-1)[0]?.event_id;
   for (let event of history) {
     if (event.type !== 'm.room.message') {
       continue;
     }
     if (event.sender !== aiBotUserId) {
       let { content } = event;
       if (content.msgtype === 'org.boxel.message') {
-        const attachedCards = content.data?.attachedCards || [];
-        for (let card of attachedCards) {
-          if (card.data.id) {
-            relevantCards.set(card.data.id, card.data);
-          } else {
-            throw new Error(`bug: don't know how to handle card without ID`);
-          }
+        setRelevantCards(attachedCardMap, content.data?.attachedCards);
+
+        // setting skill card instructions only based on the latest boxel message event (not cumulative)
+        if (event.event_id === latestMessageEventId) {
+          setRelevantCards(skillCardMap, content.data?.skillCards);
         }
       }
     }
   }
-
-  // Return the cards in a consistent manner
-  let sortedCards = Array.from(relevantCards.values()).sort((a, b) => {
-    return a.id.localeCompare(b.id);
-  });
-  return sortedCards;
+  let attachedCards = Array.from(attachedCardMap.values()).sort((a, b) =>
+    a.id.localeCompare(b.id),
+  );
+  let skillCards = Array.from(skillCardMap.values()).sort((a, b) =>
+    a.id.localeCompare(b.id),
+  );
+  return {
+    attachedCards,
+    skillCards,
+  };
 }
 
 export function getTools(history: DiscreteMatrixEvent[], aiBotUserId: string) {
@@ -227,12 +255,20 @@ export function getModifyPrompt(
     }
   }
 
+  let { attachedCards, skillCards } = getRelevantCards(history, aiBotUserId);
   let systemMessage =
     MODIFY_SYSTEM_MESSAGE +
     `
   The user currently has given you the following data to work with:
   Cards:\n`;
-  systemMessage += attachedCardsToMessage(history, aiBotUserId);
+  systemMessage += attachedCardsToMessage(attachedCards);
+
+  if (skillCards.length) {
+    systemMessage += SKILL_INSTRUCTIONS_MESSAGE;
+    systemMessage += skillCardsToMessage(skillCards);
+    systemMessage += '\n';
+  }
+
   if (tools.length == 0) {
     systemMessage +=
       'You are unable to edit any cards, the user has not given you access, they need to open the card on the stack and let it be auto-attached';
@@ -249,12 +285,13 @@ export function getModifyPrompt(
   return messages;
 }
 
-export const attachedCardsToMessage = (
-  history: DiscreteMatrixEvent[],
-  aiBotUserId: string,
-) => {
-  return `Full card data: ${JSON.stringify(
-    getRelevantCards(history, aiBotUserId),
+export const attachedCardsToMessage = (cards: CardResource[]) => {
+  return `Full card data: ${JSON.stringify(cards)}`;
+};
+
+export const skillCardsToMessage = (cards: CardResource[]) => {
+  return `${JSON.stringify(
+    cards.map((card) => card.attributes?.instructions),
   )}`;
 };
 

packages/ai-bot/helpers.ts

@@ -7,7 +7,7 @@ import {
   attachedCardsToMessage,
 } from '../helpers';
 import { MatrixClient } from './matrix';
-import type { MatrixEvent as DiscreteMatrixEvent } from 'https://cardstack.com/base/room';
+import type { MatrixEvent as DiscreteMatrixEvent } from 'https://cardstack.com/base/matrix-event';
 
 const SET_TITLE_SYSTEM_MESSAGE = `You are a chat titling system, you must read the conversation and return a suggested title of no more than six words.
 Do NOT say talk or discussion or discussing or chat or chatting, this is implied by the context. 

packages/ai-bot/lib/set-title.ts

@@ -21,7 +21,7 @@ import {
 import { Responder } from './lib/send-response';
 import { handleDebugCommands } from './lib/debug';
 import { MatrixClient } from './lib/matrix';
-import type { MatrixEvent as DiscreteMatrixEvent } from 'https://cardstack.com/base/room';
+import type { MatrixEvent as DiscreteMatrixEvent } from 'https://cardstack.com/base/matrix-event';
 import * as Sentry from '@sentry/node';
 
 if (process.env.SENTRY_DSN) {