@dxos/functions 0.8.4-main.72ec0f3 → 0.8.4-main.765dc60934

package/src/protocol/protocol.ts

@@ -2,44 +2,81 @@
 // Copyright 2025 DXOS.org
 //
 
+import * as AnthropicClient from '@effect/ai-anthropic/AnthropicClient';
 import * as Effect from 'effect/Effect';
 import * as Layer from 'effect/Layer';
+import * as Option from 'effect/Option';
 import * as Schema from 'effect/Schema';
 import * as SchemaAST from 'effect/SchemaAST';
 
-import { AiService } from '@dxos/ai';
-import { Type } from '@dxos/echo';
-import { EchoClient } from '@dxos/echo-db';
-import { acquireReleaseResource } from '@dxos/effect';
-import { failedInvariant, invariant } from '@dxos/invariant';
-import { PublicKey } from '@dxos/keys';
-import { type FunctionProtocol } from '@dxos/protocols';
+import { AiModelResolver, AiService, OpaqueToolkit } from '@dxos/ai';
+import { AnthropicResolver } from '@dxos/ai/resolvers';
+import {
+  FunctionError,
+  InvalidOperationInputError,
+  InvalidOperationOutputError,
+  Operation,
+  OperationRegistry,
+  Trace,
+} from '@dxos/compute';
+import { LifecycleState, Resource } from '@dxos/context';
+import { Database, Feed, JsonSchema, Ref, type Type } from '@dxos/echo';
+import { createFeedServiceLayer, EchoClient, type EchoDatabaseImpl, type QueueFactory } from '@dxos/echo-db';
+import { refFromEncodedReference } from '@dxos/echo/internal';
+import { runAndForwardErrors } from '@dxos/effect';
+import { assertState, failedInvariant, invariant } from '@dxos/invariant';
+import { PublicKey, type SpaceId } from '@dxos/keys';
+import { log } from '@dxos/log';
+import { EdgeFunctionEnv, ErrorCodec, type FunctionProtocol, type TraceProtocol } from '@dxos/protocols';
 
-import { FunctionError } from '../errors';
-import { FunctionDefinition, type FunctionServices } from '../sdk';
-import { CredentialsService, DatabaseService, FunctionInvocationService, TracingService } from '../services';
-import { QueueService } from '../services';
+import { type FunctionServices } from '../sdk';
+import {
+  configuredCredentialsLayer,
+  credentialsLayerFromDatabase,
+  FunctionInvocationService,
+  QueueService,
+} from '../services';
+import { FunctionsAiHttpClient } from './functions-ai-http-client';
+
+export interface FunctionWrappingOptions {
+  /**
+   * Additional types to register with the database.
+   */
+  types?: Type.AnyEntity[];
+
+  /**
+   * Toolkits to make available via the `OpaqueToolkitProvider`.
+   */
+  toolkits?: OpaqueToolkit.OpaqueToolkit[];
+}
 
 /**
  * Wraps a function handler made with `defineFunction` to a protocol that the functions-runtime expects.
  */
