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

Add extension point in saved object management to register namespaces and show filter #2656

Merged
merged 27 commits into from
Oct 28, 2022
Merged

Add extension point in saved object management to register namespaces and show filter #2656

Show file tree
Hide file tree
Changes from 20 commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
15878e3
Create filter registry for saved object management to make filters ex…
cwperks Oct 18, 2022
e61d803
WIP on making fetchCounts generic
cwperks Oct 19, 2022
ef6bd97
First step at making scroll_counts generic
cwperks Oct 19, 2022
bc6158c
Work on getting other filter counts with same object count endpoint
cwperks Oct 19, 2022
e3dc3b3
Get tenant count options to display
cwperks Oct 19, 2022
445ffc7
Extend find to work with namespaces for saved objects
cwperks Oct 20, 2022
f31e0ef
Add missing filterFields
cwperks Oct 20, 2022
f4d13eb
Update jest tests
cwperks Oct 20, 2022
ee15b77
Update saved_objects_table snapshot
cwperks Oct 20, 2022
2141b33
Append index to id to make unique
cwperks Oct 21, 2022
51b1325
Add semi-colon
cwperks Oct 21, 2022
c2ceffe
Fix saved objects table tests with new id scheme
cwperks Oct 21, 2022
5f01763
Only append idx on config type to ensure Advanced Settings have a uni…
cwperks Oct 21, 2022
2d97645
Remove itemsClone in favor of showing only Advanced Settings of curre…
cwperks Oct 21, 2022
0cd8012
Revert snapshots in table.test.tsx
cwperks Oct 24, 2022
b805531
Add additional parse_query test
cwperks Oct 24, 2022
9a153ea
Add comma
cwperks Oct 24, 2022
8211f5e
Create namespaceRegistry to decouple security dashboards plugin and o…
cwperks Oct 26, 2022
8bd743f
Merge branch 'add-namespace-filter-and-registry-to-saved-objects' int…
cwperks Oct 26, 2022
d2098e8
Add ability to register an alias
cwperks Oct 26, 2022
3331bf2
Update parse query and add to CHANGELOG
cwperks Oct 26, 2022
deb909f
Merge branch 'main' into saved-object-management-filter-registry
cwperks Oct 27, 2022
ad80403
Remove commented out code
cwperks Oct 27, 2022
05a3943
Address code review comments
cwperks Oct 27, 2022
24f9d38
Merge branch 'main' into saved-object-management-filter-registry
cwperks Oct 27, 2022
2630566
Override i18n if alias is regitered
cwperks Oct 27, 2022
9cd0900
Merge branch 'main' into saved-object-management-filter-registry
cwperks Oct 28, 2022
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
3 changes: 3 additions & 0 deletions src/plugins/saved_objects_management/public/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,9 @@ export {
SavedObjectsManagementColumnServiceSetup,
SavedObjectsManagementColumnServiceStart,
SavedObjectsManagementColumn,
SavedObjectsManagementNamespaceServiceSetup,
SavedObjectsManagementNamespaceServiceStart,
SavedObjectsManagementNamespace,
SavedObjectsManagementRecord,
ISavedObjectsManagementServiceRegistry,
SavedObjectsManagementServiceRegistryEntry,
Expand Down
3 changes: 2 additions & 1 deletion src/plugins/saved_objects_management/public/lib/get_saved_object_counts.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,11 @@ import { HttpStart } from 'src/core/public';
export async function getSavedObjectCounts(
http: HttpStart,
typesToInclude: string[],
namespacesToInclude: string[],
searchString?: string
): Promise<Record<string, number>> {
return await http.post<Record<string, number>>(
`/api/opensearch-dashboards/management/saved_objects/scroll/counts`,
{ body: JSON.stringify({ typesToInclude, searchString }) }
{ body: JSON.stringify({ typesToInclude, namespacesToInclude, searchString }) }
);
}
19 changes: 17 additions & 2 deletions src/plugins/saved_objects_management/public/lib/parse_query.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,23 @@ describe('getQueryText', () => {
it('should know how to get the text out of the AST', () => {
const ast = {
getTermClauses: () => [{ value: 'foo' }, { value: 'bar' }],
getFieldClauses: () => [{ value: 'lala' }, { value: 'lolo' }],
getFieldClauses: (field) => {
if (field === 'type') {
return [{ value: 'lala' }, { value: 'lolo' }];
} else if (field === 'namespaces') {
return [{ value: 'default' }];
}
return [];
},
};
expect(parseQuery({ ast } as any)).toEqual({ queryText: 'foo bar', visibleTypes: 'lala' });
expect(parseQuery({ ast } as any, ['type'])).toEqual({
queryText: 'foo bar',
parsedParams: { type: 'lala' },
});

expect(parseQuery({ ast } as any, ['namespaces'])).toEqual({
queryText: 'foo bar',
parsedParams: { namespaces: 'default' },
});
});
});
16 changes: 10 additions & 6 deletions src/plugins/saved_objects_management/public/lib/parse_query.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,12 +32,12 @@ import { Query } from '@elastic/eui';

interface ParsedQuery {
queryText?: string;
visibleTypes?: string[];
parsedParams?: any;
}

export function parseQuery(query: Query): ParsedQuery {
export function parseQuery(query: Query, filterFields: string[]): ParsedQuery {
let queryText: string | undefined;
let visibleTypes: string[] | undefined;
const parsedParams: any = {};

if (query) {
if (query.ast.getTermClauses().length) {
Expand All @@ -46,13 +46,17 @@ export function parseQuery(query: Query): ParsedQuery {
.map((clause: any) => clause.value)
.join(' ');
}
if (query.ast.getFieldClauses('type')) {
visibleTypes = query.ast.getFieldClauses('type')[0].value as string[];
if (!!filterFields) {
filterFields.forEach((field) => {
if (query.ast.getFieldClauses(field)) {
parsedParams[field] = query.ast.getFieldClauses(field)[0].value as string[];
}
});
}
}

return {
queryText,
visibleTypes,
parsedParams,
};
}
1 change: 1 addition & 0 deletions src/plugins/saved_objects_management/public/management_section/mount_section.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,7 @@ export const mountManagementSection = async ({
serviceRegistry={serviceRegistry}
actionRegistry={pluginStart.actions}
columnRegistry={pluginStart.columns}
namespaceRegistry={pluginStart.namespaces}
allowedTypes={allowedObjectTypes}
setBreadcrumbs={setBreadcrumbs}
/>
Expand Down
46 changes: 27 additions & 19 deletions ...t/public/management_section/objects_table/__snapshots__/saved_objects_table.test.tsx.snap
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

14 changes: 13 additions & 1 deletion ...aved_objects_management/public/management_section/objects_table/components/table.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,19 @@ const defaultProps: TableProps = {
selectionConfig: {
onSelectionChange: () => {},
},
filterOptions: [{ value: 2 }],
filters: [
{
type: 'field_value_selection',
field: 'type',
name: 'Type',
multiSelect: 'or',
options: [
{
value: 2,
},
],
},
],
onDelete: () => {},
onActionRefresh: () => {},
onExport: () => {},
Expand Down
28 changes: 5 additions & 23 deletions ...ins/saved_objects_management/public/management_section/objects_table/components/table.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,11 +61,12 @@ export interface TableProps {
basePath: IBasePath;
actionRegistry: SavedObjectsManagementActionServiceStart;
columnRegistry: SavedObjectsManagementColumnServiceStart;
namespaceRegistry: SavedObjectsManagementNamespaceServiceStart;
selectedSavedObjects: SavedObjectWithMetadata[];
selectionConfig: {
onSelectionChange: (selection: SavedObjectWithMetadata[]) => void;
};
filterOptions: any[];
filters: any[];
canDelete: boolean;
onDelete: () => void;
onActionRefresh: (object: SavedObjectWithMetadata) => void;
Expand All @@ -76,7 +77,7 @@ export interface TableProps {
items: SavedObjectWithMetadata[];
itemId: string | (() => string);
totalItemCount: number;
onQueryChange: (query: any) => void;
Copy link
Member

Choose a reason for hiding this comment

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

can this be made optional?

Copy link
Member Author

Choose a reason for hiding this comment

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

The filterFields param? It can, but in practical use it will always at least contain type.

Copy link
Member Author

Choose a reason for hiding this comment

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

FYI reverted this back to the original parseQuery, but modified the function to also extract namespaces.

onQueryChange: (query: any, filterFields: string[]) => void;
onTableChange: (table: any) => void;
isSearching: boolean;
onShowRelationships: (object: SavedObjectWithMetadata) => void;
Expand Down Expand Up @@ -163,7 +164,7 @@ export class Table extends PureComponent<TableProps, TableState> {
items,
totalItemCount,
isSearching,
filterOptions,
filters,
selectionConfig: selection,
onDelete,
onActionRefresh,
Expand All @@ -174,6 +175,7 @@ export class Table extends PureComponent<TableProps, TableState> {
basePath,
actionRegistry,
columnRegistry,
namespaceRegistry,
dateFormat,
} = this.props;

Expand All @@ -184,26 +186,6 @@ export class Table extends PureComponent<TableProps, TableState> {
pageSizeOptions: [5, 10, 20, 50],
};

const filters = [
{
type: 'field_value_selection',
field: 'type',
name: i18n.translate('savedObjectsManagement.objectsTable.table.typeFilterName', {
defaultMessage: 'Type',
}),
multiSelect: 'or',
options: filterOptions,
},
// Add this back in once we have tag support
// {
// type: 'field_value_selection',
// field: 'tag',
// name: 'Tags',
// multiSelect: 'or',
// options: [],
// },
];

const columns = [
{
field: 'type',
Expand Down
2 changes: 2 additions & 0 deletions ...d_objects_management/public/management_section/objects_table/saved_objects_table.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ import { dataPluginMock } from '../../../../data/public/mocks';
import { serviceRegistryMock } from '../../services/service_registry.mock';
import { actionServiceMock } from '../../services/action_service.mock';
import { columnServiceMock } from '../../services/column_service.mock';
import { namespaceServiceMock } from '../../services/namespace_service.mock';
import {
SavedObjectsTable,
SavedObjectsTableProps,
Expand Down Expand Up @@ -147,6 +148,7 @@ describe('SavedObjectsTable', () => {
serviceRegistry: serviceRegistryMock.create(),
actionRegistry: actionServiceMock.createStart(),
columnRegistry: columnServiceMock.createStart(),
namespaceRegistry: namespaceServiceMock.createStart(),
savedObjectsClient: savedObjects.client,
indexPatterns: dataPluginMock.createStartContract().indexPatterns,
http,
Expand Down
Loading