Merge pull request #6426 from NomicFoundation/hardhat-init-reinstall

Fix: bug in semver check on installProjectDependencies

Author: kanej

.changeset/cool-waves-wonder.md

@@ -0,0 +1,5 @@
+---
+"hardhat": patch
+---
+
+Fix unnecessary re-install of hardhat during init ([#6323](https://github.com/NomicFoundation/hardhat/issues/6323))

v-next/hardhat/src/internal/cli/init/init.ts

@@ -3,7 +3,10 @@ import type { PackageJson } from "@nomicfoundation/hardhat-utils/package";
 
 import path from "node:path";
 
-import { HardhatError } from "@nomicfoundation/hardhat-errors";
+import {
+  assertHardhatInvariant,
+  HardhatError,
+} from "@nomicfoundation/hardhat-errors";
 import {
   copy,
   ensureDir,
@@ -480,13 +483,9 @@ export async function installProjectDependencies(
 
   // Finding the installed dependencies that have an incompatible version
   const dependenciesToUpdate = templateDependencyEntries
-    .filter(([name, version]) => {
-      const workspaceVersion = workspaceDependencies[name];
-      return (
-        workspaceVersion !== undefined &&
-        !semver.satisfies(version, workspaceVersion) &&
-        !semver.intersects(version, workspaceVersion)
-      );
+    .filter(([dependencyName, templateVersion]) => {
+      const workspaceVersion = workspaceDependencies[dependencyName];
+      return shouldUpdateDependency(workspaceVersion, templateVersion);
     })
     .map(([name, version]) => `${name}@${version}`);
 
@@ -529,3 +528,34 @@ function showStarOnGitHubMessage() {
   console.log();
   console.log(chalk.cyan("     https://github.com/NomicFoundation/hardhat"));
 }
+
+// NOTE: This function is exported for testing purposes only.
+export function shouldUpdateDependency(
+  workspaceVersion: string | undefined,
+  templateVersion: string,
+): boolean {
+  // We should not update the dependency if it is not yet installed in the workspace.
+  if (workspaceVersion === undefined) {
+    return false;
+  }
+  // NOTE: a specific version also a valid range that includes itself only
+  const workspaceRange = semver.validRange(workspaceVersion, {
+    includePrerelease: true,
+  });
+  const templateRange = semver.validRange(templateVersion, {
+    includePrerelease: true,
+  });
+  assertHardhatInvariant(
+    templateRange !== null,
+    "All dependencies of the template should have valid versions",
+  );
+  // We should update the dependency if the workspace version could not be parsed.
+  if (workspaceRange === null) {
+    return true;
+  }
+  // We should update the dependency if the workspace range (or, in particular, a specific version) is not
+  // a strict subset of the template range/does not equal the template version.
+  return !semver.subset(workspaceRange, templateRange, {
+    includePrerelease: true,
+  });
+}

v-next/hardhat/test/internal/cli/init/init.ts

@@ -1,3 +1,4 @@
+import type { Template } from "../../../../src/internal/cli/init/template.js";
 import type { PackageJson } from "@nomicfoundation/hardhat-utils/package";
 
 import assert from "node:assert/strict";
@@ -28,6 +29,7 @@ import {
   printWelcomeMessage,
   relativeTemplateToWorkspacePath,
   relativeWorkspaceToTemplatePath,
+  shouldUpdateDependency,
 } from "../../../../src/internal/cli/init/init.js";
 import { getTemplates } from "../../../../src/internal/cli/init/template.js";
 
@@ -311,6 +313,72 @@ describe("installProjectDependencies", async () => {
       }
     },
   );
+
+  it(
+    "should not update dependencies if they are up-to-date and the user opts-in to the update (specific version)",
+    {
+      skip: process.env.HARDHAT_DISABLE_SLOW_TESTS === "true",
+    },
+    async () => {
+      const template: Template = {
+        name: "test",
+        packageJson: {
+          name: "test",
+          version: "0.0.1",
+          devDependencies: { "fake-dependency": "^1.2.3" }, // <-- required version
+        },
+        path: process.cwd(),
+        files: [],
+      };
+
+      await writeUtf8File(
+        "package.json",
+        JSON.stringify({
+          type: "module",
+          devDependencies: { "fake-dependency": "1.2.3" }, // <-- specific version
+        }),
+      );
+      await installProjectDependencies(process.cwd(), template, false, true);
+
+      assert.ok(
+        !(await exists("node_modules")),
+        "no modules should have been installed",
+      );
+    },
+  );
+
+  it(
+    "should not update dependencies if they are up-to-date and the user opts-in to the update (version range)",
+    {
+      skip: process.env.HARDHAT_DISABLE_SLOW_TESTS === "true",
+    },
+    async () => {
+      const template: Template = {
+        name: "test",
+        packageJson: {
+          name: "test",
+          version: "0.0.1",
+          devDependencies: { "fake-dependency": ">=1.2.3" }, // <-- required version
+        },
+        path: process.cwd(),
+        files: [],
+      };
+
+      await writeUtf8File(
+        "package.json",
+        JSON.stringify({
+          type: "module",
+          devDependencies: { "fake-dependency": "^1.2.3" }, // <-- version range
+        }),
+      );
+      await installProjectDependencies(process.cwd(), template, false, true);
+
+      assert.ok(
+        !(await exists("node_modules")),
+        "no modules should have been installed",
+      );
+    },
+  );
 });
 
 describe("initHardhat", async () => {
@@ -347,3 +415,166 @@ describe("initHardhat", async () => {
     );
   }
 });
+
+describe("shouldUpdateDependency", () => {
+  const testCases = [
+    {
+      workspaceVersion: "1.0.0",
+      templateVersion: "1.0.0",
+      expectedResult: false,
+    },
+    {
+      workspaceVersion: "1.0.0",
+      templateVersion: "1.2.3",
+      expectedResult: true,
+    },
+    {
+      workspaceVersion: "1.2.3",
+      templateVersion: "1.0.0",
+      expectedResult: true,
+    },
+    {
+      workspaceVersion: "1.2.3",
+      templateVersion: "^1.2.3",
+      expectedResult: false,
+    },
+    {
+      workspaceVersion: "^1.2.3",
+      templateVersion: "1.2.3",
+      expectedResult: true,
+    },
+    {
+      workspaceVersion: ">= 1.2.3",
+      templateVersion: "^1.2.3",
+      expectedResult: true,
+    },
+    {
+      workspaceVersion: "^1.2.3",
+      templateVersion: ">= 1.2.3",
+      expectedResult: false,
+    },
+    {
+      workspaceVersion: "1.0.0-dev",
+      templateVersion: "1.0.0-dev",
+      expectedResult: false,
+    },
+    {
+      workspaceVersion: "1.0.0-dev",
+      templateVersion: "1.2.3-dev",
+      expectedResult: true,
+    },
+    {
+      workspaceVersion: "1.2.3-dev",
+      templateVersion: "1.0.0-dev",
+      expectedResult: true,
+    },
+    {
+      workspaceVersion: "1.2.3-dev",
+      templateVersion: "^1.2.3-dev",
+      expectedResult: false,
+    },
+    {
+      workspaceVersion: "^1.2.3-dev",
+      templateVersion: "1.2.3-dev",
+      expectedResult: true,
+    },
+    {
+      workspaceVersion: ">= 1.2.3-dev",
+      templateVersion: "^1.2.3-dev",
+      expectedResult: true,
+    },
+    {
+      workspaceVersion: "^1.2.3-dev",
+      templateVersion: ">= 1.2.3-dev",
+      expectedResult: false,
+    },
+    {
+      workspaceVersion: "1.0.0",
+      templateVersion: "1.0.0-dev",
+      expectedResult: true,
+    },
+    {
+      workspaceVersion: "1.0.0-dev",
+      templateVersion: "1.0.0",
+      expectedResult: true,
+    },
+    {
+      workspaceVersion: "1.0.0-dev",
+      templateVersion: "1.2.3",
+      expectedResult: true,
+    },
+    {
+      workspaceVersion: "1.0.0",
+      templateVersion: "1.2.3-dev",
+      expectedResult: true,
+    },
+    {
+      workspaceVersion: "1.2.3",
+      templateVersion: "1.0.0-dev",
+      expectedResult: true,
+    },
+    {
+      workspaceVersion: "1.2.3-dev",
+      templateVersion: "1.0.0",
+      expectedResult: true,
+    },
+    {
+      workspaceVersion: "1.2.3",
+      templateVersion: "^1.2.3-dev",
+      expectedResult: false,
+    },
+    {
+      workspaceVersion: "1.2.3-dev",
+      templateVersion: "^1.2.3",
+      expectedResult: true,
+    },
+    {
+      workspaceVersion: "^1.2.3",
+      templateVersion: "1.2.3-dev",
+      expectedResult: true,
+    },
+    {
+      workspaceVersion: "^1.2.3-dev",
+      templateVersion: "1.2.3",
+      expectedResult: true,
+    },
+    {
+      workspaceVersion: ">= 1.2.3",
+      templateVersion: "^1.2.3-dev",
+      expectedResult: true,
+    },
+    {
+      workspaceVersion: ">= 1.2.3-dev",
+      templateVersion: "^1.2.3",
+      expectedResult: true,
+    },
+    {
+      workspaceVersion: "^1.2.3",
+      templateVersion: ">= 1.2.3-dev",
+      expectedResult: false,
+    },
+    {
+      workspaceVersion: "^1.2.3-dev",
+      templateVersion: ">= 1.2.3",
+      expectedResult: true,
+    },
+    {
+      workspaceVersion: "3.0.0-next.0",
+      templateVersion: "^3.0.0-next.0",
+      expectedResult: false,
+    },
+  ];
+
+  for (const {
+    workspaceVersion,
+    templateVersion,
+    expectedResult,
+  } of testCases) {
+    it(`should return ${expectedResult} when workspace version is ${workspaceVersion} and template version is ${templateVersion}`, () => {
+      assert.equal(
+        shouldUpdateDependency(workspaceVersion, templateVersion),
+        expectedResult,
+      );
+    });
+  }
+});