@dxos/functions 0.3.7 → 0.3.8-main.0ae9c21

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxos/functions",
-  "version": "0.3.7",
+  "version": "0.3.8-main.0ae9c21",
   "description": "Functions SDK and runtime.",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
@@ -20,15 +20,15 @@
   ],
   "dependencies": {
     "express": "^4.17.1",
-    "portfinder": "^1.0.32",
-    "@dxos/async": "0.3.7",
-    "@dxos/client": "0.3.7",
-    "@dxos/context": "0.3.7",
-    "@dxos/echo-schema": "0.3.7",
-    "@dxos/invariant": "0.3.7",
-    "@dxos/log": "0.3.7",
-    "@dxos/node-std": "0.3.7",
-    "@dxos/util": "0.3.7"
+    "get-port-please": "^3.1.1",
+    "@dxos/async": "0.3.8-main.0ae9c21",
+    "@dxos/context": "0.3.8-main.0ae9c21",
+    "@dxos/invariant": "0.3.8-main.0ae9c21",
+    "@dxos/echo-schema": "0.3.8-main.0ae9c21",
+    "@dxos/log": "0.3.8-main.0ae9c21",
+    "@dxos/node-std": "0.3.8-main.0ae9c21",
+    "@dxos/util": "0.3.8-main.0ae9c21",
+    "@dxos/client": "0.3.8-main.0ae9c21"
   },
   "devDependencies": {
     "@types/express": "^4.17.17"

package/src/handler.ts

@@ -0,0 +1,29 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import { type Client } from '@dxos/client';
+
+export interface Response {
+  status(code: number): Response;
+  succeed(data?: object): Response;
+}
+
+export interface FunctionContext {
+  client: Client;
+  status(code: number): Response;
+}
+
+/**
+ * Function handler.
+ */
+export type FunctionHandler<T extends {}> = (params: {
+  context: FunctionContext;
+  event: T;
+}) => Promise<Response | void>;
+
+// TODO(burdon): Types.
+export type FunctionSubscriptionEvent = {
+  space: string;
+  objects: string[];
+};

package/src/index.ts

@@ -2,5 +2,6 @@
 // Copyright 2023 DXOS.org
 //
 
-export * from './function';
+export * from './handler';
+export * from './manifest';
 export * from './runtime';

package/src/manifest.ts

@@ -0,0 +1,36 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+export type FunctionDef = {
+  // FQ function name.
+  id: string;
+  // URL path.
+  path: string;
+  // Path of handler.
+  handler: string;
+  description?: string;
+};
+
+export type TriggerSubscription = {
+  type: string;
+  spaceKey: string;
+  props?: Record<string, any>;
+  nested?: string[];
+};
+
+// TODO(burdon): Generalize binding.
+// https://www.npmjs.com/package/aws-lambda
+// https://docs.aws.amazon.com/lambda/latest/dg/typescript-handler.html
+export type FunctionTrigger = {
+  function: string;
+  subscription: TriggerSubscription;
+};
+
+/**
+ * Function manifest file.
+ */
+export type FunctionManifest = {
+  functions: FunctionDef[];
+  triggers: FunctionTrigger[];
+};

package/src/runtime/dev-server.ts

@@ -3,32 +3,35 @@
 //
 
 import express from 'express';
+import { getPort } from 'get-port-please';
 import type http from 'http';
 import { join } from 'node:path';
-import { getPortPromise } from 'portfinder';
 
 import { Trigger } from '@dxos/async';
 import { type Client } from '@dxos/client';
+import { invariant } from '@dxos/invariant';
 import { log } from '@dxos/log';
 
-import { type FunctionContext, type FunctionHandler, type FunctionsManifest, type Response } from '../function';
-
-const DEFAULT_PORT = 7000;
+import { type FunctionContext, type FunctionHandler, type Response } from '../handler';
+import { type FunctionDef, type FunctionManifest } from '../manifest';
 
 export type DevServerOptions = {
+  port?: number;
   directory: string;
-  manifest: FunctionsManifest;
+  manifest: FunctionManifest;
 };
 
 /**
  * Functions dev server provides a local HTTP server for testing functions.
  */
+// TODO(burdon): Reconcile with agent/functions dev dispatcher.
 export class DevServer {
-  private readonly _handlers: Record<string, FunctionHandler<any>> = {};
+  private readonly _handlers: Record<string, { def: FunctionDef; handler: FunctionHandler<any> }> = {};
 
   private _server?: http.Server;
   private _port?: number;
   private _registrationId?: string;
+  private _proxy?: string;
 
   // prettier-ignore
   constructor(
@@ -36,31 +39,37 @@ export class DevServer {
     private readonly _options: DevServerOptions,
   ) {}
 
-  get port() {
-    return this._port;
+  get endpoint() {
+    invariant(this._port);
+    return `http://localhost:${this._port}`;
   }
 
-  get endpoint() {
-    return this._port ? `http://localhost:${this._port}` : undefined;
+  get proxy() {
+    return this._proxy;
   }
 
   get functions() {
-    return Object.keys(this._handlers);
+    return Object.values(this._handlers);
   }
 
   async initialize() {
-    for (const { id } of this._options.manifest.functions) {
+    for (const def of this._options.manifest.functions) {
+      const { id, path, handler: dir } = def;
       try {
         // eslint-disable-next-line @typescript-eslint/no-var-requires
-        const module = require(join(this._options.directory, id));
+        const module = require(join(this._options.directory, dir));
         const handler = module.default;
         if (typeof handler !== 'function') {
           throw new Error(`Handler must export default function: ${id}`);
         }
 
-        this._handlers[id] = handler;
+        if (this._handlers[path]) {
+          log.warn(`Function already registered: ${id}`);
+        }
+
+        this._handlers[path] = { def, handler };
       } catch (err) {
-        log.error('parsing function (check functions.yml manifest)', err);
+        log.error('parsing function (check manifest)', err);
       }
     }
   }
@@ -69,30 +78,32 @@ export class DevServer {
     const app = express();
     app.use(express.json());
 
-    app.post('/:functionName', async (req, res) => {
-      const functionName = req.params.functionName;
-      log('invoke', { function: functionName, data: req.body });
+    app.post('/:name', async (req, res) => {
+      const { name } = req.params;
 
-      const builder: Response = {
+      const response: Response = {
         status: (code: number) => {
           res.statusCode = code;
-          return builder;
+          return response;
         },
+
         succeed: (result = {}) => {
           res.end(JSON.stringify(result));
-          return builder;
+          return response;
         },
       };
 
       const context: FunctionContext = {
         client: this._client,
-        status: builder.status.bind(builder),
+        status: response.status.bind(response),
       };
 
       void (async () => {
         try {
-          // TODO(burdon): Typed event handler.
-          await this._handlers[functionName]({ event: req.body, context });
+          log(`invoking: ${name}`);
+          const { handler } = this._handlers[name];
+          const response = await handler({ context, event: req.body });
+          log('done', { response });
         } catch (err: any) {
           res.statusCode = 500;
           res.end(err.message);
@@ -100,20 +111,24 @@ export class DevServer {
       })();
     });
 
-    this._port = await getPortPromise({ startPort: DEFAULT_PORT });
+    // TODO(burdon): Push down port management to agent.
+    this._port = await getPort({ port: 7200, portRange: [7200, 7299] });
     this._server = app.listen(this._port);
 
-    // TODO(burdon): Check plugin is registered.
-    //  TypeError: Cannot read properties of undefined (reading 'register')
+    // TODO(burdon): Test during initialization.
     try {
-      const { registrationId } = await this._client.services.services.FunctionRegistryService!.register({
-        endpoint: this.endpoint!,
-        functions: this.functions.map((name) => ({ name })),
+      // Register functions.
+      const { registrationId, endpoint } = await this._client.services.services.FunctionRegistryService!.register({
+        endpoint: this.endpoint,
+        functions: this.functions.map(({ def: { path } }) => ({ name: path })),
       });
+
+      log.info('registered', { registrationId, endpoint });
       this._registrationId = registrationId;
+      this._proxy = endpoint;
     } catch (err: any) {
       await this.stop();
-      throw new Error('FunctionRegistryService not available; check config (agent.plugins.functions).');
+      throw new Error('FunctionRegistryService not available (check plugin is configured).');
     }
   }
 
@@ -124,14 +139,17 @@ export class DevServer {
         await this._client.services.services.FunctionRegistryService!.unregister({
           registrationId: this._registrationId,
         });
+
+        log.info('unregistered', { registrationId: this._registrationId });
         this._registrationId = undefined;
+        this._proxy = undefined;
       }
 
       trigger.wake();
     });
 
     await trigger.wait();
-    this._server = undefined;
     this._port = undefined;
+    this._server = undefined;
   }
 }

package/src/runtime/trigger-manager.ts

@@ -11,12 +11,11 @@ import { invariant } from '@dxos/invariant';
 import { log } from '@dxos/log';
 import { ComplexMap } from '@dxos/util';
 
-import { type FunctionTrigger } from '../function';
+import { type FunctionManifest, type FunctionTrigger } from '../manifest';
 
 // TODO(burdon): Rename.
 export type InvokeOptions = {
   endpoint: string;
-  runtime: string;
 };
 
 export class TriggerManager {
@@ -29,7 +28,7 @@ export class TriggerManager {
 
   constructor(
     private readonly _client: Client,
-    private readonly _triggers: FunctionTrigger[],
+    private readonly _manifest: FunctionManifest,
     private readonly _invokeOptions: InvokeOptions,
   ) {}
 
@@ -38,7 +37,7 @@ export class TriggerManager {
     this._client.spaces.subscribe(async (spaces) => {
       for (const space of spaces) {
         await space.waitUntilReady();
-        for (const trigger of this._triggers) {
+        for (const trigger of this._manifest.triggers ?? []) {
           // TODO(burdon): New context? Shared?
           await this.mount(new Context(), space, trigger);
         }
@@ -54,6 +53,8 @@ export class TriggerManager {
 
   private async mount(ctx: Context, space: Space, trigger: FunctionTrigger) {
     const key = { name: trigger.function, spaceKey: space.key };
+    const config = this._manifest.functions.find((config) => config.id === trigger.function);
+    invariant(config, `Function not found: ${trigger.function}`);
     const exists = this._mounts.get(key);
     if (!exists) {
       this._mounts.set(key, { ctx, trigger });
@@ -62,11 +63,10 @@ export class TriggerManager {
         return;
       }
 
-      // TODO(burdon): Trigger binding.
       // TODO(burdon): Why DeferredTask? How to pass objectIds to function?
       const objectIds = new Set<string>();
       const task = new DeferredTask(ctx, async () => {
-        await this.invokeFunction(this._invokeOptions, trigger.function, {
+        await this.execFunction(this._invokeOptions, config.path, {
           space: space.key,
           objects: Array.from(objectIds),
         });
@@ -115,14 +115,13 @@ export class TriggerManager {
     }
   }
 
-  private async invokeFunction(options: InvokeOptions, functionName: string, data: any) {
-    const { endpoint, runtime } = options;
+  private async execFunction(options: InvokeOptions, functionName: string, data: any) {
+    const { endpoint } = options;
     invariant(endpoint, 'Missing endpoint');
-    invariant(runtime, 'Missing runtime');
 
     try {
       log('invoke', { function: functionName });
-      const url = `${endpoint}/${runtime}/${functionName}`;
+      const url = `${endpoint}/${functionName}`;
       const res = await fetch(url, {
         method: 'POST',
         body: JSON.stringify(data),

package/dist/types/src/function.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"function.d.ts","sourceRoot":"","sources":["../../../src/function.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,cAAc,CAAC;AAE3C,MAAM,WAAW,QAAQ;IACvB,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,QAAQ,CAAC;IAC/B,OAAO,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,QAAQ,CAAC;CAClC;AAED,MAAM,WAAW,eAAe;IAC9B,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,QAAQ,CAAC;CAChC;AAMD,MAAM,MAAM,yBAAyB,GAAG;IACtC,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,EAAE,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,eAAe,CAAC,CAAC,SAAS,EAAE,IAAI,CAAC,MAAM,EAAE;IACnD,KAAK,EAAE,CAAC,CAAC;IACT,OAAO,EAAE,eAAe,CAAC;CAC1B,KAAK,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC,CAAC;AAE/B,MAAM,MAAM,iBAAiB,GAAG;IAC9B,SAAS,EAAE,cAAc,EAAE,CAAC;IAC5B,QAAQ,EAAE,eAAe,EAAE,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,mBAAmB,CAAC;CACnC,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC5B,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB,CAAC"}

package/src/function.ts

@@ -1,51 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import { type Client } from '@dxos/client';
-
-export interface Response {
-  status(code: number): Response;
-  succeed(data?: object): Response;
-}
-
-export interface FunctionContext {
-  client: Client;
-  status(code: number): Response;
-}
-
-// https://www.npmjs.com/package/aws-lambda
-// https://docs.aws.amazon.com/lambda/latest/dg/typescript-handler.html
-
-// TODO(burdon): Types.
-export type FunctionSubscriptionEvent = {
-  space: string;
-  objects: string[];
-};
-
-export type FunctionHandler<T extends {}> = (params: {
-  event: T;
-  context: FunctionContext;
-}) => Promise<Response | void>;
-
-export type FunctionsManifest = {
-  functions: FunctionConfig[];
-  triggers: FunctionTrigger[];
-};
-
-export type FunctionConfig = {
-  id: string;
-  description?: string;
-};
-
-export type FunctionTrigger = {
-  function: string;
-  subscription: TriggerSubscription;
-};
-
-export type TriggerSubscription = {
-  type: string;
-  spaceKey: string;
-  props?: Record<string, any>;
-  nested?: string[];
-};