@dxos/functions-runtime-cloudflare 0.8.4-main.3c1ae3b

package/src/functions-client.ts

@@ -0,0 +1,81 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import { Resource } from '@dxos/context';
+import { EchoClient } from '@dxos/echo-db';
+import { invariant } from '@dxos/invariant';
+import { type SpaceId } from '@dxos/keys';
+import { type EdgeFunctionEnv } from '@dxos/protocols';
+
+import { ServiceContainer } from './internal';
+import { SpaceProxy } from './space-proxy';
+
+type Services = {
+  dataService: EdgeFunctionEnv.DataService;
+  queueService: EdgeFunctionEnv.QueueService;
+};
+
+/**
+ * API for functions to integrate with ECHO and HALO.
+ * @deprecated
+ */
+export class FunctionsClient extends Resource {
+  private readonly _serviceContainer;
+  private readonly _echoClient;
+  private readonly _executionContext: EdgeFunctionEnv.ExecutionContext = {};
+
+  private readonly _spaces = new Map<SpaceId, SpaceProxy>();
+
+  constructor(services: Services) {
+    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._echoClient = new EchoClient({});
+  }
+
+  get echo(): EchoClient {
+    return this._echoClient;
+  }
+
+  protected override async _open() {
+    const { dataService, queryService } = await this._serviceContainer.createServices();
+    this._echoClient.connectToService({ dataService, queryService });
+    await this._echoClient.open();
+  }
+
+  protected override async _close() {
+    for (const space of this._spaces.values()) {
+      await space.close();
+    }
+    this._spaces.clear();
+
+    await this._echoClient.close();
+  }
+
+  async getSpace(spaceId: SpaceId): Promise<SpaceProxy> {
+    if (!this._spaces.has(spaceId)) {
+      const space = new SpaceProxy(this._serviceContainer, this._echoClient, spaceId);
+      this._spaces.set(spaceId, space);
+    }
+    const space = this._spaces.get(spaceId)!;
+    await space.open(); // No-op if already open.
+    return space;
+  }
+}
+
+export const createClientFromEnv = async (env: any): Promise<FunctionsClient> => {
+  const client = new FunctionsClient({
+    dataService: env.DATA_SERVICE,
+    queueService: env.QUEUE_SERVICE,
+  });
+  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/index.ts

@@ -0,0 +1,9 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+export * from './functions-client';
+export * from './internal';
+export * from './types';
+export * from './wrap-handler-for-cloudflare';
+export * from './logger';

package/src/internal/adapter.ts

@@ -0,0 +1,48 @@
+//
+// 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, options } = isSimpleSelectionQuery(query) ?? failUndefined();
+  invariant(options?.spaceIds?.length === 1, 'Only one space is supported');
+  invariant(filter.type === 'object', 'Only object filters are supported');
+
+  const spaceId = options.spaceIds[0];
+  invariant(SpaceId.isValid(spaceId));
+
+  return {
+    spaceId,
+    type: filter.typename ?? undefined,
+    objectIds: [...(filter.id ?? [])],
+  };
+};
+
+/**
+ * Extracts the filter and options from a query.
+ * Supports Select(...) and Options(Select(...)) queries.
+ */
+export const isSimpleSelectionQuery = (
+  query: QueryAST.Query,
+): { filter: QueryAST.Filter; options?: QueryAST.QueryOptions } | null => {
+  switch (query.type) {
+    case 'options': {
+      const maybeFilter = isSimpleSelectionQuery(query.query);
+      if (!maybeFilter) {
+        return null;
+      }
+      return { filter: maybeFilter.filter, options: query.options };
+    }
+    case 'select': {
+      return { filter: query.filter, options: undefined };
+    }
+    default: {
+      return null;
+    }
+  }
+};

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

