convert all subprocess files in json files

Author: ChristopherDedominici

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

@@ -1,6 +1,6 @@
 import type { Event } from "@sentry/node";
 
-import { writeUtf8File } from "@ignored/hardhat-vnext-utils/fs";
+import { writeJsonFile } from "@ignored/hardhat-vnext-utils/fs";
 import { captureEvent, captureMessage, init } from "@sentry/node";
 
 import { Anonymizer } from "./anonymizer.js";
@@ -58,7 +58,9 @@ try {
 async function sendMsgToSentry(msg: string) {
   if (process.env.HARDHAT_TEST_SUBPROCESS_RESULT_PATH !== undefined) {
     // ATTENTION: only for testing
-    await writeUtf8File(process.env.HARDHAT_TEST_SUBPROCESS_RESULT_PATH, msg);
+    await writeJsonFile(process.env.HARDHAT_TEST_SUBPROCESS_RESULT_PATH, {
+      msg,
+    });
     return;
   }
 
@@ -68,10 +70,7 @@ async function sendMsgToSentry(msg: string) {
 async function sendEventToSentry(e: Event) {
   if (process.env.HARDHAT_TEST_SUBPROCESS_RESULT_PATH !== undefined) {
     // ATTENTION: only for testing
-    await writeUtf8File(
-      process.env.HARDHAT_TEST_SUBPROCESS_RESULT_PATH,
-      JSON.stringify(e),
-    );
+    await writeJsonFile(process.env.HARDHAT_TEST_SUBPROCESS_RESULT_PATH, e);
     return;
   }
 

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

@@ -70,7 +70,7 @@ describe("analytics", () => {
     it("should create the correct payload for the telemetry consent (positive consent)", async () => {
       await sendTelemetryConsentAnalytics(true);
 
-      await checkIfSubprocessWasExecuted(RESULT_FILE_PATH, true);
+      await checkIfSubprocessWasExecuted(RESULT_FILE_PATH);
 
       const result = await readJsonFile(RESULT_FILE_PATH);
 
@@ -92,7 +92,7 @@ describe("analytics", () => {
     it("should create the correct payload for the telemetry consent (negative consent)", async () => {
       await sendTelemetryConsentAnalytics(false);
 
-      await checkIfSubprocessWasExecuted(RESULT_FILE_PATH, true);
+      await checkIfSubprocessWasExecuted(RESULT_FILE_PATH);
 
       const result = await readJsonFile(RESULT_FILE_PATH);
 
@@ -114,7 +114,7 @@ describe("analytics", () => {
     it("should create the correct payload for the task analytics", async () => {
       const wasSent = await sendTaskAnalytics(["task", "subtask"]);
 
-      await checkIfSubprocessWasExecuted(RESULT_FILE_PATH, true);
+      await checkIfSubprocessWasExecuted(RESULT_FILE_PATH);
 
       const result: Payload = await readJsonFile(RESULT_FILE_PATH);
 

v-next/hardhat/test/internal/cli/telemetry/helpers.ts

@@ -1,10 +1,6 @@
 import path from "node:path";
 
-import {
-  exists,
-  readJsonFile,
-  readUtf8File,
-} from "@ignored/hardhat-vnext-utils/fs";
+import { exists, readJsonFile } from "@ignored/hardhat-vnext-utils/fs";
 
 export const ROOT_PATH_TO_FIXTURE: string = path.join(
   process.cwd(),
@@ -24,7 +20,6 @@ export const TELEMETRY_FOLDER_PATH: string = path.join(
 
 export async function checkIfSubprocessWasExecuted(
   resultFilePath: string,
-  isJsonFile: boolean = false,
 ): Promise<boolean> {
   // Checks if the subprocess was executed by waiting for a file to be created.
   // Uses an interval to periodically check for the file. If the file isn't found
@@ -40,12 +35,7 @@ export async function checkIfSubprocessWasExecuted(
       if (await exists(resultFilePath)) {
         try {
           // Wait for the file to be readable. The file could exist but the writing could be in progress.
-          if (isJsonFile) {
-            await readJsonFile(resultFilePath);
-          } else {
-            await readUtf8File(resultFilePath);
-          }
-
+          await readJsonFile(resultFilePath);
           clearInterval(intervalId);
           resolve(true);
         } catch (_err) {}

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

@@ -134,7 +134,7 @@ describe("Reporter", () => {
 
       const wasSent = await sendErrorTelemetry(HARDHAT_ERROR);
 
-      await checkIfSubprocessWasExecuted(RESULT_FILE_PATH, true);
+      await checkIfSubprocessWasExecuted(RESULT_FILE_PATH);
 
       const resFile: SentryEvent = await readJsonFile(RESULT_FILE_PATH);
 
@@ -176,7 +176,7 @@ describe("Reporter", () => {
 
       const wasSent = await sendErrorTelemetry(ERROR);
 
-      await checkIfSubprocessWasExecuted(RESULT_FILE_PATH, true);
+      await checkIfSubprocessWasExecuted(RESULT_FILE_PATH);
 
       const resFile: SentryEvent = await readJsonFile(RESULT_FILE_PATH);
 

v-next/hardhat/test/internal/cli/telemetry/sentry/subprocess.ts

@@ -2,7 +2,7 @@ import assert from "node:assert/strict";
 import path from "node:path";
 import { afterEach, beforeEach, describe, it } from "node:test";
 
-import { readUtf8File, remove } from "@ignored/hardhat-vnext-utils/fs";
+import { readJsonFile, remove } from "@ignored/hardhat-vnext-utils/fs";
 import { spawnDetachedSubProcess } from "@ignored/hardhat-vnext-utils/subprocess";
 
 import {
@@ -40,9 +40,9 @@ describe("sentry-subprocess", function () {
     });
 
     await checkIfSubprocessWasExecuted(RESULT_FILE_PATH);
-    const fileRes = await readUtf8File(RESULT_FILE_PATH);
+    const fileRes = await readJsonFile(RESULT_FILE_PATH);
 
-    assert.equal(fileRes, "{}");
+    assert.deepEqual(fileRes, {});
   });
 
   it("should send a failure message to Sentry because no argument is passed in argv[2] (serializedEvent)", async () => {
@@ -51,12 +51,11 @@ describe("sentry-subprocess", function () {
     });
 
     await checkIfSubprocessWasExecuted(RESULT_FILE_PATH);
-    const fileRes = await readUtf8File(RESULT_FILE_PATH);
+    const fileRes = await readJsonFile(RESULT_FILE_PATH);
 
-    assert.equal(
-      fileRes,
-      "There was an error parsing an event: 'process.argv[2]' argument is not set",
-    );
+    assert.deepEqual(fileRes, {
+      msg: "There was an error parsing an event: 'process.argv[2]' argument is not set",
+    });
   });
 
   it("should send a failure message to Sentry because the argument in argv[2] is not a valid JSON", async () => {
@@ -65,12 +64,11 @@ describe("sentry-subprocess", function () {
     });
 
     await checkIfSubprocessWasExecuted(RESULT_FILE_PATH);
-    const fileRes = await readUtf8File(RESULT_FILE_PATH);
+    const fileRes = await readJsonFile(RESULT_FILE_PATH);
 
-    assert.equal(
-      fileRes,
-      "There was an error parsing an event: 'process.argv[2]' doesn't have a valid JSON",
-    );
+    assert.deepEqual(fileRes, {
+      msg: "There was an error parsing an event: 'process.argv[2]' doesn't have a valid JSON",
+    });
   });
 
   it("should send a failure message to Sentry because there is an anonymization error", async () => {
@@ -79,11 +77,10 @@ describe("sentry-subprocess", function () {
     });
 
     await checkIfSubprocessWasExecuted(RESULT_FILE_PATH);
-    const fileRes = await readUtf8File(RESULT_FILE_PATH);
+    const fileRes = await readJsonFile(RESULT_FILE_PATH);
 
-    assert.equal(
-      fileRes,
-      "There was an error anonymizing an event: event is null or undefined",
-    );
+    assert.deepEqual(fileRes, {
+      msg: "There was an error anonymizing an event: event is null or undefined",
+    });
   });
 });