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

[Alerting] Adds lazy loading to AlertType and Flyout components #65678

Merged
merged 30 commits into from
May 12, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
9802747
lazy load email action
gmmorris May 4, 2020
e6ec3f6
fixed unit testing of lazy components
gmmorris May 4, 2020
b717d31
remoed uneeded mports
gmmorris May 4, 2020
9bdea73
lazy load all actions
gmmorris May 5, 2020
ab4b5eb
use typing to ensure lazy loading
gmmorris May 5, 2020
20e11cb
lazy load sections
gmmorris May 5, 2020
93eaa01
Merge branch 'master' into alerting/lazy-load-actions
gmmorris May 5, 2020
f1ffe64
revert siem changes
gmmorris May 6, 2020
7f95f90
corrected type in siem
gmmorris May 6, 2020
687607e
Merge branch 'master' into alerting/lazy-load-actions
gmmorris May 6, 2020
12e8da4
Revert "revert siem changes"
gmmorris May 6, 2020
61b1b0f
updated docs
gmmorris May 7, 2020
364bf6c
Merge branch 'master' into alerting/lazy-load-actions
gmmorris May 7, 2020
105a802
fixed missing docLinks
gmmorris May 7, 2020
5280975
lazy load exposed flyout components
gmmorris May 7, 2020
6172ab1
Revert "lazy load exposed flyout components"
gmmorris May 7, 2020
b89934b
Revert "Revert "lazy load exposed flyout components""
gmmorris May 7, 2020
f6774a1
load exposed components lazily
gmmorris May 7, 2020
9a497b6
align and style loading indicator
gmmorris May 7, 2020
0e1656e
Merge branch 'master' into alerting/lazy-load-actions
gmmorris May 7, 2020
c436e8d
Merge branch 'alerting/lazy-load-actions' into alerting/lazy-load-com…
gmmorris May 7, 2020
e312b20
spinner is configurable
gmmorris May 7, 2020
74f076f
Merge branch 'master' into alerting/lazy-load-components
gmmorris May 11, 2020
67674f1
removed unused import
gmmorris May 11, 2020
e84b6be
fixed unit tests
gmmorris May 11, 2020
488ee79
support lazy loading on AlertType
gmmorris May 11, 2020
041e177
change type back to any as usage is wrong in other plugins
gmmorris May 11, 2020
073a924
Merge branch 'master' into alerting/lazy-load-components
gmmorris May 12, 2020
0736325
updated docs
gmmorris May 12, 2020
fe21249
Merge branch 'master' into alerting/lazy-load-components
gmmorris May 12, 2020
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
23 changes: 16 additions & 7 deletions x-pack/plugins/triggers_actions_ui/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,13 +69,13 @@ export function getAlertType(): AlertTypeModel {
id: '.index-threshold',
name: 'Index threshold',
iconClass: 'alert',
alertParamsExpression: IndexThresholdAlertTypeExpression,
alertParamsExpression: lazy(() => import('./index_threshold_expression')),
validate: validateAlertType,
};
}
```

alertParamsExpression form represented as an expression using `EuiExpression` components:
alertParamsExpression should be a lazy loaded React component extending an expression using `EuiExpression` components:
![Index Threshold Alert expression form](https://i.imgur.com/Ysk1ljY.png)

```
Expand Down Expand Up @@ -171,6 +171,7 @@ export const alertReducer = (state: any, action: AlertReducerAction) => {
```

The Expression component should be lazy loaded which means it'll have to be the default export in `index_threshold_expression.ts`:

```
export const IndexThresholdAlertTypeExpression: React.FunctionComponent<IndexThresholdProps> = ({
Expand Down Expand Up @@ -224,6 +225,9 @@ export const IndexThresholdAlertTypeExpression: React.FunctionComponent<IndexThr
</Fragment>
);
};
// Export as default in order to support lazy loading
export {IndexThresholdAlertTypeExpression as default};
```

Index Threshold Alert form with validation:
Expand All @@ -237,7 +241,9 @@ Each alert type should be defined as `AlertTypeModel` object with the these prop
name: string;
iconClass: string;
validate: (alertParams: any) => ValidationResult;
alertParamsExpression: React.FunctionComponent<any>;
alertParamsExpression: React.LazyExoticComponent<
ComponentType<AlertTypeParamsExpressionProps<AlertParamsType, AlertsContextValue>>
>;
defaultActionMessage?: string;
```
|Property|Description|
Expand All @@ -246,7 +252,7 @@ Each alert type should be defined as `AlertTypeModel` object with the these prop
|name|Name of the alert type that will be displayed on the select card in the UI.|
|iconClass|Icon of the alert type that will be displayed on the select card in the UI.|
|validate|Validation function for the alert params.|
|alertParamsExpression|React functional component for building UI of the current alert type params.|
|alertParamsExpression| A lazy loaded React component for building UI of the current alert type params.|
|defaultActionMessage|Optional property for providing default message for all added actions with `message` property.|

IMPORTANT: The current UI supports a single action group only.
Expand Down Expand Up @@ -295,16 +301,16 @@ Below is a list of steps that should be done to build and register a new alert t

1. At any suitable place in Kibana, create a file, which will expose an object implementing interface [AlertTypeModel](https://github.com/elastic/kibana/blob/55b7905fb5265b73806006e7265739545d7521d0/x-pack/legacy/plugins/triggers_actions_ui/np_ready/public/types.ts#L83). Example:
```
import { lazy } from 'react';
import { AlertTypeModel } from '../../../../types';
import { ExampleExpression } from './expression';
import { validateExampleAlertType } from './validation';
export function getAlertType(): AlertTypeModel {
return {
id: 'example',
name: 'Example Alert Type',
iconClass: 'bell',
alertParamsExpression: ExampleExpression,
alertParamsExpression: lazy(() => import('./expression')),
validate: validateExampleAlertType,
defaultActionMessage: 'Alert [{{ctx.metadata.name}}] has exceeded the threshold',
};
Expand Down Expand Up @@ -361,6 +367,9 @@ export const ExampleExpression: React.FunctionComponent<ExampleProps> = ({
);
};
// Export as default in order to support lazy loading
export {ExampleExpression as default};
```
This alert type form becomes available, when the card of `Example Alert Type` is selected.
Each expression word here is `EuiExpression` component and implements the basic aggregation, grouping and comparison methods.
Expand Down Expand Up @@ -1017,7 +1026,7 @@ Below is a list of steps that should be done to build and register a new action

1. At any suitable place in Kibana, create a file, which will expose an object implementing interface [ActionTypeModel]:
```
import React, { Fragment } from 'react';
import React, { Fragment, lazy } from 'react';
import { i18n } from '@kbn/i18n';
import {
ActionTypeModel,
Expand Down
31 changes: 8 additions & 23 deletions x-pack/plugins/triggers_actions_ui/public/application/app.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
* or more contributor license agreements. Licensed under the Elastic License;
* you may not use this file except in compliance with the Elastic License.
*/
import React, { lazy, Suspense } from 'react';
import { Switch, Route, Redirect, HashRouter, RouteComponentProps } from 'react-router-dom';
import React, { lazy } from 'react';
import { Switch, Route, Redirect, HashRouter } from 'react-router-dom';
import {
ChromeStart,
DocLinksStart,
Expand All @@ -15,7 +15,6 @@ import {
ChromeBreadcrumb,
CoreStart,
} from 'kibana/public';
import { EuiLoadingSpinner, EuiFlexGroup, EuiFlexItem } from '@elastic/eui';
import { BASE_PATH, Section, routeToAlertDetails } from './constants';
import { AppContextProvider, useAppDependencies } from './app_context';
import { hasShowAlertsCapability } from './lib/capabilities';
Expand All @@ -24,6 +23,7 @@ import { TypeRegistry } from './type_registry';
import { ChartsPluginStart } from '../../../../../src/plugins/charts/public';
import { DataPublicPluginStart } from '../../../../../src/plugins/data/public';
import { PluginStartContract as AlertingStart } from '../../../alerting/public';
import { suspendedComponentWithProps } from './lib/suspended_component_with_props';

const TriggersActionsUIHome = lazy(async () => import('./home'));
const AlertDetailsRoute = lazy(() =>
Expand Down Expand Up @@ -68,30 +68,15 @@ export const AppWithoutRouter = ({ sectionsRegex }: { sectionsRegex: string }) =
<Switch>
<Route
path={`${BASE_PATH}/:section(${sectionsRegex})`}
component={suspendedRouteComponent(TriggersActionsUIHome)}
component={suspendedComponentWithProps(TriggersActionsUIHome, 'xl')}
/>
{canShowAlerts && (
<Route path={routeToAlertDetails} component={suspendedRouteComponent(AlertDetailsRoute)} />
<Route
path={routeToAlertDetails}
component={suspendedComponentWithProps(AlertDetailsRoute, 'xl')}
/>
)}
<Redirect from={`${BASE_PATH}`} to={`${BASE_PATH}/${DEFAULT_SECTION}`} />
</Switch>
);
};

function suspendedRouteComponent<T = unknown>(
RouteComponent: React.ComponentType<RouteComponentProps<T>>
) {
return (props: RouteComponentProps<T>) => (
<Suspense
fallback={
<EuiFlexGroup justifyContent="center">
<EuiFlexItem grow={false}>
<EuiLoadingSpinner size="xl" />
</EuiFlexItem>
</EuiFlexGroup>
}
>
<RouteComponent {...props} />
</Suspense>
);
}
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ import {
} from '../../../../common';
import { builtInAggregationTypes } from '../../../../common/constants';
import { IndexThresholdAlertParams } from './types';
import { AlertTypeParamsExpressionProps } from '../../../../types';
import { AlertsContextValue } from '../../../context/alerts_context';
import './expression.scss';

Expand All @@ -66,23 +67,10 @@ const expressionFieldsWithValidation = [
'timeWindowSize',
];

interface IndexThresholdProps {
alertParams: IndexThresholdAlertParams;
alertInterval: string;
setAlertParams: (property: string, value: any) => void;
setAlertProperty: (key: string, value: any) => void;
errors: { [key: string]: string[] };
alertsContext: AlertsContextValue;
}

export const IndexThresholdAlertTypeExpression: React.FunctionComponent<IndexThresholdProps> = ({
alertParams,
alertInterval,
setAlertParams,
setAlertProperty,
errors,
alertsContext,
}) => {
export const IndexThresholdAlertTypeExpression: React.FunctionComponent<AlertTypeParamsExpressionProps<
IndexThresholdAlertParams,
AlertsContextValue
>> = ({ alertParams, alertInterval, setAlertParams, setAlertProperty, errors, alertsContext }) => {
const {
index,
timeField,
Expand Down Expand Up @@ -476,3 +464,6 @@ export const IndexThresholdAlertTypeExpression: React.FunctionComponent<IndexThr
</Fragment>
);
};

// eslint-disable-next-line import/no-default-export
export { IndexThresholdAlertTypeExpression as default };
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,19 @@
* or more contributor license agreements. Licensed under the Elastic License;
* you may not use this file except in compliance with the Elastic License.
*/
import { lazy } from 'react';

import { AlertTypeModel } from '../../../../types';
import { IndexThresholdAlertTypeExpression } from './expression';
import { validateExpression } from './validation';
import { IndexThresholdAlertParams } from './types';
import { AlertsContextValue } from '../../../context/alerts_context';

export function getAlertType(): AlertTypeModel {
export function getAlertType(): AlertTypeModel<IndexThresholdAlertParams, AlertsContextValue> {
return {
id: '.index-threshold',
name: 'Index threshold',
iconClass: 'alert',
alertParamsExpression: IndexThresholdAlertTypeExpression,
alertParamsExpression: lazy(() => import('./expression')),
validate: validateExpression,
};
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
/*
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
* or more contributor license agreements. Licensed under the Elastic License;
* you may not use this file except in compliance with the Elastic License.
*/
import React, { Suspense } from 'react';
import { EuiLoadingSpinner, EuiFlexGroup, EuiFlexItem } from '@elastic/eui';
import { EuiLoadingSpinnerSize } from '@elastic/eui/src/components/loading/loading_spinner';

export function suspendedComponentWithProps<T = unknown>(
ComponentToSuspend: React.ComponentType<T>,
size?: EuiLoadingSpinnerSize
) {
return (props: T) => (
<Suspense
fallback={
<EuiFlexGroup justifyContent="center">
<EuiFlexItem grow={false}>
<EuiLoadingSpinner size={size ?? 'm'} />
</EuiFlexItem>
</EuiFlexGroup>
}
>
<ComponentToSuspend {...props} />
</Suspense>
);
}
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import { ReactWrapper } from 'enzyme';
import { act } from 'react-dom/test-utils';
import { actionTypeRegistryMock } from '../../action_type_registry.mock';
import { ValidationResult, Alert, AlertAction } from '../../../types';
import { ActionForm } from './action_form';
import ActionForm from './action_form';
jest.mock('../../lib/action_connector_api', () => ({
loadAllActions: jest.fn(),
loadActionTypes: jest.fn(),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -707,3 +707,6 @@ export const ActionForm = ({
</Fragment>
);
};

// eslint-disable-next-line import/no-default-export
export { ActionForm as default };
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
import * as React from 'react';
import { mountWithIntl } from 'test_utils/enzyme_helpers';
import { coreMock } from '../../../../../../../src/core/public/mocks';
import { ConnectorAddFlyout } from './connector_add_flyout';
import ConnectorAddFlyout from './connector_add_flyout';
import { ActionsConnectorsContextProvider } from '../../context/actions_connectors_context';
import { actionTypeRegistryMock } from '../../action_type_registry.mock';
import { ValidationResult } from '../../../types';
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -319,3 +319,6 @@ const UpgradeYourLicenseCallOut = ({ http }: { http: HttpSetup }) => (
</EuiFlexGroup>
</EuiCallOut>
);

// eslint-disable-next-line import/no-default-export
export { ConnectorAddFlyout as default };
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import { coreMock } from '../../../../../../../src/core/public/mocks';
import { ActionsConnectorsContextProvider } from '../../context/actions_connectors_context';
import { actionTypeRegistryMock } from '../../action_type_registry.mock';
import { ValidationResult } from '../../../types';
import { ConnectorEditFlyout } from './connector_edit_flyout';
import ConnectorEditFlyout from './connector_edit_flyout';
import { AppContextProvider } from '../../app_context';

const actionTypeRegistry = actionTypeRegistryMock.create();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -254,3 +254,6 @@ export const ConnectorEditFlyout = ({
</EuiFlyout>
);
};

// eslint-disable-next-line import/no-default-export
export { ConnectorEditFlyout as default };
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,13 @@
* you may not use this file except in compliance with the Elastic License.
*/

export { ConnectorAddFlyout } from './connector_add_flyout';
export { ConnectorEditFlyout } from './connector_edit_flyout';
export { ActionForm } from './action_form';
import { lazy } from 'react';
import { suspendedComponentWithProps } from '../../lib/suspended_component_with_props';

export const ConnectorAddFlyout = suspendedComponentWithProps(
lazy(() => import('./connector_add_flyout'))
);
export const ConnectorEditFlyout = suspendedComponentWithProps(
lazy(() => import('./connector_edit_flyout'))
);
export const ActionForm = suspendedComponentWithProps(lazy(() => import('./action_form')));
Original file line number Diff line number Diff line change
Expand Up @@ -202,11 +202,12 @@ describe('actions_connectors_list component with items', () => {
expect(wrapper.find('[data-test-subj="preConfiguredTitleMessage"]')).toHaveLength(2);
});

test('if select item for edit should render ConnectorEditFlyout', () => {
wrapper
test('if select item for edit should render ConnectorEditFlyout', async () => {
await wrapper
.find('[data-test-subj="edit1"]')
.first()
.simulate('click');

expect(wrapper.find('ConnectorEditFlyout')).toHaveLength(1);
});
});
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,9 @@ import { i18n } from '@kbn/i18n';
import { FormattedMessage } from '@kbn/i18n/react';
import { useAppDependencies } from '../../../app_context';
import { loadAllActions, loadActionTypes, deleteActions } from '../../../lib/action_connector_api';
import { ConnectorAddFlyout, ConnectorEditFlyout } from '../../action_connector_form';
import ConnectorAddFlyout from '../../action_connector_form/connector_add_flyout';
import ConnectorEditFlyout from '../../action_connector_form/connector_edit_flyout';

import { hasDeleteActionsCapability, hasSaveActionsCapability } from '../../../lib/capabilities';
import { DeleteModalConfirmation } from '../../../components/delete_modal_confirmation';
import { ActionsConnectorsContextProvider } from '../../../context/actions_connectors_context';
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import { act } from 'react-dom/test-utils';
import { FormattedMessage } from '@kbn/i18n/react';
import { EuiFormLabel } from '@elastic/eui';
import { coreMock } from '../../../../../../../src/core/public/mocks';
import { AlertAdd } from './alert_add';
import AlertAdd from './alert_add';
import { actionTypeRegistryMock } from '../../action_type_registry.mock';
import { ValidationResult } from '../../../types';
import { AlertsContextProvider, useAlertsContext } from '../../context/alerts_context';
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -219,3 +219,6 @@ const parseErrors: (errors: IErrorObject) => boolean = errors =>
if (isObject(errorList)) return parseErrors(errorList as IErrorObject);
return errorList.length >= 1;
});

// eslint-disable-next-line import/no-default-export
export { AlertAdd as default };
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import { ValidationResult } from '../../../types';
import { AlertsContextProvider } from '../../context/alerts_context';
import { alertTypeRegistryMock } from '../../alert_type_registry.mock';
import { ReactWrapper } from 'enzyme';
import { AlertEdit } from './alert_edit';
import AlertEdit from './alert_edit';
import { AppContextProvider } from '../../app_context';
const actionTypeRegistry = actionTypeRegistryMock.create();
const alertTypeRegistry = alertTypeRegistryMock.create();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -201,3 +201,6 @@ export const AlertEdit = ({ initialAlert, onClose }: AlertEditProps) => {
</EuiPortal>
);
};

// eslint-disable-next-line import/no-default-export
export { AlertEdit as default };
Loading