Make the compilation cache compiler type aware

alcuadrado · alcuadrado · commit c52e07683da1 · 2026-03-07T23:09:06.000Z
diff --git a/v-next/hardhat/src/internal/builtin-plugins/solidity/build-system/build-system.ts b/v-next/hardhat/src/internal/builtin-plugins/solidity/build-system/build-system.ts
@@ -596,7 +596,8 @@ export class SolidityBuildSystemImplementation implements SolidityBuildSystem {
         cacheResult === undefined ||
         cacheResult.jobHash !== jobHash ||
         cacheResult.isolated !== isolated ||
-        cacheResult.wasm !== isWasm
+        cacheResult.wasm !== isWasm ||
+        cacheResult.compilerType !== compilerType
       ) {
         rootFilesToCompile.add(rootFile);
         continue;
@@ -1201,6 +1202,7 @@ export class SolidityBuildSystemImplementation implements SolidityBuildSystem {
       this.#compileCache[rootFilePath] = {
         jobHash,
         isolated,
+        compilerType: individualJob.solcConfig.type ?? "solc",
         artifactPaths,
         buildInfoPath: emitArtifactsResult.buildInfoPath,
         buildInfoOutputPath: emitArtifactsResult.buildInfoOutputPath,
diff --git a/v-next/hardhat/src/internal/builtin-plugins/solidity/build-system/cache.ts b/v-next/hardhat/src/internal/builtin-plugins/solidity/build-system/cache.ts
@@ -17,6 +17,7 @@ export type CompileCache = Record<string, CompileCacheEntry>;
 export interface CompileCacheEntry {
   jobHash: string;
   isolated: boolean;
+  compilerType: string;
   buildInfoPath: string;
   buildInfoOutputPath: string;
   artifactPaths: string[];
diff --git a/v-next/hardhat/test/internal/builtin-plugins/solidity/build-system/partial-compilation/cache-hit-results.ts b/v-next/hardhat/test/internal/builtin-plugins/solidity/build-system/partial-compilation/cache-hit-results.ts
@@ -1,8 +1,13 @@
+import type { CompileCache } from "../../../../../../src/internal/builtin-plugins/solidity/build-system/cache.js";
+
 import assert from "node:assert/strict";
 import { writeFile } from "node:fs/promises";
 import path from "node:path";
 import { describe, it } from "node:test";
 
+import { readJsonFile, writeJsonFile } from "@nomicfoundation/hardhat-utils/fs";
+import { isObject } from "micro-eth-signer/utils";
+
 import { FileBuildResultType } from "../../../../../../src/types/solidity/build-system.js";
 import { useTestProjectTemplate } from "../resolver/helpers.js";
 
@@ -171,5 +176,83 @@ contract Foo {}`,
         FileBuildResultType.BUILD_SUCCESS,
       );
     });
+
+    it("should return BUILD_SUCCESS when compilerType in cache differs", async () => {
+      await using project = await useTestProjectTemplate({
+        name: "test-project",
+        version: "1.0.0",
+        files: {
+          "contracts/Foo.sol": `// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.0;
+contract Foo {}`,
+        },
+      });
+
+      const hre = await getHRE(project);
+      const filePath = path.join(project.path, "contracts/Foo.sol");
+
+      // First build
+      await hre.solidity.build([filePath], { quiet: true });
+
+      // Tamper with the cache to simulate a different compiler type
+      const cachePath = path.join(project.path, "cache", "compile-cache.json");
+      const cache: CompileCache = await readJsonFile(cachePath);
+      for (const key of Object.keys(cache)) {
+        cache[key].compilerType = "different-compiler";
+      }
+      await writeJsonFile(cachePath, cache);
+
+      // Second build should be a cache miss due to compiler type mismatch
+      const result = await hre.solidity.build([filePath], { quiet: true });
+      assert(
+        hre.solidity.isSuccessfulBuildResult(result),
+        "Build should succeed",
+      );
+
+      assert.equal(
+        result.get(filePath)?.type,
+        FileBuildResultType.BUILD_SUCCESS,
+      );
+    });
+
+    it("should return BUILD_SUCCESS when compilerType is missing from cache (old format)", async () => {
+      await using project = await useTestProjectTemplate({
+        name: "test-project",
+        version: "1.0.0",
+        files: {
+          "contracts/Foo.sol": `// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.0;
+contract Foo {}`,
+        },
+      });
+
+      const hre = await getHRE(project);
+      const filePath = path.join(project.path, "contracts/Foo.sol");
+
+      // First build
+      await hre.solidity.build([filePath], { quiet: true });
+
+      // Remove compilerType from cache to simulate old cache format
+      const cachePath = path.join(project.path, "cache", "compile-cache.json");
+      const cache = await readJsonFile(cachePath);
+      assert.ok(isObject(cache), "Cache should be an object");
+
+      for (const key of Object.keys(cache)) {
+        delete cache[key].compilerType;
+      }
+      await writeJsonFile(cachePath, cache);
+
+      // Second build should be a cache miss due to missing compiler type
+      const result = await hre.solidity.build([filePath], { quiet: true });
+      assert(
+        hre.solidity.isSuccessfulBuildResult(result),
+        "Build should succeed",
+      );
+
+      assert.equal(
+        result.get(filePath)?.type,
+        FileBuildResultType.BUILD_SUCCESS,
+      );
+    });
   });
 });
