add log module

Author: ChristopherDedominici

pnpm-lock.yaml

@@ -2,12 +2,15 @@ import {
   HardhatError,
   HardhatPluginError,
 } from "@ignored/hardhat-vnext-errors";
+import debug from "debug";
 
 import { getHardhatVersion } from "../../../utils/package.js";
 import { isTelemetryAllowed } from "../telemetry-permissions.js";
 
 import { getSubprocessTransport } from "./transport.js";
 
+const log = debug("hardhat:cli:telemetry:sentry:reporter");
+
 // TODO: replace with PROD version
 // export const SENTRY_DSN =
 //   "https://[email protected]/522486955555555555";
@@ -50,9 +53,12 @@ class Reporter {
 
     if (!telemetryAllowed) {
       // No need to initialize Sentry because telemetry is disabled
+      log("Reporter not initialized because telemetry is not allowed");
       return this.#instance;
     }
 
+    log("Initializing Reporter instance");
+
     const { Integrations, init, setExtra } = await import("@sentry/node");
 
     const linkedErrorsIntegration = new Integrations.LinkedErrors({
@@ -83,13 +89,16 @@ class Reporter {
     configPath: string = "",
   ): Promise<boolean> {
     if (!(await this.shouldBeReported(error))) {
+      log("Error not send: this type of error should not be reported");
       return false;
     }
 
     const { captureException, setExtra } = await import("@sentry/node");
 
     setExtra("configPath", configPath);
 
+    log("Capturing exception");
+
     captureException(error);
 
     // TODO: where to run it?

v-next/hardhat/src/internal/cli/telemetry/sentry/reporter.ts

@@ -1,6 +1,9 @@
 import type { Event, Response } from "@sentry/node";
 
 import { spawnDetachedSubProcess } from "@ignored/hardhat-vnext-utils/subprocess";
+import debug from "debug";
+
+const log = debug("hardhat:cli:telemetry:sentry:transport");
 
 // This class is wrapped in a function to avoid having to
 // import @sentry/node just for the BaseTransport base class
@@ -12,6 +15,8 @@ export async function getSubprocessTransport(): Promise<any> {
       const extra: { configPath?: string } = event.extra ?? {};
       const { configPath } = extra;
 
+      log("Processing event");
+
       // Don't send user's full config path for privacy reasons
       delete event.extra?.configPath;
       // We don't care about the verbose setting
@@ -43,6 +48,8 @@ export async function getSubprocessTransport(): Promise<any> {
 
       await spawnDetachedSubProcess(subprocessFile, args, env);
 
+      log("Exception sent to detached subprocess");
+
       return {
         status: Status.Success,
       };