Add retries

README.md

@@ -116,6 +116,7 @@ jobs:
   _See [Creating a PAT and adding it to your repository](#creating-a-pat-and-adding-it-to-your-repository) for more details_
 - <a name="labeled">`labeled`</a> **(optional)** is a comma-separated list of labels used to filter applicable issues. When this key is provided, an issue must have _one_ of the labels in the list to be added to the project. Omitting this key means that any issue will be added.
 - <a name="labeled">`label-operator`</a> **(optional)** is the behavior of the labels filter, either `AND`, `OR` or `NOT` that controls if the issue should be matched with `all` `labeled` input or any of them, default is `OR`.
+- <a name="retry-limit">`retry-limit`</a> **(optional)** is the number of retries done to add an item to a board, default is 0.
 
 ## Supported Events
 

__tests__/add-to-project.test.ts

@@ -1,7 +1,7 @@
 import * as core from '@actions/core'
 import * as github from '@actions/github'
 
-import {addToProject, mustGetOwnerTypeQuery} from '../src/add-to-project'
+import {addToProject, mustGetOwnerTypeQuery, withRetries} from '../src/add-to-project'
 
 describe('addToProject', () => {
   let outputs: Record<string, string>
@@ -800,6 +800,29 @@ describe('mustGetOwnerTypeQuery', () => {
   })
 })
 
+describe('withRetries', () => {
+  test('should succeed on successful callback', async () => {
+    withRetries(0, 0, () => {
+      return Promise.resolve('some string')
+    }).then(data => {
+      expect(data).toBe('some string')
+    })
+  })
+
+  test('should fail when reaching retry limit', async () => {
+    let invocations = 0
+
+    expect(() =>
+      withRetries(0, 3, () => {
+        invocations = invocations + 1
+        throw new Error('some error')
+      }),
+    ).toThrow('some error')
+
+    expect(invocations).toEqual(4)
+  })
+})
+
 function mockGetInput(mocks: Record<string, string>): jest.SpyInstance {
   const mock = (key: string) => mocks[key] ?? ''
   return jest.spyOn(core, 'getInput').mockImplementation(mock)

action.yml

@@ -17,6 +17,9 @@ inputs:
   label-operator:
     required: false
     description: The behavior of the labels filter, AND to match all labels, OR to match any label, NOT to exclude any listed label (default is OR)
+  retry-limit:
+    required: false
+    description: The number of retries used to add an item to a project (default is 0)
 outputs:
   itemId:
     description: The ID of the item that was added to the project

src/add-to-project.ts

@@ -43,6 +43,8 @@ export async function addToProject(): Promise<void> {
       .map(l => l.trim().toLowerCase())
       .filter(l => l.length > 0) ?? []
   const labelOperator = core.getInput('label-operator').trim().toLocaleLowerCase()
+  const inputRetryLimit = core.getInput('retry-limit')
+  const retryLimit = inputRetryLimit ? Number(inputRetryLimit) : 0
 
   const octokit = github.getOctokit(ghToken)
 
@@ -117,47 +119,60 @@ export async function addToProject(): Promise<void> {
   if (issueOwnerName === projectOwnerName) {
     core.info('Creating project item')
 
-    const addResp = await octokit.graphql<ProjectAddItemResponse>(
-      `mutation addIssueToProject($input: AddProjectV2ItemByIdInput!) {
-        addProjectV2ItemById(input: $input) {
-          item {
-            id
+    const addResp = await withRetries(0, retryLimit, () =>
+      octokit.graphql<ProjectAddItemResponse>(
+        `mutation addIssueToProject($input: AddProjectV2ItemByIdInput!) {
+          addProjectV2ItemById(input: $input) {
+            item {
+              id
+            }
           }
-        }
-      }`,
-      {
-        input: {
-          projectId,
-          contentId,
+        }`,
+        {
+          input: {
+            projectId,
+            contentId,
+          },
         },
-      },
+      ),
     )
 
     core.setOutput('itemId', addResp.addProjectV2ItemById.item.id)
   } else {
     core.info('Creating draft issue in project')
 
-    const addResp = await octokit.graphql<ProjectV2AddDraftIssueResponse>(
-      `mutation addDraftIssueToProject($projectId: ID!, $title: String!) {
-        addProjectV2DraftIssue(input: {
-          projectId: $projectId,
-          title: $title
-        }) {
-          projectItem {
-            id
+    const addResp = await withRetries(0, retryLimit, () =>
+      octokit.graphql<ProjectV2AddDraftIssueResponse>(
+        `mutation addDraftIssueToProject($projectId: ID!, $title: String!) {
+          addProjectV2DraftIssue(input: {
+            projectId: $projectId,
+            title: $title
+          }) {
+            projectItem {
+              id
+            }
           }
-        }
-      }`,
-      {
-        projectId,
-        title: issue?.html_url,
-      },
+        }`,
+        {
+          projectId,
+          title: issue?.html_url,
+        },
+      ),
     )
 
     core.setOutput('itemId', addResp.addProjectV2DraftIssue.projectItem.id)
   }
 }
 
+export function withRetries<T>(retryNumber: number, retryLimit: number, callback: () => Promise<T>): Promise<T> {
+  try {
+    return callback()
+  } catch (err) {
+    if (retryNumber < retryLimit) return withRetries(retryNumber + 1, retryLimit, callback)
+    else throw err
+  }
+}
+
 export function mustGetOwnerTypeQuery(ownerType?: string): 'organization' | 'user' {
   const ownerTypeQuery = ownerType === 'orgs' ? 'organization' : ownerType === 'users' ? 'user' : null