add logic to wait for the file to be readable

Author: ChristopherDedominici

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

@@ -67,7 +67,7 @@ describe("analytics", () => {
     it("should create the correct payload for the telemetry consent (positive consent)", async () => {
       await sendTelemetryConsentAnalytics(true);
 
-      await checkIfSubprocessWasExecuted(RESULT_FILE_PATH);
+      await checkIfSubprocessWasExecuted(RESULT_FILE_PATH, true);
 
       const result = await readJsonFile(RESULT_FILE_PATH);
 
@@ -89,7 +89,7 @@ describe("analytics", () => {
     it("should create the correct payload for the telemetry consent (negative consent)", async () => {
       await sendTelemetryConsentAnalytics(false);
 
-      await checkIfSubprocessWasExecuted(RESULT_FILE_PATH);
+      await checkIfSubprocessWasExecuted(RESULT_FILE_PATH, true);
 
       const result = await readJsonFile(RESULT_FILE_PATH);
 
@@ -111,7 +111,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);
+      await checkIfSubprocessWasExecuted(RESULT_FILE_PATH, true);
 
       const result: Payload = await readJsonFile(RESULT_FILE_PATH);
 

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

@@ -1,6 +1,10 @@
 import path from "node:path";
 
-import { exists, readUtf8File } from "@ignored/hardhat-vnext-utils/fs";
+import {
+  exists,
+  readJsonFile,
+  readUtf8File,
+} from "@ignored/hardhat-vnext-utils/fs";
 
 export const ROOT_PATH_TO_FIXTURE: string = path.join(
   process.cwd(),
@@ -20,6 +24,7 @@ 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
@@ -34,7 +39,13 @@ export async function checkIfSubprocessWasExecuted(
 
       if (await exists(resultFilePath)) {
         try {
-          await readUtf8File(resultFilePath); // Wait for the file to be readable
+          // 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);
+          }
+
           clearInterval(intervalId);
           resolve(true);
         } catch (_err) {}