change errors to HardhatErrors and reset hre singleton in tests

Author: zoeyTM

v-next/hardhat-errors/src/descriptors.ts

@@ -113,6 +113,32 @@ Please double check the file path.`,
 
 Please double check whether you have multiple versions of the same plugin installed.`,
     },
+    NO_CONFIG_FILE_FOUND: {
+      number: 5,
+      messageTemplate: "No Hardhat config file found",
+      websiteTitle: "No Hardhat config file found",
+      websiteDescription:
+        "Hardhat couldn't find a config file in the current directory or any of its parents.",
+    },
+    INVALID_CONFIG_PATH: {
+      number: 6,
+      messageTemplate: "Config file %configPath% not found",
+      websiteTitle: "Invalid config path",
+      websiteDescription: "The config file doesn't exist at the provided path.",
+    },
+    NO_CONFIG_EXPORTED: {
+      number: 7,
+      messageTemplate: "No config exported in %configPath%",
+      websiteTitle: "No config exported",
+      websiteDescription: "There is nothing exported from the config file.",
+    },
+    INVALID_CONFIG_OBJECT: {
+      number: 8,
+      messageTemplate: "Invalid config exported in %configPath%",
+      websiteTitle: "Invalid config object",
+      websiteDescription:
+        "The config file doesn't export a valid configuration object.",
+    },
   },
   INTERNAL: {
     ASSERTION_ERROR: {

v-next/hardhat/src/internal/helpers/config-loading.ts

@@ -1,21 +1,25 @@
 import { isAbsolute, resolve } from "node:path";
+import { pathToFileURL } from "node:url";
 
+import { HardhatError } from "@nomicfoundation/hardhat-errors";
 import { findUp } from "@nomicfoundation/hardhat-utils/fs";
 
+import { ERRORS } from "../../../../hardhat-errors/src/descriptors.js";
+
 async function findClosestHardhatConfig(): Promise<string> {
-  let hardhatConfigPath = await findUp("hardhat.config.js");
+  let hardhatConfigPath = await findUp("hardhat.config.ts");
 
   if (hardhatConfigPath !== undefined) {
     return hardhatConfigPath;
   }
 
-  hardhatConfigPath = await findUp("hardhat.config.ts");
+  hardhatConfigPath = await findUp("hardhat.config.js");
 
   if (hardhatConfigPath !== undefined) {
     return hardhatConfigPath;
   }
 
-  throw new Error("No Hardhat config file found");
+  throw new HardhatError(ERRORS.GENERAL.NO_CONFIG_FILE_FOUND);
 }
 
 export async function resolveConfigPath(): Promise<string> {
@@ -36,19 +40,22 @@ export async function importUserConfig(configPath: string) {
   const { exists } = await import("@nomicfoundation/hardhat-utils/fs");
 
   if (!(await exists(normalizedPath))) {
-    throw new Error(`Config file ${configPath} not found`);
+    throw new HardhatError(ERRORS.GENERAL.INVALID_CONFIG_PATH, { configPath });
   }
 
-  const imported = await import(normalizedPath);
+  console.log("also here", pathToFileURL(normalizedPath).href);
+  const imported = await import(pathToFileURL(normalizedPath).href);
 
   if (!("default" in imported)) {
-    throw new Error(`No config exported in ${configPath}`);
+    throw new HardhatError(ERRORS.GENERAL.NO_CONFIG_EXPORTED, { configPath });
   }
 
   const config = imported.default;
 
   if (typeof config !== "object" || config === null) {
-    throw new Error(`Invalid config exported in ${configPath}`);
+    throw new HardhatError(ERRORS.GENERAL.INVALID_CONFIG_OBJECT, {
+      configPath,
+    });
   }
 
   return config;

v-next/hardhat/src/internal/hre-singleton.ts

@@ -2,7 +2,7 @@ import type { HardhatRuntimeEnvironment } from "../types/hre.js";
 
 import { createHardhatRuntimeEnvironment } from "@nomicfoundation/hardhat-core";
 
-let hre: HardhatRuntimeEnvironment;
+let hre: HardhatRuntimeEnvironment | undefined;
 
 /**
  * This function returns a singleton instance of the Hardhat Runtime Environment.
@@ -20,3 +20,12 @@ export async function getHardhatRuntimeEnvironmentSingleton(
 
   return hre;
 }
+
+/**
+ * This function resets the singleton instance of the Hardhat Runtime Environment.
+ *
+ * It should be used only in tests.
+ */
+export function resetHardhatRuntimeEnvironmentSingleton() {
+  hre = undefined;
+}

v-next/hardhat/test/fixture-projects/config-js/nested-folder/index.js

@@ -0,0 +1 @@
+// left empty so github commits the folder

v-next/hardhat/test/fixture-projects/config-ts/nested-folder/index.js

@@ -0,0 +1 @@
+// left empty so github commits the folder

v-next/hardhat/test/helpers/project.ts

@@ -1,8 +1,7 @@
-import fsPromises from "node:fs/promises";
 import path from "node:path";
 import { before, after } from "node:test";
 
-import { exists } from "@nomicfoundation/hardhat-utils/fs";
+import { exists, getRealPath } from "@nomicfoundation/hardhat-utils/fs";
 
 /**
  * This helper adds mocha hooks to run the tests inside one of the projects
@@ -50,18 +49,3 @@ async function getFixtureProjectPath(
 
   return getRealPath(projectPath);
 }
-
-/**
- * Returns the real path of absolutePath, resolving symlinks.
- *
- * @throws Error if absolutePath doesn't exist.
- */
-async function getRealPath(absolutePath: string): Promise<string> {
-  try {
-    // This method returns the actual casing.
-    // Please read Node.js' docs to learn more.
-    return await fsPromises.realpath(path.normalize(absolutePath));
-  } catch {
-    throw new Error(`Invalid directory ${absolutePath}`);
-  }
-}

v-next/hardhat/test/hre/index.ts

@@ -4,7 +4,10 @@ import { describe, it } from "node:test";
 import { createHardhatRuntimeEnvironment } from "../../src/hre.js";
 import { builtinPlugins } from "../../src/internal/builtin-plugins/index.js";
 import { resolveConfigPath } from "../../src/internal/helpers/config-loading.js";
-import { getHardhatRuntimeEnvironmentSingleton } from "../../src/internal/hre-singleton.js";
+import {
+  getHardhatRuntimeEnvironmentSingleton,
+  resetHardhatRuntimeEnvironmentSingleton,
+} from "../../src/internal/hre-singleton.js";
 import { useFixtureProject } from "../helpers/project.js";
 
 describe("HRE", () => {
@@ -13,6 +16,8 @@ describe("HRE", () => {
       const hre = await createHardhatRuntimeEnvironment({});
 
       assert.deepEqual(hre.config.plugins, builtinPlugins);
+
+      resetHardhatRuntimeEnvironmentSingleton();
     });
   });
 
@@ -32,22 +37,24 @@ describe("HRE", () => {
         { id: "custom task" },
       );
       assert.deepEqual(hre1, hre2);
+
+      resetHardhatRuntimeEnvironmentSingleton();
     });
   });
 
   describe("config loading", () => {
     describe("resolveConfigPath", async () => {
       it("should return the HARDHAT_CONFIG env variable if it is set", async () => {
-        process.env.HARDHAT_CONFIG = "hardhat.config.js";
+        process.env.HARDHAT_CONFIG = "env.config.js";
 
-        assert.equal(await resolveConfigPath(), "hardhat.config.js");
+        assert.equal(await resolveConfigPath(), "env.config.js");
 
         delete process.env.HARDHAT_CONFIG;
       });
 
       it("should throw if the config file is not found", async () => {
         await assert.rejects(resolveConfigPath(), {
-          message: "No Hardhat config file found",
+          message: "HHE5: No Hardhat config file found",
         });
       });
 
@@ -96,18 +103,15 @@ describe("HRE", () => {
       });
     });
 
-    // This test works individually but fails when running all tests
-    // due to the hre singleton being used in tests above.
-    // ESM modules cache is not accessible like `require.cache` in CJS,
-    // so a workaround is needed.
-    // TODO: Fix this test
-    describe.skip("programmatic API", () => {
+    describe("programmatic API", () => {
       useFixtureProject("loaded-config");
 
       it("should load the config file", async () => {
         const hre = await import("../../src/index.js");
 
         assert.deepEqual(hre.config.plugins, [{ id: "test-plugin" }]);
+
+        resetHardhatRuntimeEnvironmentSingleton();
       });
     });
   });