src/store/search-bar/search-bar-actions.ts

   1 // Copyright (C) The Arvados Authors. All rights reserved.
   2 //
   3 // SPDX-License-Identifier: AGPL-3.0
   4
   5 import { ofType, unionize, UnionOf } from "~/common/unionize";
   6 import { GroupContentsResource, GroupContentsResourcePrefix } from '~/services/groups-service/groups-service';
   7 import { Dispatch } from 'redux';
   8 import { change, initialize, untouch } from 'redux-form';
   9 import { RootState } from '~/store/store';
  10 import { initUserProject, treePickerActions } from '~/store/tree-picker/tree-picker-actions';
  11 import { ServiceRepository } from '~/services/services';
  12 import { FilterBuilder } from "~/services/api/filter-builder";
  13 import { ResourceKind, RESOURCE_UUID_REGEX, COLLECTION_PDH_REGEX } from '~/models/resource';
  14 import { SearchView } from '~/store/search-bar/search-bar-reducer';
  15 import { navigateTo, navigateToSearchResults } from '~/store/navigation/navigation-action';
  16 import { snackbarActions, SnackbarKind } from '~/store/snackbar/snackbar-actions';
  17 import { PropertyValue, SearchBarAdvancedFormData } from '~/models/search-bar';
  18 import * as _ from "lodash";
  19 import { getModifiedKeysValues } from "~/common/objects";
  20 import { activateSearchBarProject } from "~/store/search-bar/search-bar-tree-actions";
  21 import { Session } from "~/models/session";
  22 import { searchResultsPanelActions } from "~/store/search-results-panel/search-results-panel-actions";
  23 import { ListResults } from "~/services/common-service/common-service";
  24 import * as parser from './search-query/arv-parser';
  25 import { Keywords } from './search-query/arv-parser';
  26 import { Vocabulary, getTagKeyLabel, getTagValueLabel } from "~/models/vocabulary";
  27
  28 export const searchBarActions = unionize({
  29     SET_CURRENT_VIEW: ofType<string>(),
  30     OPEN_SEARCH_VIEW: ofType<{}>(),
  31     CLOSE_SEARCH_VIEW: ofType<{}>(),
  32     SET_SEARCH_RESULTS: ofType<GroupContentsResource[]>(),
  33     SET_SEARCH_VALUE: ofType<string>(),
  34     SET_SAVED_QUERIES: ofType<SearchBarAdvancedFormData[]>(),
  35     SET_RECENT_QUERIES: ofType<string[]>(),
  36     UPDATE_SAVED_QUERY: ofType<SearchBarAdvancedFormData[]>(),
  37     SET_SELECTED_ITEM: ofType<string>(),
  38     MOVE_UP: ofType<{}>(),
  39     MOVE_DOWN: ofType<{}>(),
  40     SELECT_FIRST_ITEM: ofType<{}>()
  41 });
  42
  43 export type SearchBarActions = UnionOf<typeof searchBarActions>;
  44
  45 export const SEARCH_BAR_ADVANCED_FORM_NAME = 'searchBarAdvancedFormName';
  46
  47 export const SEARCH_BAR_ADVANCED_FORM_PICKER_ID = 'searchBarAdvancedFormPickerId';
  48
  49 export const DEFAULT_SEARCH_DEBOUNCE = 1000;
  50
  51 export const goToView = (currentView: string) => searchBarActions.SET_CURRENT_VIEW(currentView);
  52
  53 export const saveRecentQuery = (query: string) =>
  54     (dispatch: Dispatch<any>, getState: () => RootState, services: ServiceRepository) =>
  55         services.searchService.saveRecentQuery(query);
  56
  57
  58 export const loadRecentQueries = () =>
  59     (dispatch: Dispatch<any>, getState: () => RootState, services: ServiceRepository) => {
  60         const recentQueries = services.searchService.getRecentQueries();
  61         dispatch(searchBarActions.SET_RECENT_QUERIES(recentQueries));
  62         return recentQueries;
  63     };
  64
  65 export const searchData = (searchValue: string) =>
  66     async (dispatch: Dispatch, getState: () => RootState) => {
  67         const currentView = getState().searchBar.currentView;
  68         dispatch(searchResultsPanelActions.CLEAR());
  69         dispatch(searchBarActions.SET_SEARCH_VALUE(searchValue));
  70         if (searchValue.length > 0) {
  71             dispatch<any>(searchGroups(searchValue, 5));
  72             if (currentView === SearchView.BASIC) {
  73                 dispatch(searchBarActions.CLOSE_SEARCH_VIEW());
  74                 dispatch(navigateToSearchResults(searchValue));
  75             }
  76         }
  77     };
  78
  79 export const searchAdvancedData = (data: SearchBarAdvancedFormData) =>
  80     async (dispatch: Dispatch, getState: () => RootState) => {
  81         dispatch<any>(saveQuery(data));
  82         const searchValue = getState().searchBar.searchValue;
  83         dispatch(searchResultsPanelActions.CLEAR());
  84         dispatch(searchBarActions.SET_CURRENT_VIEW(SearchView.BASIC));
  85         dispatch(searchBarActions.CLOSE_SEARCH_VIEW());
  86         dispatch(navigateToSearchResults(searchValue));
  87     };
  88
  89 export const setSearchValueFromAdvancedData = (data: SearchBarAdvancedFormData, prevData?: SearchBarAdvancedFormData) =>
  90     (dispatch: Dispatch, getState: () => RootState) => {
  91         const searchValue = getState().searchBar.searchValue;
  92         const value = getQueryFromAdvancedData({
  93             ...data,
  94             searchValue
  95         }, prevData);
  96         dispatch(searchBarActions.SET_SEARCH_VALUE(value));
  97     };
  98
  99 export const setAdvancedDataFromSearchValue = (search: string, vocabulary: Vocabulary) =>
 100     async (dispatch: Dispatch) => {
 101         const data = getAdvancedDataFromQuery(search, vocabulary);
 102         dispatch<any>(initialize(SEARCH_BAR_ADVANCED_FORM_NAME, data));
 103         if (data.projectUuid) {
 104             await dispatch<any>(activateSearchBarProject(data.projectUuid));
 105             dispatch(treePickerActions.ACTIVATE_TREE_PICKER_NODE({ pickerId: SEARCH_BAR_ADVANCED_FORM_PICKER_ID, id: data.projectUuid }));
 106         }
 107     };
 108
 109 const saveQuery = (data: SearchBarAdvancedFormData) =>
 110     (dispatch: Dispatch<any>, getState: () => RootState, services: ServiceRepository) => {
 111         const savedQueries = services.searchService.getSavedQueries();
 112         if (data.saveQuery && data.queryName) {
 113             const filteredQuery = savedQueries.find(query => query.queryName === data.queryName);
 114             data.searchValue = getState().searchBar.searchValue;
 115             if (filteredQuery) {
 116                 services.searchService.editSavedQueries(data);
 117                 dispatch(searchBarActions.UPDATE_SAVED_QUERY(savedQueries));
 118                 dispatch(snackbarActions.OPEN_SNACKBAR({ message: 'Query has been successfully updated', hideDuration: 2000, kind: SnackbarKind.SUCCESS }));
 119             } else {
 120                 services.searchService.saveQuery(data);
 121                 dispatch(searchBarActions.SET_SAVED_QUERIES(savedQueries));
 122                 dispatch(snackbarActions.OPEN_SNACKBAR({ message: 'Query has been successfully saved', hideDuration: 2000, kind: SnackbarKind.SUCCESS }));
 123             }
 124         }
 125     };
 126
 127 export const deleteSavedQuery = (id: number) =>
 128     (dispatch: Dispatch<any>, getState: () => RootState, services: ServiceRepository) => {
 129         services.searchService.deleteSavedQuery(id);
 130         const savedSearchQueries = services.searchService.getSavedQueries();
 131         dispatch(searchBarActions.SET_SAVED_QUERIES(savedSearchQueries));
 132         return savedSearchQueries || [];
 133     };
 134
 135 export const editSavedQuery = (data: SearchBarAdvancedFormData) =>
 136     (dispatch: Dispatch<any>) => {
 137         dispatch(searchBarActions.SET_CURRENT_VIEW(SearchView.ADVANCED));
 138         dispatch(searchBarActions.SET_SEARCH_VALUE(getQueryFromAdvancedData(data)));
 139         dispatch<any>(initialize(SEARCH_BAR_ADVANCED_FORM_NAME, data));
 140     };
 141
 142 export const openSearchView = () =>
 143     (dispatch: Dispatch<any>, getState: () => RootState, services: ServiceRepository) => {
 144         const savedSearchQueries = services.searchService.getSavedQueries();
 145         dispatch(searchBarActions.SET_SAVED_QUERIES(savedSearchQueries));
 146         dispatch(loadRecentQueries());
 147         dispatch(searchBarActions.OPEN_SEARCH_VIEW());
 148         dispatch(searchBarActions.SELECT_FIRST_ITEM());
 149     };
 150
 151 export const closeSearchView = () =>
 152     (dispatch: Dispatch<any>) => {
 153         dispatch(searchBarActions.SET_SELECTED_ITEM(''));
 154         dispatch(searchBarActions.CLOSE_SEARCH_VIEW());
 155     };
 156
 157 export const closeAdvanceView = () =>
 158     (dispatch: Dispatch<any>) => {
 159         dispatch(searchBarActions.SET_SEARCH_VALUE(''));
 160         dispatch(treePickerActions.DEACTIVATE_TREE_PICKER_NODE({ pickerId: SEARCH_BAR_ADVANCED_FORM_PICKER_ID }));
 161         dispatch(searchBarActions.SET_CURRENT_VIEW(SearchView.BASIC));
 162     };
 163
 164 export const navigateToItem = (uuid: string) =>
 165     (dispatch: Dispatch<any>) => {
 166         dispatch(searchBarActions.SET_SELECTED_ITEM(''));
 167         dispatch(searchBarActions.CLOSE_SEARCH_VIEW());
 168         dispatch(navigateTo(uuid));
 169     };
 170
 171 export const changeData = (searchValue: string) =>
 172     (dispatch: Dispatch, getState: () => RootState) => {
 173         dispatch(searchBarActions.SET_SEARCH_VALUE(searchValue));
 174         const currentView = getState().searchBar.currentView;
 175         const searchValuePresent = searchValue.length > 0;
 176
 177         if (currentView === SearchView.ADVANCED) {
 178             dispatch(searchBarActions.SET_CURRENT_VIEW(SearchView.AUTOCOMPLETE));
 179         } else if (searchValuePresent) {
 180             dispatch(searchBarActions.SET_CURRENT_VIEW(SearchView.AUTOCOMPLETE));
 181             dispatch(searchBarActions.SET_SELECTED_ITEM(searchValue));
 182         } else {
 183             dispatch(searchBarActions.SET_CURRENT_VIEW(SearchView.BASIC));
 184             dispatch(searchBarActions.SET_SEARCH_RESULTS([]));
 185             dispatch(searchBarActions.SELECT_FIRST_ITEM());
 186         }
 187     };
 188
 189 export const submitData = (event: React.FormEvent<HTMLFormElement>) =>
 190     (dispatch: Dispatch, getState: () => RootState) => {
 191         event.preventDefault();
 192         const searchValue = getState().searchBar.searchValue;
 193         dispatch<any>(saveRecentQuery(searchValue));
 194         dispatch<any>(loadRecentQueries());
 195         dispatch(searchBarActions.CLOSE_SEARCH_VIEW());
 196         if (RESOURCE_UUID_REGEX.exec(searchValue) || COLLECTION_PDH_REGEX.exec(searchValue)) {
 197             dispatch<any>(navigateTo(searchValue));
 198         } else {
 199             dispatch(searchBarActions.SET_SEARCH_VALUE(searchValue));
 200             dispatch(searchBarActions.SET_SEARCH_RESULTS([]));
 201             dispatch(searchResultsPanelActions.CLEAR());
 202             dispatch(navigateToSearchResults(searchValue));
 203         }
 204     };
 205
 206
 207 const searchGroups = (searchValue: string, limit: number) =>
 208     async (dispatch: Dispatch, getState: () => RootState, services: ServiceRepository) => {
 209         const currentView = getState().searchBar.currentView;
 210
 211         if (searchValue || currentView === SearchView.ADVANCED) {
 212             const { cluster: clusterId } = getAdvancedDataFromQuery(searchValue);
 213             const sessions = getSearchSessions(clusterId, getState().auth.sessions);
 214             const lists: ListResults<GroupContentsResource>[] = await Promise.all(sessions.map(session => {
 215                 const filters = queryToFilters(searchValue, session.apiRevision);
 216                 return services.groupsService.contents('', {
 217                     filters,
 218                     limit,
 219                     recursive: true
 220                 }, session);
 221             }));
 222
 223             const items = lists.reduce((items, list) => items.concat(list.items), [] as GroupContentsResource[]);
 224             dispatch(searchBarActions.SET_SEARCH_RESULTS(items));
 225         }
 226     };
 227
 228 const buildQueryFromKeyMap = (data: any, keyMap: string[][], mode: 'rebuild' | 'reuse') => {
 229     let value = data.searchValue;
 230
 231     const addRem = (field: string, key: string) => {
 232         const v = data[key];
 233
 234         if (data.hasOwnProperty(key)) {
 235             let pattern: string;
 236             if (v === false) {
 237                 pattern = `${field.replace(':', '\\:\\s*')}\\s*`;
 238             } else if (key.startsWith('prop-')) {
 239                 // On properties, only remove key:value duplicates, allowing
 240                 // multiple properties with the same key.
 241                 pattern = `${field.replace(':', '\\:\\s*')}\\:\\s*${v}\\s*`;
 242             } else {
 243                 pattern = `${field.replace(':', '\\:\\s*')}\\:\\s*[\\w|\\#|\\-|\\/]*\\s*`;
 244             }
 245             value = value.replace(new RegExp(pattern), '');
 246         }
 247
 248         if (v) {
 249             const nv = v === true
 250                 ? `${field}`
 251                 : `${field}:${v}`;
 252
 253             if (mode === 'rebuild') {
 254                 value = value + ' ' + nv;
 255             } else {
 256                 value = nv + ' ' + value;
 257             }
 258         }
 259     };
 260
 261     keyMap.forEach(km => addRem(km[0], km[1]));
 262
 263     return value;
 264 };
 265
 266 export const getQueryFromAdvancedData = (data: SearchBarAdvancedFormData, prevData?: SearchBarAdvancedFormData) => {
 267     let value = '';
 268
 269     const flatData = (data: SearchBarAdvancedFormData) => {
 270         const fo = {
 271             searchValue: data.searchValue,
 272             type: data.type,
 273             cluster: data.cluster,
 274             projectUuid: data.projectUuid,
 275             inTrash: data.inTrash,
 276             dateFrom: data.dateFrom,
 277             dateTo: data.dateTo,
 278         };
 279         (data.properties || []).forEach(p => fo[`prop-"${p.keyID || p.key}"`] = `"${p.valueID || p.value}"`);
 280         return fo;
 281     };
 282
 283     const keyMap = [
 284         ['type', 'type'],
 285         ['cluster', 'cluster'],
 286         ['project', 'projectUuid'],
 287         [`is:${parser.States.TRASHED}`, 'inTrash'],
 288         ['from', 'dateFrom'],
 289         ['to', 'dateTo']
 290     ];
 291     _.union(data.properties, prevData ? prevData.properties : [])
 292         .forEach(p => keyMap.push([`has:"${p.keyID || p.key}"`, `prop-"${p.keyID || p.key}"`]));
 293
 294     if (prevData) {
 295         const obj = getModifiedKeysValues(flatData(data), flatData(prevData));
 296         value = buildQueryFromKeyMap({
 297             searchValue: data.searchValue,
 298             ...obj
 299         } as SearchBarAdvancedFormData, keyMap, "reuse");
 300     } else {
 301         value = buildQueryFromKeyMap(flatData(data), keyMap, "rebuild");
 302     }
 303
 304     value = value.trim();
 305     return value;
 306 };
 307
 308 export const getAdvancedDataFromQuery = (query: string, vocabulary?: Vocabulary): SearchBarAdvancedFormData => {
 309     const { tokens, searchString } = parser.parseSearchQuery(query);
 310     const getValue = parser.getValue(tokens);
 311     return {
 312         searchValue: searchString,
 313         type: getValue(Keywords.TYPE) as ResourceKind,
 314         cluster: getValue(Keywords.CLUSTER),
 315         projectUuid: getValue(Keywords.PROJECT),
 316         inTrash: parser.isTrashed(tokens),
 317         dateFrom: getValue(Keywords.FROM) || '',
 318         dateTo: getValue(Keywords.TO) || '',
 319         properties: vocabulary
 320             ? parser.getProperties(tokens).map(
 321                 p => {
 322                     return {
 323                         keyID: p.key,
 324                         key: getTagKeyLabel(p.key, vocabulary),
 325                         valueID: p.value,
 326                         value: getTagValueLabel(p.key, p.value, vocabulary),
 327                     };
 328                 })
 329             : parser.getProperties(tokens),
 330         saveQuery: false,
 331         queryName: ''
 332     };
 333 };
 334
 335 export const getSearchSessions = (clusterId: string | undefined, sessions: Session[]): Session[] => {
 336     return sessions.filter(s => s.loggedIn && (!clusterId || s.clusterId === clusterId));
 337 };
 338
 339 export const queryToFilters = (query: string, apiRevision: number) => {
 340     const data = getAdvancedDataFromQuery(query);
 341     const filter = new FilterBuilder();
 342     const resourceKind = data.type;
 343
 344     if (data.searchValue) {
 345         filter.addFullTextSearch(data.searchValue);
 346     }
 347
 348     if (data.projectUuid) {
 349         filter.addEqual('owner_uuid', data.projectUuid);
 350     }
 351
 352     if (data.dateFrom) {
 353         filter.addGte('modified_at', buildDateFilter(data.dateFrom));
 354     }
 355
 356     if (data.dateTo) {
 357         filter.addLte('modified_at', buildDateFilter(data.dateTo));
 358     }
 359
 360     data.properties.forEach(p => {
 361         if (p.value) {
 362             if (apiRevision < 20200212) {
 363                 filter
 364                     .addILike(`properties.${p.key}`, p.value, GroupContentsResourcePrefix.PROJECT)
 365                     .addILike(`properties.${p.key}`, p.value, GroupContentsResourcePrefix.COLLECTION);
 366             } else {
 367                 filter
 368                     .addContains(`properties.${p.key}`, p.value, GroupContentsResourcePrefix.PROJECT)
 369                     .addContains(`properties.${p.key}`, p.value, GroupContentsResourcePrefix.COLLECTION);
 370             }
 371         }
 372         filter.addExists(p.key);
 373     });
 374
 375     return filter
 376         .addIsA("uuid", buildUuidFilter(resourceKind))
 377         .getFilters();
 378 };
 379
 380 const buildUuidFilter = (type?: ResourceKind): ResourceKind[] => {
 381     return type ? [type] : [ResourceKind.PROJECT, ResourceKind.COLLECTION, ResourceKind.PROCESS];
 382 };
 383
 384 const buildDateFilter = (date?: string): string => {
 385     return date ? date : '';
 386 };
 387
 388 export const initAdvancedFormProjectsTree = () =>
 389     (dispatch: Dispatch) => {
 390         dispatch<any>(initUserProject(SEARCH_BAR_ADVANCED_FORM_PICKER_ID));
 391     };
 392
 393 export const changeAdvancedFormProperty = (propertyField: string, value: PropertyValue[] | string = '') =>
 394     (dispatch: Dispatch) => {
 395         dispatch(change(SEARCH_BAR_ADVANCED_FORM_NAME, propertyField, value));
 396     };
 397
 398 export const resetAdvancedFormProperty = (propertyField: string) =>
 399     (dispatch: Dispatch) => {
 400         dispatch(change(SEARCH_BAR_ADVANCED_FORM_NAME, propertyField, null));
 401         dispatch(untouch(SEARCH_BAR_ADVANCED_FORM_NAME, propertyField));
 402     };
 403
 404 export const moveUp = () =>
 405     (dispatch: Dispatch) => {
 406         dispatch(searchBarActions.MOVE_UP());
 407     };
 408
 409 export const moveDown = () =>
 410     (dispatch: Dispatch) => {
 411         dispatch(searchBarActions.MOVE_DOWN());
 412     };