add pagination logic to latestActiveDeployment() to make it more robust

Author: GrantBirki

__tests__/functions/deployment.test.js

@@ -47,7 +47,11 @@ beforeEach(() => {
               oid: '315cec138fc9d7dac8a47c6bba4217d3965ede3b'
             }
           }
-        ]
+        ],
+        pageInfo: {
+          endCursor: null,
+          hasNextPage: false
+        }
       }
     }
   }
@@ -139,6 +143,121 @@ test('returns null if no deployments are found', async () => {
   expect(octokit.graphql).toHaveBeenCalled()
 })
 
+test('returns null if no deployments are found in 3 pages of queries', async () => {
+  octokit.graphql = jest
+    .fn()
+    .mockReturnValueOnce({
+      repository: {
+        deployments: {
+          nodes: [
+            {
+              state: 'INACTIVE'
+            }
+          ],
+          pageInfo: {
+            endCursor: 'cursor',
+            hasNextPage: true
+          }
+        }
+      }
+    })
+    .mockReturnValueOnce({
+      repository: {
+        deployments: {
+          nodes: [
+            {
+              state: 'INACTIVE'
+            }
+          ],
+          pageInfo: {
+            endCursor: 'cursor',
+            hasNextPage: true
+          }
+        }
+      }
+    })
+    .mockReturnValueOnce({
+      repository: {
+        deployments: {
+          nodes: [
+            {
+              state: 'INACTIVE'
+            }
+          ],
+          pageInfo: {
+            endCursor: 'cursor',
+            hasNextPage: false
+          }
+        }
+      }
+    })
+
+  expect(await latestActiveDeployment(octokit, context, environment)).toBeNull()
+
+  expect(octokit.graphql).toHaveBeenCalledTimes(3)
+})
+
+test('returns the deployment when it is found in the second page of queries', async () => {
+  octokit.graphql = jest
+    .fn()
+    .mockReturnValueOnce({
+      repository: {
+        deployments: {
+          nodes: [
+            {
+              state: 'INACTIVE'
+            },
+            {
+              state: 'INACTIVE'
+            },
+            {
+              state: 'INACTIVE'
+            },
+            {
+              state: 'PENDING'
+            }
+          ],
+          pageInfo: {
+            endCursor: 'cursor',
+            hasNextPage: true
+          }
+        }
+      }
+    })
+    .mockReturnValueOnce({
+      repository: {
+        deployments: {
+          nodes: [
+            {
+              state: 'INACTIVE'
+            },
+            {
+              state: 'INACTIVE'
+            },
+            {
+              state: 'ACTIVE'
+            },
+            {
+              state: 'INACTIVE'
+            }
+          ],
+          pageInfo: {
+            endCursor: 'cursor',
+            hasNextPage: true
+          }
+        }
+      }
+    })
+
+  expect(
+    await latestActiveDeployment(octokit, context, environment)
+  ).toStrictEqual({
+    state: 'ACTIVE'
+  })
+
+  expect(octokit.graphql).toHaveBeenCalledTimes(2)
+})
+
 test('returns false if the deployment is not active', async () => {
   mockDeploymentData.repository.deployments.nodes[0].state = 'INACTIVE'
   octokit = createMockGraphQLOctokit(mockDeploymentData)

dist/index.js

@@ -78,13 +78,56 @@ export async function activeDeployment(octokit, context, environment, sha) {
 //   }
 // ]
 export async function latestActiveDeployment(octokit, context, environment) {
-  // Get the owner and the repo from the context
   const {owner, repo} = context.repo
 
-  const query = `
+  const variables = {
+    repo_owner: owner,
+    repo_name: repo,
+    environment: environment
+  }
+
+  let data = await octokit.graphql(buildQuery(), variables)
+  // nodes may be empty if no matching deployments were found - ex: []
+  let nodes = data.repository.deployments.nodes
+
+  // If no deployments were found, return null
+  if (nodes.length === 0) {
+    return null
+  }
+
+  // Check for an active deployment in the first page of deployments
+  let activeDeployment = nodes.find(deployment => deployment.state === 'ACTIVE')
+  if (activeDeployment) {
+    return activeDeployment
+  }
+
+  // Paginate to find the active deployment if it exists
+  let hasNextPage = data.repository.deployments.pageInfo.hasNextPage
+  let endCursor = data.repository.deployments.pageInfo.endCursor
+
+  while (hasNextPage) {
+    data = await octokit.graphql(buildQuery(endCursor), variables)
+
+    nodes = data.repository.deployments.nodes
+    activeDeployment = nodes.find(deployment => deployment.state === 'ACTIVE')
+
+    if (activeDeployment) {
+      return activeDeployment
+    }
+
+    hasNextPage = data.repository.deployments.pageInfo.hasNextPage
+    endCursor = data.repository.deployments.pageInfo.endCursor
+  }
+
+  // If no active deployment was found, return null
+  return null
+}
+
+function buildQuery(page = null) {
+  return `
     query ($repo_owner: String!, $repo_name: String!, $environment: String!) {
       repository(owner: $repo_owner, name: $repo_name) {
-        deployments(environments: [$environment], first: 1, orderBy: { field: CREATED_AT, direction: DESC }) {
+        deployments(environments: [$environment], first: 100, after: ${page}, orderBy: { field: CREATED_AT, direction: DESC }) {
           nodes {
             createdAt
             environment
@@ -102,25 +145,11 @@ export async function latestActiveDeployment(octokit, context, environment) {
               oid
             }
           }
+          pageInfo {
+            endCursor
+            hasNextPage
+          }
         }
       }
     }`
-
-  const variables = {
-    repo_owner: owner,
-    repo_name: repo,
-    environment: environment
-  }
-
-  const data = await octokit.graphql(query, variables)
-  // nodes may be empty if no matching deployments were found - ex: []
-  const nodes = data.repository.deployments.nodes
-
-  // If no deployments were found, return null
-  if (nodes.length === 0) {
-    return null
-  }
-
-  // Otherwise, return the latest deployment
-  return nodes[0]
 }