@dxos/functions 0.8.4-main.1da679c → 0.8.4-main.21d9917

package/src/schema.ts

@@ -1,68 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import { Schema } from 'effect';
-
-import { Type } from '@dxos/echo';
-import { JsonSchemaType, LabelAnnotation, Ref } from '@dxos/echo-schema';
-import { DataType } from '@dxos/schema';
-
-/**
- * Source script.
- */
-export const ScriptType = Schema.Struct({
-  name: Schema.optional(Schema.String),
-  description: Schema.optional(Schema.String),
-  // TODO(burdon): Change to hash of deployed content.
-  // Whether source has changed since last deploy.
-  changed: Schema.optional(Schema.Boolean),
-  source: Ref(DataType.Text),
-}).pipe(
-  Type.Obj({
-    typename: 'dxos.org/type/Script',
-    version: '0.1.0',
-  }),
-  LabelAnnotation.set(['name']),
-);
-
-export interface ScriptType extends Schema.Schema.Type<typeof ScriptType> {}
-
-/**
- * Function deployment.
- */
-export const FunctionType = Schema.Struct({
-  /**
-   * Global registry ID.
-   * NOTE: The `key` property refers to the original registry entry.
-   */
-  // TODO(burdon): Create Format type for DXN-like ids, such as this and schema type.
-  // TODO(dmaretskyi): Consider making it part of ECHO meta.
-  // TODO(dmaretskyi): Make required.
-  key: Schema.optional(Schema.String).annotations({
-    description: 'Unique registration key for the blueprint',
-  }),
-
-  // TODO(burdon): Rename to id/uri?
-  name: Schema.NonEmptyString,
-  version: Schema.String,
-
-  description: Schema.optional(Schema.String),
-
-  // Reference to a source script if it exists within ECHO.
-  // TODO(burdon): Don't ref ScriptType directly (core).
-  source: Schema.optional(Ref(ScriptType)),
-
-  inputSchema: Schema.optional(JsonSchemaType),
-  outputSchema: Schema.optional(JsonSchemaType),
-
-  // Local binding to a function name.
-  binding: Schema.optional(Schema.String),
-}).pipe(
-  Type.Obj({
-    typename: 'dxos.org/type/Function',
-    version: '0.1.0',
-  }),
-  LabelAnnotation.set(['name']),
-);
-export interface FunctionType extends Schema.Schema.Type<typeof FunctionType> {}

package/src/services/database.ts

@@ -1,171 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { Context, Effect, Layer, Option, type Schema } from 'effect';
-
-import {
-  type Filter,
-  type Live,
-  Obj,
-  ObjectNotFoundError,
-  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 { invariant } from '@dxos/invariant';
-import type { DXN } from '@dxos/keys';
-
-export class DatabaseService extends Context.Tag('@dxos/functions/DatabaseService')<
-  DatabaseService,
-  {
-    readonly db: EchoDatabase;
-  }
->() {
-  static notAvailable = Layer.succeed(DatabaseService, {
-    get db(): EchoDatabase {
-      throw new Error('Database not available');
-    },
-  });
-
-  static make = (db: EchoDatabase): Context.Tag.Service<DatabaseService> => {
-    return {
-      get db() {
-        return db;
-      },
-    };
-  };
-
-  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;
-      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(ref.dxn));
-    }
-    return object;
-  });
-
-  /**
-   * 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.
-   */
-  static query: {
-    <Q extends Query.Any>(query: Q): Effect.Effect<QueryResult<Live<Query.Type<Q>>>, never, DatabaseService>;
-    <F extends Filter.Any>(filter: F): Effect.Effect<QueryResult<Live<Filter.Type<F>>>, never, DatabaseService>;
-  } = (queryOrFilter: Query.Any | Filter.Any) =>
-    DatabaseService.pipe(
-      Effect.map(({ db }) => db.query(queryOrFilter as any)),
-      Effect.withSpan('DatabaseService.query'),
-    );
-
-  /**
-   * Executes the query once and returns the results.
-   */
-  static runQuery: {
-    <Q extends Query.Any>(query: Q): Effect.Effect<OneShotQueryResult<Live<Query.Type<Q>>>, never, 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) => 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())),
-    );
-}

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

