@dxos/protocols 0.8.4-main.406dc2a → 0.8.4-main.548089c

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxos/protocols",
-  "version": "0.8.4-main.406dc2a",
+  "version": "0.8.4-main.548089c",
   "description": "Protobuf definitions for DXOS protocols.",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
@@ -60,19 +60,19 @@
   ],
   "dependencies": {
     "@bufbuild/protobuf": "2.9.0",
-    "@dxos/codec-protobuf": "0.8.4-main.406dc2a",
-    "@dxos/effect": "0.8.4-main.406dc2a",
-    "@dxos/errors": "0.8.4-main.406dc2a",
-    "@dxos/invariant": "0.8.4-main.406dc2a",
-    "@dxos/keys": "0.8.4-main.406dc2a",
-    "@dxos/timeframe": "0.8.4-main.406dc2a",
-    "@dxos/util": "0.8.4-main.406dc2a"
+    "@dxos/codec-protobuf": "0.8.4-main.548089c",
+    "@dxos/effect": "0.8.4-main.548089c",
+    "@dxos/errors": "0.8.4-main.548089c",
+    "@dxos/keys": "0.8.4-main.548089c",
+    "@dxos/invariant": "0.8.4-main.548089c",
+    "@dxos/timeframe": "0.8.4-main.548089c",
+    "@dxos/util": "0.8.4-main.548089c"
   },
   "devDependencies": {
     "@bufbuild/buf": "1.43.0",
     "@bufbuild/protoc-gen-es": "2.9.0",
     "effect": "3.18.3",
-    "@dxos/protobuf-compiler": "0.8.4-main.406dc2a"
+    "@dxos/protobuf-compiler": "0.8.4-main.548089c"
   },
   "peerDependencies": {
     "effect": "^3.13.3"

package/src/edge-error.ts

@@ -2,18 +2,28 @@
 // Copyright 2025 DXOS.org
 //
 
-import { BaseError } from '@dxos/errors';
-
-import { type EdgeErrorData, type EdgeHttpFailure } from './edge';
+import { type EdgeErrorData, type EdgeFailure, EdgeHttpErrorCodec, ErrorCodec } from './edge.js';
 
 // TODO(burdon): Reconcile with @dxos/errors.
+/**
+ * Error thrown when a call to the Edge service fails.
+ * There 3 possible sources of failure:
+ * 1. EdgeFailure (JSON body with { success: false }) -> Processing the request failed and was gracefully handled by EDGE service.
+ * 2. Http failure (non-ok code) -> The HTTP request failed (e.g. timeout, network error).
+ *                               -> Unhandled exception on EDGE side, EDGE would provide serialized error in the response body.
+ * 3. Processing failure -> Unhandled exception on client side while processing the response.
+ */
 export class EdgeCallFailedError extends Error {
-  public static fromProcessingFailureCause(cause: Error): EdgeCallFailedError {
-    return new EdgeCallFailedError({
-      reason: 'Error processing request.',
-      isRetryable: true,
-      cause,
+  public static fromUnsuccessfulResponse(response: Response, body: EdgeFailure): EdgeCallFailedError {
+    const error = new EdgeCallFailedError({
+      reason: body.reason,
+      errorData: body.errorData,
+      isRetryable: body.errorData == null && response.headers.has('Retry-After'),
+      retryAfterMs: getRetryAfterMillis(response),
+      cause: body.cause ? ErrorCodec.decode(body.cause) : undefined,
     });
+
+    return error;
   }
 
   public static async fromHttpFailure(response: Response): Promise<EdgeCallFailedError> {
@@ -21,16 +31,15 @@ export class EdgeCallFailedError extends Error {
       reason: `HTTP code ${response.status}: ${response.statusText}.`,
       isRetryable: isRetryableCode(response.status),
       retryAfterMs: getRetryAfterMillis(response),
-      cause: await parseErrorBody(response),
+      cause: await EdgeHttpErrorCodec.decode(response),
     });
   }
 
-  public static fromUnsuccessfulResponse(response: Response, body: EdgeHttpFailure): EdgeCallFailedError {
+  public static fromProcessingFailureCause(cause: Error): EdgeCallFailedError {
     return new EdgeCallFailedError({
-      reason: body.reason,
-      errorData: body.errorData,
-      isRetryable: body.errorData == null && response.headers.has('Retry-After'),
-      retryAfterMs: getRetryAfterMillis(response),
+      reason: 'Error processing request.',
+      isRetryable: true,
+      cause,
     });
   }
 
@@ -68,12 +77,6 @@ const getRetryAfterMillis = (response: Response) => {
   return Number.isNaN(retryAfter) || retryAfter === 0 ? undefined : retryAfter * 1000;
 };
 
-export const createRetryableHttpFailure = (args: { reason: any; retryAfterSeconds: number }) => {
-  return new Response(JSON.stringify({ success: false, reason: args.reason }), {
-    headers: { 'Retry-After': String(args.retryAfterSeconds) },
-  });
-};
-
 const isRetryableCode = (status: number) => {
   if (status === 501) {
     // Not Implemented
@@ -81,54 +84,3 @@ const isRetryableCode = (status: number) => {
   }
   return !(status >= 400 && status < 500);
 };
-
-const parseErrorBody = async (response: Response): Promise<Error | undefined> => {
-  if (response.headers.get('Content-Type') !== 'application/json') {
-    const body = await response.text();
-    return new Error(body.slice(0, 256));
-  }
-
-  const body = await response.json();
-  if (!('error' in body)) {
-    return undefined;
-  }
-
-  return parseSerializedError(body.error);
-};
-
-type SerializedError = {
-  code?: string;
-  message?: string;
-  context?: Record<string, unknown>;
-  stack?: string;
-  cause?: SerializedError;
-};
-
-const parseSerializedError = (serializedError: SerializedError): Error => {
-  let err: Error;
-  if (typeof serializedError.code === 'string') {
-    err = new BaseError(serializedError.code, {
-      message: serializedError.message ?? 'Unknown error',
-      cause: serializedError.cause ? parseSerializedError(serializedError.cause) : undefined,
-      context: serializedError.context,
-    });
-
-    if (serializedError.stack) {
-      Object.defineProperty(err, 'stack', {
-        value: serializedError.stack,
-      });
-    }
-  } else {
-    err = new Error(serializedError.message ?? 'Unknown error', {
-      cause: serializedError.cause ? parseSerializedError(serializedError.cause) : undefined,
-    });
-
-    if (serializedError.stack) {
-      Object.defineProperty(err, 'stack', {
-        value: serializedError.stack,
-      });
-    }
-  }
-
-  return err;
-};

package/src/edge.ts

@@ -4,6 +4,8 @@
 
 import * as Schema from 'effect/Schema';
 
+import { BaseError } from '@dxos/errors';
+import { invariant } from '@dxos/invariant';
 import { SpaceId } from '@dxos/keys';
 
 // TODO(burdon): Rename EdgerRouterEndpoint.
@@ -16,20 +18,38 @@ export enum EdgeService {
   STATUS = 'status',
 }
 
-export type EdgeHttpSuccess<T> = {
+export type EdgeSuccess<T> = {
   success: true;
   data: T;
 };
 
+export type SerializedError = {
+  code?: string;
+  message?: string;
+  context?: Record<string, unknown>;
+  stack?: string;
+  cause?: SerializedError;
+};
+
 export type EdgeErrorData = { type: string } & Record<string, any>;
 
-export type EdgeHttpFailure = {
-  // TODO(burdon): Why is this required?
+/**
+ * This is the shape of the error response from the Edge service,
+ * when the error is gracefully handled, the Response will be an object with this shape and have status code 200.
+ */
+export type EdgeFailure = {
+  /**
+   * Branded Type.
+   */
   success: false;
   /**
    * An explanation of why the call failed. Used mostly for logging and monitoring.
    */
   reason: string;
+  /**
+   * Cause Error captured on the EDGE service to aid debugging on the client.
+   */
+  cause?: SerializedError;
   /**
    * Information that can be used to retry the request such that it will succeed, for example:
    * 1. { type: 'auth_required', challenge: string }
@@ -43,7 +63,87 @@ export type EdgeHttpFailure = {
   errorData?: EdgeErrorData;
 };
 
-export type EdgeHttpResponse<T> = EdgeHttpSuccess<T> | EdgeHttpFailure;
+/**
+ * Represents a body response from the Edge service.
+ */
+export type EdgeBody<T> = EdgeSuccess<T> | EdgeFailure;
+
+/**
+ * Use this to create a response from the Edge service.
+ */
+export const EdgeResponse = Object.freeze({
+  success: <T>(data: T, status: number = 200): Response => {
+    invariant(status >= 200 && status < 300, 'Status code must be in the 2xx range');
+    const headers = new Headers({ 'Content-Type': 'application/json' });
+    return new Response(
+      JSON.stringify({
+        success: true,
+        data,
+      } satisfies EdgeSuccess<T>),
+      {
+        status,
+        headers,
+      },
+    );
+  },
+  failure: ({
+    reason,
+    cause,
+    errorData,
+    shouldRetryAfter,
+    status = 500,
+  }: {
+    /**
+     * An explanation of why the call failed. Used mostly for logging and monitoring.
+     */
+    reason: string;
+    /**
+     * Error that caused the failure.
+     * Useful for debugging.
+     */
+    cause?: Error;
+    /**
+     * Information that can be used to retry the request such that it will succeed, for example:
+     * 1. { type: 'auth_required', challenge: string }
+     *    Requires retrying the request with challenge signature included.
+     * 2. { type: 'user_confirmation_required', dialog: { title: string, message: string, confirmation_payload: string } }
+     *    Requires showing a confirmation dialog to a user and retrying the request with confirmation_payload included
+     *    if the user confirms.
+     * When errorData is returned simply retrying the request won't have any effect.
+     * EdgeHttpClient should parse well-known errorData into Error types and throw.
+     */
+    errorData?: EdgeErrorData;
+    /**
+     * If provided, this request will be marked as retryable and the client will wait for the specified number of milliseconds before retrying.
+     * If not provided, the client will not retry the request.
+     */
+    shouldRetryAfter?: number;
+
+    /**
+     * Status code of the response.
+     * @default 500
+     */
+    status?: number;
+  }): Response => {
+    const headers = new Headers({ 'Content-Type': 'application/json' });
+    if (shouldRetryAfter) {
+      headers.set('Retry-After', String(shouldRetryAfter));
+    }
+
+    return new Response(
+      JSON.stringify({
+        success: false,
+        reason,
+        errorData,
+        cause: cause ? ErrorCodec.encode(cause) : undefined,
+      } satisfies EdgeFailure),
+      {
+        status,
+        headers,
+      },
+    );
+  },
+});
 
 export type GetNotarizationResponseBody = {
   awaitingNotarization: { credentials: string[] };
@@ -122,8 +222,26 @@ export type UploadFunctionRequest = {
   ownerPublicKey: string;
   entryPoint: string;
   assets: Record<string, Uint8Array>;
+  /**
+   * Runtime in Edge that will be used to run the function.
+   * Runtime cannot be changed once the function was deployed.
+   * @default Runtime.WORKERS_FOR_PLATFORMS
+   */
+  runtime?: Runtime;
 };
 
+/**
+ * Note: Do not change the values of these enums, this values are stored in the FunctionVersions database.
+ */
+export enum Runtime {
+  // https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/
+  WORKERS_FOR_PLATFORMS = 'WORKERS_FOR_PLATFORMS',
+  // https://developers.cloudflare.com/workers/runtime-apis/bindings/worker-loader/
+  WORKER_LOADER = 'WORKER_LOADER',
+  // Local worker dispatcher for testing.
+  TEST = 'TEST',
+}
+
 export type UploadFunctionResponseBody = {
   functionId: string;
   version: string;
@@ -273,7 +391,82 @@ export type ExportBundleResponse = {
   }[];
 };
 
-export const DocumentCodec = {
+export const DocumentCodec = Object.freeze({
   encode: (doc: Uint8Array) => Buffer.from(doc).toString('base64'),
   decode: (doc: string) => new Uint8Array(Buffer.from(doc, 'base64')),
-};
+});
+
+const MAX_ERROR_DEPTH = 3;
+
+/**
+ * Codec for serializing and deserializing Edge Errors.
+ */
+export const ErrorCodec = Object.freeze({
+  encode: (err: Error, depth: number = 0): SerializedError => ({
+    code: 'code' in err ? (err as any).code : undefined,
+    message: err.message,
+    stack: err.stack,
+    cause: err.cause instanceof Error && depth < MAX_ERROR_DEPTH ? ErrorCodec.encode(err.cause, depth + 1) : undefined,
+  }),
+  decode: (serializedError: SerializedError, depth: number = 0): Error => {
+    let err: Error;
+    if (typeof serializedError.code === 'string') {
+      err = new BaseError(serializedError.code, {
+        message: serializedError.message ?? 'Unknown error',
+        cause:
+          serializedError.cause && depth < MAX_ERROR_DEPTH
+            ? ErrorCodec.decode(serializedError.cause, depth + 1)
+            : undefined,
+        context: serializedError.context,
+      });
+
+      if (serializedError.stack) {
+        Object.defineProperty(err, 'stack', {
+          value: serializedError.stack,
+        });
+      }
+    } else {
+      err = new Error(serializedError.message ?? 'Unknown error', {
+        cause:
+          serializedError.cause && depth < MAX_ERROR_DEPTH
+            ? ErrorCodec.decode(serializedError.cause, depth + 1)
+            : undefined,
+      });
+
+      if (serializedError.stack) {
+        Object.defineProperty(err, 'stack', {
+          value: serializedError.stack,
+        });
+      }
+    }
+
+    return err;
+  },
+});
+
+/**
+ * Codec for serializing and deserializing Edge unhandled HTTP errors.
+ */
+export const EdgeHttpErrorCodec = Object.freeze({
+  encode: (err: Error): Response =>
+    new Response(
+      JSON.stringify({
+        error: ErrorCodec.encode(err),
+      }),
+      { status: 500 },
+    ),
+
+  decode: async (response: Response): Promise<Error | undefined> => {
+    if (response.headers.get('Content-Type') !== 'application/json') {
+      const body = await response.clone().text();
+      return new Error(body.slice(0, 256));
+    }
+
+    const body = await response.clone().json();
+    if (!('error' in body)) {
+      return undefined;
+    }
+
+    return ErrorCodec.decode(body.error);
+  },
+});