Skip to content

Commit

Permalink
[Spaces] Read Security license to infer eligibility for sub feature c…
Browse files Browse the repository at this point in the history
…ustomization (#195389)

## Summary

Closes #195549

This PR adds implementation such that eligibility to allow for the
toggling of the switch for customization of sub features whilst defining
privileges that would be assigned to a space is determined from security
license.


### Before
![ScreenRecording2024-10-09at10 09 33-ezgif
com-video-to-gif-converter](https://github.com/user-attachments/assets/c80761c9-a45e-4784-835e-e6895d2fbed5)

### After

![ScreenRecording2024-10-09at10 05 53-ezgif
com-video-to-gif-converter](https://github.com/user-attachments/assets/4e7d5724-42b0-4495-8fae-b47e7a97957c)

<!-- ### Checklist

Delete any items that are not applicable to this PR.

- [ ] Any text added follows [EUI's writing
guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses
sentence case text and includes [i18n
support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)
- [ ]
[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)
was added for features that require explanation or tutorials
- [ ] [Unit or functional
tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)
were updated or added to match the most common scenarios
- [ ] [Flaky Test
Runner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was
used on any tests changed
- [ ] Any UI touched in this PR is usable by keyboard only (learn more
about [keyboard accessibility](https://webaim.org/techniques/keyboard/))
- [ ] Any UI touched in this PR does not create any new axe failures
(run axe in browser:
[FF](https://addons.mozilla.org/en-US/firefox/addon/axe-devtools/),
[Chrome](https://chrome.google.com/webstore/detail/axe-web-accessibility-tes/lhdoppojpmngadmnindnejefpokejbdd?hl=en-US))
- [ ] If a plugin configuration key changed, check if it needs to be
allowlisted in the cloud and added to the [docker
list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)
- [ ] This renders correctly on smaller devices using a responsive
layout. (You can test this [in your
browser](https://www.browserstack.com/guide/responsive-testing-on-local-server))
- [ ] This was checked for [cross-browser
compatibility](https://www.elastic.co/support/matrix#matrix_browsers)


### Risk Matrix

Delete this section if it is not applicable to this PR.

Before closing this PR, invite QA, stakeholders, and other developers to
identify risks that should be tested prior to the change/feature
release.

When forming the risk matrix, consider some of the following examples
and how they may potentially impact the change:

| Risk | Probability | Severity | Mitigation/Notes |

|---------------------------|-------------|----------|-------------------------|
| Multiple Spaces&mdash;unexpected behavior in non-default Kibana Space.
| Low | High | Integration tests will verify that all features are still
supported in non-default Kibana Space and when user switches between
spaces. |
| Multiple nodes&mdash;Elasticsearch polling might have race conditions
when multiple Kibana nodes are polling for the same tasks. | High | Low
| Tasks are idempotent, so executing them multiple times will not result
in logical error, but will degrade performance. To test for this case we
add plenty of unit tests around this logic and document manual testing
procedure. |
| Code should gracefully handle cases when feature X or plugin Y are
disabled. | Medium | High | Unit tests will verify that any feature flag
or plugin combination still results in our service operational. |
| [See more potential risk
examples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx) |


### For maintainers

- [ ] This was checked for breaking API changes and was [labeled
appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)
-->
  • Loading branch information
eokoneyo authored Oct 16, 2024
1 parent fbe15fe commit e6e30c2
Show file tree
Hide file tree
Showing 18 changed files with 334 additions and 96 deletions.
1 change: 1 addition & 0 deletions x-pack/packages/security/plugin_types_public/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,4 @@ export type {
} from './src/roles';
export { PrivilegesAPIClientPublicContract } from './src/privileges';
export type { PrivilegesAPIClientGetAllArgs } from './src/privileges';
export type { SecurityLicense } from './src/license';
10 changes: 10 additions & 0 deletions x-pack/packages/security/plugin_types_public/src/license/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
/*
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
* or more contributor license agreements. Licensed under the Elastic License
* 2.0; you may not use this file except in compliance with the Elastic License
* 2.0.
*/

import type { SecurityPluginSetup } from '../plugin';

export type SecurityLicense = SecurityPluginSetup['license'];
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,13 @@ import {
import { __IntlProvider as IntlProvider } from '@kbn/i18n-react';

import { EditSpaceContentTab } from './edit_space_content_tab';
import { EditSpaceProvider } from './provider';
import { EditSpaceProviderRoot } from './provider';
import type { Space } from '../../../common';
import { spacesManagerMock } from '../../spaces_manager/spaces_manager.mock';
import type { SpaceContentTypeSummaryItem } from '../../types';
import { getPrivilegeAPIClientMock } from '../privilege_api_client.mock';
import { getRolesAPIClientMock } from '../roles_api_client.mock';
import { getSecurityLicenseMock } from '../security_license.mock';

const getUrlForApp = (appId: string) => appId;
const navigateToUrl = jest.fn();
Expand All @@ -42,7 +43,7 @@ const logger = loggingSystemMock.createLogger();
const TestComponent: React.FC<React.PropsWithChildren> = ({ children }) => {
return (
<IntlProvider locale="en">
<EditSpaceProvider
<EditSpaceProviderRoot
capabilities={{
navLinks: {},
management: {},
Expand All @@ -58,12 +59,13 @@ const TestComponent: React.FC<React.PropsWithChildren> = ({ children }) => {
notifications={notifications}
overlays={overlays}
getPrivilegesAPIClient={getPrivilegeAPIClient}
getSecurityLicense={getSecurityLicenseMock}
theme={theme}
i18n={i18n}
logger={logger}
>
{children}
</EditSpaceProvider>
</EditSpaceProviderRoot>
</IntlProvider>
);
};
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,13 @@ import { KibanaFeature } from '@kbn/features-plugin/common';
import { __IntlProvider as IntlProvider } from '@kbn/i18n-react';

import { EditSpaceSettingsTab } from './edit_space_general_tab';
import { EditSpaceProvider } from './provider/edit_space_provider';
import { EditSpaceProviderRoot } from './provider/edit_space_provider';
import type { SolutionView } from '../../../common';
import { SOLUTION_VIEW_CLASSIC } from '../../../common/constants';
import { spacesManagerMock } from '../../spaces_manager/spaces_manager.mock';
import { getPrivilegeAPIClientMock } from '../privilege_api_client.mock';
import { getRolesAPIClientMock } from '../roles_api_client.mock';
import { getSecurityLicenseMock } from '../security_license.mock';

const space = { id: 'default', name: 'Default', disabledFeatures: [], _reserved: true };
const history = scopedHistoryMock.create();
Expand Down Expand Up @@ -64,7 +65,7 @@ describe('EditSpaceSettings', () => {
const TestComponent: React.FC<React.PropsWithChildren> = ({ children }) => {
return (
<IntlProvider locale="en">
<EditSpaceProvider
<EditSpaceProviderRoot
capabilities={{
navLinks: {},
management: {},
Expand All @@ -80,12 +81,13 @@ describe('EditSpaceSettings', () => {
notifications={notifications}
overlays={overlays}
getPrivilegesAPIClient={getPrivilegeAPIClient}
getSecurityLicense={getSecurityLicenseMock}
theme={theme}
i18n={i18n}
logger={logger}
>
{children}
</EditSpaceProvider>
</EditSpaceProviderRoot>
</IntlProvider>
);
};
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ import React from 'react';
import type { ComponentProps, PropsWithChildren } from 'react';

import { EditSpace } from './edit_space';
import { EditSpaceProvider, type EditSpaceProviderProps } from './provider';
import { EditSpaceProviderRoot, type EditSpaceProviderRootProps } from './provider';

type EditSpacePageProps = ComponentProps<typeof EditSpace> & EditSpaceProviderProps;
type EditSpacePageProps = ComponentProps<typeof EditSpace> & EditSpaceProviderRootProps;

export function EditSpacePage({
spaceId,
Expand All @@ -25,7 +25,7 @@ export function EditSpacePage({
...editSpaceServicesProps
}: PropsWithChildren<EditSpacePageProps>) {
return (
<EditSpaceProvider {...editSpaceServicesProps}>
<EditSpaceProviderRoot {...editSpaceServicesProps}>
<EditSpace
spaceId={spaceId}
getFeatures={getFeatures}
Expand All @@ -35,6 +35,6 @@ export function EditSpacePage({
allowFeatureVisibility={allowFeatureVisibility}
allowSolutionVisibility={allowSolutionVisibility}
/>
</EditSpaceProvider>
</EditSpaceProviderRoot>
);
}
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,11 @@ import {
import { __IntlProvider as IntlProvider } from '@kbn/i18n-react';

import { EditSpaceAssignedRolesTab } from './edit_space_roles_tab';
import { EditSpaceProvider } from './provider';
import { EditSpaceProviderRoot } from './provider';
import { spacesManagerMock } from '../../spaces_manager/spaces_manager.mock';
import { getPrivilegeAPIClientMock } from '../privilege_api_client.mock';
import { getRolesAPIClientMock } from '../roles_api_client.mock';
import { getSecurityLicenseMock } from '../security_license.mock';

const getUrlForApp = (appId: string) => appId;
const navigateToUrl = jest.fn();
Expand Down Expand Up @@ -51,7 +52,7 @@ describe('EditSpaceAssignedRolesTab', () => {
const TestComponent: React.FC<React.PropsWithChildren> = ({ children }) => {
return (
<IntlProvider locale="en">
<EditSpaceProvider
<EditSpaceProviderRoot
capabilities={{
navLinks: {},
management: {},
Expand All @@ -67,12 +68,13 @@ describe('EditSpaceAssignedRolesTab', () => {
notifications={notifications}
overlays={overlays}
getPrivilegesAPIClient={getPrivilegeAPIClient}
getSecurityLicense={getSecurityLicenseMock}
theme={theme}
i18n={i18n}
logger={logger}
>
{children}
</EditSpaceProvider>
</EditSpaceProviderRoot>
</IntlProvider>
);
};
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ export const EditSpaceAssignedRolesTab: FC<Props> = ({ space, features, isReadOn
(defaultSelected?: Role[]) => {
const overlayRef = overlays.openFlyout(
toMountPoint(
<EditSpaceProvider {...services}>
<EditSpaceProvider {...services} dispatch={dispatch} state={state}>
<PrivilegesRolesForm
{...{
space,
Expand Down Expand Up @@ -109,9 +109,10 @@ export const EditSpaceAssignedRolesTab: FC<Props> = ({ space, features, isReadOn
[
overlays,
services,
dispatch,
state,
space,
features,
dispatch,
invokeClient,
getUrlForApp,
theme,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,15 @@ import {
import type { ApplicationStart } from '@kbn/core-application-browser';
import { __IntlProvider as IntlProvider } from '@kbn/i18n-react';

import { EditSpaceProvider, useEditSpaceServices, useEditSpaceStore } from './edit_space_provider';
import {
EditSpaceProviderRoot,
useEditSpaceServices,
useEditSpaceStore,
} from './edit_space_provider';
import { spacesManagerMock } from '../../../spaces_manager/spaces_manager.mock';
import { getPrivilegeAPIClientMock } from '../../privilege_api_client.mock';
import { getRolesAPIClientMock } from '../../roles_api_client.mock';
import { getSecurityLicenseMock } from '../../security_license.mock';

const http = httpServiceMock.createStartContract();
const notifications = notificationServiceMock.createStartContract();
Expand All @@ -45,7 +50,7 @@ const SUTProvider = ({
}: PropsWithChildren<Partial<Pick<ApplicationStart, 'capabilities'>>>) => {
return (
<IntlProvider locale="en">
<EditSpaceProvider
<EditSpaceProviderRoot
{...{
logger,
i18n,
Expand All @@ -58,12 +63,13 @@ const SUTProvider = ({
getUrlForApp: (_) => _,
getRolesAPIClient: getRolesAPIClientMock,
getPrivilegesAPIClient: getPrivilegeAPIClientMock,
getSecurityLicense: getSecurityLicenseMock,
navigateToUrl: jest.fn(),
capabilities,
}}
>
{children}
</EditSpaceProvider>
</EditSpaceProviderRoot>
</IntlProvider>
);
};
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ import type { Logger } from '@kbn/logging';
import type {
PrivilegesAPIClientPublicContract,
RolesAPIClient,
SecurityLicense,
} from '@kbn/security-plugin-types-public';

import {
Expand All @@ -32,7 +33,7 @@ import {
} from './reducers';
import type { SpacesManager } from '../../../spaces_manager';

export interface EditSpaceProviderProps
export interface EditSpaceProviderRootProps
extends Pick<CoreStart, 'theme' | 'i18n' | 'overlays' | 'http' | 'notifications'> {
logger: Logger;
capabilities: ApplicationStart['capabilities'];
Expand All @@ -42,10 +43,7 @@ export interface EditSpaceProviderProps
spacesManager: SpacesManager;
getRolesAPIClient: () => Promise<RolesAPIClient>;
getPrivilegesAPIClient: () => Promise<PrivilegesAPIClientPublicContract>;
}

export interface EditSpaceServices extends EditSpaceProviderProps {
invokeClient<R extends unknown>(arg: (clients: EditSpaceClients) => Promise<R>): Promise<R>;
getSecurityLicense: () => Promise<SecurityLicense>;
}

interface EditSpaceClients {
Expand All @@ -54,6 +52,15 @@ interface EditSpaceClients {
privilegesClient: PrivilegesAPIClientPublicContract;
}

export interface EditSpaceServices
extends Omit<
EditSpaceProviderRootProps,
'getRolesAPIClient' | 'getPrivilegesAPIClient' | 'getSecurityLicense'
> {
invokeClient<R extends unknown>(arg: (clients: EditSpaceClients) => Promise<R>): Promise<R>;
license?: SecurityLicense;
}

export interface EditSpaceStore {
state: IEditSpaceStoreState;
dispatch: Dispatch<IDispatchAction>;
Expand All @@ -63,16 +70,43 @@ const createSpaceRolesContext = once(() => createContext<EditSpaceStore | null>(

const createEditSpaceServicesContext = once(() => createContext<EditSpaceServices | null>(null));

/**
*
* @description EditSpaceProvider is a provider component that wraps the children components with the necessary context providers for the Edit Space feature. It provides the necessary services and state management for the feature,
* this is provided as an export for use with out of band renders within the spaces app
*/
export const EditSpaceProvider = ({
children,
state,
dispatch,
...services
}: PropsWithChildren<EditSpaceProviderProps>) => {
}: PropsWithChildren<EditSpaceServices & EditSpaceStore>) => {
const EditSpaceStoreContext = createSpaceRolesContext();
const EditSpaceServicesContext = createEditSpaceServicesContext();

const clients = useRef(
Promise.all([services.getRolesAPIClient(), services.getPrivilegesAPIClient()])
return (
<EditSpaceServicesContext.Provider value={services}>
<EditSpaceStoreContext.Provider value={{ state, dispatch }}>
{children}
</EditSpaceStoreContext.Provider>
</EditSpaceServicesContext.Provider>
);
};

/**
* @description EditSpaceProviderRoot is the root provider for the Edit Space feature. It instantiates the necessary services and state management for the feature. It ideally
* should only be rendered once
*/
export const EditSpaceProviderRoot = ({
children,
...services
}: PropsWithChildren<EditSpaceProviderRootProps>) => {
const { logger, getRolesAPIClient, getPrivilegesAPIClient, getSecurityLicense } = services;

const clients = useRef(Promise.all([getRolesAPIClient(), getPrivilegesAPIClient()]));
const license = useRef(getSecurityLicense);

const licenseRef = useRef<SecurityLicense>();
const rolesAPIClientRef = useRef<RolesAPIClient>();
const privilegesClientRef = useRef<PrivilegesAPIClientPublicContract>();

Expand All @@ -81,7 +115,14 @@ export const EditSpaceProvider = ({
fetchRolesError: false,
});

const { logger } = services;
const resolveSecurityLicense = useCallback(async () => {
try {
licenseRef.current = await license.current();
} catch (err) {
logger.error('Could not resolve Security License!', err);
}
}, [logger]);

const resolveAPIClients = useCallback(async () => {
try {
[rolesAPIClientRef.current, privilegesClientRef.current] = await clients.current;
Expand All @@ -94,6 +135,10 @@ export const EditSpaceProvider = ({
resolveAPIClients();
}, [resolveAPIClients]);

useEffect(() => {
resolveSecurityLicense();
}, [resolveSecurityLicense]);

const createInitialState = useCallback((state: IEditSpaceStoreState) => {
return state;
}, []);
Expand All @@ -118,11 +163,11 @@ export const EditSpaceProvider = ({
);

return (
<EditSpaceServicesContext.Provider value={{ ...services, invokeClient }}>
<EditSpaceStoreContext.Provider value={{ state, dispatch }}>
{children}
</EditSpaceStoreContext.Provider>
</EditSpaceServicesContext.Provider>
<EditSpaceProvider
{...{ ...services, invokeClient, state, dispatch, license: licenseRef.current }}
>
{children}
</EditSpaceProvider>
);
};

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,14 @@
* 2.0.
*/

export { EditSpaceProvider, useEditSpaceServices, useEditSpaceStore } from './edit_space_provider';
export {
EditSpaceProviderRoot,
EditSpaceProvider,
useEditSpaceServices,
useEditSpaceStore,
} from './edit_space_provider';
export type {
EditSpaceProviderProps,
EditSpaceProviderRootProps,
EditSpaceServices,
EditSpaceStore,
} from './edit_space_provider';
Loading

0 comments on commit e6e30c2

Please sign in to comment.