Merge 405c1fb into 57e97ae

server/src/services/validation/worker/build/buildInputsToSolc.ts

@@ -1,3 +1,4 @@
+import type { SolcBuild } from "hardhat/types";
 import {
   WorkerState,
   BuildJob,
@@ -7,7 +8,7 @@ export interface SolcInput {
   built: true;
   solcVersion: string;
   input: unknown;
-  compilationJob: unknown;
+  solcBuild: SolcBuild;
   sourcePaths: string[];
 }
 
@@ -59,11 +60,17 @@ export async function buildInputsToSolc(
 
   const solcVersion = buildJob.context.compilationJob.getSolcConfig().version;
 
+  await getSolcBuild(workerState, buildJob, solcVersion);
+
+  if (isJobCancelled(buildJob)) {
+    return cancel(buildJob);
+  }
+
   return {
     built: true,
     solcVersion,
     input: buildJob.context.input,
-    compilationJob: buildJob.context.compilationJob,
+    solcBuild: buildJob.context.solcBuild,
     sourcePaths: buildJob.context.sourcePaths ?? [],
   };
 }
@@ -186,6 +193,55 @@ async function getSolcInput(
   return null;
 }
 
+/**
+ * The solc build subtask, this downloads the appropriate compiler
+ * for the given solc version, then checks the hash of the solc binary.
+ * As these checks are expensive, we cache in the workerState whether
+ * the download and check has already been done
+ * @param workerState the state shared between build jobs
+ * @param buildJob the container for the context of the build job
+ * @param solcVersion the solc compiler to download
+ * @returns a promise that the context has been populated
+ *  with the compiler path details
+ */
+async function getSolcBuild(
+  {
+    hre,
+    tasks: { TASK_COMPILE_SOLIDITY_GET_SOLC_BUILD },
+    compilerMetadataCache,
+  }: WorkerState,
+  { context }: BuildJob,
+  solcVersion: string
+) {
+  try {
+    const cachedBuildVersionPromise = compilerMetadataCache[solcVersion];
+
+    if (cachedBuildVersionPromise !== undefined) {
+      const cachedSolcBuild = await cachedBuildVersionPromise;
+
+      context.solcBuild = cachedSolcBuild;
+
+      return;
+    }
+
+    const solcBuildPromise = hre.run(TASK_COMPILE_SOLIDITY_GET_SOLC_BUILD, {
+      quiet: true,
+      solcVersion,
+    });
+
+    compilerMetadataCache[solcVersion] = solcBuildPromise;
+
+    const solcBuild: SolcBuild = await solcBuildPromise;
+
+    context.solcBuild = solcBuild;
+  } catch (err) {
+    // remove the cached promise on build task failure
+    delete compilerMetadataCache[solcVersion];
+
+    throw err;
+  }
+}
+
 function cancel({ jobId, projectBasePath }: BuildJob): {
   built: false;
   result: ValidationCompleteMessage;

server/src/services/validation/worker/build/solcCompile.ts

@@ -1,3 +1,4 @@
+import type { SolcBuild } from "hardhat/types";
 import { HardhatCompilerError, WorkerState } from "../../../../types";
 import { SolcInput } from "./buildInputsToSolc";
 
@@ -8,18 +9,28 @@ export interface SolcResult {
       [key: string]: unknown;
     };
   };
+  solcBuild: SolcBuild;
 }
 
-export function solcCompile(
-  { hre, tasks: { TASK_COMPILE_SOLIDITY_COMPILE } }: WorkerState,
-  { solcVersion, input, compilationJob }: SolcInput
+export async function solcCompile(
+  {
+    hre,
+    tasks: { TASK_COMPILE_SOLIDITY_RUN_SOLCJS, TASK_COMPILE_SOLIDITY_RUN_SOLC },
+  }: WorkerState,
+  { input, solcBuild }: SolcInput
 ): Promise<SolcResult> {
-  return hre.run(TASK_COMPILE_SOLIDITY_COMPILE, {
-    solcVersion,
-    input,
-    quiet: true,
-    compilationJob,
-    compilationJobs: [compilationJob],
-    compilationJobIndex: 0,
-  });
+  let output;
+  if (solcBuild.isSolcJs) {
+    output = await hre.run(TASK_COMPILE_SOLIDITY_RUN_SOLCJS, {
+      input,
+      solcJsPath: solcBuild.compilerPath,
+    });
+  } else {
+    output = await hre.run(TASK_COMPILE_SOLIDITY_RUN_SOLC, {
+      input,
+      solcPath: solcBuild.compilerPath,
+    });
+  }
+
+  return { output, solcBuild };
 }

server/src/services/validation/worker/initialiseWorkerState.ts

@@ -34,7 +34,9 @@ export async function initialiseWorkerState(
     TASK_COMPILE_SOLIDITY_GET_DEPENDENCY_GRAPH,
     TASK_COMPILE_SOLIDITY_GET_COMPILATION_JOB_FOR_FILE,
     TASK_COMPILE_SOLIDITY_GET_COMPILER_INPUT,
-    TASK_COMPILE_SOLIDITY_COMPILE,
+    TASK_COMPILE_SOLIDITY_GET_SOLC_BUILD,
+    TASK_COMPILE_SOLIDITY_RUN_SOLCJS,
+    TASK_COMPILE_SOLIDITY_RUN_SOLC,
     // eslint-disable-next-line @typescript-eslint/no-var-requires
   } = require(`${hardhatBase}/builtin-tasks/task-names`);
 
@@ -59,8 +61,11 @@ export async function initialiseWorkerState(
       TASK_COMPILE_SOLIDITY_GET_DEPENDENCY_GRAPH,
       TASK_COMPILE_SOLIDITY_GET_COMPILATION_JOB_FOR_FILE,
       TASK_COMPILE_SOLIDITY_GET_COMPILER_INPUT,
-      TASK_COMPILE_SOLIDITY_COMPILE,
+      TASK_COMPILE_SOLIDITY_GET_SOLC_BUILD,
+      TASK_COMPILE_SOLIDITY_RUN_SOLCJS,
+      TASK_COMPILE_SOLIDITY_RUN_SOLC,
     },
+    compilerMetadataCache: {},
     send,
     logger,
   };

