@dxos/functions 0.8.1 → 0.8.2-main.2f9c567

package/src/trigger/trigger-registry.ts

@@ -1,218 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import { Event } from '@dxos/async';
-import { type Client } from '@dxos/client';
-import { create, Filter, getMeta, type Space, compareForeignKeys } from '@dxos/client/echo';
-import { Context, Resource } from '@dxos/context';
-import { ECHO_ATTR_META, foreignKey } from '@dxos/echo-schema';
-import { invariant } from '@dxos/invariant';
-import { PublicKey } from '@dxos/keys';
-import { log } from '@dxos/log';
-import { ComplexMap, diff } from '@dxos/util';
-
-import { createSubscriptionTrigger, createTimerTrigger } from './type';
-import { type FunctionManifest, FunctionTrigger, type TriggerKind, type TriggerType } from '../types';
-
-type ResponseCode = number;
-
-export type TriggerCallback = (args: object) => Promise<ResponseCode>;
-
-// TODO(burdon): Make object?
-export type TriggerFactory<Spec extends TriggerType, Options = any> = (
-  ctx: Context,
-  space: Space,
-  spec: Spec,
-  callback: TriggerCallback,
-  options?: Options,
-) => Promise<void>;
-
-export type TriggerFactoryMap = Partial<Record<TriggerKind, TriggerFactory<any>>>;
-
-const triggerFactory: TriggerFactoryMap = {
-  timer: createTimerTrigger,
-  // TODO(burdon): Cannot use in browser.
-  // webhook: createWebhookTrigger,
-  subscription: createSubscriptionTrigger,
-};
-
-export type TriggerEvent = {
-  space: Space;
-  triggers: FunctionTrigger[];
-};
-
-type RegisteredTrigger = {
-  activationCtx?: Context;
-  trigger: FunctionTrigger;
-};
-
-export class TriggerRegistry extends Resource {
-  private readonly _triggersBySpaceKey = new ComplexMap<PublicKey, RegisteredTrigger[]>(PublicKey.hash);
-
-  public readonly registered = new Event<TriggerEvent>();
-  public readonly removed = new Event<TriggerEvent>();
-
-  constructor(
-    private readonly _client: Client,
-    private readonly _options?: TriggerFactoryMap,
-  ) {
-    super();
-  }
-
-  public getActiveTriggers(space: Space): FunctionTrigger[] {
-    return this._getTriggers(space, (t) => t.activationCtx != null);
-  }
-
-  public getInactiveTriggers(space: Space): FunctionTrigger[] {
-    return this._getTriggers(space, (t) => t.activationCtx == null);
-  }
-
-  /**
-   * Set callback for trigger.
-   */
-  public async activate(space: Space, trigger: FunctionTrigger, callback: TriggerCallback): Promise<void> {
-    log('activate', { space: space.key, trigger });
-
-    const activationCtx = new Context({ name: `FunctionTrigger-${trigger.function}` });
-    this._ctx.onDispose(() => activationCtx.dispose());
-    const registeredTrigger = this._triggersBySpaceKey.get(space.key)?.find((reg) => reg.trigger.id === trigger.id);
-    invariant(registeredTrigger, `Trigger is not registered: ${trigger.function}`);
-    registeredTrigger.activationCtx = activationCtx;
-
-    try {
-      // Create trigger.
-      invariant(trigger.spec);
-      const options = this._options?.[trigger.spec.type];
-      const createTrigger = triggerFactory[trigger.spec.type];
-      invariant(createTrigger, `Trigger factory not found: ${trigger.spec.type}`);
-      await createTrigger(activationCtx, space, trigger.spec, callback, options);
-    } catch (err) {
-      delete registeredTrigger.activationCtx;
-      throw err;
-    }
-  }
-
-  /**
-   * Loads triggers from the manifest into the space.
-   */
-  public async register(space: Space, manifest: FunctionManifest): Promise<void> {
-    log('register', { space: space.key });
-    if (!manifest.triggers?.length) {
-      return;
-    }
-
-    if (!space.db.graph.schemaRegistry.hasSchema(FunctionTrigger)) {
-      space.db.graph.schemaRegistry.addSchema([FunctionTrigger]);
-    }
-
-    // Create FK to enable syncing if none are set (NOTE: Possible collision).
-    const manifestTriggers = manifest.triggers.map((trigger) => {
-      let keys = trigger[ECHO_ATTR_META]?.keys;
-      delete trigger[ECHO_ATTR_META];
-      if (!keys?.length) {
-        keys = [foreignKey('manifest', [trigger.function, trigger.spec?.type].join(':'))];
-      }
-
-      return create(FunctionTrigger, trigger, { keys });
-    });
-
-    // Sync triggers.
-    const { objects: existing } = await space.db.query(Filter.schema(FunctionTrigger)).run();
-    const { added } = diff(existing, manifestTriggers, compareForeignKeys);
-
-    // TODO(burdon): Update existing.
-    added.forEach((trigger) => {
-      space.db.add(trigger);
-      log.info('added', { meta: getMeta(trigger) });
-    });
-
-    if (added.length > 0) {
-      await space.db.flush();
-    }
-  }
-
-  protected override async _open(): Promise<void> {
-    log.info('open...');
-    const spaceListSubscription = this._client.spaces.subscribe(async (spaces) => {
-      for (const space of spaces) {
-        if (this._triggersBySpaceKey.has(space.key)) {
-          continue;
-        }
-
-        const registered: RegisteredTrigger[] = [];
-        this._triggersBySpaceKey.set(space.key, registered);
-        await space.waitUntilReady();
-        if (this._ctx.disposed) {
-          break;
-        }
-
-        // Subscribe to updates.
-        this._ctx.onDispose(
-          space.db.query(Filter.schema(FunctionTrigger)).subscribe(async ({ objects: current }) => {
-            log.info('update', { space: space.key, registered: registered.length, current: current.length });
-            await this._handleRemovedTriggers(space, current, registered);
-            this._handleNewTriggers(space, current, registered);
-          }),
-        );
-      }
-    });
-
-    this._ctx.onDispose(() => spaceListSubscription.unsubscribe());
-    log.info('opened');
-  }
-
-  protected override async _close(_: Context): Promise<void> {
-    log.info('close...');
-    this._triggersBySpaceKey.clear();
-    log.info('closed');
-  }
-
-  private _handleNewTriggers(space: Space, current: FunctionTrigger[], registered: RegisteredTrigger[]) {
-    const added = current.filter((candidate) => {
-      return candidate.enabled && registered.find((reg) => reg.trigger.id === candidate.id) == null;
-    });
-
-    if (added.length > 0) {
-      const newRegisteredTriggers: RegisteredTrigger[] = added.map((trigger) => ({ trigger }));
-      registered.push(...newRegisteredTriggers);
-      log.info('added', () => ({
-        spaceKey: space.key,
-        triggers: added.map((trigger) => trigger.function),
-      }));
-
-      this.registered.emit({ space, triggers: added });
-    }
-  }
-
-  private async _handleRemovedTriggers(
-    space: Space,
-    current: FunctionTrigger[],
-    registered: RegisteredTrigger[],
-  ): Promise<void> {
-    const removed: FunctionTrigger[] = [];
-    for (let i = registered.length - 1; i >= 0; i--) {
-      const wasRemoved =
-        current.filter((trigger) => trigger.enabled).find((trigger) => trigger.id === registered[i].trigger.id) == null;
-      if (wasRemoved) {
-        const unregistered = registered.splice(i, 1)[0];
-        await unregistered.activationCtx?.dispose();
-        removed.push(unregistered.trigger);
-      }
-    }
-
-    if (removed.length > 0) {
-      log.info('removed', () => ({
-        spaceKey: space.key,
-        triggers: removed.map((trigger) => trigger.function),
-      }));
-
-      this.removed.emit({ space, triggers: removed });
-    }
-  }
-
-  private _getTriggers(space: Space, predicate: (trigger: RegisteredTrigger) => boolean): FunctionTrigger[] {
-    const allSpaceTriggers = this._triggersBySpaceKey.get(space.key) ?? [];
-    return allSpaceTriggers.filter(predicate).map((trigger) => trigger.trigger);
-  }
-}

