@jskit-ai/assistant-runtime 0.2.41 → 0.2.42

package/CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ## Unreleased
 
+- The saved-conversations list (`GET /api/assistant/:surfaceId/conversations`, and its workspace form) answers 200 again instead of 500 ("metadata is required!") once a person has a conversation: the route still serialized each item with the conversation's read schema, which requires `metadata`, after list items stopped carrying it. It serializes them with assistant-core's `assistantConversationListItemOutputValidator`, the item of `assistantContract`'s `conversationsList`. `conversationsListRoute.test.js` lists a saved conversation over HTTP through the real route, actions and SQL repositories.
 - Each conversation request authenticates once: the route's access check and the action's request context share one sign-in lookup instead of each asking again.
 - **Breaking.** Conversation list items no longer carry `metadata`: the conversations repository's `listForActorScope` reads only the fields a list shows, as `assistantContract`'s `conversationsList` now answers them. Upgrading: code that read `metadata` from a list item reads the conversation instead, with `findByIdForActorScope` or the conversation's messages read, which still answer it.
 - A chat turn ends by reading the turn it waited on (`handle.wait({ turnId })`) instead of reading and cloning every turn of the conversation to keep one.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jskit-ai/assistant-runtime",
-  "version": "0.2.41",
+  "version": "0.2.42",
   "type": "module",
   "scripts": {
     "test": "jskit test"
@@ -15,21 +15,21 @@
     "./locales/en.json": "./locales/en.json"
   },
   "dependencies": {
-    "@jskit-ai/assistant-core": "0.2.39",
+    "@jskit-ai/assistant-core": "0.2.40",
     "@jskit-ai/resource-core": "0.1.209",
     "json-rest-schema": "^1.0.20"
   },
   "peerDependencies": {
     "@jskit-ai/http-runtime": "0.2.18",
-    "@jskit-ai/http-web": "0.2.28",
+    "@jskit-ai/http-web": "0.2.29",
     "@jskit-ai/kernel": "0.2.18",
-    "@jskit-ai/realtime": "0.2.26",
-    "@jskit-ai/shell-web": "0.2.23",
+    "@jskit-ai/realtime": "0.2.27",
+    "@jskit-ai/shell-web": "0.2.24",
     "@tanstack/vue-query": "^5.90.5",
     "vue": "^3.5.13",
     "vuetify": "^4.0.0",
     "@jskit-ai/database-runtime": "0.1.267",
-    "@jskit-ai/resource-runtime": "0.2.22"
+    "@jskit-ai/resource-runtime": "0.2.23"
   },
   "description": "Capability-based assistant runtime with per-surface chat, transcripts, settings, and action tools.",
   "jskit": {
@@ -139,6 +139,6 @@
   },
   "devDependencies": {
     "@jskit-ai/material-web": "0.1.5",
-    "@jskit-ai/resource-runtime": "0.2.22"
+    "@jskit-ai/resource-runtime": "0.2.23"
   }
 }

package/src/server/registerRoutes.js

@@ -4,7 +4,7 @@ import { createJsonApiResourceRouteContract } from "@jskit-ai/http-runtime/share
 import {
   ASSISTANT_CONVERSATIONS_TRANSPORT,
   ASSISTANT_CONVERSATION_MESSAGES_TRANSPORT,
-  assistantConversationOutputValidator,
+  assistantConversationListItemOutputValidator,
   assistantContract,
   resolveAssistantApiBasePath
 } from "@jskit-ai/assistant-core/shared";
@@ -227,7 +227,7 @@ function registerRuntimeRoutes(
       ...createJsonApiResourceRouteContract({
         ...ASSISTANT_CONVERSATIONS_TRANSPORT,
         query: assistantContract.operations.conversationsList.query,
-        output: assistantConversationOutputValidator,
+        output: assistantConversationListItemOutputValidator,
         outputKind: "collection"
       })
     },

