Merge pull request #4786 from NomicFoundation/slow-imports-fix

Fix slow imports eslint rule

Author: schaable

.changeset/curvy-cherries-beg.md

@@ -0,0 +1,7 @@
+---
+"@nomicfoundation/hardhat-chai-matchers": patch
+"hardhat": patch
+"@nomicfoundation/hardhat-viem": patch
+---
+
+Improved loading performance

.github/workflows/test-slow-imports-rule.yml

@@ -32,7 +32,7 @@ jobs:
       - name: Install
         run: pnpm install --frozen-lockfile --prefer-offline
       - name: Add slow import
-        run: echo 'import "lodash";' >> src/internal/constants.ts
+        run: echo 'import "lodash";' >> src/internal/core/config/config-resolution.ts
       - name: Build
         run: pnpm build
       - name: Run eslint

config/eslint/constants.js

@@ -7,6 +7,7 @@ module.exports.slowImportsCommonIgnoredModules = [
   "source-map-support/register",
   "@nomicfoundation/hardhat-ethers",
   "hardhat/common",
+  "hardhat/common/bigInt",
   "hardhat/config",
   "hardhat/plugins",
   "hardhat/types",

packages/eslint-plugin-slow-imports/lib/rules/no-top-level-external-import.js

@@ -5,7 +5,7 @@
 "use strict";
 const fs = require("node:fs");
 const { isBuiltin } = require("node:module");
-const resolve = require("eslint-module-utils/resolve").default;
+const { relative } = require("eslint-module-utils/resolve");
 const parse = require("eslint-module-utils/parse").default;
 const visit = require("eslint-module-utils/visit").default;
 const { visitModules } = require("../helpers/module-visitor");
@@ -45,6 +45,8 @@ module.exports = {
     messages: {
       ENFORCE_DYNAMIC_IMPORT:
         "This import transitively imports the slow dependency '{{dependency}}' in file '{{filename}}' at line {{line}}",
+      CANNOT_RESOLVE_MODULE:
+        "Unable to resolve the absolute module path. This is likely an error in the rule configuration or the file paths.",
     },
   },
 
@@ -55,7 +57,7 @@ module.exports = {
     function visitor(filename, originalNode, node) {
       const modulePath = node.value;
       if (ignoreModules.has(modulePath) || isBuiltin(modulePath)) {
-        return {};
+        return;
       }
 
       function detectTopLevelExternalDependency(path) {
@@ -80,10 +82,22 @@ module.exports = {
       }
 
       if (!isExternalModule(modulePath)) {
-        const absoluteModulePath = resolve(modulePath, context);
+        const absoluteModulePath = relative(
+          modulePath,
+          filename,
+          context.settings
+        );
+
+        if (!absoluteModulePath) {
+          context.report({
+            node: originalNode,
+            messageId: "CANNOT_RESOLVE_MODULE",
+          });
+          return;
+        }
 
-        if (!absoluteModulePath || traversed.has(absoluteModulePath)) {
-          return {};
+        if (traversed.has(absoluteModulePath)) {
+          return;
         }
 
         traversed.add(absoluteModulePath);

packages/hardhat-chai-matchers/src/internal/addressable.ts

@@ -1,4 +1,4 @@
-import { isAddress, isAddressable } from "ethers";
+import type EthersT from "ethers";
 
 export function supportAddressable(
   Assertion: Chai.AssertionStatic,
@@ -26,6 +26,7 @@ function override(
 // so we are looking for a sync way of getting the address. If an address was recovered, it is returned as a string,
 // otherwise undefined is returned.
 function tryGetAddressSync(value: any): string | undefined {
+  const { isAddress, isAddressable } = require("ethers") as typeof EthersT;
   if (isAddress(value)) {
     return value;
   } else if (isAddressable(value)) {

packages/hardhat-chai-matchers/src/internal/changeEtherBalances.ts

@@ -1,8 +1,7 @@
 import type EthersT from "ethers";
 import type { Addressable, BigNumberish, TransactionResponse } from "ethers";
 import type { BalanceChangeOptions } from "./misc/balance";
-
-import ordinal from "ordinal";
+import type OrdinalT from "ordinal";
 
 import { buildAssert } from "../utils";
 import { getAddressOf } from "./misc/account";
@@ -23,6 +22,7 @@ export function supportChangeEtherBalances(
       options?: BalanceChangeOptions
     ) {
       const { toBigInt } = require("ethers") as typeof EthersT;
+      const ordinal = require("ordinal") as typeof OrdinalT;
       // capture negated flag before async code executes; see buildAssert's jsdoc
       const negated = this.__flags.negate;
 

packages/hardhat-chai-matchers/src/internal/emit.ts

@@ -1,10 +1,10 @@
 import type EthersT from "ethers";
 import type { Contract, Transaction } from "ethers";
 import type { AssertWithSsfi, Ssfi } from "../utils";
+import type OrdinalT from "ordinal";
 
 import { AssertionError } from "chai";
 import util from "util";
-import ordinal from "ordinal";
 
 import { buildAssert } from "../utils";
 import { ASSERTION_ABORTED, EMIT_MATCHER } from "./constants";
@@ -156,6 +156,7 @@ function assertArgsArraysEqual(
   ssfi: Ssfi
 ) {
   const ethers = require("ethers") as typeof EthersT;
+  const ordinal = require("ordinal") as typeof OrdinalT;
   const parsedLog = (
     chaiUtils.flag(context, "contract").interface as Interface
   ).parseLog(log);

packages/hardhat-chai-matchers/src/internal/reverted/revertedWithCustomError.ts

@@ -1,7 +1,7 @@
 import type EthersT from "ethers";
+import type OrdinalT from "ordinal";
 
 import { AssertionError } from "chai";
-import ordinal from "ordinal";
 
 import {
   ASSERTION_ABORTED,
@@ -191,6 +191,7 @@ export async function revertedWithCustomErrorWithArgs(
   expectedArgs: any[],
   ssfi: Ssfi
 ) {
+  const ordinal = require("ordinal") as typeof OrdinalT;
   const negated = false; // .withArgs cannot be negated
   const assert = buildAssert(negated, ssfi);
 

packages/hardhat-core/src/internal/core/config/config-loading.ts

@@ -20,7 +20,6 @@ import { getUserConfigPath } from "../project-structure";
 
 import { SUPPORTED_SOLIDITY_VERSION_RANGE } from "../../hardhat-network/stack-traces/constants";
 import { resolveConfig } from "./config-resolution";
-import { validateConfig, validateResolvedConfig } from "./config-validation";
 import { DEFAULT_SOLC_VERSION } from "./default-config";
 
 const log = debug("hardhat:core:config");
@@ -68,6 +67,8 @@ export function loadConfigAndTasks(
     showSolidityConfigWarnings: false,
   }
 ): { resolvedConfig: HardhatConfig; userConfig: HardhatUserConfig } {
+  const { validateConfig, validateResolvedConfig } =
+    require("./config-validation") as typeof import("./config-validation");
   let configPath =
     hardhatArguments !== undefined ? hardhatArguments.config : undefined;
 

packages/hardhat-core/src/internal/core/config/config-resolution.ts

@@ -1,4 +1,5 @@
-import cloneDeep from "lodash/cloneDeep";
+import type { LoDashStatic } from "lodash";
+
 import path from "path";
 import semver from "semver";
 
@@ -62,6 +63,7 @@ export function resolveConfig(
   userConfigPath: string,
   userConfig: HardhatUserConfig
 ): HardhatConfig {
+  const cloneDeep = require("lodash/cloneDeep") as LoDashStatic["cloneDeep"];
   userConfig = cloneDeep(userConfig);
 
   return {
@@ -77,6 +79,7 @@ export function resolveConfig(
 function resolveNetworksConfig(
   networksConfig: NetworksUserConfig = {}
 ): NetworksConfig {
+  const cloneDeep = require("lodash/cloneDeep") as LoDashStatic["cloneDeep"];
   const hardhatNetworkConfig = networksConfig[HARDHAT_NETWORK_NAME];
 
   const localhostNetworkConfig =
@@ -128,6 +131,7 @@ function normalizeHexString(str: string): string {
 function resolveHardhatNetworkConfig(
   hardhatNetworkConfig: HardhatNetworkUserConfig = {}
 ): HardhatNetworkConfig {
+  const cloneDeep = require("lodash/cloneDeep") as LoDashStatic["cloneDeep"];
   const clonedDefaultHardhatNetworkParams = cloneDeep(
     defaultHardhatNetworkParams
   );
@@ -246,6 +250,7 @@ function isHdAccountsConfig(
 function resolveHttpNetworkConfig(
   networkConfig: HttpNetworkUserConfig
 ): HttpNetworkConfig {
+  const cloneDeep = require("lodash/cloneDeep") as LoDashStatic["cloneDeep"];
   const accounts: HttpNetworkAccountsConfig =
     networkConfig.accounts === undefined
       ? defaultHttpNetworkParams.accounts
@@ -427,6 +432,7 @@ function resolveCompiler(compiler: SolcUserConfig): SolcConfig {
 }
 
 function resolveMochaConfig(userConfig: HardhatUserConfig): Mocha.MochaOptions {
+  const cloneDeep = require("lodash/cloneDeep") as LoDashStatic["cloneDeep"];
   return {
     ...cloneDeep(defaultMochaOptions),
     ...userConfig.mocha,

packages/hardhat-core/src/internal/core/config/config-validation.ts

@@ -1,8 +1,12 @@
 import type { HardhatConfig as HardhatConfigT } from "../../../types";
+import type {
+  Context,
+  ValidationError,
+  getFunctionName as getFunctionNameT,
+} from "io-ts/lib";
+import type { Reporter } from "io-ts/lib/Reporter";
 
 import * as t from "io-ts";
-import { Context, getFunctionName, ValidationError } from "io-ts/lib";
-import { Reporter } from "io-ts/lib/Reporter";
 
 import {
   HARDHAT_MEMPOOL_SUPPORTED_ORDERS,
@@ -19,6 +23,9 @@ import { defaultHardhatNetworkParams } from "./default-config";
 
 function stringify(v: any): string {
   if (typeof v === "function") {
+    const { getFunctionName } = require("io-ts/lib") as {
+      getFunctionName: typeof getFunctionNameT;
+    };
     return getFunctionName(v);
   }
   if (typeof v === "number" && !isFinite(v)) {

packages/hardhat-core/src/internal/sentry/transport.ts

@@ -1,4 +1,4 @@
-import { Event, Response } from "@sentry/node";
+import type { Event, Response } from "@sentry/node";
 import { spawn } from "child_process";
 import * as path from "path";
 

packages/hardhat-viem/src/internal/clients.ts

@@ -13,9 +13,6 @@ import type {
   WalletClient,
 } from "../types";
 
-import { getChain, getMode, isDevelopmentNetwork } from "./chains";
-import { getAccounts } from "./accounts";
-
 /**
  * Get a PublicClient instance. This is a read-only client that can be used to
  * query the blockchain.
@@ -28,6 +25,7 @@ export async function getPublicClient(
   provider: EthereumProvider,
   publicClientConfig?: Partial<PublicClientConfig>
 ): Promise<PublicClient> {
+  const { getChain } = await import("./chains");
   const chain = publicClientConfig?.chain ?? (await getChain(provider));
   return innerGetPublicClient(provider, chain, publicClientConfig);
 }
@@ -38,6 +36,7 @@ export async function innerGetPublicClient(
   publicClientConfig?: Partial<PublicClientConfig>
 ): Promise<PublicClient> {
   const viem = await import("viem");
+  const { isDevelopmentNetwork } = await import("./chains");
   const defaultParameters = isDevelopmentNetwork(chain.id)
     ? { pollingInterval: 50, cacheTime: 0 }
     : {};
@@ -65,6 +64,8 @@ export async function getWalletClients(
   provider: EthereumProvider,
   walletClientConfig?: Partial<WalletClientConfig>
 ): Promise<WalletClient[]> {
+  const { getAccounts } = await import("./accounts");
+  const { getChain } = await import("./chains");
   const chain = walletClientConfig?.chain ?? (await getChain(provider));
   const accounts = await getAccounts(provider);
   return innerGetWalletClients(provider, chain, accounts, walletClientConfig);
@@ -77,6 +78,7 @@ export async function innerGetWalletClients(
   walletClientConfig?: Partial<WalletClientConfig>
 ): Promise<WalletClient[]> {
   const viem = await import("viem");
+  const { isDevelopmentNetwork } = await import("./chains");
   const defaultParameters = isDevelopmentNetwork(chain.id)
     ? { pollingInterval: 50, cacheTime: 0 }
     : {};
@@ -108,6 +110,7 @@ export async function getWalletClient(
   address: Address,
   walletClientConfig?: Partial<WalletClientConfig>
 ): Promise<WalletClient> {
+  const { getChain } = await import("./chains");
   const chain = walletClientConfig?.chain ?? (await getChain(provider));
   return (
     await innerGetWalletClients(provider, chain, [address], walletClientConfig)
@@ -126,6 +129,7 @@ export async function getTestClient(
   provider: EthereumProvider,
   testClientConfig?: Partial<TestClientConfig>
 ): Promise<TestClient> {
+  const { getChain, getMode } = await import("./chains");
   const chain = testClientConfig?.chain ?? (await getChain(provider));
   const mode = await getMode(provider);
   return innerGetTestClient(provider, chain, mode, testClientConfig);