@dxos/functions 0.8.4-main.dedc0f3 → 0.8.4-main.dfabb4ec29

package/src/services/event-logger.ts

@@ -1,118 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { Context, Effect, Layer, Schema } from 'effect';
-
-import { Obj, Type } from '@dxos/echo';
-import { invariant } from '@dxos/invariant';
-import { LogLevel, log } from '@dxos/log';
-
-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 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<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* ComputeEventLogger;
-    if (!logger.nodeId) {
-      throw new Error('logCustomEvent must be called within a node compute function');
-    }
-    logger.log({
-      type: 'custom',
-      nodeId: logger.nodeId,
-      event: data,
-    });
-  });
-
-export const createDefectLogger = <A, E, R>(): ((self: Effect.Effect<A, E, R>) => Effect.Effect<A, E, R>) =>
-  Effect.catchAll((error) =>
-    Effect.gen(function* () {
-      log.error('unhandled effect error', { error });
-      throw error;
-    }),
-  );
-
-export const createEventLogger = (
-  level: LogLevel,
-  message: string = 'event',
-): Context.Tag.Service<ComputeEventLogger> => {
-  const logFunction = (
-    {
-      [LogLevel.WARN]: log.warn,
-      [LogLevel.VERBOSE]: log.verbose,
-      [LogLevel.DEBUG]: log.debug,
-      [LogLevel.INFO]: log.info,
-      [LogLevel.ERROR]: log.error,
-    } as any
-  )[level];
-  invariant(logFunction);
-  return {
-    log: (event: ComputeEventPayload) => {
-      logFunction(message, event);
-    },
-    nodeId: undefined,
-  };
-};

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

@@ -1,114 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { Context, Effect, Layer, Schema } from 'effect';
-
-import { todo } from '@dxos/debug';
-
-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
-    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 } }));
-
-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';

package/src/testing/layer.ts

@@ -1,111 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import type { Schema } from 'effect';
-import { Context, Effect, Layer } from 'effect';
-
-import type { EchoDatabaseImpl, QueueFactory } from '@dxos/echo-db';
-import { EchoTestBuilder } from '@dxos/echo-db/testing';
-import type { EchoHostIndexingConfig } from '@dxos/echo-pipeline';
-import { accuireReleaseResource } from '@dxos/effect';
-import { PublicKey } from '@dxos/keys';
-import type { LevelDB } from '@dxos/kv-store';
-import { createTestLevel } from '@dxos/kv-store/testing';
-import { log } from '@dxos/log';
-
-import { DatabaseService, QueueService } from '../services';
-
-const testBuilder = accuireReleaseResource(() => new EchoTestBuilder());
-
-export const testStoragePath = ({ name = PublicKey.random().toHex() }: { name?: string }) => {
-  return `/tmp/dxos-${name}`;
-};
-
-export type TestDatabaseOptions = {
-  indexing?: Partial<EchoHostIndexingConfig>;
-  types?: Schema.Schema.AnyNoContext[];
-  storagePath?: string;
-  onInit?: () => Effect.Effect<void, never, DatabaseService | QueueService>;
-};
-
-export const TestDatabaseLayer = ({ indexing, types, storagePath, onInit }: TestDatabaseOptions = {}) =>
-  Layer.scopedContext(
-    Effect.gen(function* () {
-      const builder = yield* testBuilder;
-
-      let kv: LevelDB | undefined;
-      if (storagePath) {
-        kv = createTestLevel(storagePath);
-        yield* Effect.promise(() => kv!.open());
-        // const keyCount = yield* Effect.promise(async () => (await kv!.iterator({ values: false }).all()).length);
-        // log.info('opened test db', { storagePath, keyCount });
-      }
-      const peer = yield* Effect.promise(() => builder.createPeer({ indexing, types, kv }));
-
-      let db: EchoDatabaseImpl | undefined;
-      let queues: QueueFactory | undefined;
-
-      if (storagePath) {
-        const testMetadata = yield* Effect.promise(async () => {
-          try {
-            return await kv!.get('test-metadata', { valueEncoding: 'json' });
-          } catch (e) {
-            if ((e as any).code === 'LEVEL_NOT_FOUND') {
-              return undefined;
-            }
-            throw e;
-          }
-        });
-        log('starting persistant test db', { storagePath, testMetadata });
-        if (!testMetadata) {
-          const key = PublicKey.random();
-          db = yield* Effect.promise(() => peer.createDatabase(key));
-          queues = peer.client.constructQueueFactory(db.spaceId);
-
-          yield* Effect.promise(() =>
-            kv!.put('test-metadata', { key: key.toHex(), rootUrl: db!.rootUrl }, { valueEncoding: 'json' }),
-          );
-
-          if (onInit) {
-            yield* onInit().pipe(
-              Effect.provideService(DatabaseService, DatabaseService.make(db)),
-              Effect.provideService(QueueService, QueueService.make(queues, undefined)),
-            );
-          }
-        } else {
-          const key = PublicKey.from((testMetadata as any).key);
-          const rootUrl = (testMetadata as any).rootUrl;
-          db = yield* Effect.promise(() => peer.openDatabase(key, rootUrl));
-          queues = peer.client.constructQueueFactory(db.spaceId);
-        }
-      } else {
-        db = yield* Effect.promise(() => peer.createDatabase());
-        queues = peer.client.constructQueueFactory(db.spaceId);
-        if (onInit) {
-          yield* onInit().pipe(
-            Effect.provideService(DatabaseService, DatabaseService.make(db)),
-            Effect.provideService(QueueService, QueueService.make(queues, undefined)),
-          );
-        }
-      }
-
-      yield* Effect.addFinalizer(() =>
-        Effect.promise(async () => {
-          if (kv) {
-            // {
-            //   const keyCount = (await kv.iterator({ values: false }).all()).length;
-            //   log.info('closing persistant test db', { storagePath, keyCount });
-            // }
-
-            await kv.close();
-          }
-        }),
-      );
-
-      return Context.mergeAll(
-        Context.make(DatabaseService, DatabaseService.make(db)),
-        Context.make(QueueService, QueueService.make(queues, undefined)),
-      );
-    }),
-  );

package/src/testing/logger.ts

@@ -1,16 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { type Context, Effect } from 'effect';
-
-import { LogLevel } from '@dxos/log';
-
-import { type ComputeEventLogger, createEventLogger } from '../services';
-
-export const noopLogger: Context.Tag.Service<ComputeEventLogger> = {
-  log: () => Effect.succeed(undefined),
-  nodeId: undefined,
-};
-
-export const consoleLogger: Context.Tag.Service<ComputeEventLogger> = createEventLogger(LogLevel.INFO);