Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Adjusted source of QueryStringManager functions for flyout. #8864

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open

Adjusted source of QueryStringManager functions for flyout. #8864

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
da36888
Change origin of query string management functions.
AWSHurneyt Nov 14, 2024
9867fe8
Added try/catch block.
AWSHurneyt Nov 14, 2024
b0a31bc
Changed source of query string management functions.
AWSHurneyt Nov 14, 2024
654fa32
Fixed typo.
AWSHurneyt Nov 14, 2024
7864ebd
Fixed import.
AWSHurneyt Nov 14, 2024
b4e32f7
Fix lint errors.
AWSHurneyt Nov 14, 2024
3013ed8
Fixed lint error.
AWSHurneyt Nov 14, 2024
c6e6441
Fixed test mocks.
AWSHurneyt Nov 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 1 addition & 3 deletions src/plugins/data/public/ui/filter_bar/filter_options.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ import {
import { FilterEditor } from './filter_editor';
import { useOpenSearchDashboards } from '../../../../opensearch_dashboards_react/public';
import { SavedQueryManagementComponent } from '../saved_query_management';
import { QueryStringManager, SavedQuery, SavedQueryService } from '../../query';
import { SavedQuery, SavedQueryService } from '../../query';
import { SavedQueryMeta } from '../saved_query_form';
import { getUseNewSavedQueriesUI } from '../../services';

Expand All @@ -79,7 +79,6 @@ interface Props {
useSaveQueryMenu: boolean;
isQueryEditorControl: boolean;
saveQuery: (savedQueryMeta: SavedQueryMeta, saveAsNew?: boolean) => Promise<void>;
queryStringManager: QueryStringManager;
}
const maxFilterWidth = 600;

Expand Down Expand Up @@ -311,7 +310,6 @@ const FilterOptionsUI = (props: Props) => {
key={'savedQueryManagement'}
useNewSavedQueryUI={getUseNewSavedQueriesUI()}
saveQuery={props.saveQuery}
queryStringManager={props.queryStringManager}
/>,
]}
data-test-subj="save-query-panel"
Expand Down
15 changes: 9 additions & 6 deletions src/plugins/data/public/ui/saved_query_flyouts/open_saved_query_flyout.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,14 @@
*/

import React from 'react';
import { render, screen, fireEvent, waitFor, act } from '@testing-library/react';
import { render, screen, fireEvent, waitFor } from '@testing-library/react';
import { OpenSavedQueryFlyout } from './open_saved_query_flyout';
import { createSavedQueryService } from '../../../public/query/saved_query/saved_query_service';
import { applicationServiceMock, uiSettingsServiceMock } from '../../../../../core/public/mocks';
import { SavedQueryAttributes } from '../../../public/query/saved_query/types';
import '@testing-library/jest-dom';
import { queryStringManagerMock } from '../../../../data/public/query/query_string/query_string_manager.mock';
import { getQueryService } from '../../services';

const savedQueryAttributesWithTemplate: SavedQueryAttributes = {
title: 'foo',
Expand Down Expand Up @@ -63,6 +64,10 @@ jest.mock('@osd/i18n', () => ({
},
}));

jest.mock('../../services', () => ({
getQueryService: jest.fn(),
}));

