@ic-reactor/vite-plugin 0.4.1 → 0.5.0

package/dist/index.js

@@ -1,18 +1,19 @@
 // src/index.ts
-import fs from "fs";
 import path from "path";
-import { execFileSync } from "child_process";
 import {
-  generateDeclarations,
-  generateReactorFile,
-  generateClientFile
+  runCanisterPipeline
 } from "@ic-reactor/codegen";
+
+// src/env.ts
+import { execFileSync } from "child_process";
 function getIcEnvironmentInfo(canisterNames) {
   const environment = process.env.ICP_ENVIRONMENT || "local";
   try {
     const networkStatus = JSON.parse(
       execFileSync("icp", ["network", "status", "-e", environment, "--json"], {
-        encoding: "utf-8"
+        encoding: "utf-8",
+        stdio: ["ignore", "pipe", "ignore"]
+        // suppress stderr
       })
     );
     const rootKey = networkStatus.root_key;
@@ -23,35 +24,48 @@ function getIcEnvironmentInfo(canisterNames) {
         const canisterId = execFileSync(
           "icp",
           ["canister", "status", name, "-e", environment, "-i"],
-          {
-            encoding: "utf-8"
-          }
+          { encoding: "utf-8", stdio: ["ignore", "pipe", "ignore"] }
         ).trim();
-        canisterIds[name] = canisterId;
+        if (canisterId) {
+          canisterIds[name] = canisterId;
+        }
       } catch {
       }
     }
     return { environment, rootKey, proxyTarget, canisterIds };
-  } catch {
+  } catch (error) {
     return null;
   }
 }
 function buildIcEnvCookie(canisterIds, rootKey) {
-  const envParts = [`ic_root_key=${rootKey}`];
+  const parts = [`ic_root_key=${rootKey}`];
   for (const [name, id] of Object.entries(canisterIds)) {
-    envParts.push(`PUBLIC_CANISTER_ID:${name}=${id}`);
+    parts.push(`PUBLIC_CANISTER_ID:${name}=${id}`);
   }
-  return encodeURIComponent(envParts.join("&"));
+  return encodeURIComponent(parts.join("&"));
 }
