Move polling to a separate function returning status

Author: kraenhansen

packages/compass-smoke-tests/src/dispatch.ts

@@ -71,6 +71,51 @@ export async function getRefFromGithubPr({
   return ref;
 }
 
+type PollToCompletionOptions = {
+  octokit: ReturnType<typeof github.getOctokit>;
+  runId: number;
+  watchTimeoutMs: number;
+  watchPollDelayMs: number;
+};
+
+async function pollToCompletion({
+  octokit,
+  runId,
+  watchTimeoutMs,
+  watchPollDelayMs,
+}: PollToCompletionOptions): Promise<string> {
+  for (
+    const start = new Date();
+    new Date().getTime() - start.getTime() < watchTimeoutMs;
+
+  ) {
+    const {
+      data: { status, conclusion },
+    } = await octokit.rest.actions.getWorkflowRun({
+      owner: GITHUB_OWNER,
+      repo: GITHUB_REPO,
+      run_id: runId,
+    });
+    console.log(`Status: ${status || 'null'}`);
+    if (status === 'completed') {
+      assert(
+        typeof conclusion === 'string',
+        'Expected conclusion when completed'
+      );
+      return conclusion;
+    }
+    await new Promise((resolve) => setTimeout(resolve, watchPollDelayMs));
+  }
+
+  // Cancel the run before timing out
+  await octokit.rest.actions.cancelWorkflowRun({
+    owner: GITHUB_OWNER,
+    repo: GITHUB_REPO,
+    run_id: runId,
+  });
+  return 'timeout';
+}
+
 type DispatchOptions = {
   githubToken: string;
   ref: string;
@@ -118,29 +163,13 @@ export async function dispatchAndWait({
   );
 
   console.log(`Dispatched run #${run.run_number} (${run.html_url})`);
-  try {
-    for (
-      const start = new Date();
-      new Date().getTime() - start.getTime() < WATCH_POLL_TIMEOUT_MS;
-
-    ) {
-      const {
-        data: { status, conclusion },
-      } = await octokit.rest.actions.getWorkflowRun({
-        owner: GITHUB_OWNER,
-        repo: GITHUB_REPO,
-        run_id: run.id,
-      });
-      console.log(`Status: ${status || 'null'}`);
-      if (status === 'completed') {
-        assert.equal(conclusion, 'success');
-      }
-      await new Promise((resolve) => setTimeout(resolve, watchPollDelayMs));
-    }
-  } finally {
-    console.log(`Run completed: ${run.html_url}`);
-  }
-  throw new Error(
-    `Run did not complete successfully within ${WATCH_POLL_TIMEOUT_MS}ms: See ${run.html_url} for details.`
-  );
+  const status = await pollToCompletion({
+    octokit,
+    runId: run.id,
+    watchTimeoutMs: WATCH_POLL_TIMEOUT_MS,
+    watchPollDelayMs,
+  });
+
+  console.log(`Run completed: ${run.html_url}`);
+  assert.equal(status, 'success');
 }