@dxos/functions 0.8.4-main.3f58842 → 0.8.4-main.5ea62a8

package/src/services/database.ts

@@ -2,13 +2,18 @@
 // Copyright 2025 DXOS.org
 //
 
-import { Context, Effect, Layer } from 'effect';
+import { Context, Effect, Layer, Option, type Schema } from 'effect';
 
-import type { Filter, Live, Obj, Query, Ref, Relation } from '@dxos/echo';
-import type { EchoDatabase, OneShotQueryResult, QueryResult } from '@dxos/echo-db';
+import { type Filter, type Live, Obj, type Query, type Ref, type Relation, type Type } from '@dxos/echo';
+import type { EchoDatabase, FlushOptions, OneShotQueryResult, QueryResult, SchemaRegistryQuery } from '@dxos/echo-db';
+import type { SchemaRegistryPreparedQuery } from '@dxos/echo-db';
+import type { EchoSchema } from '@dxos/echo-schema';
+import { promiseWithCauseCapture } from '@dxos/effect';
+import { BaseError } from '@dxos/errors';
+import { invariant } from '@dxos/invariant';
 import type { DXN } from '@dxos/keys';
 
-export class DatabaseService extends Context.Tag('DatabaseService')<
+export class DatabaseService extends Context.Tag('@dxos/functions/DatabaseService')<
   DatabaseService,
   {
     readonly db: EchoDatabase;
@@ -28,23 +33,96 @@ export class DatabaseService extends Context.Tag('DatabaseService')<
     };
   };
 
-  static resolve: (dxn: DXN) => Effect.Effect<Obj.Any | Relation.Any, Error, DatabaseService> = Effect.fn(
-    function* (dxn) {
+  static layer = (db: EchoDatabase): Layer.Layer<DatabaseService> => {
+    return Layer.succeed(DatabaseService, DatabaseService.make(db));
+  };
+
+  /**
+   * Resolves an object by its DXN.
+   */
+  static resolve: {
+    // No type check.
+    (dxn: DXN): Effect.Effect<Obj.Any | Relation.Any, never, DatabaseService>;
+    // Check matches schema.
+    <S extends Type.Obj.Any | Type.Relation.Any>(
+      dxn: DXN,
+      schema: S,
+    ): Effect.Effect<Schema.Schema.Type<S>, ObjectNotFoundError, DatabaseService>;
+  } = (<S extends Type.Obj.Any | Type.Relation.Any>(
+    dxn: DXN,
+    schema?: S,
+  ): Effect.Effect<Schema.Schema.Type<S>, ObjectNotFoundError, DatabaseService> =>
+    Effect.gen(function* () {
       const { db } = yield* DatabaseService;
-      return yield* Effect.tryPromise({
-        try: () =>
-          db.graph.createRefResolver({ context: { space: db.spaceId } }).resolve(dxn) as Promise<
-            Obj.Any | Relation.Any
-          >,
-        catch: (error) => error as Error,
-      });
-    },
-  );
+      const object = yield* promiseWithCauseCapture(() =>
+        db.graph
+          .createRefResolver({
+            context: {
+              space: db.spaceId,
+            },
+          })
+          .resolve(dxn),
+      );
+
+      if (!object) {
+        return yield* Effect.fail(new ObjectNotFoundError({ dxn }));
+      }
+      invariant(!schema || Obj.instanceOf(schema, object), 'Object type mismatch.');
+      return object as any;
+    })) as any;
+
+  /**
+   * Loads an object reference.
+   */
+  static load: <T>(ref: Ref.Ref<T>) => Effect.Effect<T, ObjectNotFoundError, never> = Effect.fn(function* (ref) {
+    const object = yield* promiseWithCauseCapture(() => ref.tryLoad());
+    if (!object) {
+      return yield* Effect.fail(new ObjectNotFoundError({ dxn: ref.dxn }));
+    }
+    return object;
+  });
 
