fix(remove-pr-from-merge-queue): clean up stray PRs

.github/workflows/tests.yml

@@ -11,10 +11,6 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v3
-        with:
-          ref: ${{ github.event.pull_request.head.ref }}
-          repository: ${{ github.event.pull_request.head.repo.full_name }}
-          token: ${{ secrets.GH_PERSONAL_ACCESS_TOKEN || secrets.GITHUB_TOKEN }}
 
       - name: Validate package.json
         uses: ExpediaGroup/package-json-validator@v1
@@ -55,10 +51,5 @@ jobs:
           if [[ $(git status --porcelain) ]]; then
             echo "Detected uncommitted changes after build. Please run npm run package and commit the changes!"
             git status
-            git config user.name "${{ github.actor }}"
-            git config user.email "${{ github.actor }}@users.noreply.github.com"
-            git add dist/
-            git commit -m "chore: committing generated dist" --no-verify
-            git push
             exit 1
           fi

dist/index.js

@@ -20196,11 +20196,13 @@ var map = {
 	"./remove-pr-from-merge-queue": [
 		6974,
 		832,
+		710,
 		974
 	],
 	"./remove-pr-from-merge-queue.ts": [
 		6974,
 		832,
+		710,
 		974
 	],
 	"./rerun-pr-checks": [

src/helpers/remove-pr-from-merge-queue.ts

@@ -12,26 +12,34 @@ limitations under the License.
 */
 
 import * as core from '@actions/core';
-import { FIRST_QUEUED_PR_LABEL, READY_FOR_MERGE_PR_LABEL } from '../constants';
+import { FIRST_QUEUED_PR_LABEL, QUEUED_FOR_MERGE_PREFIX, READY_FOR_MERGE_PR_LABEL } from '../constants';
 import { HelperInputs } from '../types/generated';
 import { context } from '@actions/github';
 import { octokit } from '../octokit';
 import { removeLabelIfExists } from './remove-label';
+import { map } from 'bluebird';
 
 export class RemovePrFromMergeQueue extends HelperInputs {
   seconds = '';
 }
 
 export const removePrFromMergeQueue = async ({ seconds }: RemovePrFromMergeQueue) => {
-  const { data: prData } = await octokit.pulls.list({
+  const { data: pullRequests } = await octokit.pulls.list({
     state: 'open',
     per_page: 100,
     ...context.repo
   });
-  const firstQueuedPr = prData.find(pr => pr.labels.some(label => label.name === FIRST_QUEUED_PR_LABEL));
+  const firstQueuedPr = pullRequests.find(pr => pr.labels.some(label => label.name === FIRST_QUEUED_PR_LABEL));
   if (!firstQueuedPr) {
     core.info('No PR is first in the merge queue.');
-    return;
+
+    return map(pullRequests, pr => {
+      const queueLabel = pr.labels.find(label => label.name.startsWith(QUEUED_FOR_MERGE_PREFIX));
+      if (queueLabel?.name) {
+        core.info(`Cleaning up PR with queue label ${queueLabel.name}...`);
+        return Promise.all([removeLabelIfExists(READY_FOR_MERGE_PR_LABEL, pr.number), removeLabelIfExists(queueLabel.name, pr.number)]);
+      }
+    });
   }
 
   const {
@@ -44,7 +52,8 @@ export const removePrFromMergeQueue = async ({ seconds }: RemovePrFromMergeQueue
   });
   const failingStatus = data.find(status => status.state === 'failure');
   if (failingStatus && timestampIsStale(failingStatus.created_at, seconds)) {
-    return removeLabelIfExists(READY_FOR_MERGE_PR_LABEL, number);
+    core.info('Removing stale PR from first queued position...');
+    return Promise.all([removeLabelIfExists(READY_FOR_MERGE_PR_LABEL, number), removeLabelIfExists(FIRST_QUEUED_PR_LABEL, number)]);
   }
 };
 

test/helpers/remove-pr-from-merge-queue.test.ts

@@ -11,7 +11,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-import { FIRST_QUEUED_PR_LABEL, READY_FOR_MERGE_PR_LABEL } from '../../src/constants';
+import { FIRST_QUEUED_PR_LABEL, QUEUED_FOR_MERGE_PREFIX, READY_FOR_MERGE_PR_LABEL } from '../../src/constants';
 import { Mocktokit } from '../types';
 import { context } from '@actions/github';
 import { octokit } from '../../src/octokit';
@@ -91,6 +91,7 @@ describe('removePrFromMergeQueue', () => {
 
     it('should call removeLabelIfExists', () => {
       expect(removeLabelIfExists).toHaveBeenCalledWith(READY_FOR_MERGE_PR_LABEL, 12345);
+      expect(removeLabelIfExists).toHaveBeenCalledWith(FIRST_QUEUED_PR_LABEL, 12345);
     });
   });
 
@@ -136,7 +137,7 @@ describe('removePrFromMergeQueue', () => {
   });
 
   describe('should not remove pr case with no failure status', () => {
-    beforeEach(() => {
+    beforeEach(async () => {
       (octokit.repos.listCommitStatusesForRef as unknown as Mocktokit).mockImplementation(async () => ({
         data: [
           {
@@ -153,7 +154,7 @@ describe('removePrFromMergeQueue', () => {
           }
         ]
       }));
-      removePrFromMergeQueue({ seconds });
+      await removePrFromMergeQueue({ seconds });
     });
 
     it('should call pulls.list with correct params', () => {
@@ -175,4 +176,48 @@ describe('removePrFromMergeQueue', () => {
       expect(removeLabelIfExists).not.toHaveBeenCalled();
     });
   });
+
+  describe('should remove stray PRs in the queue', () => {
+    beforeEach(async () => {
+      (octokit.pulls.list as unknown as Mocktokit).mockImplementation(async () => ({
+        data: [
+          {
+            head: { sha: 'wrong sha' },
+            number: 456,
+            labels: [{ name: 'test label' }]
+          },
+          {
+            number: 12345,
+            head: { sha: 'correct sha' },
+            labels: [{ name: READY_FOR_MERGE_PR_LABEL }, { name: `${QUEUED_FOR_MERGE_PREFIX} #2` }]
+          },
+          {
+            number: 678,
+            head: { sha: 'correct sha' },
+            labels: [{ name: READY_FOR_MERGE_PR_LABEL }, { name: `${QUEUED_FOR_MERGE_PREFIX} #3` }]
+          }
+        ]
+      }));
+      await removePrFromMergeQueue({ seconds });
+    });
+
+    it('should call pulls.list with correct params', () => {
+      expect(octokit.pulls.list).toHaveBeenCalledWith({
+        state: 'open',
+        per_page: 100,
+        ...context.repo
+      });
+    });
+
+    it('should call listCommitStatusesForRef with correct params', () => {
+      expect(octokit.repos.listCommitStatusesForRef).not.toHaveBeenCalled();
+    });
+
+    it('should call removeLabelIfExists', () => {
+      expect(removeLabelIfExists).toHaveBeenCalledWith(READY_FOR_MERGE_PR_LABEL, 12345);
+      expect(removeLabelIfExists).toHaveBeenCalledWith(`${QUEUED_FOR_MERGE_PREFIX} #2`, 12345);
+      expect(removeLabelIfExists).toHaveBeenCalledWith(READY_FOR_MERGE_PR_LABEL, 678);
+      expect(removeLabelIfExists).toHaveBeenCalledWith(`${QUEUED_FOR_MERGE_PREFIX} #3`, 678);
+    });
+  });
 });