feat: allow nth as a config input (#164)

* refactor: remove dup implementation for first/last * remove `;` for linter * feat: add `nth` input config --------- Co-authored-by: Peter Evans <[email protected]>
peter-evans · Apr 25, 2023 · e3ce6a8 · e3ce6a8
1 parent 4809031
commit e3ce6a8
Show file tree

Hide file tree

Showing 4 changed files with 40 additions and 19 deletions.
diff --git a/README.md b/README.md
@@ -76,6 +76,7 @@ The action will output the comment ID of the comment matching the search criteri
 | `body-includes` | A string to search for in the body of comments. | |
 | `body-regex` | A regular expression to search for in the body of comments. | |
 | `direction` | Search direction, specified as `first` or `last` | `first` |
+| `nth` | 0-indexed number, specifying which comment to return if multiple are found | 0 |
 
 #### Outputs
 

diff --git a/__test__/find.unit.test.ts b/__test__/find.unit.test.ts
@@ -11,7 +11,8 @@ describe('find comment tests', () => {
           commentAuthor: '',
           bodyIncludes: 'Kansas',
           bodyRegex: '',
-          direction: 'direction'
+          direction: 'direction',
+          nth: 0
         },
         {
           id: 1,
@@ -31,7 +32,8 @@ describe('find comment tests', () => {
           commentAuthor: '',
           bodyIncludes: 'not-exist',
           bodyRegex: '',
-          direction: 'direction'
+          direction: 'direction',
+          nth: 0
         },
         {
           id: 1,
@@ -53,7 +55,8 @@ describe('find comment tests', () => {
           commentAuthor: '',
           bodyIncludes: '',
           bodyRegex: '^.*Kansas.*$',
-          direction: 'direction'
+          direction: 'direction',
+          nth: 0
         },
         {
           id: 1,
@@ -73,7 +76,8 @@ describe('find comment tests', () => {
           commentAuthor: '',
           bodyIncludes: '',
           bodyRegex: '^.*not-exist.*$',
-          direction: 'direction'
+          direction: 'direction',
+          nth: 0
         },
         {
           id: 1,
@@ -95,7 +99,8 @@ describe('find comment tests', () => {
           commentAuthor: 'dorothy',
           bodyIncludes: '',
           bodyRegex: '',
-          direction: 'direction'
+          direction: 'direction',
+          nth: 0
         },
         {
           id: 1,
@@ -115,7 +120,8 @@ describe('find comment tests', () => {
           commentAuthor: 'toto',
           bodyIncludes: '',
           bodyRegex: '',
-          direction: 'direction'
+          direction: 'direction',
+          nth: 0
         },
         {
           id: 1,
@@ -137,7 +143,8 @@ describe('find comment tests', () => {
           commentAuthor: 'dorothy',
           bodyIncludes: 'Kansas',
           bodyRegex: '',
-          direction: 'direction'
+          direction: 'direction',
+          nth: 0
         },
         {
           id: 1,
@@ -157,7 +164,8 @@ describe('find comment tests', () => {
           commentAuthor: 'dorothy',
           bodyIncludes: 'not-exist',
           bodyRegex: '',
-          direction: 'direction'
+          direction: 'direction',
+          nth: 0
         },
         {
           id: 1,
@@ -177,7 +185,8 @@ describe('find comment tests', () => {
           commentAuthor: 'toto',
           bodyIncludes: 'Kansas',
           bodyRegex: '',
-          direction: 'direction'
+          direction: 'direction',
+          nth: 0
         },
         {
           id: 1,
@@ -199,7 +208,8 @@ describe('find comment tests', () => {
           commentAuthor: 'dorothy',
           bodyIncludes: '',
           bodyRegex: '^.*Kansas.*$',
-          direction: 'direction'
+          direction: 'direction',
+          nth: 0
         },
         {
           id: 1,
@@ -219,7 +229,8 @@ describe('find comment tests', () => {
           commentAuthor: 'dorothy',
           bodyIncludes: '',
           bodyRegex: '/^.*KaNsAs.*$/i',
-          direction: 'direction'
+          direction: 'direction',
+          nth: 0
         },
         {
           id: 1,
@@ -239,7 +250,8 @@ describe('find comment tests', () => {
           commentAuthor: 'dorothy',
           bodyIncludes: '',
           bodyRegex: '^.*not-exist.*$',
-          direction: 'direction'
+          direction: 'direction',
+          nth: 0
         },
         {
           id: 1,
@@ -259,7 +271,8 @@ describe('find comment tests', () => {
           commentAuthor: 'toto',
           bodyIncludes: '',
           bodyRegex: '^.*Kansas.*$',
-          direction: 'direction'
+          direction: 'direction',
+          nth: 0
         },
         {
           id: 1,
@@ -281,7 +294,8 @@ describe('find comment tests', () => {
           commentAuthor: 'dorothy',
           bodyIncludes: 'feeling',
           bodyRegex: '^.*Kansas.*$',
-          direction: 'direction'
+          direction: 'direction',
+          nth: 0
         },
         {
           id: 1,

diff --git a/src/find.ts b/src/find.ts
@@ -8,6 +8,7 @@ export interface Inputs {
   bodyIncludes: string
   bodyRegex: string
   direction: string
+  nth: number
 }
 
 export interface Comment {
@@ -54,17 +55,21 @@ export async function findComment(
     issue_number: inputs.issueNumber
   }
 
-  const comments = await octokit.paginate(
+  const allComments = await octokit.paginate(
     octokit.rest.issues.listComments,
     parameters
   )
   if (inputs.direction == 'last') {
-    comments.reverse()
+    allComments.reverse()
   }
-  const comment = comments.find(comment =>
+  const matchingComments = allComments.filter(comment =>
     findCommentPredicate(inputs, comment)
   )
-  if (comment) return comment
+
+  const comment = matchingComments[inputs.nth]
+  if (comment) {
+    return comment
+  }
 
   return undefined
 }
diff --git a/src/main.ts b/src/main.ts
@@ -16,7 +16,8 @@ async function run(): Promise<void> {
       commentAuthor: core.getInput('comment-author'),
       bodyIncludes: core.getInput('body-includes'),
       bodyRegex: core.getInput('body-regex'),
-      direction: core.getInput('direction')
+      direction: core.getInput('direction'),
+      nth: Number(core.getInput('nth'))
     }
     core.debug(`Inputs: ${inspect(inputs)}`)