Feature: time to response (#41)

* Feature: Add types for time to response

* Feature: Time to response

* Feature: fixed linter

* Feature: fixed readme

* Feature: returned old review requests

SECURITY.md

@@ -6,6 +6,7 @@ Use this section to tell users about which versions of your project are currentl
 
 | Version | Supported          |
 | ------- | ------------------ |
+| 3.x.x   | :white_check_mark: |
 | 2.x.x   | :white_check_mark: |
 | < 1.x   | :x:                |
 

action.yml

@@ -21,9 +21,9 @@ inputs:
     description: "Github organizations separated by comma"
     required: false
   SHOW_STATS_TYPES:
-    description: "Stats types that should be displayed in report. Values must be separated by comma. Can take values: 'timeline', 'workload', 'pr-quality', 'code-review-engagement'"
+    description: "Stats types that should be displayed in report. Values must be separated by comma. Can take values: 'timeline', 'workload', 'pr-quality', 'code-review-engagement', 'response-time'"
     required: false
-    default: "timeline, workload, pr-quality, code-review-engagement"
+    default: "timeline, workload, pr-quality, code-review-engagement, response-time"
   AMOUNT:
     description: "Amount of PRs"
     required: false

package.json

@@ -1,13 +1,13 @@
 {
   "name": "pull-request-analytics-action",
-  "version": "2.2.10",
+  "version": "3.0.0",
   "description": "Generates detailed PR analytics reports within GitHub, focusing on review efficiency and team performance.",
   "main": "build/index.js",
   "scripts": {
     "start": "node ./build/index.js",
     "build": "tsc && ncc build ./dist/index.js -o build",
     "tsc": "tsc",
-    "lint": "eslint ./src",
+    "lint": "eslint ./src/**/*.ts",
     "test": "TZ=utc jest",
     "test:watch": "TZ=utc jest --watch",
     "prepare": "husky install"

src/common/utils/validate.ts

@@ -27,6 +27,7 @@ export const validate = () => {
           "workload",
           "pr-quality",
           "code-review-engagement",
+          "response-time",
         ],
         required: true,
       },
@@ -35,12 +36,7 @@ export const validate = () => {
         required: false,
       },
       EXECUTION_OUTCOME: {
-        validValues: [
-          "new-issue",
-          "collection",
-          "markdown",
-          "existing-issue",
-        ],
+        validValues: ["new-issue", "collection", "markdown", "existing-issue"],
         required: true,
       },
     });

src/converters/collectData.ts

@@ -7,6 +7,7 @@ import {
   preparePullRequestInfo,
   preparePullRequestStats,
   preparePullRequestTimeline,
+  prepareResponseTime,
   prepareRequestedReviews,
 } from "./utils";
 import {
@@ -55,7 +56,6 @@ export const collectData = (
     if (!collection[userKey]) {
       collection[userKey] = {};
     }
-
     prepareRequestedReviews(reviewRequests, collection, dateKey);
 
     ["total", userKey].forEach((key) => {
@@ -81,6 +81,12 @@ export const collectData = (
       userKey,
       getPullRequestSize(pullRequest?.additions, pullRequest?.deletions)
     );
+    prepareResponseTime(
+      data.events[index],
+      pullRequest,
+      collection,
+      dateKey
+    );
     prepareDiscussions(data.comments, collection, index, dateKey, userKey);
   });
 
@@ -89,5 +95,6 @@ export const collectData = (
       collection[key][innerKey] = preparePullRequestStats(innerValue);
     });
   });
+
   return collection;
 };

src/converters/constants.ts

@@ -5,3 +5,4 @@ export const reviewRequestedTimelineEvent = "review_requested";
 export const readyForReviewTimelineEvent = "ready_for_review";
 export const convertToDraftTimelineEvent = "convert_to_draft";
 export const reviewedTimelineEvent = "reviewed";
+export const reviewRequestRemoved = "review_request_removed";

