@dxos/functions 0.5.3-main.6e12b97 → 0.5.3-main.6f2dfea

package/src/handler.ts

@@ -8,61 +8,38 @@ import { type EchoReactiveObject } from '@dxos/echo-schema';
 import { log } from '@dxos/log';
 import { nonNullable } from '@dxos/util';
 
-// TODO(burdon): Model after http request. Ref Lambda/OpenFaaS.
-// https://docs.aws.amazon.com/lambda/latest/dg/typescript-handler.html
+// Lambda-like function definitions.
 // https://www.serverless.com/framework/docs/providers/aws/guide/serverless.yml/#functions
 // https://www.npmjs.com/package/aws-lambda
+// https://docs.aws.amazon.com/lambda/latest/dg/typescript-handler.html
 
-/**
- * Function handler.
- */
-export type FunctionHandler<TData = {}, TMeta = {}> = (params: {
-  context: FunctionContext;
-  event: FunctionEvent<TData, TMeta>;
-  response: FunctionResponse;
-}) => Promise<FunctionResponse | void>;
+// TODO(burdon): No response?
+export interface Response {
+  status(code: number): Response;
+}
 
-/**
- * Function context.
- */
 export interface FunctionContext {
   // TODO(burdon): Limit access to individual space.
   client: Client;
   // TODO(burdon): Replace with storage service abstraction.
   dataDir?: string;
+  // Data passed to function invocation.
+  data?: any;
 }
 
-/**
- * Event payload.
- */
-export type FunctionEvent<TData = {}, TMeta = {}> = {
-  data: FunctionEventMeta<TMeta> & TData;
-};
-
-/**
- * Metadata from trigger.
- */
-export type FunctionEventMeta<TMeta = {}> = {
-  meta: TMeta;
-};
-
-/**
- * Function response.
- */
-export interface FunctionResponse {
-  status(code: number): FunctionResponse;
-}
-
-//
-// Subscription utils.
-//
+// TODO(burdon): Model after http request. Ref Lambda/OpenFaaS.
+export type FunctionHandler<T extends {}> = (params: {
+  event: T;
+  context: FunctionContext;
+  response: Response;
+}) => Promise<Response | void>;
 