+
+// src/index.ts
 function icReactorPlugin(options) {
-  const baseOutDir = options.outDir ?? "./src/lib/canisters";
+  const {
+    canisters,
+    outDir = "src/declarations",
+    clientManagerPath = "../../clients",
+    injectEnvironment = true
+  } = options;
+  const globalConfig = {
+    outDir,
+    clientManagerPath
+  };
   return {
     name: "ic-reactor-plugin",
-    config(_config, { command }) {
-      if (command !== "serve" || !(options.injectEnvironment ?? true)) {
+    enforce: "pre",
+    // Run before other plugins
+    config(config, { command }) {
+      if (command !== "serve" || !injectEnvironment) {
         return {};
       }
-      const canisterNames = options.canisters.map((c) => c.name);
+      const canisterNames = canisters.map((c) => c.name).filter((n) => !!n);
       if (!canisterNames.includes("internet_identity")) {
         canisterNames.push("internet_identity");
       }
@@ -84,91 +98,53 @@ function icReactorPlugin(options) {
       };
     },
     async buildStart() {
-      const defaultClientPath = path.resolve(
-        process.cwd(),
-        "src/lib/clients.ts"
+      const projectRoot = process.cwd();
+      console.log(
+        `[ic-reactor] Generating hooks for ${canisters.length} canisters...`
       );
-      if (!fs.existsSync(defaultClientPath)) {
-        console.log(
-          `[ic-reactor] Default client manager not found. Creating at ${defaultClientPath}`
-        );
-        const clientContent = generateClientFile();
-        fs.mkdirSync(path.dirname(defaultClientPath), { recursive: true });
-        fs.writeFileSync(defaultClientPath, clientContent);
-      }
-      for (const canister of options.canisters) {
-        let didFile = canister.didFile;
-        const outDir = canister.outDir ?? path.join(baseOutDir, canister.name);
-        if (!didFile) {
-          const environment = process.env.ICP_ENVIRONMENT || "local";
-          console.log(
-            `[ic-reactor] didFile not specified for "${canister.name}". Attempting to download from canister...`
-          );
-          try {
-            const candidContent = execFileSync(
-              "icp",
-              [
-                "canister",
-                "metadata",
-                canister.name,
-                "candid:service",
-                "-e",
-                environment
-              ],
-              { encoding: "utf-8" }
-            ).trim();
-            const declarationsDir = path.join(outDir, "declarations");
-            if (!fs.existsSync(declarationsDir)) {
-              fs.mkdirSync(declarationsDir, { recursive: true });
-            }
-            didFile = path.join(declarationsDir, `${canister.name}.did`);
-            fs.writeFileSync(didFile, candidContent);
-            console.log(
-              `[ic-reactor] Candid downloaded and saved to ${didFile}`
-            );
-          } catch (error) {
+      for (const canisterConfig of canisters) {
+        try {
+          const result = await runCanisterPipeline({
+            canisterConfig,
+            projectRoot,
+            globalConfig
+          });
+          if (!result.success) {
             console.error(
-              `[ic-reactor] Failed to download candid for ${canister.name}: ${error}`
+              `[ic-reactor] Failed to generate ${canisterConfig.name}: ${result.error}`
             );
-            continue;
+          } else {
           }
-        }
-        console.log(
-          `[ic-reactor] Generating hooks for ${canister.name} from ${didFile}`
-        );
-        const result = await generateDeclarations({
-          didFile,
-          outDir,
-          canisterName: canister.name
-        });
-        if (!result.success) {
+        } catch (err) {
           console.error(
-            `[ic-reactor] Failed to generate declarations: ${result.error}`
+            `[ic-reactor] Error generating ${canisterConfig.name}:`,
+            err
           );
-          continue;
         }
-        const reactorContent = generateReactorFile({
-          canisterName: canister.name,
-          didFile,
-          clientManagerPath: canister.clientManagerPath ?? options.clientManagerPath
-        });
-        const reactorPath = path.join(outDir, "index.ts");
-        fs.mkdirSync(outDir, { recursive: true });
-        fs.writeFileSync(reactorPath, reactorContent);
-        console.log(`[ic-reactor] Reactor hooks generated at ${reactorPath}`);
       }
     },
     handleHotUpdate({ file, server }) {
       if (file.endsWith(".did")) {
-        const canister = options.canisters.find((c) => {
-          if (!c.didFile) return false;
-          return path.resolve(c.didFile) === file;
+        const affectedCanister = canisters.find((c) => {
+          const configPath = path.resolve(process.cwd(), c.didFile);
+          return configPath === file;
         });
-        if (canister) {
+        if (affectedCanister) {
           console.log(
-            `[ic-reactor] Detected change in ${file}, regenerating...`
+            `[ic-reactor] .did file changed: ${affectedCanister.name}. Regenerating...`
           );
-          server.restart();
+          const projectRoot = process.cwd();
+          runCanisterPipeline({
+            canisterConfig: affectedCanister,
+            projectRoot,
+            globalConfig
+          }).then((result) => {
+            if (result.success) {
+              server.ws.send({ type: "full-reload" });
+            } else {
+              console.error(`[ic-reactor] Regeneration failed: ${result.error}`);
+            }
+          });
         }
       }
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ic-reactor/vite-plugin",
-  "version": "0.4.1",
+  "version": "0.5.0",
   "description": "Vite plugin for zero-config IC reactor generation from Candid files",
   "type": "module",
   "main": "./dist/index.cjs",
@@ -37,7 +37,7 @@
     "url": "https://github.com/B3Pay/ic-reactor/issues"
   },
   "dependencies": {
-    "@ic-reactor/codegen": "0.4.1"
+    "@ic-reactor/codegen": "0.5.0"
   },
   "peerDependencies": {
     "vite": "^5.0.0 || ^6.0.0 || ^7.0.0"

package/src/env.ts

@@ -0,0 +1,80 @@
+/**
+ * Environment Injection Utilities
+ *
+ * Handles detecting the local IC environment (via `dfx` or `icp` CLI)
+ * and building the `ic_env` cookie for the browser.
+ */
+
+import { execFileSync } from "child_process"
+
+export interface IcEnvironment {
+  environment: string
+  rootKey: string
+  proxyTarget: string
+  canisterIds: Record<string, string>
+}
+
+/**
+ * Detect the IC environment using the `icp` or `dfx` CLI.
+ */
+export function getIcEnvironmentInfo(
+  canisterNames: string[]
+): IcEnvironment | null {
+  const environment = process.env.ICP_ENVIRONMENT || "local"
+
+  // We try `icp` first, but could fallback to `dfx` logic if needed.
+  // For now, assuming `icp` CLI is available based on previous code.
+
+  try {
+    const networkStatus = JSON.parse(
+      execFileSync("icp", ["network", "status", "-e", environment, "--json"], {
+        encoding: "utf-8",
+        stdio: ["ignore", "pipe", "ignore"], // suppress stderr
+      })
+    )
+
+    const rootKey = networkStatus.root_key
+    // Default to localhost:4943 if port strictly needed, but `icp` gives us the port
+    const proxyTarget = `http://127.0.0.1:${networkStatus.port}`
+
+    const canisterIds: Record<string, string> = {}
+
+    for (const name of canisterNames) {
+      try {
+        const canisterId = execFileSync(
+          "icp",
+          ["canister", "status", name, "-e", environment, "-i"],
+          { encoding: "utf-8", stdio: ["ignore", "pipe", "ignore"] }
+        ).trim()
+
+        if (canisterId) {
+          canisterIds[name] = canisterId
+        }
+      } catch {
+        // Canister might not exist or be deployed yet
+      }
+    }
+
+    return { environment, rootKey, proxyTarget, canisterIds }
+  } catch (error) {
+    // CLI not found or failed
+    return null
+  }
+}
+
+/**
+ * Build the `ic_env` cookie string.
+ * Format: `ic_root_key=<key>&PUBLIC_CANISTER_ID:<name>=<id>&...`
+ */
+export function buildIcEnvCookie(
+  canisterIds: Record<string, string>,
+  rootKey: string
+): string {
+  const parts = [`ic_root_key=${rootKey}`]
+
+  for (const [name, id] of Object.entries(canisterIds)) {
+    parts.push(`PUBLIC_CANISTER_ID:${name}=${id}`)
+  }
+
+  return encodeURIComponent(parts.join("&"))
+}

package/src/index.test.ts

@@ -3,17 +3,11 @@ import { icReactorPlugin, type IcReactorPluginOptions } from "./index"
 import fs from "fs"
 import path from "path"
 import { execFileSync } from "child_process"
-import {
-  generateDeclarations,
-  generateReactorFile,
-  generateClientFile,
-} from "@ic-reactor/codegen"
+import { runCanisterPipeline } from "@ic-reactor/codegen"
 
 // Mock internal dependencies
 vi.mock("@ic-reactor/codegen", () => ({
-  generateDeclarations: vi.fn(),
-  generateReactorFile: vi.fn(),
-  generateClientFile: vi.fn(),
+  runCanisterPipeline: vi.fn(),
 }))
 
 // Mock child_process
@@ -54,16 +48,16 @@ describe("icReactorPlugin", () => {
       use: vi.fn(),
     },
     restart: vi.fn(),
+    ws: {
+      send: vi.fn(),
+    },
   }
 
   beforeEach(() => {
     vi.resetAllMocks()
-    ;(generateDeclarations as any).mockResolvedValue({
+    ;(runCanisterPipeline as any).mockResolvedValue({
       success: true,
-      declarationsDir: "/mock/declarations",
     })
-    ;(generateReactorFile as any).mockReturnValue("export const reactor = {}")
-    ;(generateClientFile as any).mockReturnValue("export const client = {}")
   })
 
   it("should return correct plugin structure", () => {
@@ -72,8 +66,6 @@ describe("icReactorPlugin", () => {
     expect(plugin.buildStart).toBeDefined()
     expect(plugin.handleHotUpdate).toBeDefined()
     expect((plugin as any).config).toBeDefined()
-    // configureServer is no longer used for middleware
-    expect(plugin.configureServer).toBeUndefined()
   })
 
   describe("config", () => {
@@ -136,82 +128,13 @@ describe("icReactorPlugin", () => {
       const plugin = icReactorPlugin(mockOptions)
       await (plugin.buildStart as any)()
 
-      expect(generateDeclarations).toHaveBeenCalledWith({
-        didFile: "src/declarations/test.did",
-        outDir: "src/declarations/test_canister",
-        canisterName: "test_canister",
-      })
-
-      expect(generateReactorFile).toHaveBeenCalledWith({
-        canisterName: "test_canister",
-        didFile: "src/declarations/test.did",
-        clientManagerPath: undefined,
-      })
-
-      expect(fs.writeFileSync).toHaveBeenCalledWith(
-        path.join("src/declarations/test_canister", "index.ts"),
-        "export const reactor = {}"
-      )
-    })
-
-    it("should download candid if not specified", async () => {
-      const optionsWithMissingDid: IcReactorPluginOptions = {
-        canisters: [
-          {
-            name: "missing_did",
-            outDir: "src/declarations/missing_did",
-          },
-        ],
-        outDir: "src/declarations",
-      }
-
-      ;(execFileSync as any).mockImplementation(
-        (command: string, args: string[]) => {
-          if (command === "icp" && args.includes("metadata")) {
-            return "service : { greet: (text) -> (text) query }"
-          }
-          return ""
-        }
-      )
-
-      const plugin = icReactorPlugin(optionsWithMissingDid)
-      await (plugin.buildStart as any)()
-
-      expect(execFileSync).toHaveBeenCalledWith(
-        "icp",
-        expect.arrayContaining([
-          "canister",
-          "metadata",
-          "missing_did",
-          "candid:service",
-        ]),
-        expect.any(Object)
-      )
-
-      expect(fs.writeFileSync).toHaveBeenCalledWith(
-        path.join(
-          "src/declarations/missing_did/declarations",
-          "missing_did.did"
-        ),
-        "service : { greet: (text) -> (text) query }"
-      )
-
-      expect(generateDeclarations).toHaveBeenCalledWith({
-        didFile: path.join(
-          "src/declarations/missing_did/declarations",
-          "missing_did.did"
-        ),
-        outDir: "src/declarations/missing_did",
-        canisterName: "missing_did",
-      })
-
-      expect(generateReactorFile).toHaveBeenCalledWith({
-        canisterName: "missing_did",
-        didFile: path.join(
-          "src/declarations/missing_did/declarations",
-          "missing_did.did"
-        ),
-        clientManagerPath: undefined,
+      expect(runCanisterPipeline).toHaveBeenCalledWith({
+        canisterConfig: mockOptions.canisters[0],
+        projectRoot: expect.any(String),
+        globalConfig: {
+          outDir: "src/declarations",
+          clientManagerPath: "../../clients",
+        },
       })
     })
 
@@ -220,7 +143,7 @@ describe("icReactorPlugin", () => {
         .spyOn(console, "error")
         .mockImplementation(() => {})
 
-      ;(generateDeclarations as any).mockResolvedValue({
+      ;(runCanisterPipeline as any).mockResolvedValue({
         success: false,
         error: "Failed to generate",
       })
@@ -229,16 +152,15 @@ describe("icReactorPlugin", () => {
       await (plugin.buildStart as any)()
 
       expect(consoleErrorSpy).toHaveBeenCalledWith(
-        expect.stringContaining("Failed to generate declarations")
+        expect.stringContaining("Failed to generate test_canister")
       )
-      expect(generateReactorFile).not.toHaveBeenCalled()
 
       consoleErrorSpy.mockRestore()
     })
   })
 
   describe("handleHotUpdate", () => {
-    it("should restart server when .did file changes", () => {
+    it("should restart server when .did file changes", async () => {
       const plugin = icReactorPlugin(mockOptions)
       const ctx = {
         file: "/absolute/path/to/src/declarations/test.did",
@@ -248,14 +170,15 @@ describe("icReactorPlugin", () => {
       // Mock path.resolve to match the test case
       const originalResolve = path.resolve
       vi.spyOn(path, "resolve").mockImplementation((...args) => {
-        if (args.some((a) => a.includes("test.did"))) {
+        if (args.some((a) => a && a.includes("test.did"))) {
           return "/absolute/path/to/src/declarations/test.did"
         }
         return originalResolve(...args)
       })
-      ;(plugin.handleHotUpdate as any)(ctx)
 
-      expect(mockServer.restart).toHaveBeenCalled()
+      await (plugin.handleHotUpdate as any)(ctx)
+
+      expect(mockServer.ws.send).toHaveBeenCalledWith({ type: "full-reload" })
     })
 
     it("should ignore other files", () => {
@@ -267,7 +190,7 @@ describe("icReactorPlugin", () => {
 
       ;(plugin.handleHotUpdate as any)(ctx)
 
-      expect(mockServer.restart).not.toHaveBeenCalled()
+      expect(mockServer.ws.send).not.toHaveBeenCalled()
     })
   })
 })