@@ -0,0 +1,125 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+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,
+  DataService as DataServiceProto,
+  GetDocumentHeadsRequest,
+  GetDocumentHeadsResponse,
+  GetSpaceSyncStateRequest,
+  ReIndexHeadsRequest,
+  SpaceSyncState,
+  UpdateRequest,
+  UpdateSubscriptionRequest,
+} from '@dxos/protocols/proto/dxos/echo/service';
+
+export class DataServiceImpl implements DataServiceProto {
+  private dataSubscriptions = new Map<string, { spaceId: SpaceId; next: (msg: BatchedDocumentUpdates) => void }>();
+
+  constructor(
+    private _executionContext: EdgeFunctionEnv.ExecutionContext,
+    private _dataService: EdgeFunctionEnv.DataService,
+  ) {}
+
+  subscribe({ subscriptionId, spaceId }: { subscriptionId: string; spaceId: string }): Stream<BatchedDocumentUpdates> {
+    return new Stream(({ next }) => {
+      invariant(SpaceId.isValid(spaceId));
+      this.dataSubscriptions.set(subscriptionId, { spaceId, next });
+
+      return () => {
+        this.dataSubscriptions.delete(subscriptionId);
+      };
+    });
+  }
+
+  async updateSubscription({ subscriptionId, addIds, removeIds }: 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);
+        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 }] });
+      }
+    }
+  }
+
+  async update({ updates, subscriptionId }: UpdateRequest): Promise<void> {
+    const sub =
+      this.dataSubscriptions.get(subscriptionId) ??
+      raise(
+        new RuntimeServiceError({
+          message: 'Subscription not found.',
+          context: { subscriptionId },
+        }),
+      );
+    // TODO(dmaretskyi): Batch.
+    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);
+    }
+  }
+
+  async flush(): Promise<void> {
+    // No-op.
+  }
+
+  subscribeSpaceSyncState(request: GetSpaceSyncStateRequest, options?: RequestOptions): Stream<SpaceSyncState> {
+    throw new NotImplementedError({
+      message: 'subscribeSpaceSyncState is not implemented.',
+    });
+  }
+
+  async getDocumentHeads({ documentIds }: GetDocumentHeadsRequest): Promise<GetDocumentHeadsResponse> {
+    throw new NotImplementedError({
+      message: 'getDocumentHeads is not implemented.',
+    });
+  }
+
+  async reIndexHeads({ documentIds }: ReIndexHeadsRequest): Promise<void> {
+    throw new NotImplementedError({
+      message: 'reIndexHeads is not implemented.',
+    });
+  }
+
+  async updateIndexes(): Promise<void> {
+    throw new NotImplementedError({
+      message: 'updateIndexes is not implemented.',
+    });
+  }
+
+  async waitUntilHeadsReplicated({ heads }: { heads: any }): Promise<void> {
+    throw new NotImplementedError({
+      message: 'waitUntilHeadsReplicated is not implemented.',
+    });
+  }
+}

package/src/internal/index.ts

@@ -0,0 +1,5 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+export * from './service-container';

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

@@ -0,0 +1,103 @@
+//
+// 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';
+
+export class QueryServiceImpl implements QueryServiceProto {
+  private _queryCount = 0;
+
+  constructor(
+    private readonly _executionContext: EdgeFunctionEnv.ExecutionContext,
+    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 });
+          const 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: 0,
+                documentAutomerge: object.document.data,
+              }),
+            ),
+          } satisfies 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 },
+            cause: error,
+          });
+        }
+      })(),
+    );
+  }
+
+  async reindex() {
+    throw new NotImplementedError({
+      message: 'Reindex is not implemented.',
+    });
+  }
+
+  async setConfig() {
+    throw new NotImplementedError({
+      message: 'SetConfig is not implemented.',
+    });
+  }
+}
+
+/**
+ * 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 === 'options') {
+      if (node.options.spaceIds) {
+        for (const spaceId of node.options.spaceIds) {
+          spaces.add(SpaceId.make(spaceId));
+        }
+      }
+    }
+  };
+  QueryAST.visit(query, visitor);
+  return [...spaces];
+};

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

@@ -0,0 +1,51 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { NotImplementedError, RuntimeServiceError } from '@dxos/errors';
+import type { ObjectId, SpaceId } from '@dxos/keys';
+import { type QueueService as QueueServiceProto } from '@dxos/protocols';
+import type { EdgeFunctionEnv, QueryResult, QueueQuery } from '@dxos/protocols';
+
+export class QueueServiceImpl implements QueueServiceProto {
+  constructor(
+    protected _ctx: EdgeFunctionEnv.ExecutionContext,
+    private readonly _queueService: EdgeFunctionEnv.QueueService,
+  ) {}
+  async queryQueue(subspaceTag: string, spaceId: SpaceId, { queueId, ...query }: QueueQuery): Promise<QueryResult> {
+    try {
+      const result = await this._queueService.query(this._ctx, `dxn:queue:${subspaceTag}:${spaceId}:${queueId}`, query);
+      return result;
+    } catch (error) {
+      throw RuntimeServiceError.wrap({
+        message: 'Queue query failed.',
+        context: { subspaceTag, spaceId, queueId },
+        ifTypeDiffers: true,
+      })(error);
+    }
+  }
+
+  async insertIntoQueue(subspaceTag: string, spaceId: SpaceId, queueId: ObjectId, objects: unknown[]): Promise<void> {
+    try {
+      const result = await this._queueService.append(
+        this._ctx,
+        `dxn:queue:${subspaceTag}:${spaceId}:${queueId}`,
+        objects,
+      );
+      return result;
+    } 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 NotImplementedError({
+      message: 'Deleting from queue is not supported.',
+      context: { subspaceTag, spaceId, queueId },
+    });
+  }
+}

package/src/internal/service-container.ts

@@ -0,0 +1,54 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import type { HasId } from '@dxos/echo/internal';
+import { type DXN, type SpaceId } from '@dxos/keys';
+import type { QueryResult } from '@dxos/protocols';
+import { type EdgeFunctionEnv } from '@dxos/protocols';
+import { type QueueService as QueueServiceProto } 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 { DataServiceImpl } from './data-service-impl';
+import { QueryServiceImpl } from './query-service-impl';
+import { QueueServiceImpl } from './queue-service-impl';
+
+/**
+ * TODO: make this implement DataService and QueryService to unify API over edge and web backend
+ */
+export class ServiceContainer {
+  constructor(
+    private readonly _executionContext: EdgeFunctionEnv.ExecutionContext,
+    private readonly _dataService: EdgeFunctionEnv.DataService,
+    private readonly _queueService: EdgeFunctionEnv.QueueService,
+  ) {}
+
+  async getSpaceMeta(spaceId: SpaceId): Promise<EdgeFunctionEnv.SpaceMeta | undefined> {
+    return this._dataService.getSpaceMeta(this._executionContext, spaceId);
+  }
+
+  async createServices(): Promise<{
+    dataService: DataServiceProto;
+    queryService: QueryServiceProto;
+    queueService: QueueServiceProto;
+  }> {
+    const dataService = new DataServiceImpl(this._executionContext, this._dataService);
+    const queryService = new QueryServiceImpl(this._executionContext, this._dataService);
+    const queueService = new QueueServiceImpl(this._executionContext, this._queueService);
+
+    return {
+      dataService,
+      queryService,
+      queueService,
+    };
+  }
+
+  queryQueue(queue: DXN): Promise<QueryResult> {
+    return this._queueService.query({}, queue.toString(), {});
+  }
+
+  insertIntoQueue(queue: DXN, objects: HasId[]): Promise<void> {
+    return this._queueService.append({}, queue.toString(), objects);
+  }
+}

