[MD] Fix server sider endpoint validation by passing in request when creating datasource client (#6822) (#6824)

* [MD] Fix endpoint validation by passing in request when creating data source client


(cherry picked from commit 54b5eb5)

Signed-off-by: Zhongnan Su <[email protected]>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

Author: opensearch-trigger-bot[bot]

changelogs/fragments/6822.yml

@@ -0,0 +1,2 @@
+fix:
+- Fix endpoint validation by passing in request when creating datasource client ([#6822](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/6822))

src/plugins/data_source/server/saved_objects/data_source_saved_objects_client_wrapper.test.ts

@@ -40,6 +40,7 @@ describe('DataSourceSavedObjectsClientWrapper', () => {
   const customApiSchemaRegistry = new CustomApiSchemaRegistry();
   const customApiSchemaRegistryPromise = Promise.resolve(customApiSchemaRegistry);
   const dataSourceServiceSetup = dataSourceServiceSetupMock.create();
+  const requestMock = httpServerMock.createOpenSearchDashboardsRequest();
   const wrapperInstance = new DataSourceSavedObjectsClientWrapper(
     dataSourceServiceSetup,
     cryptographyMock,
@@ -52,7 +53,7 @@ describe('DataSourceSavedObjectsClientWrapper', () => {
   const wrapperClient = wrapperInstance.wrapperFactory({
     client: mockedClient,
     typeRegistry: requestHandlerContext.savedObjects.typeRegistry,
-    request: httpServerMock.createOpenSearchDashboardsRequest(),
+    request: requestMock,
   });
 
   const getSavedObject = (savedObject: Partial<SavedObject>) => {
@@ -204,6 +205,23 @@ describe('DataSourceSavedObjectsClientWrapper', () => {
       ).rejects.toThrowError(`Invalid auth type: 'not_in_registry': Bad Request`);
     });
 
+    it('endpoint validator datasource client should be created with request as param', async () => {
+      const mockDataSourceAttributesWithNoAuth = attributes({
+        auth: {
+          type: AuthType.NoAuth,
+        },
+      });
+
+      await wrapperClient.create(
+        DATA_SOURCE_SAVED_OBJECT_TYPE,
+        mockDataSourceAttributesWithNoAuth,
+        {}
+      );
+      expect(dataSourceServiceSetup.getDataSourceClient).toBeCalledWith(
+        expect.objectContaining({ request: requestMock })
+      );
+    });
+
     describe('createWithCredentialsEncryption: Error handling', () => {
       it('should throw error when title is empty', async () => {
         const mockDataSourceAttributes = attributes({

src/plugins/data_source/server/saved_objects/data_source_saved_objects_client_wrapper.ts

@@ -5,6 +5,7 @@
 
 import {
   OpenSearchClient,
+  OpenSearchDashboardsRequest,
   SavedObjectsBulkCreateObject,
   SavedObjectsBulkResponse,
   SavedObjectsBulkUpdateObject,
@@ -51,7 +52,10 @@ export class DataSourceSavedObjectsClientWrapper {
         return await wrapperOptions.client.create(type, attributes, options);
       }
 
-      const encryptedAttributes = await this.validateAndEncryptAttributes(attributes);
+      const encryptedAttributes = await this.validateAndEncryptAttributes(
+        attributes,
+        wrapperOptions.request
+      );
 
       return await wrapperOptions.client.create(type, encryptedAttributes, options);
     };
@@ -70,7 +74,7 @@ export class DataSourceSavedObjectsClientWrapper {
 
           return {
             ...object,
-            attributes: await this.validateAndEncryptAttributes(attributes),
+            attributes: await this.validateAndEncryptAttributes(attributes, wrapperOptions.request),
           };
         })
       );
@@ -152,8 +156,11 @@ export class DataSourceSavedObjectsClientWrapper {
     private endpointBlockedIps?: string[]
   ) {}
 
-  private async validateAndEncryptAttributes<T = unknown>(attributes: T) {
-    await this.validateAttributes(attributes);
+  private async validateAndEncryptAttributes<T = unknown>(
+    attributes: T,
+    request?: OpenSearchDashboardsRequest
+  ) {
+    await this.validateAttributes(attributes, request);
 
     const { endpoint, auth } = attributes;
 
@@ -257,11 +264,14 @@ export class DataSourceSavedObjectsClientWrapper {
     }
   }
 
-  private async validateAttributes<T = unknown>(attributes: T) {
+  private async validateAttributes<T = unknown>(
+    attributes: T,
+    request?: OpenSearchDashboardsRequest
+  ) {
     const { title, endpoint, auth } = attributes;
 
     this.validateTitle(title);
-    await this.validateEndpoint(endpoint, attributes as DataSourceAttributes);
+    await this.validateEndpoint(endpoint, attributes as DataSourceAttributes, request);
     await this.validateAuth(auth);
   }
 
@@ -279,7 +289,11 @@ export class DataSourceSavedObjectsClientWrapper {
     }
   }
 
-  private async validateEndpoint(endpoint: string, attributes: DataSourceAttributes) {
+  private async validateEndpoint(
+    endpoint: string,
+    attributes: DataSourceAttributes,
+    request?: OpenSearchDashboardsRequest
+  ) {
     if (!isValidURL(endpoint, this.endpointBlockedIps)) {
       throw SavedObjectsErrorHelpers.createBadRequestError(
         '"endpoint" attribute is not valid or allowed'
@@ -290,6 +304,7 @@ export class DataSourceSavedObjectsClientWrapper {
         savedObjects: {} as any,
         cryptography: this.cryptography,
         testClientDataSourceAttr: attributes as DataSourceAttributes,
+        request,
         authRegistry: await this.authRegistryPromise,
         customApiSchemaRegistryPromise: this.customApiSchemaRegistryPromise,
       });
@@ -298,6 +313,7 @@ export class DataSourceSavedObjectsClientWrapper {
 
       await dataSourceValidator.validate();
     } catch (err: any) {
+      this.logger.error(err);
       throw SavedObjectsErrorHelpers.createBadRequestError(
         `endpoint is not valid OpenSearch endpoint`
       );