Merge pull request #200 from hossain-khan/feature/51-use-initial-time-in-reports-and-csv

[ADDED] #51 Initial response time in the CSV and HTML report

Author: hossain-khan

src/main/kotlin/dev/hossain/githubstats/PrAuthorStatsService.kt

@@ -30,12 +30,12 @@ class PrAuthorStatsService constructor(
      *
      * For example, assume 'Bob' is a contributor on a specific repo called 'Awesome Json Library'.
      * This will be generated PR reviews for all the PRs 'Bob' has created and will be grouped by
-     * all the PR authors like 'Sally', 'Mike', 'Jim' and so on.
+     * all the PR reviewers like 'Sally', 'Mike', 'Jim' and so on.
      *
      * ```
-     * Sally -> 78 PRs reviewed; Average Review Time: 2 hours 8 min
-     * Mike -> 42 PRs reviewed; Average Review Time: 8 hours 32 min
-     * Jim -> 13 PRs reviewed; Average Review Time: 14 hours 21 min
+     * Sally -> 78 PRs reviewed for Bob; Average Review Time: 2 hours 8 min
+     * Mike -> 42 PRs reviewed for Bob; Average Review Time: 8 hours 32 min
+     * Jim -> 13 PRs reviewed for Bob; Average Review Time: 14 hours 21 min
      * ```
      */
     suspend fun authorStats(
@@ -73,7 +73,7 @@ class PrAuthorStatsService constructor(
                     )
                 } catch (e: Exception) {
                     val error = errorProcessor.getDetailedError(e)
-                    println("Error getting PR#${pr.number}. Got: ${error.message}")
+                    Log.w("Error getting PR#${pr.number}. Got: ${error.message}")
                     StatsResult.Failure(error)
                 }
             }