package/src/trigger/type/index.ts

@@ -1,7 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-export * from './subscription-trigger';
-export * from './timer-trigger';
-// export * from './webhook-trigger';

package/src/trigger/type/subscription-trigger.ts

@@ -1,84 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import { debounce, UpdateScheduler } from '@dxos/async';
-import { Filter, type Space } from '@dxos/client/echo';
-import { type Context } from '@dxos/context';
-import { createSubscription, type Query } from '@dxos/echo-db';
-import { log } from '@dxos/log';
-
-import type { SubscriptionTrigger } from '../../types';
-import { type TriggerCallback, type TriggerFactory } from '../trigger-registry';
-
-export const createSubscriptionTrigger: TriggerFactory<SubscriptionTrigger> = async (
-  ctx: Context,
-  space: Space,
-  spec: SubscriptionTrigger,
-  callback: TriggerCallback,
-) => {
-  const objectIds = new Set<string>();
-  const task = new UpdateScheduler(
-    ctx,
-    async () => {
-      if (objectIds.size > 0) {
-        const objects = Array.from(objectIds);
-        objectIds.clear();
-        await callback({ objects });
-      }
-    },
-    { maxFrequency: 4 },
-  );
-
-  // TODO(burdon): Factor out diff.
-  // TODO(burdon): Don't fire initially?
-  // TODO(burdon): Create queue. Only allow one invocation per trigger at a time?
-  const subscriptions: (() => void)[] = [];
-  const subscription = createSubscription(({ added, updated }) => {
-    const sizeBefore = objectIds.size;
-    for (const object of added) {
-      objectIds.add(object.id);
-    }
-    for (const object of updated) {
-      objectIds.add(object.id);
-    }
-    if (objectIds.size > sizeBefore) {
-      log.info('updated', { added: added.length, updated: updated.length });
-      task.trigger();
-    }
-  });
-
-  subscriptions.push(() => subscription.unsubscribe());
-
-  // TODO(burdon): Disable trigger if keeps failing.
-  const { filter, options: { deep, delay } = {} } = spec;
-  const update = ({ objects }: Query) => {
-    log.info('update', { objects: objects.length });
-    subscription.update(objects);
-
-    // TODO(burdon): Hack to monitor changes to Document's text object.
-    if (deep) {
-      // TODO(dmaretskyi): Removed to not have dependency on markdown-plugin.
-      // for (const object of objects) {
-      //   const content = object.content;
-      //   if (content instanceof TextType) {
-      //     subscriptions.push(getObjectCore(content).updates.on(debounce(() => subscription.update([object]), 1_000)));
-      //   }
-      // }
-    }
-  };
-
-  // TODO(burdon): OR not working.
-  // TODO(burdon): [Bug]: all callbacks are fired on the first mutation.
-  // TODO(burdon): [Bug]: not updated when document is deleted (either top or hierarchically).
-  log.info('subscription', { filter });
-  // const query = triggerCtx.space.db.query(Filter.or(filter.map(({ type, props }) => Filter.typename(type, props))));
-  if (filter.type) {
-    const query = space.db.query(Filter.typename(filter.type, filter.props));
-    subscriptions.push(query.subscribe(delay ? debounce(update, delay) : update));
-  }
-
-  ctx.onDispose(() => {
-    subscriptions.forEach((unsubscribe) => unsubscribe());
-  });
-};