package/src/logger.ts

@@ -0,0 +1,40 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+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

@@ -0,0 +1,38 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import type { HasId } from '@dxos/echo/internal';
+import type { DXN, SpaceId } from '@dxos/keys';
+import type { QueryResult } from '@dxos/protocols';
+
+import type { ServiceContainer } from './internal';
+
+// 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<QueryResult>;
+  insertIntoQueue(queue: DXN, objects: HasId[]): Promise<void>;
+}
+
+/**
+ * @deprecated
+ */
+export class QueuesAPIImpl implements QueuesAPI {
+  constructor(
+    private readonly _serviceContainer: ServiceContainer,
+    private readonly _spaceId: SpaceId,
+  ) {}
+
+  queryQueue(queue: DXN, options?: {}): Promise<QueryResult> {
+    return this._serviceContainer.queryQueue(queue);
+  }
+
+  insertIntoQueue(queue: DXN, objects: HasId[]): Promise<void> {
+    // TODO(dmaretskyi): Ugly.
+    return this._serviceContainer.insertIntoQueue(queue, JSON.parse(JSON.stringify(objects)));
+  }
+}

package/src/space-proxy.ts

@@ -0,0 +1,65 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import { Resource } from '@dxos/context';
+import { type CoreDatabase, type EchoClient, type EchoDatabase } from '@dxos/echo-db';
+import { invariant } from '@dxos/invariant';
+import { PublicKey, type SpaceId } from '@dxos/keys';
+
+import type { ServiceContainer } from './internal';
+import { type QueuesAPI, QueuesAPIImpl } from './queues-api';
+
+/**
+ * @deprecated
+ */
+export class SpaceProxy extends Resource {
+  private _db?: EchoDatabase = undefined;
+  private _queuesApi: QueuesAPIImpl;
+
+  constructor(
+    private readonly _serviceContainer: ServiceContainer,
+    private readonly _echoClient: EchoClient,
+    private readonly _id: SpaceId,
+  ) {
+    super();
+    this._queuesApi = new QueuesAPIImpl(this._serviceContainer, this._id);
+  }
+
+  get id(): SpaceId {
+    return this._id;
+  }
+
+  get db(): EchoDatabase {
+    invariant(this._db);
+    return this._db;
+  }
+
+  /**
+   * @deprecated Use db API.
+   */
+  get crud(): CoreDatabase {
+    invariant(this._db);
+    return this._db.coreDatabase;
+  }
+
+  get queues(): QueuesAPI {
+    return this._queuesApi;
+  }
+
+  protected override async _open() {
+    const meta = await this._serviceContainer.getSpaceMeta(this._id);
+    if (!meta) {
+      throw new Error(`Space not found: ${this._id}`);
+    }
+
+    this._db = this._echoClient.constructDatabase({
+      spaceId: this._id,
+      spaceKey: PublicKey.from(meta.spaceKey),
+      reactiveSchemaQuery: false,
+      owningObject: this,
+    });
+
+    await this._db.coreDatabase.open({ rootUrl: meta.rootDocumentId });
+  }
+}

package/src/types.ts

@@ -0,0 +1,40 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import type { JsonSchemaType } from '@dxos/echo/internal';
+
+/**
+ * Is used for to route the request to the metadata handler instead of the main handler.
+ */
+export const FUNCTION_ROUTE_HEADER = 'X-DXOS-Function-Route';
+
+export enum FunctionRouteValue {
+  Meta = 'meta',
+}
+
+export type FunctionMetadata = {
+  /**
+   * FQN.
+   */
+  key: string;
+  /**
+   * Human-readable name.
+   */
+  name?: string;
+
+  /**
+   * Description.
+   */
+  description?: string;
+
+  /**
+   * Input schema.
+   */
+  inputSchema?: JsonSchemaType;
+
+  /**
+   * Output schema.
+   */
+  outputSchema?: JsonSchemaType;
+};