refactor(api): use fragments for nested types (#2471)

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

Author: setchy

src/renderer/utils/api/graphql/common.graphql

@@ -4,3 +4,8 @@ fragment AuthorFields on Actor {
   avatar_url: avatarUrl
   type: __typename
 }
+
+fragment MilestoneFields on Milestone {
+  state
+  title
+}

src/renderer/utils/api/graphql/discussion.graphql

@@ -21,13 +21,7 @@ query FetchDiscussionByNumber(
       comments(last: $lastComments) {
         totalCount
         nodes {
-          ...CommentFields
-          replies(last: $lastReplies) {
-            totalCount
-            nodes {
-              ...CommentFields
-            }
-          }
+          ...DiscussionCommentFields
         }
       }
       labels(first: $firstLabels) {
@@ -47,3 +41,13 @@ fragment CommentFields on DiscussionComment {
   }
   url
 }
+
+fragment DiscussionCommentFields on DiscussionComment {
+  ...CommentFields
+  replies(last: $lastReplies) {
+    totalCount
+    nodes {
+      ...CommentFields
+    }
+  }
+}

src/renderer/utils/api/graphql/generated/gql.ts

@@ -35912,6 +35912,8 @@ export type AuthorFieldsFragment =
   | AuthorFields_User_Fragment
 ;
 
+export type MilestoneFieldsFragment = { __typename?: 'Milestone', state: MilestoneState, title: string };
+
 export type FetchDiscussionByNumberQueryVariables = Exact<{
   owner: Scalars['String']['input'];
   name: Scalars['String']['input'];
@@ -35951,6 +35953,20 @@ export type CommentFieldsFragment = { __typename?: 'DiscussionComment', database
     | { __typename?: 'User', login: string, html_url: any, avatar_url: any, type: 'User' }
    | null };
 
+export type DiscussionCommentFieldsFragment = { __typename?: 'DiscussionComment', databaseId?: number | null, createdAt: any, url: any, replies: { __typename?: 'DiscussionCommentConnection', totalCount: number, nodes?: Array<{ __typename?: 'DiscussionComment', databaseId?: number | null, createdAt: any, url: any, author?:
+        | { __typename?: 'Bot', login: string, html_url: any, avatar_url: any, type: 'Bot' }
+        | { __typename?: 'EnterpriseUserAccount', login: string, html_url: any, avatar_url: any, type: 'EnterpriseUserAccount' }
+        | { __typename?: 'Mannequin', login: string, html_url: any, avatar_url: any, type: 'Mannequin' }
+        | { __typename?: 'Organization', login: string, html_url: any, avatar_url: any, type: 'Organization' }
+        | { __typename?: 'User', login: string, html_url: any, avatar_url: any, type: 'User' }
+       | null } | null> | null }, author?:
+    | { __typename?: 'Bot', login: string, html_url: any, avatar_url: any, type: 'Bot' }
+    | { __typename?: 'EnterpriseUserAccount', login: string, html_url: any, avatar_url: any, type: 'EnterpriseUserAccount' }
+    | { __typename?: 'Mannequin', login: string, html_url: any, avatar_url: any, type: 'Mannequin' }
+    | { __typename?: 'Organization', login: string, html_url: any, avatar_url: any, type: 'Organization' }
+    | { __typename?: 'User', login: string, html_url: any, avatar_url: any, type: 'User' }
+   | null };
+
 export type FetchIssueByNumberQueryVariables = Exact<{
   owner: Scalars['String']['input'];
   name: Scalars['String']['input'];
@@ -35974,8 +35990,6 @@ export type FetchIssueByNumberQuery = { __typename?: 'Query', repository?: { __t
             | { __typename?: 'User', login: string, html_url: any, avatar_url: any, type: 'User' }
            | null } | null> | null }, labels?: { __typename?: 'LabelConnection', nodes?: Array<{ __typename?: 'Label', name: string } | null> | null } | null } | null } | null };
 
-export type MilestoneFieldsFragment = { __typename?: 'Milestone', state: MilestoneState, title: string };
-
 export type FetchPullRequestByNumberQueryVariables = Exact<{
   owner: Scalars['String']['input'];
   name: Scalars['String']['input'];
@@ -36007,6 +36021,14 @@ export type FetchPullRequestByNumberQuery = { __typename?: 'Query', repository?:
             | { __typename?: 'User', login: string }
            | null } | null> | null } | null, labels?: { __typename?: 'LabelConnection', nodes?: Array<{ __typename?: 'Label', name: string } | null> | null } | null, closingIssuesReferences?: { __typename?: 'IssueConnection', nodes?: Array<{ __typename?: 'Issue', number: number } | null> | null } | null } | null } | null };
 
