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

setchy · setchy · commit fc37b54625e9 · 2025-12-22T07:25:36.000+10:00
Signed-off-by: Adam Setch &lt;adam.setch@outlook.com&gt;
diff --git a/src/renderer/typesGitHub.ts b/src/renderer/typesGitHub.ts
@@ -4,6 +4,7 @@ import type {
   IssueState,
   IssueStateReason,
   MilestoneFieldsFragment,
+  PullRequestReviewState,
   PullRequestState,
 } from './utils/api/graphql/generated/graphql';
 
@@ -87,13 +88,6 @@ export type CheckSuiteStatus =
   | 'timed_out'
   | 'waiting';
 
-export type PullRequestReviewState =
-  | 'APPROVED'
-  | 'CHANGES_REQUESTED'
-  | 'COMMENTED'
-  | 'DISMISSED'
-  | 'PENDING';
-
 export type PullRequestReviewAuthorAssociation =
   | 'COLLABORATOR'
   | 'CONTRIBUTOR'
@@ -278,19 +272,6 @@ export interface GitifyPullRequestReview {
   users: string[];
 }
 
-export interface PullRequestReview {
-  id: number;
-  node_id: string;
-  user: User;
-  body: string;
-  state: PullRequestReviewState;
-  html_url: Link;
-  pull_request_url: Link;
-  author_association: PullRequestReviewAuthorAssociation;
-  submitted_at: string;
-  commit_id: string;
-}
-
 export interface Commit {
   sha: string;
   node_id: string;
diff --git a/src/renderer/utils/api/__mocks__/response-mocks.ts b/src/renderer/utils/api/__mocks__/response-mocks.ts
@@ -4,7 +4,10 @@ import {
 } from '../../../__mocks__/account-mocks';
 import type { Link } from '../../../types';
 import type { Notification, Repository, User } from '../../../typesGitHub';
-import type { FetchDiscussionByNumberQuery } from '../graphql/generated/graphql';
+import {
+  type FetchDiscussionByNumberQuery,
+  PullRequestReviewState,
+} from '../graphql/generated/graphql';
 
 export const mockNotificationUser: User = {
   login: 'octocat',
@@ -59,15 +62,15 @@ export const mockGitHubNotifications: Notification[] = [
       },
       reviews: [
         {
-          state: 'APPROVED',
+          state: PullRequestReviewState.Approved,
           users: ['octocat'],
         },
         {
-          state: 'CHANGES_REQUESTED',
+          state: PullRequestReviewState.ChangesRequested,
           users: ['gitify-app'],
         },
         {
-          state: 'PENDING',
+          state: PullRequestReviewState.Pending,
           users: ['gitify-user'],
         },
       ],
diff --git a/src/renderer/utils/api/graphql/generated/gql.ts b/src/renderer/utils/api/graphql/generated/gql.ts
@@ -18,13 +18,13 @@ type Documents = {
     "fragment AuthorFields on Actor {\n  login\n  html_url: url\n  avatar_url: avatarUrl\n  type: __typename\n}": typeof types.AuthorFieldsFragmentDoc,
     "query FetchDiscussionByNumber($owner: String!, $name: String!, $number: Int!, $lastComments: Int, $lastReplies: Int, $firstLabels: Int, $includeIsAnswered: Boolean!) {\n  repository(owner: $owner, name: $name) {\n    discussion(number: $number) {\n      __typename\n      number\n      title\n      stateReason\n      isAnswered @include(if: $includeIsAnswered)\n      url\n      author {\n        ...AuthorFields\n      }\n      comments(last: $lastComments) {\n        totalCount\n        nodes {\n          ...CommentFields\n          replies(last: $lastReplies) {\n            nodes {\n              ...CommentFields\n            }\n          }\n        }\n      }\n      labels(first: $firstLabels) {\n        nodes {\n          name\n        }\n      }\n    }\n  }\n}\n\nfragment CommentFields on DiscussionComment {\n  databaseId\n  createdAt\n  author {\n    ...AuthorFields\n  }\n  url\n}": typeof types.FetchDiscussionByNumberDocument,
     "query FetchIssueByNumber($owner: String!, $name: String!, $number: Int!, $firstLabels: Int) {\n  repository(owner: $owner, name: $name) {\n    issue(number: $number) {\n      __typename\n      number\n      title\n      url\n      state\n      stateReason\n      milestone {\n        ...MilestoneFields\n      }\n      author {\n        ...AuthorFields\n      }\n      comments(last: 1) {\n        totalCount\n        nodes {\n          url\n          author {\n            ...AuthorFields\n          }\n        }\n      }\n      labels(first: $firstLabels) {\n        nodes {\n          name\n        }\n      }\n    }\n  }\n}\n\nfragment MilestoneFields on Milestone {\n  state\n  title\n}": typeof types.FetchIssueByNumberDocument,
-    "query FetchPullByNumber($owner: String!, $name: String!, $number: Int!, $firstLabels: Int) {\n  repository(owner: $owner, name: $name) {\n    pullRequest(number: $number) {\n      __typename\n      number\n      title\n      url\n      state\n      merged\n      isDraft\n      isInMergeQueue\n      milestone {\n        ...MilestoneFields\n      }\n      author {\n        ...AuthorFields\n      }\n      comments(last: 1) {\n        totalCount\n        nodes {\n          url\n          author {\n            ...AuthorFields\n          }\n        }\n      }\n      reviews(last: 1) {\n        totalCount\n        nodes {\n          url\n          createdAt\n          author {\n            login\n          }\n        }\n      }\n      labels(first: $firstLabels) {\n        nodes {\n          name\n        }\n      }\n      closingIssuesReferences(first: 50) {\n        nodes {\n          number\n        }\n      }\n    }\n  }\n}\n\nfragment MilestoneFields on Milestone {\n  state\n  title\n}": typeof types.FetchPullByNumberDocument,
+    "query FetchPullByNumber($owner: String!, $name: String!, $number: Int!, $firstLabels: Int) {\n  repository(owner: $owner, name: $name) {\n    pullRequest(number: $number) {\n      __typename\n      number\n      title\n      url\n      state\n      merged\n      isDraft\n      isInMergeQueue\n      milestone {\n        ...MilestoneFields\n      }\n      author {\n        ...AuthorFields\n      }\n      comments(last: 1) {\n        totalCount\n        nodes {\n          url\n          author {\n            ...AuthorFields\n          }\n        }\n      }\n      reviews(last: 100) {\n        totalCount\n        nodes {\n          state\n          author {\n            login\n          }\n        }\n      }\n      labels(first: $firstLabels) {\n        nodes {\n          name\n        }\n      }\n      closingIssuesReferences(first: 50) {\n        nodes {\n          number\n        }\n      }\n    }\n  }\n}\n\nfragment MilestoneFields on Milestone {\n  state\n  title\n}": typeof types.FetchPullByNumberDocument,
 };
 const documents: Documents = {
     "fragment AuthorFields on Actor {\n  login\n  html_url: url\n  avatar_url: avatarUrl\n  type: __typename\n}": types.AuthorFieldsFragmentDoc,
     "query FetchDiscussionByNumber($owner: String!, $name: String!, $number: Int!, $lastComments: Int, $lastReplies: Int, $firstLabels: Int, $includeIsAnswered: Boolean!) {\n  repository(owner: $owner, name: $name) {\n    discussion(number: $number) {\n      __typename\n      number\n      title\n      stateReason\n      isAnswered @include(if: $includeIsAnswered)\n      url\n      author {\n        ...AuthorFields\n      }\n      comments(last: $lastComments) {\n        totalCount\n        nodes {\n          ...CommentFields\n          replies(last: $lastReplies) {\n            nodes {\n              ...CommentFields\n            }\n          }\n        }\n      }\n      labels(first: $firstLabels) {\n        nodes {\n          name\n        }\n      }\n    }\n  }\n}\n\nfragment CommentFields on DiscussionComment {\n  databaseId\n  createdAt\n  author {\n    ...AuthorFields\n  }\n  url\n}": types.FetchDiscussionByNumberDocument,
     "query FetchIssueByNumber($owner: String!, $name: String!, $number: Int!, $firstLabels: Int) {\n  repository(owner: $owner, name: $name) {\n    issue(number: $number) {\n      __typename\n      number\n      title\n      url\n      state\n      stateReason\n      milestone {\n        ...MilestoneFields\n      }\n      author {\n        ...AuthorFields\n      }\n      comments(last: 1) {\n        totalCount\n        nodes {\n          url\n          author {\n            ...AuthorFields\n          }\n        }\n      }\n      labels(first: $firstLabels) {\n        nodes {\n          name\n        }\n      }\n    }\n  }\n}\n\nfragment MilestoneFields on Milestone {\n  state\n  title\n}": types.FetchIssueByNumberDocument,
-    "query FetchPullByNumber($owner: String!, $name: String!, $number: Int!, $firstLabels: Int) {\n  repository(owner: $owner, name: $name) {\n    pullRequest(number: $number) {\n      __typename\n      number\n      title\n      url\n      state\n      merged\n      isDraft\n      isInMergeQueue\n      milestone {\n        ...MilestoneFields\n      }\n      author {\n        ...AuthorFields\n      }\n      comments(last: 1) {\n        totalCount\n        nodes {\n          url\n          author {\n            ...AuthorFields\n          }\n        }\n      }\n      reviews(last: 1) {\n        totalCount\n        nodes {\n          url\n          createdAt\n          author {\n            login\n          }\n        }\n      }\n      labels(first: $firstLabels) {\n        nodes {\n          name\n        }\n      }\n      closingIssuesReferences(first: 50) {\n        nodes {\n          number\n        }\n      }\n    }\n  }\n}\n\nfragment MilestoneFields on Milestone {\n  state\n  title\n}": types.FetchPullByNumberDocument,
+    "query FetchPullByNumber($owner: String!, $name: String!, $number: Int!, $firstLabels: Int) {\n  repository(owner: $owner, name: $name) {\n    pullRequest(number: $number) {\n      __typename\n      number\n      title\n      url\n      state\n      merged\n      isDraft\n      isInMergeQueue\n      milestone {\n        ...MilestoneFields\n      }\n      author {\n        ...AuthorFields\n      }\n      comments(last: 1) {\n        totalCount\n        nodes {\n          url\n          author {\n            ...AuthorFields\n          }\n        }\n      }\n      reviews(last: 100) {\n        totalCount\n        nodes {\n          state\n          author {\n            login\n          }\n        }\n      }\n      labels(first: $firstLabels) {\n        nodes {\n          name\n        }\n      }\n      closingIssuesReferences(first: 50) {\n        nodes {\n          number\n        }\n      }\n    }\n  }\n}\n\nfragment MilestoneFields on Milestone {\n  state\n  title\n}": types.FetchPullByNumberDocument,
 };
 
 /**
@@ -42,7 +42,7 @@ export function graphql(source: "query FetchIssueByNumber($owner: String!, $name
 /**
  * The graphql function is used to parse GraphQL queries into a document that can be used by GraphQL clients.
  */
-export function graphql(source: "query FetchPullByNumber($owner: String!, $name: String!, $number: Int!, $firstLabels: Int) {\n  repository(owner: $owner, name: $name) {\n    pullRequest(number: $number) {\n      __typename\n      number\n      title\n      url\n      state\n      merged\n      isDraft\n      isInMergeQueue\n      milestone {\n        ...MilestoneFields\n      }\n      author {\n        ...AuthorFields\n      }\n      comments(last: 1) {\n        totalCount\n        nodes {\n          url\n          author {\n            ...AuthorFields\n          }\n        }\n      }\n      reviews(last: 1) {\n        totalCount\n        nodes {\n          url\n          createdAt\n          author {\n            login\n          }\n        }\n      }\n      labels(first: $firstLabels) {\n        nodes {\n          name\n        }\n      }\n      closingIssuesReferences(first: 50) {\n        nodes {\n          number\n        }\n      }\n    }\n  }\n}\n\nfragment MilestoneFields on Milestone {\n  state\n  title\n}"): typeof import('./graphql').FetchPullByNumberDocument;
+export function graphql(source: "query FetchPullByNumber($owner: String!, $name: String!, $number: Int!, $firstLabels: Int) {\n  repository(owner: $owner, name: $name) {\n    pullRequest(number: $number) {\n      __typename\n      number\n      title\n      url\n      state\n      merged\n      isDraft\n      isInMergeQueue\n      milestone {\n        ...MilestoneFields\n      }\n      author {\n        ...AuthorFields\n      }\n      comments(last: 1) {\n        totalCount\n        nodes {\n          url\n          author {\n            ...AuthorFields\n          }\n        }\n      }\n      reviews(last: 100) {\n        totalCount\n        nodes {\n          state\n          author {\n            login\n          }\n        }\n      }\n      labels(first: $firstLabels) {\n        nodes {\n          name\n        }\n      }\n      closingIssuesReferences(first: 50) {\n        nodes {\n          number\n        }\n      }\n    }\n  }\n}\n\nfragment MilestoneFields on Milestone {\n  state\n  title\n}"): typeof import('./graphql').FetchPullByNumberDocument;
 
 
 export function graphql(source: string) {
diff --git a/src/renderer/utils/api/graphql/generated/graphql.ts b/src/renderer/utils/api/graphql/generated/graphql.ts
@@ -36269,7 +36269,7 @@ export type FetchPullByNumberQuery = { __typename?: 'Query', repository?: { __ty
             | { __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 }, reviews?: { __typename?: 'PullRequestReviewConnection', totalCount: number, nodes?: Array<{ __typename?: 'PullRequestReview', url: any, createdAt: any, author?:
+           | null } | null> | null }, reviews?: { __typename?: 'PullRequestReviewConnection', totalCount: number, nodes?: Array<{ __typename?: 'PullRequestReview', state: PullRequestReviewState, author?:
             | { __typename?: 'Bot', login: string }
             | { __typename?: 'EnterpriseUserAccount', login: string }
             | { __typename?: 'Mannequin', login: string }
@@ -36440,11 +36440,10 @@ export const FetchPullByNumberDocument = new TypedDocumentString(`
           }
         }
       }
-      reviews(last: 1) {
+      reviews(last: 100) {
         totalCount
         nodes {
-          url
-          createdAt
+          state
           author {
             login
           }
diff --git a/src/renderer/utils/api/graphql/pull.graphql b/src/renderer/utils/api/graphql/pull.graphql
@@ -29,11 +29,10 @@ query FetchPullByNumber(
           }
         }
       }
-      reviews(last: 1) {
+      reviews(last: 100) {
         totalCount
         nodes {
-          url
-          createdAt
+          state
           author {
             login
           }
diff --git a/src/renderer/utils/icons.test.ts b/src/renderer/utils/icons.test.ts
@@ -9,6 +9,7 @@ import {
 
 import { IconColor } from '../types';
 import type { GitifyPullRequestReview } from '../typesGitHub';
+import { PullRequestReviewState } from './api/graphql/generated/graphql';
 import {
   getAuthMethodIcon,
   getDefaultUserIcon,
@@ -23,18 +24,18 @@ describe('renderer/utils/icons.ts', () => {
 
     beforeEach(() => {
       mockReviewSingleReviewer = {
-        state: 'APPROVED',
+        state: PullRequestReviewState.Approved,
         users: ['user1'],
       };
       mockReviewMultipleReviewer = {
-        state: 'APPROVED',
+        state: PullRequestReviewState.Approved,
         users: ['user1', 'user2'],
       };
     });
 
     it('approved', () => {
-      mockReviewSingleReviewer.state = 'APPROVED';
-      mockReviewMultipleReviewer.state = 'APPROVED';
+      mockReviewSingleReviewer.state = PullRequestReviewState.Approved;
+      mockReviewMultipleReviewer.state = PullRequestReviewState.Approved;
 
       expect(getPullRequestReviewIcon(mockReviewSingleReviewer)).toEqual({
         type: CheckIcon,
@@ -50,8 +51,9 @@ describe('renderer/utils/icons.ts', () => {
     });
 
     it('changes requested', () => {
-      mockReviewSingleReviewer.state = 'CHANGES_REQUESTED';
-      mockReviewMultipleReviewer.state = 'CHANGES_REQUESTED';
+      mockReviewSingleReviewer.state = PullRequestReviewState.ChangesRequested;
+      mockReviewMultipleReviewer.state =
+        PullRequestReviewState.ChangesRequested;
 
       expect(getPullRequestReviewIcon(mockReviewSingleReviewer)).toEqual({
         type: FileDiffIcon,
@@ -67,8 +69,8 @@ describe('renderer/utils/icons.ts', () => {
     });
 
     it('commented', () => {
-      mockReviewSingleReviewer.state = 'COMMENTED';
-      mockReviewMultipleReviewer.state = 'COMMENTED';
+      mockReviewSingleReviewer.state = PullRequestReviewState.Commented;
+      mockReviewMultipleReviewer.state = PullRequestReviewState.Commented;
 
       expect(getPullRequestReviewIcon(mockReviewSingleReviewer)).toEqual({
         type: CommentIcon,
@@ -84,8 +86,8 @@ describe('renderer/utils/icons.ts', () => {
     });
 
     it('dismissed', () => {
-      mockReviewSingleReviewer.state = 'DISMISSED';
-      mockReviewMultipleReviewer.state = 'DISMISSED';
+      mockReviewSingleReviewer.state = PullRequestReviewState.Dismissed;
+      mockReviewMultipleReviewer.state = PullRequestReviewState.Dismissed;
 
       expect(getPullRequestReviewIcon(mockReviewSingleReviewer)).toEqual({
         type: CommentIcon,
@@ -101,8 +103,8 @@ describe('renderer/utils/icons.ts', () => {
     });
 
     it('pending', () => {
-      mockReviewSingleReviewer.state = 'PENDING';
-      mockReviewMultipleReviewer.state = 'PENDING';
+      mockReviewSingleReviewer.state = PullRequestReviewState.Pending;
+      mockReviewMultipleReviewer.state = PullRequestReviewState.Pending;
 
       expect(getPullRequestReviewIcon(mockReviewSingleReviewer)).toBeNull();
 
diff --git a/src/renderer/utils/links.ts b/src/renderer/utils/links.ts
@@ -5,10 +5,7 @@ import type { Account, Hostname, Link } from '../types';
 import type { Notification, Repository, SubjectUser } from '../typesGitHub';
 import { getDeveloperSettingsURL } from './auth/utils';
 import { openExternalLink } from './comms';
-import {
-  generateGitHubWebUrl,
-  generateNotificationReferrerId,
-} from './helpers';
+import { generateGitHubWebUrl } from './helpers';
 
 export function openGitifyReleaseNotes(version: string) {
   openExternalLink(
@@ -58,14 +55,8 @@ export function openRepository(repository: Repository) {
 }
 
 export async function openNotification(notification: Notification) {
-  const url = new URL(await generateGitHubWebUrl(notification));
-
-  url.searchParams.set(
-    'notification_referrer_id',
-    generateNotificationReferrerId(notification),
-  );
-
-  openExternalLink(url.toString() as Link);
+  const url = await generateGitHubWebUrl(notification);
+  openExternalLink(url);
 }
 
 export function openGitHubParticipatingDocs() {
diff --git a/src/renderer/utils/notifications/handlers/discussion.ts b/src/renderer/utils/notifications/handlers/discussion.ts
@@ -16,7 +16,6 @@ import type {
   GitifySubject,
   Notification,
   Subject,
-  SubjectUser,
 } from '../../../typesGitHub';
 import { fetchDiscussionByNumber } from '../../api/client';
 import type {
@@ -25,6 +24,7 @@ import type {
 } from '../../api/graphql/generated/graphql';
 import { isStateFilteredOut } from '../filters/filter';
 import { DefaultHandler } from './default';
+import { getSubjectAuthor } from './utils';
 
 type DiscussionComment = NonNullable<
   NonNullable<
@@ -57,9 +57,7 @@ class DiscussionHandler extends DefaultHandler {
 
     if (discussion.isAnswered) {
       discussionState = 'ANSWERED';
-    }
-
-    if (discussion.stateReason) {
+    } else if (discussion.stateReason) {
       discussionState = discussion.stateReason;
     }
 
@@ -73,26 +71,13 @@ class DiscussionHandler extends DefaultHandler {
       discussion.comments.nodes,
     );
 
-    let discussionUser: SubjectUser = {
-      login: discussion.author.login,
-      html_url: discussion.author.html_url,
-      avatar_url: discussion.author.avatar_url,
-      type: discussion.author.type,
-    };
-
-    if (latestDiscussionComment) {
-      discussionUser = {
-        login: latestDiscussionComment.author.login,
-        html_url: latestDiscussionComment.author.html_url,
-        avatar_url: latestDiscussionComment.author.avatar_url,
-        type: latestDiscussionComment.author.type,
-      };
-    }
-
     return {
       number: discussion.number,
       state: discussionState,
-      user: discussionUser,
+      user: getSubjectAuthor([
+        latestDiscussionComment.author,
+        discussion.author,
+      ]),
       comments: discussion.comments.totalCount,
       labels: discussion.labels?.nodes.map((label) => label.name) ?? [],
       htmlUrl: latestDiscussionComment.url ?? discussion.url,
diff --git a/src/renderer/utils/notifications/handlers/issue.ts b/src/renderer/utils/notifications/handlers/issue.ts
diff --git a/src/renderer/utils/notifications/handlers/pullRequest.test.ts b/src/renderer/utils/notifications/handlers/pullRequest.test.ts
diff --git a/src/renderer/utils/notifications/handlers/pullRequest.ts b/src/renderer/utils/notifications/handlers/pullRequest.ts

Original file line number	Diff line number	Diff line change
`@@ -36269,7 +36269,7 @@ export type FetchPullByNumberQuery = { __typename?: 'Query', repository?: { __ty`
`36269`	`36269`	`\| { __typename?: 'Mannequin', login: string, html_url: any, avatar_url: any, type: 'Mannequin' }`
`36270`	`36270`	`\| { __typename?: 'Organization', login: string, html_url: any, avatar_url: any, type: 'Organization' }`
`36271`	`36271`	`\| { __typename?: 'User', login: string, html_url: any, avatar_url: any, type: 'User' }`
`36272`		`- \| null } \| null> \| null }, reviews?: { __typename?: 'PullRequestReviewConnection', totalCount: number, nodes?: Array<{ __typename?: 'PullRequestReview', url: any, createdAt: any, author?:`
	`36272`	`+ \| null } \| null> \| null }, reviews?: { __typename?: 'PullRequestReviewConnection', totalCount: number, nodes?: Array<{ __typename?: 'PullRequestReview', state: PullRequestReviewState, author?:`
`36273`	`36273`	`\| { __typename?: 'Bot', login: string }`
`36274`	`36274`	`\| { __typename?: 'EnterpriseUserAccount', login: string }`
`36275`	`36275`	`\| { __typename?: 'Mannequin', login: string }`
@@ -36440,11 +36440,10 @@ export const FetchPullByNumberDocument = new TypedDocumentString(`
`36440`	`36440`	`}`
`36441`	`36441`	`}`
`36442`	`36442`	`}`
`36443`		`- reviews(last: 1) {`
	`36443`	`+ reviews(last: 100) {`
`36444`	`36444`	`totalCount`
`36445`	`36445`	`nodes {`
`36446`		`- url`
`36447`		`- createdAt`
	`36446`	`+ state`
`36448`	`36447`	`author {`
`36449`	`36448`	`login`
`36450`	`36449`	`}`
Original file line number	Diff line number	Diff line change
`@@ -29,11 +29,10 @@ query FetchPullByNumber(`
`29`	`29`	`}`
`30`	`30`	`}`
`31`	`31`	`}`
`32`		`- reviews(last: 1) {`
	`32`	`+ reviews(last: 100) {`
`33`	`33`	`totalCount`
`34`	`34`	`nodes {`
`35`		`- url`
`36`		`- createdAt`
	`35`	`+ state`
`37`	`36`	`author {`
`38`	`37`	`login`
`39`	`38`	`}`