fix: scale only if check run is in statues queued. #14 (#423)

Author: npalm

modules/runners/lambdas/runners/src/scale-runners/scale-up.test.ts

@@ -11,7 +11,6 @@ jest.mock('@octokit/auth-app', () => ({
 const mockOctokit = {
   checks: { get: jest.fn() },
   actions: {
-    listWorkflowRunsForRepo: jest.fn(),
     createRegistrationTokenForOrg: jest.fn(),
     createRegistrationTokenForRepo: jest.fn(),
   },
@@ -40,9 +39,9 @@ describe('scaleUp', () => {
     process.env.ENVIRONMENT = 'unit-test-environment';
 
     jest.clearAllMocks();
-    mockOctokit.actions.listWorkflowRunsForRepo.mockImplementation(() => ({
+    mockOctokit.checks.get.mockImplementation(() => ({
       data: {
-        total_count: 1,
+        status: 'queued',
       },
     }));
     const mockTokenReturnValue = {
@@ -70,16 +69,16 @@ describe('scaleUp', () => {
 
   it('checks queued workflows', async () => {
     await scaleUp('aws:sqs', TEST_DATA);
-    expect(mockOctokit.actions.listWorkflowRunsForRepo).toBeCalledWith({
+    expect(mockOctokit.checks.get).toBeCalledWith({
+      check_run_id: TEST_DATA.id,
       owner: TEST_DATA.repositoryOwner,
       repo: TEST_DATA.repositoryName,
-      status: 'queued',
     });
   });
 
   it('does not list runners when no workflows are queued', async () => {
-    mockOctokit.actions.listWorkflowRunsForRepo.mockImplementation(() => ({
-      data: { total_count: 0, runners: [] },
+    mockOctokit.checks.get.mockImplementation(() => ({
+      data: { status: 'completed' },
     }));
     await scaleUp('aws:sqs', TEST_DATA);
     expect(listRunners).not.toBeCalled();

modules/runners/lambdas/runners/src/scale-runners/scale-up.ts

@@ -56,17 +56,13 @@ export const scaleUp = async (eventSource: string, payload: ActionRequestMessage
   const environment = process.env.ENVIRONMENT as string;
   const githubAppAuth = await createGithubAppAuth(payload.installationId);
   const githubInstallationClient = await createInstallationClient(githubAppAuth);
-  const queuedWorkflows = await githubInstallationClient.actions.listWorkflowRunsForRepo({
+  const checkRun = await githubInstallationClient.checks.get({
+    check_run_id: payload.id,
     owner: payload.repositoryOwner,
     repo: payload.repositoryName,
-    // @ts-ignore (typing of the 'status' field is incorrect)
-    status: 'queued',
   });
-  console.info(
-    `Repo ${payload.repositoryOwner}/${payload.repositoryName} has ${queuedWorkflows.data.total_count} queued workflow runs`,
-  );
 
-  if (queuedWorkflows.data.total_count > 0) {
+  if (checkRun.data.status === 'queued') {
     const currentRunners = await listRunners({
       environment: environment,
       repoName: enableOrgLevel ? undefined : `${payload.repositoryOwner}/${payload.repositoryName}`,