const mockSavedQueryService = createSavedQueryService(
// @ts-ignore
mockSavedObjectsClient,
Expand Down Expand Up @@ -100,6 +105,9 @@ jest.spyOn(mockSavedQueryService, 'getAllSavedQueries').mockResolvedValue(savedQ
describe('OpenSavedQueryFlyout', () => {
beforeEach(() => {
jest.clearAllMocks();
(getQueryService as jest.Mock).mockReturnValue({
queryString: queryStringManagerMock.createSetupContract(),
});
});

it('should render the flyout with correct tabs and content', async () => {
Expand All @@ -109,7 +117,6 @@ describe('OpenSavedQueryFlyout', () => {
onClose={mockOnClose}
onQueryOpen={mockOnQueryOpen}
handleQueryDelete={mockHandleQueryDelete}
queryStringManager={queryStringManagerMock.createSetupContract()}
/>
);

Expand Down Expand Up @@ -141,7 +148,6 @@ describe('OpenSavedQueryFlyout', () => {
onClose={mockOnClose}
onQueryOpen={mockOnQueryOpen}
handleQueryDelete={mockHandleQueryDelete}
queryStringManager={queryStringManagerMock.createSetupContract()}
/>
);

Expand All @@ -162,7 +168,6 @@ describe('OpenSavedQueryFlyout', () => {
onClose={mockOnClose}
onQueryOpen={mockOnQueryOpen}
handleQueryDelete={mockHandleQueryDelete}
queryStringManager={queryStringManagerMock.createSetupContract()}
/>
);

Expand All @@ -181,7 +186,6 @@ describe('OpenSavedQueryFlyout', () => {
onClose={mockOnClose}
onQueryOpen={mockOnQueryOpen}
handleQueryDelete={mockHandleQueryDelete}
queryStringManager={queryStringManagerMock.createSetupContract()}
/>
);

Expand Down Expand Up @@ -214,7 +218,6 @@ describe('OpenSavedQueryFlyout', () => {
onClose={mockOnClose}
onQueryOpen={mockOnQueryOpen}
handleQueryDelete={mockHandleQueryDelete}
queryStringManager={queryStringManagerMock.createSetupContract()}
/>
);

Expand Down
54 changes: 30 additions & 24 deletions src/plugins/data/public/ui/saved_query_flyouts/open_saved_query_flyout.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,16 +24,16 @@
} from '@elastic/eui';
import React, { useCallback, useEffect, useRef, useState } from 'react';
import { i18n } from '@osd/i18n';
import { QueryStringManager, SavedQuery, SavedQueryService } from '../../query';
import { SavedQuery, SavedQueryService } from '../../query';
import { SavedQueryCard } from './saved_query_card';
import { Query } from '../../../common';
import { getQueryService } from '../../services';

export interface OpenSavedQueryFlyoutProps {
savedQueryService: SavedQueryService;
onClose: () => void;
onQueryOpen: (query: SavedQuery) => void;
handleQueryDelete: (query: SavedQuery) => Promise<void>;
queryStringManager: QueryStringManager;
}

interface SavedQuerySearchableItem {
Expand All @@ -50,7 +50,6 @@
onClose,
onQueryOpen,
handleQueryDelete,
queryStringManager,
}: OpenSavedQueryFlyoutProps) {
const [selectedTabId, setSelectedTabId] = useState<string>('mutable-saved-queries');
const [savedQueries, setSavedQueries] = useState<SavedQuery[]>([]);
Expand All @@ -65,36 +64,43 @@
const [searchQuery, setSearchQuery] = useState(EuiSearchBar.Query.MATCH_ALL);
const [isLoading, setIsLoading] = useState(false);
const currentTabIdRef = useRef(selectedTabId);
const queryStringManager = getQueryService().queryString;

const fetchAllSavedQueriesForSelectedTab = useCallback(async () => {
setIsLoading(true);
const query = queryStringManager.getQuery();
let templateQueries: any[] = [];
try {
const query = queryStringManager.getQuery();
let templateQueries: any[] = [];

// fetch sample query based on dataset type
if (query?.dataset?.type) {
templateQueries =
(await queryStringManager
.getDatasetService()
?.getType(query.dataset.type)
?.getSampleQueries?.()) || [];
// fetch sample query based on dataset type
if (query?.dataset?.type) {
templateQueries =

Check warning on line 77 in src/plugins/data/public/ui/saved_query_flyouts/open_saved_query_flyout.tsx

View check run for this annotation

Codecov / codecov/patch

src/plugins/data/public/ui/saved_query_flyouts/open_saved_query_flyout.tsx#L77 

Added line #L77 was not covered by tests
(await queryStringManager
.getDatasetService()
?.getType(query.dataset.type)
?.getSampleQueries?.()) || [];

// Check if any sample query has isTemplate set to true
const hasTemplates = templateQueries.some((q) => q?.attributes?.isTemplate);
setHasTemplateQueries(hasTemplates);
}
// Check if any sample query has isTemplate set to true
const hasTemplates = templateQueries.some((q) => q?.attributes?.isTemplate);
setHasTemplateQueries(hasTemplates);

Check warning on line 85 in src/plugins/data/public/ui/saved_query_flyouts/open_saved_query_flyout.tsx

View check run for this annotation

Codecov / codecov/patch

src/plugins/data/public/ui/saved_query_flyouts/open_saved_query_flyout.tsx#L84-L85 

Added lines #L84 - L85 were not covered by tests
}

// Set queries based on the current tab
if (currentTabIdRef.current === 'mutable-saved-queries') {
const allQueries = await savedQueryService.getAllSavedQueries();
const mutableSavedQueries = allQueries.filter((q) => !q.attributes.isTemplate);
// Set queries based on the current tab
if (currentTabIdRef.current === 'mutable-saved-queries') {
setSavedQueries(mutableSavedQueries);
const allQueries = await savedQueryService.getAllSavedQueries();
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we should refactor this component. we shouldn't need to fire a request to get all saved queries if the user opened saved queries and then switched to template queries and then switch back to saved queries and fire a request. we already have their saved queries

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes i think we already noticed the queries taking way longer to show up than they should

const mutableSavedQueries = allQueries.filter((q) => !q.attributes.isTemplate);
if (currentTabIdRef.current === 'mutable-saved-queries') {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is this required? line 89 should be covering it right?

Copy link
Author

@AWSHurneyt AWSHurneyt Nov 14, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jowg-amazon could you clarify?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We were noticing that the getAllSavedQueries call can take a little while to return. If a user switches tabs before this call is finished, we were seeing that setSavedQueries(mutableSavedQueries) was overwriting the saved queries incorrectly. This check makes sure that we're still on the mutable saved queries tab.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

instead of just have a state variable that sets a boolean if it hasTemplateQueries, why don't we just have a state variable for templateQueries and a state variable mutableSavedQueries.

Or even more so just set saved queries to all queries and then in the component if the selected tab is template-saved-queries you filter out all the saved queries not matching template-saved-queries etc.

setSavedQueries(mutableSavedQueries);
}
} else if (currentTabIdRef.current === 'template-saved-queries') {
setSavedQueries(templateQueries);

Check warning on line 96 in src/plugins/data/public/ui/saved_query_flyouts/open_saved_query_flyout.tsx

View check run for this annotation

Codecov / codecov/patch

src/plugins/data/public/ui/saved_query_flyouts/open_saved_query_flyout.tsx#L96 

Added line #L96 was not covered by tests
}
} else if (currentTabIdRef.current === 'template-saved-queries') {
setSavedQueries(templateQueries);
} catch (e) {
// eslint-disable-next-line no-console
console.error('Error occurred while retrieving saved queries.', e);

Check warning on line 100 in src/plugins/data/public/ui/saved_query_flyouts/open_saved_query_flyout.tsx

View check run for this annotation

Codecov / codecov/patch

src/plugins/data/public/ui/saved_query_flyouts/open_saved_query_flyout.tsx#L100 

Added line #L100 was not covered by tests
} finally {
setIsLoading(false);
}
setIsLoading(false);
}, [savedQueryService, currentTabIdRef, setSavedQueries, queryStringManager]);

const updatePageIndex = useCallback((index: number) => {
Expand Down
5 changes: 1 addition & 4 deletions src/plugins/data/public/ui/saved_query_management/saved_query_management_component.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ import {
import { i18n } from '@osd/i18n';
import React, { useCallback, useEffect, useState, Fragment, useRef } from 'react';
import { sortBy } from 'lodash';
import { QueryStringManager, SavedQuery, SavedQueryService } from '../..';
import { SavedQuery, SavedQueryService } from '../..';
import { SavedQueryListItem } from './saved_query_list_item';
import {
toMountPoint,
Expand All @@ -70,7 +70,6 @@ interface Props {
onClearSavedQuery: () => void;
closeMenuPopover: () => void;
saveQuery: (savedQueryMeta: SavedQueryMeta, saveAsNew?: boolean) => Promise<void>;
queryStringManager: QueryStringManager;
}

export function SavedQueryManagementComponent({
Expand All @@ -84,7 +83,6 @@ export function SavedQueryManagementComponent({
closeMenuPopover,
useNewSavedQueryUI,
saveQuery,
queryStringManager,
}: Props) {
const [savedQueries, setSavedQueries] = useState([] as SavedQuery[]);
const [count, setTotalCount] = useState(0);
Expand Down Expand Up @@ -258,7 +256,6 @@ export function SavedQueryManagementComponent({
onClose={() => openSavedQueryFlyout?.close().then()}
onQueryOpen={onLoad}
handleQueryDelete={handleDelete}
queryStringManager={queryStringManager}
/>
)
);
Expand Down
1 change: 0 additions & 1 deletion src/plugins/data/public/ui/search_bar/create_search_bar.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,6 @@ export function createSearchBar({ core, storage, data }: StatefulSearchBarDeps)
isRefreshPaused={refreshInterval.pause}
filters={filters}
query={query}
queryStringManager={data.query.queryString}
onFiltersUpdated={defaultFiltersUpdated(data.query)}
onRefreshChange={defaultOnRefreshChange(data.query)}
savedQuery={savedQuery}
Expand Down
10 changes: 1 addition & 9 deletions src/plugins/data/public/ui/search_bar/search_bar.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,13 +38,7 @@ import {
withOpenSearchDashboards,
} from '../../../../opensearch_dashboards_react/public';
import { Filter, IIndexPattern, Query, TimeRange, UI_SETTINGS } from '../../../common';
import {
SavedQuery,
SavedQueryAttributes,
TimeHistoryContract,
QueryStatus,
QueryStringManager,
} from '../../query';
import { SavedQuery, SavedQueryAttributes, TimeHistoryContract, QueryStatus } from '../../query';
import { IDataPluginServices } from '../../types';
import { FilterBar } from '../filter_bar/filter_bar';
import { QueryEditorTopRow } from '../query_editor';
Expand Down Expand Up @@ -101,7 +95,6 @@ export interface SearchBarOwnProps {
onRefresh?: (payload: { dateRange: TimeRange }) => void;
indicateNoData?: boolean;
queryStatus?: QueryStatus;
queryStringManager: QueryStringManager;
}

export type SearchBarProps = SearchBarOwnProps & SearchBarInjectedDeps;
Expand Down Expand Up @@ -474,7 +467,6 @@ class SearchBarUI extends Component<SearchBarProps, State> {
useSaveQueryMenu={useSaveQueryMenu}
isQueryEditorControl={isQueryEditorControl}
saveQuery={this.onSave}
queryStringManager={this.props.queryStringManager}
/>
)
);
Expand Down
Loading