add version number to newly created datasource object (#6178)

* add version number to newly created datasource object Signed-off-by: Zilong Xia <[email protected]> * update attribute key from version to dataSourceVersion Signed-off-by: Zilong Xia <[email protected]> * add support and test coverage for custom auth type Signed-off-by: Zilong Xia <[email protected]> * fix ciGroup3 test case suite Create Datasource Wizard Signed-off-by: Zilong Xia <[email protected]> --------- Signed-off-by: Zilong Xia <[email protected]> Signed-off-by: ZilongX <[email protected]>
opensearch-project · Mar 19, 2024 · daccae7 · daccae7
1 parent db9806d
commit daccae7
Show file tree

Hide file tree

Showing 11 changed files with 585 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -48,6 +48,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 - [Workspace] Add a workspace client in workspace plugin ([#6094](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/6094))
 - [Multiple Datasource] Add component to show single selected data source in read only mode ([#6125](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/6125))
 - [Multiple Datasource] Add data source aggregated view to show all compatible data sources or only show used data sources ([#6129](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/6129))
+- [Multiple Datasource] Add datasource version number to newly created data source object([#6178](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/6178))
 - [Workspace] Add workspace id in basePath ([#6060](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/6060))
 - Implement new home page ([#6065](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/6065))
 - Add sidecar service ([#5920](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/5920))

diff --git a/src/plugins/data_source/server/plugin.ts b/src/plugins/data_source/server/plugin.ts
@@ -30,6 +30,7 @@ import { DATA_SOURCE_SAVED_OBJECT_TYPE } from '../common';
 import { ensureRawRequest } from '../../../../src/core/server/http/router';
 import { createDataSourceError } from './lib/error';
 import { registerTestConnectionRoute } from './routes/test_connection';
+import { registerFetchDataSourceVersionRoute } from './routes/fetch_data_source_version';
 import { AuthenticationMethodRegistery, IAuthenticationMethodRegistery } from './auth_registry';
 import { CustomApiSchemaRegistry } from './schema_registry';
 
@@ -133,6 +134,13 @@ export class DataSourcePlugin implements Plugin<DataSourcePluginSetup, DataSourc
       authRegistryPromise,
       customApiSchemaRegistryPromise
     );
+    registerFetchDataSourceVersionRoute(
+      router,
+      dataSourceService,
+      cryptographyServiceSetup,
+      authRegistryPromise,
+      customApiSchemaRegistryPromise
+    );
 
     const registerCredentialProvider = (method: AuthenticationMethod) => {
       this.logger.debug(`Registered Credential Provider for authType = ${method.name}`);

diff --git a/src/plugins/data_source/server/routes/data_source_connection_validator.test.ts b/src/plugins/data_source/server/routes/data_source_connection_validator.test.ts
@@ -24,6 +24,23 @@ describe('DataSourceManagement: data_source_connection_validator.ts', () => {
       expect(validateDataSourcesResponse.statusCode).toBe(200);
     });
 
+    test('fetchDataSourceVersion - Success: opensearch client response code is 200 and response body have version number', async () => {
+      const opensearchClient = opensearchServiceMock.createOpenSearchClient();
+      opensearchClient.info.mockResolvedValue(
+        opensearchServiceMock.createApiResponse({
+          statusCode: 200,
+          body: {
+            version: {
+              number: '2.11.0',
+            },
+          },
+        })
+      );
+      const dataSourceValidator = new DataSourceConnectionValidator(opensearchClient, {});
+      const fetchDataSourcesVersionResponse = await dataSourceValidator.fetchDataSourceVersion();
+      expect(fetchDataSourcesVersionResponse).toBe('2.11.0');
+    });
+
     test('failure: opensearch client response code is 200 but response body not have cluster name', async () => {
       try {
         const opensearchClient = opensearchServiceMock.createOpenSearchClient();
@@ -43,6 +60,22 @@ describe('DataSourceManagement: data_source_connection_validator.ts', () => {
       }
     });
 
+    // In case fetchDataSourceVersion call succeeded yet did not return version number, return an empty version instead of raising exceptions
+    test('fetchDataSourceVersion - Success:opensearch client response code is 200 but response body does not have version number', async () => {
+      const opensearchClient = opensearchServiceMock.createOpenSearchClient();
+      opensearchClient.info.mockResolvedValue(
+        opensearchServiceMock.createApiResponse({
+          statusCode: 200,
+          body: {
+            Message: 'Response without version number.',
+          },
+        })
+      );
+      const dataSourceValidator = new DataSourceConnectionValidator(opensearchClient, {});
+      const fetchDataSourcesVersionResponse = await dataSourceValidator.fetchDataSourceVersion();
+      expect(fetchDataSourcesVersionResponse).toBe('');
+    });
+
     test('failure: opensearch client response code is other than 200', async () => {
       const statusCodeList = [100, 202, 300, 400, 500];
       statusCodeList.forEach(async function (code) {
@@ -64,6 +97,25 @@ describe('DataSourceManagement: data_source_connection_validator.ts', () => {
         }
       });
     });
+
+    // In case fetchDataSourceVersion call failed, return an empty version instead of raising exceptions
+    test('fetchDataSourceVersion - Failure: opensearch client response code is other than 200', async () => {
+      const statusCodeList = [100, 202, 300, 400, 500];
+      statusCodeList.forEach(async function (code) {
+        const opensearchClient = opensearchServiceMock.createOpenSearchClient();
+        opensearchClient.info.mockResolvedValue(
+          opensearchServiceMock.createApiResponse({
+            statusCode: code,
+            body: {
+              Message: 'Your request is not correct.',
+            },
+          })
+        );
+        const dataSourceValidator = new DataSourceConnectionValidator(opensearchClient, {});
+        const fetchDataSourcesVersionResponse = await dataSourceValidator.fetchDataSourceVersion();
+        expect(fetchDataSourcesVersionResponse).toBe('');
+      });
+    });
   });
 
   describe('Test datasource connection for SigV4 auth', () => {

diff --git a/src/plugins/data_source/server/routes/data_source_connection_validator.ts b/src/plugins/data_source/server/routes/data_source_connection_validator.ts
@@ -35,4 +35,27 @@ export class DataSourceConnectionValidator {
       throw createDataSourceError(e);
     }
   }
+
+  async fetchDataSourceVersion() {
+    let dataSourceVersion = '';
+    try {
+      // OpenSearch Serverless does not have version concept
+      if (
+        this.dataSourceAttr.auth?.credentials?.service === SigV4ServiceName.OpenSearchServerless
+      ) {
+        return dataSourceVersion;
+      }
+      await this.callDataCluster
+        .info()
+        .then((response) => response.body)
+        .then((body) => {
+          dataSourceVersion = body.version.number;
+        });
+
+      return dataSourceVersion;
+    } catch (e) {
+      // return empty dataSoyrce version instead of throwing exception in case info() api call fails
+      return dataSourceVersion;
+    }
+  }
 }