@dxos/functions 0.8.4-main.c4373fc → 0.8.4-main.c85a9c8dae

package/dist/types/src/url.d.ts

@@ -1,21 +0,0 @@
-import { type ObjectMeta } from '@dxos/echo/internal';
-import { type SpaceId } from '@dxos/keys';
-export declare const FUNCTIONS_META_KEY = "dxos.org/service/function";
-export declare const FUNCTIONS_PRESET_META_KEY = "dxos.org/service/function-preset";
-/**
- * NOTE: functionId is backend ID, not ECHO object id.
- */
-export declare const getUserFunctionIdInMetadata: (meta: ObjectMeta) => string | undefined;
-/**
- * NOTE: functionId is backend ID, not ECHO object id.
- */
-export declare const setUserFunctionIdInMetadata: (meta: ObjectMeta, functionId: string) => void;
-/**
- * NOTE: functionId is backend ID, not ECHO object id.
- */
-export declare const getInvocationUrl: (functionId: string, edgeUrl: string, options?: InvocationOptions) => string;
-export type InvocationOptions = {
-    spaceId?: SpaceId;
-    subjectId?: string;
-};
-//# sourceMappingURL=url.d.ts.map

package/dist/types/src/url.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"url.d.ts","sourceRoot":"","sources":["../../../src/url.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACtD,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,YAAY,CAAC;AAG1C,eAAO,MAAM,kBAAkB,8BAA8B,CAAC;AAE9D,eAAO,MAAM,yBAAyB,qCAAqC,CAAC;AAM5E;;GAEG;AACH,eAAO,MAAM,2BAA2B,GAAI,MAAM,UAAU,uBAE3D,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,2BAA2B,GAAI,MAAM,UAAU,EAAE,YAAY,MAAM,SAS/E,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,gBAAgB,GAAI,YAAY,MAAM,EAAE,SAAS,MAAM,EAAE,UAAS,iBAAsB,WASpG,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC"}

package/src/bundler/bundler.test.ts

@@ -1,58 +0,0 @@
-//
-// Copyright 2022 DXOS.org
-//
-
-// @ts-ignore
-import wasmUrl from 'esbuild-wasm/esbuild.wasm?url';
-import { assert, beforeAll, describe, expect, test } from 'vitest';
-
-import { isNode } from '@dxos/util';
-
-import { Bundler, initializeBundler } from './bundler';
-
-describe('Bundler', () => {
-  beforeAll(async () => {
-    if (!isNode()) {
-      await initializeBundler({ wasmUrl });
-    }
-  });
-
-  test('Basic', async () => {
-    const bundler = new Bundler({ platform: 'node', sandboxedModules: [], remoteModules: {} });
-    const result = await bundler.bundle({ source: 'const x = 100' }); // TODO(burdon): Test import.
-    assert(!('error' in result), 'error should not exist');
-    expect(result.asset).toBeDefined();
-  });
-
-  test('Import', async () => {
-    const bundler = new Bundler({ platform: 'node', sandboxedModules: [], remoteModules: {} });
-    const result = await bundler.bundle({
-      source: `
-      import { Filter } from './runtime.js';
-
-      const query = Filter.typename('dxos.org/type/Example');
-    `,
-    });
-    assert(!('error' in result), 'error should not exist');
-    expect(result.asset).toBeDefined();
-  });
-
-  // TODO(dmaretskyi): Flaky on CI.
-  test.skip('HTTPS Import', async () => {
-    const bundler = new Bundler({ platform: 'node', sandboxedModules: [], remoteModules: {} });
-    const result = await bundler.bundle({
-      source: `
-      import { invariant } from 'https://esm.sh/@dxos/invariant';
-      invariant(true);
-    `,
-    });
-    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();" });
-    assert('error' in result, 'error should exist');
-  });
-});

package/src/bundler/bundler.ts

