feat(api): merge query

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

Author: setchy

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

@@ -34,6 +34,7 @@ class CheckSuiteHandler extends DefaultHandler {
   async enrich(
     notification: Notification,
     _settings: SettingsState,
+    _fetchedData?: unknown,
   ): Promise<GitifySubject> {
     const state = getCheckSuiteAttributes(notification)?.status;
 

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

@@ -21,6 +21,7 @@ class CommitHandler extends DefaultHandler {
   async enrich(
     notification: Notification,
     settings: SettingsState,
+    _fetchedData?: unknown,
   ): Promise<GitifySubject> {
     const commitState: GitifyNotificationState = null; // Commit notifications are stateless
 

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

@@ -16,13 +16,17 @@ export class DefaultHandler implements NotificationTypeHandler {
     return null;
   }
 
-  async enrich(
-    _notification: Notification,
-    _settings: SettingsState,
-  ): Promise<GitifySubject> {
+  async enrich(_fetchedData?: unknown): Promise<GitifySubject> {
     return null;
   }
 
+  async fetchAndEnrich(
+    notification: Notification,
+    settings: SettingsState,
+  ): Promise<GitifySubject> {
+    return this.enrich(notification, settings, undefined);
+  }
+
   iconType(_subject: Subject): FC<OcticonProps> | null {
     return QuestionIcon;
   }

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

@@ -22,6 +22,7 @@ import { fetchDiscussionByNumber } from '../../api/client';
 import type {
   CommentFieldsFragment,
   DiscussionCommentFieldsFragment,
+  DiscussionDetailsFragment,
 } from '../../api/graphql/generated/graphql';
 import { DefaultHandler, defaultHandler } from './default';
 import { getNotificationAuthor } from './utils';
@@ -32,9 +33,11 @@ class DiscussionHandler extends DefaultHandler {
   async enrich(
     notification: Notification,
     _settings: SettingsState,
+    fetchedData?: DiscussionDetailsFragment,
   ): Promise<GitifySubject> {
-    const response = await fetchDiscussionByNumber(notification);
-    const discussion = response.data.repository?.discussion;
+    const discussion =
+      fetchedData ??
+      (await fetchDiscussionByNumber(notification)).data.repository?.discussion;
 
     let discussionState: GitifyDiscussionState = 'OPEN';
 

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

@@ -17,6 +17,7 @@ import type {
 import { IconColor } from '../../../types';
 import type { Notification, Subject } from '../../../typesGitHub';
 import { fetchIssueByNumber } from '../../api/client';
+import type { IssueDetailsFragment } from '../../api/graphql/generated/graphql';
 import { DefaultHandler, defaultHandler } from './default';
 import { getNotificationAuthor } from './utils';
 
@@ -26,9 +27,9 @@ class IssueHandler extends DefaultHandler {
   async enrich(
     notification: Notification,
     _settings: SettingsState,
+    fetchedData?: IssueDetailsFragment,
   ): Promise<GitifySubject> {
-    const response = await fetchIssueByNumber(notification);
-    const issue = response.data.repository?.issue;
+    const issue = fetchedData;
 
     const issueState = issue.stateReason ?? issue.state;
 

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

@@ -19,7 +19,10 @@ import {
 } from '../../../types';
 import type { Notification, Subject } from '../../../typesGitHub';
 import { fetchPullByNumber } from '../../api/client';
-import type { PullRequestReviewFieldsFragment } from '../../api/graphql/generated/graphql';
+import type {
+  PullRequestDetailsFragment,
+  PullRequestReviewFieldsFragment,
+} from '../../api/graphql/generated/graphql';
 import { DefaultHandler, defaultHandler } from './default';
 import { getNotificationAuthor } from './utils';
 
@@ -29,9 +32,11 @@ class PullRequestHandler extends DefaultHandler {
   async enrich(
     notification: Notification,
     _settings: SettingsState,
+    fetchedData?: PullRequestDetailsFragment,
   ): Promise<GitifySubject> {
-    const response = await fetchPullByNumber(notification);
-    const pr = response.data.repository.pullRequest;
+    const pr =
+      fetchedData ??
+      (await fetchPullByNumber(notification)).data.repository.pullRequest;
 
     let prState: GitifyPullRequestState = pr.state;
     if (pr.isDraft) {

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

@@ -5,7 +5,7 @@ import type { OcticonProps } from '@primer/octicons-react';
 import type { GitifySubject, Link, SettingsState } from '../../../types';
 import type { Notification, Subject, SubjectType } from '../../../typesGitHub';
 
-export interface NotificationTypeHandler {
+export interface NotificationTypeHandler<TFragment = unknown> {
   readonly type?: SubjectType;
 
   query(notification: Notification): { query; variables } | null;
@@ -16,6 +16,15 @@ export interface NotificationTypeHandler {
   enrich(
     notification: Notification,
     settings: SettingsState,
+    fetchedData?: TFragment,
+  ): Promise<GitifySubject>;
+
+  /**
+   * Fetch remote data (if needed) and enrich a notification.
+   */
+  fetchAndEnrich(
+    notification: Notification,
+    settings: SettingsState,
   ): Promise<GitifySubject>;
 
   /**

src/renderer/utils/notifications/notifications.ts

@@ -209,6 +209,11 @@ export async function enrichNotifications(
   const extraVariableDefinitions = new Map<string, string>();
   const extraVariableValues: Record<string, number | boolean> = {};
   const fragments = new Map<string, string>();
+  const targets: Array<{
+    alias: string;
+    kind: NotificationKind;
+    notification: Notification;
+  }> = [];
 
   const collectFragments = (doc: string) => {
     const fragmentRegex =
@@ -242,13 +247,16 @@ export async function enrichNotifications(
     const repo = notification.repository.name;
     const number = getNumberFromUrl(notification.subject.url);
 
+    const alias = `${config.aliasPrefix}${index}`;
+
     selections.push(config.selection(index));
     variableDefinitions.push(
       `$owner${index}: String!, $name${index}: String!, $number${index}: Int!`,
     );
     variableValues[`owner${index}`] = org;
     variableValues[`name${index}`] = repo;
     variableValues[`number${index}`] = number;
+    targets.push({ alias, kind, notification });
 
     for (const extra of config.extras) {
       if (!extraVariableDefinitions.has(extra.name)) {
@@ -289,8 +297,7 @@ ${Array.from(fragments.values()).join('\n')}`;
     ...extraVariableValues,
   };
 
-  console.log('MERGED QUERY ', JSON.stringify(mergedQuery, null, 2));
-  console.log('MERGED ARGS ', JSON.stringify(queryVariables, null, 2));
+  let mergedData: Record<string, unknown> | null = null;
 
   try {
     const url = getGitHubGraphQLUrl(
@@ -300,24 +307,73 @@ ${Array.from(fragments.values()).join('\n')}`;
 
     const headers = await getHeaders(url as Link, token);
 
-    axios({
+    const response = await axios({
       method: 'POST',
       url,
       data: {
         query: mergedQuery,
         variables: queryVariables,
       },
       headers: headers,
-    }).then((response) => {
-      console.log('MERGED RESPONSE ', JSON.stringify(response, null, 2));
     });
+
+    mergedData =
+      (response.data as { data?: Record<string, unknown> })?.data ?? null;
   } catch (err) {
-    console.error('Failed to fetch merged notification details', err);
+    rendererLogError(
+      'enrichNotifications',
+      'Failed to fetch merged notification details',
+      err,
+    );
   }
 
   const enrichedNotifications = await Promise.all(
     notifications.map(async (notification: Notification) => {
-      return enrichNotification(notification, settings);
+      const handler = createNotificationHandler(notification);
+
+      const target = targets.find((item) => item.notification === notification);
+
+      if (mergedData && target) {
+        const repoData = mergedData[target.alias] as
+          | { pullRequest?: unknown; issue?: unknown; discussion?: unknown }
+          | undefined;
+
+        let fragment: unknown;
+        if (target.kind === 'PullRequest') {
+          fragment = repoData?.pullRequest;
+        } else if (target.kind === 'Issue') {
+          fragment = repoData?.issue;
+        } else if (target.kind === 'Discussion') {
+          fragment = repoData?.discussion;
+        }
+
+        if (fragment) {
+          const details = await handler.enrich(
+            notification,
+            settings,
+            fragment,
+          );
+          return {
+            ...notification,
+            subject: {
+              ...notification.subject,
+              ...details,
+            },
+          };
+        }
+      }
+
+      const fetchedDetails = await handler.fetchAndEnrich(
+        notification,
+        settings,
+      );
+      return {
+        ...notification,
+        subject: {
+          ...notification.subject,
+          ...fetchedDetails,
+        },
+      };
     }),
   );
 
@@ -339,7 +395,10 @@ export async function enrichNotification(
 
   try {
     const handler = createNotificationHandler(notification);
-    additionalSubjectDetails = await handler.enrich(notification, settings);
+    additionalSubjectDetails = await handler.fetchAndEnrich(
+      notification,
+      settings,
+    );
   } catch (err) {
     rendererLogError(
       'enrichNotification',