package/src/trigger/type/timer-trigger.ts

@@ -1,48 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import { parseCronExpression } from 'cron-schedule';
-
-import { DeferredTask } from '@dxos/async';
-import { type Space } from '@dxos/client/echo';
-import { type Context } from '@dxos/context';
-import { log } from '@dxos/log';
-
-import type { TimerTrigger } from '../../types';
-import { type TriggerCallback, type TriggerFactory } from '../trigger-registry';
-
-export const createTimerTrigger: TriggerFactory<TimerTrigger> = async (
-  ctx: Context,
-  space: Space,
-  spec: TimerTrigger,
-  callback: TriggerCallback,
-) => {
-  const task = new DeferredTask(ctx, async () => {
-    await callback({});
-  });
-
-  let last = 0;
-  let run = 0;
-  const schedule = parseCronExpression(spec.cron);
-  const getRunTimeout = () => Date.now() - schedule.getNextDate().getTime();
-  const runCron = () => {
-    if (ctx.disposed) {
-      return;
-    }
-    // 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();
-
-    timeout = setTimeout(runCron, getRunTimeout());
-  };
-
-  let timeout = setTimeout(runCron, getRunTimeout());
-
-  ctx.onDispose(() => clearTimeout(timeout));
-};

package/src/trigger/type/webhook-trigger.ts

