Add delay between test steps to wait for GitHub

GitHub's API for fetching repo contents seems to now have a bit of a
delay before it works.

Author: s0

src/test/integration/git.test.ts

@@ -11,7 +11,7 @@ import { execFile } from "child_process";
 import { getOctokit } from "@actions/github";
 import { commitChangesFromRepo } from "../../git";
 import { getRefTreeQuery } from "../../github/graphql/queries";
-import { deleteBranches } from "./util";
+import { deleteBranches, waitForGitHubToBeReady } from "./util";
 import git from "isomorphic-git";
 
 const octokit = getOctokit(ENV.GITHUB_TOKEN);
@@ -194,6 +194,8 @@ describe("git", () => {
         log,
       });
 
+      await waitForGitHubToBeReady();
+
       await makeFileChangeAssertions(branch);
 
       // Expect the OID to be the HEAD commit
@@ -263,6 +265,8 @@ describe("git", () => {
         },
       });
 
+      await waitForGitHubToBeReady();
+
       await makeFileChangeAssertions(branch);
 
       await expectParentHasOid({ branch, oid });

src/test/integration/node.test.ts

@@ -3,7 +3,7 @@ import { getOctokit } from "@actions/github";
 
 import { ENV, REPO, ROOT_TEST_BRANCH_PREFIX, log } from "./env.js";
 import { commitFilesFromBuffers } from "../../node.js";
-import { deleteBranches } from "./util.js";
+import { deleteBranches, waitForGitHubToBeReady } from "./util.js";
 import {
   createRefMutation,
   getRefTreeQuery,
@@ -169,6 +169,8 @@ describe("node", () => {
             log,
           });
 
+          await waitForGitHubToBeReady();
+
           await expectBranchHasTree({
             branch,
             // TODO: re-enable
@@ -196,6 +198,8 @@ describe("node", () => {
         ...BASIC_FILE_CONTENTS,
       });
 
+      await waitForGitHubToBeReady();
+
       // Don't test tree for this one as it will change over time / be unstable
       await expectBranchHasTree({
         branch,
@@ -220,6 +224,8 @@ describe("node", () => {
         ...BASIC_FILE_CONTENTS,
       });
 
+      await waitForGitHubToBeReady();
+
       // Don't test tree for this one as it will change over time / be unstable
       await expectBranchHasTree({
         branch,
@@ -244,6 +250,8 @@ describe("node", () => {
         ...BASIC_FILE_CONTENTS,
       });
 
+      await waitForGitHubToBeReady();
+
       await expectBranchHasTree({
         branch,
         // TODO: re-enable
@@ -280,6 +288,8 @@ describe("node", () => {
           force: true,
         });
 
+        await waitForGitHubToBeReady();
+
         await expectBranchHasTree({
           branch,
           // TODO: re-enable
@@ -304,6 +314,8 @@ describe("node", () => {
           },
         });
 
+        await waitForGitHubToBeReady();
+
         expect(() =>
           commitFilesFromBuffers({
             octokit,
@@ -337,6 +349,8 @@ describe("node", () => {
           },
         });
 
+        await waitForGitHubToBeReady();
+
         await commitFilesFromBuffers({
           octokit,
           ...REPO,
@@ -347,6 +361,8 @@ describe("node", () => {
           ...BASIC_FILE_CONTENTS,
         });
 
+        await waitForGitHubToBeReady();
+
         await expectBranchHasTree({
           branch,
           // TODO: re-enable
@@ -371,6 +387,8 @@ describe("node", () => {
           },
         });
 
+        await waitForGitHubToBeReady();
+
         await commitFilesFromBuffers({
           octokit,
           ...REPO,
@@ -381,6 +399,8 @@ describe("node", () => {
           ...BASIC_FILE_CONTENTS,
         });
 
+        await waitForGitHubToBeReady();
+
         await expectBranchHasTree({
           branch,
           // TODO: re-enable
@@ -414,6 +434,8 @@ describe("node", () => {
           message: input,
         });
 
+        await waitForGitHubToBeReady();
+
         const ref = (
           await getRefTreeQuery(octokit, {
             ...REPO,

src/test/integration/util.ts

@@ -35,3 +35,16 @@ export const deleteBranches = async (
       console.debug(`Deleted branch ${branch}`);
     }),
   );
+
+/**
+ * GitHub sometimes has a delay between making changes to a git repo,
+ * and those changes being reflected in the API.
+ *
+ * This function is a workaround to wait for GitHub to be ready
+ * before running these assertions.
+ *
+ * It slows down testing a bit,
+ * but it's better than having flaky tests.
+ */
+export const waitForGitHubToBeReady = () =>
+  new Promise((r) => setTimeout(r, 5000));