@akanjs/devkit 3.1.0 → 3.1.1-rc.1

package/ssrScanner.test.ts

@@ -176,6 +176,37 @@ describe("akan.ssr.client-mount-load", () => {
   test("a store action that is not a load is not a finding", () => {
     expect(scanOne(UI, mount("void st.do.openModal();"))).not.toContain("akan.ssr.client-mount-load");
   });
+
+  test("never sends a mutation to the route", () => {
+    const signal = fileOf(
+      "apps/demo/lib/task/task.signal.ts",
+      `export class TaskEndpoint extends endpoint(srv.task, ({ mutation }) => ({ markTaskSeen: mutation(Boolean, {}).exec(() => true) })) {}`,
+    );
+    const [load, write] = new SsrScanner().scan([
+      signal,
+      fileOf(UI, mount("void fetch.viewTask(id); void fetch.markTaskSeen(id);")),
+    ]).warnings;
+    expect(load?.message).toContain("The route can fetch this");
+    expect(load?.fix).toBeUndefined();
+    expect(write?.rule).toBe("akan.ssr.client-mount-load");
+    expect(write?.message).toContain("sends the mutation fetch.markTaskSeen()");
+    expect(write?.fix).toContain("explicit user action");
+    expect(write?.fix).not.toContain("init/view");
+  });
+});
+
+describe("akan.ssr.render-mutation", () => {
+  test("is reported for a route file beside the component rules", () => {
+    const signal = fileOf(
+      "apps/demo/lib/task/task.signal.ts",
+      `export class TaskEndpoint extends endpoint(srv.task, ({ mutation }) => ({ approveTask: mutation(Boolean, {}).exec(() => true) })) {}`,
+    );
+    const route = fileOf(
+      "apps/demo/page/task/_index.tsx",
+      `import { fetch } from "@apps/demo/client";\nexport default page().render(async () => { await fetch.approveTask("x"); return null; });\n`,
+    );
+    expect(rulesOf(signal, route)).toEqual(["akan.ssr.render-mutation"]);
+  });
 });
 
 describe("akan.ssr.template-client-state", () => {

package/ssrScanner.ts

@@ -1,5 +1,7 @@
 import ts from "typescript";
 import type { QualityWarning, SourceFileInfo } from "./qualityScanner";
+import { RenderMutationScanner } from "./renderMutationScanner";
+import { SignalMutationIndex } from "./signalMutationIndex";
 
 /** Server/client render split for one app or lib, measured in JSX elements rather than files. */
 export interface SsrBalanceEntry {
@@ -50,19 +52,23 @@ export class SsrScanner {
   );
   // Runtime singletons that only exist in the client bundle; importing either is what forces the directive.
   static #clientRuntimeImports = new Set(["st", "fetch"]);
+  static #mountWriteFix =
+    "Send the write from an explicit user action, such as a button that calls a store action. Do not move it into the route: a write there runs for anyone who opens a link to the page.";
 
   scan(sourceFiles: SourceFileInfo[]): SsrScanResult {
+    const mutations = new SignalMutationIndex(sourceFiles);
     const componentFiles = sourceFiles.filter((sourceFile) => this.#isBalancedFile(sourceFile.file));
     return {
       warnings: [
-        ...componentFiles.flatMap((sourceFile) => this.#scanFile(sourceFile)),
+        ...componentFiles.flatMap((sourceFile) => this.#scanFile(sourceFile, mutations)),
         ...this.#scanModules(componentFiles),
+        ...new RenderMutationScanner(mutations).scan(sourceFiles),
       ],
       balance: this.#measureBalance(componentFiles),
     };
   }
 
-  #scanFile(sourceFile: SourceFileInfo): QualityWarning[] {
+  #scanFile(sourceFile: SourceFileInfo, mutations: SignalMutationIndex): QualityWarning[] {
     if (!this.#hasUseClient(sourceFile.sourceFile)) return [];
     const vendorNames = this.#getVendorNames(sourceFile.sourceFile);
     const hasVendorImport = this.#hasVendorImport(sourceFile.sourceFile);
@@ -118,7 +124,7 @@ export class SsrScanner {
       }
     }
 
-    warnings.push(...this.#getMountLoadWarnings(sourceFile));
+    warnings.push(...this.#getMountLoadWarnings(sourceFile, mutations));
     warnings.push(...this.#getTemplateStateWarnings(sourceFile));
     return warnings;
   }
@@ -147,20 +153,33 @@ export class SsrScanner {
   }
 
   // Only an empty-dependency effect is a finding: a reactive effect answers client state and has no server equivalent.
-  #getMountLoadWarnings(sourceFile: SourceFileInfo): QualityWarning[] {
+  #getMountLoadWarnings(sourceFile: SourceFileInfo, mutations: SignalMutationIndex): QualityWarning[] {
     const warnings: QualityWarning[] = [];
     SsrScanner.#walk(sourceFile.sourceFile, (node) => {
       if (!this.#isMountEffect(sourceFile.sourceFile, node)) return;
-      for (const load of this.#getLoadCalls(sourceFile.sourceFile, node))
+      for (const load of this.#getLoadCalls(sourceFile.sourceFile, node)) {
+        const line = this.#getLine(sourceFile.sourceFile, load.node);
         warnings.push(
-          fileWarning(
-            "akan.ssr.client-mount-load",
-            "ssr",
-            sourceFile.file,
-            `Mount-only effect loads server data with ${load.callee}(). The route can fetch this before the first byte instead.`,
-            this.#getLine(sourceFile.sourceFile, load.node),
-          ),
+          load.callee.startsWith("fetch.") && mutations.isMutation(sourceFile.file, load.callee.slice("fetch.".length))
+            ? {
+                ...fileWarning(
+                  "akan.ssr.client-mount-load",
+                  "ssr",
+                  sourceFile.file,
+                  `Mount-only effect sends the mutation ${load.callee}() each time the component mounts. A write is not data the route can load.`,
+                  line,
+                ),
+                fix: SsrScanner.#mountWriteFix,
+              }
+            : fileWarning(
+                "akan.ssr.client-mount-load",
+                "ssr",
+                sourceFile.file,
+                `Mount-only effect loads server data with ${load.callee}(). The route can fetch this before the first byte instead.`,
+                line,
+              ),
         );
+      }
     });
     return warnings;
   }

package/transforms/barrelImportsPlugin.ts

@@ -10,14 +10,16 @@ export interface BarrelImportsPluginOptions {
   skipPath?: (absPath: string) => boolean;
   /** Runs after the rewrite in the same onLoad (Bun's onLoad cannot fall through); null means no change. */
   pipeAfter?: (source: string, args: { path: string }) => string | Promise<string | null> | null;
+  /** Barrels the bundle leaves external: a rewritten import would inline the modules the import map already serves. */
+  external?: readonly string[];
 }
 
 export const createBarrelImportsPlugin = async (
   app: App,
-  { skipPath = defaultSkipPath, pipeAfter }: BarrelImportsPluginOptions = {},
+  { skipPath = defaultSkipPath, pipeAfter, external = [] }: BarrelImportsPluginOptions = {},
 ): Promise<BunPlugin> => {
   const akanConfig = await app.getConfig();
-  const barrels = [...new Set(akanConfig.barrelImports)].filter(Boolean);
+  const barrels = [...new Set(akanConfig.barrelImports)].filter((barrel) => barrel && !external.includes(barrel));
   const analyzer = new BarrelAnalyzer({
     resolvePackage: await createTsconfigPackageResolver(app),
   });

package/uploadRelease.ts

@@ -1,80 +0,0 @@
-import { Logger, RestClient } from "akanjs/common";
-
-import { Spinner } from "./spinner";
-
-const spinning = (message: string) => new Spinner(message, { prefix: message, enableSpin: true }).start();
-
-export const uploadRelease = async (
-  appName: string,
-  {
-    workspaceRoot,
-    environment,
-    buildNum,
-    platformVersion,
-    os,
-    local,
-  }: {
-    workspaceRoot: string;
-    environment: string;
-    buildNum: number;
-    platformVersion?: string;
-    os?: "android" | "ios";
-    local?: boolean;
-  },
-) => {
-  const logger = new Logger("uploadRelease");
-  const basePath = local ? "http://localhost:8282/backend" : "https://cloud.akanjs.com/backend";
-  const httpClient = new RestClient(basePath);
-  const readingFilesSpinner = spinning("Reading files...");
-  try {
-    const uploads = [
-      [`builds/${appName}-release.tar.gz`, `${appName}-release.tar.gz`],
-      [`sources/${appName}-source.tar.gz`, `${appName}-source.tar.gz`],
-      [`builds/${appName}-appBuild.zip`, `${appName}-appBuild.zip`],
-    ].map(([relativePath, name]) => ({ file: Bun.file(`${workspaceRoot}/releases/${relativePath}`), name }));
-    const metas = uploads.map(({ file }) => ({ lastModifiedAt: new Date(file.lastModified), size: file.size }));
-    readingFilesSpinner.succeed("Reading files... done");
-
-    const preparingFormSpinner = spinning("Preparing form data...");
-    const formData = new FormData();
-    for (const { file, name } of uploads) formData.append("files", file, name);
-    formData.append("metas", JSON.stringify(metas));
-    formData.append("type", "release");
-    preparingFormSpinner.succeed("Preparing form data... done");
-
-    try {
-      const uploadingFilesSpinner = spinning("Uploading files to server...");
-      const [buildFile, sourceFile, appBuildFile] = await httpClient.post<
-        [{ id: string }, { id: string }, { id: string }]
-      >("/file/addFiles", formData);
-      uploadingFilesSpinner.succeed("Uploading files to server... done");
-
-      const fetchingAppSpinner = spinning(`Fetching dev app information for ${appName}...`);
-      const major = platformVersion ? parseInt(platformVersion.split(".")[0]) : 1;
-      const minor = platformVersion ? parseInt(platformVersion.split(".")[1]) : 0;
-      const patch = platformVersion ? parseInt(platformVersion.split(".")[2]) : 0;
-
-      const devApp = await httpClient.get<{ id: string }>(`/devApp/devAppInName/${appName}`);
-      fetchingAppSpinner.succeed(`Fetching dev app information for ${appName}... done`);
-
-      const pushingReleaseSpinner = spinning(`Pushing release to ${environment} environment...`);
-      const release = await httpClient.post<{ id: string }>(
-        `/release/pushRelease/${devApp.id}/${environment}/${major}/${minor}/${patch}/${sourceFile.id}/${buildFile.id}/${appBuildFile.id}${os ? `/${os}` : ""}`,
-      );
-      pushingReleaseSpinner.succeed(`Pushing release to ${environment} environment... done`);
-      new Spinner(`Successfully pushed release to ${appName}-${environment} server. `, {
-        prefix: `Successfully pushed release to ${appName}-${environment} server. `,
-        enableSpin: false,
-      }).succeed(`Successfully pushed release to ${appName}-${environment} server. `);
-      return release;
-    } catch (e) {
-      const errorMessage = e instanceof Error ? e.message : "Unknown error";
-      logger.error(`Upload release failed: ${errorMessage}`);
-      return null;
-    }
-  } catch (e) {
-    const errorMessage = e instanceof Error ? e.message : "Unknown error";
-    readingFilesSpinner.fail(`Reading files failed: ${errorMessage}`);
-    return null;
-  }
-};