@dxos/functions-runtime-cloudflare 0.8.4-main.c85a9c8dae → 0.8.4-main.d05539e30a

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxos/functions-runtime-cloudflare",
-  "version": "0.8.4-main.c85a9c8dae",
+  "version": "0.8.4-main.d05539e30a",
   "description": "Functions runtime for Cloudflare.",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
@@ -8,7 +8,7 @@
     "type": "git",
     "url": "https://github.com/dxos/dxos"
   },
-  "license": "MIT",
+  "license": "FSL-1.1-Apache-2.0",
   "author": "info@dxos.org",
   "sideEffects": false,
   "type": "module",
@@ -27,23 +27,23 @@
     "src"
   ],
   "dependencies": {
-    "effect": "3.19.16",
-    "@dxos/codec-protobuf": "0.8.4-main.c85a9c8dae",
-    "@dxos/debug": "0.8.4-main.c85a9c8dae",
-    "@dxos/context": "0.8.4-main.c85a9c8dae",
-    "@dxos/echo": "0.8.4-main.c85a9c8dae",
-    "@dxos/echo-db": "0.8.4-main.c85a9c8dae",
-    "@dxos/echo-protocol": "0.8.4-main.c85a9c8dae",
-    "@dxos/errors": "0.8.4-main.c85a9c8dae",
-    "@dxos/invariant": "0.8.4-main.c85a9c8dae",
-    "@dxos/keys": "0.8.4-main.c85a9c8dae",
-    "@dxos/log": "0.8.4-main.c85a9c8dae",
-    "@dxos/protocols": "0.8.4-main.c85a9c8dae",
-    "@dxos/util": "0.8.4-main.c85a9c8dae"
+    "effect": "3.20.0",
+    "@dxos/codec-protobuf": "0.8.4-main.d05539e30a",
+    "@dxos/echo": "0.8.4-main.d05539e30a",
+    "@dxos/debug": "0.8.4-main.d05539e30a",
+    "@dxos/context": "0.8.4-main.d05539e30a",
+    "@dxos/echo-protocol": "0.8.4-main.d05539e30a",
+    "@dxos/errors": "0.8.4-main.d05539e30a",
+    "@dxos/invariant": "0.8.4-main.d05539e30a",
+    "@dxos/log": "0.8.4-main.d05539e30a",
+    "@dxos/echo-db": "0.8.4-main.d05539e30a",
+    "@dxos/protocols": "0.8.4-main.d05539e30a",
+    "@dxos/util": "0.8.4-main.d05539e30a",
+    "@dxos/keys": "0.8.4-main.d05539e30a"
   },
   "devDependencies": {
     "@cloudflare/workers-types": "^4.20260302.0",
-    "@dxos/types": "0.8.4-main.c85a9c8dae"
+    "@dxos/types": "0.8.4-main.d05539e30a"
   },
   "publishConfig": {
     "access": "public"

package/src/functions-client.ts

@@ -24,7 +24,7 @@ type Services = {
 export class FunctionsClient extends Resource {
   private readonly _serviceContainer;
   private readonly _echoClient;
-  private readonly _executionContext: EdgeFunctionEnv.ExecutionContext = {};
+  private readonly _executionContext: EdgeFunctionEnv.TraceContext = {};
 
   private readonly _spaces = new Map<SpaceId, SpaceProxy>();
 
@@ -80,9 +80,3 @@ export const createClientFromEnv = async (env: any): Promise<FunctionsClient> =>
   await client.open();
   return client;
 };
-
-/**
- - Provides data access capabilities for user functions.
- - No real-time replication or reactive queries -- function receives a snapshot.
- - Function event contains the metadata but doesn't need to include the data.
- */

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

@@ -30,7 +30,7 @@ export class DataServiceImpl implements DataServiceProto {
   private dataSubscriptions = new Map<string, { spaceId: SpaceId; next: (msg: BatchedDocumentUpdates) => void }>();
 
   constructor(
-    private _executionContext: EdgeFunctionEnv.ExecutionContext,
+    private _executionContext: EdgeFunctionEnv.TraceContext,
     private _dataService: EdgeFunctionEnv.DataService,
   ) {}
 
@@ -80,7 +80,8 @@ export class DataServiceImpl implements DataServiceProto {
   }
 
   async createDocument({ spaceId, initialValue }: CreateDocumentRequest): Promise<CreateDocumentResponse> {
-    using response = await this._dataService.createDocument(this._executionContext, { spaceId, initialValue });
+    invariant(SpaceId.isValid(spaceId));
+    using response = await this._dataService.createDocument(this._executionContext, spaceId, initialValue);
     return { documentId: response.documentId };
   }
 
@@ -96,6 +97,11 @@ export class DataServiceImpl implements DataServiceProto {
     // TODO(dmaretskyi): Batch.
     try {
       for (const update of updates ?? []) {
+        // Mutation-less updates (e.g. `requesting: true` transition signals from the worker) carry no
+        // bytes to apply; this runtime only forwards real document writes.
+        if (!update.mutation) {
+          continue;
+        }
         await this._dataService.changeDocument(this._executionContext, sub.spaceId, update.documentId, update.mutation);
       }
     } catch (error) {
@@ -130,7 +136,7 @@ export class DataServiceImpl implements DataServiceProto {
   }
 
   async updateIndexes(): Promise<void> {
-    log.error('updateIndexes is not available in EDGE env.');
+    log.verbose('updateIndexes called, but it is a no-op in EDGE env.');
     // No-op.
   }
 

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

@@ -2,71 +2,36 @@
 // Copyright 2024 DXOS.org
 //
 
-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';
 import { log } from '@dxos/log';
 import { type EdgeFunctionEnv } from '@dxos/protocols';
-import {
-  type QueryRequest,
-  type QueryResponse,
-  type QueryResult as QueryResultProto,
-  type QueryService as QueryServiceProto,
-} from '@dxos/protocols/proto/dxos/echo/query';
-
-import { queryToDataServiceRequest } from './adapter';
-import { copyUint8Array } from './utils';
+import { type QueryRequest, type QueryResponse, type QueryService } from '@dxos/protocols/proto/dxos/echo/query';
 
-export class QueryServiceImpl implements QueryServiceProto {
+export class QueryServiceImpl implements QueryService {
   private _queryCount = 0;
 
   constructor(
-    private readonly _executionContext: EdgeFunctionEnv.ExecutionContext,
+    private readonly _executionContext: EdgeFunctionEnv.TraceContext,
     private readonly _dataService: EdgeFunctionEnv.DataService,
   ) {}
 
   execQuery(request: QueryRequest): Stream<QueryResponse> {
     log.info('execQuery', { request });
-    const query = QueryAST.Query.pipe(Schema.decodeUnknownSync)(JSON.parse(request.query));
-    const requestedSpaceIds = getTargetSpacesForQuery(query);
-    invariant(requestedSpaceIds.length === 1, 'Only one space is supported');
-    const spaceId = requestedSpaceIds[0];
 
     return Stream.fromPromise<QueryResponse>(
       (async () => {
         try {
           this._queryCount++;
-          log.info('begin query', { spaceId });
-          using queryResponse = await this._dataService.queryDocuments(
-            this._executionContext,
-            queryToDataServiceRequest(query),
-          );
-          log.info('query response', { spaceId, filter: request.filter, resultCount: queryResponse.results.length });
-          return {
-            results: queryResponse.results.map(
-              (object): QueryResultProto => ({
-                id: object.objectId,
-                spaceId,
-                spaceKey: PublicKey.ZERO,
-                documentId: object.document.documentId,
-                // 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;
+          log.info('begin query', { request });
+          using queryResponse = await this._dataService.execQuery(this._executionContext, request);
+          log.info('query response', { resultCount: queryResponse.results?.length });
+          return structuredClone(queryResponse);
         } 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 },
+            context: { queryCount: this._queryCount },
             cause: error,
           });
         }
@@ -86,22 +51,3 @@ export class QueryServiceImpl implements QueryServiceProto {
     });
   }
 }
-
-/**
- * Lists spaces this query will select from.
- */
-export const getTargetSpacesForQuery = (query: QueryAST.Query): SpaceId[] => {
-  const spaces = new Set<SpaceId>();
-
-  const visitor = (node: QueryAST.Query) => {
-    if (node.type === 'from' && node.from._tag === 'scope') {
-      if (node.from.scope.spaceIds) {
-        for (const spaceId of node.from.scope.spaceIds) {
-          spaces.add(SpaceId.make(spaceId));
-        }
-      }
-    }
-  };
-  QueryAST.visit(query, visitor);
-  return [...spaces];
-};

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

@@ -7,7 +7,7 @@ import { type EdgeFunctionEnv, type FeedProtocol } from '@dxos/protocols';
 
 export class QueueServiceImpl implements FeedProtocol.QueueService {
   constructor(
-    protected _ctx: EdgeFunctionEnv.ExecutionContext,
+    protected _ctx: EdgeFunctionEnv.TraceContext,
     private readonly _queueService: EdgeFunctionEnv.QueueService,
   ) {}
 

package/src/internal/service-container.ts

@@ -6,7 +6,7 @@ import { type AnyEntity } from '@dxos/echo/internal';
 import { type DXN, type SpaceId } from '@dxos/keys';
 import { type EdgeFunctionEnv, type FeedProtocol } from '@dxos/protocols';
 import { type QueryService as QueryServiceProto } from '@dxos/protocols/proto/dxos/echo/query';
-import type { DataService as DataServiceProto } from '@dxos/protocols/proto/dxos/echo/service';
+import { type DataService as DataServiceProto } from '@dxos/protocols/proto/dxos/echo/service';
 
 import { DataServiceImpl } from './data-service-impl';
 import { QueryServiceImpl } from './query-service-impl';
@@ -17,7 +17,7 @@ import { QueueServiceImpl } from './queue-service-impl';
  */
 export class ServiceContainer {
   constructor(
-    private readonly _executionContext: EdgeFunctionEnv.ExecutionContext,
+    private readonly _executionContext: EdgeFunctionEnv.TraceContext,
     private readonly _dataService: EdgeFunctionEnv.DataService,
     private readonly _queueService: EdgeFunctionEnv.QueueService,
     private readonly _functionsService: EdgeFunctionEnv.FunctionsAiService,
@@ -58,6 +58,7 @@ export class ServiceContainer {
     if (!parts) {
       throw new Error('Invalid queue DXN');
     }
+
     const { subspaceTag, spaceId, queueId } = parts;
     const result = await this._queueService.queryQueue(this._executionContext, {
       query: {
@@ -66,6 +67,7 @@ export class ServiceContainer {
         queueIds: [queueId],
       },
     });
+
     return {
       objects: structuredClone(result.objects),
       nextCursor: result.nextCursor ?? null,
@@ -78,12 +80,13 @@ export class ServiceContainer {
     if (!parts) {
       throw new Error('Invalid queue DXN');
     }
+
     const { subspaceTag, spaceId, queueId } = parts;
     await this._queueService.insertIntoQueue(this._executionContext, {
       subspaceTag,
       spaceId,
       queueId,
-      objects: objects as FeedProtocol.InsertIntoQueueRequest['objects'],
+      objects: objects.map((obj) => JSON.stringify(obj)),
     });
   }
 }

package/src/logger.ts

@@ -16,27 +16,29 @@ const functionLogProcessor: LogProcessor = (config, entry) => {
     return;
   }
 
+  const context = entry.computedContext;
+  const error = entry.computedError;
+  const extras = [Object.keys(context).length > 0 ? context : undefined, error].filter((value) => value !== undefined);
+
   switch (entry.level) {
     case LogLevel.DEBUG:
-      console.debug(entry.message, entry.context);
-      break;
     case LogLevel.TRACE:
-      console.debug(entry.message, entry.context);
+      console.debug(entry.message, ...extras);
       break;
     case LogLevel.VERBOSE:
-      console.log(entry.message, entry.context);
+      console.log(entry.message, ...extras);
       break;
     case LogLevel.INFO:
-      console.info(entry.message, entry.context);
+      console.info(entry.message, ...extras);
       break;
     case LogLevel.WARN:
-      console.warn(entry.message, entry.context);
+      console.warn(entry.message, ...extras);
       break;
     case LogLevel.ERROR:
-      console.error(entry.message, entry.context);
+      console.error(entry.message, ...extras);
       break;
     default:
-      console.log(entry.message, entry.context);
+      console.log(entry.message, ...extras);
       break;
   }
 };

package/src/queues-api.ts

@@ -4,17 +4,23 @@
 
 import { type AnyEntity } from '@dxos/echo/internal';
 import type { DXN, SpaceId } from '@dxos/keys';
-import { type FeedProtocol } from '@dxos/protocols';
+import { log } from '@dxos/log';
 
 import type { ServiceContainer } from './internal';
 
+export interface QueuesQueryResult {
+  objects: AnyEntity[];
+  nextCursor: string | null;
+  prevCursor: string | null;
+}
+
 // TODO(dmaretskyi): Temporary API to get the queues working.
 // TODO(dmaretskyi): To be replaced with integrating queues into echo.
 /**
  * @deprecated
  */
 export interface QueuesAPI {
-  queryQueue(queue: DXN, options?: {}): Promise<FeedProtocol.QueryResult>;
+  queryQueue(queue: DXN, options?: {}): Promise<QueuesQueryResult>;
   insertIntoQueue(queue: DXN, objects: AnyEntity[]): Promise<void>;
 }
 
@@ -27,8 +33,21 @@ export class QueuesAPIImpl implements QueuesAPI {
     private readonly _spaceId: SpaceId,
   ) {}
 
-  queryQueue(queue: DXN, options?: {}): Promise<FeedProtocol.QueryResult> {
-    return this._serviceContainer.queryQueue(queue);
+  async queryQueue(queue: DXN, options?: {}): Promise<QueuesQueryResult> {
+    const result = await this._serviceContainer.queryQueue(queue);
+    const objects = (result.objects ?? []).flatMap((encoded): AnyEntity[] => {
+      try {
+        return [JSON.parse(encoded) as AnyEntity];
+      } catch (err) {
+        log.verbose('queue object JSON parse failed; object ignored', { encoded, error: err });
+        return [];
+      }
+    });
+    return {
+      objects,
+      nextCursor: result.nextCursor ?? null,
+      prevCursor: result.prevCursor ?? null,
+    };
   }
 
   insertIntoQueue(queue: DXN, objects: AnyEntity[]): Promise<void> {

package/src/space-proxy.ts

@@ -61,6 +61,6 @@ export class SpaceProxy extends Resource {
       owningObject: this,
     });
 
-    await this._db.coreDatabase.open({ rootUrl: meta.rootDocumentId });
+    await this._db.coreDatabase.open(this._ctx, { rootUrl: meta.rootDocumentId });
   }
 }

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

@@ -97,7 +97,7 @@ const handleFunctionMetaCall = (functionDefinition: FunctionProtocol.Func, reque
   });
 };
 
-const createFunctionContext = async ({
+export const createFunctionContext = async ({
   serviceContainer,
   contextSpaceId,
 }: {

package/dist/types/src/internal/adapter.d.ts

@@ -1,4 +0,0 @@
-import { type QueryAST } from '@dxos/echo-protocol';
-import { type EdgeFunctionEnv } from '@dxos/protocols';
-export declare const queryToDataServiceRequest: (query: QueryAST.Query) => EdgeFunctionEnv.QueryRequest;
-//# sourceMappingURL=adapter.d.ts.map

package/dist/types/src/internal/adapter.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"adapter.d.ts","sourceRoot":"","sources":["../../../../src/internal/adapter.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAGpD,OAAO,EAAE,KAAK,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAEvD,eAAO,MAAM,yBAAyB,GAAI,OAAO,QAAQ,CAAC,KAAK,KAAG,eAAe,CAAC,YAajF,CAAC"}

package/src/internal/adapter.ts

@@ -1,52 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import { failUndefined } from '@dxos/debug';
-import { type QueryAST } from '@dxos/echo-protocol';
-import { invariant } from '@dxos/invariant';
-import { SpaceId } from '@dxos/keys';
-import { type EdgeFunctionEnv } from '@dxos/protocols';
-
-export const queryToDataServiceRequest = (query: QueryAST.Query): EdgeFunctionEnv.QueryRequest => {
-  const { filter, spaceIds } = extractSimpleQuery(query) ?? failUndefined();
-  invariant(spaceIds?.length === 1, 'Only one space is supported');
-  invariant(filter.type === 'object', 'Only object filters are supported');
-
-  const spaceId = spaceIds[0];
-  invariant(SpaceId.isValid(spaceId));
-
-  return {
-    spaceId,
-    type: filter.typename ?? undefined,
-    objectIds: [...(filter.id ?? [])],
-  };
-};
-
-/**
- * Extracts the filter and space IDs from a query.
- * Supports Select(...), Options(Select(...)), and From(Select(...)) queries.
- */
-const extractSimpleQuery = (
-  query: QueryAST.Query,
-): { filter: QueryAST.Filter; spaceIds?: readonly string[] } | null => {
-  switch (query.type) {
-    case 'options': {
-      return extractSimpleQuery(query.query);
-    }
-    case 'from': {
-      const inner = extractSimpleQuery(query.query);
-      if (!inner) {
-        return null;
-      }
-      const spaceIds = query.from._tag === 'scope' ? query.from.scope.spaceIds : undefined;
-      return { filter: inner.filter, spaceIds: spaceIds ?? inner.spaceIds };
-    }
-    case 'select': {
-      return { filter: query.filter };
-    }
-    default: {
-      return null;
-    }
-  }
-};