feat(api): codegen for discussions

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

Author: setchy

src/renderer/typesGitHub.ts

@@ -176,13 +176,6 @@ export interface SubjectUser {
   type: UserType;
 }
 
-export interface DiscussionAuthor {
-  login: string;
-  url: Link;
-  avatar_url: Link;
-  type: UserType;
-}
-
 export interface Repository {
   id: number;
   node_id: string;
@@ -489,47 +482,6 @@ export interface Release {
   published_at: string | null;
 }
 
-export interface GraphQLSearch<T> {
-  data: {
-    search: {
-      nodes: T[];
-    };
-  };
-}
-
-export interface Discussion {
-  number: number;
-  title: string;
-  stateReason: DiscussionStateType;
-  isAnswered: boolean | null;
-  url: Link;
-  author: DiscussionAuthor;
-  comments: DiscussionComments;
-  labels: DiscussionLabels | null;
-}
-
-export interface DiscussionLabels {
-  nodes: DiscussionLabel[];
-}
-
-export interface DiscussionLabel {
-  name: string;
-}
-
-export interface DiscussionComments {
-  nodes: DiscussionComment[];
-  totalCount: number;
-}
-
-export interface DiscussionComment {
-  databaseId: string | number;
-  createdAt: string;
-  author: DiscussionAuthor;
-  replies?: {
-    nodes: DiscussionComment[];
-  };
-}
-
 export interface CheckSuiteAttributes {
   workflowName: string;
   attemptNumber?: number;

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

@@ -4,15 +4,13 @@ import {
 } from '../../../__mocks__/account-mocks';
 import type { Link } from '../../../types';
 import type {
-  Discussion,
   DiscussionAuthor,
-  DiscussionComments,
-  DiscussionLabels,
-  GraphQLSearch,
   Notification,
   Repository,
   User,
 } from '../../../typesGitHub';
+import type { FetchDiscussionsQuery } from '../graphql/generated/graphql';
+import type { GitHubGraphQLResponse } from '../types';
 
 export const mockNotificationUser: User = {
   login: 'octocat',
@@ -418,29 +416,30 @@ export const mockDiscussionLabels: DiscussionLabels = {
   ],
 };
 
-export const mockGraphQLResponse: GraphQLSearch<Discussion> = {
-  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: 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',
+            },
+            comments: mockDiscussionComments,
+            labels: mockDiscussionLabels,
           },
-          comments: mockDiscussionComments,
-          labels: mockDiscussionLabels,
-        },
-      ],
+        ],
+      },
     },
-  },
-};
+  };
 
 export const mockSingleNotification: Notification = mockGitHubNotifications[0];

src/renderer/utils/helpers.ts

@@ -8,6 +8,8 @@ import { Constants } from '../constants';
 import type { Chevron, Hostname, Link } from '../types';
 import type { Notification } from '../typesGitHub';
 import { getHtmlUrl, getLatestDiscussion } from './api/client';
+import { useFragment as getFragmentData } from './api/graphql/generated/fragment-masking';
+import { DiscussionCommentFieldsFragmentDoc } from './api/graphql/generated/graphql';
 import type { PlatformType } from './auth/types';
 import { rendererLogError } from './logger';
 import { getCheckSuiteAttributes } from './notifications/handlers/checkSuite';
