Merge branch '14917-searching-by-properties'
[arvados-workbench2.git] / 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 { arrayPush, change, initialize } 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, isResourceUuid, extractUuidKind } 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, SearchBarAdvanceFormData } from '~/models/search-bar';
18 import { debounce } from 'debounce';
19 import * as _ from "lodash";
20 import { getModifiedKeysValues } from "~/common/objects";
21 import { activateSearchBarProject } from "~/store/search-bar/search-bar-tree-actions";
22 import { Session } from "~/models/session";
23 import { searchResultsPanelActions } from "~/store/search-results-panel/search-results-panel-actions";
24 import { ListResults } from "~/services/common-service/common-service";
25 import * as parser from './search-query/arv-parser';
26 import { Keywords } from './search-query/arv-parser';
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<SearchBarAdvanceFormData[]>(),
35     SET_RECENT_QUERIES: ofType<string[]>(),
36     UPDATE_SAVED_QUERY: ofType<SearchBarAdvanceFormData[]>(),
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_ADVANCE_FORM_NAME = 'searchBarAdvanceFormName';
46
47 export const SEARCH_BAR_ADVANCE_FORM_PICKER_ID = 'searchBarAdvanceFormPickerId';
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);
75             }
76         }
77     };
78
79 export const searchAdvanceData = (data: SearchBarAdvanceFormData) =>
80     async (dispatch: Dispatch) => {
81         dispatch<any>(saveQuery(data));
82         dispatch(searchResultsPanelActions.CLEAR());
83         dispatch(searchBarActions.SET_CURRENT_VIEW(SearchView.BASIC));
84         dispatch(searchBarActions.CLOSE_SEARCH_VIEW());
85         dispatch(navigateToSearchResults);
86     };
87
88 export const setSearchValueFromAdvancedData = (data: SearchBarAdvanceFormData, prevData?: SearchBarAdvanceFormData) =>
89     (dispatch: Dispatch, getState: () => RootState) => {
90         const searchValue = getState().searchBar.searchValue;
91         const value = getQueryFromAdvancedData({
92             ...data,
93             searchValue
94         }, prevData);
95         dispatch(searchBarActions.SET_SEARCH_VALUE(value));
96     };
97
98 export const setAdvancedDataFromSearchValue = (search: string) =>
99     async (dispatch: Dispatch) => {
100         const data = getAdvancedDataFromQuery(search);
101         dispatch<any>(initialize(SEARCH_BAR_ADVANCE_FORM_NAME, data));
102         if (data.projectUuid) {
103             await dispatch<any>(activateSearchBarProject(data.projectUuid));
104             dispatch(treePickerActions.ACTIVATE_TREE_PICKER_NODE({ pickerId: SEARCH_BAR_ADVANCE_FORM_PICKER_ID, id: data.projectUuid }));
105         }
106     };
107
108 const saveQuery = (data: SearchBarAdvanceFormData) =>
109     (dispatch: Dispatch<any>, getState: () => RootState, services: ServiceRepository) => {
110         const savedQueries = services.searchService.getSavedQueries();
111         if (data.saveQuery && data.queryName) {
112             const filteredQuery = savedQueries.find(query => query.queryName === data.queryName);
113             data.searchValue = getState().searchBar.searchValue;
114             if (filteredQuery) {
115                 services.searchService.editSavedQueries(data);
116                 dispatch(searchBarActions.UPDATE_SAVED_QUERY(savedQueries));
117                 dispatch(snackbarActions.OPEN_SNACKBAR({ message: 'Query has been successfully updated', hideDuration: 2000, kind: SnackbarKind.SUCCESS }));
118             } else {
119                 services.searchService.saveQuery(data);
120                 dispatch(searchBarActions.SET_SAVED_QUERIES(savedQueries));
121                 dispatch(snackbarActions.OPEN_SNACKBAR({ message: 'Query has been successfully saved', hideDuration: 2000, kind: SnackbarKind.SUCCESS }));
122             }
123         }
124     };
125
126 export const deleteSavedQuery = (id: number) =>
127     (dispatch: Dispatch<any>, getState: () => RootState, services: ServiceRepository) => {
128         services.searchService.deleteSavedQuery(id);
129         const savedSearchQueries = services.searchService.getSavedQueries();
130         dispatch(searchBarActions.SET_SAVED_QUERIES(savedSearchQueries));
131         return savedSearchQueries || [];
132     };
133
134 export const editSavedQuery = (data: SearchBarAdvanceFormData) =>
135     (dispatch: Dispatch<any>) => {
136         dispatch(searchBarActions.SET_CURRENT_VIEW(SearchView.ADVANCED));
137         dispatch(searchBarActions.SET_SEARCH_VALUE(getQueryFromAdvancedData(data)));
138         dispatch<any>(initialize(SEARCH_BAR_ADVANCE_FORM_NAME, data));
139     };
140
141 export const openSearchView = () =>
142     (dispatch: Dispatch<any>, getState: () => RootState, services: ServiceRepository) => {
143         const savedSearchQueries = services.searchService.getSavedQueries();
144         dispatch(searchBarActions.SET_SAVED_QUERIES(savedSearchQueries));
145         dispatch(loadRecentQueries());
146         dispatch(searchBarActions.OPEN_SEARCH_VIEW());
147         dispatch(searchBarActions.SELECT_FIRST_ITEM());
148     };
149
150 export const closeSearchView = () =>
151     (dispatch: Dispatch<any>) => {
152         dispatch(searchBarActions.SET_SELECTED_ITEM(''));
153         dispatch(searchBarActions.CLOSE_SEARCH_VIEW());
154     };
155
156 export const closeAdvanceView = () =>
157     (dispatch: Dispatch<any>) => {
158         dispatch(searchBarActions.SET_SEARCH_VALUE(''));
159         dispatch(treePickerActions.DEACTIVATE_TREE_PICKER_NODE({ pickerId: SEARCH_BAR_ADVANCE_FORM_PICKER_ID }));
160         dispatch(searchBarActions.SET_CURRENT_VIEW(SearchView.BASIC));
161     };
162
163 export const navigateToItem = (uuid: string) =>
164     (dispatch: Dispatch<any>) => {
165         dispatch(searchBarActions.SET_SELECTED_ITEM(''));
166         dispatch(searchBarActions.CLOSE_SEARCH_VIEW());
167         dispatch(navigateTo(uuid));
168     };
169
170 export const changeData = (searchValue: string) =>
171     (dispatch: Dispatch, getState: () => RootState) => {
172         dispatch(searchBarActions.SET_SEARCH_VALUE(searchValue));
173         const currentView = getState().searchBar.currentView;
174         const searchValuePresent = searchValue.length > 0;
175
176         if (currentView === SearchView.ADVANCED) {
177             dispatch(searchBarActions.SET_CURRENT_VIEW(SearchView.AUTOCOMPLETE));
178         } else if (searchValuePresent) {
179             dispatch(searchBarActions.SET_CURRENT_VIEW(SearchView.AUTOCOMPLETE));
180             dispatch(searchBarActions.SET_SELECTED_ITEM(searchValue));
181             debounceStartSearch(dispatch);
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         dispatch(searchBarActions.SET_SEARCH_VALUE(searchValue));
197         dispatch(searchBarActions.SET_SEARCH_RESULTS([]));
198         dispatch(searchResultsPanelActions.CLEAR());
199         dispatch(navigateToSearchResults);
200     };
201
202 const debounceStartSearch = debounce((dispatch: Dispatch) => dispatch<any>(startSearch()), DEFAULT_SEARCH_DEBOUNCE);
203
204 const startSearch = () =>
205     (dispatch: Dispatch, getState: () => RootState) => {
206         const searchValue = getState().searchBar.searchValue;
207         dispatch<any>(searchData(searchValue));
208     };
209
210 const searchGroups = (searchValue: string, limit: number) =>
211     async (dispatch: Dispatch, getState: () => RootState, services: ServiceRepository) => {
212         const currentView = getState().searchBar.currentView;
213
214         if (searchValue || currentView === SearchView.ADVANCED) {
215             const { cluster: clusterId } = getAdvancedDataFromQuery(searchValue);
216             const sessions = getSearchSessions(clusterId, getState().auth.sessions);
217             const lists: ListResults<GroupContentsResource>[] = await Promise.all(sessions.map(session => {
218                 const filters = queryToFilters(searchValue);
219                 return services.groupsService.contents('', {
220                     filters,
221                     limit,
222                     recursive: true
223                 }, session);
224             }));
225
226             const items = lists.reduce((items, list) => items.concat(list.items), [] as GroupContentsResource[]);
227             dispatch(searchBarActions.SET_SEARCH_RESULTS(items));
228         }
229     };
230
231 const buildQueryFromKeyMap = (data: any, keyMap: string[][], mode: 'rebuild' | 'reuse') => {
232     let value = data.searchValue;
233
234     const addRem = (field: string, key: string) => {
235         const v = data[key];
236
237         if (data.hasOwnProperty(key)) {
238             const pattern = v === false
239                 ? `${field.replace(':', '\\:\\s*')}\\s*`
240                 : `${field.replace(':', '\\:\\s*')}\\:\\s*[\\w|\\#|\\-|\\/]*\\s*`;
241             value = value.replace(new RegExp(pattern), '');
242         }
243
244         if (v) {
245             const nv = v === true
246                 ? `${field}`
247                 : `${field}:${v}`;
248
249             if (mode === 'rebuild') {
250                 value = value + ' ' + nv;
251             } else {
252                 value = nv + ' ' + value;
253             }
254         }
255     };
256
257     keyMap.forEach(km => addRem(km[0], km[1]));
258
259     return value;
260 };
261
262 export const getQueryFromAdvancedData = (data: SearchBarAdvanceFormData, prevData?: SearchBarAdvanceFormData) => {
263     let value = '';
264
265     const flatData = (data: SearchBarAdvanceFormData) => {
266         const fo = {
267             searchValue: data.searchValue,
268             type: data.type,
269             cluster: data.cluster,
270             projectUuid: data.projectUuid,
271             inTrash: data.inTrash,
272             dateFrom: data.dateFrom,
273             dateTo: data.dateTo,
274         };
275         (data.properties || []).forEach(p => fo[`prop-"${p.key}"`] = `"${p.value}"`);
276         return fo;
277     };
278
279     const keyMap = [
280         ['type', 'type'],
281         ['cluster', 'cluster'],
282         ['project', 'projectUuid'],
283         [`is:${parser.States.TRASHED}`, 'inTrash'],
284         ['from', 'dateFrom'],
285         ['to', 'dateTo']
286     ];
287     _.union(data.properties, prevData ? prevData.properties : [])
288         .forEach(p => keyMap.push([`has:"${p.key}"`, `prop-"${p.key}"`]));
289
290     if (prevData) {
291         const obj = getModifiedKeysValues(flatData(data), flatData(prevData));
292         value = buildQueryFromKeyMap({
293             searchValue: data.searchValue,
294             ...obj
295         } as SearchBarAdvanceFormData, keyMap, "reuse");
296     } else {
297         value = buildQueryFromKeyMap(flatData(data), keyMap, "rebuild");
298     }
299
300     value = value.trim();
301     return value;
302 };
303
304 export const getAdvancedDataFromQuery = (query: string): SearchBarAdvanceFormData => {
305     const { tokens, searchString } = parser.parseSearchQuery(query);
306     const getValue = parser.getValue(tokens);
307     return {
308         searchValue: searchString,
309         type: getValue(Keywords.TYPE) as ResourceKind,
310         cluster: getValue(Keywords.CLUSTER),
311         projectUuid: getValue(Keywords.PROJECT),
312         inTrash: parser.isTrashed(tokens),
313         dateFrom: getValue(Keywords.FROM) || '',
314         dateTo: getValue(Keywords.TO) || '',
315         properties: parser.getProperties(tokens),
316         saveQuery: false,
317         queryName: ''
318     };
319 };
320
321 export const getSearchSessions = (clusterId: string | undefined, sessions: Session[]): Session[] => {
322     return sessions.filter(s => s.loggedIn && (!clusterId || s.clusterId === clusterId));
323 };
324
325 export const queryToFilters = (query: string) => {
326     const data = getAdvancedDataFromQuery(query);
327     const filter = new FilterBuilder();
328     const resourceKind = data.type;
329
330     if(data.searchValue){
331         filter.addFullTextSearch(data.searchValue);
332     }
333
334     if (data.projectUuid) {
335         filter.addEqual('ownerUuid', data.projectUuid);
336     }
337
338     if (data.dateFrom) {
339         filter.addGte('modified_at', buildDateFilter(data.dateFrom));
340     }
341
342     if (data.dateTo) {
343         filter.addLte('modified_at', buildDateFilter(data.dateTo));
344     }
345
346     data.properties.forEach(p => {
347         if (p.value) {
348             filter
349                 .addILike(`properties.${p.key}`, p.value, GroupContentsResourcePrefix.PROJECT)
350                 .addILike(`properties.${p.key}`, p.value, GroupContentsResourcePrefix.COLLECTION);
351         }
352         filter.addExists(p.key);
353     });
354
355     return filter
356         .addIsA("uuid", buildUuidFilter(resourceKind))
357         .getFilters();
358 };
359
360 const buildUuidFilter = (type?: ResourceKind): ResourceKind[] => {
361     return type ? [type] : [ResourceKind.PROJECT, ResourceKind.COLLECTION, ResourceKind.PROCESS];
362 };
363
364 const buildDateFilter = (date?: string): string => {
365     return date ? date : '';
366 };
367
368 export const initAdvanceFormProjectsTree = () =>
369     (dispatch: Dispatch) => {
370         dispatch<any>(initUserProject(SEARCH_BAR_ADVANCE_FORM_PICKER_ID));
371     };
372
373 export const changeAdvanceFormProperty = (property: string, value: PropertyValue[] | string = '') =>
374     (dispatch: Dispatch) => {
375         dispatch(change(SEARCH_BAR_ADVANCE_FORM_NAME, property, value));
376     };
377
378 export const updateAdvanceFormProperties = (propertyValues: PropertyValue) =>
379     (dispatch: Dispatch) => {
380         dispatch(arrayPush(SEARCH_BAR_ADVANCE_FORM_NAME, 'properties', propertyValues));
381     };
382
383 export const moveUp = () =>
384     (dispatch: Dispatch) => {
385         dispatch(searchBarActions.MOVE_UP());
386     };
387
388 export const moveDown = () =>
389     (dispatch: Dispatch) => {
390         dispatch(searchBarActions.MOVE_DOWN());
391     };