-  static loadRef: <T>(ref: Ref.Ref<T>) => Effect.Effect<T, never, never> = Effect.fn(function* (ref) {
-    return yield* Effect.promise(() => ref.load());
+  /**
+   * Loads an object reference option.
+   */
+  // TODO(burdon): Option?
+  static loadOption: <T>(ref: Ref.Ref<T>) => Effect.Effect<Option.Option<T>, never, never> = Effect.fn(function* (ref) {
+    const object = yield* DatabaseService.load(ref).pipe(
+      Effect.catchTag('OBJECT_NOT_FOUND', () => Effect.succeed(undefined)),
+    );
+    return Option.fromNullable(object);
   });
 
+  // TODO(burdon): Can we create a proxy for the following methods on EchoDatabase? Use @inheritDoc?
+  // TODO(burdon): Figure out how to chain query().run();
+
+  /**
+   * @link EchoDatabase.add
+   */
+  static add = <T extends Obj.Any | Relation.Any>(obj: T): Effect.Effect<T, never, DatabaseService> =>
+    DatabaseService.pipe(Effect.map(({ db }) => db.add(obj)));
+
+  /**
+   * @link EchoDatabase.remove
+   */
+  static remove = <T extends Obj.Any | Relation.Any>(obj: T): Effect.Effect<void, never, DatabaseService> =>
+    DatabaseService.pipe(Effect.map(({ db }) => db.remove(obj)));
+
+  /**
+   * @link EchoDatabase.flush
+   */
+  static flush = (opts?: FlushOptions) =>
+    DatabaseService.pipe(Effect.flatMap(({ db }) => promiseWithCauseCapture(() => db.flush(opts))));
+
+  /**
+   * @link EchoDatabase.getObjectById
+   */
+  static getObjectById = <T extends Obj.Any | Relation.Any>(
+    id: string,
+  ): Effect.Effect<Live<T> | undefined, never, DatabaseService> => {
+    return DatabaseService.pipe(Effect.map(({ db }) => db.getObjectById(id)));
+  };
+
   /**
    * Creates a `QueryResult` object that can be subscribed to.
    */
@@ -65,6 +143,28 @@ export class DatabaseService extends Context.Tag('DatabaseService')<
     <F extends Filter.Any>(filter: F): Effect.Effect<OneShotQueryResult<Live<Filter.Type<F>>>, never, DatabaseService>;
   } = (queryOrFilter: Query.Any | Filter.Any) =>
     DatabaseService.query(queryOrFilter as any).pipe(
-      Effect.flatMap((queryResult) => Effect.promise(() => queryResult.run())),
+      Effect.flatMap((queryResult) => promiseWithCauseCapture(() => queryResult.run())),
     );
+
+  static schemaQuery = <Q extends SchemaRegistryQuery>(
+    query: Q,
+  ): Effect.Effect<SchemaRegistryPreparedQuery<EchoSchema>, never, DatabaseService> =>
+    DatabaseService.pipe(
+      Effect.map(({ db }) => db.schemaRegistry.query(query)),
+      Effect.withSpan('DatabaseService.schemaQuery'),
+    );
+
+  static runSchemaQuery = <Q extends SchemaRegistryQuery>(
+    query: Q,
+  ): Effect.Effect<EchoSchema[], never, DatabaseService> =>
+    DatabaseService.schemaQuery(query).pipe(
+      Effect.flatMap((queryResult) => promiseWithCauseCapture(() => queryResult.run())),
+    );
+}
+
+// TODO(burdon): Move to echo/errors.
+class ObjectNotFoundError extends BaseError.extend('OBJECT_NOT_FOUND') {
+  constructor(context?: Record<string, unknown>) {
+    super('Object not found', { context });
+  }
 }

package/src/services/event-logger.ts

@@ -2,53 +2,81 @@
 // Copyright 2025 DXOS.org
 //
 
-import { Effect, Context } from 'effect';
+import { Context, Effect, Layer, Schema } from 'effect';
 
+import { Obj, Type } from '@dxos/echo';
 import { invariant } from '@dxos/invariant';