@@ -89,9 +91,16 @@ async function getDiscussionUrl(notification: Notification): Promise<Link> {
   if (discussion) {
     url.href = discussion.url;
 
+    // Unwrap discussion comments from fragment-masked types
+    const discussionComments =
+      getFragmentData(
+        DiscussionCommentFieldsFragmentDoc,
+        discussion.comments.nodes,
+      ) || [];
+
     const closestComment = getClosestDiscussionCommentOrReply(
       notification,
-      discussion.comments.nodes,
+      discussionComments,
     );
     if (closestComment) {
       url.hash = `#discussioncomment-${closestComment.databaseId}`;

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

@@ -7,15 +7,15 @@ import {
 } from '../../../__mocks__/notifications-mocks';
 import { mockSettings } from '../../../__mocks__/state-mocks';
 import type { Link } from '../../../types';
-import type {
-  Discussion,
-  DiscussionAuthor,
-  DiscussionStateType,
-  Repository,
-} from '../../../typesGitHub';
+import type { Repository } from '../../../typesGitHub';
+import {
+  type AuthorFieldsFragment,
+  type DiscussionFieldsFragment,
+  DiscussionStateReason,
+} from '../../api/graphql/generated/graphql';
 import { discussionHandler } from './discussion';
 
-const mockDiscussionAuthor: DiscussionAuthor = {
+const mockDiscussionAuthor: AuthorFieldsFragment = {
   login: 'discussion-author',
   url: 'https://github.com/discussion-author' as Link,
   avatar_url: 'https://avatars.githubusercontent.com/u/123456789?v=4' as Link,
@@ -79,7 +79,9 @@ describe('renderer/utils/notifications/handlers/discussion.ts', () => {
         .reply(200, {
           data: {
             search: {
-              nodes: [mockDiscussionNode('DUPLICATE', false)],
+              nodes: [
+                mockDiscussionNode(DiscussionStateReason.Duplicate, false),
+              ],
             },
           },
         });
@@ -139,7 +141,9 @@ describe('renderer/utils/notifications/handlers/discussion.ts', () => {
         .reply(200, {
           data: {
             search: {
-              nodes: [mockDiscussionNode('OUTDATED', false)],
+              nodes: [
+                mockDiscussionNode(DiscussionStateReason.Outdated, false),
+              ],
             },
           },
         });
@@ -169,7 +173,9 @@ describe('renderer/utils/notifications/handlers/discussion.ts', () => {
         .reply(200, {
           data: {
             search: {
-              nodes: [mockDiscussionNode('REOPENED', false)],
+              nodes: [
+                mockDiscussionNode(DiscussionStateReason.Reopened, false),
+              ],
             },
           },
         });
@@ -199,7 +205,7 @@ describe('renderer/utils/notifications/handlers/discussion.ts', () => {
         .reply(200, {
           data: {
             search: {
-              nodes: [mockDiscussionNode('RESOLVED', true)],
+              nodes: [mockDiscussionNode(DiscussionStateReason.Resolved, true)],
             },
           },
         });
@@ -308,9 +314,9 @@ describe('renderer/utils/notifications/handlers/discussion.ts', () => {
 });
 
 function mockDiscussionNode(
-  state: DiscussionStateType,
+  state: DiscussionStateReason,
   isAnswered: boolean,
-): Discussion {
+): DiscussionFieldsFragment {
   return {
     number: 123,
     title: 'This is a mock discussion',

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

@@ -19,11 +19,16 @@ import type {
   SubjectUser,
 } from '../../../typesGitHub';
 import { getLatestDiscussion } from '../../api/client';
+import { useFragment as getFragmentData } from '../../api/graphql/generated/fragment-masking';
 import type {
-  AuthorFieldsFragment,
   CommentFieldsFragment,
   DiscussionCommentFieldsFragment,
 } from '../../api/graphql/generated/graphql';
+import {
+  AuthorFieldsFragmentDoc,
+  CommentFieldsFragmentDoc,
+  DiscussionCommentFieldsFragmentDoc,
+} from '../../api/graphql/generated/graphql';
 import { isStateFilteredOut } from '../filters/filter';
 import { DefaultHandler } from './default';
 
@@ -52,25 +57,50 @@ class DiscussionHandler extends DefaultHandler {
       return null;
     }
 
+    // Unwrap discussion comments from fragment-masked types
+    const discussionComments =
+      getFragmentData(
+        DiscussionCommentFieldsFragmentDoc,
+        discussion.comments.nodes,
+      ) || [];
+
     const latestDiscussionComment = getClosestDiscussionCommentOrReply(
       notification,
-      discussion.comments.nodes as DiscussionCommentFieldsFragment[],
+      discussionComments,
     );
 
-    const discussionAuthor = discussion.author as AuthorFieldsFragment;
+    // Unwrap author from fragment-masked type
+    const discussionAuthor = getFragmentData(
+      AuthorFieldsFragmentDoc,
+      discussion.author,
+    );
+
+    let discussionUser: SubjectUser;
 
-    let discussionUser: SubjectUser = {
-      login: discussionAuthor.login,
-      html_url: discussionAuthor.url,
-      avatar_url: discussionAuthor.avatar_url,
-      type: discussionAuthor.type,
-    };
     if (latestDiscussionComment) {
+      // Unwrap author from the latest comment
+      const commentAuthor = getFragmentData(
+        AuthorFieldsFragmentDoc,
+        latestDiscussionComment.author,
+      );
+
+      if (commentAuthor) {
+        discussionUser = {
+          login: commentAuthor.login,
+          html_url: commentAuthor.url,
+          avatar_url: commentAuthor.avatar_url,
+          type: commentAuthor.type,
+        };
+      }
+    }
+
+    // Fall back to discussion author if no comment author found
+    if (!discussionUser && discussionAuthor) {
       discussionUser = {
-        login: latestDiscussionComment.author.login,
-        html_url: latestDiscussionComment.author.url,
-        avatar_url: latestDiscussionComment.author.avatar_url,
-        type: latestDiscussionComment.author.type,
+        login: discussionAuthor.login,
+        html_url: discussionAuthor.url,
+        avatar_url: discussionAuthor.avatar_url,
+        type: discussionAuthor.type,
       };
     }
 
@@ -102,17 +132,25 @@ export const discussionHandler = new DiscussionHandler();
 export function getClosestDiscussionCommentOrReply(
   notification: Notification,
   comments: DiscussionCommentFieldsFragment[],
-): DiscussionCommentFieldsFragment | null {
+): CommentFieldsFragment | null {
   if (!comments || comments.length === 0) {
     return null;
   }
 
   const targetTimestamp = notification.updated_at;
 
-  const allCommentsAndReplies = comments.flatMap((comment) => [
-    comment,
-    ...comment.replies.nodes,
-  ]);
+  // Unwrap all comments and their replies from fragment-masked types
+  const allCommentsAndReplies: CommentFieldsFragment[] = comments.flatMap(
+    (comment) => {
+      const unwrappedComment = getFragmentData(
+        CommentFieldsFragmentDoc,
+        comment,
+      );
+      const unwrappedReplies =
+        getFragmentData(CommentFieldsFragmentDoc, comment.replies.nodes) || [];
+      return [unwrappedComment, ...unwrappedReplies];
+    },
+  );
 
   // Find the closest match using the target timestamp
   const closestComment = allCommentsAndReplies.reduce(