fix: test the shouldUpdateDependency helper thoroughly

Author: galargh

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(workspaceVersion, version) &&
-        !semver.intersects(workspaceVersion, version)
-      );
+    .filter(([dependencyName, templateVersion]) => {
+      const workspaceVersion = workspaceDependencies[dependencyName];
+      return shouldUpdateDependency(workspaceVersion, templateVersion);
     })
     .map(([name, version]) => `${name}@${version}`);
 
@@ -529,3 +528,33 @@ 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;
+  }
+  const workspaceRange = semver.validRange(workspaceVersion, {
+    includePrerelease: true,
+  });
+  const templateRange = semver.validRange(templateVersion, {
+    includePrerelease: true,
+  });
+  assertHardhatInvariant(
+    templateRange !== null,
+    "All the versions of template dependencies should be valid",
+  );
+  // We should update the dependency if the workspace version could not be parsed as a range.
+  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

@@ -29,6 +29,7 @@ import {
   printWelcomeMessage,
   relativeTemplateToWorkspacePath,
   relativeWorkspaceToTemplatePath,
+  shouldUpdateDependency,
 } from "../../../../src/internal/cli/init/init.js";
 import { getTemplates } from "../../../../src/internal/cli/init/template.js";
 
@@ -233,7 +234,7 @@ describe("copyProjectFiles", () => {
 describe("installProjectDependencies", async () => {
   useTmpDir("installProjectDependencies");
 
-  disableConsole();
+  // disableConsole();
 
   const templates = await getTemplates();
 
@@ -357,7 +358,7 @@ describe("installProjectDependencies", async () => {
         packageJson: {
           name: "test",
           version: "0.0.1",
-          devDependencies: { "fake-dependency": "^1.2.3" }, // <-- required version
+          devDependencies: { "fake-dependency": ">=1.2.3" }, // <-- required version
         },
         path: process.cwd(),
         files: [],
@@ -367,7 +368,7 @@ describe("installProjectDependencies", async () => {
         "package.json",
         JSON.stringify({
           type: "module",
-          devDependencies: { "fake-dependency": ">= 1.2.3" }, // <-- version range
+          devDependencies: { "fake-dependency": "^1.2.3" }, // <-- version range
         }),
       );
       await installProjectDependencies(process.cwd(), template, false, true);
@@ -414,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,
+      );
+    });
+  }
+});