refactor(reason): separate into own file and use Record for mappings (#1036)

Author: setchy

src/components/NotificationRow.tsx

@@ -17,11 +17,11 @@ import { AppContext } from '../context/App';
 import type { Notification } from '../typesGithub';
 import { openExternalLink } from '../utils/comms';
 import {
-  formatReason,
   getNotificationTypeIcon,
   getNotificationTypeIconColor,
 } from '../utils/github-api';
 import { formatForDisplay, openInBrowser } from '../utils/helpers';
+import { formatReason } from '../utils/reason';
 
 interface IProps {
   hostname: string;
@@ -128,7 +128,7 @@ export const NotificationRow: FC<IProps> = ({ notification, hostname }) => {
                 </span>
               )}
               <span className="ml-1" title={reason.description}>
-                {reason.type}
+                {reason.title}
               </span>
               <span className="ml-1">{updatedAt}</span>
             </span>

src/types.ts

@@ -88,3 +88,8 @@ export type ErrorType =
   | 'NETWORK'
   | 'RATE_LIMITED'
   | 'UNKNOWN';
+
+export interface FormattedReason {
+  title: string;
+  description: string;
+}

src/utils/__snapshots__/github-api.test.ts.snap

@@ -1,30 +1,10 @@
-import type { Reason, StateType, Subject, SubjectType } from '../typesGithub';
+import type { StateType, Subject, SubjectType } from '../typesGithub';
 import {
-  formatReason,
   getNotificationTypeIcon,
   getNotificationTypeIconColor,
 } from './github-api';
 
 describe('utils/github-api.ts', () => {
-  it('formatReason - should format the notification reason', () => {
-    expect(formatReason('approval_requested')).toMatchSnapshot();
-    expect(formatReason('assign')).toMatchSnapshot();
-    expect(formatReason('author')).toMatchSnapshot();
-    expect(formatReason('ci_activity')).toMatchSnapshot();
-    expect(formatReason('comment')).toMatchSnapshot();
-    expect(formatReason('invitation')).toMatchSnapshot();
-    expect(formatReason('manual')).toMatchSnapshot();
-    expect(formatReason('member_feature_requested')).toMatchSnapshot();
-    expect(formatReason('mention')).toMatchSnapshot();
-    expect(formatReason('review_requested')).toMatchSnapshot();
-    expect(formatReason('security_advisory_credit')).toMatchSnapshot();
-    expect(formatReason('security_alert')).toMatchSnapshot();
-    expect(formatReason('state_change')).toMatchSnapshot();
-    expect(formatReason('subscribed')).toMatchSnapshot();
-    expect(formatReason('team_mention')).toMatchSnapshot();
-    expect(formatReason('something_else_unknown' as Reason)).toMatchSnapshot();
-  });
-
   describe('getNotificationTypeIcon - should get the notification type icon', () => {
     expect(
       getNotificationTypeIcon(

src/utils/__snapshots__/reason.test.ts.snap

@@ -24,99 +24,7 @@ import {
   XIcon,
 } from '@primer/octicons-react';
 import type { FC } from 'react';
-import type { Reason, Subject } from '../typesGithub';
-
-const DESCRIPTIONS = {
-  APPROVAL_REQUESTED: 'You were requested to review and approve a deployment.',
-  ASSIGN: 'You were assigned to the issue.',
-  AUTHOR: 'You created the thread.',
-  CI_ACTIVITY:
-    'A GitHub Actions workflow run was triggered for your repository',
-  COMMENT: 'You commented on the thread.',
-  INVITATION: 'You accepted an invitation to contribute to the repository.',
-  MANUAL: 'You subscribed to the thread (via an issue or pull request).',
-  MEMBER_FEATURE_REQUESTED:
-    'Organization members have requested to enable a feature such as Draft Pull Requests or CoPilot.',
-  MENTION: 'You were specifically @mentioned in the content.',
-  REVIEW_REQUESTED:
-    "You, or a team you're a member of, were requested to review a pull request.",
-  SECURITY_ADVISORY_CREDIT:
-    'You were credited for contributing to a security advisory.',
-  SECURITY_ALERT:
-    'GitHub discovered a security vulnerability in your repository.',
-  STATE_CHANGE:
-    'You changed the thread state (for example, closing an issue or merging a pull request).',
-  SUBSCRIBED: "You're watching the repository.",
-  TEAM_MENTION: 'You were on a team that was mentioned.',
-  UNKNOWN: 'The reason for this notification is not supported by the app.',
-};
-
-export function formatReason(reason: Reason): {
-  type: string;
-  description: string;
-} {
-  switch (reason) {
-    case 'approval_requested':
-      return {
-        type: 'Approval Requested',
-        description: DESCRIPTIONS.APPROVAL_REQUESTED,
-      };
-    case 'assign':
-      return { type: 'Assigned', description: DESCRIPTIONS.ASSIGN };
-    case 'author':
-      return { type: 'Authored', description: DESCRIPTIONS.AUTHOR };
-    case 'ci_activity':
-      return {
-        type: 'Workflow Run Completed',
-        description: DESCRIPTIONS.CI_ACTIVITY,
-      };
-    case 'comment':
-      return { type: 'Commented', description: DESCRIPTIONS.COMMENT };
-    case 'invitation':
-      return {
-        type: 'Invitation Received',
-        description: DESCRIPTIONS.INVITATION,
-      };
-    case 'manual':
-      return { type: 'Updated', description: DESCRIPTIONS.MANUAL };
-    case 'member_feature_requested':
-      return {
-        type: 'Member Feature Requested',
-        description: DESCRIPTIONS.MEMBER_FEATURE_REQUESTED,
-      };
-    case 'mention':
-      return { type: 'Mentioned', description: DESCRIPTIONS.MENTION };
-    case 'review_requested':
-      return {
-        type: 'Review Requested',
-        description: DESCRIPTIONS.REVIEW_REQUESTED,
-      };
-    case 'security_advisory_credit':
-      return {
-        type: 'Security Advisory Credit Recevied',
-        description: DESCRIPTIONS.SECURITY_ADVISORY_CREDIT,
-      };
-    case 'security_alert':
-      return {
-        type: 'Security Alert Received',
-        description: DESCRIPTIONS.SECURITY_ALERT,
-      };
-    case 'state_change':
-      return {
-        type: 'State Changed',
-        description: DESCRIPTIONS.STATE_CHANGE,
-      };
-    case 'subscribed':
-      return { type: 'Updated', description: DESCRIPTIONS.SUBSCRIBED };
-    case 'team_mention':
-      return {
-        type: 'Team Mentioned',
-        description: DESCRIPTIONS.TEAM_MENTION,
-      };
-    default:
-      return { type: 'Unknown', description: DESCRIPTIONS.UNKNOWN };
-  }
-}
+import type { Subject } from '../typesGithub';
 
 export function getNotificationTypeIcon(subject: Subject): FC<OcticonProps> {
   switch (subject.type) {