@@ -1,127 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { Context, Effect, Layer, Schema } from 'effect';
-
-import { todo } from '@dxos/debug';
-import { log } from '@dxos/log';
-
-import { FunctionError, FunctionNotFoundError } 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>;
-  }
->() {
-  /**
-   * @deprecated Use layerLive instead.
-   */
-  static layer = Layer.succeed(LocalFunctionExecutionService, {
-    invokeFunction: (functionDef, input) => invokeFunction(functionDef, input),
-  });
-
-  static layerLive = Layer.effect(
-    LocalFunctionExecutionService,
-    Effect.gen(function* () {
-      const resolver = yield* FunctionImplementationResolver;
-      return {
-        invokeFunction: Effect.fn('invokeFunction')(function* (functionDef, input) {
-          // TODO(dmaretskyi): Better error types
-          const resolved = yield* resolver.resolveFunctionImplementation(functionDef).pipe(Effect.orDie);
-          return yield* invokeFunction(resolved, 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
-    try {
-      const assertInput = functionDef.inputSchema.pipe(Schema.asserts);
-      (assertInput as any)(input);
-    } catch (e) {
-      throw new FunctionError({ message: 'Invalid function input', context: { name: functionDef.name }, cause: e });
-    }
-
-    const context: FunctionContext = {
-      space: undefined,
-      getService: () => todo(),
-      getSpace: async (_spaceId: any) => {
-        throw new Error('Not available. Use the database service instead.');
-      },
-    };
-
-    log.info('Invoking function', { name: functionDef.name, input });
-
-    // 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({ context: { name: functionDef.name }, cause: defect })),
-      ),
-    );
-
-    log.info('Function completed', { name: functionDef.name, input, data });
-
-    // Assert output matches schema
-    try {
-      const assertOutput = functionDef.outputSchema?.pipe(Schema.asserts);
-      (assertOutput as any)(data);
-    } catch (e) {
-      throw new FunctionError({ message: 'Invalid function output', context: { name: functionDef.name }, cause: e });
-    }
-
-    return data;
-  }).pipe(Effect.withSpan('invokeFunction', { attributes: { name: functionDef.name } }));
-
-export class FunctionImplementationResolver extends Context.Tag('@dxos/functions/FunctionImplementationResolver')<
-  FunctionImplementationResolver,
-  {
-    resolveFunctionImplementation(
-      functionDef: FunctionDefinition<any, any>,
-    ): Effect.Effect<FunctionDefinition<any, any>, FunctionNotFoundError>;
-  }
->() {
-  static layerTest = ({ functions }: { functions: FunctionDefinition<any, any>[] }) =>
-    Layer.succeed(FunctionImplementationResolver, {
-      resolveFunctionImplementation: (functionDef) => {
-        const resolved = functions.find((f) => f.name === functionDef.name);
-        if (!resolved) {
-          return Effect.fail(new FunctionNotFoundError(functionDef.name));
-        }
-        return Effect.succeed(resolved);
-      },
-    });
-}

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

@@ -1,46 +0,0 @@
-//
-// 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

@@ -1,114 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { type Context, Layer } from 'effect';
-
-import { AiService } from '@dxos/ai';
-import { entries } from '@dxos/util';
-
-import { ConfiguredCredentialsService, CredentialsService } from './credentials';
-import { DatabaseService } from './database';
-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.
-
-/**
- * List of all services.
- */
-const SERVICES = {
-  ai: AiService.AiService,
-  credentials: CredentialsService,
-  database: DatabaseService,
-  eventLogger: ComputeEventLogger,
-  functionCallService: RemoteFunctionExecutionService,
-  queues: QueueService,
-  tracing: TracingService,
-} as const satisfies Record<string, Context.TagClass<any, string, any>>;
-
-/**
- * Mapping of service names to their tags.
- */
-export type ServiceTagRecord = {
-  [K in keyof typeof SERVICES]: (typeof SERVICES)[K] extends { new (_: never): infer T } ? T : never;
-};
-
-/**
- * Mapping of service names to their runtime types.
- */
-export type ServiceRecord = {
-  [K in keyof ServiceTagRecord]: Context.Tag.Service<ServiceTagRecord[K]>;
-};
-
-/**
- * Union of all services tags.
- */
-export type Services = ServiceTagRecord[keyof ServiceTagRecord];
-
-const SERVICE_MAPPING: Record<string, keyof ServiceRecord> = Object.fromEntries(
-  entries(SERVICES).map(([name, tag]) => [tag.key, name]),
-);
-
-export const SERVICE_TAGS: Context.Tag<any, any>[] = Object.values(SERVICES);
-
-const DEFAULT_SERVICES: Partial<ServiceRecord> = {
-  tracing: TracingService.noop,
-};
-
-/**
- * @deprecated
- */
-export class ServiceContainer {
-  private _services: Partial<ServiceRecord> = { ...DEFAULT_SERVICES };
-
-  /**
-   * Set services.
-   * @param services - Services to set.
-   * @returns The container instance.
-   */
-  setServices(services: Partial<ServiceRecord>): this {
-    this._services = { ...this._services, ...services };
-    return this;
-  }
-
-  getService<Id, T>(tag: Context.Tag<Id, T>): T {
-    const serviceKey = SERVICE_MAPPING[tag.key];
-    const service = serviceKey != null ? this._services[serviceKey] : undefined;
-    if (!service) {
-      throw new Error(`Service not available: ${tag.key}`);
-    }
-
-    return service as T;
-  }
-
-  clone(): 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.
-  createLayer(): Layer.Layer<Services> {
-    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(),
-    );
-    const database =
-      this._services.database != null
-        ? Layer.succeed(DatabaseService, this._services.database)
-        : DatabaseService.notAvailable;
-    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(ComputeEventLogger, this._services.eventLogger ?? ComputeEventLogger.noop);
-    const functionCallService = Layer.succeed(
-      RemoteFunctionExecutionService,
-      this._services.functionCallService ?? RemoteFunctionExecutionService.mock(),
-    );
-
-    return Layer.mergeAll(ai, credentials, database, queues, tracing, eventLogger, functionCallService);
-  }
-}

package/src/services/service-registry.test.ts

@@ -1,42 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { describe, it } from '@effect/vitest';
-import { Context, Effect, Layer, Option } from 'effect';
-
-import { ServiceRegistry } from './service-registry';
-
-class MyTag extends Context.Tag('MyTag')<MyTag, { value: string }>() {}
-
-const mockRegistry = Layer.succeed(ServiceRegistry, {
-  resolve: (tag) => ((tag as any) === MyTag ? Option.some({ value: 'test' } as any) : Option.none()),
-});
-
-describe('ServiceRegistry', () => {
-  it.effect(
-    'provide',
-    Effect.fn(function* ({ expect }) {
-      const body = Effect.gen(function* () {
-        const { value } = yield* MyTag;
-        expect(value).toEqual('test');
-      });
-
-      const eff = body.pipe(ServiceRegistry.provide(MyTag));
-      yield* eff;
-    }, Effect.provide(mockRegistry)),
-  );
-
-  it.effect(
-    'provide or die',
-    Effect.fn(function* ({ expect }) {
-      const body = Effect.gen(function* () {
-        const { value } = yield* MyTag;
-        expect(value).toEqual('test');
-      });
-
-      const eff = body.pipe(ServiceRegistry.provideOrDie(MyTag));
-      yield* eff;
-    }, Effect.provide(mockRegistry)),
-  );
-});

package/src/services/service-registry.ts

@@ -1,59 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { Context, Effect, type Option, flow } from 'effect';
-
-import { ServiceNotAvailableError } from '../errors';
-
-export namespace ServiceRegistry {
-  export interface Service {
-    resolve: <T extends Context.Tag<any, any>>(tag: T) => Option.Option<Context.Tag.Service<T>>;
-  }
-}
-
-export class ServiceRegistry extends Context.Tag('@dxos/functions/ServiceRegistry')<
-  ServiceRegistry,
-  ServiceRegistry.Service
->() {
-  /**
-   * Resolves the service from the registry.
-   * @param tag Service tag to resolve.
-   * @throws {@link ServiceNotAvailableError} if the service is not found.
-   * @returns Effect that resolve to the service.
-   */
-  static resolve: <T extends Context.Tag<any, any>>(
-    tag: T,
-  ) => Effect.Effect<T, ServiceNotAvailableError, ServiceRegistry> = (tag) =>
-    ServiceRegistry.pipe(
-      Effect.flatMap((_) => _.resolve(tag)),
-      Effect.mapError(() => new ServiceNotAvailableError(tag.key)),
-    );
-
-  static provide: {
-    <Tags extends [Context.Tag<any, any>, ...Context.Tag<any, any>[]]>(
-      ...tags: Tags
-    ): <A, E, R>(
-      effect: Effect.Effect<A, E, R>,
-    ) => Effect.Effect<
-      A,
-      E | ServiceNotAvailableError,
-      Exclude<R, { [K in keyof Tags]: Context.Tag.Identifier<Tags[K]> }[number]> | ServiceRegistry
-    >;
-  } = (...tags) => (flow as any)(...tags.map((tag) => Effect.provideServiceEffect(tag, ServiceRegistry.resolve(tag))));
-
-  static provideOrDie: {
-    <Tags extends [Context.Tag<any, any>, ...Context.Tag<any, any>[]]>(
-      ...tags: Tags
-    ): <A, E, R>(
-      effect: Effect.Effect<A, E, R>,
-    ) => Effect.Effect<
-      A,
-      E,
-      Exclude<R, { [K in keyof Tags]: Context.Tag.Identifier<Tags[K]> }[number]> | ServiceRegistry
-    >;
-  } = (...tags) =>
-    (flow as any)(
-      ...tags.map((tag) => Effect.provideServiceEffect(tag, ServiceRegistry.resolve(tag).pipe(Effect.orDie))),
-    );
-}

package/src/testing/index.ts

@@ -1,6 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-export * from './services';
-export * from './layer';