Merge pull request #8128 from NomicFoundation/dont-split-compilations-phase-1

Add `splitTestsCompilation` solidity setting (1): Configuration updates

Author: alcuadrado

packages/hardhat/src/internal/builtin-plugins/solidity/config.ts

@@ -81,6 +81,7 @@ const incompatibleCompilerFields = {
 const commonSolidityUserConfigFields = {
   isolated: z.boolean().optional(),
   npmFilesToBuild: z.array(z.string()).optional(),
+  splitTestsCompilation: z.boolean().optional(),
 };
 
 const commonSolidityCompilerUserConfigFields = {
@@ -209,6 +210,7 @@ const buildProfilesSolidityUserConfigType = z.object({
       "Expected an object configuring one or more versions of Solidity",
     ),
   ),
+  ...commonSolidityUserConfigFields,
   ...incompatibleProfileFields,
 });
 
@@ -437,6 +439,7 @@ function resolveSolidityConfig(
       },
       npmFilesToBuild: [],
       registeredCompilerTypes: ["solc"],
+      splitTestsCompilation: false,
     };
   }
 
@@ -457,6 +460,7 @@ function resolveSolidityConfig(
       },
       npmFilesToBuild: solidityConfig.npmFilesToBuild ?? [],
       registeredCompilerTypes: ["solc"],
+      splitTestsCompilation: solidityConfig.splitTestsCompilation ?? false,
     };
   }
 
@@ -488,6 +492,7 @@ function resolveSolidityConfig(
     profiles,
     npmFilesToBuild: solidityConfig.npmFilesToBuild ?? [],
     registeredCompilerTypes: ["solc"],
+    splitTestsCompilation: solidityConfig.splitTestsCompilation ?? false,
   };
 }
 

packages/hardhat/src/internal/builtin-plugins/solidity/type-extensions.ts

