[FEATURE] Indiquer dans les PRs qu'elles sont en cours de merge

build/repositories/pull-request-repository.js

@@ -12,8 +12,8 @@ async function isAtLeastOneMergeInProgress(repositoryName) {
   return Boolean(isAtLeastOneMergeInProgress);
 }
 
-async function getOldest(repositoryName) {
-  return knex('pull_requests').where({ isMerging: false, repositoryName }).orderBy('createdAt', 'asc').first();
+async function findNotMerged(repositoryName) {
+  return knex('pull_requests').where({ isMerging: false, repositoryName }).orderBy('createdAt', 'asc');
 }
 
 async function update({ number, repositoryName, isMerging }) {
@@ -24,4 +24,4 @@ async function remove({ number, repositoryName }) {
   await knex('pull_requests').where({ number, repositoryName }).delete();
 }
 
-export { save, isAtLeastOneMergeInProgress, getOldest, update, remove };
+export { save, isAtLeastOneMergeInProgress, findNotMerged, update, remove };

build/services/merge-queue.js

@@ -18,13 +18,14 @@ export class MergeQueue {
       return;
     }
 
-    const pr = await this.#pullRequestRepository.getOldest(repositoryName);
-    if (!pr) {
+    const pr = await this.#pullRequestRepository.findNotMerged(repositoryName);
+    if (pr.length === 0) {
       return;
     }
 
+    const nextMergingPr = pr[0];
     await this.#pullRequestRepository.update({
-      ...pr,
+      ...nextMergingPr,
       isMerging: true,
     });
     await this.#githubService.triggerWorkflow({
@@ -34,9 +35,25 @@ export class MergeQueue {
         ref: config.github.automerge.workflowRef,
       },
       inputs: {
-        pullRequest: `${pr.repositoryName}/${pr.number}`,
+        pullRequest: `${nextMergingPr.repositoryName}/${nextMergingPr.number}`,
       },
     });