-export const wrapFunctionHandler = (func: FunctionDefinition): FunctionProtocol.Func => {
-  if (!FunctionDefinition.isFunction(func)) {
-    throw new TypeError('Invalid function definition');
+export const wrapFunctionHandler = (
+  func: Operation.WithHandler<Operation.Definition.Any>,
+  opts: FunctionWrappingOptions = {},
+): FunctionProtocol.Func => {
+  if (!Operation.isOperationWithHandler(func)) {
+    throw new TypeError('Expected operation with handler');
   }
 
+  const serviceTags = func.services.map((service) => service.key);
+
   return {
     meta: {
-      key: func.key,
-      name: func.name,
-      description: func.description,
-      inputSchema: Type.toJsonSchema(func.inputSchema),
-      outputSchema: func.outputSchema === undefined ? undefined : Type.toJsonSchema(func.outputSchema),
-      services: func.services,
+      key: func.meta.key,
+      name: func.meta.name,
+      description: func.meta.description,
+      inputSchema: JsonSchema.toJsonSchema(func.input),
+      outputSchema: func.output === undefined ? undefined : JsonSchema.toJsonSchema(func.output),
+      services: func.services.map((service) => service.key),
     },
     handler: async ({ data, context }) => {
       if (
-        (func.services.includes(DatabaseService.key) || func.services.includes(QueueService.key)) &&
+        (serviceTags.includes(Database.Service.key) ||
+          serviceTags.includes(QueueService.key) ||
+          serviceTags.includes(Feed.FeedService.key)) &&
         (!context.services.dataService || !context.services.queryService)
       ) {
         throw new FunctionError({
@@ -47,99 +84,357 @@ export const wrapFunctionHandler = (func: FunctionDefinition): FunctionProtocol.
         });
       }
 
+      // eslint-disable-next-line no-useless-catch
       try {
-        if (!SchemaAST.isAnyKeyword(func.inputSchema.ast)) {
-          Schema.validateSync(func.inputSchema)(data);
+        if (!SchemaAST.isAnyKeyword(func.input.ast)) {
+          try {
+            Schema.validateSync(func.input, { onExcessProperty: 'error' })(data);
+          } catch (error: any) {
+            throw new InvalidOperationInputError({
+              message: `Operation input did not match schema (${func.meta.key}): ${error.message}`,
+              cause: error,
+            });
+          }
         }
 
-        let result = await func.handler({
-          // TODO(dmaretskyi): Fix the types.
-          context: context as any,
-          data,
-        });
+        await using funcContext = await new FunctionContext(context, opts).open();
+
+        const types = [...(opts.types ?? []), ...(func.types ?? [])];
+        if (types.length > 0) {
+          invariant(funcContext.db, 'Database is required for functions with types');
+          await funcContext.db.graph.schemaRegistry.register(types as Type.AnyEntity[]);
+        }
+
+        const dataWithDecodedRefs =
+          funcContext.db && !SchemaAST.isAnyKeyword(func.input.ast)
+            ? decodeRefsFromSchema(func.input.ast, data, funcContext.db)
+            : data;
+
+        let result: any = await func.handler(dataWithDecodedRefs);
 
         if (Effect.isEffect(result)) {
-          result = await Effect.runPromise(
+          result = await runAndForwardErrors(
             (result as Effect.Effect<unknown, unknown, FunctionServices>).pipe(
               Effect.orDie,
-              Effect.provide(createServiceLayer(context)),
+              Effect.provide(funcContext.createLayer()),
             ),
           );
         }
 
-        if (func.outputSchema && !SchemaAST.isAnyKeyword(func.outputSchema.ast)) {
-          Schema.validateSync(func.outputSchema)(result);
+        // Flush in-memory ECHO writes before the function scope closes.
+        // Writes performed by `db.add` / `db.remove` are buffered in the in-memory
+        // `EchoDatabaseImpl` and only pushed across the `DataService` binding when
+        // `db.flush({ disk })` is called. `FunctionContext._close` (invoked by the
+        // `await using` above) calls `db.close()` but does NOT flush, so mutations
+        // performed by handlers that declare `Database.Service` (e.g. `object-create`,
+        // `object-update`, `relation-create`) would be silently dropped before reaching
+        // the edge `AutomergeReplicator`. Flushing here closes that hole.
+        if (serviceTags.includes(Database.Service.key) && funcContext.db) {
+          await funcContext.db.flush({ disk: true, indexes: false });
+        }
+
+        if (func.output && !SchemaAST.isAnyKeyword(func.output.ast)) {
+          try {
+            Schema.validateSync(func.output, { onExcessProperty: 'error' })(result);
+          } catch (error: any) {
+            throw new InvalidOperationOutputError({
+              message: `Operation output did not match schema (${func.meta.key}): ${error.message}`,
+              cause: error,
+            });
+          }
         }
 
         return result;
       } catch (error) {
-        if (FunctionError.is(error)) {
-          throw error;
-        } else {
-          throw new FunctionError({
-            cause: error,
-            context: { func: func.key },
-          });
-        }
+        // TODO(dmaretskyi): We might do error wrapping here and add extra context.
+        throw error;
       }
     },
   };
 };
 
 /**
- * Creates a layer of services for the function.
+ * Container for services and context for a function.
  */
-const createServiceLayer = (context: FunctionProtocol.Context): Layer.Layer<FunctionServices> => {
-  return Layer.unwrapScoped(
-    Effect.gen(function* () {
-      let client: EchoClient | undefined;
-
-      if (context.services.dataService && context.services.queryService) {
-        client = yield* acquireReleaseResource(() => {
-          invariant(context.services.dataService && context.services.queryService);
-          // TODO(dmaretskyi): Queues service.
-          return new EchoClient().connectToService({
-            dataService: context.services.dataService,
-            queryService: context.services.queryService,
-            queueService: context.services.queueService,
-          });
-        });
-      }
+class FunctionContext extends Resource {
+  readonly context: FunctionProtocol.Context;
+  readonly client: EchoClient | undefined;
+  db: EchoDatabaseImpl | undefined;
+  queues: QueueFactory | undefined;
+  readonly opts: FunctionWrappingOptions;
 
-      const db =
-        client && context.spaceId
-          ? yield* acquireReleaseResource(() =>
-              client.constructDatabase({
-                spaceId: context.spaceId ?? failedInvariant(),
-                spaceKey: PublicKey.fromHex(context.spaceKey ?? failedInvariant('spaceKey missing in context')),
-                reactiveSchemaQuery: false,
-              }),
-            )
-          : undefined;
-
-      if (db) {
-        console.log('Setting space root', context.spaceRootUrl);
-        yield* Effect.promise(() =>
-          db!.setSpaceRoot(context.spaceRootUrl ?? failedInvariant('spaceRootUrl missing in context')),
-        );
-      }
+  constructor(context: FunctionProtocol.Context, opts: FunctionWrappingOptions) {
+    super();
+    this.context = context;
+    this.opts = opts;
+    if (context.services.dataService && context.services.queryService) {
+      this.client = new EchoClient().connectToService({
+        dataService: context.services.dataService,
+        queryService: context.services.queryService,
+        queueService: context.services.queueService,
+      });
+    }
+  }
+
+  override async _open() {
+    await this.client?.open();
+    this.db =
+      this.client && this.context.spaceId
+        ? this.client.constructDatabase({
+            spaceId: this.context.spaceId ?? failedInvariant(),
+            spaceKey: PublicKey.fromHex(this.context.spaceKey ?? failedInvariant('spaceKey missing in context')),
+            reactiveSchemaQuery: false,
+            preloadSchemaOnOpen: false,
+          })
+        : undefined;
+
+    await this.db?.setSpaceRoot(this.context.spaceRootUrl ?? failedInvariant('spaceRootUrl missing in context'));
+    await this.db?.open();
+    this.queues =
+      this.client && this.context.spaceId ? this.client.constructQueueFactory(this.context.spaceId) : undefined;
+  }
+
+  override async _close() {
+    await this.db?.close();
+    await this.client?.close();
+  }
+
+  createLayer(): Layer.Layer<FunctionServices> {
+    assertState(this._lifecycleState === LifecycleState.OPEN, 'FunctionContext is not open');
+
+    const dbLayer = this.db ? Database.layer(this.db) : Database.notAvailable;
+    const queuesLayer = this.queues ? QueueService.layer(this.queues) : QueueService.notAvailable;
+    const feedLayer = this.queues ? createFeedServiceLayer(this.queues) : Feed.notAvailable;
+    const credentials = dbLayer
+      ? credentialsLayerFromDatabase({ caching: true }).pipe(Layer.provide(dbLayer))
+      : configuredCredentialsLayer([]);
+
+    const aiLayer = this.context.services.functionsAiService
+      ? InternalAiServiceLayer(this.context.services.functionsAiService)
+      : AiService.notAvailable;
+
+    const operationServiceLayer = this.context.services.functionsService
+      ? makeOperationServiceLayer(this.context.services.functionsService)
+      : unavailableOperationServiceLayer;
+
+    const operationRegistryLayer = this.context.services.functionsService
+      ? makeOperationRegistryLayer(this.context.services.functionsService, this.context.spaceId as SpaceId | undefined)
+      : emptyOperationRegistryLayer;
+
+    const traceWriterLayer = this.context.services.traceService
+      ? makeTraceWriterLayer(this.context.services.traceService)
+      : Trace.writerLayerNoop;
 
-      const queues = client && context.spaceId ? client.constructQueueFactory(context.spaceId) : undefined;
+    log('Creating function context layer', {
+      traceService: !!this.context.services.traceService,
+      functionsService: !!this.context.services.functionsService,
+      functionsAiService: !!this.context.services.functionsAiService,
+      spaceId: this.context.spaceId,
+      spaceRootUrl: this.context.spaceRootUrl,
+      toolkits: this.opts.toolkits?.length ?? 0,
+      types: this.opts.types?.length ?? 0,
+    });
 
-      const dbLayer = db ? DatabaseService.layer(db) : DatabaseService.notAvailable;
-      const queuesLayer = queues ? QueueService.layer(queues) : QueueService.notAvailable;
-      const credentials = dbLayer
-        ? CredentialsService.layerFromDatabase().pipe(Layer.provide(dbLayer))
-        : CredentialsService.configuredLayer([]);
-      const functionInvocationService = MockedFunctionInvocationService;
-      const aiService = AiService.notAvailable;
-      const tracing = TracingService.layerNoop;
+    return Layer.mergeAll(
+      dbLayer,
+      queuesLayer,
+      feedLayer,
+      credentials,
+      operationServiceLayer,
+      operationRegistryLayer,
+      aiLayer,
+      OpaqueToolkit.providerLayer(OpaqueToolkit.merge(...(this.opts.toolkits ?? []))),
+      traceWriterLayer,
 
-      return Layer.mergeAll(dbLayer, queuesLayer, credentials, functionInvocationService, aiService, tracing);
-    }),
+      // `FunctionInvocationService` is deprecated; new code should yield `Operation.Service`.
+      // The cloudflare wrapper provides only the unavailable layer to satisfy the (still-present)
+      // type union — handlers that yield it will die at invocation time.
+      FunctionInvocationService.layerNotAvailable,
+    );
+  }
+}
+
+/**
+ * Backs `Trace.TraceService` with the EDGE-provided `TraceService` so that operation
+ * handlers can write trace events that are forwarded to the runtime's trace sink.
+ */
+const makeTraceWriterLayer = (traceService: TraceProtocol.TraceService): Layer.Layer<Trace.TraceService> =>
+  Layer.succeed(Trace.TraceService, {
+    write: (eventType, payload) => {
+      log('Writing trace event', {
+        eventType: eventType.key,
+      });
+      traceService.write([
+        {
+          key: eventType.key,
+          isEphemeral: eventType.isEphemeral,
+          data: payload,
+        },
+      ]);
+    },
+  });
+
+/**
+ * AI service layer that proxies HTTP requests through the EDGE-provided `FunctionsAiService`.
+ */
+const InternalAiServiceLayer = (functionsAiService: EdgeFunctionEnv.FunctionsAiService) =>
+  AiModelResolver.AiModelResolver.buildAiService.pipe(
+    Layer.provide(
+      AnthropicResolver.make().pipe(
+        Layer.provide(
+          AnthropicClient.layer({
+            // Note: It doesn't matter what is base url here, it will be proxied to ai gateway in edge.
+            apiUrl: 'http://internal/provider/anthropic',
+          }).pipe(Layer.provide(FunctionsAiHttpClient.layer(functionsAiService))),
+        ),
+      ),
+    ),
   );
+
+/**
+ * Backs `Operation.Service` with the EDGE-provided `FunctionsService` so that operation
+ * handlers can invoke other deployed operations remotely. The `deployedId` on the operation
+ * definition is used as the routing key.
+ */
+const makeOperationServiceLayer = (
+  functionsService: EdgeFunctionEnv.FunctionsService,
+): Layer.Layer<Operation.Service> => {
+  const invokeRemote = async (
+    op: Operation.Definition.Any,
+    input: unknown,
+    options?: Operation.InvokeOptions,
+  ): Promise<{ data?: unknown; error?: Error }> => {
+    invariant(op.meta.deployedId, `Operation '${op.meta.key}' has no deployedId; cannot invoke remotely.`);
+    const result = await functionsService.invoke(op.meta.deployedId, input, {
+      spaceId: options?.spaceId,
+    });
+    if (result._kind === 'success') {
+      return { data: result.data };
+    }
+    return { error: ErrorCodec.decode(result.error) };
+  };
+
+  return Layer.succeed(Operation.Service, {
+    invoke: ((op: Operation.Definition.Any, input: unknown, options?: Operation.InvokeOptions) =>
+      Effect.tryPromise(() => invokeRemote(op, input, options)).pipe(
+        Effect.orDie,
+        Effect.flatMap((outcome) =>
+          outcome.error ? Effect.die(outcome.error) : Effect.succeed(outcome.data as never),
+        ),
+      )) as Operation.OperationService['invoke'],
+    schedule: ((op: Operation.Definition.Any, input: unknown) =>
+      Effect.sync(() => {
+        invariant(op.meta.deployedId, `Operation '${op.meta.key}' has no deployedId; cannot schedule remotely.`);
+        // Fire and forget — schedule is intentionally non-awaiting.
+        void functionsService.invoke(op.meta.deployedId, input).catch(() => {
+          // Swallow errors — schedule is observability-only.
+        });
+      })) as Operation.OperationService['schedule'],
+    invokePromise: ((op: Operation.Definition.Any, input: unknown, options?: Operation.InvokeOptions) =>
+      invokeRemote(op, input, options).catch((error: unknown) => ({
+        error: error instanceof Error ? error : new Error(String(error)),
+      }))) as Operation.OperationService['invokePromise'],
+  } satisfies Operation.OperationService);
 };
 
-const MockedFunctionInvocationService = Layer.succeed(FunctionInvocationService, {
-  invokeFunction: () => Effect.die('Calling functions from functions is not implemented yet.'),
+const unavailableOperationServiceLayer = Layer.succeed(Operation.Service, {
+  invoke: () => Effect.die('Operation.Service is not available: missing functionsService in EDGE context.'),
+  schedule: () => Effect.die('Operation.Service is not available: missing functionsService in EDGE context.'),
+  invokePromise: async () => ({
+    error: new Error('Operation.Service is not available: missing functionsService in EDGE context.'),
+  }),
+} as Operation.OperationService);
+
+/**
+ * Backs `OperationRegistry.Service` with the EDGE-provided `FunctionsService.query`. Returns
+ * the first persistent operation matching the requested key, or `Option.none()` when not found.
+ */
+const makeOperationRegistryLayer = (
+  functionsService: EdgeFunctionEnv.FunctionsService,
+  spaceId: SpaceId | undefined,
+): Layer.Layer<OperationRegistry.Service> =>
+  Layer.succeed(OperationRegistry.Service, {
+    resolve: (key: string) =>
+      Effect.gen(function* () {
+        const records = yield* Effect.tryPromise(() => functionsService.query({ spaceId })).pipe(Effect.orDie);
+        const match = (records as Operation.PersistentOperation[]).find((record) => Operation.getKey(record) === key);
+        return match ? Option.some(Operation.deserialize(match)) : Option.none();
+      }),
+  });
+
+const emptyOperationRegistryLayer = Layer.succeed(OperationRegistry.Service, {
+  resolve: () => Effect.succeed(Option.none()),
 });
+
+const decodeRefsFromSchema = (ast: SchemaAST.AST, value: unknown, db: EchoDatabaseImpl): unknown => {
+  if (value == null) {
+    return value;
+  }
+
+  const encoded = SchemaAST.encodedBoundAST(ast);
+  if (Ref.isRefType(encoded)) {
+    if (Ref.isRef(value)) {
+      return value;
+    }
+
+    if (typeof value === 'object' && value !== null && typeof (value as any)['/'] === 'string') {
+      const resolver = db.graph.createRefResolver({ context: { space: db.spaceId } });
+      return refFromEncodedReference(value as any, resolver);
+    }
+
+    return value;
+  }
+
+  switch (encoded._tag) {
+    case 'TypeLiteral': {
+      if (typeof value !== 'object' || value === null || Array.isArray(value)) {
+        return value;
+      }
+      const result: Record<string, unknown> = { ...(value as any) };
+      for (const prop of SchemaAST.getPropertySignatures(encoded)) {
+        const key = prop.name.toString();
+        if (key in result) {
+          result[key] = decodeRefsFromSchema(prop.type, (result as any)[key], db);
+        }
+      }
+      return result;
+    }
+
+    case 'TupleType': {
+      if (!Array.isArray(value)) {
+        return value;
+      }
+
+      // For arrays, effect uses TupleType with empty elements and a single rest element.
+      if (encoded.elements.length === 0 && encoded.rest.length === 1) {
+        const elementType = encoded.rest[0].type;
+        return (value as unknown[]).map((item) => decodeRefsFromSchema(elementType, item, db));
+      }
+
+      return value;
+    }
+
+    case 'Union': {
+      // Optional values are represented as union with undefined.
+      const nonUndefined = encoded.types.filter((t) => !SchemaAST.isUndefinedKeyword(t));
+      if (nonUndefined.length === 1) {
+        return decodeRefsFromSchema(nonUndefined[0], value, db);
+      }
+
+      // For other unions we can't safely pick a branch without validating.
+      return value;
+    }
+
+    case 'Suspend': {
+      return decodeRefsFromSchema(encoded.f(), value, db);
+    }
+
+    case 'Refinement': {
+      return decodeRefsFromSchema(encoded.from, value, db);
+    }
+
+    default: {
+      return value;
+    }
+  }
+};