feat: Exposes a RecipeEnvironment to recipes run in a context. (#900)

Allows requests to call toolshed in Deno environment.

Author: jsantell

background-charm-service/src/worker.ts

@@ -5,14 +5,14 @@ import {
   isStream,
   onError,
   setBobbyServerUrl,
+  setRecipeEnvironment,
   storage,
 } from "@commontools/runner";
 import {
   type DID,
   Identity,
   KeyPairRaw,
   openSession,
-  type Session,
 } from "@commontools/identity";
 
 let initialized = false;
@@ -28,7 +28,7 @@ onError((e: Error) => {
 });
 
 async function setup(
-  data: { did: string; toolshedUrl: string; rawIdentity: KeyPairRaw},
+  data: { did: string; toolshedUrl: string; rawIdentity: KeyPairRaw },
 ) {
   if (initialized) {
     console.log(`Worker: Already initialized, skipping setup`);
@@ -46,11 +46,15 @@ async function setup(
     throw new Error("Worker missing rawIdentity");
   }
 
-  const identity = await Identity.deserialize(rawIdentity); 
+  const identity = await Identity.deserialize(rawIdentity);
+  const apiUrl = new URL(toolshedUrl);
   // Initialize storage and remote connection
-  storage.setRemoteStorage(new URL(toolshedUrl));
+  storage.setRemoteStorage(apiUrl);
   setBobbyServerUrl(toolshedUrl);
   storage.setSigner(identity);
+  setRecipeEnvironment({
+    apiUrl,
+  });
 
   // Initialize session
   spaceId = did as DID;

builder/src/env.ts

@@ -0,0 +1,32 @@
+import { isDeno } from "@commontools/utils/env";
+
+// Environment configuration provided to recipes. Could
+// eventually be e.g. `import.meta` exposed to recipes.
+//
+// /!\ These should not be globals (outside of recipe execution context).
+// /!\ Execution needs to be sandboxed to prevent recipes setting these values.
+
+// Environment configuration available to recipes.
+export interface RecipeEnvironment {
+  readonly apiUrl: URL;
+}
+
+let globalEnv = {
+  apiUrl: isDeno()
+    ? new URL("http://localhost:8000")
+    : new URL(new URL(globalThis.location.href).origin),
+};
+
+// Sets the `RecipeEnvironment` for all recipes executed
+// within this JavaScript context.
+export function setRecipeEnvironment(env: RecipeEnvironment) {
+  globalEnv = env;
+}
+
+// Gets the `RecipeEnvironment` for all recipes executed
+// within this JavaScript context.
+//
+// User-visible.
+export function getRecipeEnvironment(): RecipeEnvironment {
+  return globalEnv;
+}

builder/src/index.ts

@@ -9,6 +9,11 @@ export {
   lift,
   render,
 } from "./module.ts";
+export {
+  getRecipeEnvironment,
+  type RecipeEnvironment,
+  setRecipeEnvironment,
+} from "./env.ts";
 export {
   getTopFrame,
   popFrame,

recipes/gmail.tsx

@@ -2,6 +2,7 @@ import { h } from "@commontools/html";
 import {
   cell,
   derive,
+  getRecipeEnvironment,
   handler,
   ID,
   JSONSchema,
@@ -21,6 +22,8 @@ const turndown = new TurndownService({
   emDelimiter: "*",
 });
 
+const env = getRecipeEnvironment();
+
 turndown.addRule("removeStyleTags", {
   filter: ["style"],
   replacement: function () {
@@ -178,7 +181,7 @@ const refreshAuthToken = async (auth: Cell<Auth>) => {
   console.log("refreshAuthToken", body);
 
   const refresh_response = await fetch(
-    "/api/integrations/google-oauth/refresh",
+    new URL("/api/integrations/google-oauth/refresh", env.apiUrl),
     {
       method: "POST",
       body: JSON.stringify(body),

runner/src/env.ts

@@ -0,0 +1,6 @@
+// Expose `getRecipeEnvironment` even if unused so that (dynamic) recipes
+// can still import from the host context.
+export {
+  getRecipeEnvironment,
+  setRecipeEnvironment,
+} from "@commontools/builder";

runner/src/index.ts

@@ -7,6 +7,7 @@ export {
   run as addAction,
   unschedule as removeAction,
 } from "./scheduler.ts";
+export { getRecipeEnvironment, setRecipeEnvironment } from "./env.ts";
 export type { DocImpl } from "./doc.ts";
 export type { Cell, CellLink, Stream } from "./cell.ts";
 export type { QueryResult } from "./query-result-proxy.ts";