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

[Manual Backport 2.x]Fix missing customApiRegistryPromise param for test connection (#5944) #5971

Merged
merged 3 commits into from
Feb 27, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
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
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,9 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
- [Discover] Fix missing index pattern field from breaking Discover [#5626](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/5626)
- [BUG] Remove duplicate sample data as id 90943e30-9a47-11e8-b64d-95841ca0b247 ([5668](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/5668))
- [BUG][Multiple Datasource] Fix datasource testing connection unexpectedly passed with wrong endpoint [#5663](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/5663)
- [Table Visualization] Fix filter action buttons for split table aggregations ([#5619](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/5619))
Copy link
Member

Choose a reason for hiding this comment

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

It seems like that you include the others changes here.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I didn't include it, but it is hanging here since it was left alone from the auto backport https://github.com/opensearch-project/OpenSearch-Dashboards/pull/5823/files, and original PR has the changelog https://github.com/opensearch-project/OpenSearch-Dashboards/pull/5619/files

If I remove it, it will not be in 2.x but it should. How should we handle it? @bandinib-amzn @ashwin-pc

Copy link
Member

Choose a reason for hiding this comment

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

According to Backport workflow, we skip changelog for backport PR. That's why we don't see changelog in autocut backport. I'm not sure if we use changelog from 2.x branch.

So for this PR, I would suggest keep only your changes in CHANGELOG.md.

@ashwin-pc Can you tell us what is best practice for changelog when we manually backport PR?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I removed the dangling changelog for now

- [BUG][Multiple Datasource] Fix missing customApiRegistryPromise param for test connection ([#5944](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/5944))


### 🚞 Infrastructure

Expand Down
3 changes: 2 additions & 1 deletion src/plugins/data_source/server/plugin.ts
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,8 @@ export class DataSourcePlugin implements Plugin<DataSourcePluginSetup, DataSourc
router,
dataSourceService,
cryptographyServiceSetup,
authRegistryPromise
authRegistryPromise,
customApiSchemaRegistryPromise
);

const registerCredentialProvider = (method: AuthenticationMethod) => {
Expand Down
96 changes: 96 additions & 0 deletions src/plugins/data_source/server/routes/test_connection.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
/*
* Copyright OpenSearch Contributors
* SPDX-License-Identifier: Apache-2.0
*/

import supertest from 'supertest';
import { UnwrapPromise } from '@osd/utility-types';
import { setupServer } from '../../../../../src/core/server/test_utils';

import {
IAuthenticationMethodRegistery,
authenticationMethodRegisteryMock,
} from '../auth_registry';
import { CustomApiSchemaRegistry } from '../schema_registry';
import { DataSourceServiceSetup } from '../../server/data_source_service';
import { CryptographyServiceSetup } from '../cryptography_service';
import { registerTestConnectionRoute } from './test_connection';
import { AuthType } from '../../common/data_sources';
// eslint-disable-next-line @osd/eslint/no-restricted-paths
import { opensearchClientMock } from '../../../../../src/core/server/opensearch/client/mocks';

type SetupServerReturn = UnwrapPromise<ReturnType<typeof setupServer>>;

const URL = '/internal/data-source-management/validate';

describe(`Test connection ${URL}`, () => {
let server: SetupServerReturn['server'];
let httpSetup: SetupServerReturn['httpSetup'];
let handlerContext: SetupServerReturn['handlerContext'];
let cryptographyMock: jest.Mocked<CryptographyServiceSetup>;
const customApiSchemaRegistry = new CustomApiSchemaRegistry();
let customApiSchemaRegistryPromise: Promise<CustomApiSchemaRegistry>;
let dataSourceClient: ReturnType<typeof opensearchClientMock.createInternalClient>;
let dataSourceServiceSetupMock: DataSourceServiceSetup;
let authRegistryPromiseMock: Promise<IAuthenticationMethodRegistery>;
const dataSourceAttr = {
endpoint: 'https://test.com',
auth: {
type: AuthType.UsernamePasswordType,
credentials: {
username: 'testUser',
password: 'testPassword',
},
},
};

beforeEach(async () => {
({ server, httpSetup, handlerContext } = await setupServer());
customApiSchemaRegistryPromise = Promise.resolve(customApiSchemaRegistry);
authRegistryPromiseMock = Promise.resolve(authenticationMethodRegisteryMock.create());
dataSourceClient = opensearchClientMock.createInternalClient();

dataSourceServiceSetupMock = {
getDataSourceClient: jest.fn(() => Promise.resolve(dataSourceClient)),
getDataSourceLegacyClient: jest.fn(),
};

const router = httpSetup.createRouter('');
dataSourceClient.info.mockImplementationOnce(() =>
opensearchClientMock.createSuccessTransportRequestPromise({ cluster_name: 'testCluster' })
);
registerTestConnectionRoute(
router,
dataSourceServiceSetupMock,
cryptographyMock,
authRegistryPromiseMock,
customApiSchemaRegistryPromise
);

await server.start();
});

afterEach(async () => {
await server.stop();
});

it('shows successful response', async () => {
const result = await supertest(httpSetup.server.listener)
.post(URL)
.send({
id: 'testId',
dataSourceAttr,
})
.expect(200);
expect(result.body).toEqual({ success: true });
expect(dataSourceServiceSetupMock.getDataSourceClient).toHaveBeenCalledWith(
expect.objectContaining({
savedObjects: handlerContext.savedObjects.client,
cryptography: cryptographyMock,
dataSourceId: 'testId',
testClientDataSourceAttr: dataSourceAttr,
customApiSchemaRegistryPromise,
})
);
});
});
4 changes: 3 additions & 1 deletion src/plugins/data_source/server/routes/test_connection.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@ export const registerTestConnectionRoute = async (
router: IRouter,
dataSourceServiceSetup: DataSourceServiceSetup,
cryptography: CryptographyServiceSetup,
authRegistryPromise: Promise<IAuthenticationMethodRegistery>
authRegistryPromise: Promise<IAuthenticationMethodRegistery>,
customApiSchemaRegistryPromise: Promise<CustomApiSchemaRegistry>
) => {
const authRegistry = await authRegistryPromise;
router.post(
Expand Down Expand Up @@ -68,6 +69,7 @@ export const registerTestConnectionRoute = async (
testClientDataSourceAttr: dataSourceAttr as DataSourceAttributes,
request,
authRegistry,
customApiSchemaRegistryPromise,
}
);

Expand Down
Loading