@dxos/functions-runtime-cloudflare 0.8.4-main.66e292d → 0.8.4-main.69d29f4

package/package.json

@@ -1,9 +1,13 @@
 {
   "name": "@dxos/functions-runtime-cloudflare",
-  "version": "0.8.4-main.66e292d",
+  "version": "0.8.4-main.69d29f4",
   "description": "Functions runtime for Cloudflare.",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/dxos/dxos"
+  },
   "license": "MIT",
   "author": "info@dxos.org",
   "sideEffects": false,
@@ -23,22 +27,23 @@
     "src"
   ],
   "dependencies": {
-    "effect": "3.18.3",
-    "@dxos/codec-protobuf": "0.8.4-main.66e292d",
-    "@dxos/context": "0.8.4-main.66e292d",
-    "@dxos/debug": "0.8.4-main.66e292d",
-    "@dxos/echo": "0.8.4-main.66e292d",
-    "@dxos/echo-protocol": "0.8.4-main.66e292d",
-    "@dxos/echo-db": "0.8.4-main.66e292d",
-    "@dxos/invariant": "0.8.4-main.66e292d",
-    "@dxos/keys": "0.8.4-main.66e292d",
-    "@dxos/log": "0.8.4-main.66e292d",
-    "@dxos/util": "0.8.4-main.66e292d",
-    "@dxos/protocols": "0.8.4-main.66e292d"
+    "effect": "3.19.11",
+    "@dxos/debug": "0.8.4-main.69d29f4",
+    "@dxos/context": "0.8.4-main.69d29f4",
+    "@dxos/echo": "0.8.4-main.69d29f4",
+    "@dxos/echo-db": "0.8.4-main.69d29f4",
+    "@dxos/codec-protobuf": "0.8.4-main.69d29f4",
+    "@dxos/echo-protocol": "0.8.4-main.69d29f4",
+    "@dxos/errors": "0.8.4-main.69d29f4",
+    "@dxos/invariant": "0.8.4-main.69d29f4",
+    "@dxos/log": "0.8.4-main.69d29f4",
+    "@dxos/keys": "0.8.4-main.69d29f4",
+    "@dxos/protocols": "0.8.4-main.69d29f4",
+    "@dxos/util": "0.8.4-main.69d29f4"
   },
   "devDependencies": {
-    "@cloudflare/workers-types": "4.20251106.1",
-    "@dxos/types": "0.8.4-main.66e292d"
+    "@cloudflare/workers-types": "^4.20251210.0",
+    "@dxos/types": "0.8.4-main.69d29f4"
   },
   "publishConfig": {
     "access": "public"

package/src/functions-client.ts

@@ -14,6 +14,7 @@ import { SpaceProxy } from './space-proxy';
 type Services = {
   dataService: EdgeFunctionEnv.DataService;
   queueService: EdgeFunctionEnv.QueueService;
+  functionsAiService: EdgeFunctionEnv.FunctionsAiService;
 };
 
 /**
@@ -31,7 +32,12 @@ export class FunctionsClient extends Resource {
     super();
     invariant(typeof services.dataService !== 'undefined', 'DataService is required');
     invariant(typeof services.queueService !== 'undefined', 'QueueService is required');
-    this._serviceContainer = new ServiceContainer(this._executionContext, services.dataService, services.queueService);
+    this._serviceContainer = new ServiceContainer(
+      this._executionContext,
+      services.dataService,
+      services.queueService,
+      services.functionsAiService,
+    );
     this._echoClient = new EchoClient({});
   }
 
@@ -69,6 +75,7 @@ export const createClientFromEnv = async (env: any): Promise<FunctionsClient> =>
   const client = new FunctionsClient({
     dataService: env.DATA_SERVICE,
     queueService: env.QUEUE_SERVICE,
+    functionsAiService: env.FUNCTIONS_AI_SERVICE,
   });
   await client.open();
   return client;

package/src/index.ts

@@ -2,5 +2,8 @@
 // Copyright 2024 DXOS.org
 //
 
-export { wrapHandlerForCloudflare } from './wrap-handler-for-cloudflare';
+export * from './functions-client';
+export * from './internal';
 export * from './types';
+export * from './wrap-handler-for-cloudflare';
+export * from './logger';

package/src/internal/data-service-impl.ts

@@ -5,12 +5,15 @@
 import type { RequestOptions } from '@dxos/codec-protobuf';
 import { Stream } from '@dxos/codec-protobuf/stream';
 import { raise } from '@dxos/debug';
+import { NotImplementedError, RuntimeServiceError } from '@dxos/errors';
 import { invariant } from '@dxos/invariant';
 import { SpaceId } from '@dxos/keys';
 import { log } from '@dxos/log';
 import { type EdgeFunctionEnv } from '@dxos/protocols';
 import type {
   BatchedDocumentUpdates,
+  CreateDocumentRequest,
+  CreateDocumentResponse,
   DataService as DataServiceProto,
   GetDocumentHeadsRequest,
   GetDocumentHeadsResponse,
@@ -21,6 +24,8 @@ import type {
   UpdateSubscriptionRequest,
 } from '@dxos/protocols/proto/dxos/echo/service';
 
+import { copyUint8Array } from './utils';
+
 export class DataServiceImpl implements DataServiceProto {
   private dataSubscriptions = new Map<string, { spaceId: SpaceId; next: (msg: BatchedDocumentUpdates) => void }>();
 
@@ -40,54 +45,98 @@ export class DataServiceImpl implements DataServiceProto {
     });
   }
 
-  async updateSubscription({ subscriptionId, addIds, removeIds }: UpdateSubscriptionRequest): Promise<void> {
-    const sub = this.dataSubscriptions.get(subscriptionId) ?? raise(new Error('Subscription not found'));
+  async updateSubscription({ subscriptionId, addIds }: UpdateSubscriptionRequest): Promise<void> {
+    const sub =
+      this.dataSubscriptions.get(subscriptionId) ??
+      raise(
+        new RuntimeServiceError({
+          message: 'Subscription not found.',
+          context: { subscriptionId },
+        }),
+      );
 
     if (addIds) {
       log.info('request documents', { count: addIds.length });
       // TODO(dmaretskyi): Batch.
       for (const documentId of addIds) {
-        const document = await this._dataService.getDocument(this._executionContext, sub.spaceId, documentId);
+        using document = await this._dataService.getDocument(this._executionContext, sub.spaceId, documentId);
         log.info('document loaded', { documentId, spaceId: sub.spaceId, found: !!document });
         if (!document) {
           log.warn('not found', { documentId });
           continue;
         }
-        sub.next({ updates: [{ documentId, mutation: document.data }] });
+        sub.next({
+          updates: [
+            {
+              documentId,
+              // Copy returned object to avoid hanging RPC stub
+              // See https://developers.cloudflare.com/workers/runtime-apis/rpc/lifecycle/
+              mutation: copyUint8Array(document.data),
+            },
+          ],
+        });
       }
     }
   }
 
+  async createDocument({ spaceId, initialValue }: CreateDocumentRequest): Promise<CreateDocumentResponse> {
+    using response = await this._dataService.createDocument(this._executionContext, { spaceId, initialValue });
+    return { documentId: response.documentId };
+  }
+
   async update({ updates, subscriptionId }: UpdateRequest): Promise<void> {
-    const sub = this.dataSubscriptions.get(subscriptionId) ?? raise(new Error('Subscription not found'));
+    const sub =
+      this.dataSubscriptions.get(subscriptionId) ??
+      raise(
+        new RuntimeServiceError({
+          message: 'Subscription not found.',
+          context: { subscriptionId },
+        }),
+      );
     // TODO(dmaretskyi): Batch.
-    for (const update of updates ?? []) {
-      await this._dataService.changeDocument(this._executionContext, sub.spaceId, update.documentId, update.mutation);
+    try {
+      for (const update of updates ?? []) {
+        await this._dataService.changeDocument(this._executionContext, sub.spaceId, update.documentId, update.mutation);
+      }
+    } catch (error) {
+      throw RuntimeServiceError.wrap({
+        message: 'Failed to apply document updates.',
+        context: { subscriptionId },
+        ifTypeDiffers: true,
+      })(error);
     }
-    throw new Error('Method not implemented.');
   }
 
   async flush(): Promise<void> {
     // No-op.
   }
 
-  subscribeSpaceSyncState(request: GetSpaceSyncStateRequest, options?: RequestOptions): Stream<SpaceSyncState> {
-    throw new Error('Method not implemented.');
+  subscribeSpaceSyncState(_request: GetSpaceSyncStateRequest, _options?: RequestOptions): Stream<SpaceSyncState> {
+    throw new NotImplementedError({
+      message: 'subscribeSpaceSyncState is not implemented.',
+    });
   }
 
-  async getDocumentHeads({ documentIds }: GetDocumentHeadsRequest): Promise<GetDocumentHeadsResponse> {
-    throw new Error('Method not implemented.');
+  async getDocumentHeads({ documentIds: _documentIds }: GetDocumentHeadsRequest): Promise<GetDocumentHeadsResponse> {
+    throw new NotImplementedError({
+      message: 'getDocumentHeads is not implemented.',
+    });
   }
 
-  async reIndexHeads({ documentIds }: ReIndexHeadsRequest): Promise<void> {
-    throw new Error('Method not implemented.');
+  async reIndexHeads({ documentIds: _documentIds }: ReIndexHeadsRequest): Promise<void> {
+    throw new NotImplementedError({
+      message: 'reIndexHeads is not implemented.',
+    });
   }
 
   async updateIndexes(): Promise<void> {
-    throw new Error('Method not implemented.');
+    log.error('updateIndexes is not available in EDGE env.');
+    // No-op.
   }
 
-  async waitUntilHeadsReplicated({ heads }: { heads: any }): Promise<void> {
-    throw new Error('Method not implemented.');
+  async waitUntilHeadsReplicated({ heads: _heads }: { heads: any }): Promise<void> {
+    throw new NotImplementedError({
+      message: 'waitUntilHeadsReplicated is not implemented.',
+    });
   }
 }

package/src/internal/query-service-impl.ts

@@ -6,6 +6,7 @@ import * as Schema from 'effect/Schema';
 
 import { Stream } from '@dxos/codec-protobuf/stream';
 import { QueryAST } from '@dxos/echo-protocol';
+import { NotImplementedError, RuntimeServiceError } from '@dxos/errors';
 import { invariant } from '@dxos/invariant';
 import { PublicKey } from '@dxos/keys';
 import { SpaceId } from '@dxos/keys';
@@ -19,8 +20,11 @@ import {
 } from '@dxos/protocols/proto/dxos/echo/query';
 
 import { queryToDataServiceRequest } from './adapter';
+import { copyUint8Array } from './utils';
 
 export class QueryServiceImpl implements QueryServiceProto {
+  private _queryCount = 0;
+
   constructor(
     private readonly _executionContext: EdgeFunctionEnv.ExecutionContext,
     private readonly _dataService: EdgeFunctionEnv.DataService,
@@ -36,8 +40,9 @@ export class QueryServiceImpl implements QueryServiceProto {
     return Stream.fromPromise<QueryResponse>(
       (async () => {
         try {
+          this._queryCount++;
           log.info('begin query', { spaceId });
-          const queryResponse = await this._dataService.queryDocuments(
+          using queryResponse = await this._dataService.queryDocuments(
             this._executionContext,
             queryToDataServiceRequest(query),
           );
@@ -49,25 +54,36 @@ export class QueryServiceImpl implements QueryServiceProto {
                 spaceId,
                 spaceKey: PublicKey.ZERO,
                 documentId: object.document.documentId,
-                rank: 0,
-                documentAutomerge: object.document.data,
+                // Rank 1 for predicate matches where ranking is not determined.
+                rank: 1,
+                // Copy returned object to avoid hanging RPC stub.
+                // See https://developers.cloudflare.com/workers/runtime-apis/rpc/lifecycle/
+                documentAutomerge: copyUint8Array(object.document.data),
               }),
             ),
           } satisfies QueryResponse;
-        } catch (err) {
-          log.error('query failed', { err });
-          throw err;
+        } catch (error) {
+          log.error('query failed', { err: error });
+          throw new RuntimeServiceError({
+            message: `Query execution failed (queryCount=${this._queryCount})`,
+            context: { spaceId, filter: request.filter, queryCount: this._queryCount },
+            cause: error,
+          });
         }
       })(),
     );
   }
 
   async reindex() {
-    throw new Error('Method not implemented.');
+    throw new NotImplementedError({
+      message: 'Reindex is not implemented.',
+    });
   }
 
   async setConfig() {
-    throw new Error('Method not implemented.');
+    throw new NotImplementedError({
+      message: 'SetConfig is not implemented.',
+    });
   }
 }
 

package/src/internal/queue-service-impl.ts

@@ -2,22 +2,68 @@
 // Copyright 2025 DXOS.org
 //
 
-import type { ObjectId, SpaceId } from '@dxos/keys';
+import { NotImplementedError, RuntimeServiceError } from '@dxos/errors';
+import { invariant } from '@dxos/invariant';
 import { type QueueService as QueueServiceProto } from '@dxos/protocols';
-import type { EdgeFunctionEnv, QueryResult, QueueQuery } from '@dxos/protocols';
+import type {
+  DeleteFromQueueRequest,
+  EdgeFunctionEnv,
+  InsertIntoQueueRequest,
+  QueryQueueRequest,
+  QueryResult,
+} from '@dxos/protocols';
 
 export class QueueServiceImpl implements QueueServiceProto {
   constructor(
     protected _ctx: EdgeFunctionEnv.ExecutionContext,
     private readonly _queueService: EdgeFunctionEnv.QueueService,
   ) {}
-  queryQueue(subspaceTag: string, spaceId: SpaceId, { queueId, ...query }: QueueQuery): Promise<QueryResult> {
-    return this._queueService.query(this._ctx, `dxn:queue:${subspaceTag}:${spaceId}:${queueId}`, query);
+  async queryQueue(request: QueryQueueRequest): Promise<QueryResult> {
+    const { query } = request;
+    const { queueIds, ...filter } = query!;
+    const spaceId = query!.spaceId;
+    const queueId = queueIds?.[0];
+    invariant(request.query.queuesNamespace);
+    try {
+      using result = await this._queueService.query(
+        this._ctx,
+        `dxn:queue:${request.query.queuesNamespace}:${spaceId}:${queueId}`,
+        filter,
+      );
+      return {
+        // Copy returned object to avoid hanging RPC stub
+        // See https://developers.cloudflare.com/workers/runtime-apis/rpc/lifecycle/
+        objects: structuredClone(result.objects),
+        nextCursor: result.nextCursor,
+        prevCursor: result.prevCursor,
+      };
+    } catch (error) {
+      throw RuntimeServiceError.wrap({
+        message: 'Queue query failed.',
+        context: { subspaceTag: request.query.queuesNamespace, spaceId, queueId },
+        ifTypeDiffers: true,
+      })(error);
+    }
   }
-  insertIntoQueue(subspaceTag: string, spaceId: SpaceId, queueId: ObjectId, objects: unknown[]): Promise<void> {
-    return this._queueService.append(this._ctx, `dxn:queue:${subspaceTag}:${spaceId}:${queueId}`, objects);
+
+  async insertIntoQueue(request: InsertIntoQueueRequest): Promise<void> {
+    const { subspaceTag, spaceId, queueId, objects } = request;
+    try {
+      await this._queueService.append(this._ctx, `dxn:queue:${subspaceTag}:${spaceId}:${queueId}`, objects ?? []);
+    } catch (error) {
+      throw RuntimeServiceError.wrap({
+        message: 'Queue append failed.',
+        context: { subspaceTag, spaceId, queueId },
+        ifTypeDiffers: true,
+      })(error);
+    }
   }
-  deleteFromQueue(subspaceTag: string, spaceId: SpaceId, queueId: ObjectId, objectIds: ObjectId[]): Promise<void> {
-    throw new Error('Deleting from queue is not supported.');
+
+  deleteFromQueue(request: DeleteFromQueueRequest): Promise<void> {
+    const { subspaceTag, spaceId, queueId } = request;
+    throw new NotImplementedError({
+      message: 'Deleting from queue is not supported.',
+      context: { subspaceTag, spaceId, queueId },
+    });
   }
 }

package/src/internal/service-container.ts

@@ -2,7 +2,7 @@
 // Copyright 2024 DXOS.org
 //
 
-import type { HasId } from '@dxos/echo/internal';
+import { type AnyEntity } from '@dxos/echo/internal';
 import { type DXN, type SpaceId } from '@dxos/keys';
 import type { QueryResult } from '@dxos/protocols';
 import { type EdgeFunctionEnv } from '@dxos/protocols';
@@ -22,16 +22,26 @@ export class ServiceContainer {
     private readonly _executionContext: EdgeFunctionEnv.ExecutionContext,
     private readonly _dataService: EdgeFunctionEnv.DataService,
     private readonly _queueService: EdgeFunctionEnv.QueueService,
+    private readonly _functionsService: EdgeFunctionEnv.FunctionsAiService,
   ) {}
 
   async getSpaceMeta(spaceId: SpaceId): Promise<EdgeFunctionEnv.SpaceMeta | undefined> {
-    return this._dataService.getSpaceMeta(this._executionContext, spaceId);
+    using result = await this._dataService.getSpaceMeta(this._executionContext, spaceId);
+    // Copy returned object to avoid hanging RPC stub
+    // See https://developers.cloudflare.com/workers/runtime-apis/rpc/lifecycle/
+    return result
+      ? {
+          spaceKey: result.spaceKey,
+          rootDocumentId: result.rootDocumentId,
+        }
+      : undefined;
   }
 
   async createServices(): Promise<{
     dataService: DataServiceProto;
     queryService: QueryServiceProto;
     queueService: QueueServiceProto;
+    functionsAiService: EdgeFunctionEnv.FunctionsAiService;
   }> {
     const dataService = new DataServiceImpl(this._executionContext, this._dataService);
     const queryService = new QueryServiceImpl(this._executionContext, this._dataService);
@@ -41,14 +51,23 @@ export class ServiceContainer {
       dataService,
       queryService,
       queueService,
+      functionsAiService: this._functionsService,
     };
   }
 
-  queryQueue(queue: DXN): Promise<QueryResult> {
-    return this._queueService.query({}, queue.toString(), {});
+  async queryQueue(queue: DXN): Promise<QueryResult> {
+    const { spaceId } = queue.asQueueDXN() ?? {};
+    using result = (await this._queueService.query({}, queue.toString(), { spaceId: spaceId! })) as any;
+    // Copy returned object to avoid hanging RPC stub
+    // See https://developers.cloudflare.com/workers/runtime-apis/rpc/lifecycle/
+    return {
+      objects: structuredClone(result.objects),
+      nextCursor: result.nextCursor ?? null,
+      prevCursor: result.prevCursor ?? null,
+    };
   }
 
-  insertIntoQueue(queue: DXN, objects: HasId[]): Promise<void> {
-    return this._queueService.append({}, queue.toString(), objects);
+  async insertIntoQueue(queue: DXN, objects: AnyEntity[]): Promise<void> {
+    await this._queueService.append({}, queue.toString(), objects);
   }
 }

package/src/internal/utils.ts

@@ -0,0 +1,5 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+export const copyUint8Array = (value: Uint8Array): Uint8Array => new Uint8Array(value);

package/src/logger.ts

@@ -0,0 +1,42 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+/* eslint-disable no-console */
+
+import { LogLevel, type LogProcessor, log, shouldLog } from '@dxos/log';
+
+export const setupFunctionsLogger = () => {
+  log.runtimeConfig.processors.length = 0;
+  log.runtimeConfig.processors.push(functionLogProcessor);
+};
+
+const functionLogProcessor: LogProcessor = (config, entry) => {
+  if (!shouldLog(entry, config.filters)) {
+    return;
+  }
+
+  switch (entry.level) {
+    case LogLevel.DEBUG:
+      console.debug(entry.message, entry.context);
+      break;
+    case LogLevel.TRACE:
+      console.debug(entry.message, entry.context);
+      break;
+    case LogLevel.VERBOSE:
+      console.log(entry.message, entry.context);
+      break;
+    case LogLevel.INFO:
+      console.info(entry.message, entry.context);
+      break;
+    case LogLevel.WARN:
+      console.warn(entry.message, entry.context);
+      break;
+    case LogLevel.ERROR:
+      console.error(entry.message, entry.context);
+      break;
+    default:
+      console.log(entry.message, entry.context);
+      break;
+  }
+};

package/src/queues-api.ts

@@ -2,7 +2,7 @@
 // Copyright 2025 DXOS.org
 //
 
-import type { HasId } from '@dxos/echo/internal';
+import { type AnyEntity } from '@dxos/echo/internal';
 import type { DXN, SpaceId } from '@dxos/keys';
 import type { QueryResult } from '@dxos/protocols';
 
@@ -15,7 +15,7 @@ import type { ServiceContainer } from './internal';
  */
 export interface QueuesAPI {
   queryQueue(queue: DXN, options?: {}): Promise<QueryResult>;
-  insertIntoQueue(queue: DXN, objects: HasId[]): Promise<void>;
+  insertIntoQueue(queue: DXN, objects: AnyEntity[]): Promise<void>;
 }
 
 /**
@@ -31,7 +31,7 @@ export class QueuesAPIImpl implements QueuesAPI {
     return this._serviceContainer.queryQueue(queue);
   }
 
-  insertIntoQueue(queue: DXN, objects: HasId[]): Promise<void> {
+  insertIntoQueue(queue: DXN, objects: AnyEntity[]): Promise<void> {
     // TODO(dmaretskyi): Ugly.
     return this._serviceContainer.insertIntoQueue(queue, JSON.parse(JSON.stringify(objects)));
   }

package/src/space-proxy.ts

@@ -3,7 +3,8 @@
 //
 
 import { Resource } from '@dxos/context';
-import { type CoreDatabase, type EchoClient, type EchoDatabase } from '@dxos/echo-db';
+import { type Database } from '@dxos/echo';
+import { type CoreDatabase, type EchoClient, type EchoDatabaseImpl } from '@dxos/echo-db';
 import { invariant } from '@dxos/invariant';
 import { PublicKey, type SpaceId } from '@dxos/keys';
 
@@ -14,7 +15,7 @@ import { type QueuesAPI, QueuesAPIImpl } from './queues-api';
  * @deprecated
  */
 export class SpaceProxy extends Resource {
-  private _db?: EchoDatabase = undefined;
+  private _db?: EchoDatabaseImpl = undefined;
   private _queuesApi: QueuesAPIImpl;
 
   constructor(
@@ -30,7 +31,7 @@ export class SpaceProxy extends Resource {
     return this._id;
   }
 
-  get db(): EchoDatabase {
+  get db(): Database.Database {
     invariant(this._db);
     return this._db;
   }

package/src/wrap-handler-for-cloudflare.ts

@@ -22,7 +22,6 @@ export const wrapHandlerForCloudflare = (func: FunctionProtocol.Func): ExportedH
     // TODO(mykola): Wrap in withNewExecutionContext;
     // Meta route is used to get the input schema of the function by the functions service.
     if (request.headers.get(FUNCTION_ROUTE_HEADER) === FunctionRouteValue.Meta) {
-      log.info('>>> meta', { func });
       return handleFunctionMetaCall(func, request);
     }
 
@@ -34,7 +33,7 @@ export const wrapHandlerForCloudflare = (func: FunctionProtocol.Func): ExportedH
         }
       }
 
-      const serviceContainer = new ServiceContainer({}, env.DATA_SERVICE, env.QUEUE_SERVICE);
+      const serviceContainer = new ServiceContainer({}, env.DATA_SERVICE, env.QUEUE_SERVICE, env.FUNCTIONS_AI_SERVICE);
       const context = await createFunctionContext({
         serviceContainer,
         contextSpaceId: spaceId as SpaceId | undefined,
@@ -105,7 +104,7 @@ const createFunctionContext = async ({
   serviceContainer: ServiceContainer;
   contextSpaceId: SpaceId | undefined;
 }): Promise<FunctionProtocol.Context> => {
-  const { dataService, queryService, queueService } = await serviceContainer.createServices();
+  const { dataService, queryService, queueService, functionsAiService } = await serviceContainer.createServices();
 
   let spaceKey: string | undefined;
   let rootUrl: string | undefined;
@@ -124,6 +123,7 @@ const createFunctionContext = async ({
       dataService,
       queryService,
       queueService,
+      functionsAiService,
     },
     spaceId: contextSpaceId,
     spaceKey,