{
data-test-subj="helpMenuButton"
id="headerHelpMenu"
isOpen={this.state.isOpen}
- ownFocus
repositionOnScroll
>
diff --git a/src/core/public/overlays/flyout/flyout_service.tsx b/src/core/public/overlays/flyout/flyout_service.tsx
index 444430175d4f2..85b31d48bd39e 100644
--- a/src/core/public/overlays/flyout/flyout_service.tsx
+++ b/src/core/public/overlays/flyout/flyout_service.tsx
@@ -19,7 +19,7 @@
/* eslint-disable max-classes-per-file */
-import { EuiFlyout } from '@elastic/eui';
+import { EuiFlyout, EuiFlyoutSize } from '@elastic/eui';
import React from 'react';
import { render, unmountComponentAtNode } from 'react-dom';
import { Subject } from 'rxjs';
@@ -93,6 +93,8 @@ export interface OverlayFlyoutOpenOptions {
closeButtonAriaLabel?: string;
ownFocus?: boolean;
'data-test-subj'?: string;
+ size?: EuiFlyoutSize;
+ maxWidth?: boolean | number | string;
}
interface StartDeps {
diff --git a/src/core/public/public.api.md b/src/core/public/public.api.md
index 82e4a6dd07824..51fc65441b3b5 100644
--- a/src/core/public/public.api.md
+++ b/src/core/public/public.api.md
@@ -12,6 +12,7 @@ import { EnvironmentMode } from '@kbn/config';
import { EuiBreadcrumb } from '@elastic/eui';
import { EuiButtonEmptyProps } from '@elastic/eui';
import { EuiConfirmModalProps } from '@elastic/eui';
+import { EuiFlyoutSize } from '@elastic/eui';
import { EuiGlobalToastListToast } from '@elastic/eui';
import { ExclusiveUnion } from '@elastic/eui';
import { History } from 'history';
@@ -885,7 +886,11 @@ export interface OverlayFlyoutOpenOptions {
// (undocumented)
closeButtonAriaLabel?: string;
// (undocumented)
+ maxWidth?: boolean | number | string;
+ // (undocumented)
ownFocus?: boolean;
+ // (undocumented)
+ size?: EuiFlyoutSize;
}
// @public
diff --git a/src/core/server/bootstrap.ts b/src/core/server/bootstrap.ts
index 6711a8b8987e5..f7dd2a4ea24f5 100644
--- a/src/core/server/bootstrap.ts
+++ b/src/core/server/bootstrap.ts
@@ -27,9 +27,6 @@ interface KibanaFeatures {
// a child process together with optimizer "worker" processes that are
// orchestrated by a parent process (dev mode only feature).
isCliDevModeSupported: boolean;
-
- // Indicates whether we can run Kibana in REPL mode (dev mode only feature).
- isReplModeSupported: boolean;
}
interface BootstrapArgs {
@@ -50,10 +47,6 @@ export async function bootstrap({
applyConfigOverrides,
features,
}: BootstrapArgs) {
- if (cliArgs.repl && !features.isReplModeSupported) {
- onRootShutdown('Kibana REPL mode can only be run in development mode.');
- }
-
if (cliArgs.optimize) {
// --optimize is deprecated and does nothing now, avoid starting up and just shutdown
return;
diff --git a/src/core/server/legacy/cluster_manager.js b/src/core/server/legacy/cli_dev_mode.js
similarity index 91%
rename from src/core/server/legacy/cluster_manager.js
rename to src/core/server/legacy/cli_dev_mode.js
index 3c51fd6869a09..05a13bc55f97e 100644
--- a/src/core/server/legacy/cluster_manager.js
+++ b/src/core/server/legacy/cli_dev_mode.js
@@ -17,4 +17,4 @@
* under the License.
*/
-export { ClusterManager } from '../../../cli/cluster/cluster_manager';
+export { CliDevMode } from '../../../dev/cli_dev_mode';
diff --git a/src/core/server/legacy/legacy_service.test.ts b/src/core/server/legacy/legacy_service.test.ts
index fe19ef9d0a774..98532d720c310 100644
--- a/src/core/server/legacy/legacy_service.test.ts
+++ b/src/core/server/legacy/legacy_service.test.ts
@@ -18,13 +18,13 @@
*/
jest.mock('../../../legacy/server/kbn_server');
-jest.mock('./cluster_manager');
+jest.mock('./cli_dev_mode');
import { BehaviorSubject, throwError } from 'rxjs';
import { REPO_ROOT } from '@kbn/dev-utils';
// @ts-expect-error js file to remove TS dependency on cli
-import { ClusterManager as MockClusterManager } from './cluster_manager';
+import { CliDevMode as MockCliDevMode } from './cli_dev_mode';
import KbnServer from '../../../legacy/server/kbn_server';
import { Config, Env, ObjectToConfigAdapter } from '../config';
import { BasePathProxyServer } from '../http';
@@ -239,7 +239,7 @@ describe('once LegacyService is set up with connection info', () => {
);
expect(MockKbnServer).not.toHaveBeenCalled();
- expect(MockClusterManager).not.toHaveBeenCalled();
+ expect(MockCliDevMode).not.toHaveBeenCalled();
});
test('reconfigures logging configuration if new config is received.', async () => {
@@ -355,7 +355,7 @@ describe('once LegacyService is set up in `devClusterMaster` mode', () => {
});
});
- test('creates ClusterManager without base path proxy.', async () => {
+ test('creates CliDevMode without base path proxy.', async () => {
const devClusterLegacyService = new LegacyService({
coreId,
env: Env.createDefault(
@@ -373,8 +373,8 @@ describe('once LegacyService is set up in `devClusterMaster` mode', () => {
await devClusterLegacyService.setup(setupDeps);
await devClusterLegacyService.start(startDeps);
- expect(MockClusterManager).toHaveBeenCalledTimes(1);
- expect(MockClusterManager).toHaveBeenCalledWith(
+ expect(MockCliDevMode.fromCoreServices).toHaveBeenCalledTimes(1);
+ expect(MockCliDevMode.fromCoreServices).toHaveBeenCalledWith(
expect.objectContaining({ silent: true, basePath: false }),
expect.objectContaining({
get: expect.any(Function),
@@ -384,7 +384,7 @@ describe('once LegacyService is set up in `devClusterMaster` mode', () => {
);
});
- test('creates ClusterManager with base path proxy.', async () => {
+ test('creates CliDevMode with base path proxy.', async () => {
const devClusterLegacyService = new LegacyService({
coreId,
env: Env.createDefault(
@@ -402,8 +402,8 @@ describe('once LegacyService is set up in `devClusterMaster` mode', () => {
await devClusterLegacyService.setup(setupDeps);
await devClusterLegacyService.start(startDeps);
- expect(MockClusterManager).toHaveBeenCalledTimes(1);
- expect(MockClusterManager).toHaveBeenCalledWith(
+ expect(MockCliDevMode.fromCoreServices).toHaveBeenCalledTimes(1);
+ expect(MockCliDevMode.fromCoreServices).toHaveBeenCalledWith(
expect.objectContaining({ quiet: true, basePath: true }),
expect.objectContaining({
get: expect.any(Function),
diff --git a/src/core/server/legacy/legacy_service.ts b/src/core/server/legacy/legacy_service.ts
index 4ae6c9d437576..6da5d54869801 100644
--- a/src/core/server/legacy/legacy_service.ts
+++ b/src/core/server/legacy/legacy_service.ts
@@ -145,7 +145,7 @@ export class LegacyService implements CoreService {
// Receive initial config and create kbnServer/ClusterManager.
if (this.coreContext.env.isDevCliParent) {
- await this.createClusterManager(this.legacyRawConfig!);
+ await this.setupCliDevMode(this.legacyRawConfig!);
} else {
this.kbnServer = await this.createKbnServer(
this.settings!,
@@ -170,7 +170,7 @@ export class LegacyService implements CoreService {
}
}
- private async createClusterManager(config: LegacyConfig) {
+ private async setupCliDevMode(config: LegacyConfig) {
const basePathProxy$ = this.coreContext.env.cliArgs.basePath
? combineLatest([this.devConfig$, this.httpConfig$]).pipe(
first(),
@@ -182,8 +182,8 @@ export class LegacyService implements CoreService {
: EMPTY;
// eslint-disable-next-line @typescript-eslint/no-var-requires
- const { ClusterManager } = require('./cluster_manager');
- return new ClusterManager(
+ const { CliDevMode } = require('./cli_dev_mode');
+ CliDevMode.fromCoreServices(
this.coreContext.env.cliArgs,
config,
await basePathProxy$.toPromise()
@@ -310,12 +310,6 @@ export class LegacyService implements CoreService {
logger: this.coreContext.logger,
});
- // Prevent the repl from being started multiple times in different processes.
- if (this.coreContext.env.cliArgs.repl && process.env.isDevCliChild) {
- // eslint-disable-next-line @typescript-eslint/no-var-requires
- require('./cli').startRepl(kbnServer);
- }
-
const { autoListen } = await this.httpConfig$.pipe(first()).toPromise();
if (autoListen) {
diff --git a/src/core/server/saved_objects/serialization/serializer.test.ts b/src/core/server/saved_objects/serialization/serializer.test.ts
index e5f0e8abd3b71..561f9bc001e30 100644
--- a/src/core/server/saved_objects/serialization/serializer.test.ts
+++ b/src/core/server/saved_objects/serialization/serializer.test.ts
@@ -573,24 +573,10 @@ describe('#savedObjectToRaw', () => {
});
describe('single-namespace type without a namespace', () => {
- test('generates an id prefixed with type, if no id is specified', () => {
- const v1 = singleNamespaceSerializer.savedObjectToRaw({
- type: 'foo',
- attributes: { bar: true },
- } as any);
-
- const v2 = singleNamespaceSerializer.savedObjectToRaw({
- type: 'foo',
- attributes: { bar: true },
- } as any);
-
- expect(v1._id).toMatch(/^foo\:[\w-]+$/);
- expect(v1._id).not.toEqual(v2._id);
- });
-
test(`doesn't specify _source.namespace`, () => {
const actual = singleNamespaceSerializer.savedObjectToRaw({
type: '',
+ id: 'mock-saved-object-id',
attributes: {},
} as any);
@@ -599,23 +585,6 @@ describe('#savedObjectToRaw', () => {
});
describe('single-namespace type with a namespace', () => {
- test('generates an id prefixed with namespace and type, if no id is specified', () => {
- const v1 = singleNamespaceSerializer.savedObjectToRaw({
- type: 'foo',
- namespace: 'bar',
- attributes: { bar: true },
- } as any);
-
- const v2 = singleNamespaceSerializer.savedObjectToRaw({
- type: 'foo',
- namespace: 'bar',
- attributes: { bar: true },
- } as any);
-
- expect(v1._id).toMatch(/^bar\:foo\:[\w-]+$/);
- expect(v1._id).not.toEqual(v2._id);
- });
-
test(`it copies namespace to _source.namespace`, () => {
const actual = singleNamespaceSerializer.savedObjectToRaw({
type: 'foo',
@@ -628,23 +597,6 @@ describe('#savedObjectToRaw', () => {
});
describe('single-namespace type with namespaces', () => {
- test('generates an id prefixed with type, if no id is specified', () => {
- const v1 = namespaceAgnosticSerializer.savedObjectToRaw({
- type: 'foo',
- namespaces: ['bar'],
- attributes: { bar: true },
- } as any);
-
- const v2 = namespaceAgnosticSerializer.savedObjectToRaw({
- type: 'foo',
- namespaces: ['bar'],
- attributes: { bar: true },
- } as any);
-
- expect(v1._id).toMatch(/^foo\:[\w-]+$/);
- expect(v1._id).not.toEqual(v2._id);
- });
-
test(`doesn't specify _source.namespaces`, () => {
const actual = namespaceAgnosticSerializer.savedObjectToRaw({
type: 'foo',
@@ -657,23 +609,6 @@ describe('#savedObjectToRaw', () => {
});
describe('namespace-agnostic type with a namespace', () => {
- test('generates an id prefixed with type, if no id is specified', () => {
- const v1 = namespaceAgnosticSerializer.savedObjectToRaw({
- type: 'foo',
- namespace: 'bar',
- attributes: { bar: true },
- } as any);
-
- const v2 = namespaceAgnosticSerializer.savedObjectToRaw({
- type: 'foo',
- namespace: 'bar',
- attributes: { bar: true },
- } as any);
-
- expect(v1._id).toMatch(/^foo\:[\w-]+$/);
- expect(v1._id).not.toEqual(v2._id);
- });
-
test(`doesn't specify _source.namespace`, () => {
const actual = namespaceAgnosticSerializer.savedObjectToRaw({
type: 'foo',
@@ -686,23 +621,6 @@ describe('#savedObjectToRaw', () => {
});
describe('namespace-agnostic type with namespaces', () => {
- test('generates an id prefixed with type, if no id is specified', () => {
- const v1 = namespaceAgnosticSerializer.savedObjectToRaw({
- type: 'foo',
- namespaces: ['bar'],
- attributes: { bar: true },
- } as any);
-
- const v2 = namespaceAgnosticSerializer.savedObjectToRaw({
- type: 'foo',
- namespaces: ['bar'],
- attributes: { bar: true },
- } as any);
-
- expect(v1._id).toMatch(/^foo\:[\w-]+$/);
- expect(v1._id).not.toEqual(v2._id);
- });
-
test(`doesn't specify _source.namespaces`, () => {
const actual = namespaceAgnosticSerializer.savedObjectToRaw({
type: 'foo',
@@ -715,23 +633,6 @@ describe('#savedObjectToRaw', () => {
});
describe('multi-namespace type with a namespace', () => {
- test('generates an id prefixed with type, if no id is specified', () => {
- const v1 = multiNamespaceSerializer.savedObjectToRaw({
- type: 'foo',
- namespace: 'bar',
- attributes: { bar: true },
- } as any);
-
- const v2 = multiNamespaceSerializer.savedObjectToRaw({
- type: 'foo',
- namespace: 'bar',
- attributes: { bar: true },
- } as any);
-
- expect(v1._id).toMatch(/^foo\:[\w-]+$/);
- expect(v1._id).not.toEqual(v2._id);
- });
-
test(`doesn't specify _source.namespace`, () => {
const actual = multiNamespaceSerializer.savedObjectToRaw({
type: 'foo',
@@ -744,23 +645,6 @@ describe('#savedObjectToRaw', () => {
});
describe('multi-namespace type with namespaces', () => {
- test('generates an id prefixed with type, if no id is specified', () => {
- const v1 = multiNamespaceSerializer.savedObjectToRaw({
- type: 'foo',
- namespaces: ['bar'],
- attributes: { bar: true },
- } as any);
-
- const v2 = multiNamespaceSerializer.savedObjectToRaw({
- type: 'foo',
- namespaces: ['bar'],
- attributes: { bar: true },
- } as any);
-
- expect(v1._id).toMatch(/^foo\:[\w-]+$/);
- expect(v1._id).not.toEqual(v2._id);
- });
-
test(`it copies namespaces to _source.namespaces`, () => {
const actual = multiNamespaceSerializer.savedObjectToRaw({
type: 'foo',
@@ -1064,11 +948,6 @@ describe('#isRawSavedObject', () => {
describe('#generateRawId', () => {
describe('single-namespace type without a namespace', () => {
- test('generates an id if none is specified', () => {
- const id = singleNamespaceSerializer.generateRawId('', 'goodbye');
- expect(id).toMatch(/^goodbye\:[\w-]+$/);
- });
-
test('uses the id that is specified', () => {
const id = singleNamespaceSerializer.generateRawId('', 'hello', 'world');
expect(id).toEqual('hello:world');
@@ -1076,11 +955,6 @@ describe('#generateRawId', () => {
});
describe('single-namespace type with a namespace', () => {
- test('generates an id if none is specified and prefixes namespace', () => {
- const id = singleNamespaceSerializer.generateRawId('foo', 'goodbye');
- expect(id).toMatch(/^foo:goodbye\:[\w-]+$/);
- });
-
test('uses the id that is specified and prefixes the namespace', () => {
const id = singleNamespaceSerializer.generateRawId('foo', 'hello', 'world');
expect(id).toEqual('foo:hello:world');
@@ -1088,11 +962,6 @@ describe('#generateRawId', () => {
});
describe('namespace-agnostic type with a namespace', () => {
- test(`generates an id if none is specified and doesn't prefix namespace`, () => {
- const id = namespaceAgnosticSerializer.generateRawId('foo', 'goodbye');
- expect(id).toMatch(/^goodbye\:[\w-]+$/);
- });
-
test(`uses the id that is specified and doesn't prefix the namespace`, () => {
const id = namespaceAgnosticSerializer.generateRawId('foo', 'hello', 'world');
expect(id).toEqual('hello:world');
diff --git a/src/core/server/saved_objects/serialization/serializer.ts b/src/core/server/saved_objects/serialization/serializer.ts
index 145dd286c1ca8..82999eeceb887 100644
--- a/src/core/server/saved_objects/serialization/serializer.ts
+++ b/src/core/server/saved_objects/serialization/serializer.ts
@@ -17,7 +17,6 @@
* under the License.
*/
-import uuid from 'uuid';
import { decodeVersion, encodeVersion } from '../version';
import { ISavedObjectTypeRegistry } from '../saved_objects_type_registry';
import { SavedObjectsRawDoc, SavedObjectSanitizedDoc } from './types';
@@ -127,10 +126,10 @@ export class SavedObjectsSerializer {
* @param {string} type - The saved object type
* @param {string} id - The id of the saved object
*/
- public generateRawId(namespace: string | undefined, type: string, id?: string) {
+ public generateRawId(namespace: string | undefined, type: string, id: string) {
const namespacePrefix =
namespace && this.registry.isSingleNamespace(type) ? `${namespace}:` : '';
- return `${namespacePrefix}${type}:${id || uuid.v1()}`;
+ return `${namespacePrefix}${type}:${id}`;
}
private trimIdPrefix(namespace: string | undefined, type: string, id: string) {
diff --git a/src/core/server/saved_objects/serialization/types.ts b/src/core/server/saved_objects/serialization/types.ts
index 8b3eebceb2c5a..e59b1a68e1ad1 100644
--- a/src/core/server/saved_objects/serialization/types.ts
+++ b/src/core/server/saved_objects/serialization/types.ts
@@ -50,7 +50,7 @@ export interface SavedObjectsRawDocSource {
*/
interface SavedObjectDoc {
attributes: T;
- id?: string; // NOTE: SavedObjectDoc is used for uncreated objects where `id` is optional
+ id: string;
type: string;
namespace?: string;
namespaces?: string[];
diff --git a/src/core/server/saved_objects/service/lib/repository.test.js b/src/core/server/saved_objects/service/lib/repository.test.js
index 6a3defb9556f5..a19b4cc01db8e 100644
--- a/src/core/server/saved_objects/service/lib/repository.test.js
+++ b/src/core/server/saved_objects/service/lib/repository.test.js
@@ -1831,21 +1831,16 @@ describe('SavedObjectsRepository', () => {
};
describe('client calls', () => {
- it(`should use the ES create action if ID is undefined and overwrite=true`, async () => {
+ it(`should use the ES index action if overwrite=true`, async () => {
await createSuccess(type, attributes, { overwrite: true });
- expect(client.create).toHaveBeenCalled();
+ expect(client.index).toHaveBeenCalled();
});
- it(`should use the ES create action if ID is undefined and overwrite=false`, async () => {
+ it(`should use the ES create action if overwrite=false`, async () => {
await createSuccess(type, attributes);
expect(client.create).toHaveBeenCalled();
});
- it(`should use the ES index action if ID is defined and overwrite=true`, async () => {
- await createSuccess(type, attributes, { id, overwrite: true });
- expect(client.index).toHaveBeenCalled();
- });
-
it(`should use the ES index with version if ID and version are defined and overwrite=true`, async () => {
await createSuccess(type, attributes, { id, overwrite: true, version: mockVersion });
expect(client.index).toHaveBeenCalled();
diff --git a/src/core/server/saved_objects/service/lib/repository.ts b/src/core/server/saved_objects/service/lib/repository.ts
index dae6a8d19dae2..587a0e51ef9b9 100644
--- a/src/core/server/saved_objects/service/lib/repository.ts
+++ b/src/core/server/saved_objects/service/lib/repository.ts
@@ -18,7 +18,6 @@
*/
import { omit, isObject } from 'lodash';
-import uuid from 'uuid';
import {
ElasticsearchClient,
DeleteDocumentResponse,
@@ -245,7 +244,7 @@ export class SavedObjectsRepository {
options: SavedObjectsCreateOptions = {}
): Promise> {
const {
- id,
+ id = SavedObjectsUtils.generateId(),
migrationVersion,
overwrite = false,
references = [],
@@ -366,7 +365,9 @@ export class SavedObjectsRepository {
const method = object.id && overwrite ? 'index' : 'create';
const requiresNamespacesCheck = object.id && this._registry.isMultiNamespace(object.type);
- if (object.id == null) object.id = uuid.v1();
+ if (object.id == null) {
+ object.id = SavedObjectsUtils.generateId();
+ }
return {
tag: 'Right' as 'Right',
diff --git a/src/core/server/saved_objects/service/lib/utils.test.ts b/src/core/server/saved_objects/service/lib/utils.test.ts
index ac06ca9275783..062a68e2dca28 100644
--- a/src/core/server/saved_objects/service/lib/utils.test.ts
+++ b/src/core/server/saved_objects/service/lib/utils.test.ts
@@ -17,11 +17,22 @@
* under the License.
*/
+import uuid from 'uuid';
import { SavedObjectsFindOptions } from '../../types';
import { SavedObjectsUtils } from './utils';
+jest.mock('uuid', () => ({
+ v1: jest.fn().mockReturnValue('mock-uuid'),
+}));
+
describe('SavedObjectsUtils', () => {
- const { namespaceIdToString, namespaceStringToId, createEmptyFindResponse } = SavedObjectsUtils;
+ const {
+ namespaceIdToString,
+ namespaceStringToId,
+ createEmptyFindResponse,
+ generateId,
+ isRandomId,
+ } = SavedObjectsUtils;
describe('#namespaceIdToString', () => {
it('converts `undefined` to default namespace string', () => {
@@ -77,4 +88,20 @@ describe('SavedObjectsUtils', () => {
expect(createEmptyFindResponse(options).per_page).toEqual(42);
});
});
+
+ describe('#generateId', () => {
+ it('returns a valid uuid', () => {
+ expect(generateId()).toBe('mock-uuid');
+ expect(uuid.v1).toHaveBeenCalled();
+ });
+ });
+
+ describe('#isRandomId', () => {
+ it('validates uuid correctly', () => {
+ expect(isRandomId('c4d82f66-3046-11eb-adc1-0242ac120002')).toBe(true);
+ expect(isRandomId('invalid')).toBe(false);
+ expect(isRandomId('')).toBe(false);
+ expect(isRandomId(undefined)).toBe(false);
+ });
+ });
});
diff --git a/src/core/server/saved_objects/service/lib/utils.ts b/src/core/server/saved_objects/service/lib/utils.ts
index 69abc37089218..b59829cb4978a 100644
--- a/src/core/server/saved_objects/service/lib/utils.ts
+++ b/src/core/server/saved_objects/service/lib/utils.ts
@@ -17,6 +17,7 @@
* under the License.
*/
+import uuid from 'uuid';
import { SavedObjectsFindOptions } from '../../types';
import { SavedObjectsFindResponse } from '..';
@@ -24,6 +25,7 @@ export const DEFAULT_NAMESPACE_STRING = 'default';
export const ALL_NAMESPACES_STRING = '*';
export const FIND_DEFAULT_PAGE = 1;
export const FIND_DEFAULT_PER_PAGE = 20;
+const UUID_REGEX = /^(?:[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}|00000000-0000-0000-0000-000000000000)$/i;
/**
* @public
@@ -69,4 +71,21 @@ export class SavedObjectsUtils {
total: 0,
saved_objects: [],
});
+
+ /**
+ * Generates a random ID for a saved objects.
+ */
+ public static generateId() {
+ return uuid.v1();
+ }
+
+ /**
+ * Validates that a saved object ID has been randomly generated.
+ *
+ * @param {string} id The ID of a saved object.
+ * @todo Use `uuid.validate` once upgraded to v5.3+
+ */
+ public static isRandomId(id: string | undefined) {
+ return typeof id === 'string' && UUID_REGEX.test(id);
+ }
}
diff --git a/src/core/server/server.api.md b/src/core/server/server.api.md
index d877fc36d114b..770048d2cff13 100644
--- a/src/core/server/server.api.md
+++ b/src/core/server/server.api.md
@@ -2518,7 +2518,7 @@ export interface SavedObjectsResolveImportErrorsOptions {
export class SavedObjectsSerializer {
// @internal
constructor(registry: ISavedObjectTypeRegistry);
- generateRawId(namespace: string | undefined, type: string, id?: string): string;
+ generateRawId(namespace: string | undefined, type: string, id: string): string;
isRawSavedObject(rawDoc: SavedObjectsRawDoc): boolean;
rawToSavedObject(doc: SavedObjectsRawDoc): SavedObjectSanitizedDoc;
savedObjectToRaw(savedObj: SavedObjectSanitizedDoc): SavedObjectsRawDoc;
@@ -2600,6 +2600,8 @@ export interface SavedObjectsUpdateResponse extends Omit({ page, perPage, }: SavedObjectsFindOptions) => SavedObjectsFindResponse;
+ static generateId(): string;
+ static isRandomId(id: string | undefined): boolean;
static namespaceIdToString: (namespace?: string | undefined) => string;
static namespaceStringToId: (namespace: string) => string | undefined;
}
diff --git a/src/core/test_helpers/kbn_server.ts b/src/core/test_helpers/kbn_server.ts
index 3161420b94d22..4ff845596f741 100644
--- a/src/core/test_helpers/kbn_server.ts
+++ b/src/core/test_helpers/kbn_server.ts
@@ -73,7 +73,6 @@ export function createRootWithSettings(
quiet: false,
silent: false,
watch: false,
- repl: false,
basePath: false,
runExamples: false,
oss: true,
diff --git a/src/dev/build/tasks/copy_source_task.ts b/src/dev/build/tasks/copy_source_task.ts
index b0ace3c63d82e..710e504e58868 100644
--- a/src/dev/build/tasks/copy_source_task.ts
+++ b/src/dev/build/tasks/copy_source_task.ts
@@ -33,7 +33,6 @@ export const CopySource: Task = {
'!src/**/{target,__tests__,__snapshots__,__mocks__}/**',
'!src/test_utils/**',
'!src/fixtures/**',
- '!src/cli/cluster/**',
'!src/cli/repl/**',
'!src/cli/dev.js',
'!src/functional_test_runner/**',
diff --git a/src/dev/build/tasks/os_packages/create_os_package_tasks.ts b/src/dev/build/tasks/os_packages/create_os_package_tasks.ts
index 4580b95423d3d..0e554162bca86 100644
--- a/src/dev/build/tasks/os_packages/create_os_package_tasks.ts
+++ b/src/dev/build/tasks/os_packages/create_os_package_tasks.ts
@@ -25,12 +25,19 @@ export const CreateDebPackage: Task = {
description: 'Creating deb package',
async run(config, log, build) {
- await runFpm(config, log, build, 'deb', [
+ await runFpm(config, log, build, 'deb', 'x64', [
'--architecture',
'amd64',
'--deb-priority',
'optional',
]);
+
+ await runFpm(config, log, build, 'deb', 'arm64', [
+ '--architecture',
+ 'arm64',
+ '--deb-priority',
+ 'optional',
+ ]);
},
};
@@ -38,7 +45,18 @@ export const CreateRpmPackage: Task = {
description: 'Creating rpm package',
async run(config, log, build) {
- await runFpm(config, log, build, 'rpm', ['--architecture', 'x86_64', '--rpm-os', 'linux']);
+ await runFpm(config, log, build, 'rpm', 'x64', [
+ '--architecture',
+ 'x86_64',
+ '--rpm-os',
+ 'linux',
+ ]);
+ await runFpm(config, log, build, 'rpm', 'arm64', [
+ '--architecture',
+ 'aarch64',
+ '--rpm-os',
+ 'linux',
+ ]);
},
};
diff --git a/src/dev/build/tasks/os_packages/run_fpm.ts b/src/dev/build/tasks/os_packages/run_fpm.ts
index def0289f53641..15606e40259c6 100644
--- a/src/dev/build/tasks/os_packages/run_fpm.ts
+++ b/src/dev/build/tasks/os_packages/run_fpm.ts
@@ -28,9 +28,10 @@ export async function runFpm(
log: ToolingLog,
build: Build,
type: 'rpm' | 'deb',
+ architecture: 'arm64' | 'x64',
pkgSpecificFlags: string[]
) {
- const linux = config.getPlatform('linux', 'x64');
+ const linux = config.getPlatform('linux', architecture);
const version = config.getBuildVersion();
const resolveWithTrailingSlash = (...paths: string[]) => `${resolve(...paths)}/`;
diff --git a/src/dev/cli_dev_mode/README.md b/src/dev/cli_dev_mode/README.md
new file mode 100644
index 0000000000000..397017027a52f
--- /dev/null
+++ b/src/dev/cli_dev_mode/README.md
@@ -0,0 +1,33 @@
+# `CliDevMode`
+
+A class that manages the alternate behavior of the Kibana cli when using the `--dev` flag. This mode provides several useful features in a single CLI for a nice developer experience:
+
+ - automatic server restarts when code changes
+ - runs the `@kbn/optimizer` to build browser bundles
+ - runs a base path proxy which helps developers test that they are writing code which is compatible with custom basePath settings while they work
+ - pauses requests when the server or optimizer are not ready to handle requests so that when users load Kibana in the browser it's always using the code as it exists on disk
+
+To accomplish this, and to make it easier to test, the `CliDevMode` class manages several objects:
+
+## `Watcher`
+
+The `Watcher` manages a [chokidar](https://github.com/paulmillr/chokidar) instance to watch the server files, logs about file changes observed and provides an observable to the `DevServer` via its `serverShouldRestart$()` method.
+
+## `DevServer`
+
+The `DevServer` object is responsible for everything related to running and restarting the Kibana server process:
+ - listens to restart notifications from the `Watcher` object, sending `SIGKILL` to the existing server and launching a new instance with the current code
+ - writes the stdout/stderr logs from the Kibana server to the parent process
+ - gracefully kills the process if the SIGINT signal is sent
+ - kills the server if the SIGTERM signal is sent, process.exit() is used, a second SIGINT is sent, or the gracefull shutdown times out
+ - proxies SIGHUP notifications to the child process, though the core team is working on migrating this functionality to the KP and making this unnecessary
+
+## `Optimizer`
+
+The `Optimizer` object manages a `@kbn/optimizer` instance, adapting its configuration and logging to the data available to the CLI.
+
+## `BasePathProxyServer` (currently passed from core)
+
+The `BasePathProxyServer` is passed to the `CliDevMode` from core when the dev mode is trigged by the `--dev` flag. This proxy injects a random three character base path in the URL that Kibana is served from to help ensure that Kibana features are written to adapt to custom base path configurations from users.
+
+The basePathProxy also has another important job, ensuring that requests don't fail because the server is restarting and that the browser receives front-end assets containing all saved changes. We accomplish this by observing the ready state of the `Optimizer` and `DevServer` objects and pausing all requests through the proxy until both objects report that they aren't building/restarting based on recently saved changes.
\ No newline at end of file
diff --git a/src/dev/cli_dev_mode/cli_dev_mode.test.ts b/src/dev/cli_dev_mode/cli_dev_mode.test.ts
new file mode 100644
index 0000000000000..b86100d161bd3
--- /dev/null
+++ b/src/dev/cli_dev_mode/cli_dev_mode.test.ts
@@ -0,0 +1,403 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import Path from 'path';
+
+import {
+ REPO_ROOT,
+ createAbsolutePathSerializer,
+ createAnyInstanceSerializer,
+} from '@kbn/dev-utils';
+import * as Rx from 'rxjs';
+
+import { TestLog } from './log';
+import { CliDevMode } from './cli_dev_mode';
+
+expect.addSnapshotSerializer(createAbsolutePathSerializer());
+expect.addSnapshotSerializer(createAnyInstanceSerializer(Rx.Observable, 'Rx.Observable'));
+expect.addSnapshotSerializer(createAnyInstanceSerializer(TestLog));
+
+jest.mock('./watcher');
+const { Watcher } = jest.requireMock('./watcher');
+
+jest.mock('./optimizer');
+const { Optimizer } = jest.requireMock('./optimizer');
+
+jest.mock('./dev_server');
+const { DevServer } = jest.requireMock('./dev_server');
+
+jest.mock('./get_server_watch_paths', () => ({
+ getServerWatchPaths: jest.fn(() => ({
+ watchPaths: [''],
+ ignorePaths: [''],
+ })),
+}));
+
+beforeEach(() => {
+ process.argv = ['node', './script', 'foo', 'bar', 'baz'];
+ jest.clearAllMocks();
+});
+
+const log = new TestLog();
+
+const mockBasePathProxy = {
+ targetPort: 9999,
+ basePath: '/foo/bar',
+ start: jest.fn(),
+ stop: jest.fn(),
+};
+
+const defaultOptions = {
+ cache: true,
+ disableOptimizer: false,
+ dist: true,
+ oss: true,
+ pluginPaths: [],
+ pluginScanDirs: [Path.resolve(REPO_ROOT, 'src/plugins')],
+ quiet: false,
+ silent: false,
+ runExamples: false,
+ watch: true,
+ log,
+};
+
+afterEach(() => {
+ log.messages.length = 0;
+});
+
+it('passes correct args to sub-classes', () => {
+ new CliDevMode(defaultOptions);
+
+ expect(DevServer.mock.calls).toMatchInlineSnapshot(`
+ Array [
+ Array [
+ Object {
+ "argv": Array [
+ "foo",
+ "bar",
+ "baz",
+ ],
+ "gracefulTimeout": 5000,
+ "log": ,
+ "script": /scripts/kibana,
+ "watcher": Watcher {
+ "serverShouldRestart$": [MockFunction],
+ },
+ },
+ ],
+ ]
+ `);
+ expect(Optimizer.mock.calls).toMatchInlineSnapshot(`
+ Array [
+ Array [
+ Object {
+ "cache": true,
+ "dist": true,
+ "enabled": true,
+ "oss": true,
+ "pluginPaths": Array [],
+ "quiet": false,
+ "repoRoot": ,
+ "runExamples": false,
+ "silent": false,
+ "watch": true,
+ },
+ ],
+ ]
+ `);
+ expect(Watcher.mock.calls).toMatchInlineSnapshot(`
+ Array [
+ Array [
+ Object {
+ "cwd": ,
+ "enabled": true,
+ "ignore": Array [
+ "",
+ ],
+ "log": ,
+ "paths": Array [
+ "",
+ ],
+ },
+ ],
+ ]
+ `);
+ expect(log.messages).toMatchInlineSnapshot(`Array []`);
+});
+
+it('disables the optimizer', () => {
+ new CliDevMode({
+ ...defaultOptions,
+ disableOptimizer: true,
+ });
+
+ expect(Optimizer.mock.calls[0][0]).toHaveProperty('enabled', false);
+});
+
+it('disables the watcher', () => {
+ new CliDevMode({
+ ...defaultOptions,
+ watch: false,
+ });
+
+ expect(Optimizer.mock.calls[0][0]).toHaveProperty('watch', false);
+ expect(Watcher.mock.calls[0][0]).toHaveProperty('enabled', false);
+});
+
+it('overrides the basePath of the server when basePathProxy is defined', () => {
+ new CliDevMode({
+ ...defaultOptions,
+ basePathProxy: mockBasePathProxy as any,
+ });
+
+ expect(DevServer.mock.calls[0][0].argv).toMatchInlineSnapshot(`
+ Array [
+ "foo",
+ "bar",
+ "baz",
+ "--server.port=9999",
+ "--server.basePath=/foo/bar",
+ "--server.rewriteBasePath=true",
+ ]
+ `);
+});
+
+describe('#start()/#stop()', () => {
+ let optimizerRun$: Rx.Subject;
+ let optimizerReady$: Rx.Subject;
+ let watcherRun$: Rx.Subject;
+ let devServerRun$: Rx.Subject;
+ let devServerReady$: Rx.Subject;
+ let processExitMock: jest.SpyInstance;
+
+ beforeAll(() => {
+ processExitMock = jest.spyOn(process, 'exit').mockImplementation(
+ // @ts-expect-error process.exit isn't supposed to return
+ () => {}
+ );
+ });
+
+ beforeEach(() => {
+ Optimizer.mockImplementation(() => {
+ optimizerRun$ = new Rx.Subject();
+ optimizerReady$ = new Rx.Subject();
+ return {
+ isReady$: jest.fn(() => optimizerReady$),
+ run$: optimizerRun$,
+ };
+ });
+ Watcher.mockImplementation(() => {
+ watcherRun$ = new Rx.Subject();
+ return {
+ run$: watcherRun$,
+ };
+ });
+ DevServer.mockImplementation(() => {
+ devServerRun$ = new Rx.Subject();
+ devServerReady$ = new Rx.Subject();
+ return {
+ isReady$: jest.fn(() => devServerReady$),
+ run$: devServerRun$,
+ };
+ });
+ });
+
+ afterEach(() => {
+ Optimizer.mockReset();
+ Watcher.mockReset();
+ DevServer.mockReset();
+ });
+
+ afterAll(() => {
+ processExitMock.mockRestore();
+ });
+
+ it('logs a warning if basePathProxy is not passed', () => {
+ new CliDevMode({
+ ...defaultOptions,
+ }).start();
+
+ expect(log.messages).toMatchInlineSnapshot(`
+ Array [
+ Object {
+ "args": Array [
+ "no-base-path",
+ "====================================================================================================",
+ ],
+ "type": "warn",
+ },
+ Object {
+ "args": Array [
+ "no-base-path",
+ "Running Kibana in dev mode with --no-base-path disables several useful features and is not recommended",
+ ],
+ "type": "warn",
+ },
+ Object {
+ "args": Array [
+ "no-base-path",
+ "====================================================================================================",
+ ],
+ "type": "warn",
+ },
+ ]
+ `);
+ });
+
+ it('calls start on BasePathProxy if enabled', () => {
+ const basePathProxy: any = {
+ start: jest.fn(),
+ };
+
+ new CliDevMode({
+ ...defaultOptions,
+ basePathProxy,
+ }).start();
+
+ expect(basePathProxy.start.mock.calls).toMatchInlineSnapshot(`
+ Array [
+ Array [
+ Object {
+ "delayUntil": [Function],
+ "shouldRedirectFromOldBasePath": [Function],
+ },
+ ],
+ ]
+ `);
+ });
+
+ it('subscribes to Optimizer#run$, Watcher#run$, and DevServer#run$', () => {
+ new CliDevMode(defaultOptions).start();
+
+ expect(optimizerRun$.observers).toHaveLength(1);
+ expect(watcherRun$.observers).toHaveLength(1);
+ expect(devServerRun$.observers).toHaveLength(1);
+ });
+
+ it('logs an error and exits the process if Optimizer#run$ errors', () => {
+ new CliDevMode({
+ ...defaultOptions,
+ basePathProxy: mockBasePathProxy as any,
+ }).start();
+
+ expect(processExitMock).not.toHaveBeenCalled();
+ optimizerRun$.error({ stack: 'Error: foo bar' });
+ expect(log.messages).toMatchInlineSnapshot(`
+ Array [
+ Object {
+ "args": Array [
+ "[@kbn/optimizer] fatal error",
+ "Error: foo bar",
+ ],
+ "type": "bad",
+ },
+ ]
+ `);
+ expect(processExitMock.mock.calls).toMatchInlineSnapshot(`
+ Array [
+ Array [
+ 1,
+ ],
+ ]
+ `);
+ });
+
+ it('logs an error and exits the process if Watcher#run$ errors', () => {
+ new CliDevMode({
+ ...defaultOptions,
+ basePathProxy: mockBasePathProxy as any,
+ }).start();
+
+ expect(processExitMock).not.toHaveBeenCalled();
+ watcherRun$.error({ stack: 'Error: foo bar' });
+ expect(log.messages).toMatchInlineSnapshot(`
+ Array [
+ Object {
+ "args": Array [
+ "[watcher] fatal error",
+ "Error: foo bar",
+ ],
+ "type": "bad",
+ },
+ ]
+ `);
+ expect(processExitMock.mock.calls).toMatchInlineSnapshot(`
+ Array [
+ Array [
+ 1,
+ ],
+ ]
+ `);
+ });
+
+ it('logs an error and exits the process if DevServer#run$ errors', () => {
+ new CliDevMode({
+ ...defaultOptions,
+ basePathProxy: mockBasePathProxy as any,
+ }).start();
+
+ expect(processExitMock).not.toHaveBeenCalled();
+ devServerRun$.error({ stack: 'Error: foo bar' });
+ expect(log.messages).toMatchInlineSnapshot(`
+ Array [
+ Object {
+ "args": Array [
+ "[dev server] fatal error",
+ "Error: foo bar",
+ ],
+ "type": "bad",
+ },
+ ]
+ `);
+ expect(processExitMock.mock.calls).toMatchInlineSnapshot(`
+ Array [
+ Array [
+ 1,
+ ],
+ ]
+ `);
+ });
+
+ it('throws if start() has already been called', () => {
+ expect(() => {
+ const devMode = new CliDevMode({
+ ...defaultOptions,
+ basePathProxy: mockBasePathProxy as any,
+ });
+
+ devMode.start();
+ devMode.start();
+ }).toThrowErrorMatchingInlineSnapshot(`"CliDevMode already started"`);
+ });
+
+ it('unsubscribes from all observables and stops basePathProxy when stopped', () => {
+ const devMode = new CliDevMode({
+ ...defaultOptions,
+ basePathProxy: mockBasePathProxy as any,
+ });
+
+ devMode.start();
+ devMode.stop();
+
+ expect(optimizerRun$.observers).toHaveLength(0);
+ expect(watcherRun$.observers).toHaveLength(0);
+ expect(devServerRun$.observers).toHaveLength(0);
+ expect(mockBasePathProxy.stop).toHaveBeenCalledTimes(1);
+ });
+});
diff --git a/src/dev/cli_dev_mode/cli_dev_mode.ts b/src/dev/cli_dev_mode/cli_dev_mode.ts
new file mode 100644
index 0000000000000..3cb97b08b75c2
--- /dev/null
+++ b/src/dev/cli_dev_mode/cli_dev_mode.ts
@@ -0,0 +1,214 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import Path from 'path';
+
+import { REPO_ROOT } from '@kbn/dev-utils';
+import * as Rx from 'rxjs';
+import { mapTo, filter, take } from 'rxjs/operators';
+
+import { CliArgs } from '../../core/server/config';
+import { LegacyConfig } from '../../core/server/legacy';
+import { BasePathProxyServer } from '../../core/server/http';
+
+import { Log, CliLog } from './log';
+import { Optimizer } from './optimizer';
+import { DevServer } from './dev_server';
+import { Watcher } from './watcher';
+import { shouldRedirectFromOldBasePath } from './should_redirect_from_old_base_path';
+import { getServerWatchPaths } from './get_server_watch_paths';
+
+// timeout where the server is allowed to exit gracefully
+const GRACEFUL_TIMEOUT = 5000;
+
+export type SomeCliArgs = Pick<
+ CliArgs,
+ 'quiet' | 'silent' | 'disableOptimizer' | 'watch' | 'oss' | 'runExamples' | 'cache' | 'dist'
+>;
+
+export interface CliDevModeOptions {
+ basePathProxy?: BasePathProxyServer;
+ log?: Log;
+
+ // cli flags
+ dist: boolean;
+ oss: boolean;
+ runExamples: boolean;
+ pluginPaths: string[];
+ pluginScanDirs: string[];
+ disableOptimizer: boolean;
+ quiet: boolean;
+ silent: boolean;
+ watch: boolean;
+ cache: boolean;
+}
+
+const firstAllTrue = (...sources: Array>) =>
+ Rx.combineLatest(sources).pipe(
+ filter((values) => values.every((v) => v === true)),
+ take(1),
+ mapTo(undefined)
+ );
+
+/**
+ * setup and manage the parent process of the dev server:
+ *
+ * - runs the Kibana server in a child process
+ * - watches for changes to the server source code, restart the server on changes.
+ * - run the kbn/optimizer
+ * - run the basePathProxy
+ * - delay requests received by the basePathProxy when either the server isn't ready
+ * or the kbn/optimizer isn't ready
+ *
+ */
+export class CliDevMode {
+ static fromCoreServices(
+ cliArgs: SomeCliArgs,
+ config: LegacyConfig,
+ basePathProxy?: BasePathProxyServer
+ ) {
+ new CliDevMode({
+ quiet: !!cliArgs.quiet,
+ silent: !!cliArgs.silent,
+ cache: !!cliArgs.cache,
+ disableOptimizer: !!cliArgs.disableOptimizer,
+ dist: !!cliArgs.dist,
+ oss: !!cliArgs.oss,
+ runExamples: !!cliArgs.runExamples,
+ pluginPaths: config.get('plugins.paths'),
+ pluginScanDirs: config.get('plugins.scanDirs'),
+ watch: !!cliArgs.watch,
+ basePathProxy,
+ }).start();
+ }
+ private readonly log: Log;
+ private readonly basePathProxy?: BasePathProxyServer;
+ private readonly watcher: Watcher;
+ private readonly devServer: DevServer;
+ private readonly optimizer: Optimizer;
+
+ private subscription?: Rx.Subscription;
+
+ constructor(options: CliDevModeOptions) {
+ this.basePathProxy = options.basePathProxy;
+ this.log = options.log || new CliLog(!!options.quiet, !!options.silent);
+
+ const { watchPaths, ignorePaths } = getServerWatchPaths({
+ pluginPaths: options.pluginPaths ?? [],
+ pluginScanDirs: [
+ ...(options.pluginScanDirs ?? []),
+ Path.resolve(REPO_ROOT, 'src/plugins'),
+ Path.resolve(REPO_ROOT, 'x-pack/plugins'),
+ ],
+ });
+
+ this.watcher = new Watcher({
+ enabled: !!options.watch,
+ log: this.log,
+ cwd: REPO_ROOT,
+ paths: watchPaths,
+ ignore: ignorePaths,
+ });
+
+ this.devServer = new DevServer({
+ log: this.log,
+ watcher: this.watcher,
+ gracefulTimeout: GRACEFUL_TIMEOUT,
+
+ script: Path.resolve(REPO_ROOT, 'scripts/kibana'),
+ argv: [
+ ...process.argv.slice(2).filter((v) => v !== '--no-watch'),
+ ...(options.basePathProxy
+ ? [
+ `--server.port=${options.basePathProxy.targetPort}`,
+ `--server.basePath=${options.basePathProxy.basePath}`,
+ '--server.rewriteBasePath=true',
+ ]
+ : []),
+ ],
+ });
+
+ this.optimizer = new Optimizer({
+ enabled: !options.disableOptimizer,
+ repoRoot: REPO_ROOT,
+ oss: options.oss,
+ pluginPaths: options.pluginPaths,
+ runExamples: options.runExamples,
+ cache: options.cache,
+ dist: options.dist,
+ quiet: options.quiet,
+ silent: options.silent,
+ watch: options.watch,
+ });
+ }
+
+ public start() {
+ const { basePathProxy } = this;
+
+ if (this.subscription) {
+ throw new Error('CliDevMode already started');
+ }
+
+ this.subscription = new Rx.Subscription();
+
+ if (basePathProxy) {
+ const delay$ = firstAllTrue(this.devServer.isReady$(), this.optimizer.isReady$());
+
+ basePathProxy.start({
+ delayUntil: () => delay$,
+ shouldRedirectFromOldBasePath,
+ });
+
+ this.subscription.add(() => basePathProxy.stop());
+ } else {
+ this.log.warn('no-base-path', '='.repeat(100));
+ this.log.warn(
+ 'no-base-path',
+ 'Running Kibana in dev mode with --no-base-path disables several useful features and is not recommended'
+ );
+ this.log.warn('no-base-path', '='.repeat(100));
+ }
+
+ this.subscription.add(this.optimizer.run$.subscribe(this.observer('@kbn/optimizer')));
+ this.subscription.add(this.watcher.run$.subscribe(this.observer('watcher')));
+ this.subscription.add(this.devServer.run$.subscribe(this.observer('dev server')));
+ }
+
+ public stop() {
+ if (!this.subscription) {
+ throw new Error('CliDevMode has not been started');
+ }
+
+ this.subscription.unsubscribe();
+ this.subscription = undefined;
+ }
+
+ private observer = (title: string): Rx.Observer => ({
+ next: () => {
+ // noop
+ },
+ error: (error) => {
+ this.log.bad(`[${title}] fatal error`, error.stack);
+ process.exit(1);
+ },
+ complete: () => {
+ // noop
+ },
+ });
+}
diff --git a/src/dev/cli_dev_mode/dev_server.test.ts b/src/dev/cli_dev_mode/dev_server.test.ts
new file mode 100644
index 0000000000000..792125f4f85b1
--- /dev/null
+++ b/src/dev/cli_dev_mode/dev_server.test.ts
@@ -0,0 +1,319 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { EventEmitter } from 'events';
+import { PassThrough } from 'stream';
+
+import * as Rx from 'rxjs';
+
+import { extendedEnvSerializer } from './test_helpers';
+import { DevServer, Options } from './dev_server';
+import { TestLog } from './log';
+
+class MockProc extends EventEmitter {
+ public readonly signalsSent: string[] = [];
+
+ stdout = new PassThrough();
+ stderr = new PassThrough();
+
+ kill = jest.fn((signal) => {
+ this.signalsSent.push(signal);
+ });
+
+ mockExit(code: number) {
+ this.emit('exit', code, undefined);
+ // close stdio streams
+ this.stderr.end();
+ this.stdout.end();
+ }
+
+ mockListening() {
+ this.emit('message', ['SERVER_LISTENING'], undefined);
+ }
+}
+
+jest.mock('execa');
+const execa = jest.requireMock('execa');
+
+let currentProc: MockProc | undefined;
+execa.node.mockImplementation(() => {
+ const proc = new MockProc();
+ currentProc = proc;
+ return proc;
+});
+function isProc(proc: MockProc | undefined): asserts proc is MockProc {
+ expect(proc).toBeInstanceOf(MockProc);
+}
+
+const restart$ = new Rx.Subject();
+const mockWatcher = {
+ enabled: true,
+ serverShouldRestart$: jest.fn(() => restart$),
+};
+
+const processExit$ = new Rx.Subject();
+const sigint$ = new Rx.Subject();
+const sigterm$ = new Rx.Subject();
+
+const log = new TestLog();
+const defaultOptions: Options = {
+ log,
+ watcher: mockWatcher as any,
+ script: 'some/script',
+ argv: ['foo', 'bar'],
+ gracefulTimeout: 100,
+ processExit$,
+ sigint$,
+ sigterm$,
+};
+
+expect.addSnapshotSerializer(extendedEnvSerializer);
+
+beforeEach(() => {
+ jest.clearAllMocks();
+ log.messages.length = 0;
+ currentProc = undefined;
+});
+
+const subscriptions: Rx.Subscription[] = [];
+const run = (server: DevServer) => {
+ const subscription = server.run$.subscribe({
+ error(e) {
+ throw e;
+ },
+ });
+ subscriptions.push(subscription);
+ return subscription;
+};
+
+afterEach(() => {
+ if (currentProc) {
+ currentProc.removeAllListeners();
+ currentProc = undefined;
+ }
+
+ for (const sub of subscriptions) {
+ sub.unsubscribe();
+ }
+ subscriptions.length = 0;
+});
+
+describe('#run$', () => {
+ it('starts the dev server with the right options', () => {
+ run(new DevServer(defaultOptions)).unsubscribe();
+
+ expect(execa.node.mock.calls).toMatchInlineSnapshot(`
+ Array [
+ Array [
+ "some/script",
+ Array [
+ "foo",
+ "bar",
+ "--logging.json=false",
+ ],
+ Object {
+ "env": Object {
+ "": true,
+ "ELASTIC_APM_SERVICE_NAME": "kibana",
+ "isDevCliChild": "true",
+ },
+ "nodeOptions": Array [],
+ "stdio": "pipe",
+ },
+ ],
+ ]
+ `);
+ });
+
+ it('writes stdout and stderr lines to logger', () => {
+ run(new DevServer(defaultOptions));
+ isProc(currentProc);
+
+ currentProc.stdout.write('hello ');
+ currentProc.stderr.write('something ');
+ currentProc.stdout.write('world\n');
+ currentProc.stderr.write('went wrong\n');
+ expect(log.messages).toMatchInlineSnapshot(`
+ Array [
+ Object {
+ "args": Array [
+ "hello world",
+ ],
+ "type": "write",
+ },
+ Object {
+ "args": Array [
+ "something went wrong",
+ ],
+ "type": "write",
+ },
+ ]
+ `);
+ });
+
+ it('is ready when message sends SERVER_LISTENING message', () => {
+ const server = new DevServer(defaultOptions);
+ run(server);
+ isProc(currentProc);
+
+ let ready;
+ subscriptions.push(
+ server.isReady$().subscribe((_ready) => {
+ ready = _ready;
+ })
+ );
+
+ expect(ready).toBe(false);
+ currentProc.mockListening();
+ expect(ready).toBe(true);
+ });
+
+ it('is not ready when process exits', () => {
+ const server = new DevServer(defaultOptions);
+ run(server);
+ isProc(currentProc);
+
+ const ready$ = new Rx.BehaviorSubject(undefined);
+ subscriptions.push(server.isReady$().subscribe(ready$));
+
+ currentProc.mockListening();
+ expect(ready$.getValue()).toBe(true);
+ currentProc.mockExit(0);
+ expect(ready$.getValue()).toBe(false);
+ });
+
+ it('logs about crashes when process exits with non-zero code', () => {
+ const server = new DevServer(defaultOptions);
+ run(server);
+ isProc(currentProc);
+
+ currentProc.mockExit(1);
+ expect(log.messages).toMatchInlineSnapshot(`
+ Array [
+ Object {
+ "args": Array [
+ "server crashed",
+ "with status code",
+ 1,
+ ],
+ "type": "bad",
+ },
+ ]
+ `);
+ });
+
+ it('does not restart the server when process exits with 0 and stdio streams complete', async () => {
+ const server = new DevServer(defaultOptions);
+ run(server);
+ isProc(currentProc);
+ const initialProc = currentProc;
+
+ const ready$ = new Rx.BehaviorSubject(undefined);
+ subscriptions.push(server.isReady$().subscribe(ready$));
+
+ currentProc.mockExit(0);
+
+ expect(ready$.getValue()).toBe(false);
+ expect(initialProc).toBe(currentProc); // no restart or the proc would have been updated
+ });
+
+ it('kills server and restarts when watcher says to', () => {
+ run(new DevServer(defaultOptions));
+
+ const initialProc = currentProc;
+ isProc(initialProc);
+
+ restart$.next();
+ expect(initialProc.signalsSent).toEqual(['SIGKILL']);
+
+ isProc(currentProc);
+ expect(currentProc).not.toBe(initialProc);
+ });
+
+ it('subscribes to sigint$, sigterm$, and processExit$ options', () => {
+ run(new DevServer(defaultOptions));
+
+ expect(sigint$.observers).toHaveLength(1);
+ expect(sigterm$.observers).toHaveLength(1);
+ expect(processExit$.observers).toHaveLength(1);
+ });
+
+ it('kills the server on sigint$ before listening', () => {
+ run(new DevServer(defaultOptions));
+ isProc(currentProc);
+
+ expect(currentProc.signalsSent).toEqual([]);
+ sigint$.next();
+ expect(currentProc.signalsSent).toEqual(['SIGKILL']);
+ });
+
+ it('kills the server on processExit$', () => {
+ run(new DevServer(defaultOptions));
+ isProc(currentProc);
+
+ expect(currentProc.signalsSent).toEqual([]);
+ processExit$.next();
+ expect(currentProc.signalsSent).toEqual(['SIGKILL']);
+ });
+
+ it('kills the server on sigterm$', () => {
+ run(new DevServer(defaultOptions));
+ isProc(currentProc);
+
+ expect(currentProc.signalsSent).toEqual([]);
+ sigterm$.next();
+ expect(currentProc.signalsSent).toEqual(['SIGKILL']);
+ });
+
+ it('sends SIGINT to child process on sigint$ after listening', () => {
+ run(new DevServer(defaultOptions));
+ isProc(currentProc);
+
+ currentProc.mockListening();
+
+ expect(currentProc.signalsSent).toEqual([]);
+ sigint$.next();
+ expect(currentProc.signalsSent).toEqual(['SIGINT']);
+ });
+
+ it('sends SIGKILL to child process on double sigint$ after listening', () => {
+ run(new DevServer(defaultOptions));
+ isProc(currentProc);
+
+ currentProc.mockListening();
+
+ expect(currentProc.signalsSent).toEqual([]);
+ sigint$.next();
+ sigint$.next();
+ expect(currentProc.signalsSent).toEqual(['SIGINT', 'SIGKILL']);
+ });
+
+ it('kills the server after sending SIGINT and gracefulTimeout is passed after listening', async () => {
+ run(new DevServer(defaultOptions));
+ isProc(currentProc);
+
+ currentProc.mockListening();
+
+ expect(currentProc.signalsSent).toEqual([]);
+ sigint$.next();
+ expect(currentProc.signalsSent).toEqual(['SIGINT']);
+ await new Promise((resolve) => setTimeout(resolve, 1000));
+ expect(currentProc.signalsSent).toEqual(['SIGINT', 'SIGKILL']);
+ });
+});
diff --git a/src/dev/cli_dev_mode/dev_server.ts b/src/dev/cli_dev_mode/dev_server.ts
new file mode 100644
index 0000000000000..da64c680a3c2d
--- /dev/null
+++ b/src/dev/cli_dev_mode/dev_server.ts
@@ -0,0 +1,222 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { EventEmitter } from 'events';
+
+import * as Rx from 'rxjs';
+import {
+ map,
+ tap,
+ take,
+ share,
+ mergeMap,
+ switchMap,
+ takeUntil,
+ ignoreElements,
+} from 'rxjs/operators';
+import { observeLines } from '@kbn/dev-utils';
+
+import { usingServerProcess } from './using_server_process';
+import { Watcher } from './watcher';
+import { Log } from './log';
+
+export interface Options {
+ log: Log;
+ watcher: Watcher;
+ script: string;
+ argv: string[];
+ gracefulTimeout: number;
+ processExit$?: Rx.Observable;
+ sigint$?: Rx.Observable;
+ sigterm$?: Rx.Observable;
+}
+
+export class DevServer {
+ private readonly log: Log;
+ private readonly watcher: Watcher;
+
+ private readonly processExit$: Rx.Observable;
+ private readonly sigint$: Rx.Observable;
+ private readonly sigterm$: Rx.Observable;
+ private readonly ready$ = new Rx.BehaviorSubject(false);
+
+ private readonly script: string;
+ private readonly argv: string[];
+ private readonly gracefulTimeout: number;
+
+ constructor(options: Options) {
+ this.log = options.log;
+ this.watcher = options.watcher;
+
+ this.script = options.script;
+ this.argv = options.argv;
+ this.gracefulTimeout = options.gracefulTimeout;
+ this.processExit$ = options.processExit$ ?? Rx.fromEvent(process as EventEmitter, 'exit');
+ this.sigint$ = options.sigint$ ?? Rx.fromEvent(process as EventEmitter, 'SIGINT');
+ this.sigterm$ = options.sigterm$ ?? Rx.fromEvent(process as EventEmitter, 'SIGTERM');
+ }
+
+ isReady$() {
+ return this.ready$.asObservable();
+ }
+
+ /**
+ * Run the Kibana server
+ *
+ * The observable will error if the child process failes to spawn for some reason, but if
+ * the child process is successfully spawned then the server will be run until it completes
+ * and restart when the watcher indicates it should. In order to restart the server as
+ * quickly as possible we kill it with SIGKILL and spawn the process again.
+ *
+ * While the process is running we also observe SIGINT signals and forward them to the child
+ * process. If the process doesn't exit within options.gracefulTimeout we kill the process
+ * with SIGKILL and complete our observable which should allow the parent process to exit.
+ *
+ * When the global 'exit' event or SIGTERM is observed we send the SIGKILL signal to the
+ * child process to make sure that it's immediately gone.
+ */
+ run$ = new Rx.Observable((subscriber) => {
+ // listen for SIGINT and forward to process if it's running, otherwise unsub
+ const gracefulShutdown$ = new Rx.Subject();
+ subscriber.add(
+ this.sigint$
+ .pipe(
+ map((_, index) => {
+ if (this.ready$.getValue() && index === 0) {
+ gracefulShutdown$.next();
+ } else {
+ subscriber.complete();
+ }
+ })
+ )
+ .subscribe({
+ error(error) {
+ subscriber.error(error);
+ },
+ })
+ );
+
+ // force unsubscription/kill on process.exit or SIGTERM
+ subscriber.add(
+ Rx.merge(this.processExit$, this.sigterm$).subscribe(() => {
+ subscriber.complete();
+ })
+ );
+
+ const runServer = () =>
+ usingServerProcess(this.script, this.argv, (proc) => {
+ // observable which emits devServer states containing lines
+ // logged to stdout/stderr, completes when stdio streams complete
+ const log$ = Rx.merge(observeLines(proc.stdout!), observeLines(proc.stderr!)).pipe(
+ tap((line) => {
+ this.log.write(line);
+ })
+ );
+
+ // observable which emits exit states and is the switch which
+ // ends all other merged observables
+ const exit$ = Rx.fromEvent<[number]>(proc, 'exit').pipe(
+ tap(([code]) => {
+ this.ready$.next(false);
+
+ if (code != null && code !== 0) {
+ if (this.watcher.enabled) {
+ this.log.bad(`server crashed`, 'with status code', code);
+ } else {
+ throw new Error(`server crashed with exit code [${code}]`);
+ }
+ }
+ }),
+ take(1),
+ share()
+ );
+
+ // throw errors if spawn fails
+ const error$ = Rx.fromEvent(proc, 'error').pipe(
+ map((error) => {
+ throw error;
+ }),
+ takeUntil(exit$)
+ );
+
+ // handles messages received from the child process
+ const msg$ = Rx.fromEvent<[any]>(proc, 'message').pipe(
+ tap(([received]) => {
+ if (!Array.isArray(received)) {
+ return;
+ }
+
+ const msg = received[0];
+
+ if (msg === 'SERVER_LISTENING') {
+ this.ready$.next(true);
+ }
+
+ // TODO: remove this once Pier is done migrating log rotation to KP
+ if (msg === 'RELOAD_LOGGING_CONFIG_FROM_SERVER_WORKER') {
+ // When receive that event from server worker
+ // forward a reloadLoggingConfig message to parent
+ // and child proc. This is only used by LogRotator service
+ // when the cluster mode is enabled
+ process.emit('message' as any, { reloadLoggingConfig: true } as any);
+ proc.send({ reloadLoggingConfig: true });
+ }
+ }),
+ takeUntil(exit$)
+ );
+
+ // handle graceful shutdown requests
+ const triggerGracefulShutdown$ = gracefulShutdown$.pipe(
+ mergeMap(() => {
+ // signal to the process that it should exit
+ proc.kill('SIGINT');
+
+ // if the timer fires before exit$ we will send SIGINT
+ return Rx.timer(this.gracefulTimeout).pipe(
+ tap(() => {
+ this.log.warn(
+ `server didnt exit`,
+ `sent [SIGINT] to the server but it didn't exit within ${this.gracefulTimeout}ms, killing with SIGKILL`
+ );
+
+ proc.kill('SIGKILL');
+ })
+ );
+ }),
+
+ // if exit$ emits before the gracefulTimeout then this
+ // will unsub and cancel the timer
+ takeUntil(exit$)
+ );
+
+ return Rx.merge(log$, exit$, error$, msg$, triggerGracefulShutdown$);
+ });
+
+ subscriber.add(
+ Rx.concat([undefined], this.watcher.serverShouldRestart$())
+ .pipe(
+ // on each tick unsubscribe from the previous server process
+ // causing it to be SIGKILL-ed, then setup a new one
+ switchMap(runServer),
+ ignoreElements()
+ )
+ .subscribe(subscriber)
+ );
+ });
+}
diff --git a/src/cli/cluster/binder_for.ts b/src/dev/cli_dev_mode/get_active_inspect_flag.ts
similarity index 58%
rename from src/cli/cluster/binder_for.ts
rename to src/dev/cli_dev_mode/get_active_inspect_flag.ts
index e3eabc8d91fa5..219c05647b2dc 100644
--- a/src/cli/cluster/binder_for.ts
+++ b/src/dev/cli_dev_mode/get_active_inspect_flag.ts
@@ -17,14 +17,27 @@
* under the License.
*/
-import { BinderBase, Emitter } from './binder';
+import getopts from 'getopts';
+// @ts-expect-error no types available, very simple module https://github.com/evanlucas/argsplit
+import argsplit from 'argsplit';
-export class BinderFor extends BinderBase {
- constructor(private readonly emitter: Emitter) {
- super();
+const execOpts = getopts(process.execArgv);
+const envOpts = getopts(process.env.NODE_OPTIONS ? argsplit(process.env.NODE_OPTIONS) : []);
+
+export function getActiveInspectFlag() {
+ if (execOpts.inspect) {
+ return '--inspect';
+ }
+
+ if (execOpts['inspect-brk']) {
+ return '--inspect-brk';
+ }
+
+ if (envOpts.inspect) {
+ return '--inspect';
}
- public on(...args: any[]) {
- super.on(this.emitter, ...args);
+ if (envOpts['inspect-brk']) {
+ return '--inspect-brk';
}
}
diff --git a/src/dev/cli_dev_mode/get_server_watch_paths.test.ts b/src/dev/cli_dev_mode/get_server_watch_paths.test.ts
new file mode 100644
index 0000000000000..ec0d5d013a782
--- /dev/null
+++ b/src/dev/cli_dev_mode/get_server_watch_paths.test.ts
@@ -0,0 +1,90 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import Path from 'path';
+
+import { REPO_ROOT, createAbsolutePathSerializer } from '@kbn/dev-utils';
+
+import { getServerWatchPaths } from './get_server_watch_paths';
+
+expect.addSnapshotSerializer(createAbsolutePathSerializer());
+
+it('produces the right watch and ignore list', () => {
+ const { watchPaths, ignorePaths } = getServerWatchPaths({
+ pluginPaths: [Path.resolve(REPO_ROOT, 'x-pack/test/plugin_functional/plugins/resolver_test')],
+ pluginScanDirs: [
+ Path.resolve(REPO_ROOT, 'src/plugins'),
+ Path.resolve(REPO_ROOT, 'test/plugin_functional/plugins'),
+ Path.resolve(REPO_ROOT, 'x-pack/plugins'),
+ ],
+ });
+
+ expect(watchPaths).toMatchInlineSnapshot(`
+ Array [
+ /src/core,
+ /src/legacy/server,
+ /src/legacy/ui,
+ /src/legacy/utils,
+ /config,
+ /x-pack/test/plugin_functional/plugins/resolver_test,
+ /src/plugins,
+ /test/plugin_functional/plugins,
+ /x-pack/plugins,
+ ]
+ `);
+
+ expect(ignorePaths).toMatchInlineSnapshot(`
+ Array [
+ /\\[\\\\\\\\\\\\/\\]\\(\\\\\\.\\.\\*\\|node_modules\\|bower_components\\|target\\|public\\|__\\[a-z0-9_\\]\\+__\\|coverage\\)\\(\\[\\\\\\\\\\\\/\\]\\|\\$\\)/,
+ /\\\\\\.test\\\\\\.\\(js\\|tsx\\?\\)\\$/,
+ /\\\\\\.\\(md\\|sh\\|txt\\)\\$/,
+ /debug\\\\\\.log\\$/,
+ /src/plugins/*/test/**,
+ /src/plugins/*/build/**,
+ /src/plugins/*/target/**,
+ /src/plugins/*/scripts/**,
+ /src/plugins/*/docs/**,
+ /test/plugin_functional/plugins/*/test/**,
+ /test/plugin_functional/plugins/*/build/**,
+ /test/plugin_functional/plugins/*/target/**,
+ /test/plugin_functional/plugins/*/scripts/**,
+ /test/plugin_functional/plugins/*/docs/**,
+ /x-pack/plugins/*/test/**,
+ /x-pack/plugins/*/build/**,
+ /x-pack/plugins/*/target/**,
+ /x-pack/plugins/*/scripts/**,
+ /x-pack/plugins/*/docs/**,
+ /x-pack/test/plugin_functional/plugins/resolver_test/test/**,
+ /x-pack/test/plugin_functional/plugins/resolver_test/build/**,
+ /x-pack/test/plugin_functional/plugins/resolver_test/target/**,
+ /x-pack/test/plugin_functional/plugins/resolver_test/scripts/**,
+ /x-pack/test/plugin_functional/plugins/resolver_test/docs/**,
+ /x-pack/plugins/reporting/chromium,
+ /x-pack/plugins/security_solution/cypress,
+ /x-pack/plugins/apm/e2e,
+ /x-pack/plugins/apm/scripts,
+ /x-pack/plugins/canvas/canvas_plugin_src,
+ /x-pack/plugins/case/server/scripts,
+ /x-pack/plugins/lists/scripts,
+ /x-pack/plugins/lists/server/scripts,
+ /x-pack/plugins/security_solution/scripts,
+ /x-pack/plugins/security_solution/server/lib/detection_engine/scripts,
+ ]
+ `);
+});
diff --git a/src/dev/cli_dev_mode/get_server_watch_paths.ts b/src/dev/cli_dev_mode/get_server_watch_paths.ts
new file mode 100644
index 0000000000000..7fe05c649b738
--- /dev/null
+++ b/src/dev/cli_dev_mode/get_server_watch_paths.ts
@@ -0,0 +1,94 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import Path from 'path';
+import Fs from 'fs';
+
+import { REPO_ROOT } from '@kbn/dev-utils';
+
+interface Options {
+ pluginPaths: string[];
+ pluginScanDirs: string[];
+}
+
+export type WatchPaths = ReturnType;
+
+export function getServerWatchPaths({ pluginPaths, pluginScanDirs }: Options) {
+ const fromRoot = (p: string) => Path.resolve(REPO_ROOT, p);
+
+ const pluginInternalDirsIgnore = pluginScanDirs
+ .map((scanDir) => Path.resolve(scanDir, '*'))
+ .concat(pluginPaths)
+ .reduce(
+ (acc: string[], path) => [
+ ...acc,
+ Path.resolve(path, 'test/**'),
+ Path.resolve(path, 'build/**'),
+ Path.resolve(path, 'target/**'),
+ Path.resolve(path, 'scripts/**'),
+ Path.resolve(path, 'docs/**'),
+ ],
+ []
+ );
+
+ const watchPaths = Array.from(
+ new Set(
+ [
+ fromRoot('src/core'),
+ fromRoot('src/legacy/server'),
+ fromRoot('src/legacy/ui'),
+ fromRoot('src/legacy/utils'),
+ fromRoot('config'),
+ ...pluginPaths,
+ ...pluginScanDirs,
+ ].map((path) => Path.resolve(path))
+ )
+ );
+
+ for (const watchPath of watchPaths) {
+ if (!Fs.existsSync(fromRoot(watchPath))) {
+ throw new Error(
+ `A watch directory [${watchPath}] does not exist, which will cause chokidar to fail. Either make sure the directory exists or remove it as a watch source in the ClusterManger`
+ );
+ }
+ }
+
+ const ignorePaths = [
+ /[\\\/](\..*|node_modules|bower_components|target|public|__[a-z0-9_]+__|coverage)([\\\/]|$)/,
+ /\.test\.(js|tsx?)$/,
+ /\.(md|sh|txt)$/,
+ /debug\.log$/,
+ ...pluginInternalDirsIgnore,
+ fromRoot('x-pack/plugins/reporting/chromium'),
+ fromRoot('x-pack/plugins/security_solution/cypress'),
+ fromRoot('x-pack/plugins/apm/e2e'),
+ fromRoot('x-pack/plugins/apm/scripts'),
+ fromRoot('x-pack/plugins/canvas/canvas_plugin_src'), // prevents server from restarting twice for Canvas plugin changes,
+ fromRoot('x-pack/plugins/case/server/scripts'),
+ fromRoot('x-pack/plugins/lists/scripts'),
+ fromRoot('x-pack/plugins/lists/server/scripts'),
+ fromRoot('x-pack/plugins/security_solution/scripts'),
+ fromRoot('x-pack/plugins/security_solution/server/lib/detection_engine/scripts'),
+ ];
+
+ return {
+ watchPaths,
+ ignorePaths,
+ };
+}
diff --git a/src/core/server/legacy/cli.js b/src/dev/cli_dev_mode/index.ts
similarity index 93%
rename from src/core/server/legacy/cli.js
rename to src/dev/cli_dev_mode/index.ts
index 28e14d28eecd3..92714c3740e9a 100644
--- a/src/core/server/legacy/cli.js
+++ b/src/dev/cli_dev_mode/index.ts
@@ -17,4 +17,5 @@
* under the License.
*/
-export { startRepl } from '../../../cli/repl';
+export * from './cli_dev_mode';
+export * from './log';
diff --git a/src/cli/cluster/log.ts b/src/dev/cli_dev_mode/log.ts
similarity index 64%
rename from src/cli/cluster/log.ts
rename to src/dev/cli_dev_mode/log.ts
index af73059c0758e..f349026ca9cab 100644
--- a/src/cli/cluster/log.ts
+++ b/src/dev/cli_dev_mode/log.ts
@@ -17,9 +17,18 @@
* under the License.
*/
+/* eslint-disable max-classes-per-file */
+
import Chalk from 'chalk';
-export class Log {
+export interface Log {
+ good(label: string, ...args: any[]): void;
+ warn(label: string, ...args: any[]): void;
+ bad(label: string, ...args: any[]): void;
+ write(label: string, ...args: any[]): void;
+}
+
+export class CliLog implements Log {
constructor(private readonly quiet: boolean, private readonly silent: boolean) {}
good(label: string, ...args: any[]) {
@@ -54,3 +63,35 @@ export class Log {
console.log(` ${label.trim()} `, ...args);
}
}
+
+export class TestLog implements Log {
+ public readonly messages: Array<{ type: string; args: any[] }> = [];
+
+ bad(label: string, ...args: any[]) {
+ this.messages.push({
+ type: 'bad',
+ args: [label, ...args],
+ });
+ }
+
+ good(label: string, ...args: any[]) {
+ this.messages.push({
+ type: 'good',
+ args: [label, ...args],
+ });
+ }
+
+ warn(label: string, ...args: any[]) {
+ this.messages.push({
+ type: 'warn',
+ args: [label, ...args],
+ });
+ }
+
+ write(label: string, ...args: any[]) {
+ this.messages.push({
+ type: 'write',
+ args: [label, ...args],
+ });
+ }
+}
diff --git a/src/dev/cli_dev_mode/optimizer.test.ts b/src/dev/cli_dev_mode/optimizer.test.ts
new file mode 100644
index 0000000000000..8a82012499b33
--- /dev/null
+++ b/src/dev/cli_dev_mode/optimizer.test.ts
@@ -0,0 +1,214 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { PassThrough } from 'stream';
+
+import * as Rx from 'rxjs';
+import { toArray } from 'rxjs/operators';
+import { OptimizerUpdate } from '@kbn/optimizer';
+import { observeLines, createReplaceSerializer } from '@kbn/dev-utils';
+import { firstValueFrom } from '@kbn/std';
+
+import { Optimizer, Options } from './optimizer';
+
+jest.mock('@kbn/optimizer');
+const realOptimizer = jest.requireActual('@kbn/optimizer');
+const { runOptimizer, OptimizerConfig, logOptimizerState } = jest.requireMock('@kbn/optimizer');
+
+logOptimizerState.mockImplementation(realOptimizer.logOptimizerState);
+
+class MockOptimizerConfig {}
+
+const mockOptimizerUpdate = (phase: OptimizerUpdate['state']['phase']) => {
+ return {
+ state: {
+ compilerStates: [],
+ durSec: 0,
+ offlineBundles: [],
+ onlineBundles: [],
+ phase,
+ startTime: 100,
+ },
+ };
+};
+
+const defaultOptions: Options = {
+ enabled: true,
+ cache: true,
+ dist: true,
+ oss: true,
+ pluginPaths: ['/some/dir'],
+ quiet: true,
+ silent: true,
+ repoRoot: '/app',
+ runExamples: true,
+ watch: true,
+};
+
+function setup(options: Options = defaultOptions) {
+ const update$ = new Rx.Subject();
+
+ OptimizerConfig.create.mockImplementation(() => new MockOptimizerConfig());
+ runOptimizer.mockImplementation(() => update$);
+
+ const optimizer = new Optimizer(options);
+
+ return { optimizer, update$ };
+}
+
+const subscriptions: Rx.Subscription[] = [];
+
+expect.addSnapshotSerializer(createReplaceSerializer(/\[\d\d:\d\d:\d\d\.\d\d\d\]/, '[timestamp]'));
+
+afterEach(() => {
+ for (const sub of subscriptions) {
+ sub.unsubscribe();
+ }
+ subscriptions.length = 0;
+
+ jest.clearAllMocks();
+});
+
+it('uses options to create valid OptimizerConfig', () => {
+ setup();
+ setup({
+ ...defaultOptions,
+ cache: false,
+ dist: false,
+ runExamples: false,
+ oss: false,
+ pluginPaths: [],
+ repoRoot: '/foo/bar',
+ watch: false,
+ });
+
+ expect(OptimizerConfig.create.mock.calls).toMatchInlineSnapshot(`
+ Array [
+ Array [
+ Object {
+ "cache": true,
+ "dist": true,
+ "examples": true,
+ "includeCoreBundle": true,
+ "oss": true,
+ "pluginPaths": Array [
+ "/some/dir",
+ ],
+ "repoRoot": "/app",
+ "watch": true,
+ },
+ ],
+ Array [
+ Object {
+ "cache": false,
+ "dist": false,
+ "examples": false,
+ "includeCoreBundle": true,
+ "oss": false,
+ "pluginPaths": Array [],
+ "repoRoot": "/foo/bar",
+ "watch": false,
+ },
+ ],
+ ]
+ `);
+});
+
+it('is ready when optimizer phase is success or issue and logs in familiar format', async () => {
+ const writeLogTo = new PassThrough();
+ const linesPromise = firstValueFrom(observeLines(writeLogTo).pipe(toArray()));
+
+ const { update$, optimizer } = setup({
+ ...defaultOptions,
+ quiet: false,
+ silent: false,
+ writeLogTo,
+ });
+
+ const history: any[] = [''];
+ subscriptions.push(
+ optimizer.isReady$().subscribe({
+ next(ready) {
+ history.push(`ready: ${ready}`);
+ },
+ error(error) {
+ throw error;
+ },
+ complete() {
+ history.push(`complete`);
+ },
+ })
+ );
+
+ subscriptions.push(
+ optimizer.run$.subscribe({
+ error(error) {
+ throw error;
+ },
+ })
+ );
+
+ history.push('');
+ update$.next(mockOptimizerUpdate('success'));
+
+ history.push('');
+ update$.next(mockOptimizerUpdate('running'));
+
+ history.push('');
+ update$.next(mockOptimizerUpdate('issue'));
+
+ update$.complete();
+
+ expect(history).toMatchInlineSnapshot(`
+ Array [
+ "",
+ "",
+ "ready: true",
+ "",
+ "ready: false",
+ "",
+ "ready: true",
+ ]
+ `);
+
+ writeLogTo.end();
+ const lines = await linesPromise;
+ expect(lines).toMatchInlineSnapshot(`
+ Array [
+ "[2mnp bld[22m log [timestamp] [[36msuccess[39m][[95m@kbn/optimizer[39m] 0 bundles compiled successfully after 0 sec",
+ "[2mnp bld[22m log [timestamp] [error][[95m@kbn/optimizer[39m] webpack compile errors",
+ ]
+ `);
+});
+
+it('completes immedately and is immediately ready when disabled', () => {
+ const ready$ = new Rx.BehaviorSubject(undefined);
+
+ const { optimizer, update$ } = setup({
+ ...defaultOptions,
+ enabled: false,
+ });
+
+ subscriptions.push(optimizer.isReady$().subscribe(ready$));
+
+ expect(update$.observers).toHaveLength(0);
+ expect(runOptimizer).not.toHaveBeenCalled();
+ expect(ready$).toHaveProperty('isStopped', true);
+ expect(ready$.getValue()).toBe(true);
+});
diff --git a/src/dev/cli_dev_mode/optimizer.ts b/src/dev/cli_dev_mode/optimizer.ts
new file mode 100644
index 0000000000000..9aac414f02b29
--- /dev/null
+++ b/src/dev/cli_dev_mode/optimizer.ts
@@ -0,0 +1,128 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import Chalk from 'chalk';
+import moment from 'moment';
+import { Writable } from 'stream';
+import { tap } from 'rxjs/operators';
+import {
+ ToolingLog,
+ pickLevelFromFlags,
+ ToolingLogTextWriter,
+ parseLogLevel,
+} from '@kbn/dev-utils';
+import * as Rx from 'rxjs';
+import { ignoreElements } from 'rxjs/operators';
+import { runOptimizer, OptimizerConfig, logOptimizerState } from '@kbn/optimizer';
+
+export interface Options {
+ enabled: boolean;
+ repoRoot: string;
+ quiet: boolean;
+ silent: boolean;
+ watch: boolean;
+ cache: boolean;
+ dist: boolean;
+ oss: boolean;
+ runExamples: boolean;
+ pluginPaths: string[];
+ writeLogTo?: Writable;
+}
+
+export class Optimizer {
+ public readonly run$: Rx.Observable;
+ private readonly ready$ = new Rx.ReplaySubject(1);
+
+ constructor(options: Options) {
+ if (!options.enabled) {
+ this.run$ = Rx.EMPTY;
+ this.ready$.next(true);
+ this.ready$.complete();
+ return;
+ }
+
+ const config = OptimizerConfig.create({
+ repoRoot: options.repoRoot,
+ watch: options.watch,
+ includeCoreBundle: true,
+ cache: options.cache,
+ dist: options.dist,
+ oss: options.oss,
+ examples: options.runExamples,
+ pluginPaths: options.pluginPaths,
+ });
+
+ const dim = Chalk.dim('np bld');
+ const name = Chalk.magentaBright('@kbn/optimizer');
+ const time = () => moment().format('HH:mm:ss.SSS');
+ const level = (msgType: string) => {
+ switch (msgType) {
+ case 'info':
+ return Chalk.green(msgType);
+ case 'success':
+ return Chalk.cyan(msgType);
+ case 'debug':
+ return Chalk.gray(msgType);
+ case 'warning':
+ return Chalk.yellowBright(msgType);
+ default:
+ return msgType;
+ }
+ };
+
+ const { flags: levelFlags } = parseLogLevel(
+ pickLevelFromFlags({
+ quiet: options.quiet,
+ silent: options.silent,
+ })
+ );
+
+ const log = new ToolingLog();
+ const has = (obj: T, x: any): x is keyof T => obj.hasOwnProperty(x);
+
+ log.setWriters([
+ {
+ write(msg) {
+ if (has(levelFlags, msg.type) && !levelFlags[msg.type]) {
+ return false;
+ }
+
+ ToolingLogTextWriter.write(
+ options.writeLogTo ?? process.stdout,
+ `${dim} log [${time()}] [${level(msg.type)}][${name}] `,
+ msg
+ );
+ return true;
+ },
+ },
+ ]);
+
+ this.run$ = runOptimizer(config).pipe(
+ logOptimizerState(log, config),
+ tap(({ state }) => {
+ this.ready$.next(state.phase === 'success' || state.phase === 'issue');
+ }),
+ ignoreElements()
+ );
+ }
+
+ isReady$() {
+ return this.ready$.asObservable();
+ }
+}
diff --git a/src/cli/cluster/binder.ts b/src/dev/cli_dev_mode/should_redirect_from_old_base_path.test.ts
similarity index 57%
rename from src/cli/cluster/binder.ts
rename to src/dev/cli_dev_mode/should_redirect_from_old_base_path.test.ts
index 55577e3a69e2b..f51b3743e0210 100644
--- a/src/cli/cluster/binder.ts
+++ b/src/dev/cli_dev_mode/should_redirect_from_old_base_path.test.ts
@@ -17,27 +17,23 @@
* under the License.
*/
-export interface Emitter {
- on: (...args: any[]) => void;
- off: (...args: any[]) => void;
- addListener: Emitter['on'];
- removeListener: Emitter['off'];
-}
-
-export class BinderBase {
- private disposal: Array<() => void> = [];
-
- public on(emitter: Emitter, ...args: any[]) {
- const on = emitter.on || emitter.addListener;
- const off = emitter.off || emitter.removeListener;
-
- on.apply(emitter, args);
- this.disposal.push(() => off.apply(emitter, args));
+import { shouldRedirectFromOldBasePath } from './should_redirect_from_old_base_path';
+it.each([
+ ['app/foo'],
+ ['app/bar'],
+ ['login'],
+ ['logout'],
+ ['status'],
+ ['s/1/status'],
+ ['s/2/app/foo'],
+])('allows %s', (path) => {
+ if (!shouldRedirectFromOldBasePath(path)) {
+ throw new Error(`expected [${path}] to be redirected from old base path`);
}
+});
- public destroy() {
- const destroyers = this.disposal;
- this.disposal = [];
- destroyers.forEach((fn) => fn());
+it.each([['api/foo'], ['v1/api/bar'], ['bundles/foo/foo.bundle.js']])('blocks %s', (path) => {
+ if (shouldRedirectFromOldBasePath(path)) {
+ throw new Error(`expected [${path}] to NOT be redirected from old base path`);
}
-}
+});
diff --git a/src/plugins/data/common/index_patterns/lib/get_from_saved_object.ts b/src/dev/cli_dev_mode/should_redirect_from_old_base_path.ts
similarity index 56%
rename from src/plugins/data/common/index_patterns/lib/get_from_saved_object.ts
rename to src/dev/cli_dev_mode/should_redirect_from_old_base_path.ts
index 1630a4547b7a1..ba13932e60231 100644
--- a/src/plugins/data/common/index_patterns/lib/get_from_saved_object.ts
+++ b/src/dev/cli_dev_mode/should_redirect_from_old_base_path.ts
@@ -17,20 +17,19 @@
* under the License.
*/
-import { SavedObject } from 'src/core/public';
-import { get } from 'lodash';
-import { IIndexPattern, IndexPatternAttributes } from '../..';
-
-export function getFromSavedObject(
- savedObject: SavedObject
-): IIndexPattern | undefined {
- if (get(savedObject, 'attributes.fields') === undefined) {
- return;
+/**
+ * Determine which requested paths should be redirected from one basePath
+ * to another. We only do this for a supset of the paths so that people don't
+ * think that specifying a random three character string at the beginning of
+ * a URL will work.
+ */
+export function shouldRedirectFromOldBasePath(path: string) {
+ // strip `s/{id}` prefix when checking for need to redirect
+ if (path.startsWith('s/')) {
+ path = path.split('/').slice(2).join('/');
}
- return {
- id: savedObject.id,
- fields: JSON.parse(savedObject.attributes.fields!),
- title: savedObject.attributes.title,
- };
+ const isApp = path.startsWith('app/');
+ const isKnownShortPath = ['login', 'logout', 'status'].includes(path);
+ return isApp || isKnownShortPath;
}
diff --git a/src/dev/cli_dev_mode/test_helpers.ts b/src/dev/cli_dev_mode/test_helpers.ts
new file mode 100644
index 0000000000000..1e320de83588b
--- /dev/null
+++ b/src/dev/cli_dev_mode/test_helpers.ts
@@ -0,0 +1,49 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+export const extendedEnvSerializer: jest.SnapshotSerializerPlugin = {
+ test: (v) =>
+ typeof v === 'object' &&
+ v !== null &&
+ typeof v.env === 'object' &&
+ v.env !== null &&
+ !v.env[''],
+
+ serialize(val, config, indentation, depth, refs, printer) {
+ const customizations: Record = {
+ '': true,
+ };
+ for (const [key, value] of Object.entries(val.env)) {
+ if (process.env[key] !== value) {
+ customizations[key] = value;
+ }
+ }
+
+ return printer(
+ {
+ ...val,
+ env: customizations,
+ },
+ config,
+ indentation,
+ depth,
+ refs
+ );
+ },
+};
diff --git a/src/dev/cli_dev_mode/using_server_process.ts b/src/dev/cli_dev_mode/using_server_process.ts
new file mode 100644
index 0000000000000..23423fcacb2fc
--- /dev/null
+++ b/src/dev/cli_dev_mode/using_server_process.ts
@@ -0,0 +1,67 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import execa from 'execa';
+import * as Rx from 'rxjs';
+
+import { getActiveInspectFlag } from './get_active_inspect_flag';
+
+const ACTIVE_INSPECT_FLAG = getActiveInspectFlag();
+
+interface ProcResource extends Rx.Unsubscribable {
+ proc: execa.ExecaChildProcess;
+ unsubscribe(): void;
+}
+
+export function usingServerProcess(
+ script: string,
+ argv: string[],
+ fn: (proc: execa.ExecaChildProcess) => Rx.Observable
+) {
+ return Rx.using(
+ (): ProcResource => {
+ const proc = execa.node(script, [...argv, '--logging.json=false'], {
+ stdio: 'pipe',
+ nodeOptions: [
+ ...process.execArgv,
+ ...(ACTIVE_INSPECT_FLAG ? [`${ACTIVE_INSPECT_FLAG}=${process.debugPort + 1}`] : []),
+ ].filter((arg) => !arg.includes('inspect')),
+ env: {
+ ...process.env,
+ NODE_OPTIONS: process.env.NODE_OPTIONS,
+ isDevCliChild: 'true',
+ ELASTIC_APM_SERVICE_NAME: 'kibana',
+ ...(process.stdout.isTTY ? { FORCE_COLOR: 'true' } : {}),
+ },
+ });
+
+ return {
+ proc,
+ unsubscribe() {
+ proc.kill('SIGKILL');
+ },
+ };
+ },
+
+ (resource) => {
+ const { proc } = resource as ProcResource;
+ return fn(proc);
+ }
+ );
+}
diff --git a/src/dev/cli_dev_mode/watcher.test.ts b/src/dev/cli_dev_mode/watcher.test.ts
new file mode 100644
index 0000000000000..59dbab52a0cf6
--- /dev/null
+++ b/src/dev/cli_dev_mode/watcher.test.ts
@@ -0,0 +1,219 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { EventEmitter } from 'events';
+
+import * as Rx from 'rxjs';
+import { materialize, toArray } from 'rxjs/operators';
+import { firstValueFrom } from '@kbn/std';
+
+import { TestLog } from './log';
+import { Watcher, Options } from './watcher';
+
+class MockChokidar extends EventEmitter {
+ close = jest.fn();
+}
+
+let mockChokidar: MockChokidar | undefined;
+jest.mock('chokidar');
+const chokidar = jest.requireMock('chokidar');
+function isMock(mock: MockChokidar | undefined): asserts mock is MockChokidar {
+ expect(mock).toBeInstanceOf(MockChokidar);
+}
+
+chokidar.watch.mockImplementation(() => {
+ mockChokidar = new MockChokidar();
+ return mockChokidar;
+});
+
+const subscriptions: Rx.Subscription[] = [];
+const run = (watcher: Watcher) => {
+ const subscription = watcher.run$.subscribe({
+ error(e) {
+ throw e;
+ },
+ });
+ subscriptions.push(subscription);
+ return subscription;
+};
+
+const log = new TestLog();
+const defaultOptions: Options = {
+ enabled: true,
+ log,
+ paths: ['foo.js', 'bar.js'],
+ ignore: [/^f/],
+ cwd: '/app/repo',
+};
+
+afterEach(() => {
+ jest.clearAllMocks();
+
+ if (mockChokidar) {
+ mockChokidar.removeAllListeners();
+ mockChokidar = undefined;
+ }
+
+ for (const sub of subscriptions) {
+ sub.unsubscribe();
+ }
+
+ subscriptions.length = 0;
+ log.messages.length = 0;
+});
+
+it('completes restart streams immediately when disabled', () => {
+ const watcher = new Watcher({
+ ...defaultOptions,
+ enabled: false,
+ });
+
+ const restart$ = new Rx.BehaviorSubject(undefined);
+ subscriptions.push(watcher.serverShouldRestart$().subscribe(restart$));
+
+ run(watcher);
+ expect(restart$.isStopped).toBe(true);
+});
+
+it('calls chokidar.watch() with expected arguments', () => {
+ const watcher = new Watcher(defaultOptions);
+ expect(chokidar.watch).not.toHaveBeenCalled();
+ run(watcher);
+ expect(chokidar.watch.mock.calls).toMatchInlineSnapshot(`
+ Array [
+ Array [
+ Array [
+ "foo.js",
+ "bar.js",
+ ],
+ Object {
+ "cwd": "/app/repo",
+ "ignored": Array [
+ /\\^f/,
+ ],
+ },
+ ],
+ ]
+ `);
+});
+
+it('closes chokidar watcher when unsubscribed', () => {
+ const sub = run(new Watcher(defaultOptions));
+ isMock(mockChokidar);
+ expect(mockChokidar.close).not.toHaveBeenCalled();
+ sub.unsubscribe();
+ expect(mockChokidar.close).toHaveBeenCalledTimes(1);
+});
+
+it('rethrows chokidar errors', async () => {
+ const watcher = new Watcher(defaultOptions);
+ const promise = firstValueFrom(watcher.run$.pipe(materialize(), toArray()));
+
+ isMock(mockChokidar);
+ mockChokidar.emit('error', new Error('foo bar'));
+
+ const notifications = await promise;
+ expect(notifications).toMatchInlineSnapshot(`
+ Array [
+ Notification {
+ "error": [Error: foo bar],
+ "hasValue": false,
+ "kind": "E",
+ "value": undefined,
+ },
+ ]
+ `);
+});
+
+it('logs the count of add events after the ready event', () => {
+ run(new Watcher(defaultOptions));
+ isMock(mockChokidar);
+
+ mockChokidar.emit('add');
+ mockChokidar.emit('add');
+ mockChokidar.emit('add');
+ mockChokidar.emit('add');
+ mockChokidar.emit('ready');
+
+ expect(log.messages).toMatchInlineSnapshot(`
+ Array [
+ Object {
+ "args": Array [
+ "watching for changes",
+ "(4 files)",
+ ],
+ "type": "good",
+ },
+ ]
+ `);
+});
+
+it('buffers subsequent changes before logging and notifying serverShouldRestart$', async () => {
+ const watcher = new Watcher(defaultOptions);
+
+ const history: any[] = [];
+ subscriptions.push(
+ watcher
+ .serverShouldRestart$()
+ .pipe(materialize())
+ .subscribe((n) => history.push(n))
+ );
+
+ run(watcher);
+ expect(history).toMatchInlineSnapshot(`Array []`);
+
+ isMock(mockChokidar);
+ mockChokidar.emit('ready');
+ mockChokidar.emit('all', ['add', 'foo.js']);
+ mockChokidar.emit('all', ['add', 'bar.js']);
+ mockChokidar.emit('all', ['delete', 'bar.js']);
+ await new Promise((resolve) => setTimeout(resolve, 1000));
+
+ expect(log.messages).toMatchInlineSnapshot(`
+ Array [
+ Object {
+ "args": Array [
+ "watching for changes",
+ "(0 files)",
+ ],
+ "type": "good",
+ },
+ Object {
+ "args": Array [
+ "restarting server",
+ "due to changes in
+ - \\"foo.js\\"
+ - \\"bar.js\\"",
+ ],
+ "type": "warn",
+ },
+ ]
+ `);
+
+ expect(history).toMatchInlineSnapshot(`
+ Array [
+ Notification {
+ "error": undefined,
+ "hasValue": true,
+ "kind": "N",
+ "value": undefined,
+ },
+ ]
+ `);
+});
diff --git a/src/dev/cli_dev_mode/watcher.ts b/src/dev/cli_dev_mode/watcher.ts
new file mode 100644
index 0000000000000..95cf86d2c332d
--- /dev/null
+++ b/src/dev/cli_dev_mode/watcher.ts
@@ -0,0 +1,122 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import * as Rx from 'rxjs';
+import {
+ map,
+ tap,
+ takeUntil,
+ count,
+ share,
+ buffer,
+ debounceTime,
+ ignoreElements,
+} from 'rxjs/operators';
+import Chokidar from 'chokidar';
+
+import { Log } from './log';
+
+export interface Options {
+ enabled: boolean;
+ log: Log;
+ paths: string[];
+ ignore: Array;
+ cwd: string;
+}
+
+export class Watcher {
+ public readonly enabled: boolean;
+
+ private readonly log: Log;
+ private readonly paths: string[];
+ private readonly ignore: Array;
+ private readonly cwd: string;
+
+ private readonly restart$ = new Rx.Subject();
+
+ constructor(options: Options) {
+ this.enabled = !!options.enabled;
+ this.log = options.log;
+ this.paths = options.paths;
+ this.ignore = options.ignore;
+ this.cwd = options.cwd;
+ }
+
+ run$ = new Rx.Observable((subscriber) => {
+ if (!this.enabled) {
+ this.restart$.complete();
+ subscriber.complete();
+ return;
+ }
+
+ const chokidar = Chokidar.watch(this.paths, {
+ cwd: this.cwd,
+ ignored: this.ignore,
+ });
+
+ subscriber.add(() => {
+ chokidar.close();
+ });
+
+ const error$ = Rx.fromEvent(chokidar, 'error').pipe(
+ map((error) => {
+ throw error;
+ })
+ );
+
+ const init$ = Rx.fromEvent(chokidar, 'add').pipe(
+ takeUntil(Rx.fromEvent(chokidar, 'ready')),
+ count(),
+ tap((fileCount) => {
+ this.log.good('watching for changes', `(${fileCount} files)`);
+ })
+ );
+
+ const change$ = Rx.fromEvent<[string, string]>(chokidar, 'all').pipe(
+ map(([, path]) => path),
+ share()
+ );
+
+ subscriber.add(
+ Rx.merge(
+ error$,
+ Rx.concat(
+ init$,
+ change$.pipe(
+ buffer(change$.pipe(debounceTime(50))),
+ map((changes) => {
+ const paths = Array.from(new Set(changes));
+ const prefix = paths.length > 1 ? '\n - ' : ' ';
+ const fileList = paths.reduce((list, file) => `${list || ''}${prefix}"${file}"`, '');
+
+ this.log.warn(`restarting server`, `due to changes in${fileList}`);
+ this.restart$.next();
+ })
+ )
+ )
+ )
+ .pipe(ignoreElements())
+ .subscribe(subscriber)
+ );
+ });
+
+ serverShouldRestart$() {
+ return this.restart$.asObservable();
+ }
+}
diff --git a/src/legacy/server/kbn_server.js b/src/legacy/server/kbn_server.js
index 85d75b4e18772..14f083acd42c2 100644
--- a/src/legacy/server/kbn_server.js
+++ b/src/legacy/server/kbn_server.js
@@ -122,7 +122,7 @@ export default class KbnServer {
if (process.env.isDevCliChild) {
// help parent process know when we are ready
- process.send(['WORKER_LISTENING']);
+ process.send(['SERVER_LISTENING']);
}
server.log(
diff --git a/src/plugins/dashboard/public/application/__snapshots__/dashboard_empty_screen.test.tsx.snap b/src/plugins/dashboard/public/application/__snapshots__/dashboard_empty_screen.test.tsx.snap
index dac84c87faf97..4fb061ec816ad 100644
--- a/src/plugins/dashboard/public/application/__snapshots__/dashboard_empty_screen.test.tsx.snap
+++ b/src/plugins/dashboard/public/application/__snapshots__/dashboard_empty_screen.test.tsx.snap
@@ -304,7 +304,7 @@ exports[`DashboardEmptyScreen renders correctly with readonly mode 1`] = `
url="/plugins/home/assets/welcome_graphic_light_2x.png"
>
![]()
![]()
{
expect(indexPatterns.refreshFields).toBeCalled();
});
+ test('find', async () => {
+ const search = 'kibana*';
+ const size = 10;
+ await indexPatterns.find('kibana*', size);
+
+ expect(savedObjectsClient.find).lastCalledWith({
+ type: 'index-pattern',
+ fields: ['title'],
+ search,
+ searchFields: ['title'],
+ perPage: size,
+ });
+ });
+
test('createAndSave', async () => {
const title = 'kibana-*';
indexPatterns.createSavedObject = jest.fn();
diff --git a/src/plugins/data/common/index_patterns/lib/index.ts b/src/plugins/data/common/index_patterns/lib/index.ts
index d9eccb6685ded..46dc49a95d204 100644
--- a/src/plugins/data/common/index_patterns/lib/index.ts
+++ b/src/plugins/data/common/index_patterns/lib/index.ts
@@ -19,7 +19,6 @@
export { IndexPatternMissingIndices } from './errors';
export { getTitle } from './get_title';
-export { getFromSavedObject } from './get_from_saved_object';
export { isDefault } from './is_default';
export * from './types';
diff --git a/src/plugins/data/public/index.ts b/src/plugins/data/public/index.ts
index 1c07b4b99e4c0..9eced777a8e36 100644
--- a/src/plugins/data/public/index.ts
+++ b/src/plugins/data/public/index.ts
@@ -235,7 +235,6 @@ import {
ILLEGAL_CHARACTERS,
isDefault,
validateIndexPattern,
- getFromSavedObject,
flattenHitWrapper,
formatHitProvider,
} from './index_patterns';
@@ -252,7 +251,6 @@ export const indexPatterns = {
isFilterable,
isNestedField,
validate: validateIndexPattern,
- getFromSavedObject,
flattenHitWrapper,
formatHitProvider,
};
diff --git a/src/plugins/data/public/index_patterns/index.ts b/src/plugins/data/public/index_patterns/index.ts
index 9cd5e5a4736f1..6c39457599c74 100644
--- a/src/plugins/data/public/index_patterns/index.ts
+++ b/src/plugins/data/public/index_patterns/index.ts
@@ -23,7 +23,6 @@ export {
ILLEGAL_CHARACTERS_VISIBLE,
ILLEGAL_CHARACTERS,
validateIndexPattern,
- getFromSavedObject,
isDefault,
} from '../../common/index_patterns/lib';
export { flattenHitWrapper, formatHitProvider, onRedirectNoIndexPattern } from './index_patterns';
diff --git a/src/plugins/data/public/public.api.md b/src/plugins/data/public/public.api.md
index 339a014b9d731..a0c25c2ce2a38 100644
--- a/src/plugins/data/public/public.api.md
+++ b/src/plugins/data/public/public.api.md
@@ -28,6 +28,7 @@ import { EuiBreadcrumb } from '@elastic/eui';
import { EuiButtonEmptyProps } from '@elastic/eui';
import { EuiComboBoxProps } from '@elastic/eui';
import { EuiConfirmModalProps } from '@elastic/eui';
+import { EuiFlyoutSize } from '@elastic/eui';
import { EuiGlobalToastListToast } from '@elastic/eui';
import { EventEmitter } from 'events';
import { ExclusiveUnion } from '@elastic/eui';
@@ -78,7 +79,6 @@ import { Required } from '@kbn/utility-types';
import * as Rx from 'rxjs';
import { SavedObject } from 'kibana/server';
import { SavedObject as SavedObject_2 } from 'src/core/server';
-import { SavedObject as SavedObject_3 } from 'src/core/public';
import { SavedObjectReference } from 'src/core/types';
import { SavedObjectsClientContract } from 'src/core/public';
import { SavedObjectsFindResponse } from 'kibana/server';
@@ -1336,7 +1336,6 @@ export const indexPatterns: {
isFilterable: typeof isFilterable;
isNestedField: typeof isNestedField;
validate: typeof validateIndexPattern;
- getFromSavedObject: typeof getFromSavedObject;
flattenHitWrapper: typeof flattenHitWrapper;
formatHitProvider: typeof formatHitProvider;
};
@@ -2436,27 +2435,26 @@ export const UI_SETTINGS: {
// src/plugins/data/public/index.ts:178:26 - (ae-forgotten-export) The symbol "StringFormat" needs to be exported by the entry point index.d.ts
// src/plugins/data/public/index.ts:178:26 - (ae-forgotten-export) The symbol "TruncateFormat" needs to be exported by the entry point index.d.ts
// src/plugins/data/public/index.ts:220:23 - (ae-forgotten-export) The symbol "datatableToCSV" needs to be exported by the entry point index.d.ts
-// src/plugins/data/public/index.ts:246:27 - (ae-forgotten-export) The symbol "isFilterable" needs to be exported by the entry point index.d.ts
-// src/plugins/data/public/index.ts:246:27 - (ae-forgotten-export) The symbol "isNestedField" needs to be exported by the entry point index.d.ts
-// src/plugins/data/public/index.ts:246:27 - (ae-forgotten-export) The symbol "validateIndexPattern" needs to be exported by the entry point index.d.ts
-// src/plugins/data/public/index.ts:246:27 - (ae-forgotten-export) The symbol "getFromSavedObject" needs to be exported by the entry point index.d.ts
-// src/plugins/data/public/index.ts:246:27 - (ae-forgotten-export) The symbol "flattenHitWrapper" needs to be exported by the entry point index.d.ts
-// src/plugins/data/public/index.ts:246:27 - (ae-forgotten-export) The symbol "formatHitProvider" needs to be exported by the entry point index.d.ts
-// src/plugins/data/public/index.ts:409:20 - (ae-forgotten-export) The symbol "getRequestInspectorStats" needs to be exported by the entry point index.d.ts
-// src/plugins/data/public/index.ts:409:20 - (ae-forgotten-export) The symbol "getResponseInspectorStats" needs to be exported by the entry point index.d.ts
-// src/plugins/data/public/index.ts:409:20 - (ae-forgotten-export) The symbol "tabifyAggResponse" needs to be exported by the entry point index.d.ts
-// src/plugins/data/public/index.ts:409:20 - (ae-forgotten-export) The symbol "tabifyGetColumns" needs to be exported by the entry point index.d.ts
-// src/plugins/data/public/index.ts:411:1 - (ae-forgotten-export) The symbol "CidrMask" needs to be exported by the entry point index.d.ts
-// src/plugins/data/public/index.ts:412:1 - (ae-forgotten-export) The symbol "dateHistogramInterval" needs to be exported by the entry point index.d.ts
-// src/plugins/data/public/index.ts:421:1 - (ae-forgotten-export) The symbol "InvalidEsCalendarIntervalError" needs to be exported by the entry point index.d.ts
-// src/plugins/data/public/index.ts:422:1 - (ae-forgotten-export) The symbol "InvalidEsIntervalFormatError" needs to be exported by the entry point index.d.ts
-// src/plugins/data/public/index.ts:423:1 - (ae-forgotten-export) The symbol "Ipv4Address" needs to be exported by the entry point index.d.ts
-// src/plugins/data/public/index.ts:424:1 - (ae-forgotten-export) The symbol "isDateHistogramBucketAggConfig" needs to be exported by the entry point index.d.ts
-// src/plugins/data/public/index.ts:428:1 - (ae-forgotten-export) The symbol "isValidEsInterval" needs to be exported by the entry point index.d.ts
-// src/plugins/data/public/index.ts:429:1 - (ae-forgotten-export) The symbol "isValidInterval" needs to be exported by the entry point index.d.ts
-// src/plugins/data/public/index.ts:432:1 - (ae-forgotten-export) The symbol "parseInterval" needs to be exported by the entry point index.d.ts
-// src/plugins/data/public/index.ts:433:1 - (ae-forgotten-export) The symbol "propFilter" needs to be exported by the entry point index.d.ts
-// src/plugins/data/public/index.ts:436:1 - (ae-forgotten-export) The symbol "toAbsoluteDates" needs to be exported by the entry point index.d.ts
+// src/plugins/data/public/index.ts:245:27 - (ae-forgotten-export) The symbol "isFilterable" needs to be exported by the entry point index.d.ts
+// src/plugins/data/public/index.ts:245:27 - (ae-forgotten-export) The symbol "isNestedField" needs to be exported by the entry point index.d.ts
+// src/plugins/data/public/index.ts:245:27 - (ae-forgotten-export) The symbol "validateIndexPattern" needs to be exported by the entry point index.d.ts
+// src/plugins/data/public/index.ts:245:27 - (ae-forgotten-export) The symbol "flattenHitWrapper" needs to be exported by the entry point index.d.ts
+// src/plugins/data/public/index.ts:245:27 - (ae-forgotten-export) The symbol "formatHitProvider" needs to be exported by the entry point index.d.ts
+// src/plugins/data/public/index.ts:407:20 - (ae-forgotten-export) The symbol "getRequestInspectorStats" needs to be exported by the entry point index.d.ts
+// src/plugins/data/public/index.ts:407:20 - (ae-forgotten-export) The symbol "getResponseInspectorStats" needs to be exported by the entry point index.d.ts
+// src/plugins/data/public/index.ts:407:20 - (ae-forgotten-export) The symbol "tabifyAggResponse" needs to be exported by the entry point index.d.ts
+// src/plugins/data/public/index.ts:407:20 - (ae-forgotten-export) The symbol "tabifyGetColumns" needs to be exported by the entry point index.d.ts
+// src/plugins/data/public/index.ts:409:1 - (ae-forgotten-export) The symbol "CidrMask" needs to be exported by the entry point index.d.ts
+// src/plugins/data/public/index.ts:410:1 - (ae-forgotten-export) The symbol "dateHistogramInterval" needs to be exported by the entry point index.d.ts
+// src/plugins/data/public/index.ts:419:1 - (ae-forgotten-export) The symbol "InvalidEsCalendarIntervalError" needs to be exported by the entry point index.d.ts
+// src/plugins/data/public/index.ts:420:1 - (ae-forgotten-export) The symbol "InvalidEsIntervalFormatError" needs to be exported by the entry point index.d.ts
+// src/plugins/data/public/index.ts:421:1 - (ae-forgotten-export) The symbol "Ipv4Address" needs to be exported by the entry point index.d.ts
+// src/plugins/data/public/index.ts:422:1 - (ae-forgotten-export) The symbol "isDateHistogramBucketAggConfig" needs to be exported by the entry point index.d.ts
+// src/plugins/data/public/index.ts:426:1 - (ae-forgotten-export) The symbol "isValidEsInterval" needs to be exported by the entry point index.d.ts
+// src/plugins/data/public/index.ts:427:1 - (ae-forgotten-export) The symbol "isValidInterval" needs to be exported by the entry point index.d.ts
+// src/plugins/data/public/index.ts:430:1 - (ae-forgotten-export) The symbol "parseInterval" needs to be exported by the entry point index.d.ts
+// src/plugins/data/public/index.ts:431:1 - (ae-forgotten-export) The symbol "propFilter" needs to be exported by the entry point index.d.ts
+// src/plugins/data/public/index.ts:434:1 - (ae-forgotten-export) The symbol "toAbsoluteDates" needs to be exported by the entry point index.d.ts
// src/plugins/data/public/query/state_sync/connect_to_query_state.ts:45:5 - (ae-forgotten-export) The symbol "FilterStateStore" needs to be exported by the entry point index.d.ts
// src/plugins/data/public/search/session/session_service.ts:46:5 - (ae-forgotten-export) The symbol "UrlGeneratorStateMapping" needs to be exported by the entry point index.d.ts
diff --git a/src/plugins/data/public/ui/filter_bar/filter_bar.tsx b/src/plugins/data/public/ui/filter_bar/filter_bar.tsx
index 780986e02be93..bc710637b8f84 100644
--- a/src/plugins/data/public/ui/filter_bar/filter_bar.tsx
+++ b/src/plugins/data/public/ui/filter_bar/filter_bar.tsx
@@ -110,7 +110,6 @@ function FilterBarUI(props: Props) {
closePopover={() => setIsAddFilterPopoverOpen(false)}
anchorPosition="downLeft"
panelPaddingSize="none"
- ownFocus={true}
initialFocus=".filterEditor__hiddenItem"
repositionOnScroll
>
diff --git a/src/plugins/data/public/ui/query_string_input/fetch_index_patterns.ts b/src/plugins/data/public/ui/query_string_input/fetch_index_patterns.ts
index 127dc0f1f41d3..7d6b4dd7acaf2 100644
--- a/src/plugins/data/public/ui/query_string_input/fetch_index_patterns.ts
+++ b/src/plugins/data/public/ui/query_string_input/fetch_index_patterns.ts
@@ -17,39 +17,26 @@
* under the License.
*/
import { isEmpty } from 'lodash';
-import { IUiSettingsClient, SavedObjectsClientContract } from 'src/core/public';
-import { indexPatterns, IndexPatternAttributes } from '../..';
+import { IndexPatternsContract } from '../..';
export async function fetchIndexPatterns(
- savedObjectsClient: SavedObjectsClientContract,
- indexPatternStrings: string[],
- uiSettings: IUiSettingsClient
+ indexPatternsService: IndexPatternsContract,
+ indexPatternStrings: string[]
) {
if (!indexPatternStrings || isEmpty(indexPatternStrings)) {
return [];
}
const searchString = indexPatternStrings.map((string) => `"${string}"`).join(' | ');
- const indexPatternsFromSavedObjects = await savedObjectsClient.find({
- type: 'index-pattern',
- fields: ['title', 'fields'],
- search: searchString,
- searchFields: ['title'],
- });
- const exactMatches = indexPatternsFromSavedObjects.savedObjects.filter((savedObject) => {
- return indexPatternStrings.includes(savedObject.attributes.title);
- });
-
- const defaultIndex = uiSettings.get('defaultIndex');
+ const exactMatches = (await indexPatternsService.find(searchString)).filter((ip) =>
+ indexPatternStrings.includes(ip.title)
+ );
const allMatches =
exactMatches.length === indexPatternStrings.length
? exactMatches
- : [
- ...exactMatches,
- await savedObjectsClient.get('index-pattern', defaultIndex),
- ];
+ : [...exactMatches, await indexPatternsService.getDefault()];
- return allMatches.map(indexPatterns.getFromSavedObject);
+ return allMatches;
}
diff --git a/src/plugins/data/public/ui/query_string_input/language_switcher.tsx b/src/plugins/data/public/ui/query_string_input/language_switcher.tsx
index 3957e59388acf..63bf47671a84a 100644
--- a/src/plugins/data/public/ui/query_string_input/language_switcher.tsx
+++ b/src/plugins/data/public/ui/query_string_input/language_switcher.tsx
@@ -71,7 +71,6 @@ export function QueryLanguageSwitcher(props: Props) {
{
});
it('Should accept index pattern strings and fetch the full object', () => {
+ const patternStrings = ['logstash-*'];
mockFetchIndexPatterns.mockClear();
mount(
wrapQueryStringInputInContext({
query: kqlQuery,
onSubmit: noop,
- indexPatterns: ['logstash-*'],
+ indexPatterns: patternStrings,
disableAutoFocus: true,
})
);
-
- expect(mockFetchIndexPatterns).toHaveBeenCalledWith(
- startMock.savedObjects.client,
- ['logstash-*'],
- startMock.uiSettings
- );
+ expect(mockFetchIndexPatterns.mock.calls[0][1]).toStrictEqual(patternStrings);
});
});
diff --git a/src/plugins/data/public/ui/query_string_input/query_string_input.tsx b/src/plugins/data/public/ui/query_string_input/query_string_input.tsx
index a6d22ce3eb473..ad6c60550c01e 100644
--- a/src/plugins/data/public/ui/query_string_input/query_string_input.tsx
+++ b/src/plugins/data/public/ui/query_string_input/query_string_input.tsx
@@ -138,9 +138,8 @@ export default class QueryStringInputUI extends Component {
const currentAbortController = this.fetchIndexPatternsAbortController;
const objectPatternsFromStrings = (await fetchIndexPatterns(
- this.services.savedObjects!.client,
- stringPatterns,
- this.services.uiSettings!
+ this.services.data.indexPatterns,
+ stringPatterns
)) as IIndexPattern[];
if (!currentAbortController.signal.aborted) {
diff --git a/src/plugins/data/public/ui/saved_query_management/saved_query_management_component.tsx b/src/plugins/data/public/ui/saved_query_management/saved_query_management_component.tsx
index 8582f4a12fa38..536a79899c5ee 100644
--- a/src/plugins/data/public/ui/saved_query_management/saved_query_management_component.tsx
+++ b/src/plugins/data/public/ui/saved_query_management/saved_query_management_component.tsx
@@ -206,7 +206,6 @@ export function SavedQueryManagementComponent({
anchorPosition="downLeft"
panelPaddingSize="none"
buffer={-8}
- ownFocus
repositionOnScroll
>
setPopoverIsOpen(false)}
display="block"
panelPaddingSize="s"
- ownFocus
>
diff --git a/src/plugins/discover/public/application/components/sidebar/discover_field.tsx b/src/plugins/discover/public/application/components/sidebar/discover_field.tsx
index c10d1fba5ad62..f95e512dfb66e 100644
--- a/src/plugins/discover/public/application/components/sidebar/discover_field.tsx
+++ b/src/plugins/discover/public/application/components/sidebar/discover_field.tsx
@@ -197,7 +197,6 @@ export function DiscoverField({
return (
{
popover = component.find(EuiPopover);
expect(popover.prop('isOpen')).toBe(false);
});
-
- test('click outside popover should close popover', () => {
- const triggerDocumentMouseDown: EventHandler = (e: ReactMouseEvent) => {
- const event = new Event('mousedown');
- // @ts-ignore
- event.euiGeneratedBy = e.nativeEvent.euiGeneratedBy;
- document.dispatchEvent(event);
- };
- const triggerDocumentMouseUp: EventHandler = (e: ReactMouseEvent) => {
- const event = new Event('mouseup');
- // @ts-ignore
- event.euiGeneratedBy = e.nativeEvent.euiGeneratedBy;
- document.dispatchEvent(event);
- };
- const component = mountWithIntl(
-
-
- );
- const btn = findTestSubject(component, 'toggleFieldFilterButton');
- btn.simulate('click');
- let popover = component.find(EuiPopover);
- expect(popover.length).toBe(1);
- expect(popover.prop('isOpen')).toBe(true);
- component.find('#wrapperId').simulate('mousedown');
- component.find('#wrapperId').simulate('mouseup');
- popover = component.find(EuiPopover);
- expect(popover.prop('isOpen')).toBe(false);
- });
});
diff --git a/src/plugins/discover/public/application/components/table/table.test.tsx b/src/plugins/discover/public/application/components/table/table.test.tsx
index 2874e2483275b..59ab032e6098d 100644
--- a/src/plugins/discover/public/application/components/table/table.test.tsx
+++ b/src/plugins/discover/public/application/components/table/table.test.tsx
@@ -174,18 +174,6 @@ describe('DocViewTable at Discover', () => {
});
}
});
-
- (['noMappingWarning'] as const).forEach((element) => {
- const elementExist = check[element];
-
- if (typeof elementExist === 'boolean') {
- const el = findTestSubject(rowComponent, element);
-
- it(`renders ${element} for '${check._property}' correctly`, () => {
- expect(el.length).toBe(elementExist ? 1 : 0);
- });
- }
- });
});
});
diff --git a/src/plugins/discover/public/application/components/table/table.tsx b/src/plugins/discover/public/application/components/table/table.tsx
index d57447eab9e26..9c136e94a3d2a 100644
--- a/src/plugins/discover/public/application/components/table/table.tsx
+++ b/src/plugins/discover/public/application/components/table/table.tsx
@@ -19,7 +19,7 @@
import React, { useState } from 'react';
import { escapeRegExp } from 'lodash';
import { DocViewTableRow } from './table_row';
-import { arrayContainsObjects, trimAngularSpan } from './table_helper';
+import { trimAngularSpan } from './table_helper';
import { DocViewRenderProps } from '../../doc_views/doc_views_types';
const COLLAPSE_LINE_LENGTH = 350;
@@ -72,11 +72,7 @@ export function DocViewTable({
}
}
: undefined;
- const isArrayOfObjects =
- Array.isArray(flattened[field]) && arrayContainsObjects(flattened[field]);
const displayUnderscoreWarning = !mapping(field) && field.indexOf('_') === 0;
- const displayNoMappingWarning =
- !mapping(field) && !displayUnderscoreWarning && !isArrayOfObjects;
// Discover doesn't flatten arrays of objects, so for documents with an `object` or `nested` field that
// contains an array, Discover will only detect the top level root field. We want to detect when those
@@ -128,7 +124,6 @@ export function DocViewTable({
fieldMapping={mapping(field)}
fieldType={String(fieldType)}
displayUnderscoreWarning={displayUnderscoreWarning}
- displayNoMappingWarning={displayNoMappingWarning}
isCollapsed={isCollapsed}
isCollapsible={isCollapsible}
isColumnActive={Array.isArray(columns) && columns.includes(field)}
diff --git a/src/plugins/discover/public/application/components/table/table_row.tsx b/src/plugins/discover/public/application/components/table/table_row.tsx
index 3ebf3c435916b..e7d663158acc0 100644
--- a/src/plugins/discover/public/application/components/table/table_row.tsx
+++ b/src/plugins/discover/public/application/components/table/table_row.tsx
@@ -24,7 +24,6 @@ import { DocViewTableRowBtnFilterRemove } from './table_row_btn_filter_remove';
import { DocViewTableRowBtnToggleColumn } from './table_row_btn_toggle_column';
import { DocViewTableRowBtnCollapse } from './table_row_btn_collapse';
import { DocViewTableRowBtnFilterExists } from './table_row_btn_filter_exists';
-import { DocViewTableRowIconNoMapping } from './table_row_icon_no_mapping';
import { DocViewTableRowIconUnderscore } from './table_row_icon_underscore';
import { FieldName } from '../field_name/field_name';
@@ -32,7 +31,6 @@ export interface Props {
field: string;
fieldMapping?: FieldMapping;
fieldType: string;
- displayNoMappingWarning: boolean;
displayUnderscoreWarning: boolean;
isCollapsible: boolean;
isColumnActive: boolean;
@@ -48,7 +46,6 @@ export function DocViewTableRow({
field,
fieldMapping,
fieldType,
- displayNoMappingWarning,
displayUnderscoreWarning,
isCollapsible,
isCollapsed,
@@ -80,7 +77,6 @@ export function DocViewTableRow({
Index Patterns page',
- }
- );
- return (
-
{
return (
(
({
+ SavedObjectsUtils: {
+ generateId: () => 'mock-saved-object-id',
+ },
+}));
+
const defaultKibanaIndex = '.kibana';
const unsecuredSavedObjectsClient = savedObjectsClientMock.create();
const scopedClusterClient = elasticsearchServiceMock.createLegacyScopedClusterClient();
const actionExecutor = actionExecutorMock.create();
const authorization = actionsAuthorizationMock.create();
const executionEnqueuer = jest.fn();
-const request = {} as KibanaRequest;
+const request = httpServerMock.createKibanaRequest();
+const auditLogger = auditServiceMock.create().asScoped(request);
const mockTaskManager = taskManagerMock.createSetup();
@@ -68,6 +76,7 @@ beforeEach(() => {
executionEnqueuer,
request,
authorization: (authorization as unknown) as ActionsAuthorization,
+ auditLogger,
});
});
@@ -142,6 +151,95 @@ describe('create()', () => {
});
});
+ describe('auditLogger', () => {
+ test('logs audit event when creating a connector', async () => {
+ const savedObjectCreateResult = {
+ id: '1',
+ type: 'action',
+ attributes: {
+ name: 'my name',
+ actionTypeId: 'my-action-type',
+ config: {},
+ },
+ references: [],
+ };
+ actionTypeRegistry.register({
+ id: savedObjectCreateResult.attributes.actionTypeId,
+ name: 'My action type',
+ minimumLicenseRequired: 'basic',
+ executor,
+ });
+ unsecuredSavedObjectsClient.create.mockResolvedValueOnce(savedObjectCreateResult);
+
+ await actionsClient.create({
+ action: {
+ ...savedObjectCreateResult.attributes,
+ secrets: {},
+ },
+ });
+
+ expect(auditLogger.log).toHaveBeenCalledWith(
+ expect.objectContaining({
+ event: expect.objectContaining({
+ action: 'connector_create',
+ outcome: 'unknown',
+ }),
+ kibana: { saved_object: { id: 'mock-saved-object-id', type: 'action' } },
+ })
+ );
+ });
+
+ test('logs audit event when not authorised to create a connector', async () => {
+ const savedObjectCreateResult = {
+ id: '1',
+ type: 'action',
+ attributes: {
+ name: 'my name',
+ actionTypeId: 'my-action-type',
+ config: {},
+ },
+ references: [],
+ };
+ actionTypeRegistry.register({
+ id: savedObjectCreateResult.attributes.actionTypeId,
+ name: 'My action type',
+ minimumLicenseRequired: 'basic',
+ executor,
+ });
+ unsecuredSavedObjectsClient.create.mockResolvedValueOnce(savedObjectCreateResult);
+
+ authorization.ensureAuthorized.mockRejectedValue(new Error('Unauthorized'));
+
+ await expect(
+ async () =>
+ await actionsClient.create({
+ action: {
+ ...savedObjectCreateResult.attributes,
+ secrets: {},
+ },
+ })
+ ).rejects.toThrow();
+ expect(auditLogger.log).toHaveBeenCalledWith(
+ expect.objectContaining({
+ event: expect.objectContaining({
+ action: 'connector_create',
+ outcome: 'failure',
+ }),
+ kibana: {
+ saved_object: {
+ id: 'mock-saved-object-id',
+ type: 'action',
+ },
+ },
+ error: {
+ code: 'Error',
+ message: 'Unauthorized',
+ },
+ })
+ );
+ });
+ });
+
test('creates an action with all given properties', async () => {
const savedObjectCreateResult = {
id: '1',
@@ -185,6 +283,9 @@ describe('create()', () => {
"name": "my name",
"secrets": Object {},
},
+ Object {
+ "id": "mock-saved-object-id",
+ },
]
`);
});
@@ -289,6 +390,9 @@ describe('create()', () => {
"name": "my name",
"secrets": Object {},
},
+ Object {
+ "id": "mock-saved-object-id",
+ },
]
`);
});
@@ -440,7 +544,7 @@ describe('get()', () => {
expect(authorization.ensureAuthorized).toHaveBeenCalledWith('get');
});
- test('throws when user is not authorised to create the type of action', async () => {
+ test('throws when user is not authorised to get the type of action', async () => {
unsecuredSavedObjectsClient.get.mockResolvedValueOnce({
id: '1',
type: 'type',
@@ -463,7 +567,7 @@ describe('get()', () => {
expect(authorization.ensureAuthorized).toHaveBeenCalledWith('get');
});
- test('throws when user is not authorised to create preconfigured of action', async () => {
+ test('throws when user is not authorised to get preconfigured of action', async () => {
actionsClient = new ActionsClient({
actionTypeRegistry,
unsecuredSavedObjectsClient,
@@ -501,6 +605,61 @@ describe('get()', () => {
});
});
+ describe('auditLogger', () => {
+ test('logs audit event when getting a connector', async () => {
+ unsecuredSavedObjectsClient.get.mockResolvedValueOnce({
+ id: '1',
+ type: 'type',
+ attributes: {
+ name: 'my name',
+ actionTypeId: 'my-action-type',
+ config: {},
+ },
+ references: [],
+ });
+
+ await actionsClient.get({ id: '1' });
+
+ expect(auditLogger.log).toHaveBeenCalledWith(
+ expect.objectContaining({
+ event: expect.objectContaining({
+ action: 'connector_get',
+ outcome: 'success',
+ }),
+ kibana: { saved_object: { id: '1', type: 'action' } },
+ })
+ );
+ });
+
+ test('logs audit event when not authorised to get a connector', async () => {
+ unsecuredSavedObjectsClient.get.mockResolvedValueOnce({
+ id: '1',
+ type: 'type',
+ attributes: {
+ name: 'my name',
+ actionTypeId: 'my-action-type',
+ config: {},
+ },
+ references: [],
+ });
+
+ authorization.ensureAuthorized.mockRejectedValue(new Error('Unauthorized'));
+
+ await expect(actionsClient.get({ id: '1' })).rejects.toThrow();
+
+ expect(auditLogger.log).toHaveBeenCalledWith(
+ expect.objectContaining({
+ event: expect.objectContaining({
+ action: 'connector_get',
+ outcome: 'failure',
+ }),
+ kibana: { saved_object: { id: '1', type: 'action' } },
+ error: { code: 'Error', message: 'Unauthorized' },
+ })
+ );
+ });
+ });
+
test('calls unsecuredSavedObjectsClient with id', async () => {
unsecuredSavedObjectsClient.get.mockResolvedValueOnce({
id: '1',
@@ -632,6 +791,64 @@ describe('getAll()', () => {
});
});
+ describe('auditLogger', () => {
+ test('logs audit event when searching connectors', async () => {
+ unsecuredSavedObjectsClient.find.mockResolvedValueOnce({
+ total: 1,
+ per_page: 10,
+ page: 1,
+ saved_objects: [
+ {
+ id: '1',
+ type: 'type',
+ attributes: {
+ name: 'test',
+ config: {
+ foo: 'bar',
+ },
+ },
+ score: 1,
+ references: [],
+ },
+ ],
+ });
+ scopedClusterClient.callAsInternalUser.mockResolvedValueOnce({
+ aggregations: {
+ '1': { doc_count: 6 },
+ testPreconfigured: { doc_count: 2 },
+ },
+ });
+
+ await actionsClient.getAll();
+
+ expect(auditLogger.log).toHaveBeenCalledWith(
+ expect.objectContaining({
+ event: expect.objectContaining({
+ action: 'connector_find',
+ outcome: 'success',
+ }),
+ kibana: { saved_object: { id: '1', type: 'action' } },
+ })
+ );
+ });
+
+ test('logs audit event when not authorised to search connectors', async () => {
+ authorization.ensureAuthorized.mockRejectedValue(new Error('Unauthorized'));
+
+ await expect(actionsClient.getAll()).rejects.toThrow();
+
+ expect(auditLogger.log).toHaveBeenCalledWith(
+ expect.objectContaining({
+ event: expect.objectContaining({
+ action: 'connector_find',
+ outcome: 'failure',
+ }),
+ error: { code: 'Error', message: 'Unauthorized' },
+ })
+ );
+ });
+ });
+
test('calls unsecuredSavedObjectsClient with parameters', async () => {
const expectedResult = {
total: 1,
@@ -773,6 +990,62 @@ describe('getBulk()', () => {
});
});
+ describe('auditLogger', () => {
+ test('logs audit event when bulk getting connectors', async () => {
+ unsecuredSavedObjectsClient.bulkGet.mockResolvedValueOnce({
+ saved_objects: [
+ {
+ id: '1',
+ type: 'action',
+ attributes: {
+ actionTypeId: 'test',
+ name: 'test',
+ config: {
+ foo: 'bar',
+ },
+ },
+ references: [],
+ },
+ ],
+ });
+ scopedClusterClient.callAsInternalUser.mockResolvedValueOnce({
+ aggregations: {
+ '1': { doc_count: 6 },
+ testPreconfigured: { doc_count: 2 },
+ },
+ });
+
+ await actionsClient.getBulk(['1']);
+
+ expect(auditLogger.log).toHaveBeenCalledWith(
+ expect.objectContaining({
+ event: expect.objectContaining({
+ action: 'connector_get',
+ outcome: 'success',
+ }),
+ kibana: { saved_object: { id: '1', type: 'action' } },
+ })
+ );
+ });
+
+ test('logs audit event when not authorised to bulk get connectors', async () => {
+ authorization.ensureAuthorized.mockRejectedValue(new Error('Unauthorized'));
+
+ await expect(actionsClient.getBulk(['1'])).rejects.toThrow();
+
+ expect(auditLogger.log).toHaveBeenCalledWith(
+ expect.objectContaining({
+ event: expect.objectContaining({
+ action: 'connector_get',
+ outcome: 'failure',
+ }),
+ kibana: { saved_object: { id: '1', type: 'action' } },
+ error: { code: 'Error', message: 'Unauthorized' },
+ })
+ );
+ });
+ });
+
test('calls getBulk unsecuredSavedObjectsClient with parameters', async () => {
unsecuredSavedObjectsClient.bulkGet.mockResolvedValueOnce({
saved_objects: [
@@ -864,6 +1137,39 @@ describe('delete()', () => {
});
});
+ describe('auditLogger', () => {
+ test('logs audit event when deleting a connector', async () => {
+ await actionsClient.delete({ id: '1' });
+
+ expect(auditLogger.log).toHaveBeenCalledWith(
+ expect.objectContaining({
+ event: expect.objectContaining({
+ action: 'connector_delete',
+ outcome: 'unknown',
+ }),
+ kibana: { saved_object: { id: '1', type: 'action' } },
+ })
+ );
+ });
+
+ test('logs audit event when not authorised to delete a connector', async () => {
+ authorization.ensureAuthorized.mockRejectedValue(new Error('Unauthorized'));
+
+ await expect(actionsClient.delete({ id: '1' })).rejects.toThrow();
+
+ expect(auditLogger.log).toHaveBeenCalledWith(
+ expect.objectContaining({
+ event: expect.objectContaining({
+ action: 'connector_delete',
+ outcome: 'failure',
+ }),
+ kibana: { saved_object: { id: '1', type: 'action' } },
+ error: { code: 'Error', message: 'Unauthorized' },
+ })
+ );
+ });
+ });
+
test('calls unsecuredSavedObjectsClient with id', async () => {
const expectedResult = Symbol();
unsecuredSavedObjectsClient.delete.mockResolvedValueOnce(expectedResult);
@@ -880,42 +1186,43 @@ describe('delete()', () => {
});
describe('update()', () => {
+ function updateOperation(): ReturnType {
+ actionTypeRegistry.register({
+ id: 'my-action-type',
+ name: 'My action type',
+ minimumLicenseRequired: 'basic',
+ executor,
+ });
+ unsecuredSavedObjectsClient.get.mockResolvedValueOnce({
+ id: '1',
+ type: 'action',
+ attributes: {
+ actionTypeId: 'my-action-type',
+ },
+ references: [],
+ });
+ unsecuredSavedObjectsClient.create.mockResolvedValueOnce({
+ id: 'my-action',
+ type: 'action',
+ attributes: {
+ actionTypeId: 'my-action-type',
+ name: 'my name',
+ config: {},
+ secrets: {},
+ },
+ references: [],
+ });
+ return actionsClient.update({
+ id: 'my-action',
+ action: {
+ name: 'my name',
+ config: {},
+ secrets: {},
+ },
+ });
+ }
+
describe('authorization', () => {
- function updateOperation(): ReturnType {
- actionTypeRegistry.register({
- id: 'my-action-type',
- name: 'My action type',
- minimumLicenseRequired: 'basic',
- executor,
- });
- unsecuredSavedObjectsClient.get.mockResolvedValueOnce({
- id: '1',
- type: 'action',
- attributes: {
- actionTypeId: 'my-action-type',
- },
- references: [],
- });
- unsecuredSavedObjectsClient.create.mockResolvedValueOnce({
- id: 'my-action',
- type: 'action',
- attributes: {
- actionTypeId: 'my-action-type',
- name: 'my name',
- config: {},
- secrets: {},
- },
- references: [],
- });
- return actionsClient.update({
- id: 'my-action',
- action: {
- name: 'my name',
- config: {},
- secrets: {},
- },
- });
- }
test('ensures user is authorised to update actions', async () => {
await updateOperation();
expect(authorization.ensureAuthorized).toHaveBeenCalledWith('update');
@@ -934,6 +1241,39 @@ describe('update()', () => {
});
});
+ describe('auditLogger', () => {
+ test('logs audit event when updating a connector', async () => {
+ await updateOperation();
+
+ expect(auditLogger.log).toHaveBeenCalledWith(
+ expect.objectContaining({
+ event: expect.objectContaining({
+ action: 'connector_update',
+ outcome: 'unknown',
+ }),
+ kibana: { saved_object: { id: 'my-action', type: 'action' } },
+ })
+ );
+ });
+
+ test('logs audit event when not authorised to update a connector', async () => {
+ authorization.ensureAuthorized.mockRejectedValue(new Error('Unauthorized'));
+
+ await expect(updateOperation()).rejects.toThrow();
+
+ expect(auditLogger.log).toHaveBeenCalledWith(
+ expect.objectContaining({
+ event: expect.objectContaining({
+ action: 'connector_update',
+ outcome: 'failure',
+ }),
+ kibana: { saved_object: { id: 'my-action', type: 'action' } },
+ error: { code: 'Error', message: 'Unauthorized' },
+ })
+ );
+ });
+ });
+
test('updates an action with all given properties', async () => {
actionTypeRegistry.register({
id: 'my-action-type',
diff --git a/x-pack/plugins/actions/server/actions_client.ts b/x-pack/plugins/actions/server/actions_client.ts
index 0d41b520501ad..ab693dc340c92 100644
--- a/x-pack/plugins/actions/server/actions_client.ts
+++ b/x-pack/plugins/actions/server/actions_client.ts
@@ -4,16 +4,19 @@
* you may not use this file except in compliance with the Elastic License.
*/
import Boom from '@hapi/boom';
+
+import { i18n } from '@kbn/i18n';
+import { omitBy, isUndefined } from 'lodash';
import {
ILegacyScopedClusterClient,
SavedObjectsClientContract,
SavedObjectAttributes,
SavedObject,
KibanaRequest,
-} from 'src/core/server';
-
-import { i18n } from '@kbn/i18n';
-import { omitBy, isUndefined } from 'lodash';
+ SavedObjectsUtils,
+} from '../../../../src/core/server';
+import { AuditLogger, EventOutcome } from '../../security/server';
+import { ActionType } from '../common';
import { ActionTypeRegistry } from './action_type_registry';
import { validateConfig, validateSecrets, ActionExecutorContract } from './lib';
import {
@@ -30,11 +33,11 @@ import {
ExecuteOptions as EnqueueExecutionOptions,
} from './create_execute_function';
import { ActionsAuthorization } from './authorization/actions_authorization';
-import { ActionType } from '../common';
import {
getAuthorizationModeBySource,
AuthorizationMode,
} from './authorization/get_authorization_mode_by_source';
+import { connectorAuditEvent, ConnectorAuditAction } from './lib/audit_events';
// We are assuming there won't be many actions. This is why we will load
// all the actions in advance and assume the total count to not go over 10000.
@@ -65,6 +68,7 @@ interface ConstructorOptions {
executionEnqueuer: ExecutionEnqueuer;
request: KibanaRequest;
authorization: ActionsAuthorization;
+ auditLogger?: AuditLogger;
}
interface UpdateOptions {
@@ -82,6 +86,7 @@ export class ActionsClient {
private readonly request: KibanaRequest;
private readonly authorization: ActionsAuthorization;
private readonly executionEnqueuer: ExecutionEnqueuer;
+ private readonly auditLogger?: AuditLogger;
constructor({
actionTypeRegistry,
@@ -93,6 +98,7 @@ export class ActionsClient {
executionEnqueuer,
request,
authorization,
+ auditLogger,
}: ConstructorOptions) {
this.actionTypeRegistry = actionTypeRegistry;
this.unsecuredSavedObjectsClient = unsecuredSavedObjectsClient;
@@ -103,6 +109,7 @@ export class ActionsClient {
this.executionEnqueuer = executionEnqueuer;
this.request = request;
this.authorization = authorization;
+ this.auditLogger = auditLogger;
}
/**
@@ -111,7 +118,20 @@ export class ActionsClient {
public async create({
action: { actionTypeId, name, config, secrets },
}: CreateOptions): Promise {
- await this.authorization.ensureAuthorized('create', actionTypeId);
+ const id = SavedObjectsUtils.generateId();
+
+ try {
+ await this.authorization.ensureAuthorized('create', actionTypeId);
+ } catch (error) {
+ this.auditLogger?.log(
+ connectorAuditEvent({
+ action: ConnectorAuditAction.CREATE,
+ savedObject: { type: 'action', id },
+ error,
+ })
+ );
+ throw error;
+ }
const actionType = this.actionTypeRegistry.get(actionTypeId);
const validatedActionTypeConfig = validateConfig(actionType, config);
@@ -119,12 +139,24 @@ export class ActionsClient {
this.actionTypeRegistry.ensureActionTypeEnabled(actionTypeId);
- const result = await this.unsecuredSavedObjectsClient.create('action', {
- actionTypeId,
- name,
- config: validatedActionTypeConfig as SavedObjectAttributes,
- secrets: validatedActionTypeSecrets as SavedObjectAttributes,
- });
+ this.auditLogger?.log(
+ connectorAuditEvent({
+ action: ConnectorAuditAction.CREATE,
+ savedObject: { type: 'action', id },
+ outcome: EventOutcome.UNKNOWN,
+ })
+ );
+
+ const result = await this.unsecuredSavedObjectsClient.create(
+ 'action',
+ {
+ actionTypeId,
+ name,
+ config: validatedActionTypeConfig as SavedObjectAttributes,
+ secrets: validatedActionTypeSecrets as SavedObjectAttributes,
+ },
+ { id }
+ );
return {
id: result.id,
@@ -139,21 +171,32 @@ export class ActionsClient {
* Update action
*/
public async update({ id, action }: UpdateOptions): Promise {
- await this.authorization.ensureAuthorized('update');
-
- if (
- this.preconfiguredActions.find((preconfiguredAction) => preconfiguredAction.id === id) !==
- undefined
- ) {
- throw new PreconfiguredActionDisabledModificationError(
- i18n.translate('xpack.actions.serverSideErrors.predefinedActionUpdateDisabled', {
- defaultMessage: 'Preconfigured action {id} is not allowed to update.',
- values: {
- id,
- },
- }),
- 'update'
+ try {
+ await this.authorization.ensureAuthorized('update');
+
+ if (
+ this.preconfiguredActions.find((preconfiguredAction) => preconfiguredAction.id === id) !==
+ undefined
+ ) {
+ throw new PreconfiguredActionDisabledModificationError(
+ i18n.translate('xpack.actions.serverSideErrors.predefinedActionUpdateDisabled', {
+ defaultMessage: 'Preconfigured action {id} is not allowed to update.',
+ values: {
+ id,
+ },
+ }),
+ 'update'
+ );
+ }
+ } catch (error) {
+ this.auditLogger?.log(
+ connectorAuditEvent({
+ action: ConnectorAuditAction.UPDATE,
+ savedObject: { type: 'action', id },
+ error,
+ })
);
+ throw error;
}
const {
attributes,
@@ -168,6 +211,14 @@ export class ActionsClient {
this.actionTypeRegistry.ensureActionTypeEnabled(actionTypeId);
+ this.auditLogger?.log(
+ connectorAuditEvent({
+ action: ConnectorAuditAction.UPDATE,
+ savedObject: { type: 'action', id },
+ outcome: EventOutcome.UNKNOWN,
+ })
+ );
+
const result = await this.unsecuredSavedObjectsClient.create(
'action',
{
@@ -201,12 +252,30 @@ export class ActionsClient {
* Get an action
*/
public async get({ id }: { id: string }): Promise {
- await this.authorization.ensureAuthorized('get');
+ try {
+ await this.authorization.ensureAuthorized('get');
+ } catch (error) {
+ this.auditLogger?.log(
+ connectorAuditEvent({
+ action: ConnectorAuditAction.GET,
+ savedObject: { type: 'action', id },
+ error,
+ })
+ );
+ throw error;
+ }
const preconfiguredActionsList = this.preconfiguredActions.find(
(preconfiguredAction) => preconfiguredAction.id === id
);
if (preconfiguredActionsList !== undefined) {
+ this.auditLogger?.log(
+ connectorAuditEvent({
+ action: ConnectorAuditAction.GET,
+ savedObject: { type: 'action', id },
+ })
+ );
+
return {
id,
actionTypeId: preconfiguredActionsList.actionTypeId,
@@ -214,8 +283,16 @@ export class ActionsClient {
isPreconfigured: true,
};
}
+
const result = await this.unsecuredSavedObjectsClient.get('action', id);
+ this.auditLogger?.log(
+ connectorAuditEvent({
+ action: ConnectorAuditAction.GET,
+ savedObject: { type: 'action', id },
+ })
+ );
+
return {
id,
actionTypeId: result.attributes.actionTypeId,
@@ -229,7 +306,17 @@ export class ActionsClient {
* Get all actions with preconfigured list
*/
public async getAll(): Promise {
- await this.authorization.ensureAuthorized('get');
+ try {
+ await this.authorization.ensureAuthorized('get');
+ } catch (error) {
+ this.auditLogger?.log(
+ connectorAuditEvent({
+ action: ConnectorAuditAction.FIND,
+ error,
+ })
+ );
+ throw error;
+ }
const savedObjectsActions = (
await this.unsecuredSavedObjectsClient.find({
@@ -238,6 +325,15 @@ export class ActionsClient {
})
).saved_objects.map(actionFromSavedObject);
+ savedObjectsActions.forEach(({ id }) =>
+ this.auditLogger?.log(
+ connectorAuditEvent({
+ action: ConnectorAuditAction.FIND,
+ savedObject: { type: 'action', id },
+ })
+ )
+ );
+
const mergedResult = [
...savedObjectsActions,
...this.preconfiguredActions.map((preconfiguredAction) => ({
@@ -258,7 +354,20 @@ export class ActionsClient {
* Get bulk actions with preconfigured list
*/
public async getBulk(ids: string[]): Promise {
- await this.authorization.ensureAuthorized('get');
+ try {
+ await this.authorization.ensureAuthorized('get');
+ } catch (error) {
+ ids.forEach((id) =>
+ this.auditLogger?.log(
+ connectorAuditEvent({
+ action: ConnectorAuditAction.GET,
+ savedObject: { type: 'action', id },
+ error,
+ })
+ )
+ );
+ throw error;
+ }
const actionResults = new Array();
for (const actionId of ids) {
@@ -283,6 +392,17 @@ export class ActionsClient {
const bulkGetOpts = actionSavedObjectsIds.map((id) => ({ id, type: 'action' }));
const bulkGetResult = await this.unsecuredSavedObjectsClient.bulkGet(bulkGetOpts);
+ bulkGetResult.saved_objects.forEach(({ id, error }) => {
+ if (!error && this.auditLogger) {
+ this.auditLogger.log(
+ connectorAuditEvent({
+ action: ConnectorAuditAction.GET,
+ savedObject: { type: 'action', id },
+ })
+ );
+ }
+ });
+
for (const action of bulkGetResult.saved_objects) {
if (action.error) {
throw Boom.badRequest(
@@ -298,22 +418,42 @@ export class ActionsClient {
* Delete action
*/
public async delete({ id }: { id: string }) {
- await this.authorization.ensureAuthorized('delete');
-
- if (
- this.preconfiguredActions.find((preconfiguredAction) => preconfiguredAction.id === id) !==
- undefined
- ) {
- throw new PreconfiguredActionDisabledModificationError(
- i18n.translate('xpack.actions.serverSideErrors.predefinedActionDeleteDisabled', {
- defaultMessage: 'Preconfigured action {id} is not allowed to delete.',
- values: {
- id,
- },
- }),
- 'delete'
+ try {
+ await this.authorization.ensureAuthorized('delete');
+
+ if (
+ this.preconfiguredActions.find((preconfiguredAction) => preconfiguredAction.id === id) !==
+ undefined
+ ) {
+ throw new PreconfiguredActionDisabledModificationError(
+ i18n.translate('xpack.actions.serverSideErrors.predefinedActionDeleteDisabled', {
+ defaultMessage: 'Preconfigured action {id} is not allowed to delete.',
+ values: {
+ id,
+ },
+ }),
+ 'delete'
+ );
+ }
+ } catch (error) {
+ this.auditLogger?.log(
+ connectorAuditEvent({
+ action: ConnectorAuditAction.DELETE,
+ savedObject: { type: 'action', id },
+ error,
+ })
);
+ throw error;
}
+
+ this.auditLogger?.log(
+ connectorAuditEvent({
+ action: ConnectorAuditAction.DELETE,
+ outcome: EventOutcome.UNKNOWN,
+ savedObject: { type: 'action', id },
+ })
+ );
+
return await this.unsecuredSavedObjectsClient.delete('action', id);
}
diff --git a/x-pack/plugins/actions/server/lib/audit_events.test.ts b/x-pack/plugins/actions/server/lib/audit_events.test.ts
new file mode 100644
index 0000000000000..6c2fd99c2eafd
--- /dev/null
+++ b/x-pack/plugins/actions/server/lib/audit_events.test.ts
@@ -0,0 +1,93 @@
+/*
+ * 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 { EventOutcome } from '../../../security/server/audit';
+import { ConnectorAuditAction, connectorAuditEvent } from './audit_events';
+
+describe('#connectorAuditEvent', () => {
+ test('creates event with `unknown` outcome', () => {
+ expect(
+ connectorAuditEvent({
+ action: ConnectorAuditAction.CREATE,
+ outcome: EventOutcome.UNKNOWN,
+ savedObject: { type: 'action', id: 'ACTION_ID' },
+ })
+ ).toMatchInlineSnapshot(`
+ Object {
+ "error": undefined,
+ "event": Object {
+ "action": "connector_create",
+ "category": "database",
+ "outcome": "unknown",
+ "type": "creation",
+ },
+ "kibana": Object {
+ "saved_object": Object {
+ "id": "ACTION_ID",
+ "type": "action",
+ },
+ },
+ "message": "User is creating connector [id=ACTION_ID]",
+ }
+ `);
+ });
+
+ test('creates event with `success` outcome', () => {
+ expect(
+ connectorAuditEvent({
+ action: ConnectorAuditAction.CREATE,
+ savedObject: { type: 'action', id: 'ACTION_ID' },
+ })
+ ).toMatchInlineSnapshot(`
+ Object {
+ "error": undefined,
+ "event": Object {
+ "action": "connector_create",
+ "category": "database",
+ "outcome": "success",
+ "type": "creation",
+ },
+ "kibana": Object {
+ "saved_object": Object {
+ "id": "ACTION_ID",
+ "type": "action",
+ },
+ },
+ "message": "User has created connector [id=ACTION_ID]",
+ }
+ `);
+ });
+
+ test('creates event with `failure` outcome', () => {
+ expect(
+ connectorAuditEvent({
+ action: ConnectorAuditAction.CREATE,
+ savedObject: { type: 'action', id: 'ACTION_ID' },
+ error: new Error('ERROR_MESSAGE'),
+ })
+ ).toMatchInlineSnapshot(`
+ Object {
+ "error": Object {
+ "code": "Error",
+ "message": "ERROR_MESSAGE",
+ },
+ "event": Object {
+ "action": "connector_create",
+ "category": "database",
+ "outcome": "failure",
+ "type": "creation",
+ },
+ "kibana": Object {
+ "saved_object": Object {
+ "id": "ACTION_ID",
+ "type": "action",
+ },
+ },
+ "message": "Failed attempt to create connector [id=ACTION_ID]",
+ }
+ `);
+ });
+});
diff --git a/x-pack/plugins/actions/server/lib/audit_events.ts b/x-pack/plugins/actions/server/lib/audit_events.ts
new file mode 100644
index 0000000000000..7d25b5c0cd479
--- /dev/null
+++ b/x-pack/plugins/actions/server/lib/audit_events.ts
@@ -0,0 +1,76 @@
+/*
+ * 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 { AuditEvent, EventOutcome, EventCategory, EventType } from '../../../security/server';
+
+export enum ConnectorAuditAction {
+ CREATE = 'connector_create',
+ GET = 'connector_get',
+ UPDATE = 'connector_update',
+ DELETE = 'connector_delete',
+ FIND = 'connector_find',
+ EXECUTE = 'connector_execute',
+}
+
+type VerbsTuple = [string, string, string];
+
+const eventVerbs: Record = {
+ connector_create: ['create', 'creating', 'created'],
+ connector_get: ['access', 'accessing', 'accessed'],
+ connector_update: ['update', 'updating', 'updated'],
+ connector_delete: ['delete', 'deleting', 'deleted'],
+ connector_find: ['access', 'accessing', 'accessed'],
+ connector_execute: ['execute', 'executing', 'executed'],
+};
+
+const eventTypes: Record = {
+ connector_create: EventType.CREATION,
+ connector_get: EventType.ACCESS,
+ connector_update: EventType.CHANGE,
+ connector_delete: EventType.DELETION,
+ connector_find: EventType.ACCESS,
+ connector_execute: undefined,
+};
+
+export interface ConnectorAuditEventParams {
+ action: ConnectorAuditAction;
+ outcome?: EventOutcome;
+ savedObject?: NonNullable['saved_object'];
+ error?: Error;
+}
+
+export function connectorAuditEvent({
+ action,
+ savedObject,
+ outcome,
+ error,
+}: ConnectorAuditEventParams): AuditEvent {
+ const doc = savedObject ? `connector [id=${savedObject.id}]` : 'a connector';
+ const [present, progressive, past] = eventVerbs[action];
+ const message = error
+ ? `Failed attempt to ${present} ${doc}`
+ : outcome === EventOutcome.UNKNOWN
+ ? `User is ${progressive} ${doc}`
+ : `User has ${past} ${doc}`;
+ const type = eventTypes[action];
+
+ return {
+ message,
+ event: {
+ action,
+ category: EventCategory.DATABASE,
+ type,
+ outcome: outcome ?? (error ? EventOutcome.FAILURE : EventOutcome.SUCCESS),
+ },
+ kibana: {
+ saved_object: savedObject,
+ },
+ error: error && {
+ code: error.name,
+ message: error.message,
+ },
+ };
+}
diff --git a/x-pack/plugins/actions/server/plugin.ts b/x-pack/plugins/actions/server/plugin.ts
index e61936321b8e0..6e37d4bd7a92a 100644
--- a/x-pack/plugins/actions/server/plugin.ts
+++ b/x-pack/plugins/actions/server/plugin.ts
@@ -314,6 +314,7 @@ export class ActionsPlugin implements Plugin, Plugi
isESOUsingEphemeralEncryptionKey: isESOUsingEphemeralEncryptionKey!,
preconfiguredActions,
}),
+ auditLogger: this.security?.audit.asScoped(request),
});
};
@@ -439,6 +440,7 @@ export class ActionsPlugin implements Plugin, Plugi
preconfiguredActions,
actionExecutor,
instantiateAuthorization,
+ security,
} = this;
return async function actionsRouteHandlerContext(context, request) {
@@ -468,6 +470,7 @@ export class ActionsPlugin implements Plugin, Plugi
isESOUsingEphemeralEncryptionKey: isESOUsingEphemeralEncryptionKey!,
preconfiguredActions,
}),
+ auditLogger: security?.audit.asScoped(request),
});
},
listTypes: actionTypeRegistry!.list.bind(actionTypeRegistry!),
diff --git a/x-pack/plugins/alerts/server/alerts_client/alerts_client.ts b/x-pack/plugins/alerts/server/alerts_client/alerts_client.ts
index c83e24c5a45f4..d697817be734b 100644
--- a/x-pack/plugins/alerts/server/alerts_client/alerts_client.ts
+++ b/x-pack/plugins/alerts/server/alerts_client/alerts_client.ts
@@ -13,7 +13,8 @@ import {
SavedObjectReference,
SavedObject,
PluginInitializerContext,
-} from 'src/core/server';
+ SavedObjectsUtils,
+} from '../../../../../src/core/server';
import { esKuery } from '../../../../../src/plugins/data/server';
import { ActionsClient, ActionsAuthorization } from '../../../actions/server';
import {
@@ -44,10 +45,12 @@ import { IEventLogClient } from '../../../../plugins/event_log/server';
import { parseIsoOrRelativeDate } from '../lib/iso_or_relative_date';
import { alertInstanceSummaryFromEventLog } from '../lib/alert_instance_summary_from_event_log';
import { IEvent } from '../../../event_log/server';
+import { AuditLogger, EventOutcome } from '../../../security/server';
import { parseDuration } from '../../common/parse_duration';
import { retryIfConflicts } from '../lib/retry_if_conflicts';
import { partiallyUpdateAlert } from '../saved_objects';
import { markApiKeyForInvalidation } from '../invalidate_pending_api_keys/mark_api_key_for_invalidation';
+import { alertAuditEvent, AlertAuditAction } from './audit_events';
export interface RegistryAlertTypeWithAuth extends RegistryAlertType {
authorizedConsumers: string[];
@@ -75,6 +78,7 @@ export interface ConstructorOptions {
getActionsClient: () => Promise;
getEventLogClient: () => Promise;
kibanaVersion: PluginInitializerContext['env']['packageInfo']['version'];
+ auditLogger?: AuditLogger;
}
export interface MuteOptions extends IndexType {
@@ -176,6 +180,7 @@ export class AlertsClient {
private readonly getEventLogClient: () => Promise;
private readonly encryptedSavedObjectsClient: EncryptedSavedObjectsClient;
private readonly kibanaVersion!: PluginInitializerContext['env']['packageInfo']['version'];
+ private readonly auditLogger?: AuditLogger;
constructor({
alertTypeRegistry,
@@ -192,6 +197,7 @@ export class AlertsClient {
actionsAuthorization,
getEventLogClient,
kibanaVersion,
+ auditLogger,
}: ConstructorOptions) {
this.logger = logger;
this.getUserName = getUserName;
@@ -207,14 +213,28 @@ export class AlertsClient {
this.actionsAuthorization = actionsAuthorization;
this.getEventLogClient = getEventLogClient;
this.kibanaVersion = kibanaVersion;
+ this.auditLogger = auditLogger;
}
public async create({ data, options }: CreateOptions): Promise {
- await this.authorization.ensureAuthorized(
- data.alertTypeId,
- data.consumer,
- WriteOperations.Create
- );
+ const id = SavedObjectsUtils.generateId();
+
+ try {
+ await this.authorization.ensureAuthorized(
+ data.alertTypeId,
+ data.consumer,
+ WriteOperations.Create
+ );
+ } catch (error) {
+ this.auditLogger?.log(
+ alertAuditEvent({
+ action: AlertAuditAction.CREATE,
+ savedObject: { type: 'alert', id },
+ error,
+ })
+ );
+ throw error;
+ }
// Throws an error if alert type isn't registered
const alertType = this.alertTypeRegistry.get(data.alertTypeId);
@@ -248,6 +268,15 @@ export class AlertsClient {
error: null,
},
};
+
+ this.auditLogger?.log(
+ alertAuditEvent({
+ action: AlertAuditAction.CREATE,
+ outcome: EventOutcome.UNKNOWN,
+ savedObject: { type: 'alert', id },
+ })
+ );
+
let createdAlert: SavedObject;
try {
createdAlert = await this.unsecuredSavedObjectsClient.create(
@@ -256,6 +285,7 @@ export class AlertsClient {
{
...options,
references,
+ id,
}
);
} catch (e) {
@@ -297,10 +327,27 @@ export class AlertsClient {
public async get({ id }: { id: string }): Promise {
const result = await this.unsecuredSavedObjectsClient.get('alert', id);
- await this.authorization.ensureAuthorized(
- result.attributes.alertTypeId,
- result.attributes.consumer,
- ReadOperations.Get
+ try {
+ await this.authorization.ensureAuthorized(
+ result.attributes.alertTypeId,
+ result.attributes.consumer,
+ ReadOperations.Get
+ );
+ } catch (error) {
+ this.auditLogger?.log(
+ alertAuditEvent({
+ action: AlertAuditAction.GET,
+ savedObject: { type: 'alert', id },
+ error,
+ })
+ );
+ throw error;
+ }
+ this.auditLogger?.log(
+ alertAuditEvent({
+ action: AlertAuditAction.GET,
+ savedObject: { type: 'alert', id },
+ })
);
return this.getAlertFromRaw(result.id, result.attributes, result.references);
}
@@ -370,11 +417,23 @@ export class AlertsClient {
public async find({
options: { fields, ...options } = {},
}: { options?: FindOptions } = {}): Promise {
+ let authorizationTuple;
+ try {
+ authorizationTuple = await this.authorization.getFindAuthorizationFilter();
+ } catch (error) {
+ this.auditLogger?.log(
+ alertAuditEvent({
+ action: AlertAuditAction.FIND,
+ error,
+ })
+ );
+ throw error;
+ }
const {
filter: authorizationFilter,
ensureAlertTypeIsAuthorized,
logSuccessfulAuthorization,
- } = await this.authorization.getFindAuthorizationFilter();
+ } = authorizationTuple;
const {
page,
@@ -392,7 +451,18 @@ export class AlertsClient {
});
const authorizedData = data.map(({ id, attributes, references }) => {
- ensureAlertTypeIsAuthorized(attributes.alertTypeId, attributes.consumer);
+ try {
+ ensureAlertTypeIsAuthorized(attributes.alertTypeId, attributes.consumer);
+ } catch (error) {
+ this.auditLogger?.log(
+ alertAuditEvent({
+ action: AlertAuditAction.FIND,
+ savedObject: { type: 'alert', id },
+ error,
+ })
+ );
+ throw error;
+ }
return this.getAlertFromRaw(
id,
fields ? (pick(attributes, fields) as RawAlert) : attributes,
@@ -400,6 +470,15 @@ export class AlertsClient {
);
});
+ authorizedData.forEach(({ id }) =>
+ this.auditLogger?.log(
+ alertAuditEvent({
+ action: AlertAuditAction.FIND,
+ savedObject: { type: 'alert', id },
+ })
+ )
+ );
+
logSuccessfulAuthorization();
return {
@@ -473,10 +552,29 @@ export class AlertsClient {
attributes = alert.attributes;
}
- await this.authorization.ensureAuthorized(
- attributes.alertTypeId,
- attributes.consumer,
- WriteOperations.Delete
+ try {
+ await this.authorization.ensureAuthorized(
+ attributes.alertTypeId,
+ attributes.consumer,
+ WriteOperations.Delete
+ );
+ } catch (error) {
+ this.auditLogger?.log(
+ alertAuditEvent({
+ action: AlertAuditAction.DELETE,
+ savedObject: { type: 'alert', id },
+ error,
+ })
+ );
+ throw error;
+ }
+
+ this.auditLogger?.log(
+ alertAuditEvent({
+ action: AlertAuditAction.DELETE,
+ outcome: EventOutcome.UNKNOWN,
+ savedObject: { type: 'alert', id },
+ })
);
const removeResult = await this.unsecuredSavedObjectsClient.delete('alert', id);
@@ -520,10 +618,30 @@ export class AlertsClient {
// Still attempt to load the object using SOC
alertSavedObject = await this.unsecuredSavedObjectsClient.get('alert', id);
}
- await this.authorization.ensureAuthorized(
- alertSavedObject.attributes.alertTypeId,
- alertSavedObject.attributes.consumer,
- WriteOperations.Update
+
+ try {
+ await this.authorization.ensureAuthorized(
+ alertSavedObject.attributes.alertTypeId,
+ alertSavedObject.attributes.consumer,
+ WriteOperations.Update
+ );
+ } catch (error) {
+ this.auditLogger?.log(
+ alertAuditEvent({
+ action: AlertAuditAction.UPDATE,
+ savedObject: { type: 'alert', id },
+ error,
+ })
+ );
+ throw error;
+ }
+
+ this.auditLogger?.log(
+ alertAuditEvent({
+ action: AlertAuditAction.UPDATE,
+ outcome: EventOutcome.UNKNOWN,
+ savedObject: { type: 'alert', id },
+ })
);
const updateResult = await this.updateAlert({ id, data }, alertSavedObject);
@@ -658,14 +776,28 @@ export class AlertsClient {
attributes = alert.attributes;
version = alert.version;
}
- await this.authorization.ensureAuthorized(
- attributes.alertTypeId,
- attributes.consumer,
- WriteOperations.UpdateApiKey
- );
- if (attributes.actions.length && !this.authorization.shouldUseLegacyAuthorization(attributes)) {
- await this.actionsAuthorization.ensureAuthorized('execute');
+ try {
+ await this.authorization.ensureAuthorized(
+ attributes.alertTypeId,
+ attributes.consumer,
+ WriteOperations.UpdateApiKey
+ );
+ if (
+ attributes.actions.length &&
+ !this.authorization.shouldUseLegacyAuthorization(attributes)
+ ) {
+ await this.actionsAuthorization.ensureAuthorized('execute');
+ }
+ } catch (error) {
+ this.auditLogger?.log(
+ alertAuditEvent({
+ action: AlertAuditAction.UPDATE_API_KEY,
+ savedObject: { type: 'alert', id },
+ error,
+ })
+ );
+ throw error;
}
const username = await this.getUserName();
@@ -678,6 +810,15 @@ export class AlertsClient {
updatedAt: new Date().toISOString(),
updatedBy: username,
});
+
+ this.auditLogger?.log(
+ alertAuditEvent({
+ action: AlertAuditAction.UPDATE_API_KEY,
+ outcome: EventOutcome.UNKNOWN,
+ savedObject: { type: 'alert', id },
+ })
+ );
+
try {
await this.unsecuredSavedObjectsClient.update('alert', id, updateAttributes, { version });
} catch (e) {
@@ -732,16 +873,35 @@ export class AlertsClient {
version = alert.version;
}
- await this.authorization.ensureAuthorized(
- attributes.alertTypeId,
- attributes.consumer,
- WriteOperations.Enable
- );
+ try {
+ await this.authorization.ensureAuthorized(
+ attributes.alertTypeId,
+ attributes.consumer,
+ WriteOperations.Enable
+ );
- if (attributes.actions.length) {
- await this.actionsAuthorization.ensureAuthorized('execute');
+ if (attributes.actions.length) {
+ await this.actionsAuthorization.ensureAuthorized('execute');
+ }
+ } catch (error) {
+ this.auditLogger?.log(
+ alertAuditEvent({
+ action: AlertAuditAction.ENABLE,
+ savedObject: { type: 'alert', id },
+ error,
+ })
+ );
+ throw error;
}
+ this.auditLogger?.log(
+ alertAuditEvent({
+ action: AlertAuditAction.ENABLE,
+ outcome: EventOutcome.UNKNOWN,
+ savedObject: { type: 'alert', id },
+ })
+ );
+
if (attributes.enabled === false) {
const username = await this.getUserName();
const updateAttributes = this.updateMeta({
@@ -816,10 +976,29 @@ export class AlertsClient {
version = alert.version;
}
- await this.authorization.ensureAuthorized(
- attributes.alertTypeId,
- attributes.consumer,
- WriteOperations.Disable
+ try {
+ await this.authorization.ensureAuthorized(
+ attributes.alertTypeId,
+ attributes.consumer,
+ WriteOperations.Disable
+ );
+ } catch (error) {
+ this.auditLogger?.log(
+ alertAuditEvent({
+ action: AlertAuditAction.DISABLE,
+ savedObject: { type: 'alert', id },
+ error,
+ })
+ );
+ throw error;
+ }
+
+ this.auditLogger?.log(
+ alertAuditEvent({
+ action: AlertAuditAction.DISABLE,
+ outcome: EventOutcome.UNKNOWN,
+ savedObject: { type: 'alert', id },
+ })
);
if (attributes.enabled === true) {
@@ -866,16 +1045,36 @@ export class AlertsClient {
'alert',
id
);
- await this.authorization.ensureAuthorized(
- attributes.alertTypeId,
- attributes.consumer,
- WriteOperations.MuteAll
- );
- if (attributes.actions.length) {
- await this.actionsAuthorization.ensureAuthorized('execute');
+ try {
+ await this.authorization.ensureAuthorized(
+ attributes.alertTypeId,
+ attributes.consumer,
+ WriteOperations.MuteAll
+ );
+
+ if (attributes.actions.length) {
+ await this.actionsAuthorization.ensureAuthorized('execute');
+ }
+ } catch (error) {
+ this.auditLogger?.log(
+ alertAuditEvent({
+ action: AlertAuditAction.MUTE,
+ savedObject: { type: 'alert', id },
+ error,
+ })
+ );
+ throw error;
}
+ this.auditLogger?.log(
+ alertAuditEvent({
+ action: AlertAuditAction.MUTE,
+ outcome: EventOutcome.UNKNOWN,
+ savedObject: { type: 'alert', id },
+ })
+ );
+
const updateAttributes = this.updateMeta({
muteAll: true,
mutedInstanceIds: [],
@@ -905,16 +1104,36 @@ export class AlertsClient {
'alert',
id
);
- await this.authorization.ensureAuthorized(
- attributes.alertTypeId,
- attributes.consumer,
- WriteOperations.UnmuteAll
- );
- if (attributes.actions.length) {
- await this.actionsAuthorization.ensureAuthorized('execute');
+ try {
+ await this.authorization.ensureAuthorized(
+ attributes.alertTypeId,
+ attributes.consumer,
+ WriteOperations.UnmuteAll
+ );
+
+ if (attributes.actions.length) {
+ await this.actionsAuthorization.ensureAuthorized('execute');
+ }
+ } catch (error) {
+ this.auditLogger?.log(
+ alertAuditEvent({
+ action: AlertAuditAction.UNMUTE,
+ savedObject: { type: 'alert', id },
+ error,
+ })
+ );
+ throw error;
}
+ this.auditLogger?.log(
+ alertAuditEvent({
+ action: AlertAuditAction.UNMUTE,
+ outcome: EventOutcome.UNKNOWN,
+ savedObject: { type: 'alert', id },
+ })
+ );
+
const updateAttributes = this.updateMeta({
muteAll: false,
mutedInstanceIds: [],
@@ -945,16 +1164,35 @@ export class AlertsClient {
alertId
);
- await this.authorization.ensureAuthorized(
- attributes.alertTypeId,
- attributes.consumer,
- WriteOperations.MuteInstance
- );
+ try {
+ await this.authorization.ensureAuthorized(
+ attributes.alertTypeId,
+ attributes.consumer,
+ WriteOperations.MuteInstance
+ );
- if (attributes.actions.length) {
- await this.actionsAuthorization.ensureAuthorized('execute');
+ if (attributes.actions.length) {
+ await this.actionsAuthorization.ensureAuthorized('execute');
+ }
+ } catch (error) {
+ this.auditLogger?.log(
+ alertAuditEvent({
+ action: AlertAuditAction.MUTE_INSTANCE,
+ savedObject: { type: 'alert', id: alertId },
+ error,
+ })
+ );
+ throw error;
}
+ this.auditLogger?.log(
+ alertAuditEvent({
+ action: AlertAuditAction.MUTE_INSTANCE,
+ outcome: EventOutcome.UNKNOWN,
+ savedObject: { type: 'alert', id: alertId },
+ })
+ );
+
const mutedInstanceIds = attributes.mutedInstanceIds || [];
if (!attributes.muteAll && !mutedInstanceIds.includes(alertInstanceId)) {
mutedInstanceIds.push(alertInstanceId);
@@ -991,15 +1229,34 @@ export class AlertsClient {
alertId
);
- await this.authorization.ensureAuthorized(
- attributes.alertTypeId,
- attributes.consumer,
- WriteOperations.UnmuteInstance
- );
- if (attributes.actions.length) {
- await this.actionsAuthorization.ensureAuthorized('execute');
+ try {
+ await this.authorization.ensureAuthorized(
+ attributes.alertTypeId,
+ attributes.consumer,
+ WriteOperations.UnmuteInstance
+ );
+ if (attributes.actions.length) {
+ await this.actionsAuthorization.ensureAuthorized('execute');
+ }
+ } catch (error) {
+ this.auditLogger?.log(
+ alertAuditEvent({
+ action: AlertAuditAction.UNMUTE_INSTANCE,
+ savedObject: { type: 'alert', id: alertId },
+ error,
+ })
+ );
+ throw error;
}
+ this.auditLogger?.log(
+ alertAuditEvent({
+ action: AlertAuditAction.UNMUTE_INSTANCE,
+ outcome: EventOutcome.UNKNOWN,
+ savedObject: { type: 'alert', id: alertId },
+ })
+ );
+
const mutedInstanceIds = attributes.mutedInstanceIds || [];
if (!attributes.muteAll && mutedInstanceIds.includes(alertInstanceId)) {
await this.unsecuredSavedObjectsClient.update(
diff --git a/x-pack/plugins/alerts/server/alerts_client/audit_events.test.ts b/x-pack/plugins/alerts/server/alerts_client/audit_events.test.ts
new file mode 100644
index 0000000000000..9cd48248320c0
--- /dev/null
+++ b/x-pack/plugins/alerts/server/alerts_client/audit_events.test.ts
@@ -0,0 +1,93 @@
+/*
+ * 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 { EventOutcome } from '../../../security/server/audit';
+import { AlertAuditAction, alertAuditEvent } from './audit_events';
+
+describe('#alertAuditEvent', () => {
+ test('creates event with `unknown` outcome', () => {
+ expect(
+ alertAuditEvent({
+ action: AlertAuditAction.CREATE,
+ outcome: EventOutcome.UNKNOWN,
+ savedObject: { type: 'alert', id: 'ALERT_ID' },
+ })
+ ).toMatchInlineSnapshot(`
+ Object {
+ "error": undefined,
+ "event": Object {
+ "action": "alert_create",
+ "category": "database",
+ "outcome": "unknown",
+ "type": "creation",
+ },
+ "kibana": Object {
+ "saved_object": Object {
+ "id": "ALERT_ID",
+ "type": "alert",
+ },
+ },
+ "message": "User is creating alert [id=ALERT_ID]",
+ }
+ `);
+ });
+
+ test('creates event with `success` outcome', () => {
+ expect(
+ alertAuditEvent({
+ action: AlertAuditAction.CREATE,
+ savedObject: { type: 'alert', id: 'ALERT_ID' },
+ })
+ ).toMatchInlineSnapshot(`
+ Object {
+ "error": undefined,
+ "event": Object {
+ "action": "alert_create",
+ "category": "database",
+ "outcome": "success",
+ "type": "creation",
+ },
+ "kibana": Object {
+ "saved_object": Object {
+ "id": "ALERT_ID",
+ "type": "alert",
+ },
+ },
+ "message": "User has created alert [id=ALERT_ID]",
+ }
+ `);
+ });
+
+ test('creates event with `failure` outcome', () => {
+ expect(
+ alertAuditEvent({
+ action: AlertAuditAction.CREATE,
+ savedObject: { type: 'alert', id: 'ALERT_ID' },
+ error: new Error('ERROR_MESSAGE'),
+ })
+ ).toMatchInlineSnapshot(`
+ Object {
+ "error": Object {
+ "code": "Error",
+ "message": "ERROR_MESSAGE",
+ },
+ "event": Object {
+ "action": "alert_create",
+ "category": "database",
+ "outcome": "failure",
+ "type": "creation",
+ },
+ "kibana": Object {
+ "saved_object": Object {
+ "id": "ALERT_ID",
+ "type": "alert",
+ },
+ },
+ "message": "Failed attempt to create alert [id=ALERT_ID]",
+ }
+ `);
+ });
+});
diff --git a/x-pack/plugins/alerts/server/alerts_client/audit_events.ts b/x-pack/plugins/alerts/server/alerts_client/audit_events.ts
new file mode 100644
index 0000000000000..f3e3959824084
--- /dev/null
+++ b/x-pack/plugins/alerts/server/alerts_client/audit_events.ts
@@ -0,0 +1,94 @@
+/*
+ * 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 { AuditEvent, EventOutcome, EventCategory, EventType } from '../../../security/server';
+
+export enum AlertAuditAction {
+ CREATE = 'alert_create',
+ GET = 'alert_get',
+ UPDATE = 'alert_update',
+ UPDATE_API_KEY = 'alert_update_api_key',
+ ENABLE = 'alert_enable',
+ DISABLE = 'alert_disable',
+ DELETE = 'alert_delete',
+ FIND = 'alert_find',
+ MUTE = 'alert_mute',
+ UNMUTE = 'alert_unmute',
+ MUTE_INSTANCE = 'alert_instance_mute',
+ UNMUTE_INSTANCE = 'alert_instance_unmute',
+}
+
+type VerbsTuple = [string, string, string];
+
+const eventVerbs: Record = {
+ alert_create: ['create', 'creating', 'created'],
+ alert_get: ['access', 'accessing', 'accessed'],
+ alert_update: ['update', 'updating', 'updated'],
+ alert_update_api_key: ['update API key of', 'updating API key of', 'updated API key of'],
+ alert_enable: ['enable', 'enabling', 'enabled'],
+ alert_disable: ['disable', 'disabling', 'disabled'],
+ alert_delete: ['delete', 'deleting', 'deleted'],
+ alert_find: ['access', 'accessing', 'accessed'],
+ alert_mute: ['mute', 'muting', 'muted'],
+ alert_unmute: ['unmute', 'unmuting', 'unmuted'],
+ alert_instance_mute: ['mute instance of', 'muting instance of', 'muted instance of'],
+ alert_instance_unmute: ['unmute instance of', 'unmuting instance of', 'unmuted instance of'],
+};
+
+const eventTypes: Record = {
+ alert_create: EventType.CREATION,
+ alert_get: EventType.ACCESS,
+ alert_update: EventType.CHANGE,
+ alert_update_api_key: EventType.CHANGE,
+ alert_enable: EventType.CHANGE,
+ alert_disable: EventType.CHANGE,
+ alert_delete: EventType.DELETION,
+ alert_find: EventType.ACCESS,
+ alert_mute: EventType.CHANGE,
+ alert_unmute: EventType.CHANGE,
+ alert_instance_mute: EventType.CHANGE,
+ alert_instance_unmute: EventType.CHANGE,
+};
+
+export interface AlertAuditEventParams {
+ action: AlertAuditAction;
+ outcome?: EventOutcome;
+ savedObject?: NonNullable['saved_object'];
+ error?: Error;
+}
+
+export function alertAuditEvent({
+ action,
+ savedObject,
+ outcome,
+ error,
+}: AlertAuditEventParams): AuditEvent {
+ const doc = savedObject ? `alert [id=${savedObject.id}]` : 'an alert';
+ const [present, progressive, past] = eventVerbs[action];
+ const message = error
+ ? `Failed attempt to ${present} ${doc}`
+ : outcome === EventOutcome.UNKNOWN
+ ? `User is ${progressive} ${doc}`
+ : `User has ${past} ${doc}`;
+ const type = eventTypes[action];
+
+ return {
+ message,
+ event: {
+ action,
+ category: EventCategory.DATABASE,
+ type,
+ outcome: outcome ?? (error ? EventOutcome.FAILURE : EventOutcome.SUCCESS),
+ },
+ kibana: {
+ saved_object: savedObject,
+ },
+ error: error && {
+ code: error.name,
+ message: error.message,
+ },
+ };
+}
diff --git a/x-pack/plugins/alerts/server/alerts_client/tests/create.test.ts b/x-pack/plugins/alerts/server/alerts_client/tests/create.test.ts
index dcbb33d849405..b943a21ba9bb6 100644
--- a/x-pack/plugins/alerts/server/alerts_client/tests/create.test.ts
+++ b/x-pack/plugins/alerts/server/alerts_client/tests/create.test.ts
@@ -14,15 +14,24 @@ import { actionsAuthorizationMock } from '../../../../actions/server/mocks';
import { AlertsAuthorization } from '../../authorization/alerts_authorization';
import { ActionsAuthorization, ActionsClient } from '../../../../actions/server';
import { TaskStatus } from '../../../../task_manager/server';
+import { auditServiceMock } from '../../../../security/server/audit/index.mock';
+import { httpServerMock } from '../../../../../../src/core/server/mocks';
import { getBeforeSetup, setGlobalDate } from './lib';
import { RecoveredActionGroup } from '../../../common';
+jest.mock('../../../../../../src/core/server/saved_objects/service/lib/utils', () => ({
+ SavedObjectsUtils: {
+ generateId: () => 'mock-saved-object-id',
+ },
+}));
+
const taskManager = taskManagerMock.createStart();
const alertTypeRegistry = alertTypeRegistryMock.create();
const unsecuredSavedObjectsClient = savedObjectsClientMock.create();
const encryptedSavedObjects = encryptedSavedObjectsMock.createClient();
const authorization = alertsAuthorizationMock.create();
const actionsAuthorization = actionsAuthorizationMock.create();
+const auditLogger = auditServiceMock.create().asScoped(httpServerMock.createKibanaRequest());
const kibanaVersion = 'v7.10.0';
const alertsClientParams: jest.Mocked = {
@@ -40,10 +49,12 @@ const alertsClientParams: jest.Mocked = {
getActionsClient: jest.fn(),
getEventLogClient: jest.fn(),
kibanaVersion,
+ auditLogger,
};
beforeEach(() => {
getBeforeSetup(alertsClientParams, taskManager, alertTypeRegistry);
+ (auditLogger.log as jest.Mock).mockClear();
});
setGlobalDate();
@@ -185,6 +196,62 @@ describe('create()', () => {
});
});
+ describe('auditLogger', () => {
+ test('logs audit event when creating an alert', async () => {
+ const data = getMockData({
+ enabled: false,
+ actions: [],
+ });
+ unsecuredSavedObjectsClient.create.mockResolvedValueOnce({
+ id: '1',
+ type: 'alert',
+ attributes: data,
+ references: [],
+ });
+ await alertsClient.create({ data });
+ expect(auditLogger.log).toHaveBeenCalledWith(
+ expect.objectContaining({
+ event: expect.objectContaining({
+ action: 'alert_create',
+ outcome: 'unknown',
+ }),
+ kibana: { saved_object: { id: 'mock-saved-object-id', type: 'alert' } },
+ })
+ );
+ });
+
+ test('logs audit event when not authorised to create an alert', async () => {
+ authorization.ensureAuthorized.mockRejectedValue(new Error('Unauthorized'));
+
+ await expect(
+ alertsClient.create({
+ data: getMockData({
+ enabled: false,
+ actions: [],
+ }),
+ })
+ ).rejects.toThrow();
+ expect(auditLogger.log).toHaveBeenCalledWith(
+ expect.objectContaining({
+ event: expect.objectContaining({
+ action: 'alert_create',
+ outcome: 'failure',
+ }),
+ kibana: {
+ saved_object: {
+ id: 'mock-saved-object-id',
+ type: 'alert',
+ },
+ },
+ error: {
+ code: 'Error',
+ message: 'Unauthorized',
+ },
+ })
+ );
+ });
+ });
+
test('creates an alert', async () => {
const data = getMockData();
const createdAttributes = {
@@ -337,16 +404,17 @@ describe('create()', () => {
}
`);
expect(unsecuredSavedObjectsClient.create.mock.calls[0][2]).toMatchInlineSnapshot(`
- Object {
- "references": Array [
- Object {
- "id": "1",
- "name": "action_0",
- "type": "action",
- },
- ],
- }
- `);
+ Object {
+ "id": "mock-saved-object-id",
+ "references": Array [
+ Object {
+ "id": "1",
+ "name": "action_0",
+ "type": "action",
+ },
+ ],
+ }
+ `);
expect(taskManager.schedule).toHaveBeenCalledTimes(1);
expect(taskManager.schedule.mock.calls[0]).toMatchInlineSnapshot(`
Array [
@@ -991,6 +1059,7 @@ describe('create()', () => {
},
},
{
+ id: 'mock-saved-object-id',
references: [
{
id: '1',
@@ -1113,6 +1182,7 @@ describe('create()', () => {
},
},
{
+ id: 'mock-saved-object-id',
references: [
{
id: '1',
diff --git a/x-pack/plugins/alerts/server/alerts_client/tests/delete.test.ts b/x-pack/plugins/alerts/server/alerts_client/tests/delete.test.ts
index e7b975aec8eb0..a7ef008eaa2ee 100644
--- a/x-pack/plugins/alerts/server/alerts_client/tests/delete.test.ts
+++ b/x-pack/plugins/alerts/server/alerts_client/tests/delete.test.ts
@@ -12,6 +12,8 @@ import { encryptedSavedObjectsMock } from '../../../../encrypted_saved_objects/s
import { actionsAuthorizationMock } from '../../../../actions/server/mocks';
import { AlertsAuthorization } from '../../authorization/alerts_authorization';
import { ActionsAuthorization } from '../../../../actions/server';
+import { httpServerMock } from '../../../../../../src/core/server/mocks';
+import { auditServiceMock } from '../../../../security/server/audit/index.mock';
import { getBeforeSetup } from './lib';
const taskManager = taskManagerMock.createStart();
@@ -20,6 +22,7 @@ const unsecuredSavedObjectsClient = savedObjectsClientMock.create();
const encryptedSavedObjects = encryptedSavedObjectsMock.createClient();
const authorization = alertsAuthorizationMock.create();
const actionsAuthorization = actionsAuthorizationMock.create();
+const auditLogger = auditServiceMock.create().asScoped(httpServerMock.createKibanaRequest());
const kibanaVersion = 'v7.10.0';
const alertsClientParams: jest.Mocked = {
@@ -37,10 +40,12 @@ const alertsClientParams: jest.Mocked = {
getActionsClient: jest.fn(),
getEventLogClient: jest.fn(),
kibanaVersion,
+ auditLogger,
};
beforeEach(() => {
getBeforeSetup(alertsClientParams, taskManager, alertTypeRegistry);
+ (auditLogger.log as jest.Mock).mockClear();
});
describe('delete()', () => {
@@ -239,4 +244,43 @@ describe('delete()', () => {
expect(authorization.ensureAuthorized).toHaveBeenCalledWith('myType', 'myApp', 'delete');
});
});
+
+ describe('auditLogger', () => {
+ test('logs audit event when deleting an alert', async () => {
+ await alertsClient.delete({ id: '1' });
+ expect(auditLogger.log).toHaveBeenCalledWith(
+ expect.objectContaining({
+ event: expect.objectContaining({
+ action: 'alert_delete',
+ outcome: 'unknown',
+ }),
+ kibana: { saved_object: { id: '1', type: 'alert' } },
+ })
+ );
+ });
+
+ test('logs audit event when not authorised to delete an alert', async () => {
+ authorization.ensureAuthorized.mockRejectedValue(new Error('Unauthorized'));
+
+ await expect(alertsClient.delete({ id: '1' })).rejects.toThrow();
+ expect(auditLogger.log).toHaveBeenCalledWith(
+ expect.objectContaining({
+ event: expect.objectContaining({
+ action: 'alert_delete',
+ outcome: 'failure',
+ }),
+ kibana: {
+ saved_object: {
+ id: '1',
+ type: 'alert',
+ },
+ },
+ error: {
+ code: 'Error',
+ message: 'Unauthorized',
+ },
+ })
+ );
+ });
+ });
});
diff --git a/x-pack/plugins/alerts/server/alerts_client/tests/disable.test.ts b/x-pack/plugins/alerts/server/alerts_client/tests/disable.test.ts
index 8c9ab9494a50a..ce0688a5ab2ff 100644
--- a/x-pack/plugins/alerts/server/alerts_client/tests/disable.test.ts
+++ b/x-pack/plugins/alerts/server/alerts_client/tests/disable.test.ts
@@ -12,16 +12,18 @@ import { encryptedSavedObjectsMock } from '../../../../encrypted_saved_objects/s
import { actionsAuthorizationMock } from '../../../../actions/server/mocks';
import { AlertsAuthorization } from '../../authorization/alerts_authorization';
import { ActionsAuthorization } from '../../../../actions/server';
-import { getBeforeSetup, setGlobalDate } from './lib';
import { InvalidatePendingApiKey } from '../../types';
+import { httpServerMock } from '../../../../../../src/core/server/mocks';
+import { auditServiceMock } from '../../../../security/server/audit/index.mock';
+import { getBeforeSetup, setGlobalDate } from './lib';
const taskManager = taskManagerMock.createStart();
const alertTypeRegistry = alertTypeRegistryMock.create();
const unsecuredSavedObjectsClient = savedObjectsClientMock.create();
-
const encryptedSavedObjects = encryptedSavedObjectsMock.createClient();
const authorization = alertsAuthorizationMock.create();
const actionsAuthorization = actionsAuthorizationMock.create();
+const auditLogger = auditServiceMock.create().asScoped(httpServerMock.createKibanaRequest());
const kibanaVersion = 'v7.10.0';
const alertsClientParams: jest.Mocked = {
@@ -39,10 +41,12 @@ const alertsClientParams: jest.Mocked = {
getActionsClient: jest.fn(),
getEventLogClient: jest.fn(),
kibanaVersion,
+ auditLogger,
};
beforeEach(() => {
getBeforeSetup(alertsClientParams, taskManager, alertTypeRegistry);
+ (auditLogger.log as jest.Mock).mockClear();
});
setGlobalDate();
@@ -109,6 +113,45 @@ describe('disable()', () => {
});
});
+ describe('auditLogger', () => {
+ test('logs audit event when disabling an alert', async () => {
+ await alertsClient.disable({ id: '1' });
+ expect(auditLogger.log).toHaveBeenCalledWith(
+ expect.objectContaining({
+ event: expect.objectContaining({
+ action: 'alert_disable',
+ outcome: 'unknown',
+ }),
+ kibana: { saved_object: { id: '1', type: 'alert' } },
+ })
+ );
+ });
+
+ test('logs audit event when not authorised to disable an alert', async () => {
+ authorization.ensureAuthorized.mockRejectedValue(new Error('Unauthorized'));
+
+ await expect(alertsClient.disable({ id: '1' })).rejects.toThrow();
+ expect(auditLogger.log).toHaveBeenCalledWith(
+ expect.objectContaining({
+ event: expect.objectContaining({
+ action: 'alert_disable',
+ outcome: 'failure',
+ }),
+ kibana: {
+ saved_object: {
+ id: '1',
+ type: 'alert',
+ },
+ },
+ error: {
+ code: 'Error',
+ message: 'Unauthorized',
+ },
+ })
+ );
+ });
+ });
+
test('disables an alert', async () => {
unsecuredSavedObjectsClient.create.mockResolvedValueOnce({
id: '1',
diff --git a/x-pack/plugins/alerts/server/alerts_client/tests/enable.test.ts b/x-pack/plugins/alerts/server/alerts_client/tests/enable.test.ts
index feec1d1b9334a..daac6689a183b 100644
--- a/x-pack/plugins/alerts/server/alerts_client/tests/enable.test.ts
+++ b/x-pack/plugins/alerts/server/alerts_client/tests/enable.test.ts
@@ -13,16 +13,18 @@ import { actionsAuthorizationMock } from '../../../../actions/server/mocks';
import { AlertsAuthorization } from '../../authorization/alerts_authorization';
import { ActionsAuthorization } from '../../../../actions/server';
import { TaskStatus } from '../../../../task_manager/server';
-import { getBeforeSetup, setGlobalDate } from './lib';
+import { httpServerMock } from '../../../../../../src/core/server/mocks';
+import { auditServiceMock } from '../../../../security/server/audit/index.mock';
import { InvalidatePendingApiKey } from '../../types';
+import { getBeforeSetup, setGlobalDate } from './lib';
const taskManager = taskManagerMock.createStart();
const alertTypeRegistry = alertTypeRegistryMock.create();
const unsecuredSavedObjectsClient = savedObjectsClientMock.create();
-
const encryptedSavedObjects = encryptedSavedObjectsMock.createClient();
const authorization = alertsAuthorizationMock.create();
const actionsAuthorization = actionsAuthorizationMock.create();
+const auditLogger = auditServiceMock.create().asScoped(httpServerMock.createKibanaRequest());
const kibanaVersion = 'v7.10.0';
const alertsClientParams: jest.Mocked = {
@@ -40,10 +42,12 @@ const alertsClientParams: jest.Mocked = {
getActionsClient: jest.fn(),
getEventLogClient: jest.fn(),
kibanaVersion,
+ auditLogger,
};
beforeEach(() => {
getBeforeSetup(alertsClientParams, taskManager, alertTypeRegistry);
+ (auditLogger.log as jest.Mock).mockClear();
});
setGlobalDate();
@@ -148,6 +152,45 @@ describe('enable()', () => {
});
});
+ describe('auditLogger', () => {
+ test('logs audit event when enabling an alert', async () => {
+ await alertsClient.enable({ id: '1' });
+ expect(auditLogger.log).toHaveBeenCalledWith(
+ expect.objectContaining({
+ event: expect.objectContaining({
+ action: 'alert_enable',
+ outcome: 'unknown',
+ }),
+ kibana: { saved_object: { id: '1', type: 'alert' } },
+ })
+ );
+ });
+
+ test('logs audit event when not authorised to enable an alert', async () => {
+ authorization.ensureAuthorized.mockRejectedValue(new Error('Unauthorized'));
+
+ await expect(alertsClient.enable({ id: '1' })).rejects.toThrow();
+ expect(auditLogger.log).toHaveBeenCalledWith(
+ expect.objectContaining({
+ event: expect.objectContaining({
+ action: 'alert_enable',
+ outcome: 'failure',
+ }),
+ kibana: {
+ saved_object: {
+ id: '1',
+ type: 'alert',
+ },
+ },
+ error: {
+ code: 'Error',
+ message: 'Unauthorized',
+ },
+ })
+ );
+ });
+ });
+
test('enables an alert', async () => {
const createdAt = new Date().toISOString();
unsecuredSavedObjectsClient.create.mockResolvedValueOnce({
diff --git a/x-pack/plugins/alerts/server/alerts_client/tests/find.test.ts b/x-pack/plugins/alerts/server/alerts_client/tests/find.test.ts
index 336cb536d702b..232d48e258256 100644
--- a/x-pack/plugins/alerts/server/alerts_client/tests/find.test.ts
+++ b/x-pack/plugins/alerts/server/alerts_client/tests/find.test.ts
@@ -14,16 +14,18 @@ import { encryptedSavedObjectsMock } from '../../../../encrypted_saved_objects/s
import { actionsAuthorizationMock } from '../../../../actions/server/mocks';
import { AlertsAuthorization } from '../../authorization/alerts_authorization';
import { ActionsAuthorization } from '../../../../actions/server';
+import { httpServerMock } from '../../../../../../src/core/server/mocks';
+import { auditServiceMock } from '../../../../security/server/audit/index.mock';
import { getBeforeSetup, setGlobalDate } from './lib';
import { RecoveredActionGroup } from '../../../common';
const taskManager = taskManagerMock.createStart();
const alertTypeRegistry = alertTypeRegistryMock.create();
const unsecuredSavedObjectsClient = savedObjectsClientMock.create();
-
const encryptedSavedObjects = encryptedSavedObjectsMock.createClient();
const authorization = alertsAuthorizationMock.create();
const actionsAuthorization = actionsAuthorizationMock.create();
+const auditLogger = auditServiceMock.create().asScoped(httpServerMock.createKibanaRequest());
const kibanaVersion = 'v7.10.0';
const alertsClientParams: jest.Mocked = {
@@ -45,6 +47,7 @@ const alertsClientParams: jest.Mocked = {
beforeEach(() => {
getBeforeSetup(alertsClientParams, taskManager, alertTypeRegistry);
+ (auditLogger.log as jest.Mock).mockClear();
});
setGlobalDate();
@@ -251,4 +254,64 @@ describe('find()', () => {
expect(logSuccessfulAuthorization).toHaveBeenCalled();
});
});
+
+ describe('auditLogger', () => {
+ test('logs audit event when searching alerts', async () => {
+ const alertsClient = new AlertsClient({ ...alertsClientParams, auditLogger });
+ await alertsClient.find();
+ expect(auditLogger.log).toHaveBeenCalledWith(
+ expect.objectContaining({
+ event: expect.objectContaining({
+ action: 'alert_find',
+ outcome: 'success',
+ }),
+ kibana: { saved_object: { id: '1', type: 'alert' } },
+ })
+ );
+ });
+
+ test('logs audit event when not authorised to search alerts', async () => {
+ const alertsClient = new AlertsClient({ ...alertsClientParams, auditLogger });
+ authorization.getFindAuthorizationFilter.mockRejectedValue(new Error('Unauthorized'));
+
+ await expect(alertsClient.find()).rejects.toThrow();
+ expect(auditLogger.log).toHaveBeenCalledWith(
+ expect.objectContaining({
+ event: expect.objectContaining({
+ action: 'alert_find',
+ outcome: 'failure',
+ }),
+ error: {
+ code: 'Error',
+ message: 'Unauthorized',
+ },
+ })
+ );
+ });
+
+ test('logs audit event when not authorised to search alert type', async () => {
+ const alertsClient = new AlertsClient({ ...alertsClientParams, auditLogger });
+ authorization.getFindAuthorizationFilter.mockResolvedValue({
+ ensureAlertTypeIsAuthorized: jest.fn(() => {
+ throw new Error('Unauthorized');
+ }),
+ logSuccessfulAuthorization: jest.fn(),
+ });
+
+ await expect(async () => await alertsClient.find()).rejects.toThrow();
+ expect(auditLogger.log).toHaveBeenCalledWith(
+ expect.objectContaining({
+ event: expect.objectContaining({
+ action: 'alert_find',
+ outcome: 'failure',
+ }),
+ kibana: { saved_object: { id: '1', type: 'alert' } },
+ error: {
+ code: 'Error',
+ message: 'Unauthorized',
+ },
+ })
+ );
+ });
+ });
});
diff --git a/x-pack/plugins/alerts/server/alerts_client/tests/get.test.ts b/x-pack/plugins/alerts/server/alerts_client/tests/get.test.ts
index 3f0c783f424d1..32ac57459795e 100644
--- a/x-pack/plugins/alerts/server/alerts_client/tests/get.test.ts
+++ b/x-pack/plugins/alerts/server/alerts_client/tests/get.test.ts
@@ -12,15 +12,17 @@ import { encryptedSavedObjectsMock } from '../../../../encrypted_saved_objects/s
import { actionsAuthorizationMock } from '../../../../actions/server/mocks';
import { AlertsAuthorization } from '../../authorization/alerts_authorization';
import { ActionsAuthorization } from '../../../../actions/server';
+import { httpServerMock } from '../../../../../../src/core/server/mocks';
+import { auditServiceMock } from '../../../../security/server/audit/index.mock';
import { getBeforeSetup, setGlobalDate } from './lib';
const taskManager = taskManagerMock.createStart();
const alertTypeRegistry = alertTypeRegistryMock.create();
const unsecuredSavedObjectsClient = savedObjectsClientMock.create();
-
const encryptedSavedObjects = encryptedSavedObjectsMock.createClient();
const authorization = alertsAuthorizationMock.create();
const actionsAuthorization = actionsAuthorizationMock.create();
+const auditLogger = auditServiceMock.create().asScoped(httpServerMock.createKibanaRequest());
const kibanaVersion = 'v7.10.0';
const alertsClientParams: jest.Mocked = {
@@ -42,6 +44,7 @@ const alertsClientParams: jest.Mocked = {
beforeEach(() => {
getBeforeSetup(alertsClientParams, taskManager, alertTypeRegistry);
+ (auditLogger.log as jest.Mock).mockClear();
});
setGlobalDate();
@@ -191,4 +194,61 @@ describe('get()', () => {
expect(authorization.ensureAuthorized).toHaveBeenCalledWith('myType', 'myApp', 'get');
});
});
+
+ describe('auditLogger', () => {
+ beforeEach(() => {
+ unsecuredSavedObjectsClient.get.mockResolvedValueOnce({
+ id: '1',
+ type: 'alert',
+ attributes: {
+ alertTypeId: '123',
+ schedule: { interval: '10s' },
+ params: {
+ bar: true,
+ },
+ actions: [],
+ },
+ references: [],
+ });
+ });
+
+ test('logs audit event when getting an alert', async () => {
+ const alertsClient = new AlertsClient({ ...alertsClientParams, auditLogger });
+ await alertsClient.get({ id: '1' });
+ expect(auditLogger.log).toHaveBeenCalledWith(
+ expect.objectContaining({
+ event: expect.objectContaining({
+ action: 'alert_get',
+ outcome: 'success',
+ }),
+ kibana: { saved_object: { id: '1', type: 'alert' } },
+ })
+ );
+ });
+
+ test('logs audit event when not authorised to get an alert', async () => {
+ const alertsClient = new AlertsClient({ ...alertsClientParams, auditLogger });
+ authorization.ensureAuthorized.mockRejectedValue(new Error('Unauthorized'));
+
+ await expect(alertsClient.get({ id: '1' })).rejects.toThrow();
+ expect(auditLogger.log).toHaveBeenCalledWith(
+ expect.objectContaining({
+ event: expect.objectContaining({
+ action: 'alert_get',
+ outcome: 'failure',
+ }),
+ kibana: {
+ saved_object: {
+ id: '1',
+ type: 'alert',
+ },
+ },
+ error: {
+ code: 'Error',
+ message: 'Unauthorized',
+ },
+ })
+ );
+ });
+ });
});
diff --git a/x-pack/plugins/alerts/server/alerts_client/tests/mute_all.test.ts b/x-pack/plugins/alerts/server/alerts_client/tests/mute_all.test.ts
index 14ebca2135587..b3c3e1bdd2ede 100644
--- a/x-pack/plugins/alerts/server/alerts_client/tests/mute_all.test.ts
+++ b/x-pack/plugins/alerts/server/alerts_client/tests/mute_all.test.ts
@@ -12,6 +12,8 @@ import { encryptedSavedObjectsMock } from '../../../../encrypted_saved_objects/s
import { actionsAuthorizationMock } from '../../../../actions/server/mocks';
import { AlertsAuthorization } from '../../authorization/alerts_authorization';
import { ActionsAuthorization } from '../../../../actions/server';
+import { httpServerMock } from '../../../../../../src/core/server/mocks';
+import { auditServiceMock } from '../../../../security/server/audit/index.mock';
import { getBeforeSetup, setGlobalDate } from './lib';
const taskManager = taskManagerMock.createStart();
@@ -20,6 +22,7 @@ const unsecuredSavedObjectsClient = savedObjectsClientMock.create();
const encryptedSavedObjects = encryptedSavedObjectsMock.createClient();
const authorization = alertsAuthorizationMock.create();
const actionsAuthorization = actionsAuthorizationMock.create();
+const auditLogger = auditServiceMock.create().asScoped(httpServerMock.createKibanaRequest());
const kibanaVersion = 'v7.10.0';
const alertsClientParams: jest.Mocked = {
@@ -41,6 +44,7 @@ const alertsClientParams: jest.Mocked = {
beforeEach(() => {
getBeforeSetup(alertsClientParams, taskManager, alertTypeRegistry);
+ (auditLogger.log as jest.Mock).mockClear();
});
setGlobalDate();
@@ -137,4 +141,85 @@ describe('muteAll()', () => {
expect(authorization.ensureAuthorized).toHaveBeenCalledWith('myType', 'myApp', 'muteAll');
});
});
+
+ describe('auditLogger', () => {
+ test('logs audit event when muting an alert', async () => {
+ const alertsClient = new AlertsClient({ ...alertsClientParams, auditLogger });
+ unsecuredSavedObjectsClient.get.mockResolvedValueOnce({
+ id: '1',
+ type: 'alert',
+ attributes: {
+ actions: [
+ {
+ group: 'default',
+ id: '1',
+ actionTypeId: '1',
+ actionRef: '1',
+ params: {
+ foo: true,
+ },
+ },
+ ],
+ muteAll: false,
+ },
+ references: [],
+ version: '123',
+ });
+ await alertsClient.muteAll({ id: '1' });
+ expect(auditLogger.log).toHaveBeenCalledWith(
+ expect.objectContaining({
+ event: expect.objectContaining({
+ action: 'alert_mute',
+ outcome: 'unknown',
+ }),
+ kibana: { saved_object: { id: '1', type: 'alert' } },
+ })
+ );
+ });
+
+ test('logs audit event when not authorised to mute an alert', async () => {
+ const alertsClient = new AlertsClient({ ...alertsClientParams, auditLogger });
+ unsecuredSavedObjectsClient.get.mockResolvedValueOnce({
+ id: '1',
+ type: 'alert',
+ attributes: {
+ actions: [
+ {
+ group: 'default',
+ id: '1',
+ actionTypeId: '1',
+ actionRef: '1',
+ params: {
+ foo: true,
+ },
+ },
+ ],
+ muteAll: false,
+ },
+ references: [],
+ version: '123',
+ });
+ authorization.ensureAuthorized.mockRejectedValue(new Error('Unauthorized'));
+
+ await expect(alertsClient.muteAll({ id: '1' })).rejects.toThrow();
+ expect(auditLogger.log).toHaveBeenCalledWith(
+ expect.objectContaining({
+ event: expect.objectContaining({
+ action: 'alert_mute',
+ outcome: 'failure',
+ }),
+ kibana: {
+ saved_object: {
+ id: '1',
+ type: 'alert',
+ },
+ },
+ error: {
+ code: 'Error',
+ message: 'Unauthorized',
+ },
+ })
+ );
+ });
+ });
});
diff --git a/x-pack/plugins/alerts/server/alerts_client/tests/mute_instance.test.ts b/x-pack/plugins/alerts/server/alerts_client/tests/mute_instance.test.ts
index c2188f128cb4d..ec69dbdeac55f 100644
--- a/x-pack/plugins/alerts/server/alerts_client/tests/mute_instance.test.ts
+++ b/x-pack/plugins/alerts/server/alerts_client/tests/mute_instance.test.ts
@@ -12,15 +12,17 @@ import { encryptedSavedObjectsMock } from '../../../../encrypted_saved_objects/s
import { actionsAuthorizationMock } from '../../../../actions/server/mocks';
import { AlertsAuthorization } from '../../authorization/alerts_authorization';
import { ActionsAuthorization } from '../../../../actions/server';
+import { httpServerMock } from '../../../../../../src/core/server/mocks';
+import { auditServiceMock } from '../../../../security/server/audit/index.mock';
import { getBeforeSetup, setGlobalDate } from './lib';
const taskManager = taskManagerMock.createStart();
const alertTypeRegistry = alertTypeRegistryMock.create();
const unsecuredSavedObjectsClient = savedObjectsClientMock.create();
-
const encryptedSavedObjects = encryptedSavedObjectsMock.createClient();
const authorization = alertsAuthorizationMock.create();
const actionsAuthorization = actionsAuthorizationMock.create();
+const auditLogger = auditServiceMock.create().asScoped(httpServerMock.createKibanaRequest());
const kibanaVersion = 'v7.10.0';
const alertsClientParams: jest.Mocked = {
@@ -42,6 +44,7 @@ const alertsClientParams: jest.Mocked = {
beforeEach(() => {
getBeforeSetup(alertsClientParams, taskManager, alertTypeRegistry);
+ (auditLogger.log as jest.Mock).mockClear();
});
setGlobalDate();
@@ -180,4 +183,75 @@ describe('muteInstance()', () => {
);
});
});
+
+ describe('auditLogger', () => {
+ test('logs audit event when muting an alert instance', async () => {
+ const alertsClient = new AlertsClient({ ...alertsClientParams, auditLogger });
+ unsecuredSavedObjectsClient.get.mockResolvedValueOnce({
+ id: '1',
+ type: 'alert',
+ attributes: {
+ actions: [],
+ schedule: { interval: '10s' },
+ alertTypeId: '2',
+ enabled: true,
+ scheduledTaskId: 'task-123',
+ mutedInstanceIds: [],
+ },
+ version: '123',
+ references: [],
+ });
+ await alertsClient.muteInstance({ alertId: '1', alertInstanceId: '2' });
+ expect(auditLogger.log).toHaveBeenCalledWith(
+ expect.objectContaining({
+ event: expect.objectContaining({
+ action: 'alert_instance_mute',
+ outcome: 'unknown',
+ }),
+ kibana: { saved_object: { id: '1', type: 'alert' } },
+ })
+ );
+ });
+
+ test('logs audit event when not authorised to mute an alert instance', async () => {
+ const alertsClient = new AlertsClient({ ...alertsClientParams, auditLogger });
+ unsecuredSavedObjectsClient.get.mockResolvedValueOnce({
+ id: '1',
+ type: 'alert',
+ attributes: {
+ actions: [],
+ schedule: { interval: '10s' },
+ alertTypeId: '2',
+ enabled: true,
+ scheduledTaskId: 'task-123',
+ mutedInstanceIds: [],
+ },
+ version: '123',
+ references: [],
+ });
+ authorization.ensureAuthorized.mockRejectedValue(new Error('Unauthorized'));
+
+ await expect(
+ alertsClient.muteInstance({ alertId: '1', alertInstanceId: '2' })
+ ).rejects.toThrow();
+ expect(auditLogger.log).toHaveBeenCalledWith(
+ expect.objectContaining({
+ event: expect.objectContaining({
+ action: 'alert_instance_mute',
+ outcome: 'failure',
+ }),
+ kibana: {
+ saved_object: {
+ id: '1',
+ type: 'alert',
+ },
+ },
+ error: {
+ code: 'Error',
+ message: 'Unauthorized',
+ },
+ })
+ );
+ });
+ });
});
diff --git a/x-pack/plugins/alerts/server/alerts_client/tests/unmute_all.test.ts b/x-pack/plugins/alerts/server/alerts_client/tests/unmute_all.test.ts
index d92304ab873be..fd0157091e3a5 100644
--- a/x-pack/plugins/alerts/server/alerts_client/tests/unmute_all.test.ts
+++ b/x-pack/plugins/alerts/server/alerts_client/tests/unmute_all.test.ts
@@ -12,15 +12,17 @@ import { encryptedSavedObjectsMock } from '../../../../encrypted_saved_objects/s
import { actionsAuthorizationMock } from '../../../../actions/server/mocks';
import { AlertsAuthorization } from '../../authorization/alerts_authorization';
import { ActionsAuthorization } from '../../../../actions/server';
+import { httpServerMock } from '../../../../../../src/core/server/mocks';
+import { auditServiceMock } from '../../../../security/server/audit/index.mock';
import { getBeforeSetup, setGlobalDate } from './lib';
const taskManager = taskManagerMock.createStart();
const alertTypeRegistry = alertTypeRegistryMock.create();
const unsecuredSavedObjectsClient = savedObjectsClientMock.create();
-
const encryptedSavedObjects = encryptedSavedObjectsMock.createClient();
const authorization = alertsAuthorizationMock.create();
const actionsAuthorization = actionsAuthorizationMock.create();
+const auditLogger = auditServiceMock.create().asScoped(httpServerMock.createKibanaRequest());
const kibanaVersion = 'v7.10.0';
const alertsClientParams: jest.Mocked = {
@@ -42,6 +44,7 @@ const alertsClientParams: jest.Mocked = {
beforeEach(() => {
getBeforeSetup(alertsClientParams, taskManager, alertTypeRegistry);
+ (auditLogger.log as jest.Mock).mockClear();
});
setGlobalDate();
@@ -138,4 +141,85 @@ describe('unmuteAll()', () => {
expect(authorization.ensureAuthorized).toHaveBeenCalledWith('myType', 'myApp', 'unmuteAll');
});
});
+
+ describe('auditLogger', () => {
+ test('logs audit event when unmuting an alert', async () => {
+ const alertsClient = new AlertsClient({ ...alertsClientParams, auditLogger });
+ unsecuredSavedObjectsClient.get.mockResolvedValueOnce({
+ id: '1',
+ type: 'alert',
+ attributes: {
+ actions: [
+ {
+ group: 'default',
+ id: '1',
+ actionTypeId: '1',
+ actionRef: '1',
+ params: {
+ foo: true,
+ },
+ },
+ ],
+ muteAll: false,
+ },
+ references: [],
+ version: '123',
+ });
+ await alertsClient.unmuteAll({ id: '1' });
+ expect(auditLogger.log).toHaveBeenCalledWith(
+ expect.objectContaining({
+ event: expect.objectContaining({
+ action: 'alert_unmute',
+ outcome: 'unknown',
+ }),
+ kibana: { saved_object: { id: '1', type: 'alert' } },
+ })
+ );
+ });
+
+ test('logs audit event when not authorised to unmute an alert', async () => {
+ const alertsClient = new AlertsClient({ ...alertsClientParams, auditLogger });
+ unsecuredSavedObjectsClient.get.mockResolvedValueOnce({
+ id: '1',
+ type: 'alert',
+ attributes: {
+ actions: [
+ {
+ group: 'default',
+ id: '1',
+ actionTypeId: '1',
+ actionRef: '1',
+ params: {
+ foo: true,
+ },
+ },
+ ],
+ muteAll: false,
+ },
+ references: [],
+ version: '123',
+ });
+ authorization.ensureAuthorized.mockRejectedValue(new Error('Unauthorized'));
+
+ await expect(alertsClient.unmuteAll({ id: '1' })).rejects.toThrow();
+ expect(auditLogger.log).toHaveBeenCalledWith(
+ expect.objectContaining({
+ event: expect.objectContaining({
+ action: 'alert_unmute',
+ outcome: 'failure',
+ }),
+ kibana: {
+ saved_object: {
+ id: '1',
+ type: 'alert',
+ },
+ },
+ error: {
+ code: 'Error',
+ message: 'Unauthorized',
+ },
+ })
+ );
+ });
+ });
});
diff --git a/x-pack/plugins/alerts/server/alerts_client/tests/unmute_instance.test.ts b/x-pack/plugins/alerts/server/alerts_client/tests/unmute_instance.test.ts
index 3486df98f2f05..c7d084a01a2a0 100644
--- a/x-pack/plugins/alerts/server/alerts_client/tests/unmute_instance.test.ts
+++ b/x-pack/plugins/alerts/server/alerts_client/tests/unmute_instance.test.ts
@@ -12,15 +12,17 @@ import { encryptedSavedObjectsMock } from '../../../../encrypted_saved_objects/s
import { actionsAuthorizationMock } from '../../../../actions/server/mocks';
import { AlertsAuthorization } from '../../authorization/alerts_authorization';
import { ActionsAuthorization } from '../../../../actions/server';
+import { httpServerMock } from '../../../../../../src/core/server/mocks';
+import { auditServiceMock } from '../../../../security/server/audit/index.mock';
import { getBeforeSetup, setGlobalDate } from './lib';
const taskManager = taskManagerMock.createStart();
const alertTypeRegistry = alertTypeRegistryMock.create();
const unsecuredSavedObjectsClient = savedObjectsClientMock.create();
-
const encryptedSavedObjects = encryptedSavedObjectsMock.createClient();
const authorization = alertsAuthorizationMock.create();
const actionsAuthorization = actionsAuthorizationMock.create();
+const auditLogger = auditServiceMock.create().asScoped(httpServerMock.createKibanaRequest());
const kibanaVersion = 'v7.10.0';
const alertsClientParams: jest.Mocked = {
@@ -42,6 +44,7 @@ const alertsClientParams: jest.Mocked = {
beforeEach(() => {
getBeforeSetup(alertsClientParams, taskManager, alertTypeRegistry);
+ (auditLogger.log as jest.Mock).mockClear();
});
setGlobalDate();
@@ -178,4 +181,75 @@ describe('unmuteInstance()', () => {
);
});
});
+
+ describe('auditLogger', () => {
+ test('logs audit event when unmuting an alert instance', async () => {
+ const alertsClient = new AlertsClient({ ...alertsClientParams, auditLogger });
+ unsecuredSavedObjectsClient.get.mockResolvedValueOnce({
+ id: '1',
+ type: 'alert',
+ attributes: {
+ actions: [],
+ schedule: { interval: '10s' },
+ alertTypeId: '2',
+ enabled: true,
+ scheduledTaskId: 'task-123',
+ mutedInstanceIds: [],
+ },
+ version: '123',
+ references: [],
+ });
+ await alertsClient.unmuteInstance({ alertId: '1', alertInstanceId: '2' });
+ expect(auditLogger.log).toHaveBeenCalledWith(
+ expect.objectContaining({
+ event: expect.objectContaining({
+ action: 'alert_instance_unmute',
+ outcome: 'unknown',
+ }),
+ kibana: { saved_object: { id: '1', type: 'alert' } },
+ })
+ );
+ });
+
+ test('logs audit event when not authorised to unmute an alert instance', async () => {
+ const alertsClient = new AlertsClient({ ...alertsClientParams, auditLogger });
+ unsecuredSavedObjectsClient.get.mockResolvedValueOnce({
+ id: '1',
+ type: 'alert',
+ attributes: {
+ actions: [],
+ schedule: { interval: '10s' },
+ alertTypeId: '2',
+ enabled: true,
+ scheduledTaskId: 'task-123',
+ mutedInstanceIds: [],
+ },
+ version: '123',
+ references: [],
+ });
+ authorization.ensureAuthorized.mockRejectedValue(new Error('Unauthorized'));
+
+ await expect(
+ alertsClient.unmuteInstance({ alertId: '1', alertInstanceId: '2' })
+ ).rejects.toThrow();
+ expect(auditLogger.log).toHaveBeenCalledWith(
+ expect.objectContaining({
+ event: expect.objectContaining({
+ action: 'alert_instance_unmute',
+ outcome: 'failure',
+ }),
+ kibana: {
+ saved_object: {
+ id: '1',
+ type: 'alert',
+ },
+ },
+ error: {
+ code: 'Error',
+ message: 'Unauthorized',
+ },
+ })
+ );
+ });
+ });
});
diff --git a/x-pack/plugins/alerts/server/alerts_client/tests/update.test.ts b/x-pack/plugins/alerts/server/alerts_client/tests/update.test.ts
index b42ee096777fe..15fb1e2ec0092 100644
--- a/x-pack/plugins/alerts/server/alerts_client/tests/update.test.ts
+++ b/x-pack/plugins/alerts/server/alerts_client/tests/update.test.ts
@@ -18,15 +18,17 @@ import { AlertsAuthorization } from '../../authorization/alerts_authorization';
import { resolvable } from '../../test_utils';
import { ActionsAuthorization, ActionsClient } from '../../../../actions/server';
import { TaskStatus } from '../../../../task_manager/server';
+import { httpServerMock } from '../../../../../../src/core/server/mocks';
+import { auditServiceMock } from '../../../../security/server/audit/index.mock';
import { getBeforeSetup, setGlobalDate } from './lib';
const taskManager = taskManagerMock.createStart();
const alertTypeRegistry = alertTypeRegistryMock.create();
const unsecuredSavedObjectsClient = savedObjectsClientMock.create();
-
const encryptedSavedObjects = encryptedSavedObjectsMock.createClient();
const authorization = alertsAuthorizationMock.create();
const actionsAuthorization = actionsAuthorizationMock.create();
+const auditLogger = auditServiceMock.create().asScoped(httpServerMock.createKibanaRequest());
const kibanaVersion = 'v7.10.0';
const alertsClientParams: jest.Mocked = {
@@ -44,10 +46,12 @@ const alertsClientParams: jest.Mocked = {
getActionsClient: jest.fn(),
getEventLogClient: jest.fn(),
kibanaVersion,
+ auditLogger,
};
beforeEach(() => {
getBeforeSetup(alertsClientParams, taskManager, alertTypeRegistry);
+ (auditLogger.log as jest.Mock).mockClear();
});
setGlobalDate();
@@ -1302,4 +1306,89 @@ describe('update()', () => {
expect(authorization.ensureAuthorized).toHaveBeenCalledWith('myType', 'myApp', 'update');
});
});
+
+ describe('auditLogger', () => {
+ beforeEach(() => {
+ unsecuredSavedObjectsClient.create.mockResolvedValueOnce({
+ id: '1',
+ type: 'alert',
+ attributes: {
+ enabled: true,
+ schedule: { interval: '10s' },
+ params: {
+ bar: true,
+ },
+ actions: [],
+ scheduledTaskId: 'task-123',
+ createdAt: new Date().toISOString(),
+ },
+ updated_at: new Date().toISOString(),
+ references: [],
+ });
+ });
+
+ test('logs audit event when updating an alert', async () => {
+ await alertsClient.update({
+ id: '1',
+ data: {
+ schedule: { interval: '10s' },
+ name: 'abc',
+ tags: ['foo'],
+ params: {
+ bar: true,
+ },
+ throttle: null,
+ actions: [],
+ },
+ });
+
+ expect(auditLogger.log).toHaveBeenCalledWith(
+ expect.objectContaining({
+ event: expect.objectContaining({
+ action: 'alert_update',
+ outcome: 'unknown',
+ }),
+ kibana: { saved_object: { id: '1', type: 'alert' } },
+ })
+ );
+ });
+
+ test('logs audit event when not authorised to update an alert', async () => {
+ authorization.ensureAuthorized.mockRejectedValue(new Error('Unauthorized'));
+
+ await expect(
+ alertsClient.update({
+ id: '1',
+ data: {
+ schedule: { interval: '10s' },
+ name: 'abc',
+ tags: ['foo'],
+ params: {
+ bar: true,
+ },
+ throttle: null,
+ actions: [],
+ },
+ })
+ ).rejects.toThrow();
+ expect(auditLogger.log).toHaveBeenCalledWith(
+ expect.objectContaining({
+ event: expect.objectContaining({
+ outcome: 'failure',
+ action: 'alert_update',
+ }),
+ kibana: {
+ saved_object: {
+ id: '1',
+ type: 'alert',
+ },
+ },
+ error: {
+ code: 'Error',
+ message: 'Unauthorized',
+ },
+ })
+ );
+ });
+ });
});
diff --git a/x-pack/plugins/alerts/server/alerts_client/tests/update_api_key.test.ts b/x-pack/plugins/alerts/server/alerts_client/tests/update_api_key.test.ts
index ca5f44078f513..bf21256bb8413 100644
--- a/x-pack/plugins/alerts/server/alerts_client/tests/update_api_key.test.ts
+++ b/x-pack/plugins/alerts/server/alerts_client/tests/update_api_key.test.ts
@@ -12,8 +12,10 @@ import { encryptedSavedObjectsMock } from '../../../../encrypted_saved_objects/s
import { actionsAuthorizationMock } from '../../../../actions/server/mocks';
import { AlertsAuthorization } from '../../authorization/alerts_authorization';
import { ActionsAuthorization } from '../../../../actions/server';
-import { getBeforeSetup, setGlobalDate } from './lib';
+import { httpServerMock } from '../../../../../../src/core/server/mocks';
+import { auditServiceMock } from '../../../../security/server/audit/index.mock';
import { InvalidatePendingApiKey } from '../../types';
+import { getBeforeSetup, setGlobalDate } from './lib';
const taskManager = taskManagerMock.createStart();
const alertTypeRegistry = alertTypeRegistryMock.create();
@@ -21,6 +23,7 @@ const unsecuredSavedObjectsClient = savedObjectsClientMock.create();
const encryptedSavedObjects = encryptedSavedObjectsMock.createClient();
const authorization = alertsAuthorizationMock.create();
const actionsAuthorization = actionsAuthorizationMock.create();
+const auditLogger = auditServiceMock.create().asScoped(httpServerMock.createKibanaRequest());
const kibanaVersion = 'v7.10.0';
const alertsClientParams: jest.Mocked = {
@@ -38,10 +41,12 @@ const alertsClientParams: jest.Mocked = {
getActionsClient: jest.fn(),
getEventLogClient: jest.fn(),
kibanaVersion,
+ auditLogger,
};
beforeEach(() => {
getBeforeSetup(alertsClientParams, taskManager, alertTypeRegistry);
+ (auditLogger.log as jest.Mock).mockClear();
});
setGlobalDate();
@@ -269,4 +274,44 @@ describe('updateApiKey()', () => {
);
});
});
+
+ describe('auditLogger', () => {
+ test('logs audit event when updating the API key of an alert', async () => {
+ await alertsClient.updateApiKey({ id: '1' });
+
+ expect(auditLogger.log).toHaveBeenCalledWith(
+ expect.objectContaining({
+ event: expect.objectContaining({
+ action: 'alert_update_api_key',
+ outcome: 'unknown',
+ }),
+ kibana: { saved_object: { id: '1', type: 'alert' } },
+ })
+ );
+ });
+
+ test('logs audit event when not authorised to update the API key of an alert', async () => {
+ authorization.ensureAuthorized.mockRejectedValue(new Error('Unauthorized'));
+
+ await expect(alertsClient.updateApiKey({ id: '1' })).rejects.toThrow();
+ expect(auditLogger.log).toHaveBeenCalledWith(
+ expect.objectContaining({
+ event: expect.objectContaining({
+ outcome: 'failure',
+ action: 'alert_update_api_key',
+ }),
+ kibana: {
+ saved_object: {
+ id: '1',
+ type: 'alert',
+ },
+ },
+ error: {
+ code: 'Error',
+ message: 'Unauthorized',
+ },
+ })
+ );
+ });
+ });
});
diff --git a/x-pack/plugins/alerts/server/alerts_client_factory.ts b/x-pack/plugins/alerts/server/alerts_client_factory.ts
index 069703be72f8a..9d71b5f817b2c 100644
--- a/x-pack/plugins/alerts/server/alerts_client_factory.ts
+++ b/x-pack/plugins/alerts/server/alerts_client_factory.ts
@@ -100,6 +100,7 @@ export class AlertsClientFactory {
actionsAuthorization: actions.getActionsAuthorizationWithRequest(request),
namespace: this.spaceIdToNamespace(spaceId),
encryptedSavedObjectsClient: this.encryptedSavedObjectsClient,
+ auditLogger: securityPluginSetup?.audit.asScoped(request),
async getUserName() {
if (!securityPluginSetup) {
return null;
diff --git a/x-pack/plugins/apm/public/components/app/ErrorGroupOverview/List/__test__/__snapshots__/List.test.tsx.snap b/x-pack/plugins/apm/public/components/app/ErrorGroupOverview/List/__test__/__snapshots__/List.test.tsx.snap
index 1f34a0cef1ccf..4b332b6904282 100644
--- a/x-pack/plugins/apm/public/components/app/ErrorGroupOverview/List/__test__/__snapshots__/List.test.tsx.snap
+++ b/x-pack/plugins/apm/public/components/app/ErrorGroupOverview/List/__test__/__snapshots__/List.test.tsx.snap
@@ -94,11 +94,6 @@ exports[`ErrorGroupOverview -> List should render empty state 1`] = `
>
List should render with data 1`] = `
>
theme.eui.textColors.subdued};
+ color: ${({ theme }) => theme.eui.euiTextSubduedColor};
}
`;
diff --git a/x-pack/plugins/apm/public/components/app/ServiceMap/Popover/ServiceStatsList.tsx b/x-pack/plugins/apm/public/components/app/ServiceMap/Popover/ServiceStatsList.tsx
index adbcf897669ae..cc41c254ffb50 100644
--- a/x-pack/plugins/apm/public/components/app/ServiceMap/Popover/ServiceStatsList.tsx
+++ b/x-pack/plugins/apm/public/components/app/ServiceMap/Popover/ServiceStatsList.tsx
@@ -20,7 +20,7 @@ export const ItemRow = styled('tr')`
`;
export const ItemTitle = styled('td')`
- color: ${({ theme }) => theme.eui.textColors.subdued};
+ color: ${({ theme }) => theme.eui.euiTextSubduedColor};
padding-right: 1rem;
`;
diff --git a/x-pack/plugins/apm/public/components/app/ServiceMap/cytoscape_options.ts b/x-pack/plugins/apm/public/components/app/ServiceMap/cytoscape_options.ts
index e2a54f6048682..f2f51496fcca8 100644
--- a/x-pack/plugins/apm/public/components/app/ServiceMap/cytoscape_options.ts
+++ b/x-pack/plugins/apm/public/components/app/ServiceMap/cytoscape_options.ts
@@ -129,7 +129,7 @@ const getStyle = (theme: EuiTheme): cytoscape.Stylesheet[] => {
color: (el: cytoscape.NodeSingular) =>
el.hasClass('primary') || el.selected()
? theme.eui.euiColorPrimaryText
- : theme.eui.textColors.text,
+ : theme.eui.euiTextColor,
// theme.euiFontFamily doesn't work here for some reason, so we're just
// specifying a subset of the fonts for the label text.
'font-family': 'Inter UI, Segoe UI, Helvetica, Arial, sans-serif',
diff --git a/x-pack/plugins/apm/public/components/app/TransactionDetails/Distribution/index.tsx b/x-pack/plugins/apm/public/components/app/TransactionDetails/Distribution/index.tsx
index bebd5bdabbae3..309cde4dd9f65 100644
--- a/x-pack/plugins/apm/public/components/app/TransactionDetails/Distribution/index.tsx
+++ b/x-pack/plugins/apm/public/components/app/TransactionDetails/Distribution/index.tsx
@@ -33,11 +33,9 @@ import { unit } from '../../../../style/variables';
import { ChartContainer } from '../../../shared/charts/chart_container';
import { EmptyMessage } from '../../../shared/EmptyMessage';
-type TransactionDistributionAPIResponse = APIReturnType<'GET /api/apm/services/{serviceName}/transaction_groups/distribution'>;
+type TransactionDistributionAPIResponse = APIReturnType<'GET /api/apm/services/{serviceName}/transactions/charts/distribution'>;
-type DistributionApiResponse = APIReturnType<'GET /api/apm/services/{serviceName}/transaction_groups/distribution'>;
-
-type DistributionBucket = DistributionApiResponse['buckets'][0];
+type DistributionBucket = TransactionDistributionAPIResponse['buckets'][0];
interface IChartPoint {
x0: number;
diff --git a/x-pack/plugins/apm/public/components/app/TransactionDetails/WaterfallWithSummmary/index.tsx b/x-pack/plugins/apm/public/components/app/TransactionDetails/WaterfallWithSummmary/index.tsx
index d90fe393c94a4..a633341ba2bb4 100644
--- a/x-pack/plugins/apm/public/components/app/TransactionDetails/WaterfallWithSummmary/index.tsx
+++ b/x-pack/plugins/apm/public/components/app/TransactionDetails/WaterfallWithSummmary/index.tsx
@@ -27,7 +27,7 @@ import { MaybeViewTraceLink } from './MaybeViewTraceLink';
import { TransactionTabs } from './TransactionTabs';
import { IWaterfall } from './WaterfallContainer/Waterfall/waterfall_helpers/waterfall_helpers';
-type DistributionApiResponse = APIReturnType<'GET /api/apm/services/{serviceName}/transaction_groups/distribution'>;
+type DistributionApiResponse = APIReturnType<'GET /api/apm/services/{serviceName}/transactions/charts/distribution'>;
type DistributionBucket = DistributionApiResponse['buckets'][0];
diff --git a/x-pack/plugins/apm/public/components/app/service_overview/service_overview_transactions_table/index.tsx b/x-pack/plugins/apm/public/components/app/service_overview/service_overview_transactions_table/index.tsx
index 6b02a44dcc2f4..e4260a2533d36 100644
--- a/x-pack/plugins/apm/public/components/app/service_overview/service_overview_transactions_table/index.tsx
+++ b/x-pack/plugins/apm/public/components/app/service_overview/service_overview_transactions_table/index.tsx
@@ -36,7 +36,7 @@ import { ImpactBar } from '../../../shared/ImpactBar';
import { ServiceOverviewTable } from '../service_overview_table';
type ServiceTransactionGroupItem = ValuesType<
- APIReturnType<'GET /api/apm/services/{serviceName}/overview_transaction_groups'>['transactionGroups']
+ APIReturnType<'GET /api/apm/services/{serviceName}/transactions/groups/overview'>['transactionGroups']
>;
interface Props {
@@ -100,7 +100,7 @@ export function ServiceOverviewTransactionsTable(props: Props) {
return callApmApi({
endpoint:
- 'GET /api/apm/services/{serviceName}/overview_transaction_groups',
+ 'GET /api/apm/services/{serviceName}/transactions/groups/overview',
params: {
path: { serviceName },
query: {
diff --git a/x-pack/plugins/apm/public/components/app/transaction_overview/TransactionList/TransactionList.stories.tsx b/x-pack/plugins/apm/public/components/app/transaction_overview/TransactionList/TransactionList.stories.tsx
index c14c31afe0445..bc73a3acf4135 100644
--- a/x-pack/plugins/apm/public/components/app/transaction_overview/TransactionList/TransactionList.stories.tsx
+++ b/x-pack/plugins/apm/public/components/app/transaction_overview/TransactionList/TransactionList.stories.tsx
@@ -10,7 +10,7 @@ import { APIReturnType } from '../../../../services/rest/createCallApmApi';
import { MockApmPluginContextWrapper } from '../../../../context/apm_plugin/mock_apm_plugin_context';
import { TransactionList } from './';
-type TransactionGroup = APIReturnType<'GET /api/apm/services/{serviceName}/transaction_groups'>['items'][0];
+type TransactionGroup = APIReturnType<'GET /api/apm/services/{serviceName}/transactions/groups'>['items'][0];
export default {
title: 'app/TransactionOverview/TransactionList',
diff --git a/x-pack/plugins/apm/public/components/app/transaction_overview/TransactionList/index.tsx b/x-pack/plugins/apm/public/components/app/transaction_overview/TransactionList/index.tsx
index 9774538b2a7a7..ade0a0563b0dc 100644
--- a/x-pack/plugins/apm/public/components/app/transaction_overview/TransactionList/index.tsx
+++ b/x-pack/plugins/apm/public/components/app/transaction_overview/TransactionList/index.tsx
@@ -20,7 +20,7 @@ import { LoadingStatePrompt } from '../../../shared/LoadingStatePrompt';
import { EmptyMessage } from '../../../shared/EmptyMessage';
import { TransactionDetailLink } from '../../../shared/Links/apm/TransactionDetailLink';
-type TransactionGroup = APIReturnType<'GET /api/apm/services/{serviceName}/transaction_groups'>['items'][0];
+type TransactionGroup = APIReturnType<'GET /api/apm/services/{serviceName}/transactions/groups'>['items'][0];
// Truncate both the link and the child span (the tooltip anchor.) The link so
// it doesn't overflow, and the anchor so we get the ellipsis.
diff --git a/x-pack/plugins/apm/public/components/app/transaction_overview/use_transaction_list.ts b/x-pack/plugins/apm/public/components/app/transaction_overview/use_transaction_list.ts
index 78883ec2cf0d3..0ca2867852f26 100644
--- a/x-pack/plugins/apm/public/components/app/transaction_overview/use_transaction_list.ts
+++ b/x-pack/plugins/apm/public/components/app/transaction_overview/use_transaction_list.ts
@@ -9,7 +9,7 @@ import { APIReturnType } from '../../../services/rest/createCallApmApi';
import { useFetcher } from '../../../hooks/use_fetcher';
import { useUrlParams } from '../../../context/url_params_context/use_url_params';
-type TransactionsAPIResponse = APIReturnType<'GET /api/apm/services/{serviceName}/transaction_groups'>;
+type TransactionsAPIResponse = APIReturnType<'GET /api/apm/services/{serviceName}/transactions/groups'>;
const DEFAULT_RESPONSE: Partial = {
items: undefined,
@@ -25,7 +25,7 @@ export function useTransactionListFetcher() {
(callApmApi) => {
if (serviceName && start && end && transactionType) {
return callApmApi({
- endpoint: 'GET /api/apm/services/{serviceName}/transaction_groups',
+ endpoint: 'GET /api/apm/services/{serviceName}/transactions/groups',
params: {
path: { serviceName },
query: {
diff --git a/x-pack/plugins/apm/public/components/shared/Stacktrace/CauseStacktrace.tsx b/x-pack/plugins/apm/public/components/shared/Stacktrace/CauseStacktrace.tsx
index 50f87184f8ee7..a36980d49db3a 100644
--- a/x-pack/plugins/apm/public/components/shared/Stacktrace/CauseStacktrace.tsx
+++ b/x-pack/plugins/apm/public/components/shared/Stacktrace/CauseStacktrace.tsx
@@ -22,7 +22,7 @@ const CausedByContainer = styled('h5')`
`;
const CausedByHeading = styled('span')`
- color: ${({ theme }) => theme.eui.textColors.subdued};
+ color: ${({ theme }) => theme.eui.euiTextSubduedColor};
display: block;
font-size: ${({ theme }) => theme.eui.euiFontSizeXS};
font-weight: ${({ theme }) => theme.eui.euiFontWeightBold};
diff --git a/x-pack/plugins/apm/public/components/shared/charts/transaction_breakdown_chart/use_transaction_breakdown.ts b/x-pack/plugins/apm/public/components/shared/charts/transaction_breakdown_chart/use_transaction_breakdown.ts
index ff744d763ecae..81840dc52c1ec 100644
--- a/x-pack/plugins/apm/public/components/shared/charts/transaction_breakdown_chart/use_transaction_breakdown.ts
+++ b/x-pack/plugins/apm/public/components/shared/charts/transaction_breakdown_chart/use_transaction_breakdown.ts
@@ -20,7 +20,7 @@ export function useTransactionBreakdown() {
if (serviceName && start && end && transactionType) {
return callApmApi({
endpoint:
- 'GET /api/apm/services/{serviceName}/transaction_groups/breakdown',
+ 'GET /api/apm/services/{serviceName}/transaction/charts/breakdown',
params: {
path: { serviceName },
query: {
diff --git a/x-pack/plugins/apm/public/components/shared/charts/transaction_error_rate_chart/index.tsx b/x-pack/plugins/apm/public/components/shared/charts/transaction_error_rate_chart/index.tsx
index 06a5e7baef79b..4a388b13d7d22 100644
--- a/x-pack/plugins/apm/public/components/shared/charts/transaction_error_rate_chart/index.tsx
+++ b/x-pack/plugins/apm/public/components/shared/charts/transaction_error_rate_chart/index.tsx
@@ -45,7 +45,7 @@ export function TransactionErrorRateChart({
if (serviceName && start && end) {
return callApmApi({
endpoint:
- 'GET /api/apm/services/{serviceName}/transaction_groups/error_rate',
+ 'GET /api/apm/services/{serviceName}/transactions/charts/error_rate',
params: {
path: {
serviceName,
diff --git a/x-pack/plugins/apm/public/hooks/use_transaction_charts_fetcher.ts b/x-pack/plugins/apm/public/hooks/use_transaction_charts_fetcher.ts
index f5105e38b985e..406a1a4633577 100644
--- a/x-pack/plugins/apm/public/hooks/use_transaction_charts_fetcher.ts
+++ b/x-pack/plugins/apm/public/hooks/use_transaction_charts_fetcher.ts
@@ -21,8 +21,7 @@ export function useTransactionChartsFetcher() {
(callApmApi) => {
if (serviceName && start && end) {
return callApmApi({
- endpoint:
- 'GET /api/apm/services/{serviceName}/transaction_groups/charts',
+ endpoint: 'GET /api/apm/services/{serviceName}/transactions/charts',
params: {
path: { serviceName },
query: {
diff --git a/x-pack/plugins/apm/public/hooks/use_transaction_distribution_fetcher.ts b/x-pack/plugins/apm/public/hooks/use_transaction_distribution_fetcher.ts
index 74222e8ffe038..b8968031e6922 100644
--- a/x-pack/plugins/apm/public/hooks/use_transaction_distribution_fetcher.ts
+++ b/x-pack/plugins/apm/public/hooks/use_transaction_distribution_fetcher.ts
@@ -12,7 +12,7 @@ import { maybe } from '../../common/utils/maybe';
import { APIReturnType } from '../services/rest/createCallApmApi';
import { useUrlParams } from '../context/url_params_context/use_url_params';
-type APIResponse = APIReturnType<'GET /api/apm/services/{serviceName}/transaction_groups/distribution'>;
+type APIResponse = APIReturnType<'GET /api/apm/services/{serviceName}/transactions/charts/distribution'>;
const INITIAL_DATA = {
buckets: [] as APIResponse['buckets'],
@@ -38,7 +38,7 @@ export function useTransactionDistributionFetcher() {
if (serviceName && start && end && transactionType && transactionName) {
const response = await callApmApi({
endpoint:
- 'GET /api/apm/services/{serviceName}/transaction_groups/distribution',
+ 'GET /api/apm/services/{serviceName}/transactions/charts/distribution',
params: {
path: {
serviceName,
diff --git a/x-pack/plugins/apm/server/lib/errors/get_error_group.ts b/x-pack/plugins/apm/server/lib/errors/get_error_group_sample.ts
similarity index 92%
rename from x-pack/plugins/apm/server/lib/errors/get_error_group.ts
rename to x-pack/plugins/apm/server/lib/errors/get_error_group_sample.ts
index 965cc28952b7a..ff09855e63a8f 100644
--- a/x-pack/plugins/apm/server/lib/errors/get_error_group.ts
+++ b/x-pack/plugins/apm/server/lib/errors/get_error_group_sample.ts
@@ -14,8 +14,7 @@ import { rangeFilter } from '../../../common/utils/range_filter';
import { Setup, SetupTimeRange } from '../helpers/setup_request';
import { getTransaction } from '../transactions/get_transaction';
-// TODO: rename from "getErrorGroup" to "getErrorGroupSample" (since a single error is returned, not an errorGroup)
-export async function getErrorGroup({
+export async function getErrorGroupSample({
serviceName,
groupId,
setup,
diff --git a/x-pack/plugins/apm/server/lib/errors/queries.test.ts b/x-pack/plugins/apm/server/lib/errors/queries.test.ts
index fec59393726bf..92f0abcfb77e7 100644
--- a/x-pack/plugins/apm/server/lib/errors/queries.test.ts
+++ b/x-pack/plugins/apm/server/lib/errors/queries.test.ts
@@ -4,7 +4,7 @@
* you may not use this file except in compliance with the Elastic License.
*/
-import { getErrorGroup } from './get_error_group';
+import { getErrorGroupSample } from './get_error_group_sample';
import { getErrorGroups } from './get_error_groups';
import {
SearchParamsMock,
@@ -20,7 +20,7 @@ describe('error queries', () => {
it('fetches a single error group', async () => {
mock = await inspectSearchParams((setup) =>
- getErrorGroup({
+ getErrorGroupSample({
groupId: 'groupId',
serviceName: 'serviceName',
setup,
diff --git a/x-pack/plugins/apm/server/lib/transaction_groups/get_transaction_sample_for_group.ts b/x-pack/plugins/apm/server/lib/transaction_groups/get_transaction_sample_for_group.ts
deleted file mode 100644
index 7e1aad075fb16..0000000000000
--- a/x-pack/plugins/apm/server/lib/transaction_groups/get_transaction_sample_for_group.ts
+++ /dev/null
@@ -1,89 +0,0 @@
-/*
- * 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 { maybe } from '../../../common/utils/maybe';
-import {
- SERVICE_NAME,
- TRANSACTION_NAME,
- TRANSACTION_SAMPLED,
-} from '../../../common/elasticsearch_fieldnames';
-import { ProcessorEvent } from '../../../common/processor_event';
-import { rangeFilter } from '../../../common/utils/range_filter';
-import { Setup, SetupTimeRange } from '../helpers/setup_request';
-
-export async function getTransactionSampleForGroup({
- serviceName,
- transactionName,
- setup,
-}: {
- serviceName: string;
- transactionName: string;
- setup: Setup & SetupTimeRange;
-}) {
- const { apmEventClient, start, end, esFilter } = setup;
-
- const filter = [
- {
- range: rangeFilter(start, end),
- },
- {
- term: {
- [SERVICE_NAME]: serviceName,
- },
- },
- {
- term: {
- [TRANSACTION_NAME]: transactionName,
- },
- },
- ...esFilter,
- ];
-
- const getSampledTransaction = async () => {
- const response = await apmEventClient.search({
- terminateAfter: 1,
- apm: {
- events: [ProcessorEvent.transaction],
- },
- body: {
- size: 1,
- query: {
- bool: {
- filter: [...filter, { term: { [TRANSACTION_SAMPLED]: true } }],
- },
- },
- },
- });
-
- return maybe(response.hits.hits[0]?._source);
- };
-
- const getUnsampledTransaction = async () => {
- const response = await apmEventClient.search({
- terminateAfter: 1,
- apm: {
- events: [ProcessorEvent.transaction],
- },
- body: {
- size: 1,
- query: {
- bool: {
- filter: [...filter, { term: { [TRANSACTION_SAMPLED]: false } }],
- },
- },
- },
- });
-
- return maybe(response.hits.hits[0]?._source);
- };
-
- const [sampledTransaction, unsampledTransaction] = await Promise.all([
- getSampledTransaction(),
- getUnsampledTransaction(),
- ]);
-
- return sampledTransaction || unsampledTransaction;
-}
diff --git a/x-pack/plugins/apm/server/routes/create_apm_api.ts b/x-pack/plugins/apm/server/routes/create_apm_api.ts
index 4f7f6320185bf..0e066a1959c49 100644
--- a/x-pack/plugins/apm/server/routes/create_apm_api.ts
+++ b/x-pack/plugins/apm/server/routes/create_apm_api.ts
@@ -23,7 +23,6 @@ import {
serviceAnnotationsCreateRoute,
serviceErrorGroupsRoute,
serviceThroughputRoute,
- serviceTransactionGroupsRoute,
} from './services';
import {
agentConfigurationRoute,
@@ -52,13 +51,13 @@ import {
correlationsForFailedTransactionsRoute,
} from './correlations';
import {
- transactionGroupsBreakdownRoute,
- transactionGroupsChartsRoute,
- transactionGroupsDistributionRoute,
+ transactionChartsBreakdownRoute,
+ transactionChartsRoute,
+ transactionChartsDistributionRoute,
+ transactionChartsErrorRateRoute,
transactionGroupsRoute,
- transactionSampleForGroupRoute,
- transactionGroupsErrorRateRoute,
-} from './transaction_groups';
+ transactionGroupsOverviewRoute,
+} from './transactions/transactions_routes';
import {
errorGroupsLocalFiltersRoute,
metricsLocalFiltersRoute,
@@ -122,7 +121,6 @@ const createApmApi = () => {
.add(serviceAnnotationsCreateRoute)
.add(serviceErrorGroupsRoute)
.add(serviceThroughputRoute)
- .add(serviceTransactionGroupsRoute)
// Agent configuration
.add(getSingleAgentConfigurationRoute)
@@ -152,13 +150,13 @@ const createApmApi = () => {
.add(tracesByIdRoute)
.add(rootTransactionByTraceIdRoute)
- // Transaction groups
- .add(transactionGroupsBreakdownRoute)
- .add(transactionGroupsChartsRoute)
- .add(transactionGroupsDistributionRoute)
+ // Transactions
+ .add(transactionChartsBreakdownRoute)
+ .add(transactionChartsRoute)
+ .add(transactionChartsDistributionRoute)
+ .add(transactionChartsErrorRateRoute)
.add(transactionGroupsRoute)
- .add(transactionSampleForGroupRoute)
- .add(transactionGroupsErrorRateRoute)
+ .add(transactionGroupsOverviewRoute)
// UI filters
.add(errorGroupsLocalFiltersRoute)
diff --git a/x-pack/plugins/apm/server/routes/errors.ts b/x-pack/plugins/apm/server/routes/errors.ts
index 64864ec2258ba..c4bc70a92d9ee 100644
--- a/x-pack/plugins/apm/server/routes/errors.ts
+++ b/x-pack/plugins/apm/server/routes/errors.ts
@@ -7,7 +7,7 @@
import * as t from 'io-ts';
import { createRoute } from './create_route';
import { getErrorDistribution } from '../lib/errors/distribution/get_distribution';
-import { getErrorGroup } from '../lib/errors/get_error_group';
+import { getErrorGroupSample } from '../lib/errors/get_error_group_sample';
import { getErrorGroups } from '../lib/errors/get_error_groups';
import { setupRequest } from '../lib/helpers/setup_request';
import { uiFiltersRt, rangeRt } from './default_api_types';
@@ -56,7 +56,7 @@ export const errorGroupsRoute = createRoute({
handler: async ({ context, request }) => {
const setup = await setupRequest(context, request);
const { serviceName, groupId } = context.params.path;
- return getErrorGroup({ serviceName, groupId, setup });
+ return getErrorGroupSample({ serviceName, groupId, setup });
},
});
diff --git a/x-pack/plugins/apm/server/routes/services.ts b/x-pack/plugins/apm/server/routes/services.ts
index 4c5738ecef581..a82f1b64d5537 100644
--- a/x-pack/plugins/apm/server/routes/services.ts
+++ b/x-pack/plugins/apm/server/routes/services.ts
@@ -19,7 +19,6 @@ import { dateAsStringRt } from '../../common/runtime_types/date_as_string_rt';
import { getSearchAggregatedTransactions } from '../lib/helpers/aggregated_transactions';
import { getServiceErrorGroups } from '../lib/services/get_service_error_groups';
import { toNumberRt } from '../../common/runtime_types/to_number_rt';
-import { getServiceTransactionGroups } from '../lib/services/get_service_transaction_groups';
import { getThroughput } from '../lib/services/get_throughput';
export const servicesRoute = createRoute({
@@ -276,52 +275,3 @@ export const serviceThroughputRoute = createRoute({
});
},
});
-
-export const serviceTransactionGroupsRoute = createRoute({
- endpoint: 'GET /api/apm/services/{serviceName}/overview_transaction_groups',
- params: t.type({
- path: t.type({ serviceName: t.string }),
- query: t.intersection([
- rangeRt,
- uiFiltersRt,
- t.type({
- size: toNumberRt,
- numBuckets: toNumberRt,
- pageIndex: toNumberRt,
- sortDirection: t.union([t.literal('asc'), t.literal('desc')]),
- sortField: t.union([
- t.literal('latency'),
- t.literal('throughput'),
- t.literal('errorRate'),
- t.literal('impact'),
- ]),
- }),
- ]),
- }),
- options: {
- tags: ['access:apm'],
- },
- handler: async ({ context, request }) => {
- const setup = await setupRequest(context, request);
-
- const searchAggregatedTransactions = await getSearchAggregatedTransactions(
- setup
- );
-
- const {
- path: { serviceName },
- query: { size, numBuckets, pageIndex, sortDirection, sortField },
- } = context.params;
-
- return getServiceTransactionGroups({
- setup,
- serviceName,
- pageIndex,
- searchAggregatedTransactions,
- size,
- sortDirection,
- sortField,
- numBuckets,
- });
- },
-});
diff --git a/x-pack/plugins/apm/server/routes/transaction_groups.ts b/x-pack/plugins/apm/server/routes/transactions/transactions_routes.ts
similarity index 62%
rename from x-pack/plugins/apm/server/routes/transaction_groups.ts
rename to x-pack/plugins/apm/server/routes/transactions/transactions_routes.ts
index 58c1ce3451a29..11d247ccab84f 100644
--- a/x-pack/plugins/apm/server/routes/transaction_groups.ts
+++ b/x-pack/plugins/apm/server/routes/transactions/transactions_routes.ts
@@ -4,21 +4,26 @@
* you may not use this file except in compliance with the Elastic License.
*/
-import * as t from 'io-ts';
import Boom from '@hapi/boom';
-import { setupRequest } from '../lib/helpers/setup_request';
-import { getTransactionCharts } from '../lib/transactions/charts';
-import { getTransactionDistribution } from '../lib/transactions/distribution';
-import { getTransactionBreakdown } from '../lib/transactions/breakdown';
-import { getTransactionGroupList } from '../lib/transaction_groups';
-import { createRoute } from './create_route';
-import { uiFiltersRt, rangeRt } from './default_api_types';
-import { getTransactionSampleForGroup } from '../lib/transaction_groups/get_transaction_sample_for_group';
-import { getSearchAggregatedTransactions } from '../lib/helpers/aggregated_transactions';
-import { getErrorRate } from '../lib/transaction_groups/get_error_rate';
+import * as t from 'io-ts';
+import { toNumberRt } from '../../../common/runtime_types/to_number_rt';
+import { getSearchAggregatedTransactions } from '../../lib/helpers/aggregated_transactions';
+import { setupRequest } from '../../lib/helpers/setup_request';
+import { getServiceTransactionGroups } from '../../lib/services/get_service_transaction_groups';
+import { getTransactionBreakdown } from '../../lib/transactions/breakdown';
+import { getTransactionCharts } from '../../lib/transactions/charts';
+import { getTransactionDistribution } from '../../lib/transactions/distribution';
+import { getTransactionGroupList } from '../../lib/transaction_groups';
+import { getErrorRate } from '../../lib/transaction_groups/get_error_rate';
+import { createRoute } from '../create_route';
+import { rangeRt, uiFiltersRt } from '../default_api_types';
+/**
+ * Returns a list of transactions grouped by name
+ * //TODO: delete this once we moved away from the old table in the transaction overview page. It should be replaced by /transactions/groups/overview/
+ */
export const transactionGroupsRoute = createRoute({
- endpoint: 'GET /api/apm/services/{serviceName}/transaction_groups',
+ endpoint: 'GET /api/apm/services/{serviceName}/transactions/groups',
params: t.type({
path: t.type({
serviceName: t.string,
@@ -53,8 +58,64 @@ export const transactionGroupsRoute = createRoute({
},
});
-export const transactionGroupsChartsRoute = createRoute({
- endpoint: 'GET /api/apm/services/{serviceName}/transaction_groups/charts',
+export const transactionGroupsOverviewRoute = createRoute({
+ endpoint: 'GET /api/apm/services/{serviceName}/transactions/groups/overview',
+ params: t.type({
+ path: t.type({ serviceName: t.string }),
+ query: t.intersection([
+ rangeRt,
+ uiFiltersRt,
+ t.type({
+ size: toNumberRt,
+ numBuckets: toNumberRt,
+ pageIndex: toNumberRt,
+ sortDirection: t.union([t.literal('asc'), t.literal('desc')]),
+ sortField: t.union([
+ t.literal('latency'),
+ t.literal('throughput'),
+ t.literal('errorRate'),
+ t.literal('impact'),
+ ]),
+ }),
+ ]),
+ }),
+ options: {
+ tags: ['access:apm'],
+ },
+ handler: async ({ context, request }) => {
+ const setup = await setupRequest(context, request);
+
+ const searchAggregatedTransactions = await getSearchAggregatedTransactions(
+ setup
+ );
+
+ const {
+ path: { serviceName },
+ query: { size, numBuckets, pageIndex, sortDirection, sortField },
+ } = context.params;
+
+ return getServiceTransactionGroups({
+ setup,
+ serviceName,
+ pageIndex,
+ searchAggregatedTransactions,
+ size,
+ sortDirection,
+ sortField,
+ numBuckets,
+ });
+ },
+});
+
+/**
+ * Returns timeseries for latency, throughput and anomalies
+ * TODO: break it into 3 new APIs:
+ * - Latency: /transactions/charts/latency
+ * - Throughput: /transactions/charts/throughput
+ * - anomalies: /transactions/charts/anomaly
+ */
+export const transactionChartsRoute = createRoute({
+ endpoint: 'GET /api/apm/services/{serviceName}/transactions/charts',
params: t.type({
path: t.type({
serviceName: t.string,
@@ -98,9 +159,9 @@ export const transactionGroupsChartsRoute = createRoute({
},
});
-export const transactionGroupsDistributionRoute = createRoute({
+export const transactionChartsDistributionRoute = createRoute({
endpoint:
- 'GET /api/apm/services/{serviceName}/transaction_groups/distribution',
+ 'GET /api/apm/services/{serviceName}/transactions/charts/distribution',
params: t.type({
path: t.type({
serviceName: t.string,
@@ -145,8 +206,8 @@ export const transactionGroupsDistributionRoute = createRoute({
},
});
-export const transactionGroupsBreakdownRoute = createRoute({
- endpoint: 'GET /api/apm/services/{serviceName}/transaction_groups/breakdown',
+export const transactionChartsBreakdownRoute = createRoute({
+ endpoint: 'GET /api/apm/services/{serviceName}/transaction/charts/breakdown',
params: t.type({
path: t.type({
serviceName: t.string,
@@ -177,33 +238,9 @@ export const transactionGroupsBreakdownRoute = createRoute({
},
});
-export const transactionSampleForGroupRoute = createRoute({
- endpoint: `GET /api/apm/transaction_sample`,
- params: t.type({
- query: t.intersection([
- uiFiltersRt,
- rangeRt,
- t.type({ serviceName: t.string, transactionName: t.string }),
- ]),
- }),
- options: { tags: ['access:apm'] },
- handler: async ({ context, request }) => {
- const setup = await setupRequest(context, request);
-
- const { transactionName, serviceName } = context.params.query;
-
- return {
- transaction: await getTransactionSampleForGroup({
- setup,
- serviceName,
- transactionName,
- }),
- };
- },
-});
-
-export const transactionGroupsErrorRateRoute = createRoute({
- endpoint: 'GET /api/apm/services/{serviceName}/transaction_groups/error_rate',
+export const transactionChartsErrorRateRoute = createRoute({
+ endpoint:
+ 'GET /api/apm/services/{serviceName}/transactions/charts/error_rate',
params: t.type({
path: t.type({
serviceName: t.string,
diff --git a/x-pack/plugins/canvas/canvas_plugin_src/renderers/filters/time_filter/components/__stories__/__snapshots__/time_filter.stories.storyshot b/x-pack/plugins/canvas/canvas_plugin_src/renderers/filters/time_filter/components/__stories__/__snapshots__/time_filter.stories.storyshot
index 3fba41069253e..59771973f2aa5 100644
--- a/x-pack/plugins/canvas/canvas_plugin_src/renderers/filters/time_filter/components/__stories__/__snapshots__/time_filter.stories.storyshot
+++ b/x-pack/plugins/canvas/canvas_plugin_src/renderers/filters/time_filter/components/__stories__/__snapshots__/time_filter.stories.storyshot
@@ -23,11 +23,6 @@ exports[`Storyshots renderers/TimeFilter default 1`] = `
`;
diff --git a/x-pack/plugins/canvas/public/components/asset_manager/__stories__/__snapshots__/asset.stories.storyshot b/x-pack/plugins/canvas/public/components/asset_manager/__stories__/__snapshots__/asset.stories.storyshot
index 05339ca558562..8194d923f34a5 100644
--- a/x-pack/plugins/canvas/public/components/asset_manager/__stories__/__snapshots__/asset.stories.storyshot
+++ b/x-pack/plugins/canvas/public/components/asset_manager/__stories__/__snapshots__/asset.stories.storyshot
@@ -18,7 +18,7 @@ exports[`Storyshots components/Assets/Asset airplane 1`] = `
className="canvasAsset__thumb canvasCheckered"
>
![Asset thumbnail]()
![Asset thumbnail]()
![Asset thumbnail]()
![Asset thumbnail]()
`;
exports[`Storyshots components/FontPicker with value 1`] = `
`;
diff --git a/x-pack/plugins/canvas/public/components/palette_picker/__stories__/__snapshots__/palette_picker.stories.storyshot b/x-pack/plugins/canvas/public/components/palette_picker/__stories__/__snapshots__/palette_picker.stories.storyshot
index d5990d3dbfd53..680f792f4d1b9 100644
--- a/x-pack/plugins/canvas/public/components/palette_picker/__stories__/__snapshots__/palette_picker.stories.storyshot
+++ b/x-pack/plugins/canvas/public/components/palette_picker/__stories__/__snapshots__/palette_picker.stories.storyshot
@@ -9,7 +9,7 @@ exports[`Storyshots components/Color/PalettePicker clearable 1`] = `
}
>
`;
@@ -75,7 +32,7 @@ exports[`Storyshots components/Color/PalettePicker default 1`] = `
}
>
`;
@@ -157,7 +55,7 @@ exports[`Storyshots components/Color/PalettePicker interactive 1`] = `
}
>
`;
diff --git a/x-pack/plugins/canvas/public/components/shape_picker_popover/__stories__/__snapshots__/shape_picker_popover.stories.storyshot b/x-pack/plugins/canvas/public/components/shape_picker_popover/__stories__/__snapshots__/shape_picker_popover.stories.storyshot
index 1d292c94436e3..548c441680c55 100644
--- a/x-pack/plugins/canvas/public/components/shape_picker_popover/__stories__/__snapshots__/shape_picker_popover.stories.storyshot
+++ b/x-pack/plugins/canvas/public/components/shape_picker_popover/__stories__/__snapshots__/shape_picker_popover.stories.storyshot
@@ -3,11 +3,6 @@
exports[`Storyshots components/Shapes/ShapePickerPopover default 1`] = `
@@ -442,7 +363,7 @@ Array [
className="euiFormRow__fieldWrapper"
>
@@ -746,7 +588,7 @@ Array [
className="euiFormRow__fieldWrapper"
>
@@ -1026,7 +789,7 @@ Array [
className="euiFormRow__fieldWrapper"
>
diff --git a/x-pack/plugins/canvas/public/components/workpad_header/edit_menu/__stories__/__snapshots__/edit_menu.stories.storyshot b/x-pack/plugins/canvas/public/components/workpad_header/edit_menu/__stories__/__snapshots__/edit_menu.stories.storyshot
index 93f4db664d1db..a242747f74362 100644
--- a/x-pack/plugins/canvas/public/components/workpad_header/edit_menu/__stories__/__snapshots__/edit_menu.stories.storyshot
+++ b/x-pack/plugins/canvas/public/components/workpad_header/edit_menu/__stories__/__snapshots__/edit_menu.stories.storyshot
@@ -3,11 +3,6 @@
exports[`Storyshots components/WorkpadHeader/EditMenu 2 elements selected 1`] = `
@@ -436,11 +375,6 @@ exports[`Storyshots arguments/ContainerStyle extended 1`] = `
@@ -905,11 +778,6 @@ exports[`Storyshots arguments/ContainerStyle/components border form 1`] = `
@@ -1386,11 +1193,6 @@ exports[`Storyshots arguments/ContainerStyle/components extended template 1`] =
-
-
+ />
-
-
-
- Select an option:
-
- , is selected
-
-
-
-
-
-
-
-
-
-
-
+ />
-
-
-
- Select an option:
- , is selected
-
-
-
-
-
-
-
-
-
-
-
+ />
-
-
-
- Select an option:
-
-
- American Typewriter
-
- , is selected
-
-
-
-
-
-
-
-
-
-
+ />
-
-
-
- Select an option: None, is selected
-
-
-
-
-
-
-
-
-
-
-
+ />
-
-
-
- Select an option:
-
- , is selected
-
-
-
-
-
-
-
-
-
-
-
+ />
-
-
-
- Select an option:
-
- , is selected
-
-
-
-
-
-
-
-
-
-
-
+ />
-
-
-
- Select an option:
- , is selected
-
-
-
-
-
-
-
-
-
-
-
+ />
-
-
-
- Select an option:
- , is selected
-
-
-
-
-
-
-
-
-
-
-
+ />
-
-
-
- Select an option:
-
-
-
-
-
-
-
- Boolean
-
-
- , is selected
-
-
-
-
-
-
-
-
-
-
+ />
-
-
-
- Select an option:
-
-
-
-
-
-
-
- Number
-
-
- , is selected
-
-
-
-
-
-
-
-
-
-
+ />
-
-
-
- Select an option:
-
-
-
-
-
-
-
- String
-
-
- , is selected
-
-
-
-
-
-
-
-
-
-
+ />
-
-
-
- Select an option:
-
-
-
-
-
-
-
- String
-
-
- , is selected
-
-
-
-
-
-
-
-
-
-
+ />
-
-
-
- Select an option:
-
- , is selected
-
-
-
-
-
-
-
-
-
-
-
+ />
-
-
-
- Select an option:
-
- , is selected
-
-
-
-
-
-
-
-
-
-
-
+ />
-
-
-
- Select an option:
-
- , is selected
-
-
-
-
-
-
-
-
- ;
export type CasesFindResponse = rt.TypeOf;
export type CasePatchRequest = rt.TypeOf;
export type CasesPatchRequest = rt.TypeOf;
-export type Status = rt.TypeOf;
export type CaseExternalServiceRequest = rt.TypeOf;
export type ServiceConnectorCaseParams = rt.TypeOf;
export type ServiceConnectorCaseResponse = rt.TypeOf;
diff --git a/x-pack/plugins/case/common/api/cases/status.ts b/x-pack/plugins/case/common/api/cases/status.ts
index 984181da8cdee..b812126dc1eab 100644
--- a/x-pack/plugins/case/common/api/cases/status.ts
+++ b/x-pack/plugins/case/common/api/cases/status.ts
@@ -8,6 +8,7 @@ import * as rt from 'io-ts';
export const CasesStatusResponseRt = rt.type({
count_open_cases: rt.number,
+ count_in_progress_cases: rt.number,
count_closed_cases: rt.number,
});
diff --git a/x-pack/plugins/case/server/client/cases/create.test.ts b/x-pack/plugins/case/server/client/cases/create.test.ts
index d82979de2cb44..e09ce226b3125 100644
--- a/x-pack/plugins/case/server/client/cases/create.test.ts
+++ b/x-pack/plugins/case/server/client/cases/create.test.ts
@@ -4,7 +4,7 @@
* you may not use this file except in compliance with the Elastic License.
*/
-import { ConnectorTypes, CasePostRequest } from '../../../common/api';
+import { ConnectorTypes, CasePostRequest, CaseStatuses } from '../../../common/api';
import {
createMockSavedObjectsRepository,
@@ -60,7 +60,7 @@ describe('create', () => {
description: 'This is a brand new case of a bad meanie defacing data',
external_service: null,
title: 'Super Bad Security Issue',
- status: 'open',
+ status: CaseStatuses.open,
tags: ['defacement'],
updated_at: null,
updated_by: null,
@@ -126,7 +126,7 @@ describe('create', () => {
description: 'This is a brand new case of a bad meanie defacing data',
external_service: null,
title: 'Super Bad Security Issue',
- status: 'open',
+ status: CaseStatuses.open,
tags: ['defacement'],
updated_at: null,
updated_by: null,
@@ -169,7 +169,7 @@ describe('create', () => {
description: 'This is a brand new case of a bad meanie defacing data',
external_service: null,
title: 'Super Bad Security Issue',
- status: 'open',
+ status: CaseStatuses.open,
tags: ['defacement'],
updated_at: null,
updated_by: null,
@@ -316,7 +316,7 @@ describe('create', () => {
title: 'a title',
description: 'This is a brand new case of a bad meanie defacing data',
tags: ['defacement'],
- status: 'closed',
+ status: CaseStatuses.closed,
connector: {
id: 'none',
name: 'none',
diff --git a/x-pack/plugins/case/server/client/cases/update.test.ts b/x-pack/plugins/case/server/client/cases/update.test.ts
index 10eebd1210a9e..ae701f16b2bcb 100644
--- a/x-pack/plugins/case/server/client/cases/update.test.ts
+++ b/x-pack/plugins/case/server/client/cases/update.test.ts
@@ -4,7 +4,7 @@
* you may not use this file except in compliance with the Elastic License.
*/
-import { ConnectorTypes, CasesPatchRequest } from '../../../common/api';
+import { ConnectorTypes, CasesPatchRequest, CaseStatuses } from '../../../common/api';
import {
createMockSavedObjectsRepository,
mockCaseNoConnectorId,
@@ -27,7 +27,7 @@ describe('update', () => {
cases: [
{
id: 'mock-id-1',
- status: 'closed' as const,
+ status: CaseStatuses.closed,
version: 'WzAsMV0=',
},
],
@@ -56,7 +56,7 @@ describe('update', () => {
description: 'This is a brand new case of a bad meanie defacing data',
id: 'mock-id-1',
external_service: null,
- status: 'closed',
+ status: CaseStatuses.closed,
tags: ['defacement'],
title: 'Super Bad Security Issue',
totalComment: 0,
@@ -79,8 +79,8 @@ describe('update', () => {
username: 'awesome',
},
action_field: ['status'],
- new_value: 'closed',
- old_value: 'open',
+ new_value: CaseStatuses.closed,
+ old_value: CaseStatuses.open,
},
references: [
{
@@ -98,7 +98,7 @@ describe('update', () => {
cases: [
{
id: 'mock-id-1',
- status: 'open' as const,
+ status: CaseStatuses.open,
version: 'WzAsMV0=',
},
],
@@ -106,7 +106,10 @@ describe('update', () => {
const savedObjectsClient = createMockSavedObjectsRepository({
caseSavedObject: [
- { ...mockCases[0], attributes: { ...mockCases[0].attributes, status: 'closed' } },
+ {
+ ...mockCases[0],
+ attributes: { ...mockCases[0].attributes, status: CaseStatuses.closed },
+ },
...mockCases.slice(1),
],
});
@@ -130,7 +133,7 @@ describe('update', () => {
description: 'This is a brand new case of a bad meanie defacing data',
id: 'mock-id-1',
external_service: null,
- status: 'open',
+ status: CaseStatuses.open,
tags: ['defacement'],
title: 'Super Bad Security Issue',
totalComment: 0,
@@ -146,7 +149,7 @@ describe('update', () => {
cases: [
{
id: 'mock-no-connector_id',
- status: 'closed' as const,
+ status: CaseStatuses.closed,
version: 'WzAsMV0=',
},
],
@@ -177,7 +180,7 @@ describe('update', () => {
description: 'This is a brand new case of a bad meanie defacing data',
external_service: null,
title: 'Super Bad Security Issue',
- status: 'closed',
+ status: CaseStatuses.closed,
tags: ['defacement'],
updated_at: '2019-11-25T21:54:48.952Z',
updated_by: { email: 'd00d@awesome.com', full_name: 'Awesome D00d', username: 'awesome' },
@@ -231,7 +234,7 @@ describe('update', () => {
description: 'Oh no, a bad meanie going LOLBins all over the place!',
external_service: null,
title: 'Another bad one',
- status: 'open',
+ status: CaseStatuses.open,
tags: ['LOLBins'],
updated_at: '2019-11-25T21:54:48.952Z',
updated_by: {
@@ -314,7 +317,7 @@ describe('update', () => {
cases: [
{
id: 'mock-id-1',
- status: 'open' as const,
+ status: CaseStatuses.open,
version: 'WzAsMV0=',
},
],
diff --git a/x-pack/plugins/case/server/client/cases/update.ts b/x-pack/plugins/case/server/client/cases/update.ts
index a754ce27c5e41..406e43a74cccf 100644
--- a/x-pack/plugins/case/server/client/cases/update.ts
+++ b/x-pack/plugins/case/server/client/cases/update.ts
@@ -19,6 +19,7 @@ import {
ESCasePatchRequest,
CasePatchRequest,
CasesResponse,
+ CaseStatuses,
} from '../../../common/api';
import { buildCaseUserActions } from '../../services/user_actions/helpers';
import {
@@ -98,12 +99,15 @@ export const update = ({
cases: updateFilterCases.map((thisCase) => {
const { id: caseId, version, ...updateCaseAttributes } = thisCase;
let closedInfo = {};
- if (updateCaseAttributes.status && updateCaseAttributes.status === 'closed') {
+ if (updateCaseAttributes.status && updateCaseAttributes.status === CaseStatuses.closed) {
closedInfo = {
closed_at: updatedDt,
closed_by: { email, full_name, username },
};
- } else if (updateCaseAttributes.status && updateCaseAttributes.status === 'open') {
+ } else if (
+ updateCaseAttributes.status &&
+ updateCaseAttributes.status === CaseStatuses.open
+ ) {
closedInfo = {
closed_at: null,
closed_by: null,
diff --git a/x-pack/plugins/case/server/connectors/case/index.test.ts b/x-pack/plugins/case/server/connectors/case/index.test.ts
index 90bb1d604e733..adf94661216cb 100644
--- a/x-pack/plugins/case/server/connectors/case/index.test.ts
+++ b/x-pack/plugins/case/server/connectors/case/index.test.ts
@@ -9,7 +9,7 @@ import { Logger } from '../../../../../../src/core/server';
import { loggingSystemMock } from '../../../../../../src/core/server/mocks';
import { actionsMock } from '../../../../actions/server/mocks';
import { validateParams } from '../../../../actions/server/lib';
-import { ConnectorTypes, CommentType } from '../../../common/api';
+import { ConnectorTypes, CommentType, CaseStatuses } from '../../../common/api';
import {
createCaseServiceMock,
createConfigureServiceMock,
@@ -785,7 +785,7 @@ describe('case connector', () => {
tags: ['case', 'connector'],
description: 'Yo fields!!',
external_service: null,
- status: 'open' as const,
+ status: CaseStatuses.open,
updated_at: null,
updated_by: null,
version: 'WzksMV0=',
@@ -868,7 +868,7 @@ describe('case connector', () => {
description: 'This is a brand new case of a bad meanie defacing data',
id: 'mock-id-1',
external_service: null,
- status: 'open' as const,
+ status: CaseStatuses.open,
tags: ['defacement'],
title: 'Update title',
totalComment: 0,
@@ -937,7 +937,7 @@ describe('case connector', () => {
description: 'This is a brand new case of a bad meanie defacing data',
external_service: null,
title: 'Super Bad Security Issue',
- status: 'open' as const,
+ status: CaseStatuses.open,
tags: ['defacement'],
updated_at: null,
updated_by: null,
diff --git a/x-pack/plugins/case/server/routes/api/__fixtures__/mock_saved_objects.ts b/x-pack/plugins/case/server/routes/api/__fixtures__/mock_saved_objects.ts
index 4c0b5887ca998..95856dd75d0ae 100644
--- a/x-pack/plugins/case/server/routes/api/__fixtures__/mock_saved_objects.ts
+++ b/x-pack/plugins/case/server/routes/api/__fixtures__/mock_saved_objects.ts
@@ -11,6 +11,7 @@ import {
ESCaseAttributes,
ConnectorTypes,
CommentType,
+ CaseStatuses,
} from '../../../../common/api';
export const mockCases: Array> = [
@@ -35,7 +36,7 @@ export const mockCases: Array> = [
description: 'This is a brand new case of a bad meanie defacing data',
external_service: null,
title: 'Super Bad Security Issue',
- status: 'open',
+ status: CaseStatuses.open,
tags: ['defacement'],
updated_at: '2019-11-25T21:54:48.952Z',
updated_by: {
@@ -69,7 +70,7 @@ export const mockCases: Array> = [
description: 'Oh no, a bad meanie destroying data!',
external_service: null,
title: 'Damaging Data Destruction Detected',
- status: 'open',
+ status: CaseStatuses.open,
tags: ['Data Destruction'],
updated_at: '2019-11-25T22:32:00.900Z',
updated_by: {
@@ -107,7 +108,7 @@ export const mockCases: Array> = [
description: 'Oh no, a bad meanie going LOLBins all over the place!',
external_service: null,
title: 'Another bad one',
- status: 'open',
+ status: CaseStatuses.open,
tags: ['LOLBins'],
updated_at: '2019-11-25T22:32:17.947Z',
updated_by: {
@@ -148,7 +149,7 @@ export const mockCases: Array> = [
},
description: 'Oh no, a bad meanie going LOLBins all over the place!',
external_service: null,
- status: 'closed',
+ status: CaseStatuses.closed,
title: 'Another bad one',
tags: ['LOLBins'],
updated_at: '2019-11-25T22:32:17.947Z',
@@ -179,7 +180,7 @@ export const mockCaseNoConnectorId: SavedObject> = {
description: 'This is a brand new case of a bad meanie defacing data',
external_service: null,
title: 'Super Bad Security Issue',
- status: 'open',
+ status: CaseStatuses.open,
tags: ['defacement'],
updated_at: '2019-11-25T21:54:48.952Z',
updated_by: {
diff --git a/x-pack/plugins/case/server/routes/api/cases/find_cases.test.ts b/x-pack/plugins/case/server/routes/api/cases/find_cases.test.ts
index b2ba8b2fcb33a..dca94589bf72a 100644
--- a/x-pack/plugins/case/server/routes/api/cases/find_cases.test.ts
+++ b/x-pack/plugins/case/server/routes/api/cases/find_cases.test.ts
@@ -38,6 +38,10 @@ describe('FIND all cases', () => {
const response = await routeHandler(theContext, request, kibanaResponseFactory);
expect(response.status).toEqual(200);
expect(response.payload.cases).toHaveLength(4);
+ // mockSavedObjectsRepository do not support filters and returns all cases every time.
+ expect(response.payload.count_open_cases).toEqual(4);
+ expect(response.payload.count_closed_cases).toEqual(4);
+ expect(response.payload.count_in_progress_cases).toEqual(4);
});
it(`has proper connector id on cases with configured connector`, async () => {
diff --git a/x-pack/plugins/case/server/routes/api/cases/find_cases.ts b/x-pack/plugins/case/server/routes/api/cases/find_cases.ts
index e70225456d5a8..b034e86b4f0d4 100644
--- a/x-pack/plugins/case/server/routes/api/cases/find_cases.ts
+++ b/x-pack/plugins/case/server/routes/api/cases/find_cases.ts
@@ -11,7 +11,13 @@ import { fold } from 'fp-ts/lib/Either';
import { identity } from 'fp-ts/lib/function';
import { isEmpty } from 'lodash';
-import { CasesFindResponseRt, CasesFindRequestRt, throwErrors } from '../../../../common/api';
+import {
+ CasesFindResponseRt,
+ CasesFindRequestRt,
+ throwErrors,
+ CaseStatuses,
+ caseStatuses,
+} from '../../../../common/api';
import { transformCases, sortToSnake, wrapError, escapeHatch } from '../utils';
import { RouteDeps, TotalCommentByCase } from '../types';
import { CASE_SAVED_OBJECT } from '../../../saved_object_types';
@@ -20,7 +26,7 @@ import { CASES_URL } from '../../../../common/constants';
const combineFilters = (filters: string[], operator: 'OR' | 'AND'): string =>
filters?.filter((i) => i !== '').join(` ${operator} `);
-const getStatusFilter = (status: 'open' | 'closed', appendFilter?: string) =>
+const getStatusFilter = (status: CaseStatuses, appendFilter?: string) =>
`${CASE_SAVED_OBJECT}.attributes.status: ${status}${
!isEmpty(appendFilter) ? ` AND ${appendFilter}` : ''
}`;
@@ -75,30 +81,21 @@ export function initFindCasesApi({ caseService, caseConfigureService, router }:
client,
};
- const argsOpenCases = {
+ const statusArgs = caseStatuses.map((caseStatus) => ({
client,
options: {
fields: [],
page: 1,
perPage: 1,
- filter: getStatusFilter('open', myFilters),
+ filter: getStatusFilter(caseStatus, myFilters),
},
- };
+ }));
- const argsClosedCases = {
- client,
- options: {
- fields: [],
- page: 1,
- perPage: 1,
- filter: getStatusFilter('closed', myFilters),
- },
- };
- const [cases, openCases, closesCases] = await Promise.all([
+ const [cases, openCases, inProgressCases, closedCases] = await Promise.all([
caseService.findCases(args),
- caseService.findCases(argsOpenCases),
- caseService.findCases(argsClosedCases),
+ ...statusArgs.map((arg) => caseService.findCases(arg)),
]);
+
const totalCommentsFindByCases = await Promise.all(
cases.saved_objects.map((c) =>
caseService.getAllCaseComments({
@@ -133,7 +130,8 @@ export function initFindCasesApi({ caseService, caseConfigureService, router }:
transformCases(
cases,
openCases.total ?? 0,
- closesCases.total ?? 0,
+ inProgressCases.total ?? 0,
+ closedCases.total ?? 0,
totalCommentsByCases
)
),
diff --git a/x-pack/plugins/case/server/routes/api/cases/patch_cases.test.ts b/x-pack/plugins/case/server/routes/api/cases/patch_cases.test.ts
index ea69ee77c5802..053f9ec18ab0f 100644
--- a/x-pack/plugins/case/server/routes/api/cases/patch_cases.test.ts
+++ b/x-pack/plugins/case/server/routes/api/cases/patch_cases.test.ts
@@ -16,7 +16,7 @@ import {
} from '../__fixtures__';
import { initPatchCasesApi } from './patch_cases';
import { mockCaseConfigure, mockCaseNoConnectorId } from '../__fixtures__/mock_saved_objects';
-import { ConnectorTypes } from '../../../../common/api/connectors';
+import { ConnectorTypes, CaseStatuses } from '../../../../common/api';
describe('PATCH cases', () => {
let routeHandler: RequestHandler;
@@ -36,7 +36,7 @@ describe('PATCH cases', () => {
cases: [
{
id: 'mock-id-1',
- status: 'closed',
+ status: CaseStatuses.closed,
version: 'WzAsMV0=',
},
],
@@ -67,7 +67,7 @@ describe('PATCH cases', () => {
description: 'This is a brand new case of a bad meanie defacing data',
id: 'mock-id-1',
external_service: null,
- status: 'closed',
+ status: CaseStatuses.closed,
tags: ['defacement'],
title: 'Super Bad Security Issue',
totalComment: 0,
@@ -86,7 +86,7 @@ describe('PATCH cases', () => {
cases: [
{
id: 'mock-id-4',
- status: 'open',
+ status: CaseStatuses.open,
version: 'WzUsMV0=',
},
],
@@ -118,7 +118,7 @@ describe('PATCH cases', () => {
description: 'Oh no, a bad meanie going LOLBins all over the place!',
id: 'mock-id-4',
external_service: null,
- status: 'open',
+ status: CaseStatuses.open,
tags: ['LOLBins'],
title: 'Another bad one',
totalComment: 0,
@@ -129,6 +129,56 @@ describe('PATCH cases', () => {
]);
});
+ it(`Change case to in-progress`, async () => {
+ const request = httpServerMock.createKibanaRequest({
+ path: '/api/cases',
+ method: 'patch',
+ body: {
+ cases: [
+ {
+ id: 'mock-id-1',
+ status: CaseStatuses['in-progress'],
+ version: 'WzAsMV0=',
+ },
+ ],
+ },
+ });
+
+ const theContext = await createRouteContext(
+ createMockSavedObjectsRepository({
+ caseSavedObject: mockCases,
+ })
+ );
+
+ const response = await routeHandler(theContext, request, kibanaResponseFactory);
+ expect(response.status).toEqual(200);
+ expect(response.payload).toEqual([
+ {
+ closed_at: null,
+ closed_by: null,
+ comments: [],
+ connector: {
+ id: 'none',
+ name: 'none',
+ type: ConnectorTypes.none,
+ fields: null,
+ },
+ created_at: '2019-11-25T21:54:48.952Z',
+ created_by: { email: 'testemail@elastic.co', full_name: 'elastic', username: 'elastic' },
+ description: 'This is a brand new case of a bad meanie defacing data',
+ id: 'mock-id-1',
+ external_service: null,
+ status: CaseStatuses['in-progress'],
+ tags: ['defacement'],
+ title: 'Super Bad Security Issue',
+ totalComment: 0,
+ updated_at: '2019-11-25T21:54:48.952Z',
+ updated_by: { email: 'd00d@awesome.com', full_name: 'Awesome D00d', username: 'awesome' },
+ version: 'WzE3LDFd',
+ },
+ ]);
+ });
+
it(`Patches a case without a connector.id`, async () => {
const request = httpServerMock.createKibanaRequest({
path: '/api/cases',
@@ -137,7 +187,7 @@ describe('PATCH cases', () => {
cases: [
{
id: 'mock-no-connector_id',
- status: 'closed',
+ status: CaseStatuses.closed,
version: 'WzAsMV0=',
},
],
@@ -163,7 +213,7 @@ describe('PATCH cases', () => {
cases: [
{
id: 'mock-id-3',
- status: 'closed',
+ status: CaseStatuses.closed,
version: 'WzUsMV0=',
},
],
@@ -225,7 +275,7 @@ describe('PATCH cases', () => {
cases: [
{
id: 'mock-id-1',
- case: { status: 'closed' },
+ case: { status: CaseStatuses.closed },
version: 'badv=',
},
],
@@ -250,7 +300,7 @@ describe('PATCH cases', () => {
cases: [
{
id: 'mock-id-1',
- case: { status: 'open' },
+ case: { status: CaseStatuses.open },
version: 'WzAsMV0=',
},
],
@@ -276,7 +326,7 @@ describe('PATCH cases', () => {
cases: [
{
id: 'mock-id-does-not-exist',
- status: 'closed',
+ status: CaseStatuses.closed,
version: 'WzAsMV0=',
},
],
diff --git a/x-pack/plugins/case/server/routes/api/cases/post_case.test.ts b/x-pack/plugins/case/server/routes/api/cases/post_case.test.ts
index 1e1b19baa1c47..508684b422891 100644
--- a/x-pack/plugins/case/server/routes/api/cases/post_case.test.ts
+++ b/x-pack/plugins/case/server/routes/api/cases/post_case.test.ts
@@ -16,7 +16,7 @@ import {
import { initPostCaseApi } from './post_case';
import { CASES_URL } from '../../../../common/constants';
import { mockCaseConfigure } from '../__fixtures__/mock_saved_objects';
-import { ConnectorTypes } from '../../../../common/api/connectors';
+import { ConnectorTypes, CaseStatuses } from '../../../../common/api';
describe('POST cases', () => {
let routeHandler: RequestHandler;
@@ -54,6 +54,7 @@ describe('POST cases', () => {
const response = await routeHandler(theContext, request, kibanaResponseFactory);
expect(response.status).toEqual(200);
expect(response.payload.id).toEqual('mock-it');
+ expect(response.payload.status).toEqual('open');
expect(response.payload.created_by.username).toEqual('awesome');
expect(response.payload.connector).toEqual({
id: 'none',
@@ -104,7 +105,7 @@ describe('POST cases', () => {
body: {
description: 'This is a brand new case of a bad meanie defacing data',
title: 'Super Bad Security Issue',
- status: 'open',
+ status: CaseStatuses.open,
tags: ['defacement'],
connector: null,
},
@@ -191,7 +192,7 @@ describe('POST cases', () => {
description: 'This is a brand new case of a bad meanie defacing data',
external_service: null,
id: 'mock-it',
- status: 'open',
+ status: CaseStatuses.open,
tags: ['defacement'],
title: 'Super Bad Security Issue',
totalComment: 0,
diff --git a/x-pack/plugins/case/server/routes/api/cases/push_case.ts b/x-pack/plugins/case/server/routes/api/cases/push_case.ts
index 6ba2da111090f..6a6b09dc3f87a 100644
--- a/x-pack/plugins/case/server/routes/api/cases/push_case.ts
+++ b/x-pack/plugins/case/server/routes/api/cases/push_case.ts
@@ -18,7 +18,12 @@ import {
getCommentContextFromAttributes,
} from '../utils';
-import { CaseExternalServiceRequestRt, CaseResponseRt, throwErrors } from '../../../../common/api';
+import {
+ CaseExternalServiceRequestRt,
+ CaseResponseRt,
+ throwErrors,
+ CaseStatuses,
+} from '../../../../common/api';
import { buildCaseUserActionItem } from '../../../services/user_actions/helpers';
import { RouteDeps } from '../types';
import { CASE_DETAILS_URL } from '../../../../common/constants';
@@ -77,7 +82,7 @@ export function initPushCaseUserActionApi({
actionsClient.getAll(),
]);
- if (myCase.attributes.status === 'closed') {
+ if (myCase.attributes.status === CaseStatuses.closed) {
throw Boom.conflict(
`This case ${myCase.attributes.title} is closed. You can not pushed if the case is closed.`
);
@@ -117,7 +122,7 @@ export function initPushCaseUserActionApi({
...(myCaseConfigure.total > 0 &&
myCaseConfigure.saved_objects[0].attributes.closure_type === 'close-by-pushing'
? {
- status: 'closed',
+ status: CaseStatuses.closed,
closed_at: pushedDate,
closed_by: { email, full_name, username },
}
@@ -153,7 +158,7 @@ export function initPushCaseUserActionApi({
actionBy: { username, full_name, email },
caseId,
fields: ['status'],
- newValue: 'closed',
+ newValue: CaseStatuses.closed,
oldValue: myCase.attributes.status,
}),
]
diff --git a/x-pack/plugins/case/server/routes/api/cases/status/get_status.ts b/x-pack/plugins/case/server/routes/api/cases/status/get_status.ts
index 8f86dbc91f315..4379a6b56367c 100644
--- a/x-pack/plugins/case/server/routes/api/cases/status/get_status.ts
+++ b/x-pack/plugins/case/server/routes/api/cases/status/get_status.ts
@@ -7,7 +7,7 @@
import { RouteDeps } from '../../types';
import { wrapError } from '../../utils';
-import { CasesStatusResponseRt } from '../../../../../common/api';
+import { CasesStatusResponseRt, caseStatuses } from '../../../../../common/api';
import { CASE_SAVED_OBJECT } from '../../../../saved_object_types';
import { CASE_STATUS_URL } from '../../../../../common/constants';
@@ -20,34 +20,24 @@ export function initGetCasesStatusApi({ caseService, router }: RouteDeps) {
async (context, request, response) => {
try {
const client = context.core.savedObjects.client;
- const argsOpenCases = {
+ const args = caseStatuses.map((status) => ({
client,
options: {
fields: [],
page: 1,
perPage: 1,
- filter: `${CASE_SAVED_OBJECT}.attributes.status: open`,
+ filter: `${CASE_SAVED_OBJECT}.attributes.status: ${status}`,
},
- };
+ }));
- const argsClosedCases = {
- client,
- options: {
- fields: [],
- page: 1,
- perPage: 1,
- filter: `${CASE_SAVED_OBJECT}.attributes.status: closed`,
- },
- };
-
- const [openCases, closesCases] = await Promise.all([
- caseService.findCases(argsOpenCases),
- caseService.findCases(argsClosedCases),
- ]);
+ const [openCases, inProgressCases, closesCases] = await Promise.all(
+ args.map((arg) => caseService.findCases(arg))
+ );
return response.ok({
body: CasesStatusResponseRt.encode({
count_open_cases: openCases.total,
+ count_in_progress_cases: inProgressCases.total,
count_closed_cases: closesCases.total,
}),
});
diff --git a/x-pack/plugins/case/server/routes/api/utils.test.ts b/x-pack/plugins/case/server/routes/api/utils.test.ts
index a67bae5ed74dc..7654ae5ff0d1a 100644
--- a/x-pack/plugins/case/server/routes/api/utils.test.ts
+++ b/x-pack/plugins/case/server/routes/api/utils.test.ts
@@ -23,7 +23,7 @@ import {
mockCaseComments,
mockCaseNoConnectorId,
} from './__fixtures__/mock_saved_objects';
-import { ConnectorTypes, ESCaseConnector, CommentType } from '../../../common/api';
+import { ConnectorTypes, ESCaseConnector, CommentType, CaseStatuses } from '../../../common/api';
describe('Utils', () => {
describe('transformNewCase', () => {
@@ -57,7 +57,7 @@ describe('Utils', () => {
created_at: '2020-04-09T09:43:51.778Z',
created_by: { email: 'elastic@elastic.co', full_name: 'Elastic', username: 'elastic' },
external_service: null,
- status: 'open',
+ status: CaseStatuses.open,
updated_at: null,
updated_by: null,
});
@@ -80,7 +80,7 @@ describe('Utils', () => {
created_at: '2020-04-09T09:43:51.778Z',
created_by: { email: undefined, full_name: undefined, username: undefined },
external_service: null,
- status: 'open',
+ status: CaseStatuses.open,
updated_at: null,
updated_by: null,
});
@@ -106,7 +106,7 @@ describe('Utils', () => {
created_at: '2020-04-09T09:43:51.778Z',
created_by: { email: null, full_name: null, username: null },
external_service: null,
- status: 'open',
+ status: CaseStatuses.open,
updated_at: null,
updated_by: null,
});
@@ -247,6 +247,7 @@ describe('Utils', () => {
},
2,
2,
+ 2,
extraCaseData
);
expect(res).toEqual({
@@ -259,6 +260,7 @@ describe('Utils', () => {
),
count_open_cases: 2,
count_closed_cases: 2,
+ count_in_progress_cases: 2,
});
});
});
@@ -289,7 +291,7 @@ describe('Utils', () => {
description: 'This is a brand new case of a bad meanie defacing data',
external_service: null,
title: 'Super Bad Security Issue',
- status: 'open',
+ status: CaseStatuses.open,
tags: ['defacement'],
updated_at: '2019-11-25T21:54:48.952Z',
updated_by: {
@@ -328,7 +330,7 @@ describe('Utils', () => {
description: 'This is a brand new case of a bad meanie defacing data',
external_service: null,
title: 'Super Bad Security Issue',
- status: 'open',
+ status: CaseStatuses.open,
tags: ['defacement'],
updated_at: '2019-11-25T21:54:48.952Z',
updated_by: {
@@ -374,7 +376,7 @@ describe('Utils', () => {
description: 'This is a brand new case of a bad meanie defacing data',
external_service: null,
title: 'Super Bad Security Issue',
- status: 'open',
+ status: CaseStatuses.open,
tags: ['defacement'],
updated_at: '2019-11-25T21:54:48.952Z',
updated_by: {
@@ -484,7 +486,7 @@ describe('Utils', () => {
description: 'This is a brand new case of a bad meanie defacing data',
external_service: null,
title: 'Super Bad Security Issue',
- status: 'open',
+ status: CaseStatuses.open,
tags: ['defacement'],
updated_at: '2019-11-25T21:54:48.952Z',
updated_by: {
diff --git a/x-pack/plugins/case/server/routes/api/utils.ts b/x-pack/plugins/case/server/routes/api/utils.ts
index 589d7c02a7be6..c8753772648c2 100644
--- a/x-pack/plugins/case/server/routes/api/utils.ts
+++ b/x-pack/plugins/case/server/routes/api/utils.ts
@@ -33,6 +33,7 @@ import {
CommentType,
excess,
throwErrors,
+ CaseStatuses,
} from '../../../common/api';
import { transformESConnectorToCaseConnector } from './cases/helpers';
@@ -61,7 +62,7 @@ export const transformNewCase = ({
created_at: createdDate,
created_by: { email, full_name, username },
external_service: null,
- status: 'open',
+ status: CaseStatuses.open,
updated_at: null,
updated_by: null,
});
@@ -103,6 +104,7 @@ export function wrapError(error: any): CustomHttpResponseOptions
export const transformCases = (
cases: SavedObjectsFindResponse,
countOpenCases: number,
+ countInProgressCases: number,
countClosedCases: number,
totalCommentByCase: TotalCommentByCase[]
): CasesFindResponse => ({
@@ -111,6 +113,7 @@ export const transformCases = (
total: cases.total,
cases: flattenCaseSavedObjects(cases.saved_objects, totalCommentByCase),
count_open_cases: countOpenCases,
+ count_in_progress_cases: countInProgressCases,
count_closed_cases: countClosedCases,
});
diff --git a/x-pack/plugins/encrypted_saved_objects/server/crypto/encrypted_saved_object_type_definition.test.ts b/x-pack/plugins/encrypted_saved_objects/server/crypto/encrypted_saved_object_type_definition.test.ts
index f1e06a0cec03d..f528843cf9ea3 100644
--- a/x-pack/plugins/encrypted_saved_objects/server/crypto/encrypted_saved_object_type_definition.test.ts
+++ b/x-pack/plugins/encrypted_saved_objects/server/crypto/encrypted_saved_object_type_definition.test.ts
@@ -113,18 +113,3 @@ it('correctly determines attribute properties', () => {
}
}
});
-
-it('it correctly sets allowPredefinedID', () => {
- const defaultTypeDefinition = new EncryptedSavedObjectAttributesDefinition({
- type: 'so-type',
- attributesToEncrypt: new Set(['attr#1', 'attr#2']),
- });
- expect(defaultTypeDefinition.allowPredefinedID).toBe(false);
-
- const typeDefinitionWithPredefinedIDAllowed = new EncryptedSavedObjectAttributesDefinition({
- type: 'so-type',
- attributesToEncrypt: new Set(['attr#1', 'attr#2']),
- allowPredefinedID: true,
- });
- expect(typeDefinitionWithPredefinedIDAllowed.allowPredefinedID).toBe(true);
-});
diff --git a/x-pack/plugins/encrypted_saved_objects/server/crypto/encrypted_saved_object_type_definition.ts b/x-pack/plugins/encrypted_saved_objects/server/crypto/encrypted_saved_object_type_definition.ts
index 398a64585411a..849a2888b6e1a 100644
--- a/x-pack/plugins/encrypted_saved_objects/server/crypto/encrypted_saved_object_type_definition.ts
+++ b/x-pack/plugins/encrypted_saved_objects/server/crypto/encrypted_saved_object_type_definition.ts
@@ -15,7 +15,6 @@ export class EncryptedSavedObjectAttributesDefinition {
public readonly attributesToEncrypt: ReadonlySet;
private readonly attributesToExcludeFromAAD: ReadonlySet | undefined;
private readonly attributesToStrip: ReadonlySet;
- public readonly allowPredefinedID: boolean;
constructor(typeRegistration: EncryptedSavedObjectTypeRegistration) {
const attributesToEncrypt = new Set();
@@ -35,7 +34,6 @@ export class EncryptedSavedObjectAttributesDefinition {
this.attributesToEncrypt = attributesToEncrypt;
this.attributesToStrip = attributesToStrip;
this.attributesToExcludeFromAAD = typeRegistration.attributesToExcludeFromAAD;
- this.allowPredefinedID = !!typeRegistration.allowPredefinedID;
}
/**
diff --git a/x-pack/plugins/encrypted_saved_objects/server/crypto/encrypted_saved_objects_service.mocks.ts b/x-pack/plugins/encrypted_saved_objects/server/crypto/encrypted_saved_objects_service.mocks.ts
index 0138e929ca1ca..c692d8698771f 100644
--- a/x-pack/plugins/encrypted_saved_objects/server/crypto/encrypted_saved_objects_service.mocks.ts
+++ b/x-pack/plugins/encrypted_saved_objects/server/crypto/encrypted_saved_objects_service.mocks.ts
@@ -13,7 +13,6 @@ import {
function createEncryptedSavedObjectsServiceMock() {
return ({
isRegistered: jest.fn(),
- canSpecifyID: jest.fn(),
stripOrDecryptAttributes: jest.fn(),
encryptAttributes: jest.fn(),
decryptAttributes: jest.fn(),
@@ -53,12 +52,6 @@ export const encryptedSavedObjectsServiceMock = {
mock.isRegistered.mockImplementation(
(type) => registrations.findIndex((r) => r.type === type) >= 0
);
- mock.canSpecifyID.mockImplementation((type, version, overwrite) => {
- const registration = registrations.find((r) => r.type === type);
- return (
- registration === undefined || registration.allowPredefinedID || !!(version && overwrite)
- );
- });
mock.encryptAttributes.mockImplementation(async (descriptor, attrs) =>
processAttributes(
descriptor,
diff --git a/x-pack/plugins/encrypted_saved_objects/server/crypto/encrypted_saved_objects_service.test.ts b/x-pack/plugins/encrypted_saved_objects/server/crypto/encrypted_saved_objects_service.test.ts
index 6bc4a392064e4..88d57072697fe 100644
--- a/x-pack/plugins/encrypted_saved_objects/server/crypto/encrypted_saved_objects_service.test.ts
+++ b/x-pack/plugins/encrypted_saved_objects/server/crypto/encrypted_saved_objects_service.test.ts
@@ -89,45 +89,6 @@ describe('#isRegistered', () => {
});
});
-describe('#canSpecifyID', () => {
- it('returns true for unknown types', () => {
- expect(service.canSpecifyID('unknown-type')).toBe(true);
- });
-
- it('returns true for types registered setting allowPredefinedID to true', () => {
- service.registerType({
- type: 'known-type-1',
- attributesToEncrypt: new Set(['attr-1']),
- allowPredefinedID: true,
- });
- expect(service.canSpecifyID('known-type-1')).toBe(true);
- });
-
- it('returns true when overwriting a saved object with a version specified even when allowPredefinedID is not set', () => {
- service.registerType({
- type: 'known-type-1',
- attributesToEncrypt: new Set(['attr-1']),
- });
- expect(service.canSpecifyID('known-type-1', '2', true)).toBe(true);
- expect(service.canSpecifyID('known-type-1', '2', false)).toBe(false);
- expect(service.canSpecifyID('known-type-1', undefined, true)).toBe(false);
- });
-
- it('returns false for types registered without setting allowPredefinedID', () => {
- service.registerType({ type: 'known-type-1', attributesToEncrypt: new Set(['attr-1']) });
- expect(service.canSpecifyID('known-type-1')).toBe(false);
- });
-
- it('returns false for types registered setting allowPredefinedID to false', () => {
- service.registerType({
- type: 'known-type-1',
- attributesToEncrypt: new Set(['attr-1']),
- allowPredefinedID: false,
- });
- expect(service.canSpecifyID('known-type-1')).toBe(false);
- });
-});
-
describe('#stripOrDecryptAttributes', () => {
it('does not strip attributes from unknown types', async () => {
const attributes = { attrOne: 'one', attrTwo: 'two', attrThree: 'three' };
diff --git a/x-pack/plugins/encrypted_saved_objects/server/crypto/encrypted_saved_objects_service.ts b/x-pack/plugins/encrypted_saved_objects/server/crypto/encrypted_saved_objects_service.ts
index 8d2ebb575c35e..1f1093a179538 100644
--- a/x-pack/plugins/encrypted_saved_objects/server/crypto/encrypted_saved_objects_service.ts
+++ b/x-pack/plugins/encrypted_saved_objects/server/crypto/encrypted_saved_objects_service.ts
@@ -31,7 +31,6 @@ export interface EncryptedSavedObjectTypeRegistration {
readonly type: string;
readonly attributesToEncrypt: ReadonlySet;
readonly attributesToExcludeFromAAD?: ReadonlySet