@@ -1,48 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import { getPort } from 'get-port-please';
-import http from 'node:http';
-
-import { type Space } from '@dxos/client/echo';
-import { type Context } from '@dxos/context';
-import { log } from '@dxos/log';
-
-import type { WebhookTrigger } from '../../types';
-import { type TriggerCallback, type TriggerFactory } from '../trigger-registry';
-
-export const createWebhookTrigger: TriggerFactory<WebhookTrigger> = async (
-  ctx: Context,
-  space: Space,
-  spec: WebhookTrigger,
-  callback: TriggerCallback,
-) => {
-  // TODO(burdon): Enable POST hook with payload.
-  const server = http.createServer(async (req, res) => {
-    if (req.method !== spec.method) {
-      res.statusCode = 405;
-      return res.end();
-    }
-    res.statusCode = await callback({});
-    res.end();
-  });
-
-  // TODO(burdon): Not used.
-  // const DEF_PORT_RANGE = { min: 7500, max: 7599 };
-  // const portRange = Object.assign({}, trigger.port, DEF_PORT_RANGE) as WebhookTrigger['port'];
-  const port = await getPort({
-    random: true,
-    // portRange: [portRange!.min, portRange!.max],
-  });
-
-  // TODO(burdon): Update trigger object with actual port.
-  server.listen(port, () => {
-    log.info('started webhook', { port });
-    spec.port = port;
-  });
-
-  ctx.onDispose(() => {
-    server.close();
-  });
-};

package/src/types/index.ts

@@ -1,8 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-export * from './schema';
-export * from './types';
-export * from './trace';
-export * from './url';

package/src/types/schema.ts

@@ -1,46 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import { EchoObject, JsonSchemaType, LabelAnnotationId, Ref, S, TypedObject } from '@dxos/echo-schema';
-import { TextType } from '@dxos/schema';
-
-/**
- * Source script.
- */
-export const ScriptType = S.Struct({
-  name: S.optional(S.String),
-  description: S.optional(S.String),
-  // TODO(burdon): Change to hash of deployed content.
-  // Whether source has changed since last deploy.
-  changed: S.optional(S.Boolean),
-  source: Ref(TextType),
-})
-  .annotations({ [LabelAnnotationId]: 'name' })
-  .pipe(EchoObject({ typename: 'dxos.org/type/Script', version: '0.1.0' }));
-
-export type ScriptType = S.Schema.Type<typeof ScriptType>;
-
-/**
- * Function deployment.
- */
-export class FunctionType extends TypedObject({
-  typename: 'dxos.org/type/Function',
-  version: '0.1.0',
-})({
-  // TODO(burdon): Rename to id/uri?
-  name: S.NonEmptyString,
-  version: S.String,
-
-  description: S.optional(S.String),
-
-  // Reference to a source script if it exists within ECHO.
-  // TODO(burdon): Don't ref ScriptType directly (core).
-  source: S.optional(Ref(ScriptType)),
-
-  inputSchema: S.optional(JsonSchemaType),
-  outputSchema: S.optional(JsonSchemaType),
-
-  // Local binding to a function name.
-  binding: S.optional(S.String),
-}) {}

package/src/types/types.ts

