fix remove-unused-fields command

tsnobip · tsnobip · commit ba933fc676be · 2026-06-09T15:12:07.000+02:00
- make it use rescript-tools from the installed rescript package
instead of relying on the outdated @rescript/tools package
- get the artifact directory from relay config
- do not analyze files in relay config `excludes`
diff --git a/packages/rescript-relay-cli/__tests__/sourceDiscovery.test.ts b/packages/rescript-relay-cli/__tests__/sourceDiscovery.test.ts
@@ -0,0 +1,101 @@
+import fs from "fs";
+import os from "os";
+import path from "path";
+import {
+  findSourceFiles,
+  getReanalyzeCwd,
+  getRescriptToolsCommand,
+} from "../fileUtils";
+
+describe("source discovery", () => {
+  it("honors relay excludes when finding source files", async () => {
+    const originalCwd = process.cwd();
+    const root = fs.mkdtempSync(
+      path.join(os.tmpdir(), "rescript-relay-source-discovery-")
+    );
+    const projectRoot = path.join(root, "packages", "web");
+
+    try {
+      fs.mkdirSync(path.join(projectRoot, "src"), { recursive: true });
+      fs.mkdirSync(path.join(projectRoot, "lib", "ocaml"), {
+        recursive: true,
+      });
+      fs.writeFileSync(
+        path.join(projectRoot, "src", "OrganizationSettings.res"),
+        "let actualSource = true\n",
+        { encoding: "utf-8" }
+      );
+      fs.writeFileSync(
+        path.join(projectRoot, "lib", "ocaml", "OrganizationSettings.res"),
+        "let compiledCopy = true\n",
+        { encoding: "utf-8" }
+      );
+
+      process.chdir(projectRoot);
+
+      const sourceFiles = await findSourceFiles(
+        ["OrganizationSettings.res"],
+        ".",
+        ["**/lib/**"]
+      );
+
+      expect(sourceFiles.map((file) => fs.realpathSync(file))).toEqual([
+        fs.realpathSync(
+          path.join(projectRoot, "src", "OrganizationSettings.res")
+        ),
+      ]);
+    } finally {
+      process.chdir(originalCwd);
+      fs.rmSync(root, { recursive: true, force: true });
+    }
+  });
+
+  it("uses the ancestor ReScript analysis root and ReScript tools wrapper", () => {
+    const root = fs.mkdtempSync(
+      path.join(os.tmpdir(), "rescript-relay-source-discovery-")
+    );
+    const webRoot = path.join(root, "packages", "web");
+
+    try {
+      fs.mkdirSync(path.join(root, "lib", "bs"), { recursive: true });
+      fs.mkdirSync(path.join(root, "node_modules", "rescript", "cli"), {
+        recursive: true,
+      });
+      fs.mkdirSync(webRoot, { recursive: true });
+      fs.writeFileSync(
+        path.join(root, "lib", "bs", ".sourcedirs.json"),
+        "[]\n",
+        { encoding: "utf-8" }
+      );
+      fs.writeFileSync(
+        path.join(
+          root,
+          "node_modules",
+          "rescript",
+          "cli",
+          "rescript-tools.js"
+        ),
+        "",
+        { encoding: "utf-8" }
+      );
+
+      expect(getReanalyzeCwd(webRoot)).toBe(root);
+      expect(getRescriptToolsCommand(webRoot)).toEqual({
+        command: process.execPath,
+        args: [
+          path.join(
+            root,
+            "node_modules",
+            "rescript",
+            "cli",
+            "rescript-tools.js"
+          ),
+          "reanalyze",
+          "-dce",
+        ],
+      });
+    } finally {
+      fs.rmSync(root, { recursive: true, force: true });
+    }
+  });
+});
diff --git a/packages/rescript-relay-cli/cliUtils.ts b/packages/rescript-relay-cli/cliUtils.ts
@@ -50,6 +50,9 @@ export const extractGraphQLSourceFromReScript = makeExtractTagsFromSource(
   rescriptGraphQLTagsRegexp
 );
 
