feat(api): codegen for discussions

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

Author: setchy

src/renderer/utils/api/client.ts

@@ -1,4 +1,5 @@
 import type { AxiosPromise } from 'axios';
+import type { ExecutionResult } from 'graphql';
 
 import type {
   Account,
@@ -26,7 +27,6 @@ import {
   type FetchDiscussionByNumberQuery,
 } from './graphql/generated/graphql';
 import { apiRequestAuth, performGraphQLRequest } from './request';
-import type { GitHubGraphQLResponse } from './types';
 import {
   getGitHubAPIBaseUrl,
   getGitHubGraphQLUrl,
@@ -241,7 +241,7 @@ export async function getHtmlUrl(url: Link, token: Token): Promise<string> {
  */
 export async function fetchDiscussionByNumber(
   notification: Notification,
-): Promise<GitHubGraphQLResponse<FetchDiscussionByNumberQuery>> {
+): Promise<ExecutionResult<FetchDiscussionByNumberQuery>> {
   const url = getGitHubGraphQLUrl(notification.account.hostname);
   const number = getNumberFromUrl(notification.subject.url);
 

src/renderer/utils/api/request.ts

@@ -9,7 +9,6 @@ import type { Link, Token } from '../../types';
 import { decryptValue } from '../comms';
 import { rendererLogError } from '../logger';
 import type { TypedDocumentString } from './graphql/generated/graphql';
-import type { GitHubGraphQLResponse } from './types';
 import { getNextURLFromLinkHeader } from './utils';
 
 /**

src/renderer/utils/helpers.test.ts

@@ -5,6 +5,7 @@ import {
 } from '@primer/octicons-react';
 
 import type { AxiosResponse } from 'axios';
+import type { ExecutionResult } from 'graphql';
 
 import { mockPersonalAccessTokenAccount } from '../__mocks__/account-mocks';
 import type { Hostname, Link } from '../types';
@@ -17,7 +18,6 @@ import {
 import * as apiClient from './api/client';
 import type { FetchDiscussionByNumberQuery } from './api/graphql/generated/graphql';
 import * as apiRequests from './api/request';
-import type { GitHubGraphQLResponse } from './api/types';
 import {
   generateGitHubWebUrl,
   generateNotificationReferrerId,
@@ -323,7 +323,7 @@ describe('renderer/utils/helpers.ts', () => {
               message: 'Something failed',
             },
           ],
-        } as GitHubGraphQLResponse<FetchDiscussionByNumberQuery>);
+        } as unknown as ExecutionResult<FetchDiscussionByNumberQuery>);
 
         const result = await generateGitHubWebUrl({
           ...mockSingleNotification,
@@ -347,7 +347,7 @@ describe('renderer/utils/helpers.ts', () => {
 
         fetchDiscussionByNumberSpy.mockResolvedValue({
           data: mockDiscussionByNumberGraphQLResponse,
-        } as GitHubGraphQLResponse<FetchDiscussionByNumberQuery>);
+        } as ExecutionResult<FetchDiscussionByNumberQuery>);
 
         const result = await generateGitHubWebUrl({
           ...mockSingleNotification,

src/renderer/utils/helpers.ts

@@ -110,48 +110,36 @@ export async function generateGitHubWebUrl(
 ): Promise<Link> {
   const url = new URL(notification.repository.html_url);
 
-  /**
-   * Discussions - override generic response values for subject and comment urls,
-   * as we will fetch more specific html urls ourselves below
-   * See issue #1583:
-   */
-  if (notification.subject.type === 'Discussion') {
-    notification.subject.url = null;
-    notification.subject.latest_comment_url = null;
-  }
-
   try {
-    if (notification.subject.latest_comment_url) {
-      url.href = await getHtmlUrl(
-        notification.subject.latest_comment_url,
-        notification.account.token,
-      );
-    } else if (notification.subject.url) {
-      url.href = await getHtmlUrl(
-        notification.subject.url,
-        notification.account.token,
-      );
-    } else {
-      // Perform any specific notification type handling (only required for a few special notification scenarios)
-      switch (notification.subject.type) {
-        case 'CheckSuite':
-          url.href = getCheckSuiteUrl(notification);
-          break;
-        case 'Discussion':
-          url.href = await getDiscussionUrl(notification);
-          break;
-        case 'RepositoryInvitation':
-          url.pathname += '/invitations';
-          break;
-        case 'RepositoryDependabotAlertsThread':
-          url.pathname += '/security/dependabot';
-          break;
-        case 'WorkflowRun':
-          url.href = getWorkflowRunUrl(notification);
-          break;
-        default:
-          break;
-      }
+    switch (notification.subject.type) {
+      case 'CheckSuite':
+        url.href = getCheckSuiteUrl(notification);
+        break;
+      case 'Discussion':
+        url.href = await getDiscussionUrl(notification);
+        break;
+      case 'RepositoryInvitation':
+        url.pathname += '/invitations';
+        break;
+      case 'RepositoryDependabotAlertsThread':
+        url.pathname += '/security/dependabot';
+        break;
+      case 'WorkflowRun':
+        url.href = getWorkflowRunUrl(notification);
+        break;
+      default:
+        if (notification.subject.latest_comment_url) {
+          url.href = await getHtmlUrl(
+            notification.subject.latest_comment_url,
+            notification.account.token,
+          );
+        } else if (notification.subject.url) {
+          url.href = await getHtmlUrl(
+            notification.subject.url,
+            notification.account.token,
+          );
+        }
+        break;
     }
   } catch (err) {
     rendererLogError(
@@ -161,8 +149,19 @@ export async function generateGitHubWebUrl(
       notification,
     );
 
-    if (notification.subject.type === 'Discussion') {
-      url.pathname += '/discussions';
+    // Error state fallback urls
+    switch (notification.subject.type) {
+      case 'Issue':
+        url.pathname += '/issues';
+        break;
+      case 'Discussion':
+        url.pathname += '/discussions';
+        break;
+      case 'PullRequest':
+        url.pathname += '/pulls';
+        break;
+      default:
+        break;
     }
   }