add debug module

Author: ChristopherDedominici

v-next/hardhat/src/internal/cli/telemetry/analytics/analytics.ts

@@ -8,6 +8,7 @@ import type {
 import os from "node:os";
 
 import { spawnDetachedSubProcess } from "@ignored/hardhat-vnext-utils/subprocess";
+import debug from "debug";
 
 import { getHardhatVersion } from "../../../utils/package.js";
 import {
@@ -17,7 +18,7 @@ import {
 
 import { getAnalyticsClientId } from "./utils.js";
 
-// TODO:log const log = debug("hardhat:core:global-dir");
+const log = debug("hardhat:cli:telemetry:analytics");
 
 const SESSION_ID = Math.random().toString();
 const ENGAGEMENT_TIME_MSEC = "10000";
@@ -79,6 +80,10 @@ async function sendAnalytics(
 async function createSubprocessToSendAnalytics(
   payload: TelemetryConsentPayload | Payload,
 ): Promise<void> {
+  log(
+    `Sending analytics for '${payload.events[0].name}'. Payload: ${JSON.stringify(payload)}`,
+  );
+
   // The HARDHAT_TEST_SUBPROCESS_RESULT_PATH env variable is used in the tests to instruct the subprocess to write the payload to a file
   // instead of sending it.
   // During testing, the subprocess file is a ts file, whereas in production, it is a js file (compiled code).

v-next/hardhat/src/internal/cli/telemetry/analytics/utils.ts

@@ -8,16 +8,19 @@ import {
   readJsonFile,
   writeJsonFile,
 } from "@ignored/hardhat-vnext-utils/fs";
+import debug from "debug";
+
+const log = debug("hardhat:cli:telemetry:analytics:utils");
 
 const ANALYTICS_FILE_NAME = "analytics.json";
 
 export async function getAnalyticsClientId(): Promise<string> {
   let clientId = await readAnalyticsClientId();
 
   if (clientId === undefined) {
-    // TODO:log log("Client Id not found, generating a new one");
-    clientId = crypto.randomUUID();
+    log("Client Id not found, generating a new one");
 
+    clientId = crypto.randomUUID();
     await writeAnalyticsClientId(clientId);
   }
 
@@ -28,15 +31,16 @@ async function readAnalyticsClientId(): Promise<string | undefined> {
   const globalTelemetryDir = await getTelemetryDir();
   const filePath = path.join(globalTelemetryDir, ANALYTICS_FILE_NAME);
 
-  // TODO:log log(`Looking up Client Id at ${filePath}`);
+  log(`Looking up Client Id at '${filePath}'`);
 
   if ((await exists(filePath)) === false) {
     return undefined;
   }
 
   const data: AnalyticsFile = await readJsonFile(filePath);
   const clientId = data.analytics.clientId;
-  // TODO:log log(`Client Id found: ${clientId}`);
+
+  log(`Client Id found: ${clientId}`);
 
   return clientId;
 }
@@ -50,5 +54,5 @@ async function writeAnalyticsClientId(clientId: string): Promise<void> {
     },
   });
 
-  // TODO:log log(`Stored clientId ${clientId}`);
+  log(`Stored clientId '${clientId}'`);
 }