Merge pull request #7140 from NomicFoundation/isolated

feat: added isolated config option to build profile

Author: kanej

.changeset/tricky-toys-fetch.md

@@ -0,0 +1,5 @@
+---
+"hardhat": patch
+---
+
+Added `isolated` config option to the build profile configuration (https://github.com/NomicFoundation/hardhat/issues/7125) and remove the `--isolated` flag.

v-next/hardhat-verify/test/solc-versions.ts

@@ -28,6 +28,7 @@ describe("solc-versions", () => {
           },
         ],
         overrides: {},
+        isolated: false,
         preferWasm: false,
       };
       const expected = ["0.8.18", "0.7.2", "0.4.11"];
@@ -51,6 +52,7 @@ describe("solc-versions", () => {
             settings: {},
           },
         },
+        isolated: false,
         preferWasm: false,
       };
       const expected = ["0.5.5", "0.6.4"];
@@ -83,6 +85,7 @@ describe("solc-versions", () => {
             settings: {},
           },
         },
+        isolated: false,
         preferWasm: false,
       };
       const expected = ["0.8.18", "0.7.2", "0.5.5", "0.6.4"];
@@ -107,6 +110,7 @@ describe("solc-versions", () => {
             settings: {},
           },
         },
+        isolated: false,
         preferWasm: false,
       };
       const expected = ["0.8.18", "0.8.18"];
@@ -135,6 +139,7 @@ describe("solc-versions", () => {
             settings: {},
           },
         },
+        isolated: false,
         preferWasm: false,
       };
 
@@ -165,6 +170,7 @@ describe("solc-versions", () => {
             settings: {},
           },
         },
+        isolated: false,
         preferWasm: false,
       };
 

v-next/hardhat/src/internal/builtin-plugins/solidity/build-profiles.ts

@@ -6,7 +6,3 @@ export const DEFAULT_BUILD_PROFILES = [
   "solidity-tests",
   "javascript-tests",
 ] as const;
-
-export function shouldMergeCompilationJobs(buildProfile: string): boolean {
-  return buildProfile !== "production";
-}

v-next/hardhat/src/internal/builtin-plugins/solidity/build-system/build-system.ts

@@ -47,10 +47,7 @@ import debug from "debug";
 import pMap from "p-map";
 
 import { FileBuildResultType } from "../../../../types/solidity/build-system.js";
-import {
-  DEFAULT_BUILD_PROFILE,
-  shouldMergeCompilationJobs,
-} from "../build-profiles.js";
+import { DEFAULT_BUILD_PROFILE } from "../build-profiles.js";
 
 import {
   getArtifactsDeclarationFile,
@@ -131,6 +128,9 @@ export class SolidityBuildSystemImplementation implements SolidityBuildSystem {
 
     await this.#downloadConfiguredCompilers(options?.quiet);
 
+    const buildProfileName = options?.buildProfile ?? DEFAULT_BUILD_PROFILE;
+    const { buildProfile } = this.#getBuildProfile(buildProfileName);
+
     const compilationJobsResult = await this.getCompilationJobs(
       rootFilePaths,
       options,
@@ -212,7 +212,7 @@ export class SolidityBuildSystemImplementation implements SolidityBuildSystem {
             indexedIndividualJobs,
             compilationResult,
             emitArtifactsResult,
-            options,
+            buildProfile.isolated,
           );
         }),
       );
