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

[Lists Plugin] Migrate authc.getCurrentUser usage to coreContext.secu… #187179

Merged
Merged
Show file tree
Hide file tree
Changes from all 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
28 changes: 11 additions & 17 deletions x-pack/plugins/lists/server/get_user.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,62 +5,56 @@
* 2.0.
*/

import { httpServerMock } from '@kbn/core/server/mocks';
import { CoreKibanaRequest } from '@kbn/core/server';
import { securityMock } from '@kbn/security-plugin/server/mocks';
import { securityServiceMock } from '@kbn/core/server/mocks';
import { SecurityRequestHandlerContext } from '@kbn/core-security-server';

import { getUser } from './get_user';

describe('get_user', () => {
let request = CoreKibanaRequest.from(httpServerMock.createRawRequest({}));
let security: SecurityRequestHandlerContext;

beforeEach(() => {
jest.clearAllMocks();
request = CoreKibanaRequest.from(httpServerMock.createRawRequest({}));
security = securityServiceMock.createRequestHandlerContext();
});

afterEach(() => {
jest.clearAllMocks();
});

test('it returns "bob" as the user given a security request with "bob"', () => {
const security = securityMock.createStart();
security.authc.getCurrentUser = jest.fn().mockReturnValue({ username: 'bob' });
const user = getUser({ request, security });
const user = getUser({ security });
expect(user).toEqual('bob');
});

test('it returns "alice" as the user given a security request with "alice"', () => {
const security = securityMock.createStart();
security.authc.getCurrentUser = jest.fn().mockReturnValue({ username: 'alice' });
const user = getUser({ request, security });
const user = getUser({ security });
expect(user).toEqual('alice');
});

test('it returns "elastic" as the user given null as the current user', () => {
const security = securityMock.createStart();
security.authc.getCurrentUser = jest.fn().mockReturnValue(null);
const user = getUser({ request, security });
const user = getUser({ security });
expect(user).toEqual('elastic');
});

test('it returns "elastic" as the user given undefined as the current user', () => {
const security = securityMock.createStart();
security.authc.getCurrentUser = jest.fn().mockReturnValue(undefined);
const user = getUser({ request, security });
const user = getUser({ security });
expect(user).toEqual('elastic');
});

test('it returns "elastic" as the user given undefined as the plugin', () => {
const security = securityMock.createStart();
security.authc.getCurrentUser = jest.fn().mockReturnValue(undefined);
const user = getUser({ request, security: undefined });
const user = getUser({ security });
expect(user).toEqual('elastic');
});

test('it returns "elastic" as the user given null as the plugin', () => {
const security = securityMock.createStart();
security.authc.getCurrentUser = jest.fn().mockReturnValue(undefined);
const user = getUser({ request, security: null });
const user = getUser({ security });
expect(user).toEqual('elastic');
});
});
10 changes: 4 additions & 6 deletions x-pack/plugins/lists/server/get_user.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,15 @@
* 2.0.
*/

import { KibanaRequest } from '@kbn/core/server';
import { SecurityPluginStart } from '@kbn/security-plugin/server';
import { SecurityRequestHandlerContext } from '@kbn/core-security-server';

export interface GetUserOptions {
security: SecurityPluginStart | null | undefined;
request: KibanaRequest;
security: SecurityRequestHandlerContext;
}

export const getUser = ({ security, request }: GetUserOptions): string => {
export const getUser = ({ security }: GetUserOptions): string => {
if (security != null) {
const authenticatedUser = security.authc.getCurrentUser(request);
const authenticatedUser = security.authc.getCurrentUser();
if (authenticatedUser != null) {
return authenticatedUser.username;
} else {
Expand Down
8 changes: 3 additions & 5 deletions x-pack/plugins/lists/server/plugin.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ import type {
Plugin,
PluginInitializerContext,
} from '@kbn/core/server';
import type { SecurityPluginStart } from '@kbn/security-plugin/server';
import type { SpacesServiceStart } from '@kbn/spaces-plugin/server';

import { ConfigType } from './config';
Expand Down Expand Up @@ -41,7 +40,6 @@ export class ListPlugin implements Plugin<ListPluginSetup, ListsPluginStart, {},
private readonly config: ConfigType;
private readonly extensionPoints: ExtensionPointStorageInterface;
private spaces: SpacesServiceStart | undefined | null;
private security: SecurityPluginStart | undefined | null;

constructor(private readonly initializerContext: PluginInitializerContext) {
this.logger = this.initializerContext.logger.get();
Expand Down Expand Up @@ -90,7 +88,6 @@ export class ListPlugin implements Plugin<ListPluginSetup, ListsPluginStart, {},

public start(core: CoreStart, plugins: PluginsStart): ListsPluginStart {
this.logger.debug('Starting plugin');
this.security = plugins.security;
this.spaces = plugins.spaces?.spacesService;
}

Expand All @@ -101,8 +98,9 @@ export class ListPlugin implements Plugin<ListPluginSetup, ListsPluginStart, {},

private createRouteHandlerContext = (): ContextProvider => {
return async (context, request): ContextProviderReturn => {
const { spaces, config, security, extensionPoints } = this;
const { spaces, config, extensionPoints } = this;
const {
security,
savedObjects: { client: savedObjectsClient },
elasticsearch: {
client: { asCurrentUser: esClient },
Expand All @@ -112,7 +110,7 @@ export class ListPlugin implements Plugin<ListPluginSetup, ListsPluginStart, {},
throw new TypeError('Configuration is required for this plugin to operate');
} else {
const spaceId = getSpaceId({ request, spaces });
const user = getUser({ request, security });
const user = getUser({ security });
return {
getExceptionListClient: (): ExceptionListClient =>
new ExceptionListClient({
Expand Down
3 changes: 2 additions & 1 deletion x-pack/plugins/lists/tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,8 @@
"@kbn/utility-types",
"@kbn/core-elasticsearch-client-server-mocks",
"@kbn/core-saved-objects-server",
"@kbn/zod-helpers"
"@kbn/zod-helpers",
"@kbn/core-security-server"
],
"exclude": ["target/**/*"]
}