+const escapeRegExp = (str: string): string =>
+  str.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
+
 export function prettify(str: string): string {
   return (
     format(str, {
@@ -410,16 +413,49 @@ export interface IFragmentRepresentationWithSourceLocation
   sourceLocation: string;
 }
 
-const graphqlNameRegexp = new RegExp(
-  /(?<=__generated__\/)[A-Za-z_0-9]+(?=_graphql\.res)/g
-);
 const fieldPathRegexp = new RegExp(
   /(?<=Types\.(fragment|response)[_.])[A-Za-z_.0-9]+(?= )/g
 );
 
 const filterRegexp = new RegExp(/Types\.(fragment|response)/g);
 
-export const processReanalyzeOutput = (output: string) => {
+const extractGeneratedFileNameFromReanalyzeOutput = (
+  output: string,
+  artifactDirectoryLocation?: string
+): string | null => {
+  const normalizedOutput = output.replace(/\\/g, "/");
+
+  if (artifactDirectoryLocation != null) {
+    const normalizedArtifactDirectoryLocation = artifactDirectoryLocation
+      .replace(/\\/g, "/")
+      .replace(/\/$/, "");
+    const artifactRegexp = new RegExp(
+      `${escapeRegExp(
+        normalizedArtifactDirectoryLocation
+      )}/([A-Za-z_0-9]+_graphql\\.res)(?:"|:)`
+    );
+    const explicitArtifactMatch = normalizedOutput.match(artifactRegexp)?.[1];
+
+    if (explicitArtifactMatch != null) {
+      return explicitArtifactMatch;
+    }
+  }
+
+  return (
+    normalizedOutput.match(
+      /(?:__generated__|__relay__)\/([A-Za-z_0-9]+_graphql\.res)(?:"|:)/
+    )?.[1] ?? null
+  );
+};
+
+export const processReanalyzeOutput = (
+  output: string,
+  {
+    artifactDirectoryLocation,
+  }: {
+    artifactDirectoryLocation?: string;
+  } = {}
+) => {
   const processed = output
     // Parse reanalyze output
     .split(/\n\n/g)
@@ -435,9 +471,12 @@ export const processReanalyzeOutput = (output: string) => {
       
       const type = curr.includes("Types.fragment") ? "fragment" : "query";
 
-      const graphqlName = curr.match(graphqlNameRegexp)?.[0];
-      const fileName =
-        graphqlName == null ? null : `${graphqlName}_graphql.res`;
+      const fileName = extractGeneratedFileNameFromReanalyzeOutput(
+        curr,
+        artifactDirectoryLocation
+      );
+      const graphqlName =
+        fileName == null ? null : fileName.replace(/_graphql\.res$/, "");
       const fieldPath = curr.match(fieldPathRegexp)?.[0];
 
       // We only care about queries
diff --git a/packages/rescript-relay-cli/commands/debugCommand.ts b/packages/rescript-relay-cli/commands/debugCommand.ts
@@ -6,6 +6,7 @@ import {
   findAllSourceFilesFromGeneratedFiles,
   findSourceFiles,
   getSrcCwd,
+  getRelayExcludes,
 } from "../fileUtils";
 
 export const addDebugCommand = (program: Command) => {
@@ -41,7 +42,11 @@ export const addDebugCommand = (program: Command) => {
 
       console.log("Looking up source files..\n");
 
-      const sourceFiles = await findSourceFiles(files, relayConfig.src);
+      const sourceFiles = await findSourceFiles(
+        files,
+        relayConfig.src,
+        getRelayExcludes(relayConfig)
+      );
 
       console.log(
         `Found ${
diff --git a/packages/rescript-relay-cli/commands/formatGraphQLCommand.ts b/packages/rescript-relay-cli/commands/formatGraphQLCommand.ts
@@ -8,6 +8,7 @@ import {
   findSourceFiles,
   getAllGeneratedFiles,
   getRelayArtifactDirectoryLocation,
+  getRelayExcludes,
   loadRelayConfig,
 } from "../fileUtils";
 import { formatOperationsInDocument } from "../formatUtils";
@@ -38,7 +39,11 @@ export const addFormatGraphQLCommands = (program: Command) => {
         sourcesToFind.length
       )}.`;
 
-      const files = await findSourceFiles(sourcesToFind, relayConfig.src);
+      const files = await findSourceFiles(
+        sourcesToFind,
+        relayConfig.src,
+        getRelayExcludes(relayConfig)
+      );
 
       const formatSuccesses = await Promise.all(
         files.map(async (filePath) => {
diff --git a/packages/rescript-relay-cli/commands/removeUnusedFieldsCommand.ts b/packages/rescript-relay-cli/commands/removeUnusedFieldsCommand.ts
@@ -25,6 +25,9 @@ import {
   getRelayArtifactDirectoryLocation,
   sourceLocExtractor,
   findSourceFiles,
+  getRelayExcludes,
+  getReanalyzeCwd,
+  getRescriptToolsCommand,
 } from "../fileUtils";
 
 export const addRemoveUnusedFieldsCommand = (program: Command) => {
@@ -52,10 +55,14 @@ export const addRemoveUnusedFieldsCommand = (program: Command) => {
         const relayConfig = loadRelayConfig();
         const artifactDirectoryLocation =
           getRelayArtifactDirectoryLocation(relayConfig);
+        const reanalyzeCwd = getReanalyzeCwd(process.cwd());
+        const reanalyzeCommand = getRescriptToolsCommand(reanalyzeCwd);
 
         const spinner = ora("Analyzing ReScript project").start();
 
-        const p = cp.spawn("npx", ["--yes", "@rescript/tools", "reanalyze", "-dce"]);
+        const p = cp.spawn(reanalyzeCommand.command, reanalyzeCommand.args, {
+          cwd: reanalyzeCwd,
+        });
 
         if (p.stdout == null) {
           console.error("Something went wrong.");
@@ -86,7 +93,9 @@ export const addRemoveUnusedFieldsCommand = (program: Command) => {
 
         p.on("close", async () => {
           spinner.text = "Analyzing GraphQL usage";
-          const processed = processReanalyzeOutput(data);
+          const processed = processReanalyzeOutput(data, {
+            artifactDirectoryLocation,
+          });
 
           if (debug) {
             console.log(
@@ -150,7 +159,8 @@ export const addRemoveUnusedFieldsCommand = (program: Command) => {
 
           const files = await findSourceFiles(
             sourcesToFind.map((s) => s.path),
-            relayConfig.src
+            relayConfig.src,
+            getRelayExcludes(relayConfig)
           );
 
           const filesWithInfo = files.map((absoluteFilePath) => {
diff --git a/packages/rescript-relay-cli/fileUtils.ts b/packages/rescript-relay-cli/fileUtils.ts
@@ -3,7 +3,7 @@ import ora from "ora";
 import path from "path";
 import fs from "fs";
 import { cosmiconfigSync } from "cosmiconfig";
-import { Config } from "relay-compiler/lib/bin/RelayCompilerMain";
+import type { Config } from "relay-compiler/lib/bin/RelayCompilerMain";
 
 const config = cosmiconfigSync("relay", {
   searchPlaces: [
@@ -97,14 +97,90 @@ export const findAllSourceFilesFromGeneratedFiles = async (
 export const getSrcCwd = (src: string) =>
   path.resolve(path.join(process.cwd(), src));
 
-export const findSourceFiles = async (fileNames: string[], src: string) => {
+export const getRelayExcludes = (
+  relayConfig: Partial<Config> & { excludes?: string[] }
+): string[] => relayConfig.excludes ?? relayConfig.exclude ?? [];
+
+const findAncestorContaining = (startDir: string, relativeFilePath: string) => {
+  let currentDir = path.resolve(startDir);
+
+  while (true) {
+    const candidate = path.join(currentDir, relativeFilePath);
+
+    if (fs.existsSync(candidate)) {
+      return currentDir;
+    }
+
+    const parentDir = path.dirname(currentDir);
+
+    if (parentDir === currentDir) {
+      return null;
+    }
+
+    currentDir = parentDir;
+  }
+};
+
+export const getReanalyzeCwd = (startDir: string) =>
+  findAncestorContaining(startDir, path.join("lib", "bs", ".sourcedirs.json")) ??
+  startDir;
+
+export const getRescriptToolsCommand = (startDir: string) => {
+  const rescriptToolsRoot = findAncestorContaining(
+    startDir,
+    path.join("node_modules", "rescript", "cli", "rescript-tools.js")
+  );
+
+  if (rescriptToolsRoot != null) {
+    return {
+      command: process.execPath,
+      args: [
+        path.join(
+          rescriptToolsRoot,
+          "node_modules",
+          "rescript",
+          "cli",
+          "rescript-tools.js"
+        ),
+        "reanalyze",
+        "-dce",
+      ],
+    };
+  }
+
+  const binName =
+    process.platform === "win32" ? "rescript-tools.cmd" : "rescript-tools";
+  const packageRoot = findAncestorContaining(
+    startDir,
+    path.join("node_modules", ".bin", binName)
+  );
+
+  if (packageRoot != null) {
+    return {
+      command: path.join(packageRoot, "node_modules", ".bin", binName),
+      args: ["reanalyze", "-dce"],
+    };
+  }
+
+  return {
+    command: "npx",
+    args: ["--yes", "@rescript/tools", "reanalyze", "-dce"],
+  };
+};
+
+export const findSourceFiles = async (
+  fileNames: string[],
+  src: string,
+  excludes: string[] = []
+) => {
   const cwd = getSrcCwd(src);
 
   const files = await glob(
     fileNames.map((name) => `**/${name}`),
     {
       cwd,
       absolute: true,
+      ignore: excludes,
       onlyFiles: true,
     }
   );