server/src/types.ts

@@ -1,12 +1,13 @@
-import { Connection } from "vscode-languageserver";
-import * as childProcess from "child_process";
-import { TextDocuments } from "vscode-languageserver/node";
-import { TextDocument } from "vscode-languageserver-textdocument";
-import { Logger } from "@utils/Logger";
-import { WorkspaceFolder } from "vscode-languageserver-protocol";
-import { SolFileIndexMap, SolProjectMap, Diagnostic } from "@common/types";
-import { HardhatProject } from "@analyzer/HardhatProject";
-import { Telemetry } from "./telemetry/types";
+import type { Connection } from "vscode-languageserver";
+import type { Serializable } from "child_process";
+import type { TextDocuments } from "vscode-languageserver/node";
+import type { TextDocument } from "vscode-languageserver-textdocument";
+import type { Logger } from "@utils/Logger";
+import type { WorkspaceFolder } from "vscode-languageserver-protocol";
+import type { SolFileIndexMap, SolProjectMap, Diagnostic } from "@common/types";
+import type { HardhatProject } from "@analyzer/HardhatProject";
+import type { SolcBuild } from "hardhat/types";
+import type { Telemetry } from "./telemetry/types";
 
 export type CancelResolver = (diagnostics: {
   [key: string]: Diagnostic[];
@@ -19,7 +20,7 @@ export interface CompilerProcess {
     solidityCompilePromise: Promise<unknown>;
   };
 
-  send: (message: childProcess.Serializable) => void;
+  send: (message: Serializable) => void;
   kill: () => void;
 }
 
@@ -87,6 +88,8 @@ export interface BuildContext {
   compilationJob?: any;
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   input?: any;
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  solcBuild?: any;
 }
 
 export interface BuildJob {
@@ -134,20 +137,25 @@ export interface WorkerState {
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   SolidityFilesCache: any;
   tasks: {
-    // eslint-disable-next-line @typescript-eslint/naming-convention, @typescript-eslint/no-explicit-any
-    TASK_COMPILE_SOLIDITY_GET_SOURCE_PATHS: any;
-    // eslint-disable-next-line @typescript-eslint/naming-convention, @typescript-eslint/no-explicit-any
-    TASK_COMPILE_SOLIDITY_GET_SOURCE_NAMES: any;
-    // eslint-disable-next-line @typescript-eslint/naming-convention, @typescript-eslint/no-explicit-any
-    TASK_COMPILE_SOLIDITY_GET_DEPENDENCY_GRAPH: any;
-    // eslint-disable-next-line @typescript-eslint/naming-convention, @typescript-eslint/no-explicit-any
-    TASK_COMPILE_SOLIDITY_GET_COMPILATION_JOB_FOR_FILE: any;
-    // eslint-disable-next-line @typescript-eslint/naming-convention, @typescript-eslint/no-explicit-any
-    TASK_COMPILE_SOLIDITY_GET_COMPILER_INPUT: any;
-    // eslint-disable-next-line @typescript-eslint/naming-convention, @typescript-eslint/no-explicit-any
-    TASK_COMPILE_SOLIDITY_COMPILE: any;
+    // eslint-disable-next-line @typescript-eslint/naming-convention
+    TASK_COMPILE_SOLIDITY_GET_SOURCE_PATHS: string;
+    // eslint-disable-next-line @typescript-eslint/naming-convention
+    TASK_COMPILE_SOLIDITY_GET_SOURCE_NAMES: string;
+    // eslint-disable-next-line @typescript-eslint/naming-convention
+    TASK_COMPILE_SOLIDITY_GET_DEPENDENCY_GRAPH: string;
+    // eslint-disable-next-line @typescript-eslint/naming-convention
+    TASK_COMPILE_SOLIDITY_GET_COMPILATION_JOB_FOR_FILE: string;
+    // eslint-disable-next-line @typescript-eslint/naming-convention
+    TASK_COMPILE_SOLIDITY_GET_COMPILER_INPUT: string;
+    // eslint-disable-next-line @typescript-eslint/naming-convention
+    TASK_COMPILE_SOLIDITY_GET_SOLC_BUILD: string;
+    // eslint-disable-next-line @typescript-eslint/naming-convention
+    TASK_COMPILE_SOLIDITY_RUN_SOLCJS: string;
+    // eslint-disable-next-line @typescript-eslint/naming-convention
+    TASK_COMPILE_SOLIDITY_RUN_SOLC: string;
   };
   send: (message: ValidationCompleteMessage) => Promise<void>;
+  compilerMetadataCache: { [key: string]: Promise<SolcBuild> };
   logger: WorkerLogger;
 }