-import { log, LogLevel } from '@dxos/log';
+import { LogLevel, log } from '@dxos/log';
 
-export type ComputeEvent =
-  | {
-      type: 'begin-compute';
-      nodeId: string;
-      inputs: Record<string, any>;
-    }
-  | {
-      type: 'end-compute';
-      nodeId: string;
-      outputs: Record<string, any>;
-    }
-  | {
-      type: 'compute-input';
-      nodeId: string;
-      property: string;
-      value: any;
-    }
-  | {
-      type: 'compute-output';
-      nodeId: string;
-      property: string;
-      value: any;
-    }
-  | {
-      type: 'custom';
-      nodeId: string;
-      event: any;
-    };
+import { TracingService } from './tracing';
+
+export const ComputeEventPayload = Schema.Union(
+  Schema.Struct({
+    type: Schema.Literal('begin-compute'),
+    nodeId: Schema.String,
+    inputs: Schema.Record({ key: Schema.String, value: Schema.Any }),
+  }),
+  Schema.Struct({
+    type: Schema.Literal('end-compute'),
+    nodeId: Schema.String,
+    outputs: Schema.Record({ key: Schema.String, value: Schema.Any }),
+  }),
+  Schema.Struct({
+    type: Schema.Literal('compute-input'),
+    nodeId: Schema.String,
+    property: Schema.String,
+    value: Schema.Any,
+  }),
+  Schema.Struct({
+    type: Schema.Literal('compute-output'),
+    nodeId: Schema.String,
+    property: Schema.String,
+    value: Schema.Any,
+  }),
+  Schema.Struct({
+    type: Schema.Literal('custom'),
+    nodeId: Schema.String,
+    event: Schema.Any,
+  }),
+);
+export type ComputeEventPayload = Schema.Schema.Type<typeof ComputeEventPayload>;
 