+export type PullRequestReviewFieldsFragment = { __typename?: 'PullRequestReview', state: PullRequestReviewState, author?:
+    | { __typename?: 'Bot', login: string }
+    | { __typename?: 'EnterpriseUserAccount', login: string }
+    | { __typename?: 'Mannequin', login: string }
+    | { __typename?: 'Organization', login: string }
+    | { __typename?: 'User', login: string }
+   | null };
+
 export class TypedDocumentString<TResult, TVariables>
   extends String
   implements DocumentTypeDecoration<TResult, TVariables>
@@ -36025,6 +36047,12 @@ export class TypedDocumentString<TResult, TVariables>
     return this.value;
   }
 }
+export const MilestoneFieldsFragmentDoc = new TypedDocumentString(`
+    fragment MilestoneFields on Milestone {
+  state
+  title
+}
+    `, {"fragmentName":"MilestoneFields"}) as unknown as TypedDocumentString<MilestoneFieldsFragment, unknown>;
 export const AuthorFieldsFragmentDoc = new TypedDocumentString(`
     fragment AuthorFields on Actor {
   login
@@ -36048,12 +36076,38 @@ export const CommentFieldsFragmentDoc = new TypedDocumentString(`
   avatar_url: avatarUrl
   type: __typename
 }`, {"fragmentName":"CommentFields"}) as unknown as TypedDocumentString<CommentFieldsFragment, unknown>;
-export const MilestoneFieldsFragmentDoc = new TypedDocumentString(`
-    fragment MilestoneFields on Milestone {
+export const DiscussionCommentFieldsFragmentDoc = new TypedDocumentString(`
+    fragment DiscussionCommentFields on DiscussionComment {
+  ...CommentFields
+  replies(last: $lastReplies) {
+    totalCount
+    nodes {
+      ...CommentFields
+    }
+  }
+}
+    fragment AuthorFields on Actor {
+  login
+  html_url: url
+  avatar_url: avatarUrl
+  type: __typename
+}
+fragment CommentFields on DiscussionComment {
+  databaseId
+  createdAt
+  author {
+    ...AuthorFields
+  }
+  url
+}`, {"fragmentName":"DiscussionCommentFields"}) as unknown as TypedDocumentString<DiscussionCommentFieldsFragment, unknown>;
+export const PullRequestReviewFieldsFragmentDoc = new TypedDocumentString(`
+    fragment PullRequestReviewFields on PullRequestReview {
   state
-  title
+  author {
+    login
+  }
 }
-    `, {"fragmentName":"MilestoneFields"}) as unknown as TypedDocumentString<MilestoneFieldsFragment, unknown>;
+    `, {"fragmentName":"PullRequestReviewFields"}) as unknown as TypedDocumentString<PullRequestReviewFieldsFragment, unknown>;
 export const FetchDiscussionByNumberDocument = new TypedDocumentString(`
     query FetchDiscussionByNumber($owner: String!, $name: String!, $number: Int!, $lastComments: Int, $lastReplies: Int, $firstLabels: Int, $includeIsAnswered: Boolean!) {
   repository(owner: $owner, name: $name) {
@@ -36070,13 +36124,7 @@ export const FetchDiscussionByNumberDocument = new TypedDocumentString(`
       comments(last: $lastComments) {
         totalCount
         nodes {
-          ...CommentFields
-          replies(last: $lastReplies) {
-            totalCount
-            nodes {
-              ...CommentFields
-            }
-          }
+          ...DiscussionCommentFields
         }
       }
       labels(first: $firstLabels) {
@@ -36100,6 +36148,15 @@ fragment CommentFields on DiscussionComment {
     ...AuthorFields
   }
   url
+}
+fragment DiscussionCommentFields on DiscussionComment {
+  ...CommentFields
+  replies(last: $lastReplies) {
+    totalCount
+    nodes {
+      ...CommentFields
+    }
+  }
 }`) as unknown as TypedDocumentString<FetchDiscussionByNumberQuery, FetchDiscussionByNumberQueryVariables>;
 export const FetchIssueByNumberDocument = new TypedDocumentString(`
     query FetchIssueByNumber($owner: String!, $name: String!, $number: Int!, $lastComments: Int, $firstLabels: Int) {
@@ -36174,10 +36231,7 @@ export const FetchPullRequestByNumberDocument = new TypedDocumentString(`
       reviews(last: $lastReviews) {
         totalCount
         nodes {
-          state
-          author {
-            login
-          }
+          ...PullRequestReviewFields
         }
       }
       labels(first: $firstLabels) {
@@ -36202,4 +36256,10 @@ export const FetchPullRequestByNumberDocument = new TypedDocumentString(`
 fragment MilestoneFields on Milestone {
   state
   title
+}
+fragment PullRequestReviewFields on PullRequestReview {
+  state
+  author {
+    login
+  }
 }`) as unknown as TypedDocumentString<FetchPullRequestByNumberQuery, FetchPullRequestByNumberQueryVariables>;

src/renderer/utils/api/graphql/generated/graphql.ts

@@ -36,8 +36,3 @@ query FetchIssueByNumber(
     }
   }
 }
-
-fragment MilestoneFields on Milestone {
-  state
-  title
-}

src/renderer/utils/api/graphql/issue.graphql

@@ -35,10 +35,7 @@ query FetchPullRequestByNumber(
       reviews(last: $lastReviews) {
         totalCount
         nodes {
-          state
-          author {
-            login
-          }
+          ...PullRequestReviewFields
         }
       }
       labels(first: $firstLabels) {
@@ -55,7 +52,9 @@ query FetchPullRequestByNumber(
   }
 }
 
-fragment MilestoneFields on Milestone {
+fragment PullRequestReviewFields on PullRequestReview {
   state
-  title
+  author {
+    login
+  }
 }

src/renderer/utils/api/graphql/pull.graphql

@@ -21,24 +21,11 @@ import type { Notification, Subject } from '../../../typesGitHub';
 import { fetchDiscussionByNumber } from '../../api/client';
 import type {
   CommentFieldsFragment,
-  FetchDiscussionByNumberQuery,
+  DiscussionCommentFieldsFragment,
 } from '../../api/graphql/generated/graphql';
 import { DefaultHandler, defaultHandler } from './default';
 import { getNotificationAuthor } from './utils';
 
-type DiscussionComment = NonNullable<
-  NonNullable<
-    NonNullable<
-      NonNullable<
-        Extract<
-          NonNullable<FetchDiscussionByNumberQuery['repository']>,
-          { __typename?: 'Repository' }
-        >['discussion']
-      >
-    >['comments']['nodes']
-  >[number]
->;
-
 class DiscussionHandler extends DefaultHandler {
   readonly type = 'Discussion';
 
@@ -112,7 +99,7 @@ export const discussionHandler = new DiscussionHandler();
 
 export function getClosestDiscussionCommentOrReply(
   notification: Notification,
-  comments: DiscussionComment[],
+  comments: DiscussionCommentFieldsFragment[],
 ): CommentFieldsFragment | null {
   if (!comments || comments.length === 0) {
     return null;

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

@@ -19,13 +19,10 @@ import {
 } from '../../../types';
 import type { Notification, Subject } from '../../../typesGitHub';
 import { fetchPullByNumber } from '../../api/client';
-import type { FetchPullRequestByNumberQuery } from '../../api/graphql/generated/graphql';
+import type { PullRequestReviewFieldsFragment } from '../../api/graphql/generated/graphql';
 import { DefaultHandler, defaultHandler } from './default';
 import { getNotificationAuthor } from './utils';
 
-type PullRequestReviews =
-  FetchPullRequestByNumberQuery['repository']['pullRequest']['reviews']['nodes'];
-
 class PullRequestHandler extends DefaultHandler {
   readonly type = 'PullRequest' as const;
 
@@ -104,7 +101,7 @@ class PullRequestHandler extends DefaultHandler {
 export const pullRequestHandler = new PullRequestHandler();
 
 export function getLatestReviewForReviewers(
-  reviews: PullRequestReviews,
+  reviews: PullRequestReviewFieldsFragment[],
 ): GitifyPullRequestReview[] {
   if (!reviews.length) {
     return null;