+
+    await this.#githubService.setMergeQueueStatus({
+      status: 'pending',
+      description: 'En cours de merge',
+      repositoryFullName: repositoryName,
+      prNumber: pr[0].number,
+    });
+
+    for (let i = 1; i < pr.length; i++) {
+      await this.#githubService.setMergeQueueStatus({
+        status: 'pending',
+        description: `${i + 1}/${pr.length} dans la file d'attente`,
+        repositoryFullName: repositoryName,
+        prNumber: pr[i].number,
+      });
+    }
   }
 
   async managePullRequest({ repositoryName, number }) {

common/services/github.js

@@ -359,28 +359,48 @@ async function _getPullRequestsDetailsByCommitShas({ repoOwner, repoName, commit
   return pullRequestsForCommitShaFilteredDetails;
 }
 
-async function addRADeploymentCheck({ repository, prNumber, status }) {
-  const checkName = 'check-ra-deployment';
+async function createCommitStatus({ context, repo, pull_number, description, state }) {
   const owner = '1024pix';
   const octokit = _createOctokit();
 
-  let response = await octokit.pulls.get({ owner: '1024pix', repo: repository, pull_number: prNumber });
+  let response = await octokit.pulls.get({ owner, repo, pull_number });
   const sha = response.data.head.sha;
 
   response = await octokit.repos.createCommitStatus({
     owner,
-    context: checkName,
-    repo: repository,
+    context,
+    description,
+    repo,
     sha,
-    state: status,
+    state,
   });
 
   const startedAt = response.data.started_at;
-  logger.info(`Check ${checkName} added for PR ${prNumber} in ${repository} with status ${status}`);
+  logger.info(`Check ${context} added for PR ${pull_number} in ${repo} with status ${state}`);
 
   return startedAt;
 }
 
+async function setMergeQueueStatus({ repositoryFullName, prNumber, status, description }) {
+  const repository = repositoryFullName.split('/')[1];
+  return createCommitStatus({
+    context: 'merge-queue-status',
+    repo: repository,
+    pull_number: prNumber,
+    state: status,
+    description,
+  });
+}
+
+async function addRADeploymentCheck({ repository, prNumber, status }) {
+  return createCommitStatus({
+    context: 'check-ra-deployment',
+    repo: repository,
+    pull_number: prNumber,
+    state: status,
+  });
+}
+
 const github = {
   async getPullRequests(label) {
     const pullRequests = await _getPullReviewsFromGithub(label);
@@ -480,6 +500,7 @@ const github = {
   },
   commentPullRequest,
   addRADeploymentCheck,
+  setMergeQueueStatus,
 
   async checkUserBelongsToPix(username) {
     const octokit = _createOctokit();

test/acceptance/build/github_test.js

@@ -682,6 +682,15 @@ describe('Acceptance | Build | Github', function () {
             })
             .reply(200, {});
 
+          const prHeadCommit = 'aaaa';
+          const getPullRequestNock = nock('https://api.github.com')
+            .get(`/repos/1024pix/pix/pulls/123`)
+            .reply(200, { head: { sha: prHeadCommit } });
+
+          const createCheckNock = nock('https://api.github.com')
+            .post(`/repos/${body.repository.full_name}/statuses/${prHeadCommit}`)
+            .reply(201, { started_at: '2024-01-01' });
+
           const response = await server.inject({
             method: 'POST',
             url: '/github/webhook',
@@ -694,6 +703,8 @@ describe('Acceptance | Build | Github', function () {
 
           expect(checkUserBelongsToPixNock.isDone()).to.be.true;
           expect(callGitHubAction.isDone()).to.be.true;
+          expect(getPullRequestNock.isDone()).to.be.true;
+          expect(createCheckNock.isDone()).to.be.true;
           expect(response.statusCode).equal(200);
         });
 
@@ -740,6 +751,16 @@ describe('Acceptance | Build | Github', function () {
             })
             .reply(200, {});
 
+          const prHeadCommit = 'aaaa';
+          nock('https://api.github.com')
+            .get(`/repos/1024pix/pix/pulls/123`)
+            .reply(200, { head: { sha: prHeadCommit } })
+            .persist();
+
+          nock('https://api.github.com')
+            .post(`/repos/${body.repository.full_name}/statuses/${prHeadCommit}`)
+            .reply(201, { started_at: '2024-01-01' });
+
           const secondPRForSameRepo = 567;
           const shouldNotBeCalled = nock('https://api.github.com/')
             .post(`/repos/${workflowRepoName}/actions/workflows/${workflowId}/dispatches`, {

test/integration/build/repositories/pull-request-repository_test.js

@@ -58,10 +58,16 @@ describe('PullRequestRepository', function () {
     });
   });
 
-  describe('#getOldest', function () {
+  describe('#findNotMerged', function () {
     context('when there is at least one pr', function () {
-      it('should return oldest pull request', async function () {
+      it('should return all pull requests', async function () {
         const repositoryName = '1024pix/pix-sample-repo';
+        await knex('pull_requests').insert({
+          number: 789,
+          repositoryName,
+          isMerging: false,
+          createdAt: new Date('2024-02-02'),
+        });
         await knex('pull_requests').insert({
           number: 123,
           repositoryName,
@@ -74,32 +80,24 @@ describe('PullRequestRepository', function () {
           isMerging: false,
           createdAt: new Date('2024-01-02'),
         });
-        await knex('pull_requests').insert({
-          number: 789,
-          repositoryName,
-          isMerging: false,
-          createdAt: new Date('2024-02-02'),
-        });
-
-        const oldestPR = await pullRequestRepository.getOldest(repositoryName);
 
-        expect(oldestPR.number).to.be.equal(456);
+        const notMergedPullRequests = await pullRequestRepository.findNotMerged(repositoryName);
+        expect(notMergedPullRequests.length).to.be.equal(2);
+        expect(notMergedPullRequests[0].number).to.equal(456);
       });
     });
 
     context('when there are no pr for given repository', function () {
-      it('should return undefined', async function () {
-        const repositoryWithoutPRInMergeQueue = '1024pix/repo-under-test';
+      it('should return empty array', async function () {
         await knex('pull_requests').insert({
           number: 123,
-          repositoryName: '1024pix/another-repo',
+          repositoryName: '1024pix/repo',
           isMerging: false,
           createdAt: new Date('2024-01-01'),
         });
 
-        const oldestPR = await pullRequestRepository.getOldest(repositoryWithoutPRInMergeQueue);
-
-        expect(oldestPR).to.be.undefined;
+        const notMergedPullRequests = await pullRequestRepository.findNotMerged('1024pix/another-repo');
+        expect(notMergedPullRequests).to.be.empty;
       });
     });
   });

test/unit/build/services/github_test.js

@@ -604,6 +604,45 @@ describe('Unit | Build | github-test', function () {
     });
   });
 
+  describe('#setMergeQueueStatus', function () {
+    describe('when everything is OK', function () {
+      it('should create the merge queue status', async function () {
+        // given
+        const repositoryFullName = '1024pix/my-repository';
+        const sha = 'my-sha';
+        const prNumber = 1234;
+        const startedAt = new Date();
+
+        const getPullRequestNock = nock('https://api.github.com')
+          .get(`/repos/${repositoryFullName}/pulls/${prNumber}`)
+          .reply(200, { head: { sha } });
+
+        const body = {
+          context: 'merge-queue-status',
+          state: 'pending',
+          description: 'fuu',
+        };
+
+        const createCheckNock = nock('https://api.github.com')
+          .post(`/repos/${repositoryFullName}/statuses/${sha}`, body)
+          .reply(201, { started_at: startedAt });
+
+        // when
+        const result = await githubService.setMergeQueueStatus({
+          repositoryFullName,
+          prNumber,
+          status: 'pending',
+          description: 'fuu',
+        });
+
+        // then
+        expect(result).to.equal(startedAt.toISOString());
+        expect(getPullRequestNock.isDone()).to.be.true;
+        expect(createCheckNock.isDone()).to.be.true;
+      });
+    });
+  });
+
   describe('#addRADeploymentCheck', function () {
     describe('when everything is OK', function () {
       it('should create the check run', async function () {

test/unit/run/services/merge-queue_test.js

@@ -19,7 +19,7 @@ describe('Unit | Build | Services | merge-queue', function () {
     });
 
     context('when there is no PR in merging', function () {
-      it('should get oldest pull requests, mark as currently merging and trigger auto-merge', async function () {
+      it('should find not merged pull requests, mark latest as currently merging and trigger auto-merge', async function () {
         const repositoryName = 'foo/pix-project';
         const pr = {
           number: 1,
@@ -28,14 +28,15 @@ describe('Unit | Build | Services | merge-queue', function () {
         };
         const pullRequestRepository = {
           isAtLeastOneMergeInProgress: sinon.stub(),
-          getOldest: sinon.stub(),
+          findNotMerged: sinon.stub(),
           update: sinon.stub(),
         };
         pullRequestRepository.isAtLeastOneMergeInProgress.withArgs(repositoryName).resolves(false);
-        pullRequestRepository.getOldest.withArgs(repositoryName).resolves(pr);
+        pullRequestRepository.findNotMerged.withArgs(repositoryName).resolves([pr]);
 
         const githubService = {
           triggerWorkflow: sinon.stub(),
+          setMergeQueueStatus: sinon.stub(),
         };
 
         await new MergeQueue({ pullRequestRepository, githubService }).manage({ repositoryName });
@@ -55,6 +56,50 @@ describe('Unit | Build | Services | merge-queue', function () {
           inputs: { pullRequest: 'foo/pix-project/1' },
         });
       });
+
+      it('should create commit status for each pending pull request', async function () {
+        const repositoryName = 'foo/pix-project';
+        const prs = [
+          {
+            number: 1,
+            repositoryName,
+            isMerging: false,
+          },
+          {
+            number: 2,
+            repositoryName,
+            isMerging: false,
+          },
+        ];
+        const pullRequestRepository = {
+          isAtLeastOneMergeInProgress: sinon.stub(),
+          findNotMerged: sinon.stub(),
+          update: sinon.stub(),
+        };
+        pullRequestRepository.isAtLeastOneMergeInProgress.withArgs(repositoryName).resolves(false);
+        pullRequestRepository.findNotMerged.withArgs(repositoryName).resolves(prs);
+
+        const githubService = {
+          triggerWorkflow: sinon.stub(),
+          setMergeQueueStatus: sinon.stub(),
+        };
+
+        await new MergeQueue({ pullRequestRepository, githubService }).manage({ repositoryName });
+
+        expect(githubService.setMergeQueueStatus).to.have.been.calledTwice;
+        expect(githubService.setMergeQueueStatus.firstCall).to.have.been.calledWithExactly({
+          status: 'pending',
+          description: 'En cours de merge',
+          repositoryFullName: repositoryName,
+          prNumber: 1,
+        });
+        expect(githubService.setMergeQueueStatus.secondCall).to.have.been.calledWithExactly({
+          status: 'pending',
+          description: "2/2 dans la file d'attente",
+          repositoryFullName: repositoryName,
+          prNumber: 2,
+        });
+      });
     });
   });