Skip to content

Commit

Permalink
rename asSecondaryAuth to asSecondaryAuthUser
Browse files Browse the repository at this point in the history
  • Loading branch information
pgayvallet committed Jun 10, 2024
1 parent fd77242 commit 02c3819
Show file tree
Hide file tree
Showing 10 changed files with 47 additions and 47 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -708,7 +708,7 @@ describe('ClusterClient', () => {
});
});

describe('#asScoped().asSecondaryAuth', () => {
describe('#asScoped().asSecondaryAuthUser', () => {
it('lazily instantiate the client when first called', () => {
const clusterClient = new ClusterClient({
config: createConfig(),
Expand All @@ -727,7 +727,7 @@ describe('ClusterClient', () => {
expect(internalClient.child).not.toHaveBeenCalled();

// trigger client instantiation via getter
client = scopedClusterClient.asSecondaryAuth;
client = scopedClusterClient.asSecondaryAuthUser;

expect(internalClient.child).toHaveBeenCalledTimes(1);
expect(internalClient.child).toHaveBeenCalledWith({
Expand All @@ -751,9 +751,9 @@ describe('ClusterClient', () => {
const scopedClusterClient = clusterClient.asScoped(request);

// trigger client instantiation via getter
client = scopedClusterClient.asSecondaryAuth;
client = scopedClusterClient.asSecondaryAuthUser;

expect(scopedClusterClient.asSecondaryAuth).toBe(internalClient.child.mock.results[0].value);
expect(scopedClusterClient.asSecondaryAuthUser).toBe(internalClient.child.mock.results[0].value);
});

it('creates a scoped client using the proper `es-secondary-authorization` header', () => {
Expand Down Expand Up @@ -781,7 +781,7 @@ describe('ClusterClient', () => {

const scopedClusterClient = clusterClient.asScoped(request);
// trigger client instantiation via getter
client = scopedClusterClient.asSecondaryAuth;
client = scopedClusterClient.asSecondaryAuthUser;

expect(internalClient.child).toHaveBeenCalledTimes(1);
expect(internalClient.child).toHaveBeenCalledWith(
Expand Down Expand Up @@ -818,7 +818,7 @@ describe('ClusterClient', () => {

const scopedClusterClient = clusterClient.asScoped(request);
// trigger client instantiation via getter
client = scopedClusterClient.asSecondaryAuth;
client = scopedClusterClient.asSecondaryAuthUser;

expect(internalClient.child).toHaveBeenCalledTimes(1);
expect(internalClient.child).toHaveBeenCalledWith(
Expand Down Expand Up @@ -850,7 +850,7 @@ describe('ClusterClient', () => {

const scopedClusterClient = clusterClient.asScoped(request);
// trigger client instantiation via getter
client = scopedClusterClient.asSecondaryAuth;
client = scopedClusterClient.asSecondaryAuthUser;

expect(internalClient.child).toHaveBeenCalledTimes(1);
expect(internalClient.child).toHaveBeenCalledWith(
Expand Down Expand Up @@ -887,7 +887,7 @@ describe('ClusterClient', () => {

const scopedClusterClient = clusterClient.asScoped(request);
// trigger client instantiation via getter
client = scopedClusterClient.asSecondaryAuth;
client = scopedClusterClient.asSecondaryAuthUser;

expect(internalClient.child).toHaveBeenCalledTimes(1);
expect(internalClient.child).toHaveBeenCalledWith(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -112,8 +112,8 @@ export class ClusterClient implements ICustomClusterClient {

return new ScopedClusterClient({
asInternalUser: this.asInternalUser,
asCurrentUserClientFactory: createScopedClient,
asSecondaryAuthClientFactory: createSecondaryScopedClient,
asCurrentUserFactory: createScopedClient,
asSecondaryAuthUserFactory: createSecondaryScopedClient,
});
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ describe('ScopedClusterClient', () => {

const scopedClusterClient = new ScopedClusterClient({
asInternalUser: internalClient,
asCurrentUserClientFactory: () => scopedClient,
asSecondaryAuthClientFactory: () => secondaryAuthClient,
asCurrentUserFactory: () => scopedClient,
asSecondaryAuthUserFactory: () => secondaryAuthClient,
});

expect(scopedClusterClient.asInternalUser).toBe(internalClient);
Expand All @@ -33,8 +33,8 @@ describe('ScopedClusterClient', () => {

const scopedClusterClient = new ScopedClusterClient({
asInternalUser: internalClient,
asCurrentUserClientFactory: () => scopedClient,
asSecondaryAuthClientFactory: () => secondaryAuthClient,
asCurrentUserFactory: () => scopedClient,
asSecondaryAuthUserFactory: () => secondaryAuthClient,
});

expect(scopedClusterClient.asCurrentUser).toBe(scopedClient);
Expand All @@ -47,11 +47,11 @@ describe('ScopedClusterClient', () => {

const scopedClusterClient = new ScopedClusterClient({
asInternalUser: internalClient,
asCurrentUserClientFactory: () => scopedClient,
asSecondaryAuthClientFactory: () => secondaryAuthClient,
asCurrentUserFactory: () => scopedClient,
asSecondaryAuthUserFactory: () => secondaryAuthClient,
});

expect(scopedClusterClient.asSecondaryAuth).toBe(secondaryAuthClient);
expect(scopedClusterClient.asSecondaryAuthUser).toBe(secondaryAuthClient);
});

it('returns the same instance when calling `asCurrentUser` multiple times', () => {
Expand All @@ -61,8 +61,8 @@ describe('ScopedClusterClient', () => {

const scopedClusterClient = new ScopedClusterClient({
asInternalUser: internalClient,
asCurrentUserClientFactory: () => scopedClient,
asSecondaryAuthClientFactory: () => secondaryAuthClient,
asCurrentUserFactory: () => scopedClient,
asSecondaryAuthUserFactory: () => secondaryAuthClient,
});

const userClient1 = scopedClusterClient.asCurrentUser;
Expand All @@ -71,19 +71,19 @@ describe('ScopedClusterClient', () => {
expect(userClient1).toBe(userClient2);
});

it('returns the same instance when calling `asSecondaryAuth` multiple times', () => {
it('returns the same instance when calling `asSecondaryAuthUser` multiple times', () => {
const internalClient = createEsClient();
const scopedClient = createEsClient();
const secondaryAuthClient = createEsClient();

const scopedClusterClient = new ScopedClusterClient({
asInternalUser: internalClient,
asCurrentUserClientFactory: () => scopedClient,
asSecondaryAuthClientFactory: () => secondaryAuthClient,
asCurrentUserFactory: () => scopedClient,
asSecondaryAuthUserFactory: () => secondaryAuthClient,
});

const secondaryAuth1 = scopedClusterClient.asSecondaryAuth;
const secondaryAuth2 = scopedClusterClient.asSecondaryAuth;
const secondaryAuth1 = scopedClusterClient.asSecondaryAuthUser;
const secondaryAuth2 = scopedClusterClient.asSecondaryAuthUser;

expect(secondaryAuth1).toBe(secondaryAuth2);
});
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,37 +12,37 @@ import type { ElasticsearchClient, IScopedClusterClient } from '@kbn/core-elasti
export class ScopedClusterClient implements IScopedClusterClient {
public readonly asInternalUser;

readonly #asCurrentUserClientFactory: () => ElasticsearchClient;
readonly #asSecondaryAuthClientFactory: () => ElasticsearchClient;
readonly #asCurrentUserFactory: () => ElasticsearchClient;
readonly #asSecondaryAuthUserFactory: () => ElasticsearchClient;

#asCurrentUserClient?: ElasticsearchClient;
#asSecondaryAuthClient?: ElasticsearchClient;
#asSecondaryAuthUserClient?: ElasticsearchClient;

constructor({
asInternalUser,
asCurrentUserClientFactory,
asSecondaryAuthClientFactory,
asCurrentUserFactory,
asSecondaryAuthUserFactory,
}: {
asInternalUser: ElasticsearchClient;
asCurrentUserClientFactory: () => ElasticsearchClient;
asSecondaryAuthClientFactory: () => ElasticsearchClient;
asCurrentUserFactory: () => ElasticsearchClient;
asSecondaryAuthUserFactory: () => ElasticsearchClient;
}) {
this.asInternalUser = asInternalUser;
this.#asCurrentUserClientFactory = asCurrentUserClientFactory;
this.#asSecondaryAuthClientFactory = asSecondaryAuthClientFactory;
this.#asCurrentUserFactory = asCurrentUserFactory;
this.#asSecondaryAuthUserFactory = asSecondaryAuthUserFactory;
}

public get asCurrentUser() {
if (this.#asCurrentUserClient === undefined) {
this.#asCurrentUserClient = this.#asCurrentUserClientFactory();
this.#asCurrentUserClient = this.#asCurrentUserFactory();
}
return this.#asCurrentUserClient;
}

public get asSecondaryAuth() {
if (this.#asSecondaryAuthClient === undefined) {
this.#asSecondaryAuthClient = this.#asSecondaryAuthClientFactory();
public get asSecondaryAuthUser() {
if (this.#asSecondaryAuthUserClient === undefined) {
this.#asSecondaryAuthUserClient = this.#asSecondaryAuthUserFactory();
}
return this.#asSecondaryAuthClient;
return this.#asSecondaryAuthUserClient;
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -190,14 +190,14 @@ const createClientMock = (res?: Promise<unknown>): ElasticsearchClientMock =>
export interface ScopedClusterClientMock {
asInternalUser: ElasticsearchClientMock;
asCurrentUser: ElasticsearchClientMock;
asSecondaryAuth: ElasticsearchClientMock;
asSecondaryAuthUser: ElasticsearchClientMock;
}

const createScopedClusterClientMock = () => {
const mock: ScopedClusterClientMock = {
asInternalUser: createClientMock(),
asCurrentUser: createClientMock(),
asSecondaryAuth: createClientMock(),
asSecondaryAuthUser: createClientMock(),
};

return mock;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ export interface IScopedClusterClient {
* Note that only a subset of Elasticsearch APIs support secondary authentication, and that only those endpoints
* should be called with this client.
*/
readonly asSecondaryAuth: ElasticsearchClient;
readonly asSecondaryAuthUser: ElasticsearchClient;

/**
* A {@link ElasticsearchClient | client} to be used to query the elasticsearch cluster
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -92,9 +92,9 @@ function wrapScopedClusterClient(opts: WrapScopedClusterClientOpts): IScopedClus
...rest,
esClient: scopedClusterClient.asCurrentUser,
}),
asSecondaryAuth: wrapEsClient({
asSecondaryAuthUser: wrapEsClient({
...rest,
esClient: scopedClusterClient.asSecondaryAuth,
esClient: scopedClusterClient.asSecondaryAuthUser,
}),
};
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -270,7 +270,7 @@ function getRequestItemsProvider(
scopedClient = {
asInternalUser,
asCurrentUser: asInternalUser,
asSecondaryAuth: asInternalUser,
asSecondaryAuthUser: asInternalUser,
};
mlSavedObjectService = getSobSavedObjectService(scopedClient);
mlClient = getMlClient(scopedClient, mlSavedObjectService);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,7 @@ describe('BurnRateRuleExecutor', () => {
scopedClusterClient: {
asCurrentUser: esClientMock,
asInternalUser: esClientMock,
asSecondaryAuth: esClientMock,
asSecondaryAuthUser: esClientMock,
},
alertsClient: publicAlertsClientMock.create(),
alertFactory: {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,9 @@ export function wrapScopedClusterClient(opts: WrapScopedClusterClientOpts): ISco
...rest,
esClient: scopedClusterClient.asCurrentUser,
}),
asSecondaryAuth: wrapEsClient({
asSecondaryAuthUser: wrapEsClient({
...rest,
esClient: scopedClusterClient.asSecondaryAuth,
esClient: scopedClusterClient.asSecondaryAuthUser,
}),
};
}
Expand Down

0 comments on commit 02c3819

Please sign in to comment.