feat(api): merge query

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

Author: setchy

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

@@ -34,7 +34,6 @@ 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

@@ -18,10 +18,9 @@ import { getNotificationAuthor } from './utils';
 class CommitHandler extends DefaultHandler {
   readonly type = 'Commit';
 
-  async fetchAndEnrich(
+  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,21 +16,9 @@ export class DefaultHandler implements NotificationTypeHandler {
     return undefined;
   }
 
-  query(_notification: Notification) {
-    return null;
-  }
-
-  async fetchAndEnrich(
-    _notification: Notification,
-    _settings: SettingsState,
-  ): Promise<GitifySubject> {
-    return null;
-  }
-
   async enrich(
     _notification: Notification,
     _settings: SettingsState,
-    _fetchedData?: unknown,
   ): Promise<GitifySubject> {
     return null;
   }

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

@@ -18,7 +18,7 @@ import { getNotificationAuthor } from './utils';
 class ReleaseHandler extends DefaultHandler {
   readonly type = 'Release';
 
-  async fetchAndEnrich(
+  async enrich(
     notification: Notification,
     settings: SettingsState,
   ): Promise<GitifySubject> {

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

@@ -20,22 +20,16 @@ export interface NotificationTypeHandler<TFragment = unknown> {
 
   mergeQueryConfig(): GraphQLMergedQueryConfig;
 
-  query(notification: Notification): { query; variables } | null;
-
-  /**
-   * Fetch remote data (if needed) and enrich a notification.
-   */
-  fetchAndEnrich(
-    notification: Notification,
-    settings: SettingsState,
-  ): Promise<GitifySubject>;
-
   /**
-   * Enrich a notification. Settings may be unused for some handlers.
+   * Enriches a base notification with additional information (state, author, metrics, etc).
+   *
+   * @param notification The base notification being enriched
+   * @param settings The app settings, which for some handlers may not be used during enrichment.
+   * @param fetchedData Previously fetched enrichment data (upstream).  If present, then enrich will skip fetching detailed data inline.
    */
   enrich(
     notification: Notification,
-    settings?: SettingsState,
+    settings: SettingsState,
     fetchedData?: TFragment,
   ): Promise<GitifySubject>;
 

src/renderer/utils/notifications/notifications.ts

@@ -133,7 +133,6 @@ export async function enrichNotifications(
   if (!settings.detailedNotifications) {
     return notifications;
   }
-  type NotificationKind = 'PullRequest' | 'Issue' | 'Discussion';
 
   const selections: string[] = [];
   const variableDefinitions: string[] = [];
@@ -143,8 +142,8 @@ export async function enrichNotifications(
   const fragments = new Map<string, string>();
   const targets: Array<{
     alias: string;
-    kind: NotificationKind;
     notification: Notification;
+    handler: ReturnType<typeof createNotificationHandler>;
   }> = [];
 
   const collectFragments = (doc: string) => {
@@ -166,54 +165,46 @@ export async function enrichNotifications(
   };
 
   let index = 0;
-
   for (const notification of notifications) {
     const handler = createNotificationHandler(notification);
-    const kind = notification.subject.type as NotificationKind;
     const config = handler.mergeQueryConfig();
-
     if (!config) {
       continue;
     }
 
     const org = notification.repository.owner.login;
     const repo = notification.repository.name;
     const number = getNumberFromUrl(notification.subject.url);
-
     const alias = `node${index}`;
     const queryFragment = config.queryFragment.replaceAll(
       'INDEX',
       index.toString(),
     );
-
     selections.push(queryFragment);
     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 });
-
+    targets.push({ alias, notification, handler });
     for (const extra of config.extras) {
       if (!extraVariableDefinitions.has(extra.name)) {
         extraVariableDefinitions.set(extra.name, extra.type);
         extraVariableValues[extra.name] = extra.defaultValue;
       }
     }
-
     collectFragments(config.responseFragment);
-
     index += 1;
   }
 
   if (selections.length === 0) {
-    const enrichedNotifications = await Promise.all(
-      notifications.map(async (notification: Notification) => {
-        return enrichNotification(notification, settings);
-      }),
+    // No handlers with mergeQueryConfig, just enrich individually
+    return Promise.all(
+      notifications.map((notification) =>
+        enrichNotification(notification, settings),
+      ),
     );
-    return enrichedNotifications;
   }
 
   const combinedVariableDefinitions = [
@@ -267,26 +258,23 @@ export async function enrichNotifications(
 
   const enrichedNotifications = await Promise.all(
     notifications.map(async (notification: Notification) => {
-      const handler = createNotificationHandler(notification);
-
       const target = targets.find((item) => item.notification === notification);
-
       if (mergedData && target) {
+        // Try to find the first defined property in the repoData (pullRequest, issue, discussion, etc.)
         const repoData = mergedData[target.alias] as
-          | { pullRequest?: unknown; issue?: unknown; discussion?: unknown }
+          | Record<string, 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 (repoData) {
+          for (const value of Object.values(repoData)) {
+            if (value !== undefined) {
+              fragment = value;
+              break;
+            }
+          }
         }
-
         if (fragment) {
-          const details = await handler.enrich(
+          const details = await target.handler.enrich(
             notification,
             settings,
             fragment,
@@ -300,11 +288,9 @@ export async function enrichNotifications(
           };
         }
       }
-
-      const fetchedDetails = await handler.fetchAndEnrich(
-        notification,
-        settings,
-      );
+      // fallback
+      const handler = createNotificationHandler(notification);
+      const fetchedDetails = await handler.enrich(notification, settings);
       return {
         ...notification,
         subject: {
@@ -314,7 +300,6 @@ export async function enrichNotifications(
       };
     }),
   );
-
   return enrichedNotifications;
 }
 
@@ -333,10 +318,7 @@ export async function enrichNotification(
 
   try {
     const handler = createNotificationHandler(notification);
-    additionalSubjectDetails = await handler.fetchAndEnrich(
-      notification,
-      settings,
-    );
+    additionalSubjectDetails = await handler.enrich(notification, settings);
   } catch (err) {
     rendererLogError(
       'enrichNotification',