@dxos/functions 0.5.3-main.e76d664 → 0.5.3-main.eb56347

package/src/runtime/scheduler.test.ts

@@ -6,40 +6,43 @@ import { expect } from 'chai';
 import WebSocket from 'ws';
 
 import { Trigger } from '@dxos/async';
-import { Client } from '@dxos/client';
+import { type Client } from '@dxos/client';
 import { TestBuilder } from '@dxos/client/testing';
-import { create, S, TypedObject } from '@dxos/echo-schema';
+import { create } from '@dxos/echo-schema';
 import { describe, test } from '@dxos/test';
 
-import { Scheduler } from './scheduler';
+import { Scheduler, type SchedulerOptions } from './scheduler';
+import { FunctionRegistry } from '../function';
+import { createInitializedClients, TestType, triggerWebhook } from '../testing';
+import { TriggerRegistry } from '../trigger';
 import { type FunctionManifest } from '../types';
 
 // TODO(burdon): Test we can add and remove triggers.
 describe('scheduler', () => {
+  let testBuilder: TestBuilder;
   let client: Client;
   before(async () => {
-    const testBuilder = new TestBuilder();
-    client = new Client({ services: testBuilder.createLocal() });
-    await client.initialize();
-    await client.halo.createIdentity();
+    testBuilder = new TestBuilder();
+    client = (await createInitializedClients(testBuilder, 1))[0];
   });
   after(async () => {
-    await client.destroy();
+    await testBuilder.destroy();
   });
 
   test('timer', async () => {
     const manifest: FunctionManifest = {
       functions: [
         {
-          id: 'example.com/function/test',
-          name: 'test',
+          uri: 'example.com/function/test',
+          route: '/test',
           handler: 'test',
         },
       ],
       triggers: [
         {
           function: 'example.com/function/test',
-          timer: {
+          spec: {
+            type: 'timer',
             cron: '0/1 * * * * *', // Every 1s.
           },
         },
@@ -48,18 +51,13 @@ describe('scheduler', () => {
 
     let count = 0;
     const done = new Trigger();
-    const scheduler = new Scheduler(client, manifest, {
-      callback: async () => {
-        if (++count === 3) {
-          done.wake();
-        }
-      },
+    const scheduler = createScheduler(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);
@@ -69,52 +67,49 @@ describe('scheduler', () => {
     const manifest: FunctionManifest = {
       functions: [
         {
-          id: 'example.com/function/test',
-          name: 'test',
+          uri: 'example.com/function/test',
+          route: '/test',
           handler: 'test',
         },
       ],
       triggers: [
         {
           function: 'example.com/function/test',
-          webhook: {
-            port: 8080,
+          spec: {
+            type: 'webhook',
+            method: 'GET',
           },
         },
       ],
     };
 
     const done = new Trigger();
-    const scheduler = new Scheduler(client, manifest, {
-      callback: async () => {
-        done.wake();
-      },
+    const scheduler = createScheduler(async () => {
+      done.wake();
     });
-
+    const space = await client.spaces.create();
+    await scheduler.register(space, manifest);
     await scheduler.start();
-    after(async () => {
-      await scheduler.stop();
-    });
 
-    setTimeout(() => {
-      void fetch('http://localhost:8080');
-    });
+    setTimeout(async () => triggerWebhook(space, manifest.functions![0].uri));
+
     await done.wait();
   });
 
-  test.only('websocket', async () => {
+  test('websocket', async () => {
     const manifest: FunctionManifest = {
       functions: [
         {
-          id: 'example.com/function/test',
-          name: 'test',
+          uri: 'example.com/function/test',
+          route: '/test',
           handler: 'test',
         },
       ],
       triggers: [
         {
           function: 'example.com/function/test',
-          websocket: {
+          spec: {
+            type: 'websocket',
             // url: 'https://hub.dxos.network/api/mailbox/test',
             url: 'http://localhost:8081',
             init: {
@@ -126,16 +121,11 @@ describe('scheduler', () => {
     };
 
     const done = new Trigger();
-    const scheduler = new Scheduler(client, manifest, {
-      callback: async (data) => {
-        done.wake();
-      },
+    const scheduler = createScheduler(async () => {
+      done.wake();
     });
-
+    await scheduler.register(client.spaces.default, manifest);
     await scheduler.start();
-    after(async () => {
-      await scheduler.stop();
-    });
 
     // Test server.
     setTimeout(() => {
@@ -153,29 +143,20 @@ 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: [
         {
-          id: 'example.com/function/test',
-          name: 'test',
+          uri: 'example.com/function/test',
+          route: '/test',
           handler: 'test',
         },
       ],
       triggers: [
         {
           function: 'example.com/function/test',
-          subscription: {
-            spaceKey: client.spaces.default.key.toHex(),
-            filter: [
-              {
-                type: TestType.typename,
-              },
-            ],
+          spec: {
+            type: 'subscription',
+            filter: [{ type: TestType.typename }],
           },
         },
       ],
@@ -183,20 +164,14 @@ describe('scheduler', () => {
 
     let count = 0;
     const done = new Trigger();
-    const scheduler = new Scheduler(client, manifest, {
-      callback: async () => {
-        if (++count === 2) {
-          done.wake();
-        }
-      },
+    const scheduler = createScheduler(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!' });
@@ -205,4 +180,12 @@ 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;
+  };
 });

package/src/runtime/scheduler.ts

@@ -2,31 +2,19 @@
 // Copyright 2023 DXOS.org
 //
 
-import { CronJob } from 'cron';
-import http from 'node:http';
-import WebSocket from 'ws';
+import path from 'node:path';
 
-import { TextV0Type } from '@braneframe/types';
-import { debounce, DeferredTask, sleep, Trigger } from '@dxos/async';
-import { type Client, type PublicKey } from '@dxos/client';
-import { createSubscription, Filter, getAutomergeObjectCore, type Query, type Space } from '@dxos/client/echo';
+import { Mutex } from '@dxos/async';
+import { type Space } from '@dxos/client/echo';
 import { Context } from '@dxos/context';
-import { invariant } from '@dxos/invariant';
 import { log } from '@dxos/log';
-import { ComplexMap } from '@dxos/util';
 
-import { type FunctionSubscriptionEvent } from '../handler';
-import {
-  type FunctionDef,
-  type FunctionManifest,
-  type FunctionTrigger,
-  type SubscriptionTrigger,
-  type TimerTrigger,
-  type WebhookTrigger,
-  type WebsocketTrigger,
-} from '../types';
+import { type FunctionRegistry } from '../function';
+import { type FunctionEventMeta } from '../handler';
+import { type TriggerRegistry } from '../trigger';
+import { type FunctionDef, type FunctionManifest, type FunctionTrigger } from '../types';
 
-type Callback = (data: FunctionSubscriptionEvent) => Promise<void>;
+export type Callback = (data: any) => Promise<void | number>;
 
 export type SchedulerOptions = {
   endpoint?: string;
@@ -34,290 +22,123 @@ export type SchedulerOptions = {
 };
 
 /**
- * The scheduler triggers function exectuion based on various triggers.
+ * The scheduler triggers function execution based on various triggers.
  */
 export class Scheduler {
-  // Map of mounted functions.
-  private readonly _mounts = new ComplexMap<
-    { id: string; spaceKey: PublicKey },
-    { ctx: Context; trigger: FunctionTrigger }
-  >(({ id, spaceKey }) => `${spaceKey.toHex()}:${id}`);
+  private _ctx = createContext();
+
+  private readonly _functionUriToCallMutex = new Map<string, Mutex>();
 
   constructor(
-    private readonly _client: Client,
-    private readonly _manifest: FunctionManifest,
+    public readonly functions: FunctionRegistry,
+    public readonly triggers: TriggerRegistry,
     private readonly _options: SchedulerOptions = {},
-  ) {}
+  ) {
+    this.functions.registered.on(async ({ space, added }) => {
+      await this._safeActivateTriggers(space, this.triggers.getInactiveTriggers(space), added);
+    });
+    this.triggers.registered.on(async ({ space, triggers }) => {
+      await this._safeActivateTriggers(space, triggers, this.functions.getFunctions(space));
+    });
+  }
 
   async start() {
-    this._client.spaces.subscribe(async (spaces) => {
-      for (const space of spaces) {
-        await space.waitUntilReady();
-        for (const trigger of this._manifest.triggers ?? []) {
-          await this.mount(new Context(), space, trigger);
-        }
-      }
-    });
+    await this._ctx.dispose();
+    this._ctx = createContext();
+    await this.functions.open(this._ctx);
+    await this.triggers.open(this._ctx);
   }
 
   async stop() {
-    for (const { id, spaceKey } of this._mounts.keys()) {
-      await this.unmount(id, spaceKey);
-    }
+    await this._ctx.dispose();
+    await this.functions.close();
+    await this.triggers.close();
   }
 
-  private async mount(ctx: Context, space: Space, trigger: FunctionTrigger) {
-    const key = { id: trigger.function, spaceKey: space.key };
-    const def = this._manifest.functions.find((config) => config.id === trigger.function);
-    invariant(def, `Function not found: ${trigger.function}`);
-
-    // TODO(burdon): Currently supports only one trigger declaration per function.
-    const exists = this._mounts.get(key);
-    if (!exists) {
-      this._mounts.set(key, { ctx, trigger });
-      log('mount', { space: space.key, trigger });
-      if (ctx.disposed) {
-        return;
-      }
-
-      //
-      // Triggers types.
-      //
+  // TODO(burdon): Remove and update registries directly.
+  public async register(space: Space, manifest: FunctionManifest) {
+    await this.functions.register(space, manifest.functions);
+    await this.triggers.register(space, manifest);
+  }
 
-      if (trigger.timer) {
-        await this._createTimer(ctx, space, def, trigger.timer);
-      }
+  private async _safeActivateTriggers(
+    space: Space,
+    triggers: FunctionTrigger[],
+    functions: FunctionDef[],
+  ): Promise<void> {
+    const mountTasks = triggers.map((trigger) => {
+      return this.activate(space, functions, trigger);
+    });
+    await Promise.all(mountTasks).catch(log.catch);
+  }
 
-      if (trigger.webhook) {
-        await this._createWebhook(ctx, space, def, trigger.webhook);
-      }
+  private async activate(space: Space, functions: FunctionDef[], fnTrigger: FunctionTrigger) {
+    const definition = functions.find((def) => def.uri === fnTrigger.function);
+    if (!definition) {
+      log.info('function is not found for trigger', { fnTrigger });
+      return;
+    }
 
-      if (trigger.websocket) {
-        await this._createWebsocket(ctx, space, def, trigger.websocket);
-      }
+    await this.triggers.activate({ space }, fnTrigger, async (args) => {
+      const mutex = this._functionUriToCallMutex.get(definition.uri) ?? new Mutex();
+      this._functionUriToCallMutex.set(definition.uri, mutex);
 
-      if (trigger.subscription) {
-        await this._createSubscription(ctx, space, def, trigger.subscription);
-      }
-    }
-  }
+      log.info('function triggered, waiting for mutex', { uri: definition.uri });
+      return mutex.executeSynchronized(() => {
+        log.info('mutex acquired', { uri: definition.uri });
+        return this._execFunction(definition, fnTrigger, {
+          meta: fnTrigger.meta,
+          data: { ...args, spaceKey: space.key },
+        });
+      });
+    });
 
-  private async unmount(id: string, spaceKey: PublicKey) {
-    const key = { id, spaceKey };
-    const { ctx } = this._mounts.get(key) ?? {};
-    if (ctx) {
-      this._mounts.delete(key);
-      await ctx.dispose();
-    }
+    log('activated trigger', { space: space.key, trigger: fnTrigger });
   }
 
-  // TODO(burdon): Pass in Space key (common context).
-  private async _execFunction(def: FunctionDef, data: any) {
+  private async _execFunction<TData, TMeta>(
+    def: FunctionDef,
+    trigger: FunctionTrigger,
+    { data, meta }: { data: TData; meta?: TMeta },
+  ): Promise<number> {
+    let status = 0;
     try {
-      log.info('exec', { function: def.id });
+      // TODO(burdon): Pass in Space key (common context)?
+      const payload = Object.assign({}, meta && ({ meta } satisfies FunctionEventMeta<TMeta>), data);
+
       const { endpoint, callback } = this._options;
       if (endpoint) {
         // TODO(burdon): Move out of scheduler (generalize as callback).
-        await fetch(`${this._options.endpoint}/${def.name}`, {
+        const url = path.join(endpoint, def.route);
+        log.info('exec', { function: def.uri, url, triggerType: trigger.spec.type });
+        const response = await fetch(url, {
           method: 'POST',
           headers: {
             'Content-Type': 'application/json',
           },
-          body: JSON.stringify(data),
+          body: JSON.stringify(payload),
         });
+
+        status = response.status;
       } else if (callback) {
-        await callback(data);
+        log.info('exec', { function: def.uri });
+        status = (await callback(payload)) ?? 200;
+      }
+
+      // Check errors.
+      if (status && status >= 400) {
+        throw new Error(`Response: ${status}`);
       }
 
       // const result = await response.json();
-      log.info('done', { function: def.id });
+      log.info('done', { function: def.uri, status });
     } catch (err: any) {
-      log.error('error', { function: def.id, error: err.message });
+      log.error('error', { function: def.uri, error: err.message });
+      status = 500;
     }
-  }
-
-  //
-  // Triggers
-  //
-
-  /**
-   * Cron timer.
-   */
-  private async _createTimer(ctx: Context, space: Space, def: FunctionDef, trigger: TimerTrigger) {
-    log.info('timer', { space: space.key, trigger });
-    const { cron } = trigger;
-
-    const task = new DeferredTask(ctx, async () => {
-      await this._execFunction(def, { space: space.key });
-    });
 
-    let last = 0;
-    let run = 0;
-    // https://www.npmjs.com/package/cron#constructor
-    const job = CronJob.from({
-      cronTime: cron,
-      runOnInit: false,
-      onTick: () => {
-        // TODO(burdon): Check greater than 30s (use cron-parser).
-        const now = Date.now();
-        const delta = last ? now - last : 0;
-        last = now;
-
-        run++;
-        log.info('tick', { space: space.key.truncate(), count: run, delta });
-        task.schedule();
-      },
-    });
-
-    job.start();
-    ctx.onDispose(() => job.stop());
-  }
-
-  /**
-   * Webhook.
-   */
-  private async _createWebhook(ctx: Context, space: Space, def: FunctionDef, trigger: WebhookTrigger) {
-    log.info('webhook', { space: space.key, trigger });
-    const { port } = trigger;
-
-    // TODO(burdon): POST JSON.
-    const server = http.createServer(async (req, res) => {
-      await this._execFunction(def, { space: space.key });
-    });
-
-    server.listen(port, () => {
-      log.info('started webhook', { port });
-    });
-
-    ctx.onDispose(() => {
-      server.close();
-    });
-  }
-
-  /**
-   * Websocket.
-   */
-  private async _createWebsocket(
-    ctx: Context,
-    space: Space,
-    def: FunctionDef,
-    trigger: WebsocketTrigger,
-    options: {
-      retryDelay: number;
-      maxAttempts: number;
-    } = {
-      retryDelay: 2,
-      maxAttempts: 5,
-    },
-  ) {
-    log.info('websocket', { space: space.key, trigger });
-    const { url } = trigger;
-
-    let ws: WebSocket;
-    for (let attempt = 1; attempt <= options.maxAttempts; attempt++) {
-      const open = new Trigger<boolean>();
-
-      ws = new WebSocket(url);
-      Object.assign(ws, {
-        onopen: () => {
-          log.info('opened', { url });
-          if (trigger.init) {
-            ws.send(new TextEncoder().encode(JSON.stringify(trigger.init)));
-          }
-
-          open.wake(true);
-        },
-
-        onclose: () => {
-          log.info('closed', { url });
-          open.wake(false);
-        },
-
-        onerror: (event) => {
-          log.catch(event.error, { url });
-        },
-
-        onmessage: async (event) => {
-          try {
-            const data = JSON.parse(new TextDecoder().decode(event.data as Uint8Array));
-            await this._execFunction(def, { space: space.key, data });
-          } catch (err) {
-            log.catch(err, { url });
-          }
-        },
-      } satisfies Partial<WebSocket>);
-
-      const isOpen = await open.wait();
-      if (isOpen) {
-        break;
-      } else {
-        const wait = Math.pow(attempt, 2) * options.retryDelay;
-        if (attempt < options.maxAttempts) {
-          log.warn(`failed to connect; trying again in ${wait}s`, { attempt });
-          await sleep(wait * 1_000);
-        }
-      }
-    }
-
-    ctx.onDispose(() => {
-      ws?.close();
-    });
-  }
-
-  /**
-   * ECHO subscription.
-   */
-  private async _createSubscription(ctx: Context, space: Space, def: FunctionDef, trigger: SubscriptionTrigger) {
-    log.info('subscription', { space: space.key, trigger });
-    const objectIds = new Set<string>();
-    const task = new DeferredTask(ctx, async () => {
-      await this._execFunction(def, { space: space.key, objects: Array.from(objectIds) });
-    });
-
-    // TODO(burdon): Don't fire initially.
-    // TODO(burdon): Subscription is called THREE times.
-    const subscriptions: (() => void)[] = [];
-    const subscription = createSubscription(({ added, updated }) => {
-      log.info('updated', { added: added.length, updated: updated.length });
-      for (const object of added) {
-        objectIds.add(object.id);
-      }
-      for (const object of updated) {
-        objectIds.add(object.id);
-      }
-
-      task.schedule();
-    });
-    subscriptions.push(() => subscription.unsubscribe());
-
-    // TODO(burdon): Create queue. Only allow one invocation per trigger at a time?
-    // TODO(burdon): Disable trigger if keeps failing.
-    const { filter, options: { deep, delay } = {} } = trigger;
-    const update = ({ objects }: Query) => {
-      subscription.update(objects);
-
-      // TODO(burdon): Hack to monitor changes to Document's text object.
-      if (deep) {
-        log.info('update', { objects: objects.length });
-        for (const object of objects) {
-          const content = object.content;
-          if (content instanceof TextV0Type) {
-            subscriptions.push(
-              getAutomergeObjectCore(content).updates.on(debounce(() => subscription.update([object]), 1_000)),
-            );
-          }
-        }
-      }
-    };
-
-    // TODO(burdon): Is Filter.or implemented?
-    // TODO(burdon): [Bug]: all callbacks are fired on the first mutation.
-    // TODO(burdon): [Bug]: not updated when document is deleted (either top or hierarchically).
-    const query = space.db.query(Filter.or(filter.map(({ type, props }) => Filter.typename(type, props))));
-    subscriptions.push(query.subscribe(delay ? debounce(update, delay) : update));
-
-    ctx.onDispose(() => {
-      subscriptions.forEach((unsubscribe) => unsubscribe());
-    });
+    return status;
   }
 }
+
+const createContext = () => new Context({ name: 'FunctionScheduler' });