refactor: extract discussions api calls into client (#1085)

* refactor: extract discussions api calls into api/client

* fix query

* update query variable name

* update comments

Author: setchy

package.json

@@ -138,6 +138,7 @@
     "css-loader": "7.1.1",
     "electron": "30.0.1",
     "electron-builder": "24.13.3",
+    "graphql-tag": "2.12.6",
     "husky": "9.0.11",
     "jest": "29.7.0",
     "jest-environment-jsdom": "29.7.0",

pnpm-lock.yaml

@@ -473,41 +473,37 @@ export const mockDiscussionComments: DiscussionComments = {
 
 export const mockedGraphQLResponse: GraphQLSearch<Discussion> = {
   data: {
-    data: {
-      search: {
-        nodes: [
-          {
-            viewerSubscription: 'SUBSCRIBED',
-            title: '1.16.0',
-            isAnswered: false,
-            stateReason: 'OPEN',
-            url: 'https://github.com/gitify-app/notifications-test/discussions/612',
-            author: {
-              login: 'discussion-creator',
-              url: 'https://github.com/discussion-creator',
-              avatar_url:
-                'https://avatars.githubusercontent.com/u/123456789?v=4',
-              type: 'User',
-            },
-            comments: mockDiscussionComments,
+    search: {
+      nodes: [
+        {
+          viewerSubscription: 'SUBSCRIBED',
+          title: '1.16.0',
+          isAnswered: false,
+          stateReason: 'OPEN',
+          url: 'https://github.com/gitify-app/notifications-test/discussions/612',
+          author: {
+            login: 'discussion-creator',
+            url: 'https://github.com/discussion-creator',
+            avatar_url: 'https://avatars.githubusercontent.com/u/123456789?v=4',
+            type: 'User',
           },
-          {
-            viewerSubscription: 'IGNORED',
-            title: '1.16.0',
-            isAnswered: false,
-            stateReason: 'ANSWERED',
-            url: 'https://github.com/gitify-app/notifications-test/discussions/123',
-            author: {
-              login: 'discussion-creator',
-              url: 'https://github.com/discussion-creator',
-              avatar_url:
-                'https://avatars.githubusercontent.com/u/123456789?v=4',
-              type: 'User',
-            },
-            comments: mockDiscussionComments,
+          comments: mockDiscussionComments,
+        },
+        {
+          viewerSubscription: 'IGNORED',
+          title: '1.16.0',
+          isAnswered: false,
+          stateReason: 'ANSWERED',
+          url: 'https://github.com/gitify-app/notifications-test/discussions/123',
+          author: {
+            login: 'discussion-creator',
+            url: 'https://github.com/discussion-creator',
+            avatar_url: 'https://avatars.githubusercontent.com/u/123456789?v=4',
+            type: 'User',
           },
-        ],
-      },
+          comments: mockDiscussionComments,
+        },
+      ],
     },
   },
 };

src/__mocks__/mockedData.ts

@@ -407,10 +407,8 @@ export interface Release {
 
 export interface GraphQLSearch<T> {
   data: {
-    data: {
-      search: {
-        nodes: T[];
-      };
+    search: {
+      nodes: T[];
     };
   };
 }

src/typesGitHub.ts

@@ -3,6 +3,8 @@ import type { SettingsState } from '../../types';
 import type {
   Commit,
   CommitComment,
+  Discussion,
+  GraphQLSearch,
   Issue,
   IssueOrPullRequestComment,
   Notification,
@@ -15,6 +17,11 @@ import type {
 import { getGitHubAPIBaseUrl } from '../helpers';
 import { apiRequestAuth } from './request';
 
+import { print } from 'graphql/language/printer';
+import Constants from '../constants';
+import { QUERY_SEARCH_DISCUSSIONS } from './graphql/discussions';
+import { formatSearchQueryString } from './utils';
+
 /**
  * Get Hypermedia links to resources accessible in GitHub's REST API
  *
@@ -213,3 +220,28 @@ export async function getHtmlUrl(url: string, token: string): Promise<string> {
     console.error('Failed to get html url');
   }
 }
+
+/**
+ * Search for Discussions that match notification title and repository.
+ *
+ * Returns first 10 matching discussions and their latest comments / replies
+ *
+ */
+export async function searchDiscussions(
+  notification: Notification,
+  token: string,
+): AxiosPromise<GraphQLSearch<Discussion>> {
+  return apiRequestAuth(Constants.GITHUB_API_GRAPHQL_URL, 'POST', token, {
+    query: print(QUERY_SEARCH_DISCUSSIONS),
+    variables: {
+      queryStatement: formatSearchQueryString(
+        notification.repository.full_name,
+        notification.subject.title,
+        notification.updated_at,
+      ),
+      firstDiscussions: 10,
+      lastComments: 100,
+      lastReplies: 1,
+    },
+  });
+}

src/utils/api/client.ts

@@ -0,0 +1,59 @@
+import gql from 'graphql-tag';
+
+const FRAGMENT_AUTHOR = gql`
+  fragment AuthorFields on Actor {
+    login
+    url
+    avatar_url: avatarUrl
+    type: __typename
+  }
+`;
+
+const FRAGMENT_COMMENTS = gql`
+  fragment CommentFields on DiscussionComment {
+    databaseId
+    createdAt
+    author {
+      ...AuthorFields
+    }
+  }
+
+  ${FRAGMENT_AUTHOR}
+`;
+
+export const QUERY_SEARCH_DISCUSSIONS = gql`
+  query fetchDiscussions(
+    $queryStatement: String!,
+    $firstDiscussions: Int,
+    $lastComments: Int,
+    $lastReplies: Int
+  ) {
+    search(query:$queryStatement, type: DISCUSSION, first: $firstDiscussions) {
+      nodes {
+        ... on Discussion {
+          viewerSubscription
+          title
+          stateReason
+          isAnswered
+          url
+          author {
+            ...AuthorFields
+          }
+          comments(last: $lastComments){
+            nodes {
+              ...CommentFields
+              replies(last: $lastReplies) {
+                nodes {
+                  ...CommentFields
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+
+  ${FRAGMENT_AUTHOR}
+  ${FRAGMENT_COMMENTS}
+`;

src/utils/api/graphql/discussions.ts

@@ -0,0 +1,29 @@
+import { addHours, formatSearchQueryString } from './utils';
+
+describe('utils/api/utils.ts', () => {
+  describe('addHours', () => {
+    test('adds hours correctly for positive values', () => {
+      const result = addHours('2024-02-20T12:00:00.000Z', 3);
+      expect(result).toBe('2024-02-20T15:00:00.000Z');
+    });
+
+    test('adds hours correctly for negative values', () => {
+      const result = addHours('2024-02-20T12:00:00.000Z', -2);
+      expect(result).toBe('2024-02-20T10:00:00.000Z');
+    });
+  });
+
+  describe('formatSearchQueryString', () => {
+    test('formats search query string correctly', () => {
+      const result = formatSearchQueryString(
+        'exampleRepo',
+        'exampleTitle',
+        '2024-02-20T12:00:00.000Z',
+      );
+
+      expect(result).toBe(
+        'exampleTitle in:title repo:exampleRepo updated:>2024-02-20T10:00:00.000Z',
+      );
+    });
+  });
+});

src/utils/api/utils.test.ts

@@ -0,0 +1,11 @@
+export function formatSearchQueryString(
+  repo: string,
+  title: string,
+  lastUpdated: string,
+): string {
+  return `${title} in:title repo:${repo} updated:>${addHours(lastUpdated, -2)}`;
+}
+
+export function addHours(date: string, hours: number): string {
+  return new Date(new Date(date).getTime() + hours * 36e5).toISOString();
+}

src/utils/api/utils.ts

@@ -11,6 +11,7 @@ export const Constants = {
   },
 
   GITHUB_API_BASE_URL: 'https://api.github.com',
+  GITHUB_API_GRAPHQL_URL: 'https://api.github.com/graphql',
 
   REPO_SLUG: 'gitify-app/gitify',
 

src/utils/constants.ts

@@ -8,10 +8,8 @@ import {
 import type { SubjectType } from '../typesGitHub';
 import * as apiRequests from './api/request';
 import {
-  addHours,
   addNotificationReferrerIdToUrl,
   formatForDisplay,
-  formatSearchQueryString,
   generateGitHubWebUrl,
   generateNotificationReferrerId,
   getGitHubAPIBaseUrl,
@@ -102,33 +100,6 @@ describe('utils/helpers.ts', () => {
     });
   });
 
-  describe('addHours', () => {
-    // Example test using Jest
-    test('adds hours correctly for positive values', () => {
-      const result = addHours('2024-02-20T12:00:00.000Z', 3);
-      expect(result).toBe('2024-02-20T15:00:00.000Z');
-    });
-
-    test('adds hours correctly for negative values', () => {
-      const result = addHours('2024-02-20T12:00:00.000Z', -2);
-      expect(result).toBe('2024-02-20T10:00:00.000Z');
-    });
-  });
-
-  describe('formatSearchQueryString', () => {
-    test('formats search query string correctly', () => {
-      const result = formatSearchQueryString(
-        'exampleRepo',
-        'exampleTitle',
-        '2024-02-20T12:00:00.000Z',
-      );
-
-      expect(result).toBe(
-        'exampleTitle in:title repo:exampleRepo updated:>2024-02-20T10:00:00.000Z',
-      );
-    });
-  });
-
   describe('generateGitHubWebUrl', () => {
     const mockedHtmlUrl =
       'https://github.com/gitify-app/notifications-test/issues/785';
@@ -398,7 +369,7 @@ describe('utils/helpers.ts', () => {
         );
       });
 
-      it('when no subject urls and no discussions found via query, default to linking to repository discussions', async () => {
+      it('link to matching discussion and comment hash', async () => {
         const subject = {
           title: '1.16.0',
           url: null,
@@ -407,7 +378,11 @@ describe('utils/helpers.ts', () => {
         };
 
         const requestPromise = new Promise((resolve) =>
-          resolve(mockedGraphQLResponse as AxiosResponse),
+          resolve({
+            data: {
+              ...mockedGraphQLResponse,
+            },
+          } as AxiosResponse),
         ) as AxiosPromise;
 
         apiRequestAuthMock.mockResolvedValue(requestPromise);