@@ -1,163 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import { AST, OptionsAnnotationId, RawObject, S, TypedObject, DXN } from '@dxos/echo-schema';
-
-/**
- * Type discriminator for TriggerType.
- * Every spec has a type field of type TriggerKind that we can use to understand which type we're working with.
- * https://www.typescriptlang.org/docs/handbook/2/narrowing.html#discriminated-unions
- */
-export enum TriggerKind {
-  Timer = 'timer',
-  Webhook = 'webhook',
-  Subscription = 'subscription',
-  Email = 'email',
-  Queue = 'queue',
-}
-
-// TODO(burdon): Rename prop kind.
-const typeLiteralAnnotations = { [AST.TitleAnnotationId]: 'Type' };
-
-/**
- * Cron timer.
- */
-const TimerTriggerSchema = S.Struct({
-  type: S.Literal(TriggerKind.Timer).annotations(typeLiteralAnnotations),
-  cron: S.String.annotations({
-    [AST.TitleAnnotationId]: 'Cron',
-    [AST.ExamplesAnnotationId]: ['0 0 * * *'],
-  }),
-}).pipe(S.mutable);
-
-export type TimerTrigger = S.Schema.Type<typeof TimerTriggerSchema>;
-
-const EmailTriggerSchema = S.Struct({
-  type: S.Literal(TriggerKind.Email).annotations(typeLiteralAnnotations),
-}).pipe(S.mutable);
-
-export type EmailTrigger = S.Schema.Type<typeof EmailTriggerSchema>;
-
-const QueueTriggerSchema = S.Struct({
-  type: S.Literal(TriggerKind.Queue).annotations(typeLiteralAnnotations),
-  queue: DXN,
-}).pipe(S.mutable);
-
-export type QueueTrigger = S.Schema.Type<typeof QueueTriggerSchema>;
-
-/**
- * Webhook.
- */
-const WebhookTriggerSchema = S.Struct({
-  type: S.Literal(TriggerKind.Webhook).annotations(typeLiteralAnnotations),
-  method: S.optional(
-    S.String.annotations({
-      [AST.TitleAnnotationId]: 'Method',
-      [OptionsAnnotationId]: ['GET', 'POST'],
-    }),
-  ),
-  port: S.optional(
-    S.Number.annotations({
-      [AST.TitleAnnotationId]: 'Port',
-    }),
-  ),
-}).pipe(S.mutable);
-
-export type WebhookTrigger = S.Schema.Type<typeof WebhookTriggerSchema>;
-
-// TODO(burdon): Use ECHO definition (from https://github.com/dxos/dxos/pull/8233).
-const QuerySchema = S.Struct({
-  type: S.optional(S.String.annotations({ [AST.TitleAnnotationId]: 'Type' })),
-  props: S.optional(S.Record({ key: S.String, value: S.Any })),
-}).annotations({ [AST.TitleAnnotationId]: 'Query' });
-
-/**
- * Subscription.
- */
-const SubscriptionTriggerSchema = S.Struct({
-  type: S.Literal(TriggerKind.Subscription).annotations(typeLiteralAnnotations),
-  // TODO(burdon): Define query DSL (from ECHO). Reconcile with Table.Query.
-  filter: QuerySchema,
-  options: S.optional(
-    S.Struct({
-      // Watch changes to object (not just creation).
-      deep: S.optional(S.Boolean.annotations({ [AST.TitleAnnotationId]: 'Nested' })),
-      // Debounce changes (delay in ms).
-      delay: S.optional(S.Number.annotations({ [AST.TitleAnnotationId]: 'Delay' })),
-    }).annotations({ [AST.TitleAnnotationId]: 'Options' }),
-  ),
-}).pipe(S.mutable);
-
-export type SubscriptionTrigger = S.Schema.Type<typeof SubscriptionTriggerSchema>;
-
-/**
- * Trigger schema (discriminated union).
- */
-export const TriggerSchema = S.Union(
-  TimerTriggerSchema,
-  WebhookTriggerSchema,
-  SubscriptionTriggerSchema,
-  EmailTriggerSchema,
-  QueueTriggerSchema,
-).annotations({
-  [AST.TitleAnnotationId]: 'Trigger',
-});
-
-export type TriggerType = S.Schema.Type<typeof TriggerSchema>;
-
-/**
- * Function trigger.
- */
-export const FunctionTriggerSchema = S.Struct({
-  // TODO(burdon): What type does this reference.
-  // TODO(wittjosiah): This should probably be a Ref?
-  function: S.optional(S.String.annotations({ [AST.TitleAnnotationId]: 'Function' })),
-
-  enabled: S.optional(S.Boolean.annotations({ [AST.TitleAnnotationId]: 'Enabled' })),
-
-  // TODO(burdon): Flatten entire schema.
-  spec: S.optional(TriggerSchema),
-
-  // TODO(burdon): Get schema as partial from function.
-  // TODO(wittjosiah): Rename to payload.
-  // The `meta` property is merged into the event data passed to the function.
-  meta: S.optional(S.mutable(S.Record({ key: S.String, value: S.Any }))),
-});
-
-export type FunctionTriggerType = S.Schema.Type<typeof FunctionTriggerSchema>;
-
-/**
- * Function trigger.
- */
-export class FunctionTrigger extends TypedObject({
-  typename: 'dxos.org/type/FunctionTrigger',
-  version: '0.1.0',
-})(FunctionTriggerSchema.fields) {}
-
-/**
- * Function definition.
- * @deprecated (Use dxos.org/type/Function)
- */
-// TODO(burdon): Reconcile with FunctionType.
-export class FunctionDef extends TypedObject({
-  typename: 'dxos.org/type/FunctionDef',
-  version: '0.1.0',
-})({
-  uri: S.String,
-  description: S.optional(S.String),
-  route: S.String,
-  handler: S.String,
-}) {}
-
-/**
- * Function manifest file.
- */
-export const FunctionManifestSchema = S.Struct({
-  functions: S.optional(S.mutable(S.Array(RawObject(FunctionDef)))),
-  triggers: S.optional(S.mutable(S.Array(RawObject(FunctionTrigger)))),
-});
-
-export type FunctionManifest = S.Schema.Type<typeof FunctionManifestSchema>;
-
-export const FUNCTION_TYPES = [FunctionDef, FunctionTrigger];