Mitigate race condition around setting size labels

By fetching labels from the API just before we apply them, we reduce the chance that the set of labels has changed since the workflow started.
lerebear · Mar 2, 2024 · 0ed1635 · 0ed1635
1 parent 4b744e0
commit 0ed1635
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 5 deletions.
diff --git a/__tests__/main.test.ts b/__tests__/main.test.ts
@@ -34,7 +34,6 @@ function pullRequestEventContext(overrides = {}): object {
         head: {
           ref: 'topic'
         },
-        labels: [],
         number: 1,
         user: {
           login: 'lerebear'
@@ -51,10 +50,12 @@ describe('action', () => {
   jest.spyOn(github, 'getOctokit').mockImplementation((token: string): any => {
     if (token === 'xxx') {
       return {
+        paginate: () => [],
         rest: {
           issues: {
             getLabel: () => {},
-            addLabels: () => {}
+            addLabels: () => {},
+            listComments: () => {}
           }
         }
       }

diff --git a/badges/coverage.svg b/badges/coverage.svg
diff --git a/dist/index.js b/dist/index.js
diff --git a/src/main.ts b/src/main.ts
@@ -180,6 +180,7 @@ async function applyLabel(
   config: Configuration
 ): Promise<void> {
   const octokit = github.getOctokit(core.getInput('token'))
+
   const labelPrefix = configOrDefault(
     config.labeling?.categoryLabelPrefix,
     DEFAULT_LABEL_PREFIX
@@ -188,7 +189,15 @@ async function applyLabel(
   const labelsToAdd = [newLabelName]
   const labelsToRemove = []
 
-  for (const existingLabel of pull.labels) {
+  const existingLabels = await octokit.paginate(
+    octokit.rest.issues.listLabelsOnIssue,
+    {
+      owner: pull.base.repo.owner.login,
+      repo: pull.base.repo.name,
+      issue_number: pull.number
+    }
+  )
+  for (const existingLabel of existingLabels) {
     if (existingLabel.name === newLabelName) {
       labelsToAdd.pop()
     } else if (existingLabel.name.startsWith(labelPrefix)) {