package/test/conversationsListRoute.test.js

@@ -0,0 +1,68 @@
+import assert from "node:assert/strict";
+import test from "node:test";
+import Fastify from "fastify";
+import knex from "knex";
+import { createActionCatalogue } from "@jskit-ai/kernel/server/actions";
+import { createRouter } from "../../kernel/server/http/lib/router.js";
+import { registerRoutes as registerFastifyRoutes } from "../../kernel/server/http/lib/routeRegistration.js";
+import { registerApiErrorHandler } from "../../kernel/server/http/errorHandling.js";
+import transcriptsMigration from "../migrations/assistant_transcripts_initial.cjs";
+import summaryMigration from "../migrations/assistant_transcripts_summary.cjs";
+import claimsMigration from "../migrations/assistant_turn_requests.cjs";
+import { createAssistantActions } from "../src/server/actions.js";
+import { registerRoutes } from "../src/server/registerRoutes.js";
+import { createChatService } from "../src/server/services/chatService.js";
+import { createTranscriptService } from "../src/server/services/transcriptService.js";
+import { createTestAssistantStore } from "./support/assistantStore.js";
+
+const config = Object.freeze({
+  surfaceDefinitions: { assistant: { enabled: true, requiresWorkspace: false } },
+  assistantSurfaces: { assistant: { settingsSurfaceId: "assistant", configScope: "global" } }
+});
+
+// The saved-conversations list as an application serves it: the assistant's SQL repositories on SQLite, its chat
+// service and actions, and its routes on Fastify, with the signed-in user "1".
+async function listApp(t) {
+  const db = knex({ client: "better-sqlite3", connection: { filename: ":memory:" }, useNullAsDefault: true, pool: { min: 1, max: 1 } });
+  const store = await createTestAssistantStore(db);
+  const app = Fastify();
+  t.after(async () => {
+    await app.close();
+    await store.close();
+    await db.destroy();
+  });
+  await db.schema.createTable("users", (table) => table.bigInteger("id").primary());
+  await db("users").insert([{ id: 1 }]);
+  await transcriptsMigration.up(db);
+  await summaryMigration.up(db);
+  await claimsMigration.up(db);
+
+  const chatService = createChatService({
+    transcriptService: createTranscriptService({ conversationsRepository: store.conversations, messagesRepository: store.messages }),
+    turnRequests: store.turnRequests,
+    appConfig: config
+  });
+  const actions = createActionCatalogue();
+  actions.register({ contributorId: "test.assistant", domain: "assistant", actions: createAssistantActions({ config, chatService, assistantConfigService: {} }) });
+  actions.registerContextContributor({ id: "test.actor", contribute: () => ({ actor: { id: "1" } }) });
+  const router = createRouter();
+  registerRoutes(router, { config });
+  registerApiErrorHandler(app);
+  registerFastifyRoutes(app, { routes: router.list(), actions });
+  return { app, conversations: store.conversations };
+}
+
+test("the saved-conversations list answers its conversations over HTTP, without their runtime metadata", async (t) => {
+  const { app, conversations } = await listApp(t);
+  const saved = await conversations.create({ createdByUserId: "1", surfaceId: "assistant", title: "Order follow-up",
+    metadata: { runtime: { systemPrompt: "Answer briefly." } } });
+
+  const response = await app.inject({ method: "GET", url: "/api/assistant/assistant/conversations", headers: { "x-jskit-surface": "assistant" } });
+
+  // Before, the route serialized each item with the conversation's read schema, which requires metadata: a 500.
+  assert.equal(response.statusCode, 200, response.body);
+  const { data } = response.json();
+  assert.deepEqual(data.map((item) => [item.type, item.id, item.attributes.title]), [["assistant-conversations", saved.id, "Order follow-up"]]);
+  assert.equal(Object.hasOwn(data[0].attributes, "metadata"), false);
+  assert.equal(data[0].attributes.createdByUserId, "1");
+});