Add types for many variables (for tests) (#10632)

Author: michaelfward

packages/e2e-tests/package.json

@@ -1,12 +1,12 @@
 /* Copyright 2024 Record Replay Inc. */
 
-const { execSync } = require("child_process");
+import { execSync } from "child_process";
 
-export function getSecret(key, region) {
+export function getSecret(key: string, region: string) {
   return execSync(
     `aws secretsmanager get-secret-value --secret-id "${key}" --region ${region} --output json --query "SecretString"`
   )
     .toString()
     .trim()
-    .replaceAll('"', "");
+    .replace(/"/g, "");
 }

packages/e2e-tests/scripts/aws_secrets.ts

@@ -5,7 +5,7 @@ import fs from "fs";
 import os from "os";
 import path from "path";
 
-export function install_build_products(RUNTIME_BUILD_ID, PLATFORM, ARCHITECTURE) {
+export function install_build_products(RUNTIME_BUILD_ID: string, PLATFORM: string, ARCHITECTURE: string) {
   // Set BUILD_FILE based on ARCHITECTURE and PLATFORM
   let BUILD_FILE;
   let ARCH_SUFFIX = "";

packages/e2e-tests/scripts/build_products.ts

@@ -17,10 +17,10 @@ const CONFIG = {
 };
 
 // We use this for debugging purposes only.
-let TestFileOverrideList = [];
+let TestFileOverrideList: string[] = [];
 
 // Disable some tests that we know to be problematic.
-const TestFileBlockLists = {
+const TestFileBlockLists: Record<string, string[]> = {
   linux: [],
   darwin: [
     // This test has been failing for a long, long time.  disable it for now so
@@ -40,26 +40,26 @@ const TestFileBlockLists = {
 
 const TestFileBlockList = new Set([
   ...TestFileBlockLists["ALL"],
-  ...TestFileBlockLists[os.platform()],
+  ...(TestFileBlockLists[os.platform()] || []),
 ]);
 
 // Force some tests to run that we have recently fixed but not yet enabled everywhere.
-const TestFileForceLists = {
+const TestFileForceLists: Record<string, string[]> = {
   linux: [],
   darwin: [],
   ALL: [],
 };
 
 const TestFileForceList = new Set([
   ...TestFileForceLists["ALL"],
-  ...TestFileForceLists[os.platform()],
+  ...(TestFileForceLists[os.platform()] || []),
 ]);
 
 /**
  * Re-record all examples that have previously been recorded with
  * "recent Chromium".
  */
-function checkReRecord(testFile, exampleFileInfo: ExampleInfo) {
+function checkReRecord(testFile: string, exampleFileInfo: ExampleInfo) {
   const wouldNormallyTest =
     exampleFileInfo.runtime === "chromium" &&
     exampleFileInfo.runtimeReleaseDate.getUTCFullYear() === 2024 &&
@@ -173,7 +173,7 @@ function gatherChromiumExamplesAndTests() {
 
 // transforms https://github.com/replayio/chromium.git or
 // git@github.com:replayio/chromium to replayio/chromium
-function githubUrlToRepository(url) {
+function githubUrlToRepository(url: string | undefined) {
   return url?.replace(/.*github.com[:\/](.*)\.git/, "$1");
 }
 
@@ -184,8 +184,8 @@ function testHttpConnection(
   const startTime = Date.now();
   return new Promise((resolve, reject) => {
     function attemptConnection() {
-      const request = http.get(url, async res => {
-        if (res.statusCode < 500) {
+      const request = http.get(url, async (res: http.IncomingMessage) => {
+        if (res.statusCode && res.statusCode < 500) {
           // As long as we can connect at all, we should be fine.
           resolve();
           return;
@@ -203,8 +203,8 @@ function testHttpConnection(
         setTimeout(attemptConnection, 1000); // Retry after 1 second
       });
 
-      request.on("error", (err: Error) => {
-        if (err["code"] === "ECONNREFUSED") {
+      request.on("error", (err: Error & { code?: string }) => {
+        if (err.code === "ECONNREFUSED") {
           if (Date.now() - startTime >= timeoutMs) {
             reject(new Error(`Failed to connect to the server within ${timeoutMs / 1000} seconds`));
             return;
@@ -225,7 +225,7 @@ function testHttpConnection(
 }
 
 export default async function run_fe_tests(
-  CHROME_BINARY_PATH,
+  CHROME_BINARY_PATH: string | undefined,
   runInCI = true,
   nWorkers = 4,
   testOverrides?: string[]

packages/e2e-tests/scripts/buildkite_run_fe_tests.ts

@@ -24,18 +24,18 @@ function run_fe_tests_from_build_id(os: string, arch: string, runtimeBuildId: st
   run_fe_tests(CHROME_BINARY_PATH);
 }
 
-function buildUrl(pipelineSlug, buildNumber) {
+function buildUrl(pipelineSlug: string, buildNumber: string | number) {
   return `https://buildkite.com/replay/${pipelineSlug}/builds/${buildNumber}`;
 }
 
-function describeReason(markdownMessage, rebuild) {
+function describeReason(markdownMessage: string, rebuild?: boolean) {
   // do something with `rebuild` here...
   execSync(`buildkite-agent annotate --style info "${markdownMessage}"`, {
     stdio: "inherit",
   });
 }
 
-export async function build_from_reason(os, arch) {
+export async function build_from_reason(os: string, arch: string) {
   const buildReason = await detectAndRecordBuildReason();
 
   if (!process.env.BUILDKITE_TOKEN) {
@@ -46,7 +46,7 @@ export async function build_from_reason(os, arch) {
     case "runtime-chromium-build-id": {
       describeReason(
         `Testing against chromium buildid ${buildReason.chromiumBuildId}`,
-        buildReason.rebuild
+        buildReason.rebuild ?? false
       );
       run_fe_tests_from_build_id(os, arch, buildReason.chromiumBuildId);
       break;
@@ -57,7 +57,7 @@ export async function build_from_reason(os, arch) {
           "chromium-build",
           buildReason.buildNumber
         )})`,
-        buildReason.rebuild
+        buildReason.rebuild ?? false
       );
       const runtimeBuildId = await fetchRuntimeBuildIdFromChromiumBuildNumber(
         os,
@@ -81,7 +81,7 @@ export async function build_from_reason(os, arch) {
         `Testing against latest chromium build on branch \\\`${
           buildReason.branch
         }\\\`: [#${buildNumber}](${buildUrl("chromium-build", buildNumber)})`,
-        buildReason.rebuild
+        buildReason.rebuild ?? false
       );
       const runtimeBuildId = await fetchRuntimeBuildIdFromChromiumBuildId(os, arch, buildId);
       run_fe_tests_from_build_id(os, arch, runtimeBuildId);
@@ -93,7 +93,7 @@ export async function build_from_reason(os, arch) {
           buildReason.pipelineSlug,
           buildReason.buildNumber
         )})`,
-        buildReason.rebuild
+        buildReason.rebuild ?? false
       );
       const runtimeBuildId = await fetchRuntimeBuildIdFromChromiumBuildId(
         os,

packages/e2e-tests/scripts/buildkite_run_tests_from_reason.ts

@@ -113,6 +113,9 @@ export async function detectAndRecordBuildReason() {
   if (BUILDKITE_TRIGGERED_FROM_BUILD_ID) {
     // if we're running due to a triggered build, record that info in an artifact.
     // we assume if BUILDKITE_TRIGGERED_FROM_BUILD_ID is set, then the other two are also set.
+    if (!BUILDKITE_TRIGGERED_FROM_BUILD_PIPELINE_SLUG || !BUILDKITE_TRIGGERED_FROM_BUILD_NUMBER) {
+      throw new Error("Missing required environment variables for triggered build");
+    }
     return await storeTriggeredBuildReason(
       BUILDKITE_TRIGGERED_FROM_BUILD_PIPELINE_SLUG,
       parseInt(BUILDKITE_TRIGGERED_FROM_BUILD_NUMBER),
@@ -191,7 +194,7 @@ async function graphql<ResultT, VariablesT = Record<string, unknown>>(
 
 // apparently we wouldn't need this function (and could use the buildkite-agent cli directly) if
 // we upgraded (there's `buildkite-agent build ...`?)
-export async function fetchLatestChromiumBuildOnBranch(token, branch) {
+export async function fetchLatestChromiumBuildOnBranch(token: string, branch: string) {
   type VariablesType = {
     branch: string;
   };
@@ -233,11 +236,11 @@ export async function fetchLatestChromiumBuildOnBranch(token, branch) {
   };
 }
 
-export async function fetchRuntimeBuildIdFromChromiumBuildId(os, arch, buildId) {
+export async function fetchRuntimeBuildIdFromChromiumBuildId(os: string, arch: string, buildId: string) {
   return fetchArtifactContents(buildId, path.join("build_id", os, arch, "build_id"));
 }
 
-export async function fetchRuntimeBuildIdFromChromiumBuildNumber(os, arch, buildNumber) {
+export async function fetchRuntimeBuildIdFromChromiumBuildNumber(os: string, arch: string, buildNumber: number) {
   const pageSize = 25;
 
   // fetch the first page of builds
@@ -324,13 +327,13 @@ export async function fetchRuntimeBuildIdFromChromiumBuildNumber(os, arch, build
   throw new Error("did not find build number");
 }
 
-async function fetchArtifactContents(buildId, artifactPath) {
+async function fetchArtifactContents(buildId: string, artifactPath: string) {
   execSync(`buildkite-agent artifact download ${artifactPath} . --build ` + buildId);
 
   return fs.readFileSync(artifactPath, "utf8").trim();
 }
 
-async function uploadArtifactContents(artifactPath, contents, contentType) {
+async function uploadArtifactContents(artifactPath: string, contents: string, contentType: string) {
   fs.writeFileSync(artifactPath, contents);
   execSync(`buildkite-agent artifact upload --content-type ${contentType} ${artifactPath}`);
 }