API now has action execution endpoint (#1797)

Using the API you can now supply actions that are forwarded to the
dispatcher.

Author: robgruen

ts/.vscode/launch.json

@@ -65,7 +65,14 @@
       "cwd": "${workspaceFolder}/packages/api",
       "program": "./dist/index.js",
       "outFiles": ["${workspaceFolder}/**/*.js"],
-      "resolveSourceMapLocations": []
+      "console": "externalTerminal",
+      "resolveSourceMapLocations": [],
+      "serverReadyAction": {
+      "pattern": "Listening on all local IPs at port ([0-9]+)",
+      "uriFormat": "http://localhost:%s/chatView.html",
+      "action": "openExternally"
+      }
+    }
     },
     {
       "type": "node",

ts/package.json

@@ -55,7 +55,7 @@
     "prettier": "^3.5.3",
     "shx": "^0.4.0"
   },
-  "packageManager": "pnpm@10.23.0+sha512.21c4e5698002ade97e4efe8b8b4a89a8de3c85a37919f957e7a0f30f38fbc5bbdd05980ffe29179b2fb6e6e691242e098d945d1601772cad0fef5fb6411e2a4b",
+  "packageManager": "pnpm@10.24.0+sha512.01ff8ae71b4419903b65c60fb2dc9d34cf8bb6e06d03bde112ef38f7a34d6904c424ba66bea5cdcf12890230bf39f9580473140ed9c946fef328b6e5238a345a",
   "engines": {
     "node": ">=20",
     "pnpm": ">=10"

ts/packages/api/README.md

@@ -10,7 +10,7 @@ After setting up and building at the workspace root, there are several ways to s
 
 ### Locally
 
-The server can be started with `npm run start` in this package's directory. Then connect to `http://localhost:3000` using a web browser.
+The server can be started with `npm run start` in this package's directory. Then connect to `http://localhost:3000` using a web browser. If you want to load the Shell interface in the browser window you want to open `http://localhost:3000/chatView.html`
 
 ### Docker Image
 

ts/packages/api/package.json

@@ -32,6 +32,7 @@
     "@typeagent/agent-rpc": "workspace:*",
     "@typeagent/agent-sdk": "workspace:*",
     "@typeagent/dispatcher-rpc": "workspace:*",
+    "agent-cache": "workspace:*",
     "agent-dispatcher": "workspace:*",
     "aiclient": "workspace:*",
     "chalk": "^5.4.1",

ts/packages/api/src/typeAgentServer.ts

@@ -24,6 +24,10 @@ import { TypeAgentStorageProvider } from "./storageProvider.js";
 import { AzureStorageProvider } from "./storageProviders/azureStorageProvider.js";
 import { AWSStorageProvider } from "./storageProviders/awsStorageProvider.js";
 import { WebDispatcher, createWebDispatcher } from "./webDispatcher.js";
+import registerDebug from "debug";
+
+const debug = registerDebug("typeagent:webserver:api");
+registerDebug.enable("typeagent:webserver:*");
 
 export class TypeAgentServer {
     private webDispatcher: WebDispatcher | undefined;
@@ -34,12 +38,16 @@ export class TypeAgentServer {
     private config: TypeAgentAPIServerConfig;
 
     constructor(private envPath: string) {
+        debug(`Loading .env from path: ${envPath}`);
+
         // typeAgent config
         dotenv.config({ path: this.envPath });
 
         // web server config
         this.config = JSON.parse(readFileSync("data/config.json").toString());
 
+        debug(`Loaded web config from `);
+
         const storageProviderMap = {
             azure: AzureStorageProvider,
             aws: AWSStorageProvider,
@@ -50,6 +58,11 @@ export class TypeAgentServer {
             this.storageProvider = new storageProviderMap[
                 this.config.storageProvider
             ]();
+            debug(`Storage provider setup: ${this.config.storageProvider}`);
+        } else {
+            debug(
+                `Skipping storage provider setup [backupEnabled: ${this.config.blobBackupEnabled}] [provider: ${this.config.storageProvider}]`,
+            );
         }
     }
 
@@ -60,39 +73,28 @@ export class TypeAgentServer {
             await this.syncFromProvider();
             this.startLocalStorageBackup();
             sw.stop("Downloaded Session Backup");
-            /*
-            if (
-                this.storageAccount !== undefined &&
-                this.storageAccount.length > 0 &&
-                this.containerName != undefined &&
-                this.containerName.length > 0
-            ) {
-                const sw = new StopWatch();
-                sw.start("Downloading Session Backup");
-
-                await this.syncBlobStorage();
-
-                this.startLocalStorageBackup();
-
-                sw.stop("Downloaded Session Backup");
-            } else {
-                console.warn(
-                    `Blob backup enabled but NOT configured.  Missing env var ${openai.EnvVars.AZURE_STORAGE_ACCOUNT}.`,
-                );
-            }
-            */
         }
 
         this.webDispatcher = await createWebDispatcher();
+        debug("Web Dispatcher created.");
+
         // web server
-        this.webServer = new TypeAgentAPIWebServer(this.config);
+        this.webServer = new TypeAgentAPIWebServer(
+            this.config,
+            (action: any) => {
+                // a client passed in an action to perform
+                this.webDispatcher?.handleAction(action);
+            },
+        );
         this.webServer.start();
+        debug("TypeAgent Web Server created.");
 
         // websocket server
         this.webSocketServer = new TypeAgentAPIWebSocketServer(
             this.webServer.server,
             this.webDispatcher.connect,
         );
+        debug("WebSocket Server created.");
     }
 
     stop() {

ts/packages/api/src/webDispatcher.ts

@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-import { createDispatcher } from "agent-dispatcher";
+import { CommandResult, createDispatcher } from "agent-dispatcher";
 import { getConsolePrompt } from "agent-dispatcher/helpers/console";
 import { getInstanceDir, getClientId } from "agent-dispatcher/helpers/data";
 import { getStatusSummary } from "agent-dispatcher/helpers/status";
@@ -15,11 +15,18 @@ import {
 } from "default-agent-provider";
 import WebSocket from "ws";
 import { getFsStorageProvider } from "dispatcher-node-providers";
+import registerDebug from "debug";
+import { FullAction } from "agent-cache";
+
+const debug = registerDebug("typeagent:webserver:api");
+registerDebug.enable("typeagent:webserver:*");
 
 export interface WebDispatcher {
     connect(ws: WebSocket): void;
     close(): void;
+    handleAction(action: FullAction): Promise<CommandResult>;
 }
+
 export async function createWebDispatcher(): Promise<WebDispatcher> {
     let ws: WebSocket | null = null;
     const clientIOChannel = createChannelAdapter((message: any) =>
@@ -31,6 +38,8 @@ export async function createWebDispatcher(): Promise<WebDispatcher> {
         ),
     );
 
+    debug("Creating Web Dispatcher...");
+
     const instanceDir = getInstanceDir();
     const clientIO = createClientIORpcClient(clientIOChannel.channel);
     const dispatcher = await createDispatcher("api", {
@@ -68,6 +77,16 @@ export async function createWebDispatcher(): Promise<WebDispatcher> {
         return newSettingSummary;
     };
 
+    async function handleAction(action: FullAction): Promise<any> {
+        // TODO: expose executeAction so we can call that directly instead of running it through a command
+        // TODO: bubble back any action results along with the command result
+        await dispatcher.processCommand(
+            `@action ${action.schemaName} ${action.actionName} --parameters '${JSON.stringify(action.parameters).replaceAll("'", "\\'")}'`,
+            undefined,
+            undefined,
+        );
+    }
+
     async function processShellRequest(
         text: string,
         id: string,
@@ -91,6 +110,7 @@ export async function createWebDispatcher(): Promise<WebDispatcher> {
     const patchedDispatcher = {
         ...dispatcher,
         processCommand: processShellRequest,
+        handleAction: handleAction,
     };
 
     const dispatcherChannel = createChannelAdapter((message: any) =>
@@ -138,5 +158,6 @@ export async function createWebDispatcher(): Promise<WebDispatcher> {
         close: () => {
             dispatcher.close();
         },
+        handleAction: handleAction,
     };
 }

ts/packages/api/src/webServer.ts

@@ -21,8 +21,12 @@ export type TypeAgentAPIServerConfig = {
 export class TypeAgentAPIWebServer {
     public server: Server<any, any>;
     private secureServer: SecureServer<any, any> | undefined;
+    private actionHandler: (action: any) => any;
 
-    constructor(config: TypeAgentAPIServerConfig) {
+    constructor(
+        config: TypeAgentAPIServerConfig,
+        actionHandler: (action: any) => any,
+    ) {
         // web server
         this.server = createServer((request: any, response: any) => {
             this.serve(config, request, response);
@@ -49,6 +53,9 @@ export class TypeAgentAPIWebServer {
                 "SSL Certificates NOT found, cannot listen for https:// requests!",
             );
         }
+
+        // action handler
+        this.actionHandler = actionHandler;
     }
 
     serve(config: TypeAgentAPIServerConfig, request: any, response: any) {
@@ -64,6 +71,38 @@ export class TypeAgentAPIWebServer {
             return this.printHeaders(request, response);
         }
 
+        // process POST requests
+        let url = new URL(request.url, "http://localhost");
+        if (
+            url.pathname == "/action/" &&
+            (request.method === "PUT" || request.method === "GET")
+        ) {
+            let data: string | null = "";
+            if (request.method === "PUT") {
+                data = request.read();
+            } else {
+                data = url.searchParams.get("a");
+            }
+
+            try {
+                var action: any = JSON.parse(data?.toString() ?? "");
+                console.log(
+                    "Received action request: ",
+                    JSON.stringify(action, null, 2),
+                );
+
+                var actionResult = this.actionHandler(action);
+
+                response.writeHead(200, { "Content-Type": "application/json" });
+                response.end(JSON.stringify(actionResult));
+            } catch (ex) {
+                response.writeHead(500, { "Content-Type": "application/json" });
+                response.end(JSON.stringify({ error: ex }));
+            }
+
+            return;
+        }
+
         // make sure requested file falls under web root
         try {
             requestedFile = realpathSync(
@@ -85,13 +124,18 @@ export class TypeAgentAPIWebServer {
                 response.end(readFileSync(requestedFile).toString());
 
                 console.log(`Served '${requestedFile}' as '${request.url}'`);
+                return;
             }
         } catch (error) {
             response.writeHead(404, { "Content-Type": "text/plain" });
             response.end("File Not Found!\n");
 
             console.log(`Unable to serve '${request.url}', 404. ${error}`);
+            return;
         }
+
+        response.writeHead(400, { "Content-Type": "text/plain" });
+        response.end("Invalid Request!\n");
     }
 
     start() {