better helpers

Author: aslushnikov

src/_internalUtils.ts

@@ -1,8 +1,6 @@
 import { spawnSync, SpawnSyncOptionsWithStringEncoding } from 'child_process';
 import crypto from 'crypto';
 import fs from 'fs';
-import http from 'http';
-import https from 'https';
 import util from 'util';
 import zlib from 'zlib';
 
@@ -55,13 +53,21 @@ async function fetchOk(input: RequestInfo | URL, init?: RequestInit): Promise<Re
   return response;
 }
 
-export async function fetchWithRetries(input: RequestInfo | URL, init?: RequestInit, backoff: number[] = HTTP_BACKOFF): Promise<Response> {
-  return await retryWithBackoff(async () => await fetchOk(input, init), backoff);
+export async function getJSON<T>(input: RequestInfo | URL, init?: RequestInit, backoff: number[] = HTTP_BACKOFF): Promise<T> {
+  return await retryWithBackoff(async () => {
+    const response = await fetchOk(input, init);
+    return await response.json() as T;
+  }, backoff);
 }
 
-export async function fetchAndDrainWithRetries(input: RequestInfo | URL, init?: RequestInit, backoff: number[] = HTTP_BACKOFF): Promise<void> {
+export async function putBuffer(input: RequestInfo | URL, body: Buffer, headers?: HeadersInit, backoff: number[] = HTTP_BACKOFF): Promise<void> {
   await retryWithBackoff(async () => {
-    const response = await fetchOk(input, init);
+    const response = await fetchOk(input, {
+      method: 'PUT',
+      headers,
+      body: new Uint8Array(body),
+    });
+    // Read response to ensure it completes.
     await response.arrayBuffer();
   }, backoff);
 }

src/fetchTestDurations.ts

@@ -1,6 +1,6 @@
 import { FlakinessReport } from '@flakiness/flakiness-report';
 import { URL } from 'url';
-import { compressTextAsync, fetchAndDrainWithRetries, fetchWithRetries, sha1Text } from './_internalUtils.js';
+import { compressTextAsync, getJSON, putBuffer, sha1Text } from './_internalUtils.js';
 import { GithubOIDC } from './githubOIDC.js';
 
 type TestDurationsFetcherOptions = {
@@ -104,14 +104,14 @@ class TestDurationsFetcher {
   private async _api<OUTPUT>(pathname: string, token: string, body?: any): Promise<OUTPUT> {
     const url = new URL(this._options.flakinessEndpoint);
     url.pathname = pathname;
-    return await fetchWithRetries(url, {
+    return await getJSON<OUTPUT>(url, {
       method: 'POST',
       headers: {
         'Authorization': `Bearer ${token}`,
         'Content-Type': 'application/json',
       },
       body: body ? JSON.stringify(body) : undefined,
-    }).then(async response => await response.json());
+    });
   }
 
   async fetch(): Promise<FlakinessReport.Report> {
@@ -139,7 +139,7 @@ class TestDurationsFetcher {
       createResponse.testDurationsToken,
     );
 
-    return await fetchWithRetries(submitResponse.downloadUrl, undefined, DOWNLOAD_BACKOFF).then(async response => await response.json() as FlakinessReport.Report);
+    return await getJSON<FlakinessReport.Report>(submitResponse.downloadUrl, undefined, DOWNLOAD_BACKOFF);
   }
 
   private async _uploadReport(data: string, uploadUrl: string) {
@@ -149,10 +149,6 @@ class TestDurationsFetcher {
       'Content-Length': Buffer.byteLength(compressed) + '',
       'Content-Encoding': 'br',
     };
-    await fetchAndDrainWithRetries(uploadUrl, {
-      method: 'PUT',
-      headers,
-      body: Buffer.from(compressed),
-    });
+    await putBuffer(uploadUrl, compressed, headers);
   }
 }

src/githubOIDC.ts

@@ -1,4 +1,4 @@
-import { fetchWithRetries } from './_internalUtils.js';
+import { getJSON } from './_internalUtils.js';
 
 /**
  * Provides GitHub Actions OIDC (OpenID Connect) token exchange.
@@ -58,9 +58,9 @@ export class GithubOIDC {
     const url = new URL(this._requestUrl);
     url.searchParams.set('audience', flakinessProject);
 
-    let response: Response;
+    let json: { value?: string };
     try {
-      response = await fetchWithRetries(url, {
+      json = await getJSON<{ value?: string }>(url, {
         headers: {
           'Authorization': `bearer ${this._requestToken}`,
           'Accept': 'application/json; api-version=2.0',
@@ -70,7 +70,6 @@ export class GithubOIDC {
       throw new Error(`Failed to request GitHub OIDC token: ${error.message || String(error)}`);
     }
 
-    const json = await response.json() as { value?: string };
     if (!json.value)
       throw new Error('GitHub OIDC token response did not contain a token value.');
 

src/uploadReport.ts

@@ -3,7 +3,7 @@ import assert from 'assert';
 import fs from 'fs';
 import { URL } from 'url';
 import { GithubOIDC } from './githubOIDC.js';
-import { compressTextAsync, fetchAndDrainWithRetries, fetchWithRetries, sha1File, sha1Text } from './_internalUtils.js';
+import { compressTextAsync, getJSON, putBuffer, sha1File, sha1Text } from './_internalUtils.js';
 
 type ReportUploaderOptions = {
   flakinessEndpoint: string;
@@ -308,7 +308,7 @@ class ReportUpload {
     const url = new URL(this._options.flakinessEndpoint);
     url.pathname = pathname;
     try {
-      const response = await fetchWithRetries(url, {
+      const result = await getJSON<OUTPUT>(url, {
         method: 'POST',
         headers: {
           'Authorization': `Bearer ${token}`,
@@ -317,7 +317,7 @@ class ReportUpload {
         body: body ? JSON.stringify(body) : undefined,
       });
       return {
-        result: await response.json() as OUTPUT,
+        result,
         error: undefined,
       };
     } catch (error: any) {
@@ -370,11 +370,7 @@ class ReportUpload {
       'Content-Length': Buffer.byteLength(compressed) + '',
       'Content-Encoding': 'br',
     };
-    await fetchAndDrainWithRetries(uploadUrl, {
-      method: 'PUT',
-      headers,
-      body: Buffer.from(compressed),
-    });
+    await putBuffer(uploadUrl, compressed, headers);
   }
 
   private async _uploadAttachment(attachment: Attachment, uploadUrl: string) {
@@ -387,13 +383,9 @@ class ReportUpload {
     // Stream file only if there's attachment path and we should NOT compress it.
     if (!compressable && attachment.type === 'file') {
       const fileBuffer = await fs.promises.readFile(attachment.path);
-      await fetchAndDrainWithRetries(uploadUrl, {
-        method: 'PUT',
-        headers: {
+      await putBuffer(uploadUrl, fileBuffer, {
           'Content-Type': attachment.contentType,
           'Content-Length': fileBuffer.length + '',
-        },
-        body: new Uint8Array(fileBuffer),
       });
       return;
     }
@@ -413,10 +405,6 @@ class ReportUpload {
       headers['Content-Encoding'] = encoding;
     }
 
-    await fetchAndDrainWithRetries(uploadUrl, {
-      method: 'PUT',
-      headers,
-      body: new Uint8Array(buffer),
-    });
+    await putBuffer(uploadUrl, buffer, headers);
   }
 }