@@ -88,18 +88,20 @@ class PrAuthorStatsService constructor(
         val userReviews = mutableMapOf<UserId, List<ReviewStats>>()
         prStatsList.filter { it.prApprovalTime.isNotEmpty() }
             .forEach { stats: PrStats ->
-                stats.prApprovalTime.forEach { (user, time) ->
+                stats.prApprovalTime.forEach { (userId, time) ->
                     val reviewStats = ReviewStats(
+                        reviewerUserId = userId,
                         pullRequest = stats.pullRequest,
                         reviewCompletion = time,
-                        prComments = stats.comments[user] ?: noComments(user),
+                        initialResponseTime = stats.initialResponseTime[userId] ?: time,
+                        prComments = stats.comments[userId] ?: noComments(userId),
                         prReadyOn = stats.prReadyOn,
                         prMergedOn = stats.prMergedOn
                     )
-                    if (userReviews.containsKey(user)) {
-                        userReviews[user] = userReviews[user]!!.plus(reviewStats)
+                    if (userReviews.containsKey(userId)) {
+                        userReviews[userId] = userReviews[userId]!!.plus(reviewStats)
                     } else {
-                        userReviews[user] = listOf(reviewStats)
+                        userReviews[userId] = listOf(reviewStats)
                     }
                 }
             }

src/main/kotlin/dev/hossain/githubstats/PrReviewerStatsService.kt

@@ -78,9 +78,12 @@ class PrReviewerStatsService constructor(
                 it.prApprovalTime.containsKey(prReviewerUserId)
             }
             .map { stats ->
+                val prApprovalTime = stats.prApprovalTime[prReviewerUserId]!!
                 ReviewStats(
+                    reviewerUserId = prReviewerUserId,
                     pullRequest = stats.pullRequest,
-                    reviewCompletion = stats.prApprovalTime[prReviewerUserId]!!,
+                    reviewCompletion = prApprovalTime,
+                    initialResponseTime = stats.initialResponseTime[prReviewerUserId] ?: prApprovalTime,
                     prComments = stats.comments[prReviewerUserId] ?: noComments(prReviewerUserId),
                     prReadyOn = stats.prReadyOn,
                     prMergedOn = stats.prMergedOn

src/main/kotlin/dev/hossain/githubstats/ReviewStats.kt

@@ -50,7 +50,11 @@ data class PrStats(
 /**
  * PR review stats for a specific author.
  */
-data class ReviewStats(
+data class ReviewStats constructor(
+    /**
+     * User who has reviewer the PR.
+     */
+    val reviewerUserId: UserId,
     /**
      * The PR information including PR number and URL.
      */
@@ -61,6 +65,12 @@ data class ReviewStats(
      */
     val reviewCompletion: Duration,
 
+    /**
+     * The initial response time indicates the time it took for reviewer to first respond to PR
+     * by either commenting, reviewing or approving the PR.
+     */
+    val initialResponseTime: Duration,
+
     /**
      * Contains PR issue comment and review comment count by a specific user.
      */

src/main/kotlin/dev/hossain/githubstats/formatter/CsvFormatter.kt

@@ -4,9 +4,11 @@ import com.github.doyaaaaaken.kotlincsv.dsl.csvWriter
 import dev.hossain.ascii.Art
 import dev.hossain.githubstats.AuthorReviewStats
 import dev.hossain.githubstats.PrStats
+import dev.hossain.githubstats.ReviewStats
 import dev.hossain.githubstats.ReviewerReviewStats
 import dev.hossain.githubstats.util.FileUtil
 import dev.hossain.githubstats.util.LocalProperties
+import dev.hossain.time.toWorkingHour
 import org.koin.core.component.KoinComponent
 import org.koin.core.component.inject
 import kotlin.time.DurationUnit
@@ -50,6 +52,7 @@ class CsvFormatter : StatsFormatter, KoinComponent {
                 "Reviewer",
                 "PR Number",
                 "Review time (mins)",
+                "Initial Response time (mins)",
                 "Code Review Comments",
                 "PR Issue Comments",
                 "PR Review Comments",
@@ -65,6 +68,7 @@ class CsvFormatter : StatsFormatter, KoinComponent {
                         stat.reviewerId, /* "Reviewer" */
                         "PR ${reviewStats.pullRequest.number}", /* "PR Number" */
                         "${reviewStats.reviewCompletion.toInt(DurationUnit.MINUTES)}", /* "Review time (mins)" */
+                        "${reviewStats.initialResponseTime.toInt(DurationUnit.MINUTES)}", /* "Initial Response time (mins)" */
                         "${reviewStats.prComments.codeReviewComment}", /* "Code Review Comments" */
                         "${reviewStats.prComments.issueComment}", /* "PR Issue Comments" */
                         "${reviewStats.prComments.prReviewComment}", /* "PR Review Comments" */
@@ -126,7 +130,10 @@ class CsvFormatter : StatsFormatter, KoinComponent {
                 listOf(
                     "PR#",
                     "Review Time",
+                    "Review Time (working days)",
                     "Review Time (mins)",
+                    "Initial Response Time (working days)",
+                    "Initial Response Time (mins)",
                     "Code Review Comments",
                     "PR Issue Comments",
                     "PR Review Comments",
@@ -138,11 +145,14 @@ class CsvFormatter : StatsFormatter, KoinComponent {
                     "PR URL"
                 )
             )
-            stats.reviewedPrStats.forEach { reviewStats ->
+            stats.reviewedPrStats.forEach { reviewStats: ReviewStats ->
                 writeRow(
                     reviewStats.pullRequest.number,
                     reviewStats.reviewCompletion,
+                    reviewStats.reviewCompletion.toWorkingHour(),
                     reviewStats.reviewCompletion.toInt(DurationUnit.MINUTES),
+                    reviewStats.initialResponseTime.toWorkingHour(),
+                    reviewStats.initialResponseTime.toInt(DurationUnit.MINUTES),
                     reviewStats.prComments.codeReviewComment,
                     reviewStats.prComments.issueComment,
                     reviewStats.prComments.prReviewComment,

src/main/kotlin/dev/hossain/githubstats/formatter/HtmlChartFormatter.kt

@@ -93,7 +93,7 @@ class HtmlChartFormatter : StatsFormatter, KoinComponent {
             "[" +
                 "'Reviewed For different PR Authors', " +
                 "'Total PRs Reviewed by ${stats.reviewerId} since ${appConfig.get().dateLimitAfter}', " +
-                "'Total Code Review Comments', " +
+                "'Total Source Code Review Comments', " +
                 "'Total PR Issue Comments', " +
                 "'Total PR Review Comments', " +
                 "'Total All Comments Made'" +
@@ -136,13 +136,15 @@ class HtmlChartFormatter : StatsFormatter, KoinComponent {
             "" +
                 "[" +
                 "'PR#', " +
+                "'Initial Response Time (mins)'," +
                 "'Review Time (mins)'" +
                 "]"
         ).plus(
             stats.reviewedPrStats.map { reviewStats ->
                 "" +
                     "[" +
                     "'PR# ${reviewStats.pullRequest.number}', " +
+                    "${reviewStats.initialResponseTime.toInt(DurationUnit.MINUTES)}," +
                     "${reviewStats.reviewCompletion.toInt(DurationUnit.MINUTES)}" +
                     "]"
             }

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

@@ -198,7 +198,7 @@ class PullRequestStatsRepoImpl(
                 endInstant = firstReviewedEvent.submitted_at.toInstant(),
                 timeZoneId = userTimeZone.get(prReviewerUserId)
             )
-            Log.i("  -- First Responded[${firstReviewedEvent.state.name.lowercase()}] in `$reviewTimeInWorkingHours` by `$prReviewerUserId`.")
+            Log.d("  -- First Responded[${firstReviewedEvent.state.name.lowercase()}] in `$reviewTimeInWorkingHours` by `$prReviewerUserId`.")
             Log.v(
                 "     -- 🔍👀 Initial response event: $firstReviewedEvent. PR available on ${prAvailableForReviewOn.format()} " +
                     "and event on ${firstReviewedEvent.submitted_at.toInstant().format()}"