@@ -292,8 +292,6 @@ export class SolidityBuildSystemImplementation implements SolidityBuildSystem {
     rootFilePaths: string[],
     options?: GetCompilationJobsOptions,
   ): Promise<CompilationJobCreationError | GetCompilationJobsResult> {
-    const isolated = options?.isolated ?? false;
-
     await this.#downloadConfiguredCompilers(options?.quiet);
 
     const dependencyGraph = await buildDependencyGraph(
@@ -389,6 +387,8 @@ export class SolidityBuildSystemImplementation implements SolidityBuildSystem {
     // Select which files to compile
     const rootFilesToCompile: Set<string> = new Set();
 
+    const isolated = buildProfile.isolated;
+
     for (const [rootFile, compilationJob] of indexedIndividualJobs.entries()) {
       const jobHash = await compilationJob.getBuildId();
       const cacheResult = this.#compileCache[rootFile];
@@ -432,7 +432,7 @@ export class SolidityBuildSystemImplementation implements SolidityBuildSystem {
       }
     }
 
-    if (!isolated && shouldMergeCompilationJobs(buildProfileName)) {
+    if (!isolated) {
       // non-isolated mode
       log(`Merging compilation jobs`);
 
@@ -895,7 +895,7 @@ export class SolidityBuildSystemImplementation implements SolidityBuildSystem {
     indexedIndividualJobs: Map<string, CompilationJob>,
     result: CompilationResult,
     emitArtifactsResult: EmitArtifactsResult,
-    options: BuildOptions | undefined,
+    isolated: boolean,
   ): Promise<void> {
     const rootFilePaths = result.compilationJob.dependencyGraph
       .getRoots()
@@ -928,7 +928,7 @@ export class SolidityBuildSystemImplementation implements SolidityBuildSystem {
 
       this.#compileCache[rootFilePath] = {
         jobHash,
-        isolated: options?.isolated === true,
+        isolated,
         artifactPaths,
         buildInfoPath: emitArtifactsResult.buildInfoPath,
         buildInfoOutputPath: emitArtifactsResult.buildInfoOutputPath,

v-next/hardhat/src/internal/builtin-plugins/solidity/config.ts

@@ -26,6 +26,10 @@ const sourcePathsType = conditionalUnionType(
   "Expected a string or an array of strings",
 );
 
+const commonSolcUserConfigType = z.object({
+  isolated: z.boolean().optional(),
+});
+
 const solcUserConfigType = z.object({
   version: z.string(),
   settings: z.any().optional(),
@@ -36,12 +40,14 @@ const solcUserConfigType = z.object({
 
 // NOTE: This is only to match the setup present in ./type-extensions.ts
 const singleVersionSolcUserConfigType = solcUserConfigType.extend({
+  isolated: z.boolean().optional(),
   preferWasm: z.boolean().optional(),
 });
 
-const multiVersionSolcUserConfigType = z.object({
+const multiVersionSolcUserConfigType = commonSolcUserConfigType.extend({
   compilers: z.array(solcUserConfigType).nonempty(),
   overrides: z.record(z.string(), solcUserConfigType).optional(),
+  isolated: z.boolean().optional(),
   preferWasm: z.boolean().optional(),
   version: incompatibleFieldType("This field is incompatible with `compilers`"),
   settings: incompatibleFieldType(
@@ -216,6 +222,7 @@ function resolveSolidityConfig(
             settings: {},
           })),
           overrides: {},
+          isolated: false,
           preferWasm: false,
         },
       },
@@ -234,6 +241,7 @@ function resolveSolidityConfig(
             },
           ],
           overrides: {},
+          isolated: solidityConfig.isolated ?? false,
           preferWasm: solidityConfig.preferWasm ?? false,
         },
       },
@@ -263,6 +271,7 @@ function resolveSolidityConfig(
               },
             ),
           ),
+          isolated: solidityConfig.isolated ?? false,
         },
       },
       npmFilesToBuild: solidityConfig.npmFilesToBuild ?? [],
@@ -275,6 +284,7 @@ function resolveSolidityConfig(
   for (const [profileName, profile] of Object.entries(
     solidityConfig.profiles,
   )) {
+    const isolated = profile.isolated ?? profileName === "production";
     const preferWasm = profile.preferWasm ?? profileName === "production";
 
     if ("version" in profile) {
@@ -286,6 +296,7 @@ function resolveSolidityConfig(
           },
         ],
         overrides: {},
+        isolated,
         preferWasm,
       };
       continue;
@@ -309,6 +320,7 @@ function resolveSolidityConfig(
           },
         ),
       ),
+      isolated,
       preferWasm,
     };
   }
@@ -318,6 +330,7 @@ function resolveSolidityConfig(
     if (!(profile in profiles)) {
       profiles[profile] = {
         ...profiles.default,
+        isolated: profile === "production",
         preferWasm: profile === "production",
       };
     }

v-next/hardhat/src/internal/builtin-plugins/solidity/index.ts

@@ -19,10 +19,6 @@ const buildTask = task("build", "Builds your project")
     description: "The default build profile to use",
     defaultValue: "default",
   })
-  .addFlag({
-    name: "isolated",
-    description: "Use isolated mode, which prioritizes reproducibility",
-  })
   .addVariadicArgument({
     name: "files",
     description: "An optional list of files to compile",

v-next/hardhat/src/internal/builtin-plugins/solidity/tasks/build.ts

@@ -10,11 +10,10 @@ interface CompileActionArguments {
   files: string[];
   quiet: boolean;
   defaultBuildProfile: string | undefined;
-  isolated: boolean;
 }
 
 const buildAction: NewTaskActionFunction<CompileActionArguments> = async (
-  { force, files, quiet, defaultBuildProfile, isolated },
+  { force, files, quiet, defaultBuildProfile },
   { solidity, globalOptions },
 ) => {
   const rootPaths =
@@ -34,7 +33,6 @@ const buildAction: NewTaskActionFunction<CompileActionArguments> = async (
     force,
     buildProfile,
     quiet,
-    isolated,
   });
 
   throwIfSolidityBuildFailed(results);

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

@@ -16,10 +16,12 @@ declare module "../../../types/config.js" {
   }
 
   export interface SingleVersionSolcUserConfig extends SolcUserConfig {
+    isolated?: boolean;
     preferWasm?: boolean;
   }
 
   export interface MultiVersionSolcUserConfig {
+    isolated?: boolean;
     preferWasm?: boolean;
     compilers: SolcUserConfig[];
     overrides?: Record<string, SolcUserConfig>;
@@ -55,6 +57,7 @@ declare module "../../../types/config.js" {
   }
 
   export interface SolidityBuildProfileConfig {
+    isolated: boolean;
     preferWasm: boolean;
     compilers: SolcConfig[];
     overrides: Record<string, SolcConfig>;

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

@@ -88,6 +88,7 @@ describe(
             },
           ],
           overrides: {},
+          isolated: false,
           preferWasm: false,
         },
       },

v-next/hardhat/test/internal/builtin-plugins/solidity/build-system/partial-compilation/add-a-dependant.ts

@@ -105,7 +105,7 @@ describe("Partial compilation", () => {
         const project = new TestProjectWrapper(_project, hre);
 
         // Compile first time
-        await project.compile({ isolated: true });
+        await project.compile({ defaultBuildProfile: "production" });
         const firstSnapshot = await project.getSnapshot();
 
         assertFileCounts(firstSnapshot, 1, 1, 1);
@@ -117,7 +117,7 @@ describe("Partial compilation", () => {
         );
 
         // Compile second time
-        await project.compile({ isolated: true });
+        await project.compile({ defaultBuildProfile: "production" });
         const secondSnapshot = await project.getSnapshot();
 
         assertFileCounts(secondSnapshot, 2, 2, 2);