@@ -1,295 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import * as FetchHttpClient from '@effect/platform/FetchHttpClient';
-import * as HttpClient from '@effect/platform/HttpClient';
-import * as Duration from 'effect/Duration';
-import * as Effect from 'effect/Effect';
-import * as Function from 'effect/Function';
-import * as Schedule from 'effect/Schedule';
-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';
-
-export type Import = {
-  moduleUrl: string;
-  defaultImport: boolean;
-  namedImports: string[];
-};
-
-export type BundleOptions = {
-  /**
-   * Source code to bundle.
-   */
-  source: string;
-};
-
-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'];
-  sandboxedModules: string[];
-  remoteModules: Record<string, string>;
-};
-
-let initialized: Promise<void>;
-export const initializeBundler = async (options: { wasmUrl: string }) => {
-  await (initialized ??= initialize({
-    wasmURL: options.wasmUrl,
-  }));
-};
-
-/**
- * ESBuild bundler.
- */
-export class Bundler {
-  constructor(private readonly _options: BundlerOptions) {}
-
-  async bundle({ source }: BundleOptions): Promise<BundleResult> {
-    const { sandboxedModules: providedModules, ...options } = this._options;
-    const sourceHash = Buffer.from(await subtleCrypto.digest('SHA-256', Buffer.from(source)));
-
-    if (this._options.platform === 'browser') {
-      invariant(initialized, 'Compiler not initialized.');
-      await initialized;
-    }
-
-    const imports = source ? analyzeSourceFileImports(source) : [];
-
-    // https://esbuild.github.io/api/#build
-    try {
-      const result = await build({
-        platform: options.platform,
-        conditions: ['workerd', 'browser'],
-        metafile: true,
-        write: false,
-        entryPoints: {
-          // Gets mapped to `userFunc.js` by esbuild.
-          userFunc: 'memory:main.tsx',
-        },
-        bundle: true,
-        format: 'esm',
-        plugins: [
-          {
-            name: 'memory',
-            setup: (build) => {
-              build.onResolve({ filter: /^\.\/runtime\.js$/ }, ({ path }) => {
-                return { path, external: true };
-              });
-
-              build.onResolve({ filter: /^dxos:functions$/ }, ({ path }) => {
-                return { path: './runtime.js', external: true };
-              });
-
-              build.onResolve({ filter: /^memory:/ }, ({ path }) => {
-                return { path: path.split(':')[1], namespace: 'memory' };
-              });
-
-              build.onLoad({ filter: /.*/, namespace: 'memory' }, ({ path }) => {
-                if (path === 'main.tsx') {
-                  return {
-                    contents: source,
-                    loader: 'tsx',
-                  };
-                }
-              });
-
-              for (const module of providedModules) {
-                build.onResolve({ filter: new RegExp(`^${module}$`) }, ({ path }) => {
-                  return { path, namespace: 'injected-module' };
-                });
-              }
-
-              build.onLoad({ filter: /.*/, namespace: 'injected-module' }, ({ path }) => {
-                const namedImports = imports.find((entry) => entry.moduleIdentifier === path)?.namedImports ?? [];
-                return {
-                  contents: `
-                  const { ${namedImports.join(',')} } = window.__DXOS_SANDBOX_MODULES__[${JSON.stringify(path)}];
-                  export { ${namedImports.join(',')} };
-                  export default window.__DXOS_SANDBOX_MODULES__[${JSON.stringify(path)}].default;
-                `,
-                  loader: 'tsx',
-                };
-              });
-            },
-          },
-          httpPlugin,
-        ],
-      });
-
-      log('compile complete', result.metafile);
-
-      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 { timestamp: Date.now(), sourceHash, error: err };
-    }
-  }
-
-  // TODO(dmaretskyi): In the future we can replace the compiler with SWC with plugins running in WASM.
-  analyzeImports(result: BuildResult): Import[] {
-    invariant(result.outputFiles);
-
-    // TODO(dmaretskyi): Support import aliases and wildcard imports.
-    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;
-        const namedImportsMatch = NAMED_IMPORTS_REGEX.exec(parsedImport[2]);
-        if (namedImportsMatch) {
-          namedImportsMatch[1].split(',').forEach((importName) => {
-            namedImports.push(importName.trim());
-          });
-        }
-      }
-
-      return {
-        moduleUrl: entry.path,
-        defaultImport: !!parsedImport?.[1],
-        namedImports,
-      };
-    });
-  }
-
-  analyzeSourceFileImports(code: string): {
-    defaultImportName: string;
-    namedImports: string[];
-    wildcardImportName: string;
-    moduleIdentifier: string;
-    quotes: string;
-  }[] {
-    // TODO(dmaretskyi): Support import aliases and wildcard imports.
-    const parsedImports = allMatches(IMPORT_REGEX, code);
-    return parsedImports.map((capture) => {
-      return {
-        defaultImportName: capture[1],
-        namedImports: capture[2]?.split(',').map((importName) => importName.trim()),
-        wildcardImportName: capture[3],
-        moduleIdentifier: capture[4],
-        quotes: capture[5],
-      };
-    });
-  }
-}
-
-// https://regex101.com/r/FEN5ks/1
-// https://stackoverflow.com/a/73265022
-// $1 = default import name (can be non-existent)
-// $2 = destructured exports (can be non-existent)
-// $3 = wildcard import name (can be non-existent)
-// $4 = module identifier
-// $5 = quotes used (either ' or ")
-const IMPORT_REGEX =
-  /import(?:(?:(?:[ \n\t]+([^ *\n\t{},]+)[ \n\t]*(?:,|[ \n\t]+))?([ \n\t]*{(?:[ \n\t]*[^ \n\t"'{}]+[ \n\t]*,?)+})?[ \n\t]*)|[ \n\t]*\*[ \n\t]*as[ \n\t]+([^ \n\t{}]+)[ \n\t]+)from[ \n\t]*(?:['"])([^'"\n]+)(['"])/gm;
-
-const NAMED_IMPORTS_REGEX = /[ \n\t]*{((?:[ \n\t]*[^ \n\t"'{}]+[ \n\t]*,?)+)}[ \n\t]*/gm;
-
-const allMatches = (regex: RegExp, str: string) => {
-  let match;
-  const matches = [];
-  regex.lastIndex = 0;
-  while ((match = regex.exec(str))) {
-    matches.push(match);
-  }
-
-  return matches;
-};
-
-type ParsedImport = {
-  defaultImportName?: string;
-  namedImports: string[];
-  wildcardImportName?: string;
-  moduleIdentifier: string;
-  quotes: string;
-};
-
-const analyzeSourceFileImports = (code: string): ParsedImport[] => {
-  // TODO(dmaretskyi): Support import aliases and wildcard imports.
-  const parsedImports = allMatches(IMPORT_REGEX, code);
-  return parsedImports.map((capture) => {
-    return {
-      defaultImportName: capture[1],
-      namedImports: capture[2]
-        ?.trim()
-        .slice(1, -1)
-        .split(',')
-        .map((importName) => importName.trim()),
-      wildcardImportName: capture[3],
-      moduleIdentifier: capture[4],
-      quotes: capture[5],
-    };
-  });
-};
-
-const MAX_RETRIES = 5;
-const INITIAL_DELAY = 1_000;
-
-const httpPlugin: Plugin = {
-  name: 'http',
-  setup: (build) => {
-    // Intercept import paths starting with "http:" and "https:" so esbuild doesn't attempt to map them to a file system location.
-    // Tag them with the "http-url" namespace to associate them with this plugin.
-    build.onResolve({ filter: /^https?:\/\// }, (args) => ({
-      path: args.path,
-      namespace: 'http-url',
-    }));
-
-    // We also want to intercept all import paths inside downloaded files and resolve them against the original URL.
-    // All of these files will be in the "http-url" namespace.
-    // Make sure to keep the newly resolved URL in the "http-url" namespace so imports inside it will also be resolved as URLs recursively.
-    build.onResolve({ filter: /.*/, namespace: 'http-url' }, (args) => ({
-      path: new URL(args.path, args.importer).toString(),
-      namespace: 'http-url',
-    }));
-
-    // 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) => {
-      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(
-          Function.pipe(
-            Schedule.exponential(Duration.millis(INITIAL_DELAY)),
-            Schedule.jittered,
-            Schedule.intersect(Schedule.recurs(MAX_RETRIES - 1)),
-          ),
-        ),
-        Effect.provide(FetchHttpClient.layer),
-        runAndForwardErrors,
-      );
-    });
-  },
-};

package/src/bundler/index.ts

@@ -1,5 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-export * from './bundler';

package/src/edge/functions.ts

@@ -1,67 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import { type DID } from 'iso-did/types';
-
-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 { log } from '@dxos/log';
-import { type UploadFunctionResponseBody } from '@dxos/protocols';
-
-export type UploadWorkerArgs = {
-  client: Client;
-  version: string;
-  name?: string;
-  functionId?: string;
-  ownerPublicKey: PublicKey;
-  entryPoint: string;
-  assets: Record<string, Uint8Array>;
-};
-
-export const uploadWorkerFunction = async ({
-  client,
-  version,
-  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);
-  const edgeIdentity = createEdgeIdentity(client);
-  edgeClient.setIdentity(edgeIdentity);
-  const response = await edgeClient.uploadFunction(
-    { functionId },
-    { name, version, ownerPublicKey: ownerPublicKey.toHex(), entryPoint, assets },
-  );
-
-  // TODO(burdon): Edge service log.
-  log('uploaded', {
-    identityKey: edgeIdentity.identityKey,
-    functionId,
-    name,
-    version,
-    response,
-  });
-
-  return response;
-};
-
-export const incrementSemverPatch = (version: string): string => {
-  const [major, minor, patch] = version.split('.');
-  const patchNum = Number(patch);
-  invariant(!Number.isNaN(patchNum), `Unexpected function version format: ${version}`);
-  return [major, minor, String(patchNum + 1)].join('.');
-};
-
-// TODO(burdon): Factor out.
-export const publicKeyToDid = (key: PublicKey): DID => {
-  return `did:key:${key.toHex()}`;
-};

package/src/edge/index.ts

@@ -1,9 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-// NOTE: This module is separate because it uses the edge client.
-//  This means it cannot be used on edge itself.
-// TODO(wittjosiah): Factor out.
-
-export * from './functions';

package/src/examples/index.ts

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

package/src/executor/executor.ts

@@ -1,58 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import * as Effect from 'effect/Effect';
-import * as Schema from 'effect/Schema';
-
-import { type SpaceId } from '@dxos/client/echo';
-import { runAndForwardErrors } from '@dxos/effect';
-
-import type { FunctionContext, FunctionDefinition } from '../handler';
-import type { ServiceContainer, Services } from '../services';
-
-/**
- * @deprecated Use `FunctionInvocationService`
- */
-export class FunctionExecutor {
-  constructor(private readonly _services: ServiceContainer) {}
-
-  /**
-   * Invoke function.
-   */
-  // TODO(dmaretskyi): Invocation context: queue, space, etc...
-  async invoke<F extends FunctionDefinition<any, any>>(
-    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 = 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.');
-      },
-    };
-
-    const result = functionDef.handler({ context, data: input });
-
-    let data: unknown;
-    if (Effect.isEffect(result)) {
-      data = await (result as Effect.Effect<unknown, unknown, Services>).pipe(
-        Effect.provide(this._services.createLayer()),
-        runAndForwardErrors,
-      );
-    } else {
-      data = await result;
-    }
-
-    // Assert output matches schema
-    const assertOutput = functionDef.outputSchema?.pipe(Schema.asserts);
-    (assertOutput as any)(data);
-
-    return data as any;
-  }
-}