@dxos/functions 0.8.4-main.dedc0f3 → 0.8.4-main.e8ec1fe

package/src/bundler/bundler.ts

@@ -1,291 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-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';
-
-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(
-          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,54 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { Effect, Schema } from 'effect';
-
-import { type SpaceId } from '@dxos/client/echo';
-import { runAndForwardErrors } from '@dxos/effect';
-
-import type { FunctionContext, FunctionDefinition } from '../handler';
-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>>(
-    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;
-  }
-}

package/src/handler.ts

@@ -1,201 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import { type Context, Effect, Schema, type Types } from 'effect';
-
-import { Obj, Type } from '@dxos/echo';
-import { type EchoDatabase } from '@dxos/echo-db';
-import { type HasId } from '@dxos/echo-schema';
-import { assertArgument } from '@dxos/invariant';
-import { type DXN, type SpaceId } from '@dxos/keys';
-import { type QueryResult } from '@dxos/protocols';
-
-import { FunctionType } from './schema';
-import { type Services } from './services';
-
-// TODO(burdon): Model after http request. Ref Lambda/OpenFaaS.
-// https://docs.aws.amazon.com/lambda/latest/dg/typescript-handler.html
-// https://www.serverless.com/framework/docs/providers/aws/guide/serverless.yml/#functions
-// https://www.npmjs.com/package/aws-lambda
-
-/**
- * Function handler.
- */
-export type FunctionHandler<TData = {}, TOutput = any> = (params: {
-  /**
-   * Services and context available to the function.
-   */
-  context: FunctionContext;
-
-  /**
-   * Data passed as the input to the function.
-   * Must match the function's input schema.
-   * This will be the payload from the trigger or other data passed into the function in a workflow.
-   */
-  data: TData;
-}) => TOutput | Promise<TOutput> | Effect.Effect<TOutput, any, Services>;
-
-/**
- * Function context.
- */
-export interface FunctionContext {
-  /**
-   * Space from which the function was invoked.
-   */
-  space: SpaceAPI | undefined;
-
-  /**
-   * Resolves a service available to the function.
-   * @throws if the service is not available.
-   */
-  getService: <T extends Context.Tag<any, any>>(tag: T) => Context.Tag.Service<T>;
-
-  getSpace: (spaceId: SpaceId) => Promise<SpaceAPI>;
-}
-
-export interface FunctionContextAi {
-  // TODO(dmaretskyi): Refer to cloudflare AI docs for more comprehensive typedefs.
-  run(model: string, inputs: any, options?: any): Promise<any>;
-}
-
-//
-// API.
-//
-
-// TODO(dmaretskyi): Temporary API to get the queues working.
-// TODO(dmaretskyi): To be replaced with integrating queues into echo.
-export interface QueuesAPI {
-  queryQueue(queue: DXN, options?: {}): Promise<QueryResult>;
-  insertIntoQueue(queue: DXN, objects: HasId[]): Promise<void>;
-}
-
-/**
- * Space interface available to functions.
- */
-export interface SpaceAPI {
-  get id(): SpaceId;
-  get db(): EchoDatabase;
-
-  // TODO(dmaretskyi): Align with echo api: queues.get(id).append(items);
-  get queues(): QueuesAPI;
-}
-
-// TODO(wittjosiah): Queues are incompatible.
-const __assertFunctionSpaceIsCompatibleWithTheClientSpace = () => {
-  // const _: SpaceAPI = {} as Space;
-};
-
-const typeId = Symbol.for('@dxos/functions/FunctionDefinition');
-
-export type FunctionDefinition<T = any, O = any> = {
-  [typeId]: true;
-  // TODO(dmaretskyi): Use `key` for FQN and `name` for human-readable-name.
-  key: string;
-  name: string;
-  description?: string;
-  inputSchema: Schema.Schema<T, any>;
-  outputSchema?: Schema.Schema<O, any>;
-  handler: FunctionHandler<T, O>;
-};
-
-export const defineFunction: {
-  <I, O>(params: {
-    // TODO(dmaretskyi): Make `key` required.
-    key?: string;
-    name: string;
-    description?: string;
-    inputSchema: Schema.Schema<I, any>;
-    outputSchema?: Schema.Schema<O, any>;
-    handler: Types.NoInfer<FunctionHandler<I, O>>;
-  }): FunctionDefinition<I, O>;
-} = ({ key, name, description, inputSchema, outputSchema = Schema.Any, handler }) => {
-  if (!Schema.isSchema(inputSchema)) {
-    throw new Error('Input schema must be a valid schema');
-  }
-  if (typeof handler !== 'function') {
-    throw new Error('Handler must be a function');
-  }
-
-  // Captures the function definition location.
-  const limit = Error.stackTraceLimit;
-  Error.stackTraceLimit = 2;
-  const traceError = new Error();
-  Error.stackTraceLimit = limit;
-  let cache: false | string = false;
-  const captureStackTrace = () => {
-    if (cache !== false) {
-      return cache;
-    }
-    if (traceError.stack !== undefined) {
-      const stack = traceError.stack.split('\n');
-      if (stack[2] !== undefined) {
-        cache = stack[2].trim();
-        return cache;
-      }
-    }
-  };
-
-  const handlerWithSpan = (...args: any[]) => {
-    const result = (handler as any)(...args);
-    if (Effect.isEffect(result)) {
-      return Effect.withSpan(result, `${key ?? name}`, {
-        captureStackTrace,
-      });
-    }
-    return result;
-  };
-
-  return {
-    [typeId]: true,
-    key: key ?? name,
-    name,
-    description,
-    inputSchema,
-    outputSchema,
-    handler: handlerWithSpan,
-  };
-};
-
-export const FunctionDefinition = {
-  make: defineFunction,
-  isFunction: (value: unknown): value is FunctionDefinition.Any => {
-    return typeof value === 'object' && value !== null && Symbol.for('@dxos/functions/FunctionDefinition') in value;
-  },
-  serialize: (functionDef: FunctionDefinition.Any): FunctionType => {
-    assertArgument(FunctionDefinition.isFunction(functionDef), 'functionDef');
-    return serializeFunction(functionDef);
-  },
-  deserialize: (functionObj: FunctionType): FunctionDefinition.Any => {
-    assertArgument(Obj.instanceOf(FunctionType, functionObj), 'functionObj');
-    return deserializeFunction(functionObj);
-  },
-};
-export declare namespace FunctionDefinition {
-  export type Any = FunctionDefinition<any, any>;
-  export type Input<T extends FunctionDefinition> = T extends FunctionDefinition<infer I, any> ? I : never;
-  export type Output<T extends FunctionDefinition> = T extends FunctionDefinition<any, infer O> ? O : never;
-}
-
-export const serializeFunction = (functionDef: FunctionDefinition<any, any>): FunctionType =>
-  Obj.make(FunctionType, {
-    key: functionDef.name,
-    name: functionDef.name,
-    version: '0.1.0',
-    description: functionDef.description,
-    inputSchema: Type.toJsonSchema(functionDef.inputSchema),
-    outputSchema: !functionDef.outputSchema ? undefined : Type.toJsonSchema(functionDef.outputSchema),
-  });
-
-export const deserializeFunction = (functionObj: FunctionType): FunctionDefinition<unknown, unknown> => {
-  return {
-    [typeId]: true,
-    // TODO(dmaretskyi): Fix key.
-    key: functionObj.key ?? functionObj.name,
-    name: functionObj.name,
-    description: functionObj.description,
-    inputSchema: !functionObj.inputSchema ? Schema.Unknown : Type.toEffectSchema(functionObj.inputSchema),
-    outputSchema: !functionObj.outputSchema ? undefined : Type.toEffectSchema(functionObj.outputSchema),
-    handler: () => {},
-  };
-};