src/converters/types.ts

@@ -10,6 +10,9 @@ type TimelinePoints = {
   timeToReview?: number;
   timeToApprove?: number;
   timeToMerge?: number;
+  timeFromInitialRequestToResponse?: number;
+  timeFromOpenToResponse?: number;
+  timeFromRepeatedRequestToResponse?: number;
 };
 
 type DiscussionResult = {
@@ -58,6 +61,11 @@ export type Collection = {
   timeToReview?: number[];
   timeToApprove?: number[];
   timeToMerge?: number[];
+  timeFromOpenToResponse?: number[];
+  timeFromInitialRequestToResponse?: number[];
+  timeFromRepeatedRequestToResponse?: number[];
+  timeReviewerInDraft?: number[];
+  unrespondedRequests?: number;
   comments?: number;
   totalReviewComments?: number;
   reviewComments?: number;

src/converters/utils/calculations/getResponses.ts

@@ -0,0 +1,42 @@
+import {
+  invalidUserLogin,
+  reviewRequestRemoved,
+  reviewRequestedTimelineEvent,
+  reviewedTimelineEvent,
+} from "../../constants";
+
+export const getResponses = (events: any[] | undefined | null = []) => {
+  return events?.reduce((acc, event) => {
+    if (event.event === reviewRequestedTimelineEvent) {
+      const user = event.requested_reviewer?.login || invalidUserLogin;
+      return {
+        ...acc,
+        [user]: [...(acc?.[user] || []), [(event as any)?.created_at]],
+      };
+    }
+    if (event.event === reviewedTimelineEvent) {
+      const user = event.user?.login || invalidUserLogin;
+      return {
+        ...acc,
+        [user]: acc[user]?.map((el: any, index: number, arr: any[]) =>
+          index === arr.length - 1 && el.length < 2
+            ? [el[0], event.submitted_at]
+            : el
+        ) || [[null, event.submitted_at]],
+      };
+    }
+    if (event.event === reviewRequestRemoved) {
+      const user = event.requested_reviewer?.login || invalidUserLogin;
+      return {
+        ...acc,
+        [user]: acc[user].map(
+          (el: [string | undefined | null, string | undefined | null]) => [
+            el[0],
+            null,
+          ]
+        ),
+      };
+    }
+    return acc;
+  }, {});
+};

src/converters/utils/calculations/index.ts

@@ -1,5 +1,5 @@
-export { prepareIntervals } from './prepareIntervals';
-export { calcIntervals } from './calcIntervals';
+export { prepareIntervals } from "./prepareIntervals";
+export { calcIntervals } from "./calcIntervals";
 export { calcPercentileValue } from "./calcPercentileValue";
 export { getApproveTime } from "./getApproveTime";
 export { calcWeekendMinutes } from "./calcWeekendMinutes";
@@ -9,3 +9,4 @@ export { calcDifferenceInMinutes } from "./calcDifferenceInMinutes";
 export { calcAverageValue } from "./calcAverageValue";
 export { getPullRequestSize } from "./getPullRequestSize";
 export { calcDraftTime } from "./calcDraftTime";
+export { getResponses } from "./getResponses";

src/converters/utils/index.ts

@@ -1,6 +1,7 @@
-export { prepareRequestedReviews } from './prepareRequestedReviews';
 export { preparePullRequestTimeline } from "./preparePullRequestTimeline";
 export { preparePullRequestStats } from "./preparePullRequestStats";
 export { preparePullRequestInfo } from "./preparePullRequestInfo";
 export { prepareDiscussions } from "./prepareDiscussions";
 export { prepareReviews } from "./prepareReviews";
+export { prepareResponseTime } from "./prepareResponseTime";
+export { prepareRequestedReviews } from "./prepareRequestedReviews";

src/converters/utils/preparePullRequestStats.ts

@@ -40,20 +40,47 @@ export const preparePullRequestStats = (collection: Collection) => {
       timeToMerge: calcMedianValue(collection.timeToMerge),
       timeToReviewRequest: calcMedianValue(collection.timeToReviewRequest),
       timeInDraft: calcMedianValue(collection.timeInDraft),
+      timeFromInitialRequestToResponse: calcMedianValue(
+        collection.timeFromInitialRequestToResponse
+      ),
+      timeFromOpenToResponse: calcMedianValue(
+        collection.timeFromOpenToResponse
+      ),
+      timeFromRepeatedRequestToResponse: calcMedianValue(
+        collection.timeFromRepeatedRequestToResponse
+      ),
     },
     percentile: {
       timeToReview: calcPercentileValue(collection.timeToReview),
       timeToApprove: calcPercentileValue(collection.timeToApprove),
       timeToMerge: calcPercentileValue(collection.timeToMerge),
       timeToReviewRequest: calcPercentileValue(collection.timeToReviewRequest),
       timeInDraft: calcPercentileValue(collection.timeInDraft),
+      timeFromInitialRequestToResponse: calcPercentileValue(
+        collection.timeFromInitialRequestToResponse
+      ),
+      timeFromOpenToResponse: calcPercentileValue(
+        collection.timeFromOpenToResponse
+      ),
+      timeFromRepeatedRequestToResponse: calcPercentileValue(
+        collection.timeFromRepeatedRequestToResponse
+      ),
     },
     average: {
       timeToReview: calcAverageValue(collection.timeToReview),
       timeToApprove: calcAverageValue(collection.timeToApprove),
       timeToMerge: calcAverageValue(collection.timeToMerge),
       timeToReviewRequest: calcAverageValue(collection.timeToReviewRequest),
       timeInDraft: calcAverageValue(collection.timeInDraft),
+      timeFromInitialRequestToResponse: calcAverageValue(
+        collection.timeFromInitialRequestToResponse
+      ),
+      timeFromOpenToResponse: calcAverageValue(
+        collection.timeFromOpenToResponse
+      ),
+      timeFromRepeatedRequestToResponse: calcAverageValue(
+        collection.timeFromRepeatedRequestToResponse
+      ),
     },
   };
 };