-export class EventLogger extends Context.Tag('EventLogger')<
-  EventLogger,
-  { readonly log: (event: ComputeEvent) => void; readonly nodeId: string | undefined }
+export const ComputeEvent = Schema.Struct({
+  payload: ComputeEventPayload,
+}).pipe(Type.Obj({ typename: 'dxos.org/type/ComputeEvent', version: '0.1.0' }));
+
+/**
+ * Logs event for the compute workflows.
+ */
+export class ComputeEventLogger extends Context.Tag('@dxos/functions/ComputeEventLogger')<
+  ComputeEventLogger,
+  { readonly log: (event: ComputeEventPayload) => void; readonly nodeId: string | undefined }
 >() {
-  static noop: Context.Tag.Service<EventLogger> = {
+  static noop: Context.Tag.Service<ComputeEventLogger> = {
     log: () => {},
     nodeId: undefined,
   };
+
+  /**
+   * Implements ComputeEventLogger using TracingService.
+   */
+  static layerFromTracing = Layer.effect(
+    ComputeEventLogger,
+    Effect.gen(function* () {
+      const tracing = yield* TracingService;
+      return {
+        log: (event: ComputeEventPayload) => {
+          tracing.write(Obj.make(ComputeEvent, { payload: event }));
+        },
+        nodeId: undefined,
+      };
+    }),
+  );
 }
 
 export const logCustomEvent = (data: any) =>
   Effect.gen(function* () {
-    const logger = yield* EventLogger;
+    const logger = yield* ComputeEventLogger;
     if (!logger.nodeId) {
       throw new Error('logCustomEvent must be called within a node compute function');
     }
@@ -67,7 +95,10 @@ export const createDefectLogger = <A, E, R>(): ((self: Effect.Effect<A, E, R>) =
     }),
   );
 
-export const createEventLogger = (level: LogLevel, message: string = 'event'): Context.Tag.Service<EventLogger> => {
+export const createEventLogger = (
+  level: LogLevel,
+  message: string = 'event',
+): Context.Tag.Service<ComputeEventLogger> => {
   const logFunction = (
     {
       [LogLevel.WARN]: log.warn,
@@ -79,7 +110,7 @@ export const createEventLogger = (level: LogLevel, message: string = 'event'): C
   )[level];
   invariant(logFunction);
   return {
-    log: (event: ComputeEvent) => {
+    log: (event: ComputeEventPayload) => {
       logFunction(message, event);
     },
     nodeId: undefined,

package/src/services/index.ts

@@ -8,4 +8,5 @@ export * from './service-container';
 export * from './credentials';
 export * from './tracing';
 export * from './event-logger';
-export * from './function-call-service';
+export * from './remote-function-execution-service';
+export * from './local-function-execution';

package/src/services/local-function-execution.ts

@@ -0,0 +1,77 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { Context, Effect, Layer, Schema } from 'effect';
+
+import { todo } from '@dxos/debug';
+
+import { FunctionError } from '../errors';
+import type { FunctionContext, FunctionDefinition } from '../handler';
+
+import type { Services } from './service-container';
+
+export class LocalFunctionExecutionService extends Context.Tag('@dxos/functions/LocalFunctionExecutionService')<
+  LocalFunctionExecutionService,
+  {
+    // TODO(dmaretskyi): This should take function id instead of the definition object.
+    // TODO(dmaretskyi): Services should be satisfied from environment rather then bubbled up.
+    invokeFunction(functionDef: FunctionDefinition<any, any>, input: unknown): Effect.Effect<unknown, never, Services>;
+  }
+>() {
+  static layer = Layer.succeed(LocalFunctionExecutionService, {
+    invokeFunction: (functionDef, input) => invokeFunction(functionDef, input),
+  });
+
+  static invokeFunction: <F extends FunctionDefinition.Any>(
+    functionDef: F,
+    input: FunctionDefinition.Input<F>,
+  ) => Effect.Effect<FunctionDefinition.Output<F>, never, Services | LocalFunctionExecutionService> =
+    Effect.serviceFunctionEffect(LocalFunctionExecutionService, (_) => _.invokeFunction as any);
+}
+
+const invokeFunction = (
+  functionDef: FunctionDefinition<any, any>,
+  input: any,
+): Effect.Effect<unknown, never, Services> =>
+  Effect.gen(function* () {
+    // Assert input matches schema
+    const assertInput = functionDef.inputSchema.pipe(Schema.asserts);
+    (assertInput as any)(input);
+
+    const context: FunctionContext = {
+      space: undefined,
+      getService: () => todo(),
+      getSpace: async (_spaceId: any) => {
+        throw new Error('Not available. Use the database service instead.');
+      },
+    };
+
+    // TODO(dmaretskyi): This should be delegated to a function invoker service.
+    const data = yield* Effect.gen(function* () {
+      const result = functionDef.handler({ context, data: input });
+      if (Effect.isEffect(result)) {
+        return yield* (result as Effect.Effect<unknown, unknown, Services>).pipe(Effect.orDie);
+      } else if (
+        typeof result === 'object' &&
+        result !== null &&
+        'then' in result &&
+        typeof result.then === 'function'
+      ) {
+        return yield* Effect.promise(() => result);
+      } else {
+        return result;
+      }
+    }).pipe(
+      Effect.orDie,
+      Effect.catchAllDefect((defect) =>
+        Effect.die(new FunctionError('Error running function', { context: { name: functionDef.name }, cause: defect })),
+      ),
+    );
+
+    // Assert output matches schema
+    const assertOutput = functionDef.outputSchema?.pipe(Schema.asserts);
+    (assertOutput as any)(data);
+
+    return data;
+  }).pipe(Effect.withSpan('invokeFunction', { attributes: { name: functionDef.name } }));

package/src/services/queues.ts

@@ -2,14 +2,16 @@
 // Copyright 2025 DXOS.org
 //
 
-import { Context, Layer } from 'effect';
+import { Context, Effect, Layer } from 'effect';
 
+import type { Obj, Relation } from '@dxos/echo';
 import type { Queue, QueueAPI, QueueFactory } from '@dxos/echo-db';
+import type { DXN, QueueSubspaceTag } from '@dxos/keys';
 
 /**
  * Gives access to all queues.
  */
-export class QueueService extends Context.Tag('QueueService')<
+export class QueueService extends Context.Tag('@dxos/functions/QueueService')<
   QueueService,
   {
     /**
@@ -21,35 +23,55 @@ export class QueueService extends Context.Tag('QueueService')<
      * The queue that is used to store the context of the current research.
      * @deprecated Use `ContextQueueService` instead.
      */
-    readonly contextQueue: Queue | undefined;
+    readonly queue: Queue | undefined;
   }
 >() {
   static notAvailable = Layer.succeed(QueueService, {
     queues: {
-      get(dxn) {
+      get(_dxn) {
         throw new Error('Queues not available');
       },
       create() {
         throw new Error('Queues not available');
       },
     },
-    contextQueue: undefined,
+    queue: undefined,
   });
 
-  static make = (queues: QueueFactory, contextQueue?: Queue): Context.Tag.Service<QueueService> => {
+  static make = (queues: QueueFactory, queue?: Queue): Context.Tag.Service<QueueService> => {
     return {
       queues,
-      contextQueue,
+      queue,
     };
   };
+
+  static layer = (queues: QueueFactory, queue?: Queue): Layer.Layer<QueueService> =>
+    Layer.succeed(QueueService, QueueService.make(queues, queue));
+
+  /**
+   * Gets a queue by its DXN.
+   */
+  static getQueue = <T extends Obj.Any | Relation.Any = Obj.Any | Relation.Any>(
+    dxn: DXN,
+  ): Effect.Effect<Queue<T>, never, QueueService> => QueueService.pipe(Effect.map(({ queues }) => queues.get<T>(dxn)));
+
+  /**
+   * Creates a new queue.
+   */
+  static createQueue = <T extends Obj.Any | Relation.Any = Obj.Any | Relation.Any>(options?: {
+    subspaceTag?: QueueSubspaceTag;
+  }): Effect.Effect<Queue<T>, never, QueueService> =>
+    QueueService.pipe(Effect.map(({ queues }) => queues.create<T>(options)));
 }
 
 /**
  * Gives access to a specific queue passed as a context.
  */
-export class ContextQueueService extends Context.Tag('ContextQueueService')<
+export class ContextQueueService extends Context.Tag('@dxos/functions/ContextQueueService')<
   ContextQueueService,
   {
-    readonly contextQueue: Queue;
+    readonly queue: Queue;
   }
->() {}
+>() {
+  static layer = (queue: Queue) => Layer.succeed(ContextQueueService, { queue });
+}

package/src/services/remote-function-execution-service.ts

@@ -0,0 +1,46 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { Context, Layer } from 'effect';
+
+import type { SpaceId } from '@dxos/keys';
+
+import { getInvocationUrl } from '../url';
+
+/**
+ * Allows calling into other functions.
+ */
+export class RemoteFunctionExecutionService extends Context.Tag('@dxos/functions/RemoteFunctionExecutionService')<
+  RemoteFunctionExecutionService,
+  {
+    callFunction(deployedFunctionId: string, input: any, spaceId?: SpaceId): Promise<any>;
+  }
+>() {
+  static fromClient(baseUrl: string, spaceId: SpaceId): Context.Tag.Service<RemoteFunctionExecutionService> {
+    return {
+      callFunction: async (deployedFunctionId: string, input: any) => {
+        const url = getInvocationUrl(deployedFunctionId, baseUrl, { spaceId });
+        const result = await fetch(url, {
+          method: 'POST',
+          headers: { 'Content-Type': 'application/json' },
+          body: JSON.stringify(input),
+        });
+        if (result.status >= 300 || result.status < 200) {
+          throw new Error('Failed to invoke function', { cause: new Error(`HTTP error: ${await result.text()}`) });
+        }
+        return await result.json();
+      },
+    };
+  }
+
+  static mock = (): Context.Tag.Service<RemoteFunctionExecutionService> => {
+    return {
+      callFunction: async (deployedFunctionId: string, input: any) => {
+        return input;
+      },
+    };
+  };
+
+  static mockLayer = Layer.succeed(RemoteFunctionExecutionService, RemoteFunctionExecutionService.mock());
+}

package/src/services/service-container.ts

@@ -9,9 +9,9 @@ import { entries } from '@dxos/util';
 
 import { ConfiguredCredentialsService, CredentialsService } from './credentials';
 import { DatabaseService } from './database';
-import { EventLogger } from './event-logger';
-import { FunctionCallService } from './function-call-service';
+import { ComputeEventLogger } from './event-logger';
 import { QueueService } from './queues';
+import { RemoteFunctionExecutionService } from './remote-function-execution-service';
 import { TracingService } from './tracing';
 
 // TODO(dmaretskyi): Refactor this module to only rely on tags and not the human-assigned names.
@@ -20,11 +20,11 @@ import { TracingService } from './tracing';
  * List of all services.
  */
 const SERVICES = {
-  ai: AiService,
+  ai: AiService.AiService,
   credentials: CredentialsService,
   database: DatabaseService,
-  eventLogger: EventLogger,
-  functionCallService: FunctionCallService,
+  eventLogger: ComputeEventLogger,
+  functionCallService: RemoteFunctionExecutionService,
   queues: QueueService,
   tracing: TracingService,
 } as const satisfies Record<string, Context.TagClass<any, string, any>>;
@@ -88,9 +88,10 @@ export class ServiceContainer {
     return new ServiceContainer().setServices({ ...this._services });
   }
 
-  // TODO(dmaretskyi): `getService` is designed to error at runtime if the service is not available, but layer forces us to provide all services and makes stubs for the ones that are not available.
+  // TODO(dmaretskyi): `getService` is designed to error at runtime if the service is not available, but Layer forces us to provide all services and makes stubs for the ones that are not available.
   createLayer(): Layer.Layer<Services> {
-    const ai = this._services.ai != null ? Layer.succeed(AiService, this._services.ai) : AiService.notAvailable;
+    const ai =
+      this._services.ai != null ? Layer.succeed(AiService.AiService, this._services.ai) : AiService.notAvailable;
     const credentials = Layer.succeed(
       CredentialsService,
       this._services.credentials ?? new ConfiguredCredentialsService(),
@@ -102,10 +103,10 @@ export class ServiceContainer {
     const queues =
       this._services.queues != null ? Layer.succeed(QueueService, this._services.queues) : QueueService.notAvailable;
     const tracing = Layer.succeed(TracingService, this._services.tracing ?? TracingService.noop);
-    const eventLogger = Layer.succeed(EventLogger, this._services.eventLogger ?? EventLogger.noop);
+    const eventLogger = Layer.succeed(ComputeEventLogger, this._services.eventLogger ?? ComputeEventLogger.noop);
     const functionCallService = Layer.succeed(
-      FunctionCallService,
-      this._services.functionCallService ?? FunctionCallService.mock(),
+      RemoteFunctionExecutionService,
+      this._services.functionCallService ?? RemoteFunctionExecutionService.mock(),
     );
 
     return Layer.mergeAll(ai, credentials, database, queues, tracing, eventLogger, functionCallService);

package/src/services/service-registry.ts

@@ -2,7 +2,7 @@
 // Copyright 2025 DXOS.org
 //
 
-import { Context, Effect, flow, type Option } from 'effect';
+import { Context, Effect, type Option, flow } from 'effect';
 
 import { ServiceNotAvailableError } from '../errors';
 
@@ -12,7 +12,10 @@ export namespace ServiceRegistry {
   }
 }
 
-export class ServiceRegistry extends Context.Tag('ServiceRegistry')<ServiceRegistry, ServiceRegistry.Service>() {
+export class ServiceRegistry extends Context.Tag('@dxos/functions/ServiceRegistry')<
+  ServiceRegistry,
+  ServiceRegistry.Service
+>() {
   /**
    * Resolves the service from the registry.
    * @param tag Service tag to resolve.