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.

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

[Dashboard De-Angular] Enable URL title param for initial filter on dashboard listing #4480

Merged
Changes from 1 commit
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,16 @@
* SPDX-License-Identifier: Apache-2.0
*/

import React, { useCallback, useMemo } from 'react';
import React, { useCallback, useEffect, useMemo, useState } from 'react';
import { i18n } from '@osd/i18n';
import { useMount } from 'react-use';
import { useLocation } from 'react-router-dom';
import {
useOpenSearchDashboards,
TableListView,
} from '../../../../opensearch_dashboards_react/public';
import { CreateButton } from '../listing/create_button';
import { DashboardConstants } from '../../dashboard_constants';
import { DashboardConstants, createDashboardEditUrl } from '../../dashboard_constants';
import { DashboardServices } from '../../types';
import { getTableColumns } from '../utils/get_table_columns';
import { getNoItemsMessage } from '../utils/get_no_items_message';
Expand All @@ -34,6 +35,46 @@
},
} = useOpenSearchDashboards<DashboardServices>();

const location = useLocation();
const queryParameters = new URLSearchParams(location.search);
const initialFiltersFromURL = queryParameters.get('filter');
const [initialFilter, setInitialFilter] = useState<string | null>(initialFiltersFromURL);

Check warning on line 41 in src/plugins/dashboard/public/application/components/dashboard_listing.tsx

View check run for this annotation

Codecov / codecov/patch

src/plugins/dashboard/public/application/components/dashboard_listing.tsx#L38-L41

Added lines #L38 - L41 were not covered by tests

useEffect(() => {
const getDashboardsBasedOnUrl = async () => {
const title = queryParameters.get('title');

Check warning on line 45 in src/plugins/dashboard/public/application/components/dashboard_listing.tsx

View check run for this annotation

Codecov / codecov/patch

src/plugins/dashboard/public/application/components/dashboard_listing.tsx#L43-L45

Added lines #L43 - L45 were not covered by tests

try {

Check warning on line 47 in src/plugins/dashboard/public/application/components/dashboard_listing.tsx

View check run for this annotation

Codecov / codecov/patch

src/plugins/dashboard/public/application/components/dashboard_listing.tsx#L47

Added line #L47 was not covered by tests
if (title) {
const results = await savedObjectsClient.find<any>({

Check warning on line 49 in src/plugins/dashboard/public/application/components/dashboard_listing.tsx

View check run for this annotation

Codecov / codecov/patch

src/plugins/dashboard/public/application/components/dashboard_listing.tsx#L49

Added line #L49 was not covered by tests
search: `"${title}"`,
searchFields: ['title'],
type: 'dashboard',
});

const matchingDashboards = results.savedObjects.filter(
(dashboard) => dashboard.attributes.title.toLowerCase() === title.toLowerCase()

Check warning on line 56 in src/plugins/dashboard/public/application/components/dashboard_listing.tsx

View check run for this annotation

Codecov / codecov/patch

src/plugins/dashboard/public/application/components/dashboard_listing.tsx#L55-L56

Added lines #L55 - L56 were not covered by tests
);

if (matchingDashboards.length === 1) {
history.replace(createDashboardEditUrl(matchingDashboards[0].id));

Check warning on line 60 in src/plugins/dashboard/public/application/components/dashboard_listing.tsx

View check run for this annotation

Codecov / codecov/patch

src/plugins/dashboard/public/application/components/dashboard_listing.tsx#L60

Added line #L60 was not covered by tests
} else {
history.push(`${DashboardConstants.LANDING_PAGE_PATH}?filter="${title}"`);
setInitialFilter(title);

Check warning on line 63 in src/plugins/dashboard/public/application/components/dashboard_listing.tsx

View check run for this annotation

Codecov / codecov/patch

src/plugins/dashboard/public/application/components/dashboard_listing.tsx#L62-L63

Added lines #L62 - L63 were not covered by tests
}
return new Promise(() => {});

Check warning on line 65 in src/plugins/dashboard/public/application/components/dashboard_listing.tsx

View check run for this annotation

Codecov / codecov/patch

src/plugins/dashboard/public/application/components/dashboard_listing.tsx#L65

Added line #L65 was not covered by tests
}
} catch (e) {
notifications.toasts.addWarning(

Check warning on line 68 in src/plugins/dashboard/public/application/components/dashboard_listing.tsx

View check run for this annotation

Codecov / codecov/patch

src/plugins/dashboard/public/application/components/dashboard_listing.tsx#L68

Added line #L68 was not covered by tests
i18n.translate('dashboard.listing. savedObjectWarning', {
defaultMessage: 'Uble to filter by title',
Copy link
Member

Choose a reason for hiding this comment

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

uble

Copy link
Member

Choose a reason for hiding this comment

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

unable?

})
);
}
};
getDashboardsBasedOnUrl();

Check warning on line 75 in src/plugins/dashboard/public/application/components/dashboard_listing.tsx

View check run for this annotation

Codecov / codecov/patch

src/plugins/dashboard/public/application/components/dashboard_listing.tsx#L75

Added line #L75 was not covered by tests
}, [savedObjectsClient, history, notifications.toasts, queryParameters]);

const hideWriteControls = dashboardConfig.getHideWriteControls();

const tableColumns = useMemo(() => getTableColumns(application, history, uiSettings), [
Expand Down Expand Up @@ -143,7 +184,7 @@
editItem={hideWriteControls ? undefined : editItem}
tableColumns={tableColumns}
listingLimit={listingLimit}
initialFilter={''}
initialFilter={initialFilter ?? ''}
initialPageSize={initialPageSize}
noItemsFragment={noItemsFragment}
entityName={i18n.translate('dashboard.listing.table.entityName', {
Expand Down
Loading