Merge pull request #293 from hossain-khan/feature/292-use-botuser

[UPDATE] Use bot user to ignore PR author

Author: hossain-khan

src/main/kotlin/dev/hossain/githubstats/repository/PullRequestStatsRepoImpl.kt

@@ -51,6 +51,14 @@ class PullRequestStatsRepoImpl(
             return StatsResult.Failure(IllegalStateException("PR has not been merged, no reason to analyze PR stats."))
         }
 
+        if (pullRequest.user.login in botUserIds) {
+            // Skips PR stats generation if PR is created by bot user.
+            Log.i("The PR#${pullRequest.number} is created by bot user '${pullRequest.user.login}'. Skipping PR stat analysis.")
+            return StatsResult.Failure(
+                IllegalStateException("PR has been created by bot user '${pullRequest.user.login}', no reason to analyze PR stats."),
+            )
+        }
+
         // API request to get all timeline events for the PR
         val prTimelineEvents = timelinesPager.getAllTimelineEvents(repoOwner, repoId, prNumber)
         // API request to get all PR source code review comments associated with diffs
@@ -61,14 +69,20 @@ class PullRequestStatsRepoImpl(
         val prAvailableForReviewOn: Instant = prAvailableForReviewTime(pullRequest.prCreatedOn, prTimelineEvents)
 
         // List of users who has been requested as reviewer or reviewed the PR
+        val nonFilteredPrReviewerUsers = prReviewers(pullRequest.user, prTimelineEvents)
         val prReviewers: Set<User> =
-            prReviewers(pullRequest.user, prTimelineEvents)
+            nonFilteredPrReviewerUsers
                 // Filters out the bot users from the reviewers
                 .filter { it.login !in botUserIds }.toSet()
 
         if (prReviewers.isEmpty()) {
             Log.w("No human reviewers found for PR#${pullRequest.number}. Skipping PR stat analysis.")
-            return StatsResult.Failure(IllegalStateException("No human reviewers found for PR#${pullRequest.number}."))
+            return StatsResult.Failure(
+                IllegalStateException(
+                    "No human reviewers found for PR#${pullRequest.number}. " +
+                        "Original reviewers: ${nonFilteredPrReviewerUsers.map { it.login }}.",
+                ),
+            )
         }
 
         // Builds a map of [Reviewer User -> Initial response time by either commenting, reviewing or approving PR]

src/test/kotlin/dev/hossain/githubstats/PullRequestStatsRepoTest.kt

@@ -158,7 +158,7 @@ internal class PullRequestStatsRepoTest {
         }
 
     @Test
-    fun `stats - given merged with bot user as reviewer - provides no related metrics`() =
+    fun `stats - given merged with bot user as reviewer - provides failure status`() =
         runTest {
             // Uses data from https://github.com/hossain-khan/github-stats/pull/27
             mockWebServer.enqueue(MockResponse().setBody(respond("pulls-githubstats-27.json")))
@@ -170,6 +170,19 @@ internal class PullRequestStatsRepoTest {
             assertThat(calculateStats).isInstanceOf(StatsResult.Failure::class.java)
         }
 
+    @Test
+    fun `stats - given pr created by ignored bot user - provides failure status`() =
+        runTest {
+            // Uses data from https://github.com/jquery/jquery/pull/5046
+            mockWebServer.enqueue(MockResponse().setBody(respond("pulls-jquery-5046-bot-user.json")))
+            mockWebServer.enqueue(MockResponse().setBody(respond("timeline-jquery-5046.json")))
+            mockWebServer.enqueue(MockResponse().setBody("[]")) // PR Review comments
+
+            val calculateStats = pullRequestStatsRepo.stats(REPO_OWNER, REPO_ID, 123, listOf("BotUser"))
+
+            assertThat(calculateStats).isInstanceOf(StatsResult.Failure::class.java)
+        }
+
     @Test
     fun `stats - given pr was draft - provides time taken after pr was ready for review`() =
         runTest {