Merge pull request #10456 from DestinyItemManager/search-type

Allow saving loadout search history

config/i18n.json

@@ -1099,7 +1099,9 @@
  "UsageCount": "# Used",
  "Query": "Search",
  "Link": "View and edit search history",
- "Title": "Search History"
+ "Title": "Search History",
+ "Item": "Item Searches",
+ "Loadout": "Loadout Searches"
  },
  "Settings": {
  "AutoLockTagged": "Sync item lock state with tag",

package.json

@@ -194,7 +194,7 @@
  },
  "dependencies": {
  "@babel/runtime": "^7.24.5",
- "@destinyitemmanager/dim-api-types": "^1.30.0",
+ "@destinyitemmanager/dim-api-types": "^1.31.0",
  "@fortawesome/fontawesome-free": "^5.15.4",
  "@fortawesome/fontawesome-svg-core": "^1.2.36",
  "@fortawesome/react-fontawesome": "^0.2.1",

src/app/dim-api/basic-actions.ts

@@ -2,6 +2,7 @@ import {
  GlobalSettings,
  ProfileResponse,
  ProfileUpdateResult,
+ SearchType,
 } from '@destinyitemmanager/dim-api-types';
 import { DestinyAccount } from 'app/accounts/destiny-account';
 import { createAction } from 'typesafe-actions';
@@ -40,16 +41,23 @@ export const trackTriumph = createAction('dim-api/TRACK_TRIUMPH')<{
 }>();
 
 /** Record that a search was used */
-export const searchUsed = createAction('dim-api/SEARCH_USED')<string>();
+export const searchUsed = createAction('dim-api/SEARCH_USED')<{
+ query: string;
+ type: SearchType;
+}>();
 
 /** Save or un-save a search */
 export const saveSearch = createAction('dim-api/SAVE_SEARCH')<{
  query: string;
  saved: boolean;
+ type: SearchType;
 }>();
 
 /** Delete a saved search */
-export const searchDeleted = createAction('dim-api/DELETE_SEARCH')<string>();
+export const searchDeleted = createAction('dim-api/DELETE_SEARCH')<{
+ query: string;
+ type: SearchType;
+}>();
 
 /**
  * This signals that we are about to flush the update queue.

src/app/dim-api/reducer.test.ts

@@ -1,3 +1,4 @@
+import { SearchType } from '@destinyitemmanager/dim-api-types';
 import { DestinyAccount } from 'app/accounts/destiny-account';
 import { setItemHashTag, setItemTag } from 'app/inventory/actions';
 import { setSettingAction } from 'app/settings/actions';
@@ -643,13 +644,13 @@ describe('saveSearch', () => {
  };
  const updatedState = dimApi(
  state,
- saveSearch({ query: '(is:masterwork) (is:weapon)', saved: true }),
+ saveSearch({ query: '(is:masterwork) (is:weapon)', saved: true, type: SearchType.Item }),
  currentAccount,
  );
 
  expect(updatedState.searches).toMatchObject({
  [1]: [],
- [2]: [{ query: 'is:masterwork is:weapon', saved: true }],
+ [2]: [{ query: 'is:masterwork is:weapon', saved: true, type: SearchType.Item }],
  });
  });
 
@@ -659,19 +660,19 @@ describe('saveSearch', () => {
  };
  let updatedState = dimApi(
  state,
- saveSearch({ query: '(is:masterwork) (is:weapon)', saved: true }),
+ saveSearch({ query: '(is:masterwork) (is:weapon)', saved: true, type: SearchType.Item }),
  currentAccount,
  );
 
  updatedState = dimApi(
  updatedState,
- saveSearch({ query: '(is:masterwork) (is:weapon)', saved: false }),
+ saveSearch({ query: '(is:masterwork) (is:weapon)', saved: false, type: SearchType.Item }),
  currentAccount,
  );
 
  expect(updatedState.searches).toMatchObject({
  [1]: [],
- [2]: [{ query: 'is:masterwork is:weapon', saved: false }],
+ [2]: [{ query: 'is:masterwork is:weapon', saved: false, type: SearchType.Item }],
  });
  });
 
@@ -681,7 +682,7 @@ describe('saveSearch', () => {
  };
  const updatedState = dimApi(
  state,
- saveSearch({ query: 'deepsight:incomplete', saved: true }),
+ saveSearch({ query: 'deepsight:incomplete', saved: true, type: SearchType.Item }),
  currentAccount,
  );
  expect(updatedState.searches).toMatchObject({
@@ -695,12 +696,20 @@ describe('saveSearch', () => {
  ...initialState,
  searches: {
  [1]: [],
- [2]: [{ usageCount: 1, lastUsage: 919191, saved: true, query: 'deepsight:incomplete' }],
+ [2]: [
+ {
+ usageCount: 1,
+ lastUsage: 919191,
+ saved: true,
+ query: 'deepsight:incomplete',
+ type: SearchType.Item,
+ },
+ ],
  },
  };
  const updatedState = dimApi(
  state,
- saveSearch({ query: 'deepsight:incomplete', saved: false }),
+ saveSearch({ query: 'deepsight:incomplete', saved: false, type: SearchType.Item }),
  currentAccount,
  );
 

src/app/dim-api/reducer.ts

@@ -1,14 +1,15 @@
 import {
  CustomStatWeights,
- defaultGlobalSettings,
  DestinyVersion,
  GlobalSettings,
  ItemAnnotation,
  ItemHashTag,
  Loadout,
  ProfileUpdateResult,
  Search,
+ SearchType,
  TagValue,
+ defaultGlobalSettings,
 } from '@destinyitemmanager/dim-api-types';
 import { DestinyAccount } from 'app/accounts/destiny-account';
 import { t } from 'app/i18next-t';
@@ -31,7 +32,7 @@ import * as inventoryActions from '../inventory/actions';
 import * as loadoutActions from '../loadout-drawer/actions';
 import { Loadout as DimLoadout } from '../loadout-drawer/loadout-types';
 import * as settingsActions from '../settings/actions';
-import { initialSettingsState, Settings } from '../settings/initial-settings';
+import { Settings, initialSettingsState } from '../settings/initial-settings';
 import { DeleteLoadoutUpdateWithRollback, ProfileUpdateWithRollback } from './api-types';
 import * as actions from './basic-actions';
 import { makeProfileKey, makeProfileKeyFromAccount } from './selectors';
@@ -384,17 +385,23 @@ export const dimApi = (
 
  case getType(actions.searchUsed):
  return produce(state, (draft) => {
- searchUsed(draft, account!, action.payload);
+ searchUsed(draft, account!, action.payload.query, action.payload.type);
  });
 
  case getType(actions.saveSearch):
  return produce(state, (draft) => {
- saveSearch(account!, draft, action.payload.query, action.payload.saved);
+ saveSearch(
+ account!,
+ draft,
+ action.payload.query,
+ action.payload.saved,
+ action.payload.type,
+ );
  });
 
  case getType(actions.searchDeleted):
  return produce(state, (draft) => {
- deleteSearch(draft, account!.destinyVersion, action.payload);
+ deleteSearch(draft, account!.destinyVersion, action.payload.query, action.payload.type);
  });
 
  // *** Triumphs ***
@@ -1147,7 +1154,12 @@ function trackTriumph(
  draft.updateQueue.push(updateAction);
 }
 
-function searchUsed(draft: Draft<DimApiState>, account: DestinyAccount, query: string) {
+function searchUsed(
+ draft: Draft<DimApiState>,
+ account: DestinyAccount,
+ query: string,
+ type: SearchType,
+) {
  const destinyVersion = account.destinyVersion;
  // Note: memoized
  const filtersMap = buildItemFiltersMap(destinyVersion);
@@ -1166,6 +1178,7 @@ function searchUsed(draft: Draft<DimApiState>, account: DestinyAccount, query: s
  action: 'search',
  payload: {
  query,
+ type,
  },
  destinyVersion,
  };
@@ -1182,9 +1195,11 @@ function searchUsed(draft: Draft<DimApiState>, account: DestinyAccount, query: s
  usageCount: 1,
  saved: false,
  lastUsage: Date.now(),
+ type,
  });
  }
 
+ // TODO: maybe this should be max per type?
  if (searches.length > MAX_SEARCH_HISTORY) {
  const sortedSearches = searches.toSorted(recentSearchComparator);
 
@@ -1195,7 +1210,7 @@ function searchUsed(draft: Draft<DimApiState>, account: DestinyAccount, query: s
  const lastSearch = sortedSearches.pop()!;
  // Never try to delete the built-in searches or saved searches
  if (!lastSearch.saved && lastSearch.usageCount > 0) {
- deleteSearch(draft, destinyVersion, lastSearch.query);
+ deleteSearch(draft, destinyVersion, lastSearch.query, lastSearch.type);
  }
  }
  }
@@ -1208,6 +1223,7 @@ function saveSearch(
  draft: Draft<DimApiState>,
  query: string,
  saved: boolean,
+ type: SearchType,
 ) {
  const destinyVersion = account.destinyVersion;
  // Note: memoized
@@ -1228,6 +1244,7 @@ function saveSearch(
  payload: {
  query,
  saved,
+ type,
  },
  destinyVersion,
  };
@@ -1245,11 +1262,13 @@ function saveSearch(
  usageCount: 1,
  saved: true,
  lastUsage: Date.now(),
+ type,
  });
  draft.updateQueue.push({
  action: 'search',
  payload: {
  query,
+ type,
  },
  destinyVersion,
  });
@@ -1258,11 +1277,17 @@ function saveSearch(
  draft.updateQueue.push(updateAction);
 }
 
-function deleteSearch(draft: Draft<DimApiState>, destinyVersion: DestinyVersion, query: string) {
+function deleteSearch(
+ draft: Draft<DimApiState>,
+ destinyVersion: DestinyVersion,
+ query: string,
+ type: SearchType,
+) {
  const updateAction: ProfileUpdateWithRollback = {
  action: 'delete_search',
  payload: {
  query,
+ type,
  },
  destinyVersion,
  };
@@ -1293,7 +1318,7 @@ function cleanupInvalidSearches(draft: Draft<DimApiState>, account: DestinyAccou
  customStats: draft.settings.customStats ?? [],
  } as FilterContext);
  if (!saveInHistory) {
- deleteSearch(draft, account.destinyVersion, search.query);
+ deleteSearch(draft, account.destinyVersion, search.query, search.type);
  }
  }
 }

src/app/dim-api/selectors.ts

@@ -1,4 +1,8 @@
-import { DestinyVersion, defaultLoadoutParameters } from '@destinyitemmanager/dim-api-types';
+import {
+ DestinyVersion,
+ SearchType,
+ defaultLoadoutParameters,
+} from '@destinyitemmanager/dim-api-types';
 import { DestinyAccount } from 'app/accounts/destiny-account';
 import { currentAccountSelector, destinyVersionSelector } from 'app/accounts/selectors';
 import { Settings } from 'app/settings/initial-settings';
@@ -57,13 +61,17 @@ export const currentProfileSelector = createSelector(
  currentAccount ? profiles[makeProfileKeyFromAccount(currentAccount)] : undefined,
 );
 
+const recentSearchesSelectorCached = createSelector(
+ (state: RootState) => state.dimApi.searches[destinyVersionSelector(state)],
+ (_state: RootState, searchType: SearchType) => searchType,
+ (searches, searchType) => searches.filter((s) => s.type === searchType),
+);
+
 /**
- * Returns all recent/saved searches.
- *
- * TODO: Sort/trim this list
+ * Returns all recent/saved searches of the given type.
  */
-export const recentSearchesSelector = (state: RootState) =>
- state.dimApi.searches[destinyVersionSelector(state)];
+export const recentSearchesSelector = (searchType: SearchType) => (state: RootState) =>
+ recentSearchesSelectorCached(state, searchType);
 
 export const trackedTriumphsSelector = createSelector(
  currentProfileSelector,

src/app/item-actions/ItemActionsDropdown.tsx

@@ -1,3 +1,4 @@
+import { SearchType } from '@destinyitemmanager/dim-api-types';
 import { destinyVersionSelector } from 'app/accounts/selectors';
 import { compareFilteredItems } from 'app/compare/actions';
 import { saveSearch } from 'app/dim-api/basic-actions';
@@ -102,15 +103,15 @@ export default memo(function ItemActionsDropdown({
  bulkItemTags.push({ type: 'clear', label: t('Tags.ClearTag'), icon: clearIcon });
 
  // Is the current search saved?
- const recentSearches = useSelector(recentSearchesSelector);
+ const recentSearches = useSelector(recentSearchesSelector(SearchType.Item));
  const validateQuery = useSelector(validateQuerySelector);
  const { valid, saveable } = validateQuery(searchQuery);
  const canonical = searchQuery ? canonicalizeQuery(parseQuery(searchQuery)) : '';
  const saved = canonical ? recentSearches.find((s) => s.query === canonical)?.saved : false;
 
  const toggleSaved = () => {
  // TODO: keep track of the last search, if you search for something more narrow immediately after then replace?
- dispatch(saveSearch({ query: searchQuery, saved: !saved }));
+ dispatch(saveSearch({ query: searchQuery, saved: !saved, type: SearchType.Item }));
  };
 
  const location = useLocation();

src/app/loadout/loadout-menu/LoadoutPopup.tsx

@@ -1,3 +1,4 @@
+import { SearchType } from '@destinyitemmanager/dim-api-types';
 import { languageSelector, settingSelector } from 'app/dim-api/selectors';
 import { AlertIcon } from 'app/dim-ui/AlertIcon';
 import ClassIcon from 'app/dim-ui/ClassIcon';
@@ -166,7 +167,7 @@ export default function LoadoutPopup({
  className={styles.filterInput}
  placeholder={t('Header.FilterHelpLoadouts')}
  onQueryChanged={setLoadoutQuery}
- loadouts
+ searchType={SearchType.Loadout}
  instant
  />
  </div>