Skip to content

Commit fa7f16c

Browse files
ansjcyansjcy
committed
Version decoupling and tests for MDS
Signed-off-by: Chenyang Ji <[email protected]>
1 parent 9f955a0 commit fa7f16c

File tree

7 files changed

+246
-27
lines changed

7 files changed

+246
-27
lines changed

‎opensearch_dashboards.json

+3-1
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,7 @@
66
"ui": true,
77
"requiredPlugins": ["navigation"],
88
"optionalPlugins": ["dataSource",
9-
"dataSourceManagement"]
9+
"dataSourceManagement"],
10+
"supportedOSDataSourceVersions": ">=2.19.0",
11+
"requiredOSDataSourcePlugins": ["query-insights"]
1012
}

‎public/components/DataSourcePicker.tsx

+2-17
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ import {
1111
} from 'src/plugins/data_source_management/public';
1212
import { AppMountParameters, CoreStart } from '../../../../src/core/public';
1313
import { QueryInsightsDashboardsPluginStartDependencies } from '../types';
14+
import { getDataSourceEnabledUrl, isDataSourceCompatible } from '../utils/datasource-utils';
1415

1516
export interface DataSourceMenuProps {
1617
dataSourceManagement?: DataSourceManagementPluginSetup;
@@ -24,23 +25,6 @@ export interface DataSourceMenuProps {
2425
dataSourcePickerReadOnly: boolean;
2526
}
2627

27-
export function getDataSourceEnabledUrl(dataSource: DataSourceOption) {
28-
const url = new URL(window.location.href);
29-
url.searchParams.set('dataSource', JSON.stringify(dataSource));
30-
return url;
31-
}
32-
33-
export function getDataSourceFromUrl(): DataSourceOption {
34-
const urlParams = new URLSearchParams(window.location.search);
35-
const dataSourceParam = (urlParams && urlParams.get('dataSource')) || '{}';
36-
// following block is needed if the dataSource param is set to non-JSON value, say 'undefined'
37-
try {
38-
return JSON.parse(dataSourceParam);
39-
} catch (e) {
40-
return JSON.parse('{}'); // Return an empty object or some default value if parsing fails
41-
}
42-
}
43-
4428
export const QueryInsightsDataSourceMenu = React.memo(
4529
(props: DataSourceMenuProps) => {
4630
const {
@@ -78,6 +62,7 @@ export const QueryInsightsDataSourceMenu = React.memo(
7862
selectedDataSource.id || selectedDataSource.label ? [selectedDataSource] : undefined,
7963
onSelectedDataSources: wrapSetDataSourceWithUpdateUrl,
8064
fullWidth: true,
65+
dataSourceFilter: isDataSourceCompatible,
8166
}}
8267
/>
8368
) : null;

‎public/pages/QueryDetails/QueryDetails.tsx

+3-4
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,9 @@ import { SearchQueryRecord } from '../../../types/types';
2727
import { PageHeader } from '../../components/PageHeader';
2828
import { QueryInsightsDashboardsPluginStartDependencies } from '../../types';
2929
import { retrieveQueryById } from '../Utils/QueryUtils';
30-
import {
31-
getDataSourceFromUrl,
32-
QueryInsightsDataSourceMenu,
33-
} from '../../components/DataSourcePicker';
30+
import { QueryInsightsDataSourceMenu } from '../../components/DataSourcePicker';
31+
32+
import { getDataSourceFromUrl } from '../../utils/datasource-utils';
3433

3534
const QueryDetails = ({
3635
core,

‎public/pages/QueryGroupDetails/QueryGroupDetails.tsx

+2-4
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,8 @@ import { QueryInsightsDashboardsPluginStartDependencies } from '../../types';
3030
import { PageHeader } from '../../components/PageHeader';
3131
import { SearchQueryRecord } from '../../../types/types';
3232
import { retrieveQueryById } from '../Utils/QueryUtils';
33-
import {
34-
getDataSourceFromUrl,
35-
QueryInsightsDataSourceMenu,
36-
} from '../../components/DataSourcePicker';
33+
import { QueryInsightsDataSourceMenu } from '../../components/DataSourcePicker';
34+
import { getDataSourceFromUrl } from '../../utils/datasource-utils';
3735

3836
export const QueryGroupDetails = ({
3937
core,

‎public/pages/TopNQueries/TopNQueries.tsx

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ import {
3232
getMergedStringSettings,
3333
getTimeAndUnitFromString,
3434
} from '../Utils/MetricUtils';
35-
import { getDataSourceFromUrl } from '../../components/DataSourcePicker';
35+
import { getDataSourceFromUrl } from '../../utils/datasource-utils';
3636
import { EXPORTER_TYPE } from '../Utils/Constants';
3737

3838
export const QUERY_INSIGHTS = '/queryInsights';

‎public/utils/datasource-utils.test.ts

+170
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,170 @@
1+
/*
2+
* Copyright OpenSearch Contributors
3+
* SPDX-License-Identifier: Apache-2.0
4+
*/
5+
6+
/*
7+
* Copyright OpenSearch Contributors
8+
*
9+
* Licensed under the Apache License, Version 2.0 (the "License").
10+
* You may not use this file except in compliance with the License.
11+
* A copy of the License is located at
12+
*
13+
* http://www.apache.org/licenses/LICENSE-2.0
14+
*
15+
* or in the "license" file accompanying this file. This file is distributed
16+
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
17+
* express or implied. See the License for the specific language governing
18+
* permissions and limitations under the License.
19+
*/
20+
21+
import { getDataSourceFromUrl, isDataSourceCompatible } from './datasource-utils';
22+
23+
describe('Tests datasource utils', () => {
24+
it('Tests getting the datasource from the url', () => {
25+
const mockSearchNoDataSourceId = '?foo=bar&baz=qux';
26+
Object.defineProperty(window, 'location', {
27+
value: { search: mockSearchNoDataSourceId },
28+
writable: true,
29+
});
30+
expect(getDataSourceFromUrl()).toEqual({});
31+
const mockSearchDataSourceIdNotfirst =
32+
'?foo=bar&baz=qux&dataSource=%7B"id"%3A"94ffa650-f11a-11ee-a585-793f7b098e1a"%2C"label"%3A"9202"%7D';
33+
Object.defineProperty(window, 'location', {
34+
value: { search: mockSearchDataSourceIdNotfirst },
35+
writable: true,
36+
});
37+
expect(getDataSourceFromUrl()).toEqual({
38+
id: '94ffa650-f11a-11ee-a585-793f7b098e1a',
39+
label: '9202',
40+
});
41+
const mockSearchDataSourceIdFirst =
42+
'?dataSource=%7B"id"%3A"94ffa650-f11a-11ee-a585-793f7b098e1a"%2C"label"%3A"9202"%7D';
43+
Object.defineProperty(window, 'location', {
44+
value: { search: mockSearchDataSourceIdFirst },
45+
writable: true,
46+
});
47+
expect(getDataSourceFromUrl()).toEqual({
48+
id: '94ffa650-f11a-11ee-a585-793f7b098e1a',
49+
label: '9202',
50+
});
51+
});
52+
53+
it('Tests getting the datasource from the url with undefined dataSource', () => {
54+
const mockSearchUndefinedDataSource = '?dataSource=undefined';
55+
Object.defineProperty(window, 'location', {
56+
value: { search: mockSearchUndefinedDataSource },
57+
writable: true,
58+
});
59+
expect(getDataSourceFromUrl()).toEqual({});
60+
});
61+
62+
describe('isDataSourceCompatible', () => {
63+
it('should return true for compatible data sources', () => {
64+
expect(
65+
isDataSourceCompatible({
66+
attributes: {
67+
installedPlugins: ['query-insights'],
68+
dataSourceVersion: '2.19.0',
69+
title: '',
70+
endpoint: '',
71+
auth: {
72+
type: '',
73+
credentials: undefined,
74+
},
75+
},
76+
id: '',
77+
type: '',
78+
references: [],
79+
})
80+
).toBe(true);
81+
expect(
82+
isDataSourceCompatible({
83+
attributes: {
84+
installedPlugins: ['query-insights'],
85+
dataSourceVersion: '3.0.0',
86+
title: '',
87+
endpoint: '',
88+
auth: {
89+
type: '',
90+
credentials: undefined,
91+
},
92+
},
93+
id: '',
94+
type: '',
95+
references: [],
96+
})
97+
).toBe(true);
98+
});
99+
100+
it('should return false for un-compatible data sources', () => {
101+
expect(
102+
isDataSourceCompatible({
103+
attributes: {
104+
installedPlugins: [],
105+
dataSourceVersion: '2.13.0',
106+
title: '',
107+
endpoint: '',
108+
auth: {
109+
type: '',
110+
credentials: undefined,
111+
},
112+
},
113+
id: '',
114+
type: '',
115+
references: [],
116+
})
117+
).toBe(false);
118+
expect(
119+
isDataSourceCompatible({
120+
attributes: {
121+
installedPlugins: ['query-insights'],
122+
dataSourceVersion: '2.13.0',
123+
title: '',
124+
endpoint: '',
125+
auth: {
126+
type: '',
127+
credentials: undefined,
128+
},
129+
},
130+
id: '',
131+
type: '',
132+
references: [],
133+
})
134+
).toBe(false);
135+
expect(
136+
isDataSourceCompatible({
137+
attributes: {
138+
title: '',
139+
endpoint: '',
140+
dataSourceVersion: '',
141+
auth: {
142+
type: '',
143+
credentials: undefined,
144+
},
145+
},
146+
id: '',
147+
type: '',
148+
references: [],
149+
})
150+
).toBe(false);
151+
expect(
152+
isDataSourceCompatible({
153+
attributes: {
154+
installedPlugins: ['random'],
155+
dataSourceVersion: '1.0.0-beta1',
156+
title: '',
157+
endpoint: '',
158+
auth: {
159+
type: '',
160+
credentials: undefined,
161+
},
162+
},
163+
id: '',
164+
type: '',
165+
references: [],
166+
})
167+
).toBe(false);
168+
});
169+
});
170+
});

‎public/utils/datasource-utils.ts

+65
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
/*
2+
* Copyright OpenSearch Contributors
3+
* SPDX-License-Identifier: Apache-2.0
4+
*/
5+
6+
/*
7+
* Copyright OpenSearch Contributors
8+
*
9+
* Licensed under the Apache License, Version 2.0 (the "License").
10+
* You may not use this file except in compliance with the License.
11+
* A copy of the License is located at
12+
*
13+
* http://www.apache.org/licenses/LICENSE-2.0
14+
*
15+
* or in the "license" file accompanying this file. This file is distributed
16+
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
17+
* express or implied. See the License for the specific language governing
18+
* permissions and limitations under the License.
19+
*/
20+
21+
import semver from 'semver';
22+
import { DataSourceOption } from 'src/plugins/data_source_management/public';
23+
import pluginManifest from '../../opensearch_dashboards.json';
24+
import type { SavedObject } from '../../../../src/core/public';
25+
import type { DataSourceAttributes } from '../../../../src/plugins/data_source/common/data_sources';
26+
27+
export function getDataSourceEnabledUrl(dataSource: DataSourceOption) {
28+
const url = new URL(window.location.href);
29+
url.searchParams.set('dataSource', JSON.stringify(dataSource));
30+
return url;
31+
}
32+
33+
export function getDataSourceFromUrl(): DataSourceOption {
34+
const urlParams = new URLSearchParams(window.location.search);
35+
const dataSourceParam = (urlParams && urlParams.get('dataSource')) || '{}';
36+
// following block is needed if the dataSource param is set to non-JSON value, say 'undefined'
37+
try {
38+
return JSON.parse(dataSourceParam);
39+
} catch (e) {
40+
return JSON.parse('{}'); // Return an empty object or some default value if parsing fails
41+
}
42+
}
43+
44+
export const isDataSourceCompatible = (dataSource: SavedObject<DataSourceAttributes>) => {
45+
if (
46+
'requiredOSDataSourcePlugins' in pluginManifest &&
47+
!pluginManifest.requiredOSDataSourcePlugins.every((plugin) =>
48+
dataSource.attributes.installedPlugins?.includes(plugin)
49+
)
50+
) {
51+
return false;
52+
}
53+
54+
// filter out data sources which is NOT in the support range of plugin
55+
if (
56+
'supportedOSDataSourceVersions' in pluginManifest &&
57+
!semver.satisfies(
58+
dataSource.attributes.dataSourceVersion,
59+
pluginManifest.supportedOSDataSourceVersions
60+
)
61+
) {
62+
return false;
63+
}
64+
return true;
65+
};

0 commit comments

Comments
 (0)