feat: search notifications

setchy · setchy · commit 44874040f56b · 2025-09-08T14:30:37.000-04:00
Signed-off-by: Adam Setch &lt;adam.setch@outlook.com&gt;
diff --git a/src/renderer/components/filters/SearchFilterSuggestions.tsx b/src/renderer/components/filters/SearchFilterSuggestions.tsx
@@ -5,8 +5,8 @@ import { Box, Popover, Stack, Text } from '@primer/react';
 import { Opacity } from '../../types';
 import { cn } from '../../utils/cn';
 import {
-  BASE_SEARCH_QUALIFIERS,
   ALL_SEARCH_QUALIFIERS,
+  BASE_SEARCH_QUALIFIERS,
   SEARCH_DELIMITER,
 } from '../../utils/notifications/filters/search';
 
@@ -28,7 +28,9 @@ export const SearchFilterSuggestions: FC<SearchFilterSuggestionsProps> = ({
   }
 
   const lower = inputValue.toLowerCase();
-  const base = isDetailedNotificationsEnabled ? ALL_SEARCH_QUALIFIERS : BASE_SEARCH_QUALIFIERS;
+  const base = isDetailedNotificationsEnabled
+    ? ALL_SEARCH_QUALIFIERS
+    : BASE_SEARCH_QUALIFIERS;
   const suggestions = base.filter(
     (q) => q.prefix.startsWith(lower) || inputValue === '',
   );
diff --git a/src/renderer/components/filters/TokenSearchInput.tsx b/src/renderer/components/filters/TokenSearchInput.tsx
@@ -4,7 +4,7 @@ import { Box, Stack, Text, TextInputWithTokens } from '@primer/react';
 
 import type { SearchToken } from '../../types';
 import {
-  normalizeSearchInputToToken,
+  parseSearchInput,
   SEARCH_DELIMITER,
 } from '../../utils/notifications/filters/search';
 import { SearchFilterSuggestions } from './SearchFilterSuggestions';
@@ -20,7 +20,7 @@ interface TokenSearchInputProps {
   onRemove: (token: SearchToken) => void;
 }
 
-const tokenEvents = ['Enter', 'Tab', ' ', ','];
+const INPUT_KEY_EVENTS = ['Enter', 'Tab', ' ', ','];
 
 export const TokenSearchInput: FC<TokenSearchInputProps> = ({
   label,
@@ -43,16 +43,17 @@ export const TokenSearchInput: FC<TokenSearchInputProps> = ({
       | React.FocusEvent<HTMLInputElement>,
   ) {
     const raw = (event.target as HTMLInputElement).value;
-    const value = normalizeSearchInputToToken(raw);
-    if (value && !tokens.includes(value as SearchToken)) {
-      onAdd(value as SearchToken);
+    const parsed = parseSearchInput(raw);
+    const token = parsed?.token as SearchToken | undefined;
+    if (token && !tokens.includes(token)) {
+      onAdd(token);
       (event.target as HTMLInputElement).value = '';
       setInputValue('');
     }
   }
 
   function onKeyDown(e: React.KeyboardEvent<HTMLInputElement>) {
-    if (tokenEvents.includes(e.key)) {
+    if (INPUT_KEY_EVENTS.includes(e.key)) {
       tryAddToken(e);
       setShowSuggestions(false);
     } else if (e.key === 'ArrowDown') {
diff --git a/src/renderer/utils/notifications/filters/filter.ts b/src/renderer/utils/notifications/filters/filter.ts
@@ -5,20 +5,18 @@ import type {
   SubjectUser,
 } from '../../../typesGitHub';
 import {
+  BASE_SEARCH_QUALIFIERS,
+  DETAILED_ONLY_SEARCH_QUALIFIERS,
   filterNotificationBySearchTerm,
   hasExcludeSearchFilters,
   hasIncludeSearchFilters,
   reasonFilter,
+  type SearchQualifier,
   stateFilter,
   subjectTypeFilter,
   userTypeFilter,
-  type SearchQualifier,
-  BASE_SEARCH_QUALIFIERS,
-  DETAILED_ONLY_SEARCH_QUALIFIERS,
 } from '.';
 
-
-
 export function filterBaseNotifications(
   notifications: Notification[],
   settings: SettingsState,
@@ -28,7 +26,10 @@ export function filterBaseNotifications(
 
     // Apply base qualifier include/exclude filters (org, repo, etc.)
     for (const qualifier of BASE_SEARCH_QUALIFIERS) {
-      if (!passesFilters) break;
+      if (!passesFilters) {
+        break;
+      }
+
       passesFilters =
         passesFilters &&
         passesSearchTokenFiltersForQualifier(notification, settings, qualifier);
@@ -140,7 +141,10 @@ function passesUserFilters(
 
   // Apply detailed-only qualifier search token filters (e.g. author)
   for (const qualifier of DETAILED_ONLY_SEARCH_QUALIFIERS) {
-    if (!passesFilters) break;
+    if (!passesFilters) {
+      break;
+    }
+
     passesFilters =
       passesFilters &&
       passesSearchTokenFiltersForQualifier(notification, settings, qualifier);
diff --git a/src/renderer/utils/notifications/filters/search.test.ts b/src/renderer/utils/notifications/filters/search.test.ts
@@ -1,40 +1,37 @@
 import { partialMockNotification } from '../../../__mocks__/partial-mocks';
 import type { Link } from '../../../types';
 import type { Owner } from '../../../typesGitHub';
-import { filterNotificationBySearchTerm, parseSearchToken, ALL_SEARCH_QUALIFIERS } from './search';
+import {
+  ALL_SEARCH_QUALIFIERS,
+  filterNotificationBySearchTerm,
+  parseSearchInput,
+} from './search';
 
 // (helper removed – no longer used)
 
 describe('renderer/utils/notifications/filters/search.ts', () => {
-  describe('parseSearchToken (prefix matching behavior)', () => {
+  describe('parseSearchInput (prefix matching behavior)', () => {
     it('returns null for empty string', () => {
-      expect(parseSearchToken('')).toBeNull();
+      expect(parseSearchInput('')).toBeNull();
     });
 
     it('returns null when no qualifier prefix matches', () => {
-      expect(parseSearchToken('unknown:value')).toBeNull();
-      expect(parseSearchToken('auth:foo')).toBeNull(); // near miss
+      expect(parseSearchInput('unknown:value')).toBeNull();
+      expect(parseSearchInput('auth:foo')).toBeNull(); // near miss
     });
 
     it('matches each known qualifier by its exact prefix and additional value', () => {
       for (const q of ALL_SEARCH_QUALIFIERS) {
         const token = q.prefix + 'someValue';
-        const parsed = parseSearchToken(token);
+        const parsed = parseSearchInput(token);
         expect(parsed).not.toBeNull();
         expect(parsed?.qualifier).toBe(q);
       }
     });
 
-    it('is case-sensitive (does not match mismatched casing)', () => {
-      // Intentionally alter case of prefix characters
-      expect(parseSearchToken('Author:foo')).toBeNull();
-      expect(parseSearchToken('ORG:bar')).toBeNull();
-      expect(parseSearchToken('Repo:baz')).toBeNull();
-    });
-
     it('does not match when prefix appears later in the token', () => {
-      expect(parseSearchToken('xauthor:foo')).toBeNull();
-      expect(parseSearchToken('xxorg:bar')).toBeNull();
+      expect(parseSearchInput('xauthor:foo')).toBeNull();
+      expect(parseSearchInput('xxorg:bar')).toBeNull();
     });
   });
 
@@ -60,64 +57,49 @@ describe('renderer/utils/notifications/filters/search.ts', () => {
 
     it('matches author qualifier (case-insensitive)', () => {
       expect(
-        filterNotificationBySearchTerm(mockNotification, `author:github-user`),
+        filterNotificationBySearchTerm(mockNotification, 'author:github-user'),
       ).toBe(true);
 
       expect(
-        filterNotificationBySearchTerm(
-          mockNotification,
-          `author:GITHUB-USER`,
-        ),
+        filterNotificationBySearchTerm(mockNotification, 'author:GITHUB-USER'),
       ).toBe(true);
 
       expect(
-        filterNotificationBySearchTerm(
-          mockNotification,
-          `author:some-bot`,
-        ),
+        filterNotificationBySearchTerm(mockNotification, 'author:some-bot'),
       ).toBe(false);
     });
 
     it('matches org qualifier (case-insensitive)', () => {
       expect(
-        filterNotificationBySearchTerm(
-          mockNotification,
-          `org:gitify-app`,
-        ),
+        filterNotificationBySearchTerm(mockNotification, 'org:gitify-app'),
       ).toBe(true);
 
       expect(
-        filterNotificationBySearchTerm(
-          mockNotification,
-          `org:GITIFY-APP`,
-        ),
+        filterNotificationBySearchTerm(mockNotification, 'org:GITIFY-APP'),
       ).toBe(true);
 
       expect(
-        filterNotificationBySearchTerm(mockNotification, `org:github`),
+        filterNotificationBySearchTerm(mockNotification, 'org:github'),
       ).toBe(false);
     });
 
     it('matches repo qualifier (case-insensitive full_name)', () => {
       expect(
         filterNotificationBySearchTerm(
           mockNotification,
-          `repo:gitify-app/gitify`,
+          'repo:gitify-app/gitify',
         ),
       ).toBe(true);
 
       expect(
         filterNotificationBySearchTerm(
           mockNotification,
-          `repo:Gitify-App/Gitify`,
+          'repo:Gitify-App/Gitify',
         ),
       ).toBe(true);
 
       expect(
-        filterNotificationBySearchTerm(
-          mockNotification,
-          `repo:github/other`,
-        ),
+        filterNotificationBySearchTerm(mockNotification, 'repo:github/other'),
       ).toBe(false);
     });
 
diff --git a/src/renderer/utils/notifications/filters/search.ts b/src/renderer/utils/notifications/filters/search.ts
@@ -33,15 +33,11 @@ export const ALL_SEARCH_QUALIFIERS: readonly SearchQualifier[] = Object.values(
   SEARCH_QUALIFIERS,
 ) as readonly SearchQualifier[];
 
+export const BASE_SEARCH_QUALIFIERS: readonly SearchQualifier[] =
+  ALL_SEARCH_QUALIFIERS.filter((q) => !q.requiresDetailsNotifications);
 
-export const BASE_SEARCH_QUALIFIERS: readonly SearchQualifier[] = ALL_SEARCH_QUALIFIERS.filter(
-  (q) => !q.requiresDetailsNotifications,
-);
-
-export const DETAILED_ONLY_SEARCH_QUALIFIERS: readonly SearchQualifier[] = ALL_SEARCH_QUALIFIERS.filter(
-  (q) => q.requiresDetailsNotifications,
-);
-
+export const DETAILED_ONLY_SEARCH_QUALIFIERS: readonly SearchQualifier[] =
+  ALL_SEARCH_QUALIFIERS.filter((q) => q.requiresDetailsNotifications);
 
 export function hasIncludeSearchFilters(settings: SettingsState) {
   return settings.filterIncludeSearchTokens.length > 0;
@@ -51,63 +47,46 @@ export function hasExcludeSearchFilters(settings: SettingsState) {
   return settings.filterExcludeSearchTokens.length > 0;
 }
 
-function stripPrefix(token: string, qualifier: SearchQualifier) {
-  return token.slice(qualifier.prefix.length).trim();
-}
-
 export interface ParsedSearchToken {
-  qualifier: SearchQualifier;
-  value: string;
-  valueLower: string;
+  qualifier: SearchQualifier; // matched qualifier
+  value: string; // original-case value after prefix
+  valueLower: string; // lowercase cached
+  token: string; // canonical stored token (prefix + value)
 }
 
-export function parseSearchToken(token: string): ParsedSearchToken | null {
-  if (!token) {
+export function parseSearchInput(raw: string): ParsedSearchToken | null {
+  const trimmed = raw.trim();
+  if (!trimmed) {
     return null;
   }
 
+  const lower = trimmed.toLowerCase();
+
   for (const qualifier of ALL_SEARCH_QUALIFIERS) {
-    if (token.startsWith(qualifier.prefix)) {
-      const value = stripPrefix(token, qualifier);
-  
-      if (!value) {
-        return null; // prefix only
+    if (lower.startsWith(qualifier.prefix)) {
+      const valuePart = trimmed.slice(qualifier.prefix.length).trim();
+      if (!valuePart) {
+        return null;
       }
-      
-      return { qualifier, value, valueLower: value.toLowerCase() };
+
+      const token = qualifier.prefix + valuePart;
+      return {
+        qualifier,
+        value: valuePart,
+        valueLower: valuePart.toLowerCase(),
+        token,
+      };
     }
   }
   return null;
 }
 
-// Normalize raw user input from the token text field into a SearchToken (string)
-// Returns null if no known prefix or no value after prefix yet.
-export function normalizeSearchInputToToken(raw: string): string | null {
-  const value = raw.trim();
-  if (!value) {
-    return null;
-  }
-
-  const lower = value.toLowerCase();
-  const matchedQualifier = ALL_SEARCH_QUALIFIERS.find((q) => lower.startsWith(q.prefix));
-
-  if (!matchedQualifier) {
-    return null;
-  }
-
-  const rest = value.substring(matchedQualifier.prefix.length);
-  if (rest.length === 0) {
-    return null; // prefix only, incomplete token
-  }
-
-  return `${matchedQualifier.prefix}${rest}`;
-}
-
 export function filterNotificationBySearchTerm(
   notification: Notification,
   token: string,
 ): boolean {
-  const parsed = parseSearchToken(token);
+  const parsed = parseSearchInput(token);
+
   if (!parsed) {
     return false;
   }