@@ -51,6 +51,16 @@ declare module "../../../types/config.js" {
   export interface CommonSolidityUserConfig {
     isolated?: boolean;
     npmFilesToBuild?: string[];
+    /**
+     * Controls whether Solidity test files are compiled in a separate pass
+     * from contract files.
+     *
+     * When `false` (the default), contracts and tests are compiled together
+     * in a single pass.
+     *
+     * When `true`, contracts and tests are compiled separately.
+     */
+    splitTestsCompilation?: boolean;
   }
 
   /**
@@ -289,6 +299,7 @@ declare module "../../../types/config.js" {
     profiles: Record<string, SolidityBuildProfileConfig>;
     npmFilesToBuild: string[];
     registeredCompilerTypes: SolidityCompilerType[];
+    splitTestsCompilation: boolean;
   }
 
   /**

packages/hardhat/test/internal/builtin-plugins/solidity/build-system/build-system.ts

@@ -98,6 +98,7 @@ describe(
       },
       npmFilesToBuild: [],
       registeredCompilerTypes: ["solc"],
+      splitTestsCompilation: false,
     };
 
     before(async () => {

packages/hardhat/test/internal/builtin-plugins/solidity/config.ts

@@ -841,6 +841,103 @@ describe("solidity plugin config validation", () => {
       );
     });
   });
+
+  describe("splitTestsCompilation validation", () => {
+    it("Should accept splitTestsCompilation: true in a single-version config", () => {
+      assert.deepEqual(
+        validateSolidityUserConfig({
+          solidity: {
+            version: "0.8.28",
+            splitTestsCompilation: true,
+          },
+        }),
+        [],
+      );
+    });
+
+    it("Should accept splitTestsCompilation: false in a single-version config", () => {
+      assert.deepEqual(
+        validateSolidityUserConfig({
+          solidity: {
+            version: "0.8.28",
+            splitTestsCompilation: false,
+          },
+        }),
+        [],
+      );
+    });
+
+    it("Should accept omitted splitTestsCompilation", () => {
+      assert.deepEqual(
+        validateSolidityUserConfig({
+          solidity: {
+            version: "0.8.28",
+          },
+        }),
+        [],
+      );
+    });
+
+    it("Should reject invalid non-boolean splitTestsCompilation values", () => {
+      assert.deepEqual(
+        validateSolidityUserConfig({
+          solidity: {
+            version: "0.8.28",
+            splitTestsCompilation: "yes",
+          } as any,
+        }),
+        [
+          {
+            path: ["solidity", "splitTestsCompilation"],
+            message: "Expected boolean, received string",
+          },
+        ],
+      );
+
+      assert.deepEqual(
+        validateSolidityUserConfig({
+          solidity: {
+            version: "0.8.28",
+            splitTestsCompilation: 1,
+          } as any,
+        }),
+        [
+          {
+            path: ["solidity", "splitTestsCompilation"],
+            message: "Expected boolean, received number",
+          },
+        ],
+      );
+    });
+
+    it("Should accept splitTestsCompilation in a multi-version config", () => {
+      assert.deepEqual(
+        validateSolidityUserConfig({
+          solidity: {
+            compilers: [{ version: "0.8.28" }],
+            splitTestsCompilation: true,
+          },
+        }),
+        [],
+      );
+    });
+
+    it("Should accept splitTestsCompilation in a build-profiles config", () => {
+      assert.deepEqual(
+        validateSolidityUserConfig({
+          solidity: {
+            profiles: {
+              default: {
+                version: "0.8.28",
+              },
+            },
+            splitTestsCompilation: true,
+          },
+        }),
+        [],
+      );
+    });
+  });
 });
 
 describe("solidity plugin config resolution", () => {
@@ -854,6 +951,78 @@ describe("solidity plugin config resolution", () => {
 
   it.todo("should resolve a BuildProfilesSolidityUserConfig value", () => {});
 
+  describe("splitTestsCompilation resolution", () => {
+    const otherResolvedConfig = { paths: { root: process.cwd() } } as any;
+
+    it("should default splitTestsCompilation to false for a string config", async () => {
+      const resolvedConfig = await resolveSolidityUserConfig(
+        { solidity: "0.8.28" },
+        otherResolvedConfig,
+      );
+      assert.equal(resolvedConfig.solidity.splitTestsCompilation, false);
+    });
+
+    it("should default splitTestsCompilation to false for a string-array config", async () => {
+      const resolvedConfig = await resolveSolidityUserConfig(
+        { solidity: ["0.8.28"] },
+        otherResolvedConfig,
+      );
+      assert.equal(resolvedConfig.solidity.splitTestsCompilation, false);
+    });
+
+    it("should default splitTestsCompilation to false when omitted from an object config", async () => {
+      const resolvedConfig = await resolveSolidityUserConfig(
+        { solidity: { version: "0.8.28" } },
+        otherResolvedConfig,
+      );
+      assert.equal(resolvedConfig.solidity.splitTestsCompilation, false);
+    });
+
+    it("should resolve splitTestsCompilation: true from a single-version config", async () => {
+      const resolvedConfig = await resolveSolidityUserConfig(
+        { solidity: { version: "0.8.28", splitTestsCompilation: true } },
+        otherResolvedConfig,
+      );
+      assert.equal(resolvedConfig.solidity.splitTestsCompilation, true);
+    });
+
+    it("should resolve splitTestsCompilation: false from a single-version config", async () => {
+      const resolvedConfig = await resolveSolidityUserConfig(
+        { solidity: { version: "0.8.28", splitTestsCompilation: false } },
+        otherResolvedConfig,
+      );
+      assert.equal(resolvedConfig.solidity.splitTestsCompilation, false);
+    });
+
+    it("should resolve splitTestsCompilation from a multi-version config", async () => {
+      const resolvedConfig = await resolveSolidityUserConfig(
+        {
+          solidity: {
+            compilers: [{ version: "0.8.28" }],
+            splitTestsCompilation: true,
+          },
+        },
+        otherResolvedConfig,
+      );
+      assert.equal(resolvedConfig.solidity.splitTestsCompilation, true);
+    });
+
+    it("should resolve splitTestsCompilation from a build-profiles config", async () => {
+      const resolvedConfig = await resolveSolidityUserConfig(
+        {
+          solidity: {
+            profiles: {
+              default: { version: "0.8.28" },
+            },
+            splitTestsCompilation: true,
+          },
+        },
+        otherResolvedConfig,
+      );
+      assert.equal(resolvedConfig.solidity.splitTestsCompilation, true);
+    });
+  });
+
   describe("profile-level preferWasm setting resolution", function () {
     const otherResolvedConfig = { paths: { root: process.cwd() } } as any;
 
@@ -1595,6 +1764,7 @@ describe("validateResolvedConfig", () => {
         profiles,
         npmFilesToBuild: [],
         registeredCompilerTypes,
+        splitTestsCompilation: false,
       },
     }) as unknown as HardhatConfig;