Differentiate notification reason review_requested from team_review_requested

Closes #204

Author: brunolemos

packages/components/src/components/cards/BaseCard.shared.ts

@@ -35,7 +35,6 @@ import {
   getUserURLFromObject,
   GitHubIcon,
   GitHubIssueOrPullRequest,
-  GitHubNotificationReason,
   GitHubPullRequest,
   GitHubPushEvent,
   isDraft,
@@ -142,7 +141,7 @@ export interface BaseCardProps extends AdditionalCardProps {
   link: string
   nodeIdOrId: string
   reason?: {
-    reason: GitHubNotificationReason
+    reason: EnhancedGitHubNotification['reason']
     color: keyof ThemeColors
     label: string
     tooltip?: string

packages/components/src/redux/actions/columns.ts

@@ -4,10 +4,10 @@ import {
   ColumnOptions,
   ColumnsAndSubscriptions,
   ColumnSubscriptionCreation,
+  EnhancedGitHubNotification,
   GitHubEventAction,
   GitHubEventSubjectType,
   GitHubIssueOrPullRequestSubjectType,
-  GitHubNotificationReason,
   GitHubNotificationSubjectType,
   GitHubStateType,
   NotificationColumnFilters,
@@ -105,7 +105,7 @@ export function setColumnLabelFilter(payload: {
 }
 
 export function setColumnReasonFilter<
-  T extends GitHubNotificationReason
+  T extends EnhancedGitHubNotification['reason']
 >(payload: {
   columnId: string
   reason: T

packages/components/src/redux/migrations.ts

@@ -14,6 +14,7 @@ import {
   isItemRead,
   isItemSaved,
   IssueOrPullRequestColumnSubscription,
+  NotificationColumn,
   removeUselessURLsFromResponseItem,
 } from '@devhub/core'
 import immer from 'immer'
@@ -536,4 +537,28 @@ export default {
       draft.github.installations.lastFetchSuccessAt = (draft.github
         .installations as any).lastFetchedSuccessfullyAt
     }),
+  17: (state: RootState) =>
+    immer(state, draft => {
+      draft.columns = draft.columns || {}
+      draft.columns.byId = draft.columns.byId || {}
+
+      const columnIds = Object.keys(draft.columns.byId)
+      columnIds.forEach(columnId => {
+        const column = draft.columns.byId![columnId] as NotificationColumn
+
+        if (!(column && column.type === 'notifications')) return
+
+        if (
+          column &&
+          column.filters &&
+          column.filters.notifications &&
+          column.filters.notifications.reasons &&
+          typeof column.filters.notifications.reasons.review_requested ===
+            'boolean'
+        ) {
+          column.filters.notifications.reasons.team_review_requested =
+            column.filters.notifications.reasons.review_requested
+        }
+      })
+    }),
 }

packages/components/src/redux/sagas/subscriptions.ts

@@ -425,6 +425,7 @@ function* onFetchRequest(
             repoName: string | undefined,
           ) =>
             selectors.getPrivateTokenByRepoSelector(state, ownerName, repoName),
+          githubLogin: loggedUsername,
           githubToken,
         },
       )

packages/components/src/redux/store.ts

@@ -60,7 +60,7 @@ export function configureStore(key = 'root') {
     },
     storage,
     throttle: 500,
-    version: 16,
+    version: 17,
   }
   const persistedReducer = persistReducer(persistConfig, rootReducer)
 

packages/core/src/helpers/github/notifications.ts

@@ -10,9 +10,9 @@ import {
   GitHubIssueOrPullRequest,
   GitHubLabel,
   GitHubNotification,
-  GitHubNotificationReason,
   GitHubNotificationSubjectType,
   GitHubPullRequest,
+  GitHubUser,
   NotificationPayloadEnhancement,
   ThemeColors,
   UserPlan,
@@ -36,7 +36,9 @@ import {
   getRepoFullNameFromObject,
 } from './url'
 
-export const notificationReasons: GitHubNotificationReason[] = [
+export const notificationReasons: Array<
+  EnhancedGitHubNotification['reason']
+> = [
   'assign',
   'author',
   'comment',
@@ -48,6 +50,7 @@ export const notificationReasons: GitHubNotificationReason[] = [
   'state_change',
   'subscribed',
   'team_mention',
+  'team_review_requested',
 ]
 
 export const notificationSubjectTypes: GitHubNotificationSubjectType[] = [
@@ -60,7 +63,7 @@ export const notificationSubjectTypes: GitHubNotificationSubjectType[] = [
 ]
 
 export function getNotificationSubjectType(
-  notification: GitHubNotification,
+  notification: Pick<GitHubNotification, 'subject'>,
 ): GitHubNotificationSubjectType | null {
   if (!(notification && notification.subject && notification.subject.type))
     return null
@@ -69,7 +72,7 @@ export function getNotificationSubjectType(
 }
 
 export function getNotificationIconAndColor(
-  notification: GitHubNotification,
+  notification: Pick<GitHubNotification, 'subject'>,
   payload: GitHubIssueOrPullRequest | undefined,
 ): { icon: GitHubIcon; color?: keyof ThemeColors; tooltip: string } {
   const { subject } = notification
@@ -105,7 +108,7 @@ export function getNotificationIconAndColor(
 }
 
 export function getNotificationReasonMetadata<
-  T extends GitHubNotificationReason
+  T extends EnhancedGitHubNotification['reason']
 >(
   reason: T,
 ): {
@@ -201,12 +204,22 @@ export function getNotificationReasonMetadata<
     case 'review_requested':
       return {
         reason,
-        color: 'yellow',
+        color: 'orange',
         fullDescription: 'Someone requested your review in the pull request',
         // smallDescription: 'Review requested',
         label: 'Review requested',
       }
 
+    case 'team_review_requested':
+      return {
+        reason,
+        color: 'yellow',
+        fullDescription:
+          "Someone requested your team's review in the pull request",
+        // smallDescription: 'Team review requested',
+        label: 'Team review requested',
+      }
+
     case 'security_alert':
       return {
         reason,
@@ -274,7 +287,9 @@ export function mergeNotificationPreservingEnhancement(
       newItem.last_unsaved_at,
     ]),
     pullRequest: existingItem.pullRequest,
+    reason: existingItem.reason,
     release: existingItem.release,
+    requestedMyReview: existingItem.requestedMyReview,
     updated_at: _.max([existingItem.updated_at, newItem.updated_at])!,
   }
 
@@ -307,15 +322,19 @@ export async function getNotificationsEnhancementMap(
     cache = new Map(),
     getGitHubPrivateTokenForRepo,
     githubToken: _githubToken,
+    githubLogin: _githubLogin,
   }: {
     cache: EnhancementCache | undefined | undefined
     getGitHubPrivateTokenForRepo: (
       owner: string | undefined,
       repo: string | undefined,
     ) => string | undefined
     githubToken: string
+    githubLogin: string
   },
 ): Promise<Record<string, NotificationPayloadEnhancement>> {
+  const githubLogin = `${_githubLogin || ''}`.toLowerCase().trim()
+
   const promises = notifications.map(async notification => {
     if (!(notification.repository && notification.repository.full_name)) return
 
@@ -376,6 +395,30 @@ export async function getNotificationsEnhancementMap(
         if (!enhance.enhanced) enhance.enhanced = false
         return
       }
+
+      // if (
+      //   subjectField === 'pullRequest' &&
+      //   enhance.pullRequest &&
+      //   notification.reason === 'review_requested' &&
+      //   !enhance.requestedMyReview
+      // ) {
+      //   try {
+      //     const { data } = await axios.get(
+      //       `${notification.subject.url}/reviews?access_token=${githubToken}`,
+      //     )
+
+      //     if (data && data.length) {
+      //       enhance.requestedMyReview = !!data.find(
+      //         (item: { user?: GitHubUser }) =>
+      //           item &&
+      //           item.user &&
+      //           githubLogin === `${item.user.login || ''}`.toLowerCase().trim(),
+      //       )
+      //     }
+      //   } catch (error) {
+      //     //
+      //   }
+      // }
     } else if (hasSubjectCache) {
       if (subjectCache && subjectCache.data) {
         enhance[subjectField] = subjectCache.data
@@ -413,6 +456,25 @@ export async function getNotificationsEnhancementMap(
       } else if (!enhance.enhanced) enhance.enhanced = false
     }
 
+    if (
+      githubLogin &&
+      enhance.pullRequest &&
+      enhance.pullRequest.requested_reviewers
+    ) {
+      if (!enhance.requestedMyReview) {
+        enhance.requestedMyReview = !!enhance.pullRequest.requested_reviewers.find(
+          u => githubLogin === `${u.login || ''}`.toLowerCase().trim(),
+        )
+      }
+    }
+
+    if (
+      notification.reason === 'review_requested' &&
+      enhance.requestedMyReview === false
+    ) {
+      enhance.reason = 'team_review_requested'
+    }
+
     if (!Object.keys(enhance).length) return
 
     return { id: notification.id, enhance }

packages/core/src/helpers/shared.ts

@@ -189,7 +189,9 @@ export function isEventPrivate(event: EnhancedGitHubEvent) {
   )
 }
 
-export function isNotificationPrivate(notification: GitHubNotification) {
+export function isNotificationPrivate(
+  notification: Pick<GitHubNotification, 'repository'>,
+) {
   if (!notification) return false
   return !!(notification.repository && notification.repository.private)
 }

packages/core/src/types/devhub.ts

@@ -27,6 +27,10 @@ import { GraphQLUserPlan } from './graphql'
 
 type octokit = InstanceType<typeof Octokit>
 
+export type EnhancedGitHubNotificationReason =
+  | GitHubNotificationReason
+  | 'team_review_requested'
+
 export interface ArchivedEnhancement {
   // archived_at?: string
 }
@@ -51,10 +55,12 @@ export interface BaseEnhancement
 export interface NotificationPayloadEnhancement extends BaseEnhancement {
   comment?: GitHubComment
   commit?: GitHubCommit
+  enhanced?: boolean
   issue?: GitHubIssue
   pullRequest?: GitHubPullRequest
+  reason?: EnhancedGitHubNotificationReason
   release?: GitHubRelease
-  enhanced?: boolean
+  requestedMyReview?: boolean
 }
 
 export interface IssuePayloadEnhancement extends BaseEnhancement {
@@ -74,8 +80,10 @@ export type IssueOrPullRequestPayloadEnhancement =
   | PullRequestPayloadEnhancement
 
 export interface EnhancedGitHubNotification
-  extends GitHubNotification,
-    NotificationPayloadEnhancement {}
+  extends Omit<GitHubNotification, 'reason'>,
+    NotificationPayloadEnhancement {
+  reason: EnhancedGitHubNotificationReason
+}
 
 export interface GitHubEnhancedEventBase {
   merged: string[]
@@ -262,7 +270,7 @@ export interface IssueOrPullRequestColumnFilters extends BaseColumnFilters {
 export interface NotificationColumnFilters extends BaseColumnFilters {
   notifications?: {
     participating?: boolean
-    reasons?: Partial<Record<GitHubNotificationReason, boolean>>
+    reasons?: Partial<Record<EnhancedGitHubNotification['reason'], boolean>>
   }
   subjectTypes?: Partial<Record<GitHubNotificationSubjectType, boolean>>
 }
@@ -480,7 +488,10 @@ export interface ItemsFilterMetadata {
     Record<GitHubItemSubjectType, ItemFilterCountMetadata | undefined>
   >
   subscriptionReason: Partial<
-    Record<GitHubNotificationReason, ItemFilterCountMetadata | undefined>
+    Record<
+      EnhancedGitHubNotification['reason'],
+      ItemFilterCountMetadata | undefined
+    >
   >
   eventAction: Partial<Record<GitHubEventAction, ItemFilterCountMetadata>>
   privacy: Record<GitHubPrivacy, ItemFilterCountMetadata>

packages/core/src/types/github.ts

@@ -243,6 +243,7 @@ export interface GitHubPullRequest {
   merged_by: GitHubUser // User
   comments: number // 0
   review_comments: number // 0
+  requested_reviewers?: GitHubUser[] | null // []
   commits: number // 2
   additions: number // 4
   deletions: number // 4
@@ -864,7 +865,7 @@ export type GitHubNotificationReason =
   | 'invitation' // You accepted an invitation to contribute to the repository.
   | 'manual' // You subscribed to the thread (via an Issue or Pull Request).
   | 'mention' // You were specifically @mentioned in the content.
-  | 'review_requested' // Someone requested your review on a pull request
+  | 'review_requested' // Someone requested your review (or your team's) on a pull request
   | 'security_alert' // Potential security vulnerability alert
   | 'state_change' // You changed the thread state (for example, closing an Issue or merging a PR).
   | 'subscribed' // You're watching the repository.