src/converters/utils/prepareRequestedReviews.ts

@@ -27,4 +27,4 @@ export const prepareRequestedReviews = (
       };
     });
   });
-};
+};

src/converters/utils/prepareResponseTime.ts

@@ -0,0 +1,105 @@
+import { getMultipleValuesInput, getValueAsIs } from "../../common/utils";
+import { makeComplexRequest } from "../../requests";
+import { Collection } from "../types";
+import { calcDifferenceInMinutes, getResponses } from "./calculations";
+
+export const prepareResponseTime = (
+  events: any[] | undefined | null = [],
+  pullRequest: Awaited<
+    ReturnType<typeof makeComplexRequest>
+  >["pullRequestInfo"][number],
+  collection: Record<string, Record<string, Collection>>,
+  dateKey: string
+) => {
+  const responses = getResponses(events);
+
+  Object.entries(responses as Record<string, any[][]>).forEach(
+    ([user, responses]) => {
+      ["total", dateKey].forEach((key) => {
+
+        const timeFromInitialRequestToResponse = calcDifferenceInMinutes(
+          responses[0]?.[0],
+          responses[0]?.[1],
+          {
+            endOfWorkingTime: getValueAsIs("CORE_HOURS_END"),
+            startOfWorkingTime: getValueAsIs("CORE_HOURS_START"),
+          },
+          getMultipleValuesInput("HOLIDAYS")
+        );
+
+        const timeFromOpenToResponse = calcDifferenceInMinutes(
+          pullRequest?.created_at,
+          responses[0]?.[1],
+          {
+            endOfWorkingTime: getValueAsIs("CORE_HOURS_END"),
+            startOfWorkingTime: getValueAsIs("CORE_HOURS_START"),
+          },
+          getMultipleValuesInput("HOLIDAYS")
+        );
+
+        const timeFromRepeatedRequestToResponse = responses
+          .filter((el, index) => index > 0)
+          .map((element) =>
+            calcDifferenceInMinutes(
+              element?.[0],
+              element?.[1],
+              {
+                endOfWorkingTime: getValueAsIs("CORE_HOURS_END"),
+                startOfWorkingTime: getValueAsIs("CORE_HOURS_START"),
+              },
+              getMultipleValuesInput("HOLIDAYS")
+            )
+          );
+
+        collection[user][key] = {
+          ...collection[user][key],
+          timeFromInitialRequestToResponse:
+            typeof timeFromInitialRequestToResponse === "number"
+              ? [
+                  ...(collection[user][key].timeFromInitialRequestToResponse ||
+                    []),
+                  timeFromInitialRequestToResponse,
+                ]
+              : collection[user][key].timeFromInitialRequestToResponse,
+          timeFromOpenToResponse:
+            typeof timeFromOpenToResponse === "number"
+              ? [
+                  ...(collection[user][key].timeFromOpenToResponse || []),
+                  timeFromOpenToResponse,
+                ]
+              : collection[user][key].timeFromOpenToResponse,
+          timeFromRepeatedRequestToResponse: [
+            ...(collection[user][key].timeFromRepeatedRequestToResponse || []),
+            ...(timeFromRepeatedRequestToResponse.filter(
+              (el) => typeof el === "number"
+            ) as number[]),
+          ],
+        };
+        collection.total[key] = {
+          ...collection.total[key],
+          timeFromInitialRequestToResponse:
+            typeof timeFromInitialRequestToResponse === "number"
+              ? [
+                  ...(collection.total[key].timeFromInitialRequestToResponse ||
+                    []),
+                  timeFromInitialRequestToResponse,
+                ]
+              : collection.total[key].timeFromInitialRequestToResponse,
+          timeFromOpenToResponse:
+            typeof timeFromOpenToResponse === "number"
+              ? [
+                  ...(collection.total[key].timeFromOpenToResponse || []),
+                  timeFromOpenToResponse,
+                ]
+              : collection.total[key].timeFromOpenToResponse,
+          timeFromRepeatedRequestToResponse: [
+            ...(collection.total[key].timeFromRepeatedRequestToResponse || []),
+            ...(timeFromRepeatedRequestToResponse.filter(
+              (el) => typeof el === "number"
+            ) as number[]),
+          ],
+        };
+      });
+    }
+  );
+};

