refactor(api): use graphql api for issue and pull request enrichment

Signed-off-by: Adam Setch <[email protected]>

Author: setchy

src/renderer/utils/helpers.test.ts

@@ -6,7 +6,6 @@ import {
 
 import type { ExecutionResult } from 'graphql';
 
-import { createPartialMockNotification } from '../__mocks__/notifications-mocks';
 import type { Hostname, Link } from '../types';
 import type { SubjectType } from '../typesGitHub';
 import * as logger from '../utils/logger';
@@ -20,7 +19,6 @@ import {
   generateGitHubWebUrl,
   generateNotificationReferrerId,
   getChevronDetails,
-  getDefaultURLForType,
   getPlatformFromHostname,
   isEnterpriseServerHost,
 } from './helpers';
@@ -556,76 +554,6 @@ describe('renderer/utils/helpers.ts', () => {
     });
   });
 
-  describe('getDefaultURLForType', () => {
-    const mockUrl = 'https://github.com/gitify-app/notifications-test' as Link;
-
-    it('discussions', () => {
-      const mockNotification = createPartialMockNotification(
-        { type: 'Discussion' },
-        { html_url: mockUrl },
-      );
-
-      expect(getDefaultURLForType(mockNotification)).toEqual(
-        'https://github.com/gitify-app/notifications-test/discussions',
-      );
-    });
-
-    it('issues', () => {
-      const mockNotification = createPartialMockNotification(
-        { type: 'Issue' },
-        { html_url: mockUrl },
-      );
-
-      expect(getDefaultURLForType(mockNotification)).toEqual(
-        'https://github.com/gitify-app/notifications-test/issues',
-      );
-    });
-
-    it('pull requests', () => {
-      const mockNotification = createPartialMockNotification(
-        { type: 'PullRequest' },
-        { html_url: mockUrl },
-      );
-
-      expect(getDefaultURLForType(mockNotification)).toEqual(
-        'https://github.com/gitify-app/notifications-test/pulls',
-      );
-    });
-
-    it('repository invitation', () => {
-      const mockNotification = createPartialMockNotification(
-        { type: 'RepositoryInvitation' },
-        { html_url: mockUrl },
-      );
-
-      expect(getDefaultURLForType(mockNotification)).toEqual(
-        'https://github.com/gitify-app/notifications-test/invitations',
-      );
-    });
-
-    it('repository dependabot alert thread', () => {
-      const mockNotification = createPartialMockNotification(
-        { type: 'RepositoryDependabotAlertsThread' },
-        { html_url: mockUrl },
-      );
-
-      expect(getDefaultURLForType(mockNotification)).toEqual(
-        'https://github.com/gitify-app/notifications-test/security/dependabot',
-      );
-    });
-
-    it('default web urls', () => {
-      const mockNotification = createPartialMockNotification(
-        { type: 'Commit' },
-        { html_url: mockUrl },
-      );
-
-      expect(getDefaultURLForType(mockNotification)).toEqual(
-        'https://github.com/gitify-app/notifications-test',
-      );
-    });
-  });
-
   describe('getChevronDetails', () => {
     it('should return correct chevron details', () => {
       expect(getChevronDetails(true, true, 'account')).toEqual({

src/renderer/utils/helpers.ts

@@ -10,6 +10,7 @@ import type { Notification } from '../typesGitHub';
 import { getHtmlUrl } from './api/client';
 import type { PlatformType } from './auth/types';
 import { rendererLogError } from './logger';
+import { createNotificationHandler } from './notifications/handlers';
 
 export function getPlatformFromHostname(hostname: string): PlatformType {
   return hostname.endsWith(Constants.DEFAULT_AUTH_OPTIONS.hostname)
@@ -46,10 +47,12 @@ export function actionsURL(repositoryURL: string, filters: string[]): Link {
 export async function generateGitHubWebUrl(
   notification: Notification,
 ): Promise<Link> {
-  const url = new URL(getDefaultURLForType(notification));
+  const url = new URL(notification.repository.html_url);
 
   try {
-    if (notification.subject.latest_comment_url) {
+    if (notification.subject.htmlUrl) {
+      url.href = notification.subject.htmlUrl;
+    } else if (notification.subject.latest_comment_url) {
       url.href = await getHtmlUrl(
         notification.subject.latest_comment_url,
         notification.account.token,
@@ -59,6 +62,9 @@ export async function generateGitHubWebUrl(
         notification.subject.url,
         notification.account.token,
       );
+    } else {
+      const handler = createNotificationHandler(notification);
+      handler.defaultUrl(notification);
     }
   } catch (err) {
     rendererLogError(
@@ -77,41 +83,6 @@ export async function generateGitHubWebUrl(
   return url.toString() as Link;
 }
 
-export function getDefaultURLForType(notification: Notification) {
-  const url = new URL(notification.repository.html_url);
-
-  switch (notification.subject.type) {
-    case 'CheckSuite':
-      url.pathname += '/actions';
-      break;
-    case 'Discussion':
-      url.pathname += '/discussions';
-      break;
-    case 'Issue':
-      url.pathname += '/issues';
-      break;
-    case 'PullRequest':
-      url.pathname += '/pulls';
-      break;
-    case 'Release':
-      url.pathname += '/releases';
-      break;
-    case 'RepositoryInvitation':
-      url.pathname += '/invitations';
-      break;
-    case 'RepositoryDependabotAlertsThread':
-      url.pathname += '/security/dependabot';
-      break;
-    case 'WorkflowRun':
-      url.pathname += '/actions';
-      break;
-    default:
-      break;
-  }
-
-  return url.href;
-}
-
 export function getChevronDetails(
   hasNotifications: boolean,
   isVisible: boolean,

src/renderer/utils/links.ts

@@ -5,7 +5,10 @@ import type { Account, Hostname, Link } from '../types';
 import type { Notification, Repository, SubjectUser } from '../typesGitHub';
 import { getDeveloperSettingsURL } from './auth/utils';
 import { openExternalLink } from './comms';
-import { generateNotificationReferrerId } from './helpers';
+import {
+  generateGitHubWebUrl,
+  generateNotificationReferrerId,
+} from './helpers';
 
 export function openGitifyReleaseNotes(version: string) {
   openExternalLink(
@@ -55,7 +58,7 @@ export function openRepository(repository: Repository) {
 }
 
 export async function openNotification(notification: Notification) {
-  const url = new URL(notification.subject.htmlUrl);
+  const url = new URL(await generateGitHubWebUrl(notification));
 
   url.searchParams.set(
     'notification_referrer_id',

src/renderer/utils/notifications/handlers/checkSuite.ts

@@ -54,6 +54,12 @@ class CheckSuiteHandler extends DefaultHandler {
         return RocketIcon;
     }
   }
+
+  defaultUrl(notification: Notification): Link {
+    const url = new URL(notification.repository.html_url);
+    url.pathname += '/actions';
+    return url.href as Link;
+  }
 }
 
 export const checkSuiteHandler = new CheckSuiteHandler();

src/renderer/utils/notifications/handlers/default.ts

@@ -3,7 +3,7 @@ import type { FC } from 'react';
 import type { OcticonProps } from '@primer/octicons-react';
 import { QuestionIcon } from '@primer/octicons-react';
 
-import type { SettingsState } from '../../../types';
+import type { Link, SettingsState } from '../../../types';
 import { IconColor } from '../../../types';
 import type {
   GitifySubject,
@@ -80,6 +80,10 @@ export class DefaultHandler implements NotificationTypeHandler {
     }
     return title;
   }
+
+  defaultUrl(notification: Notification): Link {
+    return notification.repository.html_url as Link;
+  }
 }
 
 export const defaultHandler = new DefaultHandler();

src/renderer/utils/notifications/handlers/discussion.ts

@@ -10,7 +10,7 @@ import {
 
 import { differenceInMilliseconds } from 'date-fns';
 
-import type { SettingsState } from '../../../types';
+import type { Link, SettingsState } from '../../../types';
 import type {
   DiscussionStateType,
   GitifySubject,
@@ -111,6 +111,12 @@ class DiscussionHandler extends DefaultHandler {
         return CommentDiscussionIcon;
     }
   }
+
+  defaultUrl(notification: Notification): Link {
+    const url = new URL(notification.repository.html_url);
+    url.pathname += '/discussions';
+    return url.href as Link;
+  }
 }
 
 export const discussionHandler = new DiscussionHandler();

src/renderer/utils/notifications/handlers/issue.ts

@@ -9,7 +9,7 @@ import {
   SkipIcon,
 } from '@primer/octicons-react';
 
-import type { SettingsState } from '../../../types';
+import type { Link, SettingsState } from '../../../types';
 import type {
   GitifySubject,
   Notification,
@@ -64,6 +64,12 @@ class IssueHandler extends DefaultHandler {
         return IssueOpenedIcon;
     }
   }
+
+  defaultUrl(notification: Notification): Link {
+    const url = new URL(notification.repository.html_url);
+    url.pathname += '/issues';
+    return url.href as Link;
+  }
 }
 
 export const issueHandler = new IssueHandler();

src/renderer/utils/notifications/handlers/pullRequest.ts

@@ -8,7 +8,7 @@ import {
   GitPullRequestIcon,
 } from '@primer/octicons-react';
 
-import type { SettingsState } from '../../../types';
+import type { Link, SettingsState } from '../../../types';
 import type {
   GitifyPullRequestReview,
   GitifySubject,
@@ -81,6 +81,12 @@ class PullRequestHandler extends DefaultHandler {
         return GitPullRequestIcon;
     }
   }
+
+  defaultUrl(notification: Notification): Link {
+    const url = new URL(notification.repository.html_url);
+    url.pathname += '/pulls';
+    return url.href as Link;
+  }
 }
 
 export const pullRequestHandler = new PullRequestHandler();

src/renderer/utils/notifications/handlers/release.ts

@@ -3,7 +3,7 @@ import type { FC } from 'react';
 import type { OcticonProps } from '@primer/octicons-react';
 import { TagIcon } from '@primer/octicons-react';
 
-import type { SettingsState } from '../../../types';
+import type { Link, SettingsState } from '../../../types';
 import type {
   GitifySubject,
   Notification,
@@ -42,6 +42,12 @@ class ReleaseHandler extends DefaultHandler {
   iconType(_subject: Subject): FC<OcticonProps> | null {
     return TagIcon;
   }
+
+  defaultUrl(notification: Notification): Link {
+    const url = new URL(notification.repository.html_url);
+    url.pathname += '/releases';
+    return url.href as Link;
+  }
 }
 
 export const releaseHandler = new ReleaseHandler();

src/renderer/utils/notifications/handlers/repositoryDependabotAlertsThread.ts

@@ -3,7 +3,8 @@ import type { FC } from 'react';
 import type { OcticonProps } from '@primer/octicons-react';
 import { AlertIcon } from '@primer/octicons-react';
 
-import type { Subject } from '../../../typesGitHub';
+import type { Link } from '../../../types';
+import type { Notification, Subject } from '../../../typesGitHub';
 import { DefaultHandler } from './default';
 
 class RepositoryDependabotAlertsThreadHandler extends DefaultHandler {
@@ -12,6 +13,12 @@ class RepositoryDependabotAlertsThreadHandler extends DefaultHandler {
   iconType(_subject: Subject): FC<OcticonProps> | null {
     return AlertIcon;
   }
+
+  defaultUrl(notification: Notification): Link {
+    const url = new URL(notification.repository.html_url);
+    url.pathname += '/security/dependabot';
+    return url.href as Link;
+  }
 }
 
 export const repositoryDependabotAlertsThreadHandler =