@dxos/edge-client 0.8.4-main.ae835ea → 0.8.4-main.bc674ce

package/package.json

@@ -1,12 +1,16 @@
 {
   "name": "@dxos/edge-client",
-  "version": "0.8.4-main.ae835ea",
+  "version": "0.8.4-main.bc674ce",
   "description": "EDGE Client",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/dxos/dxos"
+  },
   "license": "MIT",
   "author": "DXOS.org",
-  "sideEffects": true,
+  "sideEffects": false,
   "type": "module",
   "exports": {
     ".": {
@@ -42,27 +46,28 @@
     "README.md"
   ],
   "dependencies": {
-    "@effect/platform": "^0.92.1",
+    "@effect/platform": "0.93.6",
     "isomorphic-ws": "^5.0.0",
     "ws": "^8.14.2",
-    "@dxos/credentials": "0.8.4-main.ae835ea",
-    "@dxos/context": "0.8.4-main.ae835ea",
-    "@dxos/debug": "0.8.4-main.ae835ea",
-    "@dxos/invariant": "0.8.4-main.ae835ea",
-    "@dxos/keyring": "0.8.4-main.ae835ea",
-    "@dxos/keys": "0.8.4-main.ae835ea",
-    "@dxos/log": "0.8.4-main.ae835ea",
-    "@dxos/async": "0.8.4-main.ae835ea",
-    "@dxos/node-std": "0.8.4-main.ae835ea",
-    "@dxos/crypto": "0.8.4-main.ae835ea",
-    "@dxos/protocols": "0.8.4-main.ae835ea",
-    "@dxos/util": "0.8.4-main.ae835ea"
+    "@dxos/async": "0.8.4-main.bc674ce",
+    "@dxos/context": "0.8.4-main.bc674ce",
+    "@dxos/credentials": "0.8.4-main.bc674ce",
+    "@dxos/crypto": "0.8.4-main.bc674ce",
+    "@dxos/effect": "0.8.4-main.bc674ce",
+    "@dxos/invariant": "0.8.4-main.bc674ce",
+    "@dxos/keyring": "0.8.4-main.bc674ce",
+    "@dxos/log": "0.8.4-main.bc674ce",
+    "@dxos/keys": "0.8.4-main.bc674ce",
+    "@dxos/debug": "0.8.4-main.bc674ce",
+    "@dxos/node-std": "0.8.4-main.bc674ce",
+    "@dxos/protocols": "0.8.4-main.bc674ce",
+    "@dxos/util": "0.8.4-main.bc674ce"
   },
   "devDependencies": {
-    "@dxos/test-utils": "0.8.4-main.ae835ea"
+    "@dxos/test-utils": "0.8.4-main.bc674ce"
   },
   "peerDependencies": {
-    "effect": "^3.13.3"
+    "effect": "3.19.11"
   },
   "publishConfig": {
     "access": "public"

package/src/edge-http-client.test.ts

@@ -11,7 +11,7 @@ import { EdgeHttpClient } from './edge-http-client';
 const DEV_SERVER = 'https://edge.dxos.workers.dev';
 
 describe.skipIf(process.env.CI)('EdgeHttpClient', () => {
-  it.only('should get status', async ({ expect }) => {
+  it.skip('should get status', async ({ expect }) => {
     const client = new EdgeHttpClient(DEV_SERVER);
     const identity = await createEphemeralEdgeIdentity();
     client.setIdentity(identity);

package/src/edge-http-client.ts

@@ -9,6 +9,7 @@ import * as Function from 'effect/Function';
 
 import { sleep } from '@dxos/async';
 import { Context } from '@dxos/context';
+import { runAndForwardErrors } from '@dxos/effect';
 import { invariant } from '@dxos/invariant';
 import { type PublicKey, type SpaceId } from '@dxos/keys';
 import { log } from '@dxos/log';
@@ -18,8 +19,8 @@ import {
   type CreateSpaceRequest,
   type CreateSpaceResponseBody,
   EdgeAuthChallengeError,
-  type EdgeBody,
   EdgeCallFailedError,
+  type EdgeFailure,
   type EdgeStatus,
   type ExecuteWorkflowResponseBody,
   type ExportBundleRequest,
@@ -77,14 +78,19 @@ type EdgeHttpRequestArgs = {
   json?: boolean;
 
   /**
-   * Do not expect a standard EDGE JSON response with a `success` field.
-   * @deprecated Use only for debugging.
+   * Force authentication.
+   * This should be used for requests with large bodies to avoid sending the body twice.
+   * The client will call /auth endpoint to generate the auth header.
    */
-  rawResponse?: boolean;
+  auth?: boolean;
 };
 
-export type EdgeHttpGetArgs = Pick<EdgeHttpRequestArgs, 'context' | 'retry'>;
-export type EdgeHttpPostArgs = Pick<EdgeHttpRequestArgs, 'context' | 'retry' | 'body'>;
+export type EdgeHttpGetArgs = Pick<EdgeHttpRequestArgs, 'context' | 'retry' | 'auth'>;
+export type EdgeHttpPostArgs = Pick<EdgeHttpRequestArgs, 'context' | 'retry' | 'body' | 'auth'>;
+
+export type GetCronTriggersResponse = {
+  cronIds: string[];
+};
 
 export class EdgeHttpClient {
   private readonly _baseUrl: string;
@@ -117,7 +123,7 @@ export class EdgeHttpClient {
   //
 
   public async getStatus(args?: EdgeHttpGetArgs): Promise<EdgeStatus> {
-    return this._call(new URL('/status', this.baseUrl), { ...args, method: 'GET' });
+    return this._call(new URL('/status', this.baseUrl), { ...args, method: 'GET', auth: true });
   }
 
   //
@@ -206,7 +212,8 @@ export class EdgeHttpClient {
     query: QueueQuery,
     args?: EdgeHttpGetArgs,
   ): Promise<QueryResult> {
-    const { queueId } = query;
+    const queueId = query.queueIds?.[0];
+    invariant(queueId, 'queueId required');
     return this._call(
       createUrl(new URL(`/spaces/${subspaceTag}/${spaceId}/queue/${queueId}/query`, this.baseUrl), {
         after: query.after,
@@ -268,6 +275,7 @@ export class EdgeHttpClient {
     formData.append('version', body.version);
     formData.append('ownerPublicKey', body.ownerPublicKey);
     formData.append('entryPoint', body.entryPoint);
+    body.runtime && formData.append('runtime', body.runtime);
     for (const [filename, content] of Object.entries(body.assets)) {
       formData.append(
         'assets',
@@ -318,7 +326,6 @@ export class EdgeHttpClient {
       ...args,
       body: input,
       method: 'POST',
-      rawResponse: true,
     });
   }
 
@@ -343,8 +350,16 @@ export class EdgeHttpClient {
   // Triggers
   //
 
-  public async getCronTriggers(spaceId: SpaceId) {
-    return this._call(new URL(`/test/functions/${spaceId}/triggers/crons`, this.baseUrl), { method: 'GET' });
+  public async getCronTriggers(spaceId: SpaceId): Promise<GetCronTriggersResponse> {
+    return this._call<GetCronTriggersResponse>(new URL(`/test/functions/${spaceId}/triggers/crons`, this.baseUrl), {
+      method: 'GET',
+    });
+  }
+
+  public async forceRunCronTrigger(spaceId: SpaceId, triggerId: ObjectId) {
+    return this._call(new URL(`/test/functions/${spaceId}/triggers/crons/${triggerId}/run`, this.baseUrl), {
+      method: 'POST',
+    });
   }
 
   //
@@ -375,7 +390,7 @@ export class EdgeHttpClient {
   // Internal
   //
 
-  private async _fetch<T>(url: URL, args: EdgeHttpRequestArgs): Promise<T> {
+  private async _fetch<T>(url: URL, _args: EdgeHttpRequestArgs): Promise<T> {
     return Function.pipe(
       HttpClient.get(url),
       withLogging,
@@ -383,7 +398,7 @@ export class EdgeHttpClient {
       Effect.provide(FetchHttpClient.layer),
       Effect.provide(HttpConfig.default),
       Effect.withSpan('EdgeHttpClient'),
-      Effect.runPromise,
+      runAndForwardErrors,
     ) as T;
   }
 
@@ -394,18 +409,23 @@ export class EdgeHttpClient {
     log('fetch', { url, request: args.body });
 
     let handledAuth = false;
+    const tryCount = 1;
     while (true) {
       let processingError: EdgeCallFailedError | undefined = undefined;
       try {
+        if (!this._authHeader && args.auth) {
+          const response = await fetch(new URL(`/auth`, this.baseUrl));
+          if (response.status === 401) {
+            this._authHeader = await this._handleUnauthorized(response);
+          }
+        }
+
         const request = createRequest(args, this._authHeader);
+        log('call edge', { url, tryCount, authHeader: !!this._authHeader });
         const response = await fetch(url, request);
-        const body: EdgeBody<T> | undefined =
-          response.headers.get('Content-Type') === 'application/json' ? await response.clone().json() : undefined;
 
         if (response.ok) {
-          if (args.rawResponse) {
-            return body as any;
-          }
+          const body = await response.clone().json();
           invariant(body, 'Expected body to be present');
           if (!('success' in body)) {
             return body;
@@ -419,10 +439,13 @@ export class EdgeHttpClient {
           continue;
         }
 
+        const body: EdgeFailure =
+          response.headers.get('Content-Type') === 'application/json' ? await response.clone().json() : undefined;
+
         invariant(!body?.success, 'Expected body to not be a failure response or undefined.');
 
-        if (body?.errorData?.type === 'auth_challenge' && typeof body?.errorData?.challenge === 'string') {
-          processingError = new EdgeAuthChallengeError(body.errorData.challenge, body.errorData);
+        if (body?.data?.type === 'auth_challenge' && typeof body?.data?.challenge === 'string') {
+          processingError = new EdgeAuthChallengeError(body.data.challenge, body.data);
         } else if (body?.success === false) {
           processingError = EdgeCallFailedError.fromUnsuccessfulResponse(response, body);
         } else {
@@ -434,7 +457,7 @@ export class EdgeHttpClient {
       }
 
       if (processingError?.isRetryable && (await shouldRetry(requestContext, processingError.retryAfterMs))) {
-        log('retrying edge request', { url, processingError });
+        log.verbose('retrying edge request', { url, processingError });
       } else {
         throw processingError!;
       }

package/src/http-client.test.ts

@@ -8,6 +8,7 @@ import * as Effect from 'effect/Effect';
 import * as Function from 'effect/Function';
 import { afterEach, beforeEach, describe, it } from 'vitest';
 
+import { runAndForwardErrors } from '@dxos/effect';
 import { invariant } from '@dxos/invariant';
 
 import { HttpConfig, withLogging, withRetry, withRetryConfig } from './http-client';
@@ -36,7 +37,7 @@ describe('HttpClient', () => {
         withRetry(HttpClient.get(server.url)),
         Effect.provide(FetchHttpClient.layer),
         Effect.withSpan('EdgeHttpClient'),
-        Effect.runPromise,
+        runAndForwardErrors,
       );
       expect(result).toMatchObject({ success: true, data: { value: 100 } });
     }
@@ -49,7 +50,7 @@ describe('HttpClient', () => {
         Effect.provide(FetchHttpClient.layer),
         Effect.provide(HttpConfig.default), // TODO(burdon): Swap out to mock.
         Effect.withSpan('EdgeHttpClient'), // TODO(burdon): OTEL.
-        Effect.runPromise,
+        runAndForwardErrors,
       );
       expect(result).toMatchObject({ success: true, data: { value: 100 } });
     }

package/src/http-client.ts

@@ -61,7 +61,11 @@ export const withRetryConfig = (
   });
 
 export const withLogging = <A extends HttpClientResponse.HttpClientResponse, E, R>(effect: Effect.Effect<A, E, R>) =>
-  effect.pipe(Effect.tap((res) => log.info('response', { status: res.status })));
+  effect.pipe(
+    Effect.tap((res) => {
+      log.info('response', { status: res.status });
+    }),
+  );
 
 /**
  *

package/src/testing/test-utils.ts

@@ -16,13 +16,13 @@ import { toUint8Array } from '../protocol';
 
 export const DEFAULT_PORT = 8080;
 
-type TestEdgeWsServerParams = {
+type TestEdgeWsServerProps = {
   admitConnection?: Trigger;
   payloadDecoder?: (payload: Uint8Array) => any;
   messageHandler?: (payload: any) => Promise<Uint8Array | undefined>;
 };
 
-export const createTestEdgeWsServer = async (port = DEFAULT_PORT, params?: TestEdgeWsServerParams) => {
+export const createTestEdgeWsServer = async (port = DEFAULT_PORT, params?: TestEdgeWsServerProps) => {
   const wsServer = new WebSocket.Server({
     port,
     verifyClient: createConnectionDelayHandler(params),
@@ -86,7 +86,7 @@ export const createTestEdgeWsServer = async (port = DEFAULT_PORT, params?: TestE
   };
 };
 
-const createConnectionDelayHandler = (params: TestEdgeWsServerParams | undefined) => {
+const createConnectionDelayHandler = (params: TestEdgeWsServerProps | undefined) => {
   return (_: any, callback: (admit: boolean) => void) => {
     if (params?.admitConnection) {
       log('delaying edge connection admission');
@@ -116,7 +116,7 @@ const createResponseSender = (connection: () => WebSocketMuxer) => {
   };
 };
 
-const decodePayload = async (request: Message, params: TestEdgeWsServerParams | undefined) => {
+const decodePayload = async (request: Message, params: TestEdgeWsServerProps | undefined) => {
   const requestPayload = params?.payloadDecoder
     ? params.payloadDecoder(request.payload!.value!)
     : protocol.getPayload(request, TextMessageSchema);