Merge pull request #5371 from NomicFoundation/check-missing-deps

Check for missing dependencies when failing to import a file action

Author: schaable

v-next/core/src/internal/plugins/detect-plugin-npm-dependency-problems.ts

@@ -13,13 +13,13 @@ import semver from "semver";
  * @param plugin - the plugin to be validated
  * @param basePathForNpmResolution - the directory path to use for node module resolution, defaulting to `process.cwd()`
  * @throws {HardhatError} with descriptor:
- * - {@link ERRORS.ARTIFACTS.PLUGIN_NOT_INSTALLED} if the plugin is not installed as an npm package
- * - {@link ERRORS.ARTIFACTS.PLUGIN_MISSING_DEPENDENCY} if the plugin's package peer dependency is not installed
- * - {@link ERRORS.ARTIFACTS.DEPENDENCY_VERSION_MISMATCH} if the plugin's package peer dependency is installed but has the wrong version
+ * - {@link HardhatError.ERRORS.PLUGINS.PLUGIN_NOT_INSTALLED} if the plugin is not installed as an npm package
+ * - {@link HardhatError.ERRORS.PLUGINS.PLUGIN_MISSING_DEPENDENCY} if the plugin's package peer dependency is not installed
+ * - {@link HardhatError.ERRORS.PLUGINS.DEPENDENCY_VERSION_MISMATCH} if the plugin's package peer dependency is installed but has the wrong version
  */
 export async function detectPluginNpmDependencyProblems(
   plugin: HardhatPlugin,
-  basePathForNpmResolution: string,
+  basePathForNpmResolution: string = process.cwd(),
 ): Promise<void> {
   if (plugin.npmPackage === undefined) {
     return;

v-next/core/src/internal/tasks/resolved-task.ts

@@ -11,10 +11,14 @@ import type {
   TaskParameter,
 } from "../../types/tasks.js";
 
-import { HardhatError } from "@nomicfoundation/hardhat-errors";
+import {
+  HardhatError,
+  assertHardhatInvariant,
+} from "@nomicfoundation/hardhat-errors";
 import { ensureError } from "@nomicfoundation/hardhat-utils/error";
 
 import { isParameterValueValid } from "../parameters.js";
+import { detectPluginNpmDependencyProblems } from "../plugins/detect-plugin-npm-dependency-problems.js";
 
 import { formatTaskId } from "./utils.js";
 
@@ -126,11 +130,13 @@ export class ResolvedTask implements Task {
     ): Promise<any> => {
       // The first action may be empty if the task was originally an empty task
       const currentAction = this.actions[currentIndex].action ?? (() => {});
-
       const actionFn =
         typeof currentAction === "function"
           ? currentAction
-          : await this.#resolveFileAction(currentAction, this.id);
+          : await this.#resolveFileAction(
+              currentAction,
+              this.actions[currentIndex].pluginId,
+            );
 
       if (currentIndex === 0) {
         /* eslint-disable-next-line @typescript-eslint/consistent-type-assertions --
@@ -237,18 +243,32 @@ export class ResolvedTask implements Task {
    */
   async #resolveFileAction(
     actionFileUrl: string,
-    taskId: string[],
+    actionPluginId?: string,
   ): Promise<NewTaskActionFunction | TaskOverrideActionFunction> {
     let resolvedActionFn;
     try {
       resolvedActionFn = await import(actionFileUrl);
     } catch (error) {
       ensureError(error);
+
+      if (actionPluginId !== undefined) {
+        const plugin = this.#hre.config.plugins.find(
+          (p) => p.id === actionPluginId,
+        );
+
+        assertHardhatInvariant(
+          plugin !== undefined,
+          `Plugin with id ${actionPluginId} not found.`,
+        );
+
+        await detectPluginNpmDependencyProblems(plugin);
+      }
+
       throw new HardhatError(
         HardhatError.ERRORS.TASK_DEFINITIONS.INVALID_ACTION_URL,
         {
           action: actionFileUrl,
-          task: formatTaskId(taskId),
+          task: formatTaskId(this.id),
         },
         error,
       );
@@ -259,7 +279,7 @@ export class ResolvedTask implements Task {
         HardhatError.ERRORS.TASK_DEFINITIONS.INVALID_ACTION,
         {
           action: actionFileUrl,
-          task: formatTaskId(taskId),
+          task: formatTaskId(this.id),
         },
       );
     }

v-next/core/test/internal/tasks/task-manager.ts

@@ -1493,7 +1493,7 @@ describe("TaskManagerImplementation", () => {
         );
       });
 
-      it("should throw if an action url is provided and the module can't be resolved", async () => {
+      it("should throw if an action url is provided but the corresponding module can't be resolved", async () => {
         const hre = await createHardhatRuntimeEnvironment({
           plugins: [
             {
@@ -1520,7 +1520,70 @@ describe("TaskManagerImplementation", () => {
         );
       });
 
-      it("should throw if an action url is provided and the module doesn't have a default export", async () => {
+      /**
+       * There are multiple scenarios where detectPluginNpmDependencyProblems
+       * can throw an error. We're not trying to test all of them, just verify
+       * that the logic is being called and that the error is being thrown.
+       */
+      it("should throw if an action url is provided but the corresponding module can't be resolved due to a missing package", async () => {
+        const nonInstalledPackageActionUrl = import.meta.resolve(
+          "./fixture-projects/not-installed-package/index.js",
+        );
+
+        // the missing dependency is used in the NEW_TASK action
+        let hre = await createHardhatRuntimeEnvironment({
+          plugins: [
+            {
+              id: "plugin1",
+              npmPackage: "non-installed-package",
+              tasks: [
+                new NewTaskDefinitionBuilderImplementation("task1")
+                  .setAction(nonInstalledPackageActionUrl)
+                  .build(),
+              ],
+            },
+          ],
+        });
+
+        await assert.rejects(
+          hre.tasks.getTask("task1").run({}),
+          new HardhatError(HardhatError.ERRORS.PLUGINS.PLUGIN_NOT_INSTALLED, {
+            pluginId: "plugin1",
+          }),
+        );
+
+        // the missing dependency is used in the TASK_OVERRIDE action
+        hre = await createHardhatRuntimeEnvironment({
+          plugins: [
+            {
+              id: "plugin1",
+              tasks: [
+                new NewTaskDefinitionBuilderImplementation("task1")
+                  .setAction(() => {})
+                  .build(),
+              ],
+            },
+            {
+              id: "plugin2",
+              npmPackage: "non-installed-package",
+              tasks: [
+                new TaskOverrideDefinitionBuilderImplementation("task1")
+                  .setAction(nonInstalledPackageActionUrl)
+                  .build(),
+              ],
+            },
+          ],
+        });
+
+        await assert.rejects(
+          hre.tasks.getTask("task1").run({}),
+          new HardhatError(HardhatError.ERRORS.PLUGINS.PLUGIN_NOT_INSTALLED, {
+            pluginId: "plugin2",
+          }),
+        );
+      });
+
+      it("should throw if an action url is provided and the corresponding module doesn't have a default export", async () => {
         const actionUrl = import.meta.resolve(
           "./fixture-projects/file-actions/no-default.js",
         );
@@ -1551,7 +1614,7 @@ describe("TaskManagerImplementation", () => {
         );
       });
 
-      it("should throw if an action url is provided and the module default export is not a function", async () => {
+      it("should throw if an action url is provided and the corresponding module default export is not a function", async () => {
         const actionUrl = import.meta.resolve(
           "./fixture-projects/file-actions/no-default-fn.js",
         );