@sanity/workbench 0.1.0-alpha.20 → 0.1.0-alpha.21

package/src/system/module-federation.ts

@@ -0,0 +1,116 @@
+import { createInstance as createMFInstance } from "@module-federation/runtime";
+import type {
+  ModuleFederationRuntimePlugin,
+  UserOptions,
+} from "@module-federation/runtime/types";
+
+/** Make some properties of a type optional. */
+type MakeOptional<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
+
+/**
+ * @public
+ */
+export type FederationRemote = {
+  name: string;
+  entry: string;
+};
+
+/**
+ * @public
+ */
+export type CreateInstanceOptions = MakeOptional<
+  Pick<UserOptions, "name" | "remotes" | "shared" | "plugins">,
+  "remotes" | "plugins"
+>;
+
+/**
+ * @public
+ */
+export interface FederationInstance {
+  registerRemotes(remotes: FederationRemote[]): void;
+  loadRemote<T>(id: string): Promise<T | null>;
+}
+
+/**
+ * @public
+ */
+export function createInstance(
+  options: CreateInstanceOptions,
+): FederationInstance {
+  const instance = createMFInstance({
+    remotes: [],
+    ...options,
+  });
+
+  return {
+    registerRemotes: (remotes) =>
+      instance.registerRemotes(remotes, { force: false }),
+    loadRemote: async <T>(id: string) => {
+      let remoteModule: T | null;
+
+      try {
+        remoteModule = await instance.loadRemote<T>(id);
+      } catch (error) {
+        throw new Error(`Failed to load remote module "${id}"`, {
+          cause: error,
+        });
+      }
+
+      return remoteModule;
+    },
+  };
+}
+
+/**
+ * Forward Module Federation lifecycle events to a provided logging function
+ * from workbench.
+ *
+ * @public
+ */
+export function log(
+  onDebug: (message: string, context?: Record<string, unknown>) => void,
+): ModuleFederationRuntimePlugin {
+  const logEvent = (eventName: string, args: unknown) => {
+    // `origin` logs the whole instance, which is noisy
+    const { origin: _origin, ...data } =
+      typeof args === "object" && args !== null
+        ? (args as Record<string, unknown>)
+        : { args };
+
+    onDebug(`[Lifecycle] ${eventName}`, data);
+  };
+
+  return {
+    name: "sanity-logger",
+    beforeInit(args) {
+      logEvent("beforeInit", args);
+      return args;
+    },
+    beforeRegisterRemote(args) {
+      logEvent("beforeRegisterRemote", args);
+      return args;
+    },
+    beforePreloadRemote(args) {
+      logEvent("beforePreloadRemote", args);
+    },
+    beforeRequest(args) {
+      logEvent("beforeRequest", args);
+      return args;
+    },
+    afterResolve(args) {
+      logEvent("afterResolve", args);
+      return args;
+    },
+    onLoad(args) {
+      logEvent("onLoad", args);
+      return args;
+    },
+    loadShare(args) {
+      logEvent("loadShare", args);
+    },
+    beforeLoadShare(args) {
+      logEvent("beforeLoadShare", args);
+      return args;
+    },
+  };
+}

package/src/system/remote.machine.ts

@@ -1,7 +1,7 @@
-import type { FederationInstance } from "@sanity/federation/runtime";
 import { assign, fromPromise, sendParent, setup } from "xstate";
 
 import { loadRemoteModule } from "./load-federated-module";
+import type { FederationInstance } from "./module-federation";
 
 /**
  * @public

package/src/system/remotes.machine.ts

@@ -1,6 +1,6 @@
-import { type FederationInstance } from "@sanity/federation/runtime";
 import { type ActorRefFrom, assign, setup } from "xstate";
 
+import { type FederationInstance } from "./module-federation";
 import { remoteLogic } from "./remote.machine";
 
 /** The shared federation instance, supplied by the root machine. */

package/src/system/root.machine.ts

@@ -1,14 +1,14 @@
-import {
-  createInstance,
-  type FederationInstance,
-} from "@sanity/federation/runtime";
-import { log } from "@sanity/federation/runtime/plugins/log";
 import { createSanityInstance, type SanityInstance } from "@sanity/sdk";
 import { raise, sendTo, setup, type ActorOptions } from "xstate";
 
 import { logger } from "../core/log";
 import { authLogic } from "./auth.machine";
 import { inspect } from "./inspect";
+import {
+  createInstance,
+  type FederationInstance,
+  log,
+} from "./module-federation";
 import { remotesLogic } from "./remotes.machine";
 import { servicesLogic } from "./services.machine";
 import {

package/src/system/service.machine.ts

@@ -1,7 +1,7 @@
-import { type FederationInstance } from "@sanity/federation/runtime";
 import { assign, fromCallback, setup } from "xstate";
 
 import { logger } from "../core/log";
+import { type FederationInstance } from "./module-federation";
 import {
   remoteLogic,
   type RemoteError,

package/src/system/services.machine.ts

@@ -1,6 +1,6 @@
-import { type FederationInstance } from "@sanity/federation/runtime";
 import { type ActorRefFrom, enqueueActions, setup } from "xstate";
 
+import { type FederationInstance } from "./module-federation";
 import { serviceLogic } from "./service.machine";
 
 /** The shared federation instance, supplied by the root machine. */