feat: Introduce HttpProgramResolver, for resolving recipe dependencies over HTTP (#1772)

Author: jsantell

packages/cli/lib/charm.ts

@@ -18,7 +18,7 @@ import {
 import { CharmsController } from "@commontools/charm/ops";
 import { join } from "@std/path";
 import { isVNode } from "@commontools/html";
-import { FileSystemProgramResolver } from "@commontools/js-runtime/deno";
+import { FileSystemProgramResolver } from "@commontools/js-runtime";
 
 export interface EntryConfig {
   mainPath: string;

packages/cli/lib/dev.ts

@@ -1,5 +1,5 @@
 import { type JsScript } from "@commontools/js-runtime";
-import { FileSystemProgramResolver } from "@commontools/js-runtime/deno";
+import { FileSystemProgramResolver } from "@commontools/js-runtime";
 import { Identity } from "@commontools/identity";
 import { Engine, Runtime } from "@commontools/runner";
 import { basename } from "@std/path";

packages/js-runtime/deno.json

@@ -9,8 +9,7 @@
   },
   "exports": {
     ".": "./mod.ts",
-    "./typescript": "./typescript/mod.ts",
-    "./deno": "./deno.ts"
+    "./typescript": "./typescript/mod.ts"
   },
   "fmt": {
     "exclude": ["test/fixtures/"]

packages/js-runtime/deno.ts

@@ -48,7 +48,7 @@ export interface Compiler<T> {
 // A program's entry point with a resolver to
 // resolve other sources used in the program.
 export interface ProgramResolver {
-  main(): Source;
+  main(): Promise<Source>;
   resolveSource(identifier: string): Promise<Source | undefined>;
 }
 

packages/js-runtime/interface.ts

@@ -19,5 +19,9 @@ export {
   UnsafeEvalJsValue,
   UnsafeEvalRuntime,
 } from "./runtime/mod.ts";
-export { InMemoryProgram } from "./program.ts";
+export {
+  FileSystemProgramResolver,
+  HttpProgramResolver,
+  InMemoryProgram,
+} from "./program.ts";
 export { getTypeScriptEnvironmentTypes } from "./utils.ts";

packages/js-runtime/mod.ts

@@ -1,4 +1,6 @@
+import { isDeno } from "@commontools/utils/env";
 import { ProgramResolver, Source } from "./interface.ts";
+import { dirname, join } from "@std/path";
 
 export class InMemoryProgram implements ProgramResolver {
   private modules: Record<string, string>;
@@ -8,12 +10,12 @@ export class InMemoryProgram implements ProgramResolver {
     this._main = main;
   }
 
-  main(): Source {
+  main(): Promise<Source> {
     const main = this.modules[this._main];
     if (!main) {
       throw new Error(`${this._main} not in modules.`);
     }
-    return { name: this._main, contents: main };
+    return Promise.resolve({ name: this._main, contents: main });
   }
 
   resolveSource(identifier: string): Promise<Source | undefined> {
@@ -22,3 +24,83 @@ export class InMemoryProgram implements ProgramResolver {
     return Promise.resolve({ contents, name: identifier });
   }
 }
+
+// Resolve a program using the file system.
+// Deno-only.
+export class FileSystemProgramResolver implements ProgramResolver {
+  private fsRoot: string;
+  private _main: Source;
+  constructor(mainPath: string) {
+    this.fsRoot = dirname(mainPath);
+    this._main = {
+      name: mainPath.substring(this.fsRoot.length),
+      contents: this.#readFile(mainPath),
+    };
+  }
+
+  main(): Promise<Source> {
+    return Promise.resolve(this._main);
+  }
+
+  resolveSource(specifier: string): Promise<Source | undefined> {
+    if (!specifier || specifier[0] !== "/") {
+      return Promise.resolve(undefined);
+    }
+    const absPath = join(
+      this.fsRoot,
+      specifier.substring(1, specifier.length),
+    );
+    return Promise.resolve({
+      name: specifier,
+      contents: this.#readFile(absPath),
+    });
+  }
+
+  #readFile(path: string): string {
+    if (!isDeno()) {
+      throw new Error(
+        "FileSystemProgramResolver is not supported in this environment.",
+      );
+    }
+    return Deno.readTextFileSync(path);
+  }
+}
+
+// Resolve a program from HTTP.
+export class HttpProgramResolver implements ProgramResolver {
+  #httpRoot: string;
+  #mainUrl: URL;
+  #main?: Promise<Source>;
+  constructor(main: string | URL) {
+    this.#mainUrl = !(main instanceof URL) ? new URL(main) : main;
+    this.#httpRoot = dirname(this.#mainUrl.pathname);
+  }
+
+  main(): Promise<Source> {
+    if (!this.#main) {
+      this.#main = this.#fetch(this.#mainUrl);
+    }
+    return this.#main;
+  }
+
+  resolveSource(specifier: string): Promise<Source | undefined> {
+    if (!specifier || specifier[0] !== "/") {
+      return Promise.resolve(undefined);
+    }
+    const url = new URL(this.#mainUrl);
+    url.pathname = join(
+      this.#httpRoot,
+      specifier.substring(1, specifier.length),
+    );
+    return this.#fetch(url);
+  }
+
+  async #fetch(url: URL): Promise<Source> {
+    const res = await fetch(url);
+    const contents = await res.text();
+    return {
+      name: url.pathname.substring(this.#httpRoot.length),
+      contents,
+    };
+  }
+}

packages/js-runtime/program.ts

@@ -18,7 +18,7 @@ export async function resolveProgram(
   { unresolvedModules, target, resolveUnresolvedModuleTypes }:
     ResolveModuleConfig,
 ): Promise<Program> {
-  const main = graph.main();
+  const main = await graph.main();
   const sources = new Map([[main.name, main]]);
   const toProcess = [main.name];
   const processed: string[] = [];

packages/js-runtime/typescript/resolver.ts

@@ -4,7 +4,7 @@ import { afterAll, beforeAll, describe, it } from "@std/testing/bdd";
 import { join } from "@std/path";
 import { assert } from "@std/assert";
 import { Identity } from "@commontools/identity";
-import { FileSystemProgramResolver } from "@commontools/js-runtime/deno";
+import { FileSystemProgramResolver } from "@commontools/js-runtime";
 import { RuntimeProgram } from "@commontools/runner";
 
 const { API_URL, SPACE_NAME } = env;

packages/patterns/integration/all.test.ts

@@ -5,7 +5,7 @@ import { afterAll, beforeAll, describe, it } from "@std/testing/bdd";
 import { join } from "@std/path";
 import { assert, assertEquals } from "@std/assert";
 import { Identity } from "@commontools/identity";
-import { FileSystemProgramResolver } from "@commontools/js-runtime/deno";
+import { FileSystemProgramResolver } from "@commontools/js-runtime";
 
 const { API_URL, FRONTEND_URL, SPACE_NAME } = env;