src/converters/utils/prepareReviews.ts

@@ -1,4 +1,3 @@
-import { makeComplexRequest } from "../../requests";
 import { invalidUserLogin } from "../constants";
 import { Collection } from "../types";
 import { PullRequestSize } from "./calculations/getPullRequestSize";

src/view/createMarkdown.ts

@@ -3,6 +3,7 @@ import {
   createConfigParamsCode,
   createPullRequestQualityTable,
   createReferences,
+  createResponseTable,
   createReviewTable,
   createTimelineContent,
   createTotalTable,
@@ -26,6 +27,7 @@ export const createMarkdown = (
       workload: createTotalTable(data, users, date),
       "code-review-engagement": createReviewTable(data, users, date),
       "pr-quality": createPullRequestQualityTable(data, users, date),
+      "response-time": createResponseTable(data, users, date),
     };
 
     return `

src/view/utils/constants.ts

@@ -18,3 +18,8 @@ export const commentsReceivedHeader = "Comments received";
 export const reviewTypesHeader = "Changes requested / Commented / Approved";
 export const requestChangesReceived = "Changes requested received";
 export const prSizesHeader = "PR size: xs/s/m/l/xl";
+export const timeFromRequestToResponseHeader =
+  "Time from initial request to response";
+export const timeFromOpenToResponseHeader = "Time from opening to response";
+export const timeFromRepeatedRequestToResponseHeader =
+  "Time from re-request to response";