@dxos/functions 0.8.3 → 0.8.4-main.1da679c

package/package.json

@@ -1,30 +1,34 @@
 {
   "name": "@dxos/functions",
-  "version": "0.8.3",
+  "version": "0.8.4-main.1da679c",
   "description": "Functions API and runtime.",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
   "license": "MIT",
   "author": "info@dxos.org",
-  "sideEffects": true,
+  "sideEffects": false,
   "type": "module",
   "exports": {
     ".": {
+      "source": "./src/index.ts",
       "types": "./dist/types/src/index.d.ts",
       "browser": "./dist/lib/browser/index.mjs",
       "node": "./dist/lib/node-esm/index.mjs"
     },
     "./bundler": {
+      "source": "./src/bundler/index.ts",
       "types": "./dist/types/src/bundler/index.d.ts",
       "browser": "./dist/lib/browser/bundler/index.mjs",
       "node": "./dist/lib/node-esm/bundler/index.mjs"
     },
     "./edge": {
+      "source": "./src/edge/index.ts",
       "types": "./dist/types/src/edge/index.d.ts",
       "browser": "./dist/lib/browser/edge/index.mjs",
       "node": "./dist/lib/node-esm/edge/index.mjs"
     },
     "./testing": {
+      "source": "./src/testing/index.ts",
       "types": "./dist/types/src/testing/index.d.ts",
       "browser": "./dist/lib/browser/testing/index.mjs",
       "node": "./dist/lib/node-esm/testing/index.mjs"
@@ -47,43 +51,49 @@
     "src"
   ],
   "dependencies": {
+    "@effect/platform": "0.90.2",
     "@preact/signals-core": "^1.9.0",
     "cron": "^3.1.6",
     "cron-schedule": "^5.0.4",
-    "effect": "3.14.21",
+    "effect": "3.17.7",
     "esbuild-wasm": "^0.16.14",
     "express": "^4.19.2",
     "get-port-please": "^3.1.1",
+    "i18next": "^24.2.1",
     "iso-did": "^1.6.0",
     "ws": "^8.14.2",
-    "@dxos/ai": "0.8.3",
-    "@dxos/client": "0.8.3",
-    "@dxos/async": "0.8.3",
-    "@dxos/crypto": "0.8.3",
-    "@dxos/echo": "0.8.3",
-    "@dxos/context": "0.8.3",
-    "@dxos/echo-protocol": "0.8.3",
-    "@dxos/echo-db": "0.8.3",
-    "@dxos/echo-schema": "0.8.3",
-    "@dxos/edge-client": "0.8.3",
-    "@dxos/invariant": "0.8.3",
-    "@dxos/keys": "0.8.3",
-    "@dxos/live-object": "0.8.3",
-    "@dxos/log": "0.8.3",
-    "@dxos/node-std": "0.8.3",
-    "@dxos/protocols": "0.8.3",
-    "@dxos/schema": "0.8.3",
-    "@dxos/util": "0.8.3"
+    "@dxos/ai": "0.8.4-main.1da679c",
+    "@dxos/async": "0.8.4-main.1da679c",
+    "@dxos/client": "0.8.4-main.1da679c",
+    "@dxos/client-protocol": "0.8.4-main.1da679c",
+    "@dxos/context": "0.8.4-main.1da679c",
+    "@dxos/crypto": "0.8.4-main.1da679c",
+    "@dxos/debug": "0.8.4-main.1da679c",
+    "@dxos/echo": "0.8.4-main.1da679c",
+    "@dxos/echo-db": "0.8.4-main.1da679c",
+    "@dxos/echo-pipeline": "0.8.4-main.1da679c",
+    "@dxos/echo-protocol": "0.8.4-main.1da679c",
+    "@dxos/echo-schema": "0.8.4-main.1da679c",
+    "@dxos/edge-client": "0.8.4-main.1da679c",
+    "@dxos/effect": "0.8.4-main.1da679c",
+    "@dxos/errors": "0.8.4-main.1da679c",
+    "@dxos/invariant": "0.8.4-main.1da679c",
+    "@dxos/keys": "0.8.4-main.1da679c",
+    "@dxos/kv-store": "0.8.4-main.1da679c",
+    "@dxos/live-object": "0.8.4-main.1da679c",
+    "@dxos/log": "0.8.4-main.1da679c",
+    "@dxos/node-std": "0.8.4-main.1da679c",
+    "@dxos/protocols": "0.8.4-main.1da679c",
+    "@dxos/schema": "0.8.4-main.1da679c",
+    "@dxos/util": "0.8.4-main.1da679c"
   },
   "devDependencies": {
     "@types/express": "^4.17.17",
     "@types/ws": "^7.4.0",
-    "@dxos/agent": "0.8.3"
+    "@dxos/agent": "0.8.4-main.1da679c"
   },
   "publishConfig": {
     "access": "public"
   },
-  "scripts": {
-    "gen-schema": "ts-node ./tools/schema.ts"
-  }
+  "scripts": {}
 }

package/src/bundler/bundler.test.ts

@@ -4,7 +4,7 @@
 
 // @ts-ignore
 import wasmUrl from 'esbuild-wasm/esbuild.wasm?url';
-import { beforeAll, describe, expect, test } from 'vitest';
+import { assert, beforeAll, describe, expect, test } from 'vitest';
 
 import { isNode } from '@dxos/util';
 
@@ -20,8 +20,8 @@ describe('Bundler', () => {
   test('Basic', async () => {
     const bundler = new Bundler({ platform: 'node', sandboxedModules: [], remoteModules: {} });
     const result = await bundler.bundle({ source: 'const x = 100' }); // TODO(burdon): Test import.
-    expect(result.bundle).to.exist;
-    expect(result.error).to.not.exist;
+    assert(!('error' in result), 'error should not exist');
+    expect(result.asset).toBeDefined();
   });
 
   test('Import', async () => {
@@ -33,11 +33,11 @@ describe('Bundler', () => {
       const query = Filter.typename('dxos.org/type/Example');
     `,
     });
-    expect(result.bundle).to.exist;
-    expect(result.error).to.not.exist;
+    assert(!('error' in result), 'error should not exist');
+    expect(result.asset).toBeDefined();
   });
 
-  // TODO(dmaretskyi): Flaky on CI: https://cloud.nx.app/runs/Hjcifa8Ccq/task/plugin-script%3Atest
+  // TODO(dmaretskyi): Flaky on CI.
   test.skip('HTTPS Import', async () => {
     const bundler = new Bundler({ platform: 'node', sandboxedModules: [], remoteModules: {} });
     const result = await bundler.bundle({
@@ -46,14 +46,13 @@ describe('Bundler', () => {
       invariant(true);
     `,
     });
-    expect(result.bundle).to.exist;
-    expect(result.error).to.not.exist;
+    assert(!('error' in result), 'error should not exist');
+    expect(result.asset).toBeDefined();
   });
 
   test('Error', async () => {
     const bundler = new Bundler({ platform: 'node', sandboxedModules: [], remoteModules: {} });
     const result = await bundler.bundle({ source: "import missing from './module'; missing();" });
-    expect(result.bundle).to.not.exist;
-    expect(result.error).to.exist;
+    assert('error' in result, 'error should exist');
   });
 });

package/src/bundler/bundler.ts

@@ -2,10 +2,12 @@
 // Copyright 2023 DXOS.org
 //
 
-import { type BuildOptions } from 'esbuild';
-import { build, initialize, type BuildResult, type Plugin } from 'esbuild-wasm';
+import { FetchHttpClient, HttpClient } from '@effect/platform';
+import { Duration, Effect, Schedule, pipe } from 'effect';
+import { type BuildOptions, type BuildResult, type Loader, type Plugin, build, initialize } from 'esbuild-wasm';
 
 import { subtleCrypto } from '@dxos/crypto';
+import { runAndForwardErrors } from '@dxos/effect';
 import { invariant } from '@dxos/invariant';
 import { log } from '@dxos/log';
 
@@ -16,26 +18,26 @@ export type Import = {
 };
 
 export type BundleOptions = {
-  /**
-   * Path to the source file on the local file system.
-   * If provided, the path will be used instead of the `source` code.
-   */
-  path?: string;
-
   /**
    * Source code to bundle.
-   * Required if `path` is not provided.
    */
-  source?: string;
+  source: string;
 };
 
-export type BundleResult = {
-  timestamp: number;
-  sourceHash?: Buffer;
-  imports?: Import[];
-  bundle?: string;
-  error?: any;
-};
+export type BundleResult =
+  | {
+      timestamp: number;
+      sourceHash: Buffer;
+      error: unknown;
+    }
+  | {
+      timestamp: number;
+      sourceHash: Buffer;
+      imports: Import[];
+      entryPoint: string;
+      asset: Uint8Array;
+      bundle: string;
+    };
 
 export type BundlerOptions = {
   platform: BuildOptions['platform'];
@@ -56,16 +58,9 @@ export const initializeBundler = async (options: { wasmUrl: string }) => {
 export class Bundler {
   constructor(private readonly _options: BundlerOptions) {}
 
-  async bundle({ path, source }: BundleOptions): Promise<BundleResult> {
+  async bundle({ source }: BundleOptions): Promise<BundleResult> {
     const { sandboxedModules: providedModules, ...options } = this._options;
-
-    const createResult = async (result?: Partial<BundleResult>) => {
-      return {
-        timestamp: Date.now(),
-        sourceHash: source ? Buffer.from(await subtleCrypto.digest('SHA-256', Buffer.from(source))) : undefined,
-        ...result,
-      };
-    };
+    const sourceHash = Buffer.from(await subtleCrypto.digest('SHA-256', Buffer.from(source)));
 
     if (this._options.platform === 'browser') {
       invariant(initialized, 'Compiler not initialized.');
@@ -81,7 +76,10 @@ export class Bundler {
         conditions: ['workerd', 'browser'],
         metafile: true,
         write: false,
-        entryPoints: [path ?? 'memory:main.tsx'],
+        entryPoints: {
+          // Gets mapped to `userFunc.js` by esbuild.
+          userFunc: 'memory:main.tsx',
+        },
         bundle: true,
         format: 'esm',
         plugins: [
@@ -134,12 +132,17 @@ export class Bundler {
 
       log('compile complete', result.metafile);
 
-      return await createResult({
+      const entryPoint = 'userFunc.js';
+      return {
+        timestamp: Date.now(),
+        sourceHash,
         imports: this.analyzeImports(result),
+        entryPoint,
+        asset: result.outputFiles![0].contents,
         bundle: result.outputFiles![0].text,
-      });
+      };
     } catch (err) {
-      return await createResult({ error: err });
+      return { timestamp: Date.now(), sourceHash, error: err };
     }
   }
 
@@ -151,7 +154,6 @@ export class Bundler {
     const parsedImports = allMatches(IMPORT_REGEX, result.outputFiles[0].text);
     return Object.values(result.metafile!.outputs)[0].imports.map((entry): Import => {
       const namedImports: string[] = [];
-
       const parsedImport = parsedImports.find((capture) => capture?.[4] === entry.path);
       if (parsedImport?.[2]) {
         NAMED_IMPORTS_REGEX.lastIndex = 0;
@@ -205,10 +207,9 @@ const IMPORT_REGEX =
 const NAMED_IMPORTS_REGEX = /[ \n\t]*{((?:[ \n\t]*[^ \n\t"'{}]+[ \n\t]*,?)+)}[ \n\t]*/gm;
 
 const allMatches = (regex: RegExp, str: string) => {
-  regex.lastIndex = 0;
-
   let match;
   const matches = [];
+  regex.lastIndex = 0;
   while ((match = regex.exec(str))) {
     matches.push(match);
   }
@@ -242,6 +243,9 @@ const analyzeSourceFileImports = (code: string): ParsedImport[] => {
   });
 };
 
+const MAX_RETRIES = 5;
+const INITIAL_DELAY = 1_000;
+
 const httpPlugin: Plugin = {
   name: 'http',
   setup: (build) => {
@@ -263,8 +267,25 @@ const httpPlugin: Plugin = {
     // When a URL is loaded, we want to actually download the content from the internet.
     // This has just enough logic to be able to handle the example import from unpkg.com but in reality this would probably need to be more complex.
     build.onLoad({ filter: /.*/, namespace: 'http-url' }, async (args) => {
-      const response = await fetch(args.path);
-      return { contents: await response.text(), loader: 'jsx' };
+      return Effect.gen(function* () {
+        const response = yield* HttpClient.get(args.path);
+        if (response.status !== 200) {
+          throw new Error(`failed to fetch: ${response.status}`);
+        }
+
+        const text = yield* response.text;
+        return { contents: text, loader: 'jsx' as Loader };
+      }).pipe(
+        Effect.retry(
+          pipe(
+            Schedule.exponential(Duration.millis(INITIAL_DELAY)),
+            Schedule.jittered,
+            Schedule.intersect(Schedule.recurs(MAX_RETRIES - 1)),
+          ),
+        ),
+        Effect.provide(FetchHttpClient.layer),
+        runAndForwardErrors,
+      );
     });
   },
 };

package/src/edge/functions.ts

@@ -8,27 +8,30 @@ import { type Client } from '@dxos/client';
 import { createEdgeIdentity } from '@dxos/client/edge';
 import { EdgeHttpClient } from '@dxos/edge-client';
 import { invariant } from '@dxos/invariant';
-import type { PublicKey } from '@dxos/keys';
+import { type PublicKey } from '@dxos/keys';
 import { log } from '@dxos/log';
 import { type UploadFunctionResponseBody } from '@dxos/protocols';
 
 export type UploadWorkerArgs = {
   client: Client;
-  source: string;
   version: string;
   name?: string;
   functionId?: string;
   ownerPublicKey: PublicKey;
+  entryPoint: string;
+  assets: Record<string, Uint8Array>;
 };
 
 export const uploadWorkerFunction = async ({
   client,
   version,
-  source,
   name,
   functionId,
   ownerPublicKey,
+  entryPoint,
+  assets,
 }: UploadWorkerArgs): Promise<UploadFunctionResponseBody> => {
+  log('uploading function', { functionId, name, version, ownerPublicKey });
   const edgeUrl = client.config.values.runtime?.services?.edge?.url;
   invariant(edgeUrl, 'Edge is not configured.');
   const edgeClient = new EdgeHttpClient(edgeUrl);
@@ -36,15 +39,15 @@ export const uploadWorkerFunction = async ({
   edgeClient.setIdentity(edgeIdentity);
   const response = await edgeClient.uploadFunction(
     { functionId },
-    { name, version, script: source, ownerPublicKey: ownerPublicKey.toHex() },
+    { name, version, ownerPublicKey: ownerPublicKey.toHex(), entryPoint, assets },
   );
 
   // TODO(burdon): Edge service log.
-  log.info('Uploaded', {
+  log('uploaded', {
     identityKey: edgeIdentity.identityKey,
     functionId,
     name,
-    source: source.length,
+    version,
     response,
   });
 

package/src/errors.ts

@@ -0,0 +1,21 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { BaseError, type BaseErrorOptions } from '@dxos/errors';
+
+export class ServiceNotAvailableError extends BaseError.extend('SERVICE_NOT_AVAILABLE', 'Service not available') {
+  constructor(service: string, options?: Omit<BaseErrorOptions, 'context'>) {
+    super({ context: { service }, ...options });
+  }
+}
+
+export class FunctionNotFoundError extends BaseError.extend('FUNCTION_NOT_FOUND', 'Function not found') {
+  constructor(functionKey: string, options?: Omit<BaseErrorOptions, 'context'>) {
+    super({ context: { function: functionKey }, ...options });
+  }
+}
+
+export class FunctionError extends BaseError.extend('FUNCTION_ERROR', 'Function invocation error') {}
+
+export class TriggerStateNotFoundError extends BaseError.extend('TRIGGER_STATE_NOT_FOUND', 'Trigger state not found') {}

package/src/examples/fib.ts

@@ -0,0 +1,30 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { Effect, Schema } from 'effect';
+
+import { defineFunction } from '../handler';
+
+export default defineFunction({
+  name: 'example.org/function/fib',
+  description: 'Function that calculates a Fibonacci number',
+  inputSchema: Schema.Struct({
+    iterations: Schema.optional(Schema.Number).annotations({
+      description: 'Number of iterations',
+      default: 100_000,
+    }),
+  }),
+  outputSchema: Schema.Struct({
+    result: Schema.String,
+  }),
+  handler: Effect.fn(function* ({ data: { iterations = 100_000 } }) {
+    let a = 0n;
+    let b = 1n;
+    for (let i = 0; i < iterations; i++) {
+      a += b;
+      b = a - b;
+    }
+    return { result: a.toString() };
+  }),
+});

package/src/examples/index.ts

@@ -0,0 +1,7 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+export { default as fib } from './fib';
+export { default as reply } from './reply';
+export { default as sleep } from './sleep';

package/src/examples/reply.ts

@@ -0,0 +1,18 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { Console, Effect, Schema } from 'effect';
+
+import { defineFunction } from '../handler';
+
+export default defineFunction({
+  name: 'example.org/function/reply',
+  description: 'Function that echoes the input',
+  inputSchema: Schema.Any,
+  outputSchema: Schema.Any,
+  handler: Effect.fn(function* ({ data }) {
+    yield* Console.log('reply', { data });
+    return data;
+  }),
+});

package/src/examples/sleep.ts

@@ -0,0 +1,22 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { Effect, Schema } from 'effect';
+
+import { defineFunction } from '../handler';
+
+export default defineFunction({
+  name: 'example.org/function/sleep',
+  description: 'Function that sleeps for a given amount of time',
+  inputSchema: Schema.Struct({
+    duration: Schema.optional(Schema.Number).annotations({
+      description: 'Milliseconds to sleep',
+      default: 100_000,
+    }),
+  }),
+  outputSchema: Schema.Void,
+  handler: Effect.fn(function* ({ data: { duration = 100_000 } }) {
+    yield* Effect.sleep(duration);
+  }),
+});

package/src/executor/executor.ts

@@ -4,44 +4,51 @@
 
 import { Effect, Schema } from 'effect';
 
-import type { SpaceId } from '@dxos/client/echo';
+import { type SpaceId } from '@dxos/client/echo';
+import { runAndForwardErrors } from '@dxos/effect';
 
 import type { FunctionContext, FunctionDefinition } from '../handler';
-import type { ServiceContainer } from '../services';
+import type { ServiceContainer, Services } from '../services';
 
 export class FunctionExecutor {
   constructor(private readonly _services: ServiceContainer) {}
 
+  /**
+   * Invoke function.
+   */
   // TODO(dmaretskyi): Invocation context: queue, space, etc...
   async invoke<F extends FunctionDefinition<any, any>>(
-    fnDef: F,
+    functionDef: F,
     input: F extends FunctionDefinition<infer I, infer _O> ? I : never,
   ): Promise<F extends FunctionDefinition<infer _I, infer O> ? O : never> {
     // Assert input matches schema
-    const assertInput = fnDef.inputSchema.pipe(Schema.asserts);
+    const assertInput = functionDef.inputSchema.pipe(Schema.asserts);
     (assertInput as any)(input);
 
     const context: FunctionContext = {
+      space: undefined,
       getService: this._services.getService.bind(this._services),
       getSpace: async (_spaceId: SpaceId) => {
         throw new Error('Not available. Use the database service instead.');
       },
-      space: undefined,
-      get ai(): never {
-        throw new Error('Not available. Use the ai service instead.');
-      },
     };
 
-    const result = await fnDef.handler({ context, data: input });
-
-    // Assert output matches schema
-    const assertOutput = fnDef.outputSchema?.pipe(Schema.asserts);
-    (assertOutput as any)(result);
+    const result = functionDef.handler({ context, data: input });
 
+    let data: unknown;
     if (Effect.isEffect(result)) {
-      return Effect.runPromise(result as any);
+      data = await (result as Effect.Effect<unknown, unknown, Services>).pipe(
+        Effect.provide(this._services.createLayer()),
+        runAndForwardErrors,
+      );
+    } else {
+      data = await result;
     }
 
-    return result as any;
+    // Assert output matches schema
+    const assertOutput = functionDef.outputSchema?.pipe(Schema.asserts);
+    (assertOutput as any)(data);
+
+    return data as any;
   }
 }