feat(api): codegen for discussions

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

Author: setchy

src/renderer/utils/api/__mocks__/response-mocks.ts

@@ -3,14 +3,14 @@ import {
   mockGitHubEnterpriseServerAccount,
 } from '../../../__mocks__/account-mocks';
 import type { Link } from '../../../types';
-import type {
-  DiscussionAuthor,
-  Notification,
-  Repository,
-  User,
-} from '../../../typesGitHub';
+import type { Notification, Repository, User } from '../../../typesGitHub';
+import { makeFragmentData } from '../graphql/generated/fragment-masking';
 import type { FetchDiscussionsQuery } from '../graphql/generated/graphql';
-import type { GitHubGraphQLResponse } from '../types';
+import {
+  CommentFieldsFragmentDoc,
+  DiscussionCommentFieldsFragmentDoc,
+  DiscussionFieldsFragmentDoc,
+} from '../graphql/generated/graphql';
 
 export const mockNotificationUser: User = {
   login: 'octocat',
@@ -374,72 +374,105 @@ export const mockEnterpriseNotifications: Notification[] = [
   },
 ];
 
-const mockDiscussionAuthor: DiscussionAuthor = {
-  login: 'comment-user',
-  url: 'https://github.com/comment-user' as Link,
-  avatar_url: 'https://avatars.githubusercontent.com/u/123456789?v=4' as Link,
-  type: 'User',
+const mockDiscussionAuthor = {
+  __typename: 'User' as const,
+  ' $fragmentRefs': {
+    AuthorFields_User_Fragment: {
+      __typename: 'User' as const,
+      login: 'comment-user',
+      url: 'https://github.com/comment-user' as Link,
+      avatar_url:
+        'https://avatars.githubusercontent.com/u/123456789?v=4' as Link,
+      type: 'User' as const,
+    },
+  },
 };
 
-const mockDiscussionReplier: DiscussionAuthor = {
-  login: 'reply-user',
-  url: 'https://github.com/reply-user' as Link,
-  avatar_url: 'https://avatars.githubusercontent.com/u/123456789?v=4' as Link,
-  type: 'User',
+const mockDiscussionReplier = {
+  __typename: 'User' as const,
+  ' $fragmentRefs': {
+    AuthorFields_User_Fragment: {
+      __typename: 'User' as const,
+      login: 'reply-user',
+      url: 'https://github.com/reply-user' as Link,
+      avatar_url:
+        'https://avatars.githubusercontent.com/u/123456789?v=4' as Link,
+      type: 'User' as const,
+    },
+  },
 };
 
-export const mockDiscussionComments: DiscussionComments = {
+const mockDiscussionComments = {
   nodes: [
-    {
-      databaseId: 2258799,
-      createdAt: '2017-02-20T17:51:57Z',
-      author: mockDiscussionAuthor,
-      replies: {
-        nodes: [
-          {
-            databaseId: 2300902,
-            createdAt: '2017-05-20T17:51:57Z',
-            author: mockDiscussionReplier,
-          },
-        ],
+    makeFragmentData(
+      {
+        __typename: 'DiscussionComment' as const,
+        databaseId: 2258799,
+        createdAt: '2017-02-20T17:51:57Z',
+        author: mockDiscussionAuthor,
+        replies: {
+          __typename: 'DiscussionCommentConnection' as const,
+          nodes: [
+            makeFragmentData(
+              {
+                __typename: 'DiscussionComment' as const,
+                databaseId: 2300902,
+                createdAt: '2017-05-20T17:51:57Z',
+                author: mockDiscussionReplier,
+              },
+              CommentFieldsFragmentDoc,
+            ),
+          ],
+        },
       },
-    },
+      DiscussionCommentFieldsFragmentDoc,
+    ),
   ],
   totalCount: 2,
 };
 
-export const mockDiscussionLabels: DiscussionLabels = {
+const mockDiscussionLabels = {
+  __typename: 'LabelConnection' as const,
   nodes: [
     {
+      __typename: 'Label' as const,
       name: 'enhancement',
     },
   ],
 };
 
-export const mockGraphQLResponse: GitHubGraphQLResponse<FetchDiscussionsQuery> =
-  {
-    data: {
-      search: {
-        nodes: [
-          {
-            number: 123,
-            title: '1.16.0',
-            isAnswered: false,
-            stateReason: 'OPEN',
-            url: 'https://github.com/gitify-app/notifications-test/discussions/612' as Link,
-            author: {
-              login: 'discussion-creator',
-              url: 'https://github.com/discussion-creator' as Link,
-              avatar_url:
-                'https://avatars.githubusercontent.com/u/123456789?v=4' as Link,
-              type: 'User',
+export const mockGraphQLResponse: FetchDiscussionsQuery = {
+  search: {
+    __typename: 'SearchResultItemConnection',
+    nodes: [
+      makeFragmentData(
+        {
+          __typename: 'Discussion' as const,
+          number: 123,
+          title: '1.16.0',
+          isAnswered: false,
+          stateReason: null,
+          url: 'https://github.com/gitify-app/notifications-test/discussions/612' as Link,
+          author: {
+            __typename: 'User' as const,
+            ' $fragmentRefs': {
+              AuthorFields_User_Fragment: {
+                __typename: 'User' as const,
+                login: 'discussion-creator',
+                url: 'https://github.com/discussion-creator' as Link,
+                avatar_url:
+                  'https://avatars.githubusercontent.com/u/123456789?v=4' as Link,
+                type: 'User' as const,
+              },
             },
-            comments: mockDiscussionComments,
-            labels: mockDiscussionLabels,
           },
-        ],
-      },
-    },
-  };
+          comments: mockDiscussionComments,
+          labels: mockDiscussionLabels,
+        },
+        DiscussionFieldsFragmentDoc,
+      ),
+    ],
+  },
+};
 
 export const mockSingleNotification: Notification = mockGitHubNotifications[0];

src/renderer/utils/api/client.ts

@@ -29,7 +29,7 @@ import {
   type MeQuery,
 } from './graphql/generated/graphql';
 import { formatAsGitHubSearchSyntax } from './graphql/utils';
-import { apiRequestAuth, performRequestForAccount } from './request';
+import { apiRequestAuth, performGraphQLRequest } from './request';
 import type { GitHubGraphQLResponse } from './types';
 import { getGitHubAPIBaseUrl, getGitHubGraphQLUrl } from './utils';
 
@@ -244,7 +244,7 @@ export async function searchDiscussions(
 ): Promise<GitHubGraphQLResponse<FetchDiscussionsQuery>> {
   const url = getGitHubGraphQLUrl(notification.account.hostname);
 
-  return performRequestForAccount(
+  return performGraphQLRequest(
     url.toString() as Link,
     notification.account.token,
     FetchDiscussionsDocument,
@@ -283,7 +283,7 @@ export async function searchDiscussionsv2(
     }
   `);
 
-  return performRequestForAccount(
+  return performGraphQLRequest(
     url.toString() as Link,
     notification.account.token,
     Me,

src/renderer/utils/api/request.ts

@@ -90,7 +90,7 @@ export async function apiRequestAuth(
  * @param variables
  * @returns
  */
-export async function performRequestForAccount<TResult, TVariables>(
+export async function performGraphQLRequest<TResult, TVariables>(
   url: Link,
   token: Token,
   query: TypedDocumentString<TResult, TVariables>,

src/renderer/utils/helpers.test.ts

@@ -273,6 +273,11 @@ describe('renderer/utils/helpers.ts', () => {
     });
 
     describe('Discussions URLs', () => {
+      const performGraphQLRequestSpy = jest.spyOn(
+        apiRequests,
+        'performGraphQLRequest',
+      );
+
       it('when no subject urls and no discussions found via query, default to linking to repository discussions', async () => {
         const subject = {
           title: 'generate github web url unit tests',
@@ -281,7 +286,7 @@ describe('renderer/utils/helpers.ts', () => {
           type: 'Discussion' as SubjectType,
         };
 
-        apiRequestAuthSpy.mockResolvedValue({
+        performGraphQLRequestSpy.mockResolvedValue({
           data: { data: { search: { nodes: [] } } },
         } as AxiosResponse);
 
@@ -290,7 +295,7 @@ describe('renderer/utils/helpers.ts', () => {
           subject: subject,
         });
 
-        expect(apiRequestAuthSpy).toHaveBeenCalledTimes(1);
+        expect(performGraphQLRequestSpy).toHaveBeenCalledTimes(1);
         expect(result).toBe(
           `${mockSingleNotification.repository.html_url}/discussions?${mockNotificationReferrer}`,
         );
@@ -304,7 +309,7 @@ describe('renderer/utils/helpers.ts', () => {
           type: 'Discussion' as SubjectType,
         };
 
-        apiRequestAuthSpy.mockResolvedValue({
+        performGraphQLRequestSpy.mockResolvedValue({
           data: {
             ...mockGraphQLResponse,
           },
@@ -315,7 +320,7 @@ describe('renderer/utils/helpers.ts', () => {
           subject: subject,
         });
 
-        expect(apiRequestAuthSpy).toHaveBeenCalledTimes(1);
+        expect(performGraphQLRequestSpy).toHaveBeenCalledTimes(1);
         expect(result).toBe(
           `https://github.com/gitify-app/notifications-test/discussions/612?${mockNotificationReferrer}#discussioncomment-2300902`,
         );
@@ -333,14 +338,14 @@ describe('renderer/utils/helpers.ts', () => {
           type: 'Discussion' as SubjectType,
         };
 
-        apiRequestAuthSpy.mockResolvedValue(null as AxiosResponse);
+        performGraphQLRequestSpy.mockResolvedValue(null as AxiosResponse);
 
         const result = await generateGitHubWebUrl({
           ...mockSingleNotification,
           subject: subject,
         });
 
-        expect(apiRequestAuthSpy).toHaveBeenCalledTimes(1);
+        expect(performGraphQLRequestSpy).toHaveBeenCalledTimes(1);
         expect(result).toBe(
           `https://github.com/gitify-app/notifications-test/discussions?${mockNotificationReferrer}`,
         );