-
Notifications
You must be signed in to change notification settings - Fork 187
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
52 changed files
with
823 additions
and
896 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
1 change: 1 addition & 0 deletions
1
plugins/main/public/components/common/hooks/saved_query/constants.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| export const SAVED_QUERY = 'savedQuery'; |
185 changes: 185 additions & 0 deletions
185
plugins/main/public/components/common/hooks/saved_query/use_saved_query.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,185 @@ | ||
| /* | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| * | ||
| * The OpenSearch Contributors require contributions made to | ||
| * this file be licensed under the Apache-2.0 license or a | ||
| * compatible open source license. | ||
| * | ||
| * Any modifications Copyright OpenSearch Contributors. See | ||
| * GitHub history for details. | ||
| */ | ||
|
|
||
| /* | ||
| * Licensed to Elasticsearch B.V. under one or more contributor | ||
| * license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright | ||
| * ownership. Elasticsearch B.V. licenses this file to you under | ||
| * the Apache License, Version 2.0 (the "License"); you may | ||
| * not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
|
|
||
| import { useState, useEffect } from 'react'; | ||
| import { | ||
| DataPublicPluginStart, | ||
| RefreshInterval, | ||
| SavedQuery, | ||
| TimeRange, | ||
| Query, | ||
| Filter, | ||
| } from '../../../../../../../src/plugins/data/public'; | ||
| import NavigationService from '../../../../react-services/navigation-service'; | ||
| import { OSD_URL_STATE_STORAGE_ID } from '../../../../../common/constants'; | ||
| import { getDataPlugin, getUiSettings } from '../../../../kibana-services'; | ||
| import { createOsdUrlStateStorage } from '../../../../../../../src/plugins/opensearch_dashboards_utils/public'; | ||
| import OsdUrlStateStorage from '../../../../react-services/state-storage'; | ||
|
|
||
| interface Options { | ||
| firstTime?: boolean; | ||
| } | ||
|
|
||
| interface UseSavedQueriesProps { | ||
| queryService: DataPublicPluginStart['query']; | ||
| setTimeFilter: (timeFilter: TimeRange) => void; | ||
| setRefreshInterval: (refreshInterval: RefreshInterval) => void; | ||
| setQuery: (query?: Query) => void; | ||
| setFilters: (filters: Filter[]) => void; | ||
| } | ||
|
|
||
| interface UseSavedQueriesReturn { | ||
| savedQuery?: SavedQuery; | ||
| setSavedQuery: (savedQuery: SavedQuery) => void; | ||
| clearSavedQuery: () => void; | ||
| } | ||
|
|
||
| export const useSavedQuery = ( | ||
| props: UseSavedQueriesProps, | ||
| ): UseSavedQueriesReturn => { | ||
| // Handle saved queries | ||
| const [savedQuery, setSavedQuery] = useState<SavedQuery | undefined>(); | ||
| const data = getDataPlugin(); | ||
| const config = getUiSettings(); | ||
| const history = NavigationService.getInstance().getHistory(); | ||
| const osdUrlStateStorage = createOsdUrlStateStorage({ | ||
| useHash: config.get(OSD_URL_STATE_STORAGE_ID), | ||
| history: history, | ||
| }); | ||
|
|
||
| const getAppFilters = ( | ||
| newSavedQuery?: SavedQuery, | ||
| { firstTime }: Options = { firstTime: false }, | ||
| ) => { | ||
| const { filterManager } = props.queryService; | ||
| // When the page reloads, savedQuery starts as undefined, so retrieve the time and refreshInterval from the URL. | ||
| return firstTime | ||
| ? filterManager.getAppFilters() | ||
| : newSavedQuery?.attributes.filters ?? []; | ||
| }; | ||
|
|
||
| const getQuery = ( | ||
| newSavedQuery?: SavedQuery, | ||
| { firstTime }: Options = { firstTime: false }, | ||
| ) => { | ||
| const { queryString } = props.queryService; | ||
| // When the page reloads, savedQuery starts as undefined, so retrieve the time and refreshInterval from the URL. | ||
| return firstTime | ||
| ? queryString.getQuery() | ||
| : newSavedQuery?.attributes.query ?? { query: '', language: 'kuery' }; | ||
| }; | ||
|
|
||
| const getTimeFilter = ( | ||
| newSavedQuery?: SavedQuery, | ||
| { firstTime }: Options = { firstTime: false }, | ||
| ) => { | ||
| const { timefilter } = props.queryService; | ||
| // When the page reloads, savedQuery starts as undefined, so retrieve the time and refreshInterval from the URL. | ||
| return firstTime | ||
| ? timefilter.timefilter.getTime() | ||
| : newSavedQuery?.attributes.timefilter; | ||
| }; | ||
|
|
||
| const getRefreshInterval = ( | ||
| newSavedQuery?: SavedQuery, | ||
| { firstTime }: Options = { firstTime: false }, | ||
| ) => { | ||
| const { timefilter } = props.queryService; | ||
| // When the page reloads, savedQuery starts as undefined, so retrieve the time and refreshInterval from the URL. | ||
| return firstTime | ||
| ? timefilter.timefilter.getRefreshInterval() | ||
| : newSavedQuery?.attributes.timefilter?.refreshInterval; | ||
| }; | ||
|
|
||
| const setTimeFilter = (timeFilter: TimeRange) => { | ||
| props.setTimeFilter(timeFilter); | ||
| props.queryService.timefilter.timefilter.setTime(timeFilter); | ||
| }; | ||
|
|
||
| const saveSavedQuery = async ( | ||
| newSavedQuery?: SavedQuery, | ||
| { firstTime }: Options = { firstTime: false }, | ||
| ) => { | ||
| setSavedQuery(newSavedQuery); | ||
| const filters = getAppFilters(newSavedQuery, { firstTime }); | ||
| const query = getQuery(newSavedQuery, { firstTime }); | ||
| await OsdUrlStateStorage(data, osdUrlStateStorage).replaceUrlAppState({ | ||
| savedQuery: newSavedQuery?.id, | ||
| }); | ||
| props.setFilters(filters); | ||
| props.setQuery(query); | ||
| if (newSavedQuery?.attributes.timefilter) { | ||
| setTimeFilter(getTimeFilter(newSavedQuery, { firstTime })); | ||
| props.setRefreshInterval( | ||
| getRefreshInterval(newSavedQuery, { firstTime }), | ||
| ); | ||
| } | ||
| }; | ||
|
|
||
| const updateSavedQuery = async ( | ||
| savedQuery: SavedQuery, | ||
| { firstTime }: { firstTime?: boolean } = { firstTime: false }, | ||
| ) => { | ||
| saveSavedQuery(savedQuery, { firstTime }); | ||
| }; | ||
|
|
||
| const clearSavedQuery = () => { | ||
| // remove saved query from url | ||
| saveSavedQuery(undefined); | ||
| }; | ||
|
|
||
| // Effect is used to convert a saved query id into an object | ||
| useEffect(() => { | ||
| const fetchSavedQuery = async () => { | ||
| try { | ||
| const savedQueryId = OsdUrlStateStorage( | ||
| data, | ||
| osdUrlStateStorage, | ||
| ).getAppStateFromUrl().savedQuery as string; | ||
| if (!savedQueryId) return; | ||
| // fetch saved query | ||
| const savedQuery = await props.queryService.savedQueries.getSavedQuery( | ||
| savedQueryId, | ||
| ); | ||
| updateSavedQuery(savedQuery, { firstTime: true }); | ||
| } catch (error) { | ||
| clearSavedQuery(); | ||
| } | ||
| }; | ||
|
|
||
| fetchSavedQuery(); | ||
| }, [props.queryService, props.queryService.savedQueries]); | ||
|
|
||
| return { | ||
| savedQuery, | ||
| setSavedQuery: updateSavedQuery, | ||
| clearSavedQuery, | ||
| }; | ||
| }; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.