-export type RawSubscriptionData = {
+export type RawSubscriptionEvent = {
   spaceKey?: string;
   objects?: string[];
 };
 
-export type SubscriptionData = {
+export type SubscriptionEvent = {
   space?: Space;
   objects?: EchoReactiveObject<any>[];
 };
@@ -77,22 +54,22 @@ export type SubscriptionData = {
  *
  * NOTE: Get space key from devtools or `dx space list --json`
  */
-export const subscriptionHandler = <TMeta>(
-  handler: FunctionHandler<SubscriptionData, TMeta>,
-): FunctionHandler<RawSubscriptionData, TMeta> => {
-  return ({ event: { data }, context, ...rest }) => {
+export const subscriptionHandler = (
+  handler: FunctionHandler<SubscriptionEvent>,
+): FunctionHandler<RawSubscriptionEvent> => {
+  return ({ event, context, ...rest }) => {
     const { client } = context;
-    const space = data.spaceKey ? client.spaces.get(PublicKey.from(data.spaceKey)) : undefined;
-    const objects = space
-      ? data.objects?.map<EchoReactiveObject<any> | undefined>((id) => space!.db.getObjectById(id)).filter(nonNullable)
-      : [];
+    const space = event.spaceKey ? client.spaces.get(PublicKey.from(event.spaceKey)) : undefined;
+    const objects =
+      space &&
+      event.objects?.map<EchoReactiveObject<any> | undefined>((id) => space!.db.getObjectById(id)).filter(nonNullable);
 
-    if (!!data.spaceKey && !space) {
-      log.warn('invalid space', { data });
+    if (!!event.spaceKey && !space) {
+      log.warn('invalid space', { event });
     } else {
       log.info('handler', { space: space?.key.truncate(), objects: objects?.length });
     }
 
-    return handler({ event: { data: { ...data, space, objects } }, context, ...rest });
+    return handler({ event: { space, objects }, context, ...rest });
   };
 };

package/src/index.ts

@@ -3,7 +3,5 @@
 //
 
 export * from './handler';
-export * from './registry';
 export * from './runtime';
-export * from './trigger';
 export * from './types';

package/src/runtime/dev-server.test.ts

@@ -5,14 +5,12 @@
 import { expect } from 'chai';
 import path from 'path';
 
-import { waitForCondition } from '@dxos/async';
-import { type Client } from '@dxos/client';
+import { FunctionsPlugin } from '@dxos/agent';
+import { Client, Config } from '@dxos/client';
 import { TestBuilder } from '@dxos/client/testing';
-import { describe, test } from '@dxos/test';
+import { describe, openAndClose, test } from '@dxos/test';
 
 import { DevServer } from './dev-server';
-import { FunctionRegistry } from '../registry';
-import { createFunctionRuntime } from '../testing';
 import { type FunctionManifest } from '../types';
 
 describe('dev server', () => {
@@ -20,10 +18,35 @@ describe('dev server', () => {
   let testBuilder: TestBuilder;
   before(async () => {
     testBuilder = new TestBuilder();
-    client = await createFunctionRuntime(testBuilder);
+    const config = new Config({
+      runtime: {
+        agent: {
+          plugins: [
+            {
+              id: 'dxos.org/agent/plugin/functions',
+              config: {
+                port: 8080,
+              },
+            },
+          ],
+        },
+      },
+    });
+
+    const services = testBuilder.createLocalClientServices();
+    client = new Client({ config, services });
+
+    await client.initialize();
+    await client.halo.createIdentity();
+    testBuilder.ctx.onDispose(() => client.destroy());
+
+    // TODO(burdon): Better way to configure plugin? (Rationalize chess.test).
+    const functionsPlugin = new FunctionsPlugin();
+    await functionsPlugin.initialize({ client, clientServices: services });
+    await openAndClose(functionsPlugin);
+
     expect(client.services.services.FunctionRegistryService).to.exist;
   });
-
   after(async () => {
     await testBuilder.destroy();
   });
@@ -32,19 +55,18 @@ describe('dev server', () => {
     const manifest: FunctionManifest = {
       functions: [
         {
-          uri: 'example.com/function/test',
-          route: 'test',
+          id: 'example.com/function/test',
+          path: 'test',
           handler: 'test',
         },
       ],
     };
 
-    const registry = new FunctionRegistry(client);
-    const server = new DevServer(client, registry, {
+    const server = new DevServer(client, {
+      manifest,
       baseDir: path.join(__dirname, '../testing'),
     });
-    const space = await client.spaces.create();
-    await registry.register(space, manifest);
+    await server.initialize();
     await server.start();
 
     // TODO(burdon): Doesn't shut down cleanly.
@@ -52,8 +74,6 @@ describe('dev server', () => {
     testBuilder.ctx.onDispose(() => server.stop());
     expect(server).to.exist;
 
-    await waitForCondition({ condition: () => server.functions.length > 0 });
-
     await server.invoke('test', {});
     expect(server.stats.seq).to.eq(1);
   });

package/src/runtime/dev-server.ts

@@ -9,15 +9,14 @@ import { join } from 'node:path';
 
 import { Event, Trigger } from '@dxos/async';
 import { type Client } from '@dxos/client';
-import { Context } from '@dxos/context';
 import { invariant } from '@dxos/invariant';
 import { log } from '@dxos/log';
 
-import { type FunctionContext, type FunctionEvent, type FunctionHandler, type FunctionResponse } from '../handler';
-import { type FunctionRegistry } from '../registry';
-import { type FunctionDef } from '../types';
+import { type FunctionContext, type FunctionHandler, type Response } from '../handler';
+import { type FunctionDef, type FunctionManifest } from '../types';
 
 export type DevServerOptions = {
+  manifest: FunctionManifest;
   baseDir: string;
   port?: number;
   reload?: boolean;
@@ -28,8 +27,6 @@ export type DevServerOptions = {
  * Functions dev server provides a local HTTP server for testing functions.
  */
 export class DevServer {
-  private _ctx = createContext();
-
   // Function handlers indexed by name (URL path).
   private readonly _handlers: Record<string, { def: FunctionDef; handler: FunctionHandler<any> }> = {};
 
@@ -44,15 +41,8 @@ export class DevServer {
   // prettier-ignore
   constructor(
     private readonly _client: Client,
-    private readonly _functionsRegistry: FunctionRegistry,
     private readonly _options: DevServerOptions,
-  ) {
-    this._functionsRegistry.onFunctionsRegistered.on(async ({ newFunctions }) => {
-      newFunctions.forEach((def) => this._load(def));
-      await this._safeUpdateRegistration();
-      log('new functions loaded', { newFunctions });
-    });
-  }
+  ) {}
 
   get stats() {
     return {
@@ -73,10 +63,19 @@ export class DevServer {
     return Object.values(this._handlers);
   }
 
+  async initialize() {
+    for (const def of this._options.manifest.functions) {
+      try {
+        await this._load(def);
+      } catch (err) {
+        log.error('parsing function (check manifest)', err);
+      }
+    }
+  }
+
   async start() {
     invariant(!this._server);
     log.info('starting...');
-    this._ctx = createContext();
 
     // TODO(burdon): Move to hono.
     const app = express();
@@ -108,14 +107,12 @@ export class DevServer {
       // Register functions.
       const { registrationId, endpoint } = await this._client.services.services.FunctionRegistryService!.register({
         endpoint: this.endpoint,
+        functions: this.functions.map(({ def: { id, path } }) => ({ id, path })),
       });
 
       log.info('registered', { endpoint });
       this._proxy = endpoint;
       this._functionServiceRegistration = registrationId;
-
-      // Open after registration, so that it can be updated with the list of function definitions.
-      await this._functionsRegistry.open(this._ctx);
     } catch (err: any) {
       await this.stop();
       throw new Error('FunctionRegistryService not available (check plugin is configured).');
@@ -159,9 +156,9 @@ export class DevServer {
    * Load function.
    */
   private async _load(def: FunctionDef, force = false) {
-    const { uri, route, handler } = def;
+    const { id, path, handler } = def;
     const filePath = join(this._options.baseDir, handler);
-    log.info('loading', { uri, force });
+    log.info('loading', { id, force });
 
     // Remove from cache.
     if (force) {
@@ -172,26 +169,13 @@ export class DevServer {
         });
     }
 
-    // TODO(burdon): Import types.
     // eslint-disable-next-line @typescript-eslint/no-var-requires
     const module = require(filePath);
     if (typeof module.default !== 'function') {
-      throw new Error(`Handler must export default function: ${uri}`);
+      throw new Error(`Handler must export default function: ${id}`);
     }
 
-    this._handlers[route] = { def, handler: module.default };
-  }
-
-  private async _safeUpdateRegistration(): Promise<void> {
-    invariant(this._functionServiceRegistration);
-    try {
-      await this._client.services.services.FunctionRegistryService!.updateRegistration({
-        registrationId: this._functionServiceRegistration,
-        functions: this.functions.map(({ def: { id, route } }) => ({ id, route })),
-      });
-    } catch (e) {
-      log.catch(e);
-    }
+    this._handlers[path] = { def, handler: module.default };
   }
 
   /**
@@ -202,14 +186,14 @@ export class DevServer {
     const now = Date.now();
 
     log.info('req', { seq, path });
-    const statusCode = await this._invoke(path, { data });
+    const statusCode = await this._invoke(path, data);
 
     log.info('res', { seq, path, statusCode, duration: Date.now() - now });
     this.update.emit(statusCode);
     return statusCode;
   }
 
-  private async _invoke(path: string, event: FunctionEvent) {
+  private async _invoke(path: string, event: any) {
     const { handler } = this._handlers[path] ?? {};
     invariant(handler, `invalid path: ${path}`);
 
@@ -219,7 +203,7 @@ export class DevServer {
     };
 
     let statusCode = 200;
-    const response: FunctionResponse = {
+    const response: Response = {
       status: (code: number) => {
         statusCode = code;
         return response;
@@ -230,5 +214,3 @@ export class DevServer {
     return statusCode;
   }
 }
-
-const createContext = () => new Context({ name: 'DevServer' });

package/src/runtime/scheduler.test.ts

@@ -6,43 +6,40 @@ import { expect } from 'chai';
 import WebSocket from 'ws';
 
 import { Trigger } from '@dxos/async';
-import { type Client } from '@dxos/client';
+import { Client } from '@dxos/client';
 import { TestBuilder } from '@dxos/client/testing';
-import { create } from '@dxos/echo-schema';
+import { create, S, TypedObject } from '@dxos/echo-schema';
 import { describe, test } from '@dxos/test';
 
-import { Scheduler, type SchedulerOptions } from './scheduler';
-import { FunctionRegistry } from '../registry';
-import { createInitializedClients, TestType, triggerWebhook } from '../testing';
-import { TriggerRegistry } from '../trigger';
-import { type FunctionManifest } from '../types';
+import { Scheduler } from './scheduler';
+import { type FunctionManifest, type WebhookTrigger } from '../types';
 
 // TODO(burdon): Test we can add and remove triggers.
 describe('scheduler', () => {
-  let testBuilder: TestBuilder;
   let client: Client;
   before(async () => {
-    testBuilder = new TestBuilder();
-    client = (await createInitializedClients(testBuilder, 1))[0];
+    const testBuilder = new TestBuilder();
+    client = new Client({ services: testBuilder.createLocalClientServices() });
+    await client.initialize();
+    await client.halo.createIdentity();
   });
   after(async () => {
-    await testBuilder.destroy();
+    await client.destroy();
   });
 
   test('timer', async () => {
     const manifest: FunctionManifest = {
       functions: [
         {
-          uri: 'example.com/function/test',
-          route: '/test',
+          id: 'example.com/function/test',
+          path: '/test',
           handler: 'test',
         },
       ],
       triggers: [
         {
           function: 'example.com/function/test',
-          spec: {
-            type: 'timer',
+          timer: {
             cron: '0/1 * * * * *', // Every 1s.
           },
         },
@@ -51,13 +48,18 @@ describe('scheduler', () => {
 
     let count = 0;
     const done = new Trigger();
-    const scheduler = createScheduler(async () => {
-      if (++count === 3) {
-        done.wake();
-      }
+    const scheduler = new Scheduler(client, manifest, {
+      callback: async () => {
+        if (++count === 3) {
+          done.wake();
+        }
+      },
     });
-    await scheduler.register(client.spaces.default, manifest);
+
     await scheduler.start();
+    after(async () => {
+      await scheduler.stop();
+    });
 
     await done.wait({ timeout: 5_000 });
     expect(count).to.equal(3);
@@ -67,16 +69,15 @@ describe('scheduler', () => {
     const manifest: FunctionManifest = {
       functions: [
         {
-          uri: 'example.com/function/test',
-          route: '/test',
+          id: 'example.com/function/test',
+          path: '/test',
           handler: 'test',
         },
       ],
       triggers: [
         {
           function: 'example.com/function/test',
-          spec: {
-            type: 'webhook',
+          webhook: {
             method: 'GET',
           },
         },
@@ -84,14 +85,23 @@ describe('scheduler', () => {
     };
 
     const done = new Trigger();
-    const scheduler = createScheduler(async () => {
-      done.wake();
+    const scheduler = new Scheduler(client, manifest, {
+      callback: async () => {
+        done.wake();
+      },
     });
-    const space = await client.spaces.create();
-    await scheduler.register(space, manifest);
+
     await scheduler.start();
+    after(async () => {
+      await scheduler.stop();
+    });
 
-    setTimeout(async () => triggerWebhook(space, manifest.functions![0].uri));
+    setTimeout(() => {
+      const mount: WebhookTrigger = scheduler.mounts.find(
+        (mount) => mount.function === 'example.com/function/test',
+      )!.webhook!;
+      void fetch(`http://localhost:${mount.port}`);
+    });
 
     await done.wait();
   });
@@ -100,16 +110,15 @@ describe('scheduler', () => {
     const manifest: FunctionManifest = {
       functions: [
         {
-          uri: 'example.com/function/test',
-          route: '/test',
+          id: 'example.com/function/test',
+          path: '/test',
           handler: 'test',
         },
       ],
       triggers: [
         {
           function: 'example.com/function/test',
-          spec: {
-            type: 'websocket',
+          websocket: {
             // url: 'https://hub.dxos.network/api/mailbox/test',
             url: 'http://localhost:8081',
             init: {
@@ -121,11 +130,16 @@ describe('scheduler', () => {
     };
 
     const done = new Trigger();
-    const scheduler = createScheduler(async () => {
-      done.wake();
+    const scheduler = new Scheduler(client, manifest, {
+      callback: async (data) => {
+        done.wake();
+      },
     });
-    await scheduler.register(client.spaces.default, manifest);
+
     await scheduler.start();
+    after(async () => {
+      await scheduler.stop();
+    });
 
     // Test server.
     setTimeout(() => {
@@ -143,20 +157,29 @@ describe('scheduler', () => {
   });
 
   test('subscription', async () => {
+    class TestType extends TypedObject({ typename: 'example.com/type/Test', version: '0.1.0' })({
+      title: S.string,
+    }) {}
+    client.addSchema(TestType);
+
     const manifest: FunctionManifest = {
       functions: [
         {
-          uri: 'example.com/function/test',
-          route: '/test',
+          id: 'example.com/function/test',
+          path: '/test',
           handler: 'test',
         },
       ],
       triggers: [
         {
           function: 'example.com/function/test',
-          spec: {
-            type: 'subscription',
-            filter: [{ type: TestType.typename }],
+          subscription: {
+            spaceKey: client.spaces.default.key.toHex(),
+            filter: [
+              {
+                type: TestType.typename,
+              },
+            ],
           },
         },
       ],
@@ -164,14 +187,20 @@ describe('scheduler', () => {
 
     let count = 0;
     const done = new Trigger();
-    const scheduler = createScheduler(async () => {
-      if (++count === 2) {
-        done.wake();
-      }
+    const scheduler = new Scheduler(client, manifest, {
+      callback: async () => {
+        if (++count === 2) {
+          done.wake();
+        }
+      },
     });
-    await scheduler.register(client.spaces.default, manifest);
+
     await scheduler.start();
+    after(async () => {
+      await scheduler.stop();
+    });
 
+    // TODO(burdon): Query for Expando?
     setTimeout(() => {
       const space = client.spaces.default;
       const object = create(TestType, { title: 'Hello world!' });
@@ -180,12 +209,4 @@ describe('scheduler', () => {
 
     await done.wait();
   });
-
-  const createScheduler = (callback: SchedulerOptions['callback']) => {
-    const scheduler = new Scheduler(new FunctionRegistry(client), new TriggerRegistry(client), { callback });
-    after(async () => {
-      await scheduler.stop();
-    });
-    return scheduler;
-  };
 });