+
+
+
+
+
+
+
+
+
+
+ -
+
+
+
+
+
+
+
+
+
+
+
{},
closeNav: () => {},
navigateToApp: () => Promise.resolve(),
+ customNavLink$: new BehaviorSubject(undefined),
};
}
@@ -120,12 +121,14 @@ describe('CollapsibleNav', () => {
mockRecentNavLink({ label: 'recent 1' }),
mockRecentNavLink({ label: 'recent 2' }),
];
+ const customNavLink = mockLink({ title: 'Custom link' });
const component = mount(
);
expect(component).toMatchSnapshot();
diff --git a/src/core/public/chrome/ui/header/collapsible_nav.tsx b/src/core/public/chrome/ui/header/collapsible_nav.tsx
index 9494e22920de8..07541b1adff16 100644
--- a/src/core/public/chrome/ui/header/collapsible_nav.tsx
+++ b/src/core/public/chrome/ui/header/collapsible_nav.tsx
@@ -30,7 +30,7 @@ import {
} from '@elastic/eui';
import { i18n } from '@kbn/i18n';
import { groupBy, sortBy } from 'lodash';
-import React, { useRef } from 'react';
+import React, { Fragment, useRef } from 'react';
import { useObservable } from 'react-use';
import * as Rx from 'rxjs';
import { ChromeNavLink, ChromeRecentlyAccessedHistoryItem } from '../..';
@@ -88,6 +88,7 @@ interface Props {
onIsLockedUpdate: OnIsLockedUpdate;
closeNav: () => void;
navigateToApp: InternalApplicationStart['navigateToApp'];
+ customNavLink$: Rx.Observable;
}
export function CollapsibleNav({
@@ -105,6 +106,7 @@ export function CollapsibleNav({
}: Props) {
const navLinks = useObservable(observables.navLinks$, []).filter((link) => !link.hidden);
const recentlyAccessed = useObservable(observables.recentlyAccessed$, []);
+ const customNavLink = useObservable(observables.customNavLink$, undefined);
const appId = useObservable(observables.appId$, '');
const lockRef = useRef(null);
const groupedNavLinks = groupBy(navLinks, (link) => link?.category?.id);
@@ -134,6 +136,38 @@ export function CollapsibleNav({
isDocked={isLocked}
onClose={closeNav}
>
+ {customNavLink && (
+
+
+
+
+
+
+
+
+
+ )}
+
{/* Pinned items */}
{
const navLinks$ = new BehaviorSubject([
{ id: 'kibana', title: 'kibana', baseUrl: '', legacy: false },
]);
+ const customNavLink$ = new BehaviorSubject({
+ id: 'cloud-deployment-link',
+ title: 'Manage cloud deployment',
+ baseUrl: '',
+ legacy: false,
+ });
const recentlyAccessed$ = new BehaviorSubject([
{ link: '', label: 'dashboard', id: 'dashboard' },
]);
@@ -87,6 +94,7 @@ describe('Header', () => {
recentlyAccessed$={recentlyAccessed$}
isLocked$={isLocked$}
navType$={navType$}
+ customNavLink$={customNavLink$}
/>
);
expect(component).toMatchSnapshot();
diff --git a/src/core/public/chrome/ui/header/header.tsx b/src/core/public/chrome/ui/header/header.tsx
index d24b342e0386b..3da3caaaa4a4f 100644
--- a/src/core/public/chrome/ui/header/header.tsx
+++ b/src/core/public/chrome/ui/header/header.tsx
@@ -58,6 +58,7 @@ export interface HeaderProps {
appTitle$: Observable;
badge$: Observable;
breadcrumbs$: Observable;
+ customNavLink$: Observable;
homeHref: string;
isVisible$: Observable;
kibanaDocLink: string;
@@ -203,6 +204,7 @@ export function Header({
toggleCollapsibleNavRef.current.focus();
}
}}
+ customNavLink$={observables.customNavLink$}
/>
) : (
// TODO #64541
diff --git a/src/core/public/chrome/ui/header/nav_link.tsx b/src/core/public/chrome/ui/header/nav_link.tsx
index 969b6728e0263..6b5cecd138376 100644
--- a/src/core/public/chrome/ui/header/nav_link.tsx
+++ b/src/core/public/chrome/ui/header/nav_link.tsx
@@ -35,11 +35,12 @@ function LinkIcon({ url }: { url: string }) {
interface Props {
link: ChromeNavLink;
legacyMode: boolean;
- appId: string | undefined;
+ appId?: string;
basePath?: HttpStart['basePath'];
dataTestSubj: string;
onClick?: Function;
navigateToApp: CoreStart['application']['navigateToApp'];
+ externalLink?: boolean;
}
// TODO #64541
@@ -54,6 +55,7 @@ export function createEuiListItem({
onClick = () => {},
navigateToApp,
dataTestSubj,
+ externalLink = false,
}: Props) {
const { legacy, active, id, title, disabled, euiIconType, icon, tooltip } = link;
let { href } = link;
@@ -69,6 +71,7 @@ export function createEuiListItem({
onClick(event: React.MouseEvent) {
onClick();
if (
+ !externalLink && // ignore external links
!legacyMode && // ignore when in legacy mode
!legacy && // ignore links to legacy apps
!event.defaultPrevented && // onClick prevented default
diff --git a/src/core/public/core_system.ts b/src/core/public/core_system.ts
index d6172b77d3ca5..00fabc2b6f2f1 100644
--- a/src/core/public/core_system.ts
+++ b/src/core/public/core_system.ts
@@ -163,7 +163,7 @@ export class CoreSystem {
i18n: this.i18n.getContext(),
});
await this.integrations.setup();
- const docLinks = this.docLinks.setup({ injectedMetadata });
+ this.docLinks.setup();
const http = this.http.setup({ injectedMetadata, fatalErrors: this.fatalErrorsSetup });
const uiSettings = this.uiSettings.setup({ http, injectedMetadata });
const notifications = this.notifications.setup({ uiSettings });
@@ -185,7 +185,6 @@ export class CoreSystem {
const core: InternalCoreSetup = {
application,
context,
- docLinks,
fatalErrors: this.fatalErrorsSetup,
http,
injectedMetadata,
@@ -217,7 +216,7 @@ export class CoreSystem {
try {
const injectedMetadata = await this.injectedMetadata.start();
const uiSettings = await this.uiSettings.start();
- const docLinks = this.docLinks.start();
+ const docLinks = this.docLinks.start({ injectedMetadata });
const http = await this.http.start();
const savedObjects = await this.savedObjects.start({ http });
const i18n = await this.i18n.start();
diff --git a/src/core/public/doc_links/doc_links_service.mock.ts b/src/core/public/doc_links/doc_links_service.mock.ts
index 9edcf2e3c7990..105c13f96cef6 100644
--- a/src/core/public/doc_links/doc_links_service.mock.ts
+++ b/src/core/public/doc_links/doc_links_service.mock.ts
@@ -18,25 +18,23 @@
*/
import { injectedMetadataServiceMock } from '../injected_metadata/injected_metadata_service.mock';
-import { DocLinksService, DocLinksSetup, DocLinksStart } from './doc_links_service';
+import { DocLinksService, DocLinksStart } from './doc_links_service';
-const createSetupContractMock = (): DocLinksSetup => {
+const createStartContractMock = (): DocLinksStart => {
// This service is so simple that we actually use the real implementation
const injectedMetadata = injectedMetadataServiceMock.createStartContract();
injectedMetadata.getKibanaBranch.mockReturnValue('mocked-test-branch');
- return new DocLinksService().setup({ injectedMetadata });
+ return new DocLinksService().start({ injectedMetadata });
};
-const createStartContractMock: () => DocLinksStart = createSetupContractMock;
-
type DocLinksServiceContract = PublicMethodsOf;
const createMock = (): jest.Mocked => ({
- setup: jest.fn().mockReturnValue(createSetupContractMock()),
+ setup: jest.fn().mockReturnValue(undefined),
start: jest.fn().mockReturnValue(createStartContractMock()),
});
export const docLinksServiceMock = {
create: createMock,
- createSetupContract: createSetupContractMock,
+ createSetupContract: () => jest.fn(),
createStartContract: createStartContractMock,
};
diff --git a/src/core/public/doc_links/doc_links_service.test.ts b/src/core/public/doc_links/doc_links_service.test.ts
index 4c5d6bcde8b77..c430ae7655040 100644
--- a/src/core/public/doc_links/doc_links_service.test.ts
+++ b/src/core/public/doc_links/doc_links_service.test.ts
@@ -20,33 +20,15 @@
import { DocLinksService } from './doc_links_service';
import { injectedMetadataServiceMock } from '../injected_metadata/injected_metadata_service.mock';
-describe('DocLinksService#setup()', () => {
+describe('DocLinksService#start()', () => {
it('templates the doc links with the branch information from injectedMetadata', () => {
const injectedMetadata = injectedMetadataServiceMock.createStartContract();
injectedMetadata.getKibanaBranch.mockReturnValue('test-branch');
const service = new DocLinksService();
- const setup = service.setup({ injectedMetadata });
- expect(setup.DOC_LINK_VERSION).toEqual('test-branch');
- expect(setup.links.kibana).toEqual(
+ const api = service.start({ injectedMetadata });
+ expect(api.DOC_LINK_VERSION).toEqual('test-branch');
+ expect(api.links.kibana).toEqual(
'https://www.elastic.co/guide/en/kibana/test-branch/index.html'
);
});
});
-
-describe('DocLinksService#start()', () => {
- it('returns the same data as setup', () => {
- const injectedMetadata = injectedMetadataServiceMock.createStartContract();
- injectedMetadata.getKibanaBranch.mockReturnValue('test-branch');
- const service = new DocLinksService();
- const setup = service.setup({ injectedMetadata });
- const start = service.start();
- expect(setup).toEqual(start);
- });
-
- it('must be called after setup', () => {
- const service = new DocLinksService();
- expect(() => {
- service.start();
- }).toThrowErrorMatchingInlineSnapshot(`"DocLinksService#setup() must be called first!"`);
- });
-});
diff --git a/src/core/public/doc_links/doc_links_service.ts b/src/core/public/doc_links/doc_links_service.ts
index f2bc90a5b08d4..0662586797164 100644
--- a/src/core/public/doc_links/doc_links_service.ts
+++ b/src/core/public/doc_links/doc_links_service.ts
@@ -20,20 +20,19 @@
import { InjectedMetadataSetup } from '../injected_metadata';
import { deepFreeze } from '../../utils';
-interface SetupDeps {
+interface StartDeps {
injectedMetadata: InjectedMetadataSetup;
}
/** @internal */
export class DocLinksService {
- private service?: DocLinksSetup;
-
- public setup({ injectedMetadata }: SetupDeps): DocLinksSetup {
+ public setup() {}
+ public start({ injectedMetadata }: StartDeps): DocLinksStart {
const DOC_LINK_VERSION = injectedMetadata.getKibanaBranch();
const ELASTIC_WEBSITE_URL = 'https://www.elastic.co/';
const ELASTICSEARCH_DOCS = `${ELASTIC_WEBSITE_URL}guide/en/elasticsearch/reference/${DOC_LINK_VERSION}/`;
- this.service = deepFreeze({
+ return deepFreeze({
DOC_LINK_VERSION,
ELASTIC_WEBSITE_URL,
links: {
@@ -129,21 +128,11 @@ export class DocLinksService {
},
},
});
-
- return this.service;
- }
-
- public start(): DocLinksStart {
- if (!this.service) {
- throw new Error(`DocLinksService#setup() must be called first!`);
- }
-
- return this.service;
}
}
/** @public */
-export interface DocLinksSetup {
+export interface DocLinksStart {
readonly DOC_LINK_VERSION: string;
readonly ELASTIC_WEBSITE_URL: string;
readonly links: {
@@ -236,6 +225,3 @@ export interface DocLinksSetup {
readonly management: Record;
};
}
-
-/** @public */
-export type DocLinksStart = DocLinksSetup;
diff --git a/src/core/public/doc_links/index.ts b/src/core/public/doc_links/index.ts
index fbfa9db5635dd..fe49d4a7c6a58 100644
--- a/src/core/public/doc_links/index.ts
+++ b/src/core/public/doc_links/index.ts
@@ -17,4 +17,4 @@
* under the License.
*/
-export { DocLinksService, DocLinksSetup, DocLinksStart } from './doc_links_service';
+export { DocLinksService, DocLinksStart } from './doc_links_service';
diff --git a/src/core/public/index.ts b/src/core/public/index.ts
index 99b75f85340f3..41af0f1b8395f 100644
--- a/src/core/public/index.ts
+++ b/src/core/public/index.ts
@@ -67,7 +67,7 @@ import { OverlayStart } from './overlays';
import { Plugin, PluginInitializer, PluginInitializerContext, PluginOpaqueId } from './plugins';
import { UiSettingsState, IUiSettingsClient } from './ui_settings';
import { ApplicationSetup, Capabilities, ApplicationStart } from './application';
-import { DocLinksSetup, DocLinksStart } from './doc_links';
+import { DocLinksStart } from './doc_links';
import { SavedObjectsStart } from './saved_objects';
export { PackageInfo, EnvironmentMode } from '../server/types';
import {
@@ -216,8 +216,6 @@ export interface CoreSetup {
mockSetupDeps = {
application: applicationServiceMock.createInternalSetupContract(),
context: contextServiceMock.createSetupContract(),
- docLinks: docLinksServiceMock.createSetupContract(),
fatalErrors: fatalErrorsServiceMock.createSetupContract(),
http: httpServiceMock.createSetupContract(),
injectedMetadata: pick(injectedMetadataServiceMock.createStartContract(), 'getInjectedVar'),
diff --git a/src/core/public/public.api.md b/src/core/public/public.api.md
index 7970d9f3f86bb..d10e351f4d13e 100644
--- a/src/core/public/public.api.md
+++ b/src/core/public/public.api.md
@@ -154,6 +154,7 @@ export function __kbnBootstrap__(): void;
export interface App extends AppBase {
appRoute?: string;
chromeless?: boolean;
+ exactRoute?: boolean;
mount: AppMount | AppMountDeprecated;
}
@@ -466,6 +467,7 @@ export interface ChromeStart {
getBadge$(): Observable;
getBrand$(): Observable;
getBreadcrumbs$(): Observable;
+ getCustomNavLink$(): Observable | undefined>;
getHelpExtension$(): Observable;
getIsNavDrawerLocked$(): Observable;
getIsVisible$(): Observable;
@@ -478,6 +480,7 @@ export interface ChromeStart {
setBadge(badge?: ChromeBadge): void;
setBrand(brand: ChromeBrand): void;
setBreadcrumbs(newBreadcrumbs: ChromeBreadcrumb[]): void;
+ setCustomNavLink(newCustomNavLink?: Partial): void;
setHelpExtension(helpExtension?: ChromeHelpExtension): void;
setHelpSupportUrl(url: string): void;
setIsVisible(isVisible: boolean): void;
@@ -508,8 +511,6 @@ export interface CoreSetup;
@@ -600,7 +601,7 @@ export const DEFAULT_APP_CATEGORIES: Readonly<{
}>;
// @public (undocumented)
-export interface DocLinksSetup {
+export interface DocLinksStart {
// (undocumented)
readonly DOC_LINK_VERSION: string;
// (undocumented)
@@ -697,9 +698,6 @@ export interface DocLinksSetup {
};
}
-// @public (undocumented)
-export type DocLinksStart = DocLinksSetup;
-
// @public (undocumented)
export interface EnvironmentMode {
// (undocumented)
@@ -1594,6 +1592,6 @@ export interface UserProvidedValues {
// Warnings were encountered during analysis:
//
-// src/core/public/core_system.ts:216:21 - (ae-forgotten-export) The symbol "InternalApplicationStart" needs to be exported by the entry point index.d.ts
+// src/core/public/core_system.ts:215:21 - (ae-forgotten-export) The symbol "InternalApplicationStart" needs to be exported by the entry point index.d.ts
```
diff --git a/src/core/server/capabilities/integration_tests/capabilities_service.test.ts b/src/core/server/capabilities/integration_tests/capabilities_service.test.ts
index 6be9846f5a86a..b4d620965b047 100644
--- a/src/core/server/capabilities/integration_tests/capabilities_service.test.ts
+++ b/src/core/server/capabilities/integration_tests/capabilities_service.test.ts
@@ -20,7 +20,7 @@
import supertest from 'supertest';
import { HttpService, InternalHttpServiceSetup } from '../../http';
import { contextServiceMock } from '../../context/context_service.mock';
-import { loggingServiceMock } from '../../logging/logging_service.mock';
+import { loggingSystemMock } from '../../logging/logging_system.mock';
import { Env } from '../../config';
import { getEnvOptions } from '../../config/__mocks__/env';
import { CapabilitiesService, CapabilitiesSetup } from '..';
@@ -44,7 +44,7 @@ describe('CapabilitiesService', () => {
service = new CapabilitiesService({
coreId,
env,
- logger: loggingServiceMock.create(),
+ logger: loggingSystemMock.create(),
configService: {} as any,
});
serviceSetup = await service.setup({ http: httpSetup });
diff --git a/src/core/server/config/config_service.test.ts b/src/core/server/config/config_service.test.ts
index 5f28fca1371b0..236cf6579d7c8 100644
--- a/src/core/server/config/config_service.test.ts
+++ b/src/core/server/config/config_service.test.ts
@@ -28,12 +28,12 @@ import { rawConfigServiceMock } from './raw_config_service.mock';
import { schema } from '@kbn/config-schema';
import { ConfigService, Env } from '.';
-import { loggingServiceMock } from '../logging/logging_service.mock';
+import { loggingSystemMock } from '../logging/logging_system.mock';
import { getEnvOptions } from './__mocks__/env';
const emptyArgv = getEnvOptions();
const defaultEnv = new Env('/kibana', emptyArgv);
-const logger = loggingServiceMock.create();
+const logger = loggingSystemMock.create();
const getRawConfigProvider = (rawConfig: Record) =>
rawConfigServiceMock.create({ rawConfig });
@@ -443,9 +443,9 @@ test('logs deprecation warning during validation', async () => {
return config;
});
- loggingServiceMock.clear(logger);
+ loggingSystemMock.clear(logger);
await configService.validate();
- expect(loggingServiceMock.collect(logger).warn).toMatchInlineSnapshot(`
+ expect(loggingSystemMock.collect(logger).warn).toMatchInlineSnapshot(`
Array [
Array [
"some deprecation message",
diff --git a/src/core/server/config/integration_tests/config_deprecation.test.mocks.ts b/src/core/server/config/integration_tests/config_deprecation.test.mocks.ts
index 58b2da926b7c3..1d42c7667a34d 100644
--- a/src/core/server/config/integration_tests/config_deprecation.test.mocks.ts
+++ b/src/core/server/config/integration_tests/config_deprecation.test.mocks.ts
@@ -17,9 +17,9 @@
* under the License.
*/
-import { loggingServiceMock } from '../../logging/logging_service.mock';
-export const mockLoggingService = loggingServiceMock.create();
-mockLoggingService.asLoggerFactory.mockImplementation(() => mockLoggingService);
-jest.doMock('../../logging/logging_service', () => ({
- LoggingService: jest.fn(() => mockLoggingService),
+import { loggingSystemMock } from '../../logging/logging_system.mock';
+export const mockLoggingSystem = loggingSystemMock.create();
+mockLoggingSystem.asLoggerFactory.mockImplementation(() => mockLoggingSystem);
+jest.doMock('../../logging/logging_system', () => ({
+ LoggingSystem: jest.fn(() => mockLoggingSystem),
}));
diff --git a/src/core/server/config/integration_tests/config_deprecation.test.ts b/src/core/server/config/integration_tests/config_deprecation.test.ts
index 3523b074ea5b4..56385f3b171c9 100644
--- a/src/core/server/config/integration_tests/config_deprecation.test.ts
+++ b/src/core/server/config/integration_tests/config_deprecation.test.ts
@@ -17,8 +17,8 @@
* under the License.
*/
-import { mockLoggingService } from './config_deprecation.test.mocks';
-import { loggingServiceMock } from '../../logging/logging_service.mock';
+import { mockLoggingSystem } from './config_deprecation.test.mocks';
+import { loggingSystemMock } from '../../logging/logging_system.mock';
import * as kbnTestServer from '../../../../test_utils/kbn_server';
describe('configuration deprecations', () => {
@@ -35,7 +35,7 @@ describe('configuration deprecations', () => {
await root.setup();
- const logs = loggingServiceMock.collect(mockLoggingService);
+ const logs = loggingSystemMock.collect(mockLoggingSystem);
const warnings = logs.warn.flatMap((i) => i);
expect(warnings).not.toContain(
'"optimize.lazy" is deprecated and has been replaced by "optimize.watch"'
@@ -55,7 +55,7 @@ describe('configuration deprecations', () => {
await root.setup();
- const logs = loggingServiceMock.collect(mockLoggingService);
+ const logs = loggingSystemMock.collect(mockLoggingSystem);
const warnings = logs.warn.flatMap((i) => i);
expect(warnings).toContain(
'"optimize.lazy" is deprecated and has been replaced by "optimize.watch"'
diff --git a/src/core/server/core_context.mock.ts b/src/core/server/core_context.mock.ts
index d287348e19079..f870d30528df4 100644
--- a/src/core/server/core_context.mock.ts
+++ b/src/core/server/core_context.mock.ts
@@ -20,17 +20,17 @@
import { CoreContext } from './core_context';
import { getEnvOptions } from './config/__mocks__/env';
import { Env, IConfigService } from './config';
-import { loggingServiceMock } from './logging/logging_service.mock';
+import { loggingSystemMock } from './logging/logging_system.mock';
import { configServiceMock } from './config/config_service.mock';
-import { ILoggingService } from './logging';
+import { ILoggingSystem } from './logging';
function create({
env = Env.createDefault(getEnvOptions()),
- logger = loggingServiceMock.create(),
+ logger = loggingSystemMock.create(),
configService = configServiceMock.create(),
}: {
env?: Env;
- logger?: jest.Mocked;
+ logger?: jest.Mocked;
configService?: jest.Mocked;
} = {}): DeeplyMockedKeys {
return { coreId: Symbol(), env, logger, configService };
diff --git a/src/core/server/elasticsearch/cluster_client.test.ts b/src/core/server/elasticsearch/cluster_client.test.ts
index db277fa0e0607..820272bdf14b8 100644
--- a/src/core/server/elasticsearch/cluster_client.test.ts
+++ b/src/core/server/elasticsearch/cluster_client.test.ts
@@ -28,11 +28,11 @@ import {
import { errors } from 'elasticsearch';
import { get } from 'lodash';
import { Logger } from '../logging';
-import { loggingServiceMock } from '../logging/logging_service.mock';
+import { loggingSystemMock } from '../logging/logging_system.mock';
import { httpServerMock } from '../http/http_server.mocks';
import { ClusterClient } from './cluster_client';
-const logger = loggingServiceMock.create();
+const logger = loggingSystemMock.create();
afterEach(() => jest.clearAllMocks());
test('#constructor creates client with parsed config', () => {
diff --git a/src/core/server/elasticsearch/elasticsearch_client_config.test.ts b/src/core/server/elasticsearch/elasticsearch_client_config.test.ts
index 20c10459e0e8a..77d1e41c9ad83 100644
--- a/src/core/server/elasticsearch/elasticsearch_client_config.test.ts
+++ b/src/core/server/elasticsearch/elasticsearch_client_config.test.ts
@@ -18,12 +18,12 @@
*/
import { duration } from 'moment';
-import { loggingServiceMock } from '../logging/logging_service.mock';
+import { loggingSystemMock } from '../logging/logging_system.mock';
import {
ElasticsearchClientConfig,
parseElasticsearchClientConfig,
} from './elasticsearch_client_config';
-const logger = loggingServiceMock.create();
+const logger = loggingSystemMock.create();
afterEach(() => jest.clearAllMocks());
test('parses minimally specified config', () => {
@@ -360,7 +360,7 @@ describe('#log', () => {
expect(typeof esLogger.close).toBe('function');
- expect(loggingServiceMock.collect(logger)).toMatchInlineSnapshot(`
+ expect(loggingSystemMock.collect(logger)).toMatchInlineSnapshot(`
Object {
"debug": Array [],
"error": Array [
@@ -406,7 +406,7 @@ Object {
expect(typeof esLogger.close).toBe('function');
- expect(loggingServiceMock.collect(logger)).toMatchInlineSnapshot(`
+ expect(loggingSystemMock.collect(logger)).toMatchInlineSnapshot(`
Object {
"debug": Array [
Array [
diff --git a/src/core/server/elasticsearch/elasticsearch_service.test.ts b/src/core/server/elasticsearch/elasticsearch_service.test.ts
index 8bf0df74186a9..0a7068903e15c 100644
--- a/src/core/server/elasticsearch/elasticsearch_service.test.ts
+++ b/src/core/server/elasticsearch/elasticsearch_service.test.ts
@@ -26,7 +26,7 @@ import { Env } from '../config';
import { getEnvOptions } from '../config/__mocks__/env';
import { CoreContext } from '../core_context';
import { configServiceMock } from '../config/config_service.mock';
-import { loggingServiceMock } from '../logging/logging_service.mock';
+import { loggingSystemMock } from '../logging/logging_system.mock';
import { httpServiceMock } from '../http/http_service.mock';
import { ElasticsearchConfig } from './elasticsearch_config';
import { ElasticsearchService } from './elasticsearch_service';
@@ -55,7 +55,7 @@ configService.atPath.mockReturnValue(
let env: Env;
let coreContext: CoreContext;
-const logger = loggingServiceMock.create();
+const logger = loggingSystemMock.create();
beforeEach(() => {
env = Env.createDefault(getEnvOptions());
diff --git a/src/core/server/elasticsearch/retry_call_cluster.test.ts b/src/core/server/elasticsearch/retry_call_cluster.test.ts
index 8be138e6752d2..18ffa95048c4d 100644
--- a/src/core/server/elasticsearch/retry_call_cluster.test.ts
+++ b/src/core/server/elasticsearch/retry_call_cluster.test.ts
@@ -19,7 +19,7 @@
import * as legacyElasticsearch from 'elasticsearch';
import { retryCallCluster, migrationsRetryCallCluster } from './retry_call_cluster';
-import { loggingServiceMock } from '../logging/logging_service.mock';
+import { loggingSystemMock } from '../logging/logging_system.mock';
describe('retryCallCluster', () => {
it('retries ES API calls that rejects with NoConnections', () => {
@@ -69,10 +69,10 @@ describe('migrationsRetryCallCluster', () => {
'Gone',
];
- const mockLogger = loggingServiceMock.create();
+ const mockLogger = loggingSystemMock.create();
beforeEach(() => {
- loggingServiceMock.clear(mockLogger);
+ loggingSystemMock.clear(mockLogger);
});
errors.forEach((errorName) => {
@@ -133,7 +133,7 @@ describe('migrationsRetryCallCluster', () => {
callEsApi.mockResolvedValueOnce('done');
const retried = migrationsRetryCallCluster(callEsApi, mockLogger.get('mock log'), 1);
await retried('endpoint');
- expect(loggingServiceMock.collect(mockLogger).warn).toMatchInlineSnapshot(`
+ expect(loggingSystemMock.collect(mockLogger).warn).toMatchInlineSnapshot(`
Array [
Array [
"Unable to connect to Elasticsearch. Error: No Living connections",
diff --git a/src/core/server/elasticsearch/version_check/ensure_es_version.test.ts b/src/core/server/elasticsearch/version_check/ensure_es_version.test.ts
index a2090ed111ca1..3d1218d4a8e8b 100644
--- a/src/core/server/elasticsearch/version_check/ensure_es_version.test.ts
+++ b/src/core/server/elasticsearch/version_check/ensure_es_version.test.ts
@@ -17,12 +17,12 @@
* under the License.
*/
import { mapNodesVersionCompatibility, pollEsNodesVersion, NodesInfo } from './ensure_es_version';
-import { loggingServiceMock } from '../../logging/logging_service.mock';
+import { loggingSystemMock } from '../../logging/logging_system.mock';
import { take, delay } from 'rxjs/operators';
import { TestScheduler } from 'rxjs/testing';
import { of } from 'rxjs';
-const mockLoggerFactory = loggingServiceMock.create();
+const mockLoggerFactory = loggingSystemMock.create();
const mockLogger = mockLoggerFactory.get('mock logger');
const KIBANA_VERSION = '5.1.0';
diff --git a/src/core/server/http/__snapshots__/http_config.test.ts.snap b/src/core/server/http/__snapshots__/http_config.test.ts.snap
index 07c153a7a8a20..d48ead3cec8e1 100644
--- a/src/core/server/http/__snapshots__/http_config.test.ts.snap
+++ b/src/core/server/http/__snapshots__/http_config.test.ts.snap
@@ -83,6 +83,8 @@ Object {
exports[`throws if basepath appends a slash 1`] = `"[basePath]: must start with a slash, don't end with one"`;
+exports[`throws if basepath is an empty string 1`] = `"[basePath]: must start with a slash, don't end with one"`;
+
exports[`throws if basepath is missing prepended slash 1`] = `"[basePath]: must start with a slash, don't end with one"`;
exports[`throws if basepath is not specified, but rewriteBasePath is set 1`] = `"cannot use [rewriteBasePath] when [basePath] is not specified"`;
diff --git a/src/core/server/http/cookie_session_storage.test.ts b/src/core/server/http/cookie_session_storage.test.ts
index 3afe5e0c4dfc7..1fb2b5693bb61 100644
--- a/src/core/server/http/cookie_session_storage.test.ts
+++ b/src/core/server/http/cookie_session_storage.test.ts
@@ -29,14 +29,14 @@ import { Env } from '../config';
import { getEnvOptions } from '../config/__mocks__/env';
import { configServiceMock } from '../config/config_service.mock';
import { contextServiceMock } from '../context/context_service.mock';
-import { loggingServiceMock } from '../logging/logging_service.mock';
+import { loggingSystemMock } from '../logging/logging_system.mock';
import { httpServerMock } from './http_server.mocks';
import { createCookieSessionStorageFactory } from './cookie_session_storage';
let server: HttpService;
-let logger: ReturnType;
+let logger: ReturnType;
let env: Env;
let coreContext: CoreContext;
const configService = configServiceMock.create();
@@ -67,7 +67,7 @@ configService.atPath.mockReturnValue(
);
beforeEach(() => {
- logger = loggingServiceMock.create();
+ logger = loggingSystemMock.create();
env = Env.createDefault(getEnvOptions());
coreContext = { coreId: Symbol(), env, logger, configService: configService as any };
@@ -324,7 +324,7 @@ describe('Cookie based SessionStorage', () => {
expect(mockServer.auth.test).toBeCalledTimes(1);
expect(mockServer.auth.test).toHaveBeenCalledWith('security-cookie', mockRequest);
- expect(loggingServiceMock.collect(logger).warn).toEqual([
+ expect(loggingSystemMock.collect(logger).warn).toEqual([
['Found 2 auth sessions when we were only expecting 1.'],
]);
});
@@ -381,7 +381,7 @@ describe('Cookie based SessionStorage', () => {
const session = await factory.asScoped(KibanaRequest.from(mockRequest)).get();
expect(session).toBe(null);
- expect(loggingServiceMock.collect(logger).debug).toEqual([['Error: Invalid cookie.']]);
+ expect(loggingSystemMock.collect(logger).debug).toEqual([['Error: Invalid cookie.']]);
});
});
diff --git a/src/core/server/http/http_config.test.ts b/src/core/server/http/http_config.test.ts
index eaf66219d08dc..0698f118be03f 100644
--- a/src/core/server/http/http_config.test.ts
+++ b/src/core/server/http/http_config.test.ts
@@ -78,6 +78,14 @@ test('throws if basepath appends a slash', () => {
expect(() => httpSchema.validate(obj)).toThrowErrorMatchingSnapshot();
});
+test('throws if basepath is an empty string', () => {
+ const httpSchema = config.schema;
+ const obj = {
+ basePath: '',
+ };
+ expect(() => httpSchema.validate(obj)).toThrowErrorMatchingSnapshot();
+});
+
test('throws if basepath is not specified, but rewriteBasePath is set', () => {
const httpSchema = config.schema;
const obj = {
diff --git a/src/core/server/http/http_config.ts b/src/core/server/http/http_config.ts
index 289b6539fd762..83a2e712b424f 100644
--- a/src/core/server/http/http_config.ts
+++ b/src/core/server/http/http_config.ts
@@ -23,7 +23,7 @@ import { hostname } from 'os';
import { CspConfigType, CspConfig, ICspConfig } from '../csp';
import { SslConfig, sslSchema } from './ssl_config';
-const validBasePathRegex = /(^$|^\/.*[^\/]$)/;
+const validBasePathRegex = /^\/.*[^\/]$/;
const uuidRegexp = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i;
const match = (regex: RegExp, errorMsg: string) => (str: string) =>
diff --git a/src/core/server/http/http_server.test.ts b/src/core/server/http/http_server.test.ts
index 9a5deb9b45562..4520851bb460c 100644
--- a/src/core/server/http/http_server.test.ts
+++ b/src/core/server/http/http_server.test.ts
@@ -31,7 +31,7 @@ import {
RouteValidationResultFactory,
RouteValidationFunction,
} from './router';
-import { loggingServiceMock } from '../logging/logging_service.mock';
+import { loggingSystemMock } from '../logging/logging_system.mock';
import { HttpServer } from './http_server';
import { Readable } from 'stream';
import { RequestHandlerContext } from 'kibana/server';
@@ -48,7 +48,7 @@ let server: HttpServer;
let config: HttpConfig;
let configWithSSL: HttpConfig;
-const loggingService = loggingServiceMock.create();
+const loggingService = loggingSystemMock.create();
const logger = loggingService.get();
const enhanceWithContext = (fn: (...args: any[]) => any) => fn.bind(null, {});
@@ -97,7 +97,7 @@ test('log listening address after started', async () => {
await server.start();
expect(server.isListening()).toBe(true);
- expect(loggingServiceMock.collect(loggingService).info).toMatchInlineSnapshot(`
+ expect(loggingSystemMock.collect(loggingService).info).toMatchInlineSnapshot(`
Array [
Array [
"http server running at http://127.0.0.1:10002",
@@ -113,7 +113,7 @@ test('log listening address after started when configured with BasePath and rewr
await server.start();
expect(server.isListening()).toBe(true);
- expect(loggingServiceMock.collect(loggingService).info).toMatchInlineSnapshot(`
+ expect(loggingSystemMock.collect(loggingService).info).toMatchInlineSnapshot(`
Array [
Array [
"http server running at http://127.0.0.1:10002",
@@ -129,7 +129,7 @@ test('log listening address after started when configured with BasePath and rewr
await server.start();
expect(server.isListening()).toBe(true);
- expect(loggingServiceMock.collect(loggingService).info).toMatchInlineSnapshot(`
+ expect(loggingSystemMock.collect(loggingService).info).toMatchInlineSnapshot(`
Array [
Array [
"http server running at http://127.0.0.1:10002/bar",
diff --git a/src/core/server/http/http_service.test.ts b/src/core/server/http/http_service.test.ts
index 8b500caf217dc..3d759b427d9fb 100644
--- a/src/core/server/http/http_service.test.ts
+++ b/src/core/server/http/http_service.test.ts
@@ -25,12 +25,12 @@ import { HttpService } from '.';
import { HttpConfigType, config } from './http_config';
import { httpServerMock } from './http_server.mocks';
import { ConfigService, Env } from '../config';
-import { loggingServiceMock } from '../logging/logging_service.mock';
+import { loggingSystemMock } from '../logging/logging_system.mock';
import { contextServiceMock } from '../context/context_service.mock';
import { getEnvOptions } from '../config/__mocks__/env';
import { config as cspConfig } from '../csp';
-const logger = loggingServiceMock.create();
+const logger = loggingSystemMock.create();
const env = Env.createDefault(getEnvOptions());
const coreId = Symbol();
@@ -159,7 +159,7 @@ test('logs error if already set up', async () => {
await service.setup(setupDeps);
- expect(loggingServiceMock.collect(logger).warn).toMatchSnapshot();
+ expect(loggingSystemMock.collect(logger).warn).toMatchSnapshot();
});
test('stops http server', async () => {
diff --git a/src/core/server/http/http_tools.test.ts b/src/core/server/http/http_tools.test.ts
index 7d5a7277a767a..f09d862f9edac 100644
--- a/src/core/server/http/http_tools.test.ts
+++ b/src/core/server/http/http_tools.test.ts
@@ -34,7 +34,7 @@ import { defaultValidationErrorHandler, HapiValidationError, getServerOptions }
import { HttpServer } from './http_server';
import { HttpConfig, config } from './http_config';
import { Router } from './router';
-import { loggingServiceMock } from '../logging/logging_service.mock';
+import { loggingSystemMock } from '../logging/logging_system.mock';
import { ByteSizeValue } from '@kbn/config-schema';
const emptyOutput = {
@@ -77,7 +77,7 @@ describe('defaultValidationErrorHandler', () => {
});
describe('timeouts', () => {
- const logger = loggingServiceMock.create();
+ const logger = loggingSystemMock.create();
const server = new HttpServer(logger, 'foo');
const enhanceWithContext = (fn: (...args: any[]) => any) => fn.bind(null, {});
diff --git a/src/core/server/http/https_redirect_server.test.ts b/src/core/server/http/https_redirect_server.test.ts
index a7d3cbe41aa3d..f35456f01c19b 100644
--- a/src/core/server/http/https_redirect_server.test.ts
+++ b/src/core/server/http/https_redirect_server.test.ts
@@ -27,7 +27,7 @@ import supertest from 'supertest';
import { ByteSizeValue } from '@kbn/config-schema';
import { HttpConfig } from '.';
-import { loggingServiceMock } from '../logging/logging_service.mock';
+import { loggingSystemMock } from '../logging/logging_system.mock';
import { HttpsRedirectServer } from './https_redirect_server';
const chance = new Chance();
@@ -50,7 +50,7 @@ beforeEach(() => {
},
} as HttpConfig;
- server = new HttpsRedirectServer(loggingServiceMock.create().get());
+ server = new HttpsRedirectServer(loggingSystemMock.create().get());
});
afterEach(async () => {
diff --git a/src/core/server/http/integration_tests/lifecycle.test.ts b/src/core/server/http/integration_tests/lifecycle.test.ts
index 73ed4e5de4b04..879cbc689f8e7 100644
--- a/src/core/server/http/integration_tests/lifecycle.test.ts
+++ b/src/core/server/http/integration_tests/lifecycle.test.ts
@@ -24,12 +24,12 @@ import { ensureRawRequest } from '../router';
import { HttpService } from '../http_service';
import { contextServiceMock } from '../../context/context_service.mock';
-import { loggingServiceMock } from '../../logging/logging_service.mock';
+import { loggingSystemMock } from '../../logging/logging_system.mock';
import { createHttpServer } from '../test_utils';
let server: HttpService;
-let logger: ReturnType;
+let logger: ReturnType;
const contextSetup = contextServiceMock.createSetupContract();
@@ -38,7 +38,7 @@ const setupDeps = {
};
beforeEach(() => {
- logger = loggingServiceMock.create();
+ logger = loggingSystemMock.create();
server = createHttpServer({ logger });
});
@@ -167,7 +167,7 @@ describe('OnPreAuth', () => {
const result = await supertest(innerServer.listener).get('/').expect(500);
expect(result.body.message).toBe('An internal server error occurred.');
- expect(loggingServiceMock.collect(logger).error).toMatchInlineSnapshot(`
+ expect(loggingSystemMock.collect(logger).error).toMatchInlineSnapshot(`
Array [
Array [
[Error: reason],
@@ -188,7 +188,7 @@ describe('OnPreAuth', () => {
const result = await supertest(innerServer.listener).get('/').expect(500);
expect(result.body.message).toBe('An internal server error occurred.');
- expect(loggingServiceMock.collect(logger).error).toMatchInlineSnapshot(`
+ expect(loggingSystemMock.collect(logger).error).toMatchInlineSnapshot(`
Array [
Array [
[Error: Unexpected result from OnPreAuth. Expected OnPreAuthResult or KibanaResponse, but given: [object Object].],
@@ -301,7 +301,7 @@ describe('OnPostAuth', () => {
const result = await supertest(innerServer.listener).get('/').expect(500);
expect(result.body.message).toBe('An internal server error occurred.');
- expect(loggingServiceMock.collect(logger).error).toMatchInlineSnapshot(`
+ expect(loggingSystemMock.collect(logger).error).toMatchInlineSnapshot(`
Array [
Array [
[Error: reason],
@@ -321,7 +321,7 @@ describe('OnPostAuth', () => {
const result = await supertest(innerServer.listener).get('/').expect(500);
expect(result.body.message).toBe('An internal server error occurred.');
- expect(loggingServiceMock.collect(logger).error).toMatchInlineSnapshot(`
+ expect(loggingSystemMock.collect(logger).error).toMatchInlineSnapshot(`
Array [
Array [
[Error: Unexpected result from OnPostAuth. Expected OnPostAuthResult or KibanaResponse, but given: [object Object].],
@@ -506,7 +506,7 @@ describe('Auth', () => {
const result = await supertest(innerServer.listener).get('/').expect(500);
expect(result.body.message).toBe('An internal server error occurred.');
- expect(loggingServiceMock.collect(logger).error).toMatchInlineSnapshot(`
+ expect(loggingSystemMock.collect(logger).error).toMatchInlineSnapshot(`
Array [
Array [
[Error: reason],
@@ -703,7 +703,7 @@ describe('Auth', () => {
const response = await supertest(innerServer.listener).get('/').expect(200);
expect(response.header['www-authenticate']).toBe('from auth interceptor');
- expect(loggingServiceMock.collect(logger).warn).toMatchInlineSnapshot(`
+ expect(loggingSystemMock.collect(logger).warn).toMatchInlineSnapshot(`
Array [
Array [
"onPreResponseHandler rewrote a response header [www-authenticate].",
@@ -736,7 +736,7 @@ describe('Auth', () => {
const response = await supertest(innerServer.listener).get('/').expect(400);
expect(response.header['www-authenticate']).toBe('from auth interceptor');
- expect(loggingServiceMock.collect(logger).warn).toMatchInlineSnapshot(`
+ expect(loggingSystemMock.collect(logger).warn).toMatchInlineSnapshot(`
Array [
Array [
"onPreResponseHandler rewrote a response header [www-authenticate].",
@@ -798,7 +798,7 @@ describe('Auth', () => {
const result = await supertest(innerServer.listener).get('/').expect(500);
expect(result.body.message).toBe('An internal server error occurred.');
- expect(loggingServiceMock.collect(logger).error).toMatchInlineSnapshot(`
+ expect(loggingSystemMock.collect(logger).error).toMatchInlineSnapshot(`
Array [
Array [
[Error: reason],
@@ -818,7 +818,7 @@ describe('Auth', () => {
const result = await supertest(innerServer.listener).get('/').expect(500);
expect(result.body.message).toBe('An internal server error occurred.');
- expect(loggingServiceMock.collect(logger).error).toMatchInlineSnapshot(`
+ expect(loggingSystemMock.collect(logger).error).toMatchInlineSnapshot(`
Array [
Array [
[Error: Unexpected result from OnPostAuth. Expected OnPostAuthResult or KibanaResponse, but given: [object Object].],
@@ -929,7 +929,7 @@ describe('OnPreResponse', () => {
await supertest(innerServer.listener).get('/').expect(200);
- expect(loggingServiceMock.collect(logger).warn).toMatchInlineSnapshot(`
+ expect(loggingSystemMock.collect(logger).warn).toMatchInlineSnapshot(`
Array [
Array [
"onPreResponseHandler rewrote a response header [x-kibana-header].",
@@ -953,7 +953,7 @@ describe('OnPreResponse', () => {
const result = await supertest(innerServer.listener).get('/').expect(500);
expect(result.body.message).toBe('An internal server error occurred.');
- expect(loggingServiceMock.collect(logger).error).toMatchInlineSnapshot(`
+ expect(loggingSystemMock.collect(logger).error).toMatchInlineSnapshot(`
Array [
Array [
[Error: reason],
@@ -975,7 +975,7 @@ describe('OnPreResponse', () => {
const result = await supertest(innerServer.listener).get('/').expect(500);
expect(result.body.message).toBe('An internal server error occurred.');
- expect(loggingServiceMock.collect(logger).error).toMatchInlineSnapshot(`
+ expect(loggingSystemMock.collect(logger).error).toMatchInlineSnapshot(`
Array [
Array [
[Error: Unexpected result from OnPreResponse. Expected OnPreResponseResult, but given: [object Object].],
diff --git a/src/core/server/http/integration_tests/request.test.ts b/src/core/server/http/integration_tests/request.test.ts
index d33757273042b..2d018f7f464b5 100644
--- a/src/core/server/http/integration_tests/request.test.ts
+++ b/src/core/server/http/integration_tests/request.test.ts
@@ -21,12 +21,12 @@ import supertest from 'supertest';
import { HttpService } from '../http_service';
import { contextServiceMock } from '../../context/context_service.mock';
-import { loggingServiceMock } from '../../logging/logging_service.mock';
+import { loggingSystemMock } from '../../logging/logging_system.mock';
import { createHttpServer } from '../test_utils';
let server: HttpService;
-let logger: ReturnType;
+let logger: ReturnType;
const contextSetup = contextServiceMock.createSetupContract();
const setupDeps = {
@@ -34,7 +34,7 @@ const setupDeps = {
};
beforeEach(() => {
- logger = loggingServiceMock.create();
+ logger = loggingSystemMock.create();
server = createHttpServer({ logger });
});
diff --git a/src/core/server/http/integration_tests/router.test.ts b/src/core/server/http/integration_tests/router.test.ts
index 8f3799b12eccb..bb36fefa96611 100644
--- a/src/core/server/http/integration_tests/router.test.ts
+++ b/src/core/server/http/integration_tests/router.test.ts
@@ -24,12 +24,12 @@ import { schema } from '@kbn/config-schema';
import { HttpService } from '../http_service';
import { contextServiceMock } from '../../context/context_service.mock';
-import { loggingServiceMock } from '../../logging/logging_service.mock';
+import { loggingSystemMock } from '../../logging/logging_system.mock';
import { createHttpServer } from '../test_utils';
let server: HttpService;
-let logger: ReturnType;
+let logger: ReturnType;
const contextSetup = contextServiceMock.createSetupContract();
const setupDeps = {
@@ -37,7 +37,7 @@ const setupDeps = {
};
beforeEach(() => {
- logger = loggingServiceMock.create();
+ logger = loggingSystemMock.create();
server = createHttpServer({ logger });
});
@@ -347,7 +347,7 @@ describe('Handler', () => {
const result = await supertest(innerServer.listener).get('/').expect(500);
expect(result.body.message).toBe('An internal server error occurred.');
- expect(loggingServiceMock.collect(logger).error).toMatchInlineSnapshot(`
+ expect(loggingSystemMock.collect(logger).error).toMatchInlineSnapshot(`
Array [
Array [
[Error: unexpected error],
@@ -368,7 +368,7 @@ describe('Handler', () => {
const result = await supertest(innerServer.listener).get('/').expect(500);
expect(result.body.message).toBe('An internal server error occurred.');
- expect(loggingServiceMock.collect(logger).error).toMatchInlineSnapshot(`
+ expect(loggingSystemMock.collect(logger).error).toMatchInlineSnapshot(`
Array [
Array [
[Error: Unauthorized],
@@ -387,7 +387,7 @@ describe('Handler', () => {
const result = await supertest(innerServer.listener).get('/').expect(500);
expect(result.body.message).toBe('An internal server error occurred.');
- expect(loggingServiceMock.collect(logger).error).toMatchInlineSnapshot(`
+ expect(loggingSystemMock.collect(logger).error).toMatchInlineSnapshot(`
Array [
Array [
[Error: Unexpected result from Route Handler. Expected KibanaResponse, but given: string.],
@@ -763,7 +763,7 @@ describe('Response factory', () => {
await supertest(innerServer.listener).get('/').expect(500);
// error happens within hapi when route handler already finished execution.
- expect(loggingServiceMock.collect(logger).error).toHaveLength(0);
+ expect(loggingSystemMock.collect(logger).error).toHaveLength(0);
});
it('200 OK with body', async () => {
@@ -855,7 +855,7 @@ describe('Response factory', () => {
const result = await supertest(innerServer.listener).get('/').expect(500);
expect(result.body.message).toBe('An internal server error occurred.');
- expect(loggingServiceMock.collect(logger).error).toMatchInlineSnapshot(`
+ expect(loggingSystemMock.collect(logger).error).toMatchInlineSnapshot(`
Array [
Array [
[Error: expected 'location' header to be set],
@@ -1261,7 +1261,7 @@ describe('Response factory', () => {
message: 'An internal server error occurred.',
statusCode: 500,
});
- expect(loggingServiceMock.collect(logger).error).toMatchInlineSnapshot(`
+ expect(loggingSystemMock.collect(logger).error).toMatchInlineSnapshot(`
Array [
Array [
[Error: Unexpected Http status code. Expected from 400 to 599, but given: 200],
@@ -1330,7 +1330,7 @@ describe('Response factory', () => {
await supertest(innerServer.listener).get('/').expect(500);
- expect(loggingServiceMock.collect(logger).error).toMatchInlineSnapshot(`
+ expect(loggingSystemMock.collect(logger).error).toMatchInlineSnapshot(`
Array [
Array [
[Error: expected 'location' header to be set],
@@ -1445,7 +1445,7 @@ describe('Response factory', () => {
const result = await supertest(innerServer.listener).get('/').expect(500);
expect(result.body.message).toBe('reason');
- expect(loggingServiceMock.collect(logger).error).toHaveLength(0);
+ expect(loggingSystemMock.collect(logger).error).toHaveLength(0);
});
it('throws an error if not valid error is provided', async () => {
@@ -1464,7 +1464,7 @@ describe('Response factory', () => {
const result = await supertest(innerServer.listener).get('/').expect(500);
expect(result.body.message).toBe('An internal server error occurred.');
- expect(loggingServiceMock.collect(logger).error).toMatchInlineSnapshot(`
+ expect(loggingSystemMock.collect(logger).error).toMatchInlineSnapshot(`
Array [
Array [
[Error: expected error message to be provided],
@@ -1488,7 +1488,7 @@ describe('Response factory', () => {
const result = await supertest(innerServer.listener).get('/').expect(500);
expect(result.body.message).toBe('An internal server error occurred.');
- expect(loggingServiceMock.collect(logger).error).toMatchInlineSnapshot(`
+ expect(loggingSystemMock.collect(logger).error).toMatchInlineSnapshot(`
Array [
Array [
[Error: expected error message to be provided],
@@ -1511,7 +1511,7 @@ describe('Response factory', () => {
const result = await supertest(innerServer.listener).get('/').expect(500);
expect(result.body.message).toBe('An internal server error occurred.');
- expect(loggingServiceMock.collect(logger).error).toMatchInlineSnapshot(`
+ expect(loggingSystemMock.collect(logger).error).toMatchInlineSnapshot(`
Array [
Array [
[Error: options.statusCode is expected to be set. given options: undefined],
@@ -1534,7 +1534,7 @@ describe('Response factory', () => {
const result = await supertest(innerServer.listener).get('/').expect(500);
expect(result.body.message).toBe('An internal server error occurred.');
- expect(loggingServiceMock.collect(logger).error).toMatchInlineSnapshot(`
+ expect(loggingSystemMock.collect(logger).error).toMatchInlineSnapshot(`
Array [
Array [
[Error: Unexpected Http status code. Expected from 100 to 599, but given: 20.],
diff --git a/src/core/server/http/router/router.test.ts b/src/core/server/http/router/router.test.ts
index 9655e2153b863..fa38c7bd6b336 100644
--- a/src/core/server/http/router/router.test.ts
+++ b/src/core/server/http/router/router.test.ts
@@ -18,10 +18,10 @@
*/
import { Router } from './router';
-import { loggingServiceMock } from '../../logging/logging_service.mock';
+import { loggingSystemMock } from '../../logging/logging_system.mock';
import { schema } from '@kbn/config-schema';
-const logger = loggingServiceMock.create().get();
+const logger = loggingSystemMock.create().get();
const enhanceWithContext = (fn: (...args: any[]) => any) => fn.bind(null, {});
describe('Router', () => {
diff --git a/src/core/server/http/test_utils.ts b/src/core/server/http/test_utils.ts
index 0e639aa72a825..bda66e1de8168 100644
--- a/src/core/server/http/test_utils.ts
+++ b/src/core/server/http/test_utils.ts
@@ -24,12 +24,12 @@ import { getEnvOptions } from '../config/__mocks__/env';
import { HttpService } from './http_service';
import { CoreContext } from '../core_context';
import { configServiceMock } from '../config/config_service.mock';
-import { loggingServiceMock } from '../logging/logging_service.mock';
+import { loggingSystemMock } from '../logging/logging_system.mock';
const coreId = Symbol('core');
const env = Env.createDefault(getEnvOptions());
-const logger = loggingServiceMock.create();
+const logger = loggingSystemMock.create();
const configService = configServiceMock.create();
configService.atPath.mockReturnValue(
diff --git a/src/core/server/index.ts b/src/core/server/index.ts
index 0da7e5d66cf2a..e0afd5e57f041 100644
--- a/src/core/server/index.ts
+++ b/src/core/server/index.ts
@@ -62,6 +62,12 @@ import { CapabilitiesSetup, CapabilitiesStart } from './capabilities';
import { UuidServiceSetup } from './uuid';
import { MetricsServiceSetup } from './metrics';
import { StatusServiceSetup } from './status';
+import {
+ LoggingServiceSetup,
+ appendersSchema,
+ loggerContextConfigSchema,
+ loggerSchema,
+} from './logging';
export { bootstrap } from './bootstrap';
export { Capabilities, CapabilitiesProvider, CapabilitiesSwitcher } from './capabilities';
@@ -187,7 +193,17 @@ export {
} from './http_resources';
export { IRenderOptions } from './rendering';
-export { Logger, LoggerFactory, LogMeta, LogRecord, LogLevel } from './logging';
+export {
+ Logger,
+ LoggerFactory,
+ LogMeta,
+ LogRecord,
+ LogLevel,
+ LoggingServiceSetup,
+ LoggerContextConfigInput,
+ LoggerConfigType,
+ AppenderConfigType,
+} from './logging';
export {
DiscoveredPlugin,
@@ -385,6 +401,8 @@ export interface CoreSetup = KbnServer as any;
@@ -64,7 +65,7 @@ let setupDeps: LegacyServiceSetupDeps;
let startDeps: LegacyServiceStartDeps;
-const logger = loggingServiceMock.create();
+const logger = loggingSystemMock.create();
let configService: ReturnType;
let uuidSetup: ReturnType;
@@ -100,6 +101,7 @@ beforeEach(() => {
metrics: metricsServiceMock.createInternalSetupContract(),
uuid: uuidSetup,
status: statusServiceMock.createInternalSetupContract(),
+ logging: loggingServiceMock.createInternalSetupContract(),
},
plugins: { 'plugin-id': 'plugin-value' },
uiPlugins: {
@@ -281,7 +283,7 @@ describe('once LegacyService is set up with connection info', () => {
const [mockKbnServer] = MockKbnServer.mock.instances as Array>;
expect(mockKbnServer.applyLoggingConfiguration).not.toHaveBeenCalled();
- expect(loggingServiceMock.collect(logger).error).toEqual([]);
+ expect(loggingSystemMock.collect(logger).error).toEqual([]);
const configError = new Error('something went wrong');
mockKbnServer.applyLoggingConfiguration.mockImplementation(() => {
@@ -290,7 +292,7 @@ describe('once LegacyService is set up with connection info', () => {
config$.next(new ObjectToConfigAdapter({ logging: { verbose: true } }));
- expect(loggingServiceMock.collect(logger).error).toEqual([[configError]]);
+ expect(loggingSystemMock.collect(logger).error).toEqual([[configError]]);
});
test('logs error if config service fails.', async () => {
@@ -306,13 +308,13 @@ describe('once LegacyService is set up with connection info', () => {
const [mockKbnServer] = MockKbnServer.mock.instances;
expect(mockKbnServer.applyLoggingConfiguration).not.toHaveBeenCalled();
- expect(loggingServiceMock.collect(logger).error).toEqual([]);
+ expect(loggingSystemMock.collect(logger).error).toEqual([]);
const configError = new Error('something went wrong');
config$.error(configError);
expect(mockKbnServer.applyLoggingConfiguration).not.toHaveBeenCalled();
- expect(loggingServiceMock.collect(logger).error).toEqual([[configError]]);
+ expect(loggingSystemMock.collect(logger).error).toEqual([[configError]]);
});
});
diff --git a/src/core/server/legacy/legacy_service.ts b/src/core/server/legacy/legacy_service.ts
index cfc53b10d91f0..be737f6593c02 100644
--- a/src/core/server/legacy/legacy_service.ts
+++ b/src/core/server/legacy/legacy_service.ts
@@ -309,6 +309,9 @@ export class LegacyService implements CoreService {
csp: setupDeps.core.http.csp,
getServerInfo: setupDeps.core.http.getServerInfo,
},
+ logging: {
+ configure: (config$) => setupDeps.core.logging.configure([], config$),
+ },
metrics: {
getOpsMetrics$: setupDeps.core.metrics.getOpsMetrics$,
},
diff --git a/src/core/server/logging/__snapshots__/logging_service.test.ts.snap b/src/core/server/logging/__snapshots__/logging_system.test.ts.snap
similarity index 100%
rename from src/core/server/logging/__snapshots__/logging_service.test.ts.snap
rename to src/core/server/logging/__snapshots__/logging_system.test.ts.snap
diff --git a/src/core/server/logging/appenders/appenders.ts b/src/core/server/logging/appenders/appenders.ts
index 3aa86495e4d82..3b90a10a1a76c 100644
--- a/src/core/server/logging/appenders/appenders.ts
+++ b/src/core/server/logging/appenders/appenders.ts
@@ -26,13 +26,19 @@ import { LogRecord } from '../log_record';
import { ConsoleAppender } from './console/console_appender';
import { FileAppender } from './file/file_appender';
-const appendersSchema = schema.oneOf([
+/**
+ * Config schema for validting the shape of the `appenders` key in in {@link LoggerContextConfigType} or
+ * {@link LoggingConfigType}.
+ *
+ * @public
+ */
+export const appendersSchema = schema.oneOf([
ConsoleAppender.configSchema,
FileAppender.configSchema,
LegacyAppender.configSchema,
]);
-/** @internal */
+/** @public */
export type AppenderConfigType = TypeOf;
/**
diff --git a/src/core/server/logging/index.ts b/src/core/server/logging/index.ts
index fd35ed39092b3..9471972030281 100644
--- a/src/core/server/logging/index.ts
+++ b/src/core/server/logging/index.ts
@@ -21,7 +21,18 @@ export { Logger, LogMeta } from './logger';
export { LoggerFactory } from './logger_factory';
export { LogRecord } from './log_record';
export { LogLevel } from './log_level';
-/** @internal */
-export { config, LoggingConfigType } from './logging_config';
-/** @internal */
-export { LoggingService, ILoggingService } from './logging_service';
+export {
+ config,
+ LoggingConfigType,
+ LoggerContextConfigInput,
+ LoggerConfigType,
+ loggerContextConfigSchema,
+ loggerSchema,
+} from './logging_config';
+export { LoggingSystem, ILoggingSystem } from './logging_system';
+export {
+ InternalLoggingServiceSetup,
+ LoggingServiceSetup,
+ LoggingService,
+} from './logging_service';
+export { appendersSchema, AppenderConfigType } from './appenders/appenders';
diff --git a/src/core/server/logging/logging_config.test.ts b/src/core/server/logging/logging_config.test.ts
index 75f571d34c25c..e2ce3e1983aa1 100644
--- a/src/core/server/logging/logging_config.test.ts
+++ b/src/core/server/logging/logging_config.test.ts
@@ -171,3 +171,127 @@ test('fails if loggers use unknown appenders.', () => {
expect(() => new LoggingConfig(validateConfig)).toThrowErrorMatchingSnapshot();
});
+
+describe('extend', () => {
+ it('adds new appenders', () => {
+ const configValue = new LoggingConfig(
+ config.schema.validate({
+ appenders: {
+ file1: {
+ kind: 'file',
+ layout: { kind: 'pattern' },
+ path: 'path',
+ },
+ },
+ })
+ );
+
+ const mergedConfigValue = configValue.extend(
+ config.schema.validate({
+ appenders: {
+ file2: {
+ kind: 'file',
+ layout: { kind: 'pattern' },
+ path: 'path',
+ },
+ },
+ })
+ );
+
+ expect([...mergedConfigValue.appenders.keys()]).toEqual([
+ 'default',
+ 'console',
+ 'file1',
+ 'file2',
+ ]);
+ });
+
+ it('overrides appenders', () => {
+ const configValue = new LoggingConfig(
+ config.schema.validate({
+ appenders: {
+ file1: {
+ kind: 'file',
+ layout: { kind: 'pattern' },
+ path: 'path',
+ },
+ },
+ })
+ );
+
+ const mergedConfigValue = configValue.extend(
+ config.schema.validate({
+ appenders: {
+ file1: {
+ kind: 'file',
+ layout: { kind: 'json' },
+ path: 'updatedPath',
+ },
+ },
+ })
+ );
+
+ expect(mergedConfigValue.appenders.get('file1')).toEqual({
+ kind: 'file',
+ layout: { kind: 'json' },
+ path: 'updatedPath',
+ });
+ });
+
+ it('adds new loggers', () => {
+ const configValue = new LoggingConfig(
+ config.schema.validate({
+ loggers: [
+ {
+ context: 'plugins',
+ level: 'warn',
+ },
+ ],
+ })
+ );
+
+ const mergedConfigValue = configValue.extend(
+ config.schema.validate({
+ loggers: [
+ {
+ context: 'plugins.pid',
+ level: 'trace',
+ },
+ ],
+ })
+ );
+
+ expect([...mergedConfigValue.loggers.keys()]).toEqual(['root', 'plugins', 'plugins.pid']);
+ });
+
+ it('overrides loggers', () => {
+ const configValue = new LoggingConfig(
+ config.schema.validate({
+ loggers: [
+ {
+ context: 'plugins',
+ level: 'warn',
+ },
+ ],
+ })
+ );
+
+ const mergedConfigValue = configValue.extend(
+ config.schema.validate({
+ loggers: [
+ {
+ appenders: ['console'],
+ context: 'plugins',
+ level: 'trace',
+ },
+ ],
+ })
+ );
+
+ expect(mergedConfigValue.loggers.get('plugins')).toEqual({
+ appenders: ['console'],
+ context: 'plugins',
+ level: 'trace',
+ });
+ });
+});
diff --git a/src/core/server/logging/logging_config.ts b/src/core/server/logging/logging_config.ts
index 772909ce584e5..a6aafabeb970c 100644
--- a/src/core/server/logging/logging_config.ts
+++ b/src/core/server/logging/logging_config.ts
@@ -39,7 +39,7 @@ const ROOT_CONTEXT_NAME = 'root';
*/
const DEFAULT_APPENDER_NAME = 'default';
-const createLevelSchema = schema.oneOf(
+const levelSchema = schema.oneOf(
[
schema.literal('all'),
schema.literal('fatal'),
@@ -55,21 +55,26 @@ const createLevelSchema = schema.oneOf(
}
);
-const createLoggerSchema = schema.object({
+/**
+ * Config schema for validating the `loggers` key in {@link LoggerContextConfigType} or {@link LoggingConfigType}.
+ *
+ * @public
+ */
+export const loggerSchema = schema.object({
appenders: schema.arrayOf(schema.string(), { defaultValue: [] }),
context: schema.string(),
- level: createLevelSchema,
+ level: levelSchema,
});
-/** @internal */
-export type LoggerConfigType = TypeOf;
+/** @public */
+export type LoggerConfigType = TypeOf;
export const config = {
path: 'logging',
schema: schema.object({
appenders: schema.mapOf(schema.string(), Appenders.configSchema, {
defaultValue: new Map(),
}),
- loggers: schema.arrayOf(createLoggerSchema, {
+ loggers: schema.arrayOf(loggerSchema, {
defaultValue: [],
}),
root: schema.object(
@@ -78,7 +83,7 @@ export const config = {
defaultValue: [DEFAULT_APPENDER_NAME],
minSize: 1,
}),
- level: createLevelSchema,
+ level: levelSchema,
},
{
validate(rawConfig) {
@@ -93,6 +98,29 @@ export const config = {
export type LoggingConfigType = TypeOf;
+/**
+ * Config schema for validating the inputs to the {@link LoggingServiceStart.configure} API.
+ * See {@link LoggerContextConfigType}.
+ *
+ * @public
+ */
+export const loggerContextConfigSchema = schema.object({
+ appenders: schema.mapOf(schema.string(), Appenders.configSchema, {
+ defaultValue: new Map(),
+ }),
+
+ loggers: schema.arrayOf(loggerSchema, { defaultValue: [] }),
+});
+
+/** @public */
+export type LoggerContextConfigType = TypeOf;
+/** @public */
+export interface LoggerContextConfigInput {
+ // config-schema knows how to handle either Maps or Records
+ appenders?: Record | Map;
+ loggers?: LoggerConfigType[];
+}
+
/**
* Describes the config used to fully setup logging subsystem.
* @internal
@@ -147,11 +175,35 @@ export class LoggingConfig {
*/
public readonly loggers: Map = new Map();
- constructor(configType: LoggingConfigType) {
+ constructor(private readonly configType: LoggingConfigType) {
this.fillAppendersConfig(configType);
this.fillLoggersConfig(configType);
}
+ /**
+ * Returns a new LoggingConfig that merges the existing config with the specified config.
+ *
+ * @remarks
+ * Does not support merging the `root` config property.
+ *
+ * @param contextConfig
+ */
+ public extend(contextConfig: LoggerContextConfigType) {
+ // Use a Map to de-dupe any loggers for the same context. contextConfig overrides existing config.
+ const mergedLoggers = new Map([
+ ...this.configType.loggers.map((l) => [l.context, l] as [string, LoggerConfigType]),
+ ...contextConfig.loggers.map((l) => [l.context, l] as [string, LoggerConfigType]),
+ ]);
+
+ const mergedConfig: LoggingConfigType = {
+ appenders: new Map([...this.configType.appenders, ...contextConfig.appenders]),
+ loggers: [...mergedLoggers.values()],
+ root: this.configType.root,
+ };
+
+ return new LoggingConfig(mergedConfig);
+ }
+
private fillAppendersConfig(loggingConfig: LoggingConfigType) {
for (const [appenderKey, appenderSchema] of loggingConfig.appenders) {
this.appenders.set(appenderKey, appenderSchema);
diff --git a/src/core/server/logging/logging_service.mock.ts b/src/core/server/logging/logging_service.mock.ts
index 15d66c2e8535c..21edbe670eaec 100644
--- a/src/core/server/logging/logging_service.mock.ts
+++ b/src/core/server/logging/logging_service.mock.ts
@@ -17,67 +17,35 @@
* under the License.
*/
-// Test helpers to simplify mocking logs and collecting all their outputs
-import { ILoggingService } from './logging_service';
-import { LoggerFactory } from './logger_factory';
-import { loggerMock, MockedLogger } from './logger.mock';
-
-const createLoggingServiceMock = () => {
- const mockLog = loggerMock.create();
-
- mockLog.get.mockImplementation((...context) => ({
- ...mockLog,
- context,
- }));
-
- const mocked: jest.Mocked = {
- get: jest.fn(),
- asLoggerFactory: jest.fn(),
- upgrade: jest.fn(),
+import {
+ LoggingService,
+ LoggingServiceSetup,
+ InternalLoggingServiceSetup,
+} from './logging_service';
+
+const createInternalSetupMock = (): jest.Mocked => ({
+ configure: jest.fn(),
+});
+
+const createSetupMock = (): jest.Mocked => ({
+ configure: jest.fn(),
+});
+
+type LoggingServiceContract = PublicMethodsOf;
+const createMock = (): jest.Mocked => {
+ const service: jest.Mocked = {
+ setup: jest.fn(),
+ start: jest.fn(),
stop: jest.fn(),
};
- mocked.get.mockImplementation((...context) => ({
- ...mockLog,
- context,
- }));
- mocked.asLoggerFactory.mockImplementation(() => mocked);
- mocked.stop.mockResolvedValue();
- return mocked;
-};
-
-const collectLoggingServiceMock = (loggerFactory: LoggerFactory) => {
- const mockLog = loggerFactory.get() as MockedLogger;
- return {
- debug: mockLog.debug.mock.calls,
- error: mockLog.error.mock.calls,
- fatal: mockLog.fatal.mock.calls,
- info: mockLog.info.mock.calls,
- log: mockLog.log.mock.calls,
- trace: mockLog.trace.mock.calls,
- warn: mockLog.warn.mock.calls,
- };
-};
-const clearLoggingServiceMock = (loggerFactory: LoggerFactory) => {
- const mockedLoggerFactory = (loggerFactory as unknown) as jest.Mocked;
- mockedLoggerFactory.get.mockClear();
- mockedLoggerFactory.asLoggerFactory.mockClear();
- mockedLoggerFactory.upgrade.mockClear();
- mockedLoggerFactory.stop.mockClear();
+ service.setup.mockReturnValue(createInternalSetupMock());
- const mockLog = loggerFactory.get() as MockedLogger;
- mockLog.debug.mockClear();
- mockLog.info.mockClear();
- mockLog.warn.mockClear();
- mockLog.error.mockClear();
- mockLog.trace.mockClear();
- mockLog.fatal.mockClear();
- mockLog.log.mockClear();
+ return service;
};
export const loggingServiceMock = {
- create: createLoggingServiceMock,
- collect: collectLoggingServiceMock,
- clear: clearLoggingServiceMock,
- createLogger: loggerMock.create,
+ create: createMock,
+ createSetupContract: createSetupMock,
+ createInternalSetupContract: createInternalSetupMock,
};
diff --git a/src/core/server/logging/logging_service.test.ts b/src/core/server/logging/logging_service.test.ts
index 1e6c253c56c7b..5107db77304fc 100644
--- a/src/core/server/logging/logging_service.test.ts
+++ b/src/core/server/logging/logging_service.test.ts
@@ -16,167 +16,85 @@
* specific language governing permissions and limitations
* under the License.
*/
-
-const mockStreamWrite = jest.fn();
-jest.mock('fs', () => ({
- constants: {},
- createWriteStream: jest.fn(() => ({ write: mockStreamWrite })),
-}));
-
-const dynamicProps = { pid: expect.any(Number) };
-
-jest.mock('../../../legacy/server/logging/rotate', () => ({
- setupLoggingRotate: jest.fn().mockImplementation(() => Promise.resolve({})),
-}));
-
-const timestamp = new Date(Date.UTC(2012, 1, 1, 14, 33, 22, 11));
-let mockConsoleLog: jest.SpyInstance;
-
-import { createWriteStream } from 'fs';
-const mockCreateWriteStream = (createWriteStream as unknown) as jest.Mock;
-
-import { LoggingService, config } from '.';
-
-let service: LoggingService;
-beforeEach(() => {
- mockConsoleLog = jest.spyOn(global.console, 'log').mockReturnValue(undefined);
- jest.spyOn(global, 'Date').mockImplementation(() => timestamp);
- service = new LoggingService();
-});
-
-afterEach(() => {
- jest.restoreAllMocks();
- mockCreateWriteStream.mockClear();
- mockStreamWrite.mockClear();
-});
-
-test('uses default memory buffer logger until config is provided', () => {
- const bufferAppendSpy = jest.spyOn((service as any).bufferAppender, 'append');
-
- const logger = service.get('test', 'context');
- logger.trace('trace message');
-
- // We shouldn't create new buffer appender for another context.
- const anotherLogger = service.get('test', 'context2');
- anotherLogger.fatal('fatal message', { some: 'value' });
-
- expect(bufferAppendSpy).toHaveBeenCalledTimes(2);
- expect(bufferAppendSpy.mock.calls[0][0]).toMatchSnapshot(dynamicProps);
- expect(bufferAppendSpy.mock.calls[1][0]).toMatchSnapshot(dynamicProps);
-});
-
-test('flushes memory buffer logger and switches to real logger once config is provided', () => {
- const logger = service.get('test', 'context');
-
- logger.trace('buffered trace message');
- logger.info('buffered info message', { some: 'value' });
- logger.fatal('buffered fatal message');
-
- const bufferAppendSpy = jest.spyOn((service as any).bufferAppender, 'append');
-
- // Switch to console appender with `info` level, so that `trace` message won't go through.
- service.upgrade(
- config.schema.validate({
- appenders: { default: { kind: 'console', layout: { kind: 'json' } } },
- root: { level: 'info' },
- })
- );
-
- expect(JSON.parse(mockConsoleLog.mock.calls[0][0])).toMatchSnapshot(
- dynamicProps,
- 'buffered messages'
- );
- mockConsoleLog.mockClear();
-
- // Now message should go straight to thew newly configured appender, not buffered one.
- logger.info('some new info message');
- expect(JSON.parse(mockConsoleLog.mock.calls[0][0])).toMatchSnapshot(dynamicProps, 'new messages');
- expect(bufferAppendSpy).not.toHaveBeenCalled();
-});
-
-test('appends records via multiple appenders.', () => {
- const loggerWithoutConfig = service.get('some-context');
- const testsLogger = service.get('tests');
- const testsChildLogger = service.get('tests', 'child');
-
- loggerWithoutConfig.info('You know, just for your info.');
- testsLogger.warn('Config is not ready!');
- testsChildLogger.error('Too bad that config is not ready :/');
- testsChildLogger.info('Just some info that should not be logged.');
-
- expect(mockConsoleLog).not.toHaveBeenCalled();
- expect(mockCreateWriteStream).not.toHaveBeenCalled();
-
- service.upgrade(
- config.schema.validate({
- appenders: {
- default: { kind: 'console', layout: { kind: 'pattern' } },
- file: { kind: 'file', layout: { kind: 'pattern' }, path: 'path' },
- },
- loggers: [
- { appenders: ['file'], context: 'tests', level: 'warn' },
- { context: 'tests.child', level: 'error' },
- ],
- })
- );
-
- // Now all logs should added to configured appenders.
- expect(mockConsoleLog).toHaveBeenCalledTimes(1);
- expect(mockConsoleLog.mock.calls[0][0]).toMatchSnapshot('console logs');
-
- expect(mockStreamWrite).toHaveBeenCalledTimes(2);
- expect(mockStreamWrite.mock.calls[0][0]).toMatchSnapshot('file logs');
- expect(mockStreamWrite.mock.calls[1][0]).toMatchSnapshot('file logs');
-});
-
-test('uses `root` logger if context is not specified.', () => {
- service.upgrade(
- config.schema.validate({
- appenders: { default: { kind: 'console', layout: { kind: 'pattern' } } },
- })
- );
-
- const rootLogger = service.get();
- rootLogger.info('This message goes to a root context.');
-
- expect(mockConsoleLog.mock.calls).toMatchSnapshot();
-});
-
-test('`stop()` disposes all appenders.', async () => {
- service.upgrade(
- config.schema.validate({
- appenders: { default: { kind: 'console', layout: { kind: 'json' } } },
- root: { level: 'info' },
- })
- );
-
- const bufferDisposeSpy = jest.spyOn((service as any).bufferAppender, 'dispose');
- const consoleDisposeSpy = jest.spyOn((service as any).appenders.get('default'), 'dispose');
-
- await service.stop();
-
- expect(bufferDisposeSpy).toHaveBeenCalledTimes(1);
- expect(consoleDisposeSpy).toHaveBeenCalledTimes(1);
-});
-
-test('asLoggerFactory() only allows to create new loggers.', () => {
- const logger = service.asLoggerFactory().get('test', 'context');
-
- service.upgrade(
- config.schema.validate({
- appenders: { default: { kind: 'console', layout: { kind: 'json' } } },
- root: { level: 'all' },
- })
- );
-
- logger.trace('buffered trace message');
- logger.info('buffered info message', { some: 'value' });
- logger.fatal('buffered fatal message');
-
- expect(Object.keys(service.asLoggerFactory())).toEqual(['get']);
-
- expect(mockConsoleLog).toHaveBeenCalledTimes(3);
- expect(JSON.parse(mockConsoleLog.mock.calls[0][0])).toMatchSnapshot(dynamicProps);
- expect(JSON.parse(mockConsoleLog.mock.calls[1][0])).toMatchSnapshot(dynamicProps);
- expect(JSON.parse(mockConsoleLog.mock.calls[2][0])).toMatchSnapshot(dynamicProps);
+import { of, Subject } from 'rxjs';
+
+import { LoggingService, InternalLoggingServiceSetup } from './logging_service';
+import { loggingSystemMock } from './logging_system.mock';
+import { LoggerContextConfigType } from './logging_config';
+
+describe('LoggingService', () => {
+ let loggingSystem: ReturnType;
+ let service: LoggingService;
+ let setup: InternalLoggingServiceSetup;
+
+ beforeEach(() => {
+ loggingSystem = loggingSystemMock.create();
+ service = new LoggingService({ logger: loggingSystem.asLoggerFactory() } as any);
+ setup = service.setup({ loggingSystem });
+ });
+ afterEach(() => {
+ service.stop();
+ });
+
+ describe('setup', () => {
+ it('forwards configuration changes to logging system', () => {
+ const config1: LoggerContextConfigType = {
+ appenders: new Map(),
+ loggers: [{ context: 'subcontext', appenders: ['console'], level: 'warn' }],
+ };
+ const config2: LoggerContextConfigType = {
+ appenders: new Map(),
+ loggers: [{ context: 'subcontext', appenders: ['default'], level: 'all' }],
+ };
+
+ setup.configure(['test', 'context'], of(config1, config2));
+ expect(loggingSystem.setContextConfig).toHaveBeenNthCalledWith(
+ 1,
+ ['test', 'context'],
+ config1
+ );
+ expect(loggingSystem.setContextConfig).toHaveBeenNthCalledWith(
+ 2,
+ ['test', 'context'],
+ config2
+ );
+ });
+
+ it('stops forwarding first observable when called a second time', () => {
+ const updates$ = new Subject();
+ const config1: LoggerContextConfigType = {
+ appenders: new Map(),
+ loggers: [{ context: 'subcontext', appenders: ['console'], level: 'warn' }],
+ };
+ const config2: LoggerContextConfigType = {
+ appenders: new Map(),
+ loggers: [{ context: 'subcontext', appenders: ['default'], level: 'all' }],
+ };
+
+ setup.configure(['test', 'context'], updates$);
+ setup.configure(['test', 'context'], of(config1));
+ updates$.next(config2);
+ expect(loggingSystem.setContextConfig).toHaveBeenNthCalledWith(
+ 1,
+ ['test', 'context'],
+ config1
+ );
+ expect(loggingSystem.setContextConfig).not.toHaveBeenCalledWith(['test', 'context'], config2);
+ });
+ });
+
+ describe('stop', () => {
+ it('stops forwarding updates to logging system', () => {
+ const updates$ = new Subject();
+ const config1: LoggerContextConfigType = {
+ appenders: new Map(),
+ loggers: [{ context: 'subcontext', appenders: ['console'], level: 'warn' }],
+ };
+
+ setup.configure(['test', 'context'], updates$);
+ service.stop();
+ updates$.next(config1);
+ expect(loggingSystem.setContextConfig).not.toHaveBeenCalledWith(['test', 'context'], config1);
+ });
+ });
});
diff --git a/src/core/server/logging/logging_service.ts b/src/core/server/logging/logging_service.ts
index 2e6f895724122..09051f8f07702 100644
--- a/src/core/server/logging/logging_service.ts
+++ b/src/core/server/logging/logging_service.ts
@@ -16,112 +16,88 @@
* specific language governing permissions and limitations
* under the License.
*/
-import { Appenders, DisposableAppender } from './appenders/appenders';
-import { BufferAppender } from './appenders/buffer/buffer_appender';
-import { LogLevel } from './log_level';
-import { BaseLogger, Logger } from './logger';
-import { LoggerAdapter } from './logger_adapter';
-import { LoggerFactory } from './logger_factory';
-import { LoggingConfigType, LoggerConfigType, LoggingConfig } from './logging_config';
-export type ILoggingService = PublicMethodsOf;
+import { Observable, Subscription } from 'rxjs';
+import { CoreService } from '../../types';
+import { LoggingConfig, LoggerContextConfigInput } from './logging_config';
+import { ILoggingSystem } from './logging_system';
+import { Logger } from './logger';
+import { CoreContext } from '../core_context';
+
/**
- * Service that is responsible for maintaining loggers and logger appenders.
- * @internal
+ * Provides APIs to plugins for customizing the plugin's logger.
+ * @public
*/
-export class LoggingService implements LoggerFactory {
- private config?: LoggingConfig;
- private readonly appenders: Map = new Map();
- private readonly bufferAppender = new BufferAppender();
- private readonly loggers: Map = new Map();
-
- public get(...contextParts: string[]): Logger {
- const context = LoggingConfig.getLoggerContext(contextParts);
- if (!this.loggers.has(context)) {
- this.loggers.set(context, new LoggerAdapter(this.createLogger(context, this.config)));
- }
- return this.loggers.get(context)!;
- }
-
- /**
- * Safe wrapper that allows passing logging service as immutable LoggerFactory.
- */
- public asLoggerFactory(): LoggerFactory {
- return { get: (...contextParts: string[]) => this.get(...contextParts) };
- }
-
+export interface LoggingServiceSetup {
/**
- * Updates all current active loggers with the new config values.
- * @param rawConfig New config instance.
+ * Customizes the logging config for the plugin's context.
+ *
+ * @remarks
+ * Assumes that that the `context` property of the individual `logger` items emitted by `config$`
+ * are relative to the plugin's logging context (defaults to `plugins.`).
+ *
+ * @example
+ * Customize the configuration for the plugins.data.search context.
+ * ```ts
+ * core.logging.configure(
+ * of({
+ * appenders: new Map(),
+ * loggers: [{ context: 'search', appenders: ['default'] }]
+ * })
+ * )
+ * ```
+ *
+ * @param config$
*/
- public upgrade(rawConfig: LoggingConfigType) {
- const config = new LoggingConfig(rawConfig);
- // Config update is asynchronous and may require some time to complete, so we should invalidate
- // config so that new loggers will be using BufferAppender until newly configured appenders are ready.
- this.config = undefined;
-
- // Appenders must be reset, so we first dispose of the current ones, then
- // build up a new set of appenders.
- for (const appender of this.appenders.values()) {
- appender.dispose();
- }
- this.appenders.clear();
+ configure(config$: Observable): void;
+}
- for (const [appenderKey, appenderConfig] of config.appenders) {
- this.appenders.set(appenderKey, Appenders.create(appenderConfig));
- }
+/** @internal */
+export interface InternalLoggingServiceSetup {
+ configure(contextParts: string[], config$: Observable): void;
+}
- for (const [loggerKey, loggerAdapter] of this.loggers) {
- loggerAdapter.updateLogger(this.createLogger(loggerKey, config));
- }
+interface SetupDeps {
+ loggingSystem: ILoggingSystem;
+}
- this.config = config;
+/** @internal */
+export class LoggingService implements CoreService {
+ private readonly subscriptions = new Map();
+ private readonly log: Logger;
- // Re-log all buffered log records with newly configured appenders.
- for (const logRecord of this.bufferAppender.flush()) {
- this.get(logRecord.context).log(logRecord);
- }
+ constructor(coreContext: CoreContext) {
+ this.log = coreContext.logger.get('logging');
}
- /**
- * Disposes all loggers (closes log files, clears buffers etc.). Service is not usable after
- * calling of this method until new config is provided via `upgrade` method.
- * @returns Promise that is resolved once all loggers are successfully disposed.
- */
- public async stop() {
- for (const appender of this.appenders.values()) {
- await appender.dispose();
- }
-
- await this.bufferAppender.dispose();
-
- this.appenders.clear();
- this.loggers.clear();
+ public setup({ loggingSystem }: SetupDeps) {
+ return {
+ configure: (contextParts: string[], config$: Observable) => {
+ const contextName = LoggingConfig.getLoggerContext(contextParts);
+ this.log.debug(`Setting custom config for context [${contextName}]`);
+
+ const existingSubscription = this.subscriptions.get(contextName);
+ if (existingSubscription) {
+ existingSubscription.unsubscribe();
+ }
+
+ // Might be fancier way to do this with rxjs, but this works and is simple to understand
+ this.subscriptions.set(
+ contextName,
+ config$.subscribe((config) => {
+ this.log.debug(`Updating logging config for context [${contextName}]`);
+ loggingSystem.setContextConfig(contextParts, config);
+ })
+ );
+ },
+ };
}
- private createLogger(context: string, config: LoggingConfig | undefined) {
- if (config === undefined) {
- // If we don't have config yet, use `buffered` appender that will store all logged messages in the memory
- // until the config is ready.
- return new BaseLogger(context, LogLevel.All, [this.bufferAppender], this.asLoggerFactory());
- }
-
- const { level, appenders } = this.getLoggerConfigByContext(config, context);
- const loggerLevel = LogLevel.fromId(level);
- const loggerAppenders = appenders.map((appenderKey) => this.appenders.get(appenderKey)!);
+ public start() {}
- return new BaseLogger(context, loggerLevel, loggerAppenders, this.asLoggerFactory());
- }
-
- private getLoggerConfigByContext(config: LoggingConfig, context: string): LoggerConfigType {
- const loggerConfig = config.loggers.get(context);
- if (loggerConfig !== undefined) {
- return loggerConfig;
+ public stop() {
+ for (const [, subscription] of this.subscriptions) {
+ subscription.unsubscribe();
}
-
- // If we don't have configuration for the specified context and it's the "nested" one (eg. `foo.bar.baz`),
- // let's move up to the parent context (eg. `foo.bar`) and check if it has config we can rely on. Otherwise
- // we fallback to the `root` context that should always be defined (enforced by configuration schema).
- return this.getLoggerConfigByContext(config, LoggingConfig.getParentLoggerContext(context));
}
}
diff --git a/src/core/server/logging/logging_system.mock.ts b/src/core/server/logging/logging_system.mock.ts
new file mode 100644
index 0000000000000..ac1e9b5196002
--- /dev/null
+++ b/src/core/server/logging/logging_system.mock.ts
@@ -0,0 +1,84 @@
+/*
+ * 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.
+ */
+
+// Test helpers to simplify mocking logs and collecting all their outputs
+import { ILoggingSystem } from './logging_system';
+import { LoggerFactory } from './logger_factory';
+import { loggerMock, MockedLogger } from './logger.mock';
+
+const createLoggingSystemMock = () => {
+ const mockLog = loggerMock.create();
+
+ mockLog.get.mockImplementation((...context) => ({
+ ...mockLog,
+ context,
+ }));
+
+ const mocked: jest.Mocked = {
+ get: jest.fn(),
+ asLoggerFactory: jest.fn(),
+ setContextConfig: jest.fn(),
+ upgrade: jest.fn(),
+ stop: jest.fn(),
+ };
+ mocked.get.mockImplementation((...context) => ({
+ ...mockLog,
+ context,
+ }));
+ mocked.asLoggerFactory.mockImplementation(() => mocked);
+ mocked.stop.mockResolvedValue();
+ return mocked;
+};
+
+const collectLoggingSystemMock = (loggerFactory: LoggerFactory) => {
+ const mockLog = loggerFactory.get() as MockedLogger;
+ return {
+ debug: mockLog.debug.mock.calls,
+ error: mockLog.error.mock.calls,
+ fatal: mockLog.fatal.mock.calls,
+ info: mockLog.info.mock.calls,
+ log: mockLog.log.mock.calls,
+ trace: mockLog.trace.mock.calls,
+ warn: mockLog.warn.mock.calls,
+ };
+};
+
+const clearLoggingSystemMock = (loggerFactory: LoggerFactory) => {
+ const mockedLoggerFactory = (loggerFactory as unknown) as jest.Mocked;
+ mockedLoggerFactory.get.mockClear();
+ mockedLoggerFactory.asLoggerFactory.mockClear();
+ mockedLoggerFactory.upgrade.mockClear();
+ mockedLoggerFactory.stop.mockClear();
+
+ const mockLog = loggerFactory.get() as MockedLogger;
+ mockLog.debug.mockClear();
+ mockLog.info.mockClear();
+ mockLog.warn.mockClear();
+ mockLog.error.mockClear();
+ mockLog.trace.mockClear();
+ mockLog.fatal.mockClear();
+ mockLog.log.mockClear();
+};
+
+export const loggingSystemMock = {
+ create: createLoggingSystemMock,
+ collect: collectLoggingSystemMock,
+ clear: clearLoggingSystemMock,
+ createLogger: loggerMock.create,
+};
diff --git a/src/core/server/logging/logging_system.test.ts b/src/core/server/logging/logging_system.test.ts
new file mode 100644
index 0000000000000..f73e40fe320dc
--- /dev/null
+++ b/src/core/server/logging/logging_system.test.ts
@@ -0,0 +1,348 @@
+/*
+ * 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.
+ */
+
+const mockStreamWrite = jest.fn();
+jest.mock('fs', () => ({
+ constants: {},
+ createWriteStream: jest.fn(() => ({ write: mockStreamWrite })),
+}));
+
+const dynamicProps = { pid: expect.any(Number) };
+
+jest.mock('../../../legacy/server/logging/rotate', () => ({
+ setupLoggingRotate: jest.fn().mockImplementation(() => Promise.resolve({})),
+}));
+
+const timestamp = new Date(Date.UTC(2012, 1, 1, 14, 33, 22, 11));
+let mockConsoleLog: jest.SpyInstance;
+
+import { createWriteStream } from 'fs';
+const mockCreateWriteStream = (createWriteStream as unknown) as jest.Mock;
+
+import { LoggingSystem, config } from '.';
+
+let system: LoggingSystem;
+beforeEach(() => {
+ mockConsoleLog = jest.spyOn(global.console, 'log').mockReturnValue(undefined);
+ jest.spyOn(global, 'Date').mockImplementation(() => timestamp);
+ system = new LoggingSystem();
+});
+
+afterEach(() => {
+ jest.restoreAllMocks();
+ mockCreateWriteStream.mockClear();
+ mockStreamWrite.mockClear();
+});
+
+test('uses default memory buffer logger until config is provided', () => {
+ const bufferAppendSpy = jest.spyOn((system as any).bufferAppender, 'append');
+
+ const logger = system.get('test', 'context');
+ logger.trace('trace message');
+
+ // We shouldn't create new buffer appender for another context.
+ const anotherLogger = system.get('test', 'context2');
+ anotherLogger.fatal('fatal message', { some: 'value' });
+
+ expect(bufferAppendSpy).toHaveBeenCalledTimes(2);
+ expect(bufferAppendSpy.mock.calls[0][0]).toMatchSnapshot(dynamicProps);
+ expect(bufferAppendSpy.mock.calls[1][0]).toMatchSnapshot(dynamicProps);
+});
+
+test('flushes memory buffer logger and switches to real logger once config is provided', () => {
+ const logger = system.get('test', 'context');
+
+ logger.trace('buffered trace message');
+ logger.info('buffered info message', { some: 'value' });
+ logger.fatal('buffered fatal message');
+
+ const bufferAppendSpy = jest.spyOn((system as any).bufferAppender, 'append');
+
+ // Switch to console appender with `info` level, so that `trace` message won't go through.
+ system.upgrade(
+ config.schema.validate({
+ appenders: { default: { kind: 'console', layout: { kind: 'json' } } },
+ root: { level: 'info' },
+ })
+ );
+
+ expect(JSON.parse(mockConsoleLog.mock.calls[0][0])).toMatchSnapshot(
+ dynamicProps,
+ 'buffered messages'
+ );
+ mockConsoleLog.mockClear();
+
+ // Now message should go straight to thew newly configured appender, not buffered one.
+ logger.info('some new info message');
+ expect(JSON.parse(mockConsoleLog.mock.calls[0][0])).toMatchSnapshot(dynamicProps, 'new messages');
+ expect(bufferAppendSpy).not.toHaveBeenCalled();
+});
+
+test('appends records via multiple appenders.', () => {
+ const loggerWithoutConfig = system.get('some-context');
+ const testsLogger = system.get('tests');
+ const testsChildLogger = system.get('tests', 'child');
+
+ loggerWithoutConfig.info('You know, just for your info.');
+ testsLogger.warn('Config is not ready!');
+ testsChildLogger.error('Too bad that config is not ready :/');
+ testsChildLogger.info('Just some info that should not be logged.');
+
+ expect(mockConsoleLog).not.toHaveBeenCalled();
+ expect(mockCreateWriteStream).not.toHaveBeenCalled();
+
+ system.upgrade(
+ config.schema.validate({
+ appenders: {
+ default: { kind: 'console', layout: { kind: 'pattern' } },
+ file: { kind: 'file', layout: { kind: 'pattern' }, path: 'path' },
+ },
+ loggers: [
+ { appenders: ['file'], context: 'tests', level: 'warn' },
+ { context: 'tests.child', level: 'error' },
+ ],
+ })
+ );
+
+ // Now all logs should added to configured appenders.
+ expect(mockConsoleLog).toHaveBeenCalledTimes(1);
+ expect(mockConsoleLog.mock.calls[0][0]).toMatchSnapshot('console logs');
+
+ expect(mockStreamWrite).toHaveBeenCalledTimes(2);
+ expect(mockStreamWrite.mock.calls[0][0]).toMatchSnapshot('file logs');
+ expect(mockStreamWrite.mock.calls[1][0]).toMatchSnapshot('file logs');
+});
+
+test('uses `root` logger if context is not specified.', () => {
+ system.upgrade(
+ config.schema.validate({
+ appenders: { default: { kind: 'console', layout: { kind: 'pattern' } } },
+ })
+ );
+
+ const rootLogger = system.get();
+ rootLogger.info('This message goes to a root context.');
+
+ expect(mockConsoleLog.mock.calls).toMatchSnapshot();
+});
+
+test('`stop()` disposes all appenders.', async () => {
+ system.upgrade(
+ config.schema.validate({
+ appenders: { default: { kind: 'console', layout: { kind: 'json' } } },
+ root: { level: 'info' },
+ })
+ );
+
+ const bufferDisposeSpy = jest.spyOn((system as any).bufferAppender, 'dispose');
+ const consoleDisposeSpy = jest.spyOn((system as any).appenders.get('default'), 'dispose');
+
+ await system.stop();
+
+ expect(bufferDisposeSpy).toHaveBeenCalledTimes(1);
+ expect(consoleDisposeSpy).toHaveBeenCalledTimes(1);
+});
+
+test('asLoggerFactory() only allows to create new loggers.', () => {
+ const logger = system.asLoggerFactory().get('test', 'context');
+
+ system.upgrade(
+ config.schema.validate({
+ appenders: { default: { kind: 'console', layout: { kind: 'json' } } },
+ root: { level: 'all' },
+ })
+ );
+
+ logger.trace('buffered trace message');
+ logger.info('buffered info message', { some: 'value' });
+ logger.fatal('buffered fatal message');
+
+ expect(Object.keys(system.asLoggerFactory())).toEqual(['get']);
+
+ expect(mockConsoleLog).toHaveBeenCalledTimes(3);
+ expect(JSON.parse(mockConsoleLog.mock.calls[0][0])).toMatchSnapshot(dynamicProps);
+ expect(JSON.parse(mockConsoleLog.mock.calls[1][0])).toMatchSnapshot(dynamicProps);
+ expect(JSON.parse(mockConsoleLog.mock.calls[2][0])).toMatchSnapshot(dynamicProps);
+});
+
+test('setContextConfig() updates config with relative contexts', () => {
+ const testsLogger = system.get('tests');
+ const testsChildLogger = system.get('tests', 'child');
+ const testsGrandchildLogger = system.get('tests', 'child', 'grandchild');
+
+ system.upgrade(
+ config.schema.validate({
+ appenders: { default: { kind: 'console', layout: { kind: 'json' } } },
+ root: { level: 'info' },
+ })
+ );
+
+ system.setContextConfig(['tests', 'child'], {
+ appenders: new Map([
+ [
+ 'custom',
+ { kind: 'console', layout: { kind: 'pattern', pattern: '[%level][%logger] %message' } },
+ ],
+ ]),
+ loggers: [{ context: 'grandchild', appenders: ['default', 'custom'], level: 'debug' }],
+ });
+
+ testsLogger.warn('tests log to default!');
+ testsChildLogger.error('tests.child log to default!');
+ testsGrandchildLogger.debug('tests.child.grandchild log to default and custom!');
+
+ expect(mockConsoleLog).toHaveBeenCalledTimes(4);
+ // Parent contexts are unaffected
+ expect(JSON.parse(mockConsoleLog.mock.calls[0][0])).toMatchObject({
+ context: 'tests',
+ message: 'tests log to default!',
+ level: 'WARN',
+ });
+ expect(JSON.parse(mockConsoleLog.mock.calls[1][0])).toMatchObject({
+ context: 'tests.child',
+ message: 'tests.child log to default!',
+ level: 'ERROR',
+ });
+ // Customized context is logged in both appender formats
+ expect(JSON.parse(mockConsoleLog.mock.calls[2][0])).toMatchObject({
+ context: 'tests.child.grandchild',
+ message: 'tests.child.grandchild log to default and custom!',
+ level: 'DEBUG',
+ });
+ expect(mockConsoleLog.mock.calls[3][0]).toMatchInlineSnapshot(
+ `"[DEBUG][tests.child.grandchild] tests.child.grandchild log to default and custom!"`
+ );
+});
+
+test('custom context configs are applied on subsequent calls to update()', () => {
+ system.setContextConfig(['tests', 'child'], {
+ appenders: new Map([
+ [
+ 'custom',
+ { kind: 'console', layout: { kind: 'pattern', pattern: '[%level][%logger] %message' } },
+ ],
+ ]),
+ loggers: [{ context: 'grandchild', appenders: ['default', 'custom'], level: 'debug' }],
+ });
+
+ // Calling upgrade after setContextConfig should not throw away the context-specific config
+ system.upgrade(
+ config.schema.validate({
+ appenders: { default: { kind: 'console', layout: { kind: 'json' } } },
+ root: { level: 'info' },
+ })
+ );
+
+ system
+ .get('tests', 'child', 'grandchild')
+ .debug('tests.child.grandchild log to default and custom!');
+
+ // Customized context is logged in both appender formats still
+ expect(mockConsoleLog).toHaveBeenCalledTimes(2);
+ expect(JSON.parse(mockConsoleLog.mock.calls[0][0])).toMatchObject({
+ context: 'tests.child.grandchild',
+ message: 'tests.child.grandchild log to default and custom!',
+ level: 'DEBUG',
+ });
+ expect(mockConsoleLog.mock.calls[1][0]).toMatchInlineSnapshot(
+ `"[DEBUG][tests.child.grandchild] tests.child.grandchild log to default and custom!"`
+ );
+});
+
+test('subsequent calls to setContextConfig() for the same context override the previous config', () => {
+ system.upgrade(
+ config.schema.validate({
+ appenders: { default: { kind: 'console', layout: { kind: 'json' } } },
+ root: { level: 'info' },
+ })
+ );
+
+ system.setContextConfig(['tests', 'child'], {
+ appenders: new Map([
+ [
+ 'custom',
+ { kind: 'console', layout: { kind: 'pattern', pattern: '[%level][%logger] %message' } },
+ ],
+ ]),
+ loggers: [{ context: 'grandchild', appenders: ['default', 'custom'], level: 'debug' }],
+ });
+
+ // Call again, this time with level: 'warn' and a different pattern
+ system.setContextConfig(['tests', 'child'], {
+ appenders: new Map([
+ [
+ 'custom',
+ {
+ kind: 'console',
+ layout: { kind: 'pattern', pattern: '[%level][%logger] second pattern! %message' },
+ },
+ ],
+ ]),
+ loggers: [{ context: 'grandchild', appenders: ['default', 'custom'], level: 'warn' }],
+ });
+
+ const logger = system.get('tests', 'child', 'grandchild');
+ logger.debug('this should not show anywhere!');
+ logger.warn('tests.child.grandchild log to default and custom!');
+
+ // Only the warn log should have been logged
+ expect(mockConsoleLog).toHaveBeenCalledTimes(2);
+ expect(JSON.parse(mockConsoleLog.mock.calls[0][0])).toMatchObject({
+ context: 'tests.child.grandchild',
+ message: 'tests.child.grandchild log to default and custom!',
+ level: 'WARN',
+ });
+ expect(mockConsoleLog.mock.calls[1][0]).toMatchInlineSnapshot(
+ `"[WARN ][tests.child.grandchild] second pattern! tests.child.grandchild log to default and custom!"`
+ );
+});
+
+test('subsequent calls to setContextConfig() for the same context can disable the previous config', () => {
+ system.upgrade(
+ config.schema.validate({
+ appenders: { default: { kind: 'console', layout: { kind: 'json' } } },
+ root: { level: 'info' },
+ })
+ );
+
+ system.setContextConfig(['tests', 'child'], {
+ appenders: new Map([
+ [
+ 'custom',
+ { kind: 'console', layout: { kind: 'pattern', pattern: '[%level][%logger] %message' } },
+ ],
+ ]),
+ loggers: [{ context: 'grandchild', appenders: ['default', 'custom'], level: 'debug' }],
+ });
+
+ // Call again, this time no customizations (effectively disabling)
+ system.setContextConfig(['tests', 'child'], {});
+
+ const logger = system.get('tests', 'child', 'grandchild');
+ logger.debug('this should not show anywhere!');
+ logger.warn('tests.child.grandchild log to default!');
+
+ // Only the warn log should have been logged once on the default appender
+ expect(mockConsoleLog).toHaveBeenCalledTimes(1);
+ expect(JSON.parse(mockConsoleLog.mock.calls[0][0])).toMatchObject({
+ context: 'tests.child.grandchild',
+ message: 'tests.child.grandchild log to default!',
+ level: 'WARN',
+ });
+});
diff --git a/src/core/server/logging/logging_system.ts b/src/core/server/logging/logging_system.ts
new file mode 100644
index 0000000000000..0bab9534d2d05
--- /dev/null
+++ b/src/core/server/logging/logging_system.ts
@@ -0,0 +1,185 @@
+/*
+ * 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 { Appenders, DisposableAppender } from './appenders/appenders';
+import { BufferAppender } from './appenders/buffer/buffer_appender';
+import { LogLevel } from './log_level';
+import { BaseLogger, Logger } from './logger';
+import { LoggerAdapter } from './logger_adapter';
+import { LoggerFactory } from './logger_factory';
+import {
+ LoggingConfigType,
+ LoggerConfigType,
+ LoggingConfig,
+ LoggerContextConfigType,
+ LoggerContextConfigInput,
+ loggerContextConfigSchema,
+} from './logging_config';
+
+export type ILoggingSystem = PublicMethodsOf;
+
+/**
+ * System that is responsible for maintaining loggers and logger appenders.
+ * @internal
+ */
+export class LoggingSystem implements LoggerFactory {
+ /** The configuration set by the user. */
+ private baseConfig?: LoggingConfig;
+ /** The fully computed configuration extended by context-specific configurations set programmatically */
+ private computedConfig?: LoggingConfig;
+ private readonly appenders: Map = new Map();
+ private readonly bufferAppender = new BufferAppender();
+ private readonly loggers: Map = new Map();
+ private readonly contextConfigs = new Map();
+
+ public get(...contextParts: string[]): Logger {
+ const context = LoggingConfig.getLoggerContext(contextParts);
+ if (!this.loggers.has(context)) {
+ this.loggers.set(context, new LoggerAdapter(this.createLogger(context, this.computedConfig)));
+ }
+ return this.loggers.get(context)!;
+ }
+
+ /**
+ * Safe wrapper that allows passing logging service as immutable LoggerFactory.
+ */
+ public asLoggerFactory(): LoggerFactory {
+ return { get: (...contextParts: string[]) => this.get(...contextParts) };
+ }
+
+ /**
+ * Updates all current active loggers with the new config values.
+ * @param rawConfig New config instance.
+ */
+ public upgrade(rawConfig: LoggingConfigType) {
+ const config = new LoggingConfig(rawConfig)!;
+ this.applyBaseConfig(config);
+ }
+
+ /**
+ * Customizes the logging config for a specific context.
+ *
+ * @remarks
+ * Assumes that that the `context` property of the individual items in `rawConfig.loggers`
+ * are relative to the `baseContextParts`.
+ *
+ * @example
+ * Customize the configuration for the plugins.data.search context.
+ * ```ts
+ * loggingSystem.setContextConfig(
+ * ['plugins', 'data'],
+ * {
+ * loggers: [{ context: 'search', appenders: ['default'] }]
+ * }
+ * )
+ * ```
+ *
+ * @param baseContextParts
+ * @param rawConfig
+ */
+ public setContextConfig(baseContextParts: string[], rawConfig: LoggerContextConfigInput) {
+ const context = LoggingConfig.getLoggerContext(baseContextParts);
+ const contextConfig = loggerContextConfigSchema.validate(rawConfig);
+ this.contextConfigs.set(context, {
+ ...contextConfig,
+ // Automatically prepend the base context to the logger sub-contexts
+ loggers: contextConfig.loggers.map((l) => ({
+ ...l,
+ context: LoggingConfig.getLoggerContext([context, l.context]),
+ })),
+ });
+
+ // If we already have a base config, apply the config. If not, custom context configs
+ // will be picked up on next call to `upgrade`.
+ if (this.baseConfig) {
+ this.applyBaseConfig(this.baseConfig);
+ }
+ }
+
+ /**
+ * Disposes all loggers (closes log files, clears buffers etc.). Service is not usable after
+ * calling of this method until new config is provided via `upgrade` method.
+ * @returns Promise that is resolved once all loggers are successfully disposed.
+ */
+ public async stop() {
+ await Promise.all([...this.appenders.values()].map((a) => a.dispose()));
+
+ await this.bufferAppender.dispose();
+
+ this.appenders.clear();
+ this.loggers.clear();
+ }
+
+ private createLogger(context: string, config: LoggingConfig | undefined) {
+ if (config === undefined) {
+ // If we don't have config yet, use `buffered` appender that will store all logged messages in the memory
+ // until the config is ready.
+ return new BaseLogger(context, LogLevel.All, [this.bufferAppender], this.asLoggerFactory());
+ }
+
+ const { level, appenders } = this.getLoggerConfigByContext(config, context);
+ const loggerLevel = LogLevel.fromId(level);
+ const loggerAppenders = appenders.map((appenderKey) => this.appenders.get(appenderKey)!);
+
+ return new BaseLogger(context, loggerLevel, loggerAppenders, this.asLoggerFactory());
+ }
+
+ private getLoggerConfigByContext(config: LoggingConfig, context: string): LoggerConfigType {
+ const loggerConfig = config.loggers.get(context);
+ if (loggerConfig !== undefined) {
+ return loggerConfig;
+ }
+
+ // If we don't have configuration for the specified context and it's the "nested" one (eg. `foo.bar.baz`),
+ // let's move up to the parent context (eg. `foo.bar`) and check if it has config we can rely on. Otherwise
+ // we fallback to the `root` context that should always be defined (enforced by configuration schema).
+ return this.getLoggerConfigByContext(config, LoggingConfig.getParentLoggerContext(context));
+ }
+
+ private applyBaseConfig(newBaseConfig: LoggingConfig) {
+ const computedConfig = [...this.contextConfigs.values()].reduce(
+ (baseConfig, contextConfig) => baseConfig.extend(contextConfig),
+ newBaseConfig
+ );
+
+ // Appenders must be reset, so we first dispose of the current ones, then
+ // build up a new set of appenders.
+ for (const appender of this.appenders.values()) {
+ appender.dispose();
+ }
+ this.appenders.clear();
+
+ for (const [appenderKey, appenderConfig] of computedConfig.appenders) {
+ this.appenders.set(appenderKey, Appenders.create(appenderConfig));
+ }
+
+ for (const [loggerKey, loggerAdapter] of this.loggers) {
+ loggerAdapter.updateLogger(this.createLogger(loggerKey, computedConfig));
+ }
+
+ // We keep a reference to the base config so we can properly extend it
+ // on each config change.
+ this.baseConfig = newBaseConfig;
+ this.computedConfig = computedConfig;
+
+ // Re-log all buffered log records with newly configured appenders.
+ for (const logRecord of this.bufferAppender.flush()) {
+ this.get(logRecord.context).log(logRecord);
+ }
+ }
+}
diff --git a/src/core/server/mocks.ts b/src/core/server/mocks.ts
index f3ae5462f1631..0770e8843e2f6 100644
--- a/src/core/server/mocks.ts
+++ b/src/core/server/mocks.ts
@@ -19,6 +19,7 @@
import { of } from 'rxjs';
import { duration } from 'moment';
import { PluginInitializerContext, CoreSetup, CoreStart, StartServicesAccessor } from '.';
+import { loggingSystemMock } from './logging/logging_system.mock';
import { loggingServiceMock } from './logging/logging_service.mock';
import { elasticsearchServiceMock } from './elasticsearch/elasticsearch_service.mock';
import { httpServiceMock } from './http/http_service.mock';
@@ -42,7 +43,7 @@ export { sessionStorageMock } from './http/cookie_session_storage.mocks';
export { configServiceMock } from './config/config_service.mock';
export { elasticsearchServiceMock } from './elasticsearch/elasticsearch_service.mock';
export { httpServiceMock } from './http/http_service.mock';
-export { loggingServiceMock } from './logging/logging_service.mock';
+export { loggingSystemMock } from './logging/logging_system.mock';
export { savedObjectsRepositoryMock } from './saved_objects/service/lib/repository.mock';
export { savedObjectsServiceMock } from './saved_objects/saved_objects_service.mock';
export { typeRegistryMock as savedObjectsTypeRegistryMock } from './saved_objects/saved_objects_type_registry.mock';
@@ -78,7 +79,7 @@ export function pluginInitializerContextConfigMock(config: T) {
function pluginInitializerContextMock(config: T = {} as T) {
const mock: PluginInitializerContext = {
opaqueId: Symbol(),
- logger: loggingServiceMock.create(),
+ logger: loggingSystemMock.create(),
env: {
mode: {
dev: true,
@@ -130,6 +131,7 @@ function createCoreSetupMock({
metrics: metricsServiceMock.createSetupContract(),
uiSettings: uiSettingsMock,
uuid: uuidServiceMock.createSetupContract(),
+ logging: loggingServiceMock.createSetupContract(),
getStartServices: jest
.fn, object, any]>, []>()
.mockResolvedValue([createCoreStartMock(), pluginStartDeps, pluginStartContract]),
@@ -163,6 +165,7 @@ function createInternalCoreSetupMock() {
httpResources: httpResourcesMock.createSetupContract(),
rendering: renderingMock.createSetupContract(),
uiSettings: uiSettingsServiceMock.createSetupContract(),
+ logging: loggingServiceMock.createInternalSetupContract(),
};
return setupDeps;
}
diff --git a/src/core/server/plugins/discovery/plugin_manifest_parser.test.ts b/src/core/server/plugins/discovery/plugin_manifest_parser.test.ts
index 979accb1f769e..5ffdef88104c8 100644
--- a/src/core/server/plugins/discovery/plugin_manifest_parser.test.ts
+++ b/src/core/server/plugins/discovery/plugin_manifest_parser.test.ts
@@ -20,12 +20,12 @@
import { PluginDiscoveryErrorType } from './plugin_discovery_error';
import { mockReadFile } from './plugin_manifest_parser.test.mocks';
-import { loggingServiceMock } from '../../logging/logging_service.mock';
+import { loggingSystemMock } from '../../logging/logging_system.mock';
import { resolve } from 'path';
import { parseManifest } from './plugin_manifest_parser';
-const logger = loggingServiceMock.createLogger();
+const logger = loggingSystemMock.createLogger();
const pluginPath = resolve('path', 'existent-dir');
const pluginManifestPath = resolve(pluginPath, 'kibana.json');
const packageInfo = {
@@ -105,9 +105,9 @@ test('logs warning if pluginId is not in camelCase format', async () => {
cb(null, Buffer.from(JSON.stringify({ id: 'some_name', version: 'kibana', server: true })));
});
- expect(loggingServiceMock.collect(logger).warn).toHaveLength(0);
+ expect(loggingSystemMock.collect(logger).warn).toHaveLength(0);
await parseManifest(pluginPath, packageInfo, logger);
- expect(loggingServiceMock.collect(logger).warn).toMatchInlineSnapshot(`
+ expect(loggingSystemMock.collect(logger).warn).toMatchInlineSnapshot(`
Array [
Array [
"Expect plugin \\"id\\" in camelCase, but found: some_name",
diff --git a/src/core/server/plugins/discovery/plugins_discovery.test.ts b/src/core/server/plugins/discovery/plugins_discovery.test.ts
index 73f274957cbc4..1c42f5dcfc7a7 100644
--- a/src/core/server/plugins/discovery/plugins_discovery.test.ts
+++ b/src/core/server/plugins/discovery/plugins_discovery.test.ts
@@ -19,7 +19,7 @@
import { mockPackage, mockReaddir, mockReadFile, mockStat } from './plugins_discovery.test.mocks';
import { rawConfigServiceMock } from '../../config/raw_config_service.mock';
-import { loggingServiceMock } from '../../logging/logging_service.mock';
+import { loggingSystemMock } from '../../logging/logging_system.mock';
import { resolve } from 'path';
import { first, map, toArray } from 'rxjs/operators';
@@ -37,7 +37,7 @@ const TEST_PLUGIN_SEARCH_PATHS = {
};
const TEST_EXTRA_PLUGIN_PATH = resolve(process.cwd(), 'my-extra-plugin');
-const logger = loggingServiceMock.create();
+const logger = loggingSystemMock.create();
beforeEach(() => {
mockReaddir.mockImplementation((path, cb) => {
@@ -221,7 +221,7 @@ test('logs a warning about --plugin-path when used in development', async () =>
logger,
});
- expect(loggingServiceMock.collect(logger).warn).toEqual([
+ expect(loggingSystemMock.collect(logger).warn).toEqual([
[
`Explicit plugin paths [${TEST_EXTRA_PLUGIN_PATH}] should only be used in development. Relative imports may not work properly in production.`,
],
@@ -263,5 +263,5 @@ test('does not log a warning about --plugin-path when used in production', async
logger,
});
- expect(loggingServiceMock.collect(logger).warn).toEqual([]);
+ expect(loggingSystemMock.collect(logger).warn).toEqual([]);
});
diff --git a/src/core/server/plugins/integration_tests/plugins_service.test.ts b/src/core/server/plugins/integration_tests/plugins_service.test.ts
index 04f570cca489b..e676c789449ca 100644
--- a/src/core/server/plugins/integration_tests/plugins_service.test.ts
+++ b/src/core/server/plugins/integration_tests/plugins_service.test.ts
@@ -27,13 +27,13 @@ import { getEnvOptions } from '../../config/__mocks__/env';
import { BehaviorSubject, from } from 'rxjs';
import { rawConfigServiceMock } from '../../config/raw_config_service.mock';
import { config } from '../plugins_config';
-import { loggingServiceMock } from '../../logging/logging_service.mock';
+import { loggingSystemMock } from '../../logging/logging_system.mock';
import { coreMock } from '../../mocks';
import { Plugin } from '../types';
import { PluginWrapper } from '../plugin';
describe('PluginsService', () => {
- const logger = loggingServiceMock.create();
+ const logger = loggingSystemMock.create();
let pluginsService: PluginsService;
const createPlugin = (
diff --git a/src/core/server/plugins/plugin.test.ts b/src/core/server/plugins/plugin.test.ts
index 8d82d96f949c7..ec0a3986b4877 100644
--- a/src/core/server/plugins/plugin.test.ts
+++ b/src/core/server/plugins/plugin.test.ts
@@ -26,14 +26,14 @@ import { getEnvOptions } from '../config/__mocks__/env';
import { CoreContext } from '../core_context';
import { coreMock } from '../mocks';
import { configServiceMock } from '../config/config_service.mock';
-import { loggingServiceMock } from '../logging/logging_service.mock';
+import { loggingSystemMock } from '../logging/logging_system.mock';
import { PluginWrapper } from './plugin';
import { PluginManifest } from './types';
import { createPluginInitializerContext, createPluginSetupContext } from './plugin_context';
const mockPluginInitializer = jest.fn();
-const logger = loggingServiceMock.create();
+const logger = loggingSystemMock.create();
jest.doMock(
join('plugin-with-initializer-path', 'server'),
() => ({ plugin: mockPluginInitializer }),
diff --git a/src/core/server/plugins/plugin.ts b/src/core/server/plugins/plugin.ts
index d7cfaa14d2343..2e5881c651843 100644
--- a/src/core/server/plugins/plugin.ts
+++ b/src/core/server/plugins/plugin.ts
@@ -95,8 +95,6 @@ export class PluginWrapper<
public async setup(setupContext: CoreSetup, plugins: TPluginsSetup) {
this.instance = this.createPluginInstance();
- this.log.debug('Setting up plugin');
-
return this.instance.setup(setupContext, plugins);
}
@@ -112,8 +110,6 @@ export class PluginWrapper<
throw new Error(`Plugin "${this.name}" can't be started since it isn't set up.`);
}
- this.log.debug('Starting plugin');
-
const startContract = await this.instance.start(startContext, plugins);
this.startDependencies$.next([startContext, plugins, startContract]);
return startContract;
@@ -127,8 +123,6 @@ export class PluginWrapper<
throw new Error(`Plugin "${this.name}" can't be stopped since it isn't set up.`);
}
- this.log.info('Stopping plugin');
-
if (typeof this.instance.stop === 'function') {
await this.instance.stop();
}
diff --git a/src/core/server/plugins/plugin_context.test.ts b/src/core/server/plugins/plugin_context.test.ts
index 54350d96984b4..69b354661abc9 100644
--- a/src/core/server/plugins/plugin_context.test.ts
+++ b/src/core/server/plugins/plugin_context.test.ts
@@ -22,14 +22,14 @@ import { first } from 'rxjs/operators';
import { createPluginInitializerContext } from './plugin_context';
import { CoreContext } from '../core_context';
import { Env } from '../config';
-import { loggingServiceMock } from '../logging/logging_service.mock';
+import { loggingSystemMock } from '../logging/logging_system.mock';
import { rawConfigServiceMock } from '../config/raw_config_service.mock';
import { getEnvOptions } from '../config/__mocks__/env';
import { PluginManifest } from './types';
import { Server } from '../server';
import { fromRoot } from '../utils';
-const logger = loggingServiceMock.create();
+const logger = loggingSystemMock.create();
let coreId: symbol;
let env: Env;
diff --git a/src/core/server/plugins/plugin_context.ts b/src/core/server/plugins/plugin_context.ts
index 31e36db49223a..32bc8dc088cad 100644
--- a/src/core/server/plugins/plugin_context.ts
+++ b/src/core/server/plugins/plugin_context.ts
@@ -166,6 +166,9 @@ export function createPluginSetupContext(
csp: deps.http.csp,
getServerInfo: deps.http.getServerInfo,
},
+ logging: {
+ configure: (config$) => deps.logging.configure(['plugins', plugin.name], config$),
+ },
metrics: {
getOpsMetrics$: deps.metrics.getOpsMetrics$,
},
diff --git a/src/core/server/plugins/plugins_service.test.ts b/src/core/server/plugins/plugins_service.test.ts
index 6f8d15838641f..c277dc85e5e04 100644
--- a/src/core/server/plugins/plugins_service.test.ts
+++ b/src/core/server/plugins/plugins_service.test.ts
@@ -28,7 +28,7 @@ import { ConfigPath, ConfigService, Env } from '../config';
import { rawConfigServiceMock } from '../config/raw_config_service.mock';
import { getEnvOptions } from '../config/__mocks__/env';
import { coreMock } from '../mocks';
-import { loggingServiceMock } from '../logging/logging_service.mock';
+import { loggingSystemMock } from '../logging/logging_system.mock';
import { PluginDiscoveryError } from './discovery';
import { PluginWrapper } from './plugin';
import { PluginsService } from './plugins_service';
@@ -47,7 +47,7 @@ let env: Env;
let mockPluginSystem: jest.Mocked;
const setupDeps = coreMock.createInternalSetup();
-const logger = loggingServiceMock.create();
+const logger = loggingSystemMock.create();
expect.addSnapshotSerializer(createAbsolutePathSerializer());
@@ -138,7 +138,7 @@ describe('PluginsService', () => {
[Error: Failed to initialize plugins:
Invalid JSON (invalid-manifest, path-1)]
`);
- expect(loggingServiceMock.collect(logger).error).toMatchInlineSnapshot(`
+ expect(loggingSystemMock.collect(logger).error).toMatchInlineSnapshot(`
Array [
Array [
[Error: Invalid JSON (invalid-manifest, path-1)],
@@ -159,7 +159,7 @@ describe('PluginsService', () => {
[Error: Failed to initialize plugins:
Incompatible version (incompatible-version, path-3)]
`);
- expect(loggingServiceMock.collect(logger).error).toMatchInlineSnapshot(`
+ expect(loggingSystemMock.collect(logger).error).toMatchInlineSnapshot(`
Array [
Array [
[Error: Incompatible version (incompatible-version, path-3)],
@@ -238,7 +238,7 @@ describe('PluginsService', () => {
expect(mockPluginSystem.setupPlugins).toHaveBeenCalledTimes(1);
expect(mockPluginSystem.setupPlugins).toHaveBeenCalledWith(setupDeps);
- expect(loggingServiceMock.collect(logger).info).toMatchInlineSnapshot(`
+ expect(loggingSystemMock.collect(logger).info).toMatchInlineSnapshot(`
Array [
Array [
"Plugin \\"explicitly-disabled-plugin\\" is disabled.",
@@ -360,7 +360,7 @@ describe('PluginsService', () => {
{ coreId, env, logger, configService }
);
- const logs = loggingServiceMock.collect(logger);
+ const logs = loggingSystemMock.collect(logger);
expect(logs.info).toHaveLength(0);
expect(logs.error).toHaveLength(0);
});
diff --git a/src/core/server/plugins/plugins_system.test.ts b/src/core/server/plugins/plugins_system.test.ts
index 70983e4fd087b..a40df70228ff3 100644
--- a/src/core/server/plugins/plugins_system.test.ts
+++ b/src/core/server/plugins/plugins_system.test.ts
@@ -28,7 +28,7 @@ import { Env } from '../config';
import { getEnvOptions } from '../config/__mocks__/env';
import { CoreContext } from '../core_context';
import { configServiceMock } from '../config/config_service.mock';
-import { loggingServiceMock } from '../logging/logging_service.mock';
+import { loggingSystemMock } from '../logging/logging_system.mock';
import { PluginWrapper } from './plugin';
import { PluginName } from './types';
@@ -36,7 +36,7 @@ import { PluginsSystem } from './plugins_system';
import { coreMock } from '../mocks';
import { Logger } from '../logging';
-const logger = loggingServiceMock.create();
+const logger = loggingSystemMock.create();
function createPlugin(
id: string,
{
diff --git a/src/core/server/root/index.test.mocks.ts b/src/core/server/root/index.test.mocks.ts
index 1d3add66d7c22..ef4a40fa3db2d 100644
--- a/src/core/server/root/index.test.mocks.ts
+++ b/src/core/server/root/index.test.mocks.ts
@@ -17,10 +17,10 @@
* under the License.
*/
-import { loggingServiceMock } from '../logging/logging_service.mock';
-export const logger = loggingServiceMock.create();
-jest.doMock('../logging/logging_service', () => ({
- LoggingService: jest.fn(() => logger),
+import { loggingSystemMock } from '../logging/logging_system.mock';
+export const logger = loggingSystemMock.create();
+jest.doMock('../logging/logging_system', () => ({
+ LoggingSystem: jest.fn(() => logger),
}));
import { configServiceMock } from '../config/config_service.mock';
diff --git a/src/core/server/root/index.ts b/src/core/server/root/index.ts
index d6d0c641e00b0..5e9722de03dee 100644
--- a/src/core/server/root/index.ts
+++ b/src/core/server/root/index.ts
@@ -21,7 +21,7 @@ import { ConnectableObservable, Subscription } from 'rxjs';
import { first, map, publishReplay, switchMap, tap } from 'rxjs/operators';
import { Env, RawConfigurationProvider } from '../config';
-import { Logger, LoggerFactory, LoggingConfigType, LoggingService } from '../logging';
+import { Logger, LoggerFactory, LoggingConfigType, LoggingSystem } from '../logging';
import { Server } from '../server';
/**
@@ -30,7 +30,7 @@ import { Server } from '../server';
export class Root {
public readonly logger: LoggerFactory;
private readonly log: Logger;
- private readonly loggingService: LoggingService;
+ private readonly loggingSystem: LoggingSystem;
private readonly server: Server;
private loggingConfigSubscription?: Subscription;
@@ -39,10 +39,10 @@ export class Root {
env: Env,
private readonly onShutdown?: (reason?: Error | string) => void
) {
- this.loggingService = new LoggingService();
- this.logger = this.loggingService.asLoggerFactory();
+ this.loggingSystem = new LoggingSystem();
+ this.logger = this.loggingSystem.asLoggerFactory();
this.log = this.logger.get('root');
- this.server = new Server(rawConfigProvider, env, this.logger);
+ this.server = new Server(rawConfigProvider, env, this.loggingSystem);
}
public async setup() {
@@ -86,7 +86,7 @@ export class Root {
this.loggingConfigSubscription.unsubscribe();
this.loggingConfigSubscription = undefined;
}
- await this.loggingService.stop();
+ await this.loggingSystem.stop();
if (this.onShutdown !== undefined) {
this.onShutdown(reason);
@@ -99,7 +99,7 @@ export class Root {
const update$ = configService.getConfig$().pipe(
// always read the logging config when the underlying config object is re-read
switchMap(() => configService.atPath('logging')),
- map((config) => this.loggingService.upgrade(config)),
+ map((config) => this.loggingSystem.upgrade(config)),
// This specifically console.logs because we were not able to configure the logger.
// eslint-disable-next-line no-console
tap({ error: (err) => console.error('Configuring logger failed:', err) }),
diff --git a/src/core/server/saved_objects/migrations/core/document_migrator.test.ts b/src/core/server/saved_objects/migrations/core/document_migrator.test.ts
index a364710322524..6287d47f99f62 100644
--- a/src/core/server/saved_objects/migrations/core/document_migrator.test.ts
+++ b/src/core/server/saved_objects/migrations/core/document_migrator.test.ts
@@ -20,11 +20,11 @@
import _ from 'lodash';
import { SavedObjectUnsanitizedDoc } from '../../serialization';
import { DocumentMigrator } from './document_migrator';
-import { loggingServiceMock } from '../../../logging/logging_service.mock';
+import { loggingSystemMock } from '../../../logging/logging_system.mock';
import { SavedObjectsType } from '../../types';
import { SavedObjectTypeRegistry } from '../../saved_objects_type_registry';
-const mockLoggerFactory = loggingServiceMock.create();
+const mockLoggerFactory = loggingSystemMock.create();
const mockLogger = mockLoggerFactory.get('mock logger');
const createRegistry = (...types: Array>) => {
@@ -572,7 +572,7 @@ describe('DocumentMigrator', () => {
expect('Did not throw').toEqual('But it should have!');
} catch (error) {
expect(error.message).toMatch(/Dang diggity!/);
- const warning = loggingServiceMock.collect(mockLoggerFactory).warn[0][0];
+ const warning = loggingSystemMock.collect(mockLoggerFactory).warn[0][0];
expect(warning).toContain(JSON.stringify(failedDoc));
expect(warning).toContain('dog:1.2.3');
}
@@ -601,8 +601,8 @@ describe('DocumentMigrator', () => {
migrationVersion: {},
};
migrator.migrate(doc);
- expect(loggingServiceMock.collect(mockLoggerFactory).info[0][0]).toEqual(logTestMsg);
- expect(loggingServiceMock.collect(mockLoggerFactory).warn[1][0]).toEqual(logTestMsg);
+ expect(loggingSystemMock.collect(mockLoggerFactory).info[0][0]).toEqual(logTestMsg);
+ expect(loggingSystemMock.collect(mockLoggerFactory).warn[1][0]).toEqual(logTestMsg);
});
test('extracts the latest migration version info', () => {
diff --git a/src/core/server/saved_objects/migrations/core/index_migrator.test.ts b/src/core/server/saved_objects/migrations/core/index_migrator.test.ts
index 392089c69f5a0..86c79cbfb5824 100644
--- a/src/core/server/saved_objects/migrations/core/index_migrator.test.ts
+++ b/src/core/server/saved_objects/migrations/core/index_migrator.test.ts
@@ -21,7 +21,7 @@ import _ from 'lodash';
import { SavedObjectUnsanitizedDoc, SavedObjectsSerializer } from '../../serialization';
import { SavedObjectTypeRegistry } from '../../saved_objects_type_registry';
import { IndexMigrator } from './index_migrator';
-import { loggingServiceMock } from '../../../logging/logging_service.mock';
+import { loggingSystemMock } from '../../../logging/logging_system.mock';
describe('IndexMigrator', () => {
let testOpts: any;
@@ -31,7 +31,7 @@ describe('IndexMigrator', () => {
batchSize: 10,
callCluster: jest.fn(),
index: '.kibana',
- log: loggingServiceMock.create().get(),
+ log: loggingSystemMock.create().get(),
mappingProperties: {},
pollInterval: 1,
scrollDuration: '1m',
diff --git a/src/core/server/saved_objects/migrations/kibana/kibana_migrator.test.ts b/src/core/server/saved_objects/migrations/kibana/kibana_migrator.test.ts
index 7a5c044924d0e..01b0d1cd0ba3a 100644
--- a/src/core/server/saved_objects/migrations/kibana/kibana_migrator.test.ts
+++ b/src/core/server/saved_objects/migrations/kibana/kibana_migrator.test.ts
@@ -19,7 +19,7 @@
import { take } from 'rxjs/operators';
import { KibanaMigratorOptions, KibanaMigrator } from './kibana_migrator';
-import { loggingServiceMock } from '../../../logging/logging_service.mock';
+import { loggingSystemMock } from '../../../logging/logging_system.mock';
import { SavedObjectTypeRegistry } from '../../saved_objects_type_registry';
import { SavedObjectsType } from '../../types';
@@ -110,7 +110,7 @@ describe('KibanaMigrator', () => {
function mockOptions(): KibanaMigratorOptions {
const callCluster = jest.fn();
return {
- logger: loggingServiceMock.create().get(),
+ logger: loggingSystemMock.create().get(),
kibanaVersion: '8.2.3',
savedObjectValidations: {},
typeRegistry: createRegistry([
diff --git a/src/core/server/saved_objects/routes/integration_tests/log_legacy_import.test.ts b/src/core/server/saved_objects/routes/integration_tests/log_legacy_import.test.ts
index 0fe07245dda20..8d021580da36c 100644
--- a/src/core/server/saved_objects/routes/integration_tests/log_legacy_import.test.ts
+++ b/src/core/server/saved_objects/routes/integration_tests/log_legacy_import.test.ts
@@ -20,7 +20,7 @@
import supertest from 'supertest';
import { UnwrapPromise } from '@kbn/utility-types';
import { registerLogLegacyImportRoute } from '../log_legacy_import';
-import { loggingServiceMock } from '../../../logging/logging_service.mock';
+import { loggingSystemMock } from '../../../logging/logging_system.mock';
import { setupServer } from '../test_utils';
type setupServerReturn = UnwrapPromise>;
@@ -28,11 +28,11 @@ type setupServerReturn = UnwrapPromise>;
describe('POST /api/saved_objects/_log_legacy_import', () => {
let server: setupServerReturn['server'];
let httpSetup: setupServerReturn['httpSetup'];
- let logger: ReturnType;
+ let logger: ReturnType;
beforeEach(async () => {
({ server, httpSetup } = await setupServer());
- logger = loggingServiceMock.createLogger();
+ logger = loggingSystemMock.createLogger();
const router = httpSetup.createRouter('/api/saved_objects/');
registerLogLegacyImportRoute(router, logger);
@@ -50,7 +50,7 @@ describe('POST /api/saved_objects/_log_legacy_import', () => {
.expect(200);
expect(result.body).toEqual({ success: true });
- expect(loggingServiceMock.collect(logger).warn).toMatchInlineSnapshot(`
+ expect(loggingSystemMock.collect(logger).warn).toMatchInlineSnapshot(`
Array [
Array [
"Importing saved objects from a .json file has been deprecated",
diff --git a/src/core/server/server.api.md b/src/core/server/server.api.md
index 9dc3ac9b94d96..4d6316fceb568 100644
--- a/src/core/server/server.api.md
+++ b/src/core/server/server.api.md
@@ -388,6 +388,11 @@ export interface APICaller {
(endpoint: string, clientParams?: Record, options?: CallAPIOptions): Promise;
}
+// Warning: (ae-forgotten-export) The symbol "appendersSchema" needs to be exported by the entry point index.d.ts
+//
+// @public (undocumented)
+export type AppenderConfigType = TypeOf;
+
// @public
export function assertNever(x: never): never;
@@ -574,6 +579,72 @@ export const config: {
ignoreVersionMismatch: import("@kbn/config-schema/target/types/types").ConditionalType;
}>;
};
+ logging: {
+ appenders: import("@kbn/config-schema").Type | Readonly<{
+ pattern?: string | undefined;
+ highlight?: boolean | undefined;
+ } & {
+ kind: "pattern";
+ }>;
+ kind: "console";
+ }> | Readonly<{} & {
+ path: string;
+ layout: Readonly<{} & {
+ kind: "json";
+ }> | Readonly<{
+ pattern?: string | undefined;
+ highlight?: boolean | undefined;
+ } & {
+ kind: "pattern";
+ }>;
+ kind: "file";
+ }> | Readonly<{
+ legacyLoggingConfig?: any;
+ } & {
+ kind: "legacy-appender";
+ }>>;
+ loggers: import("@kbn/config-schema").ObjectType<{
+ appenders: import("@kbn/config-schema").Type;
+ context: import("@kbn/config-schema").Type;
+ level: import("@kbn/config-schema").Type;
+ }>;
+ loggerContext: import("@kbn/config-schema").ObjectType<{
+ appenders: import("@kbn/config-schema").Type | Readonly<{
+ pattern?: string | undefined;
+ highlight?: boolean | undefined;
+ } & {
+ kind: "pattern";
+ }>;
+ kind: "console";
+ }> | Readonly<{} & {
+ path: string;
+ layout: Readonly<{} & {
+ kind: "json";
+ }> | Readonly<{
+ pattern?: string | undefined;
+ highlight?: boolean | undefined;
+ } & {
+ kind: "pattern";
+ }>;
+ kind: "file";
+ }> | Readonly<{
+ legacyLoggingConfig?: any;
+ } & {
+ kind: "legacy-appender";
+ }>>>;
+ loggers: import("@kbn/config-schema").Type[]>;
+ }>;
+ };
};
// @public
@@ -639,6 +710,8 @@ export interface CoreSetup;
+
+// @public (undocumented)
+export interface LoggerContextConfigInput {
+ // (undocumented)
+ appenders?: Record | Map;
+ // (undocumented)
+ loggers?: LoggerConfigType[];
+}
+
// @public
export interface LoggerFactory {
get(...contextParts: string[]): Logger;
}
+// @public
+export interface LoggingServiceSetup {
+ configure(config$: Observable): void;
+}
+
// @internal
export class LogLevel {
// (undocumented)
diff --git a/src/core/server/server.test.mocks.ts b/src/core/server/server.test.mocks.ts
index 5d535c9845724..e5e710d54e04b 100644
--- a/src/core/server/server.test.mocks.ts
+++ b/src/core/server/server.test.mocks.ts
@@ -91,3 +91,9 @@ export const mockStatusService = statusServiceMock.create();
jest.doMock('./status/status_service', () => ({
StatusService: jest.fn(() => mockStatusService),
}));
+
+import { loggingServiceMock } from './logging/logging_service.mock';
+export const mockLoggingService = loggingServiceMock.create();
+jest.doMock('./logging/logging_service', () => ({
+ LoggingService: jest.fn(() => mockLoggingService),
+}));
diff --git a/src/core/server/server.test.ts b/src/core/server/server.test.ts
index 1e3e1638cf2a0..1f507a85d3ddf 100644
--- a/src/core/server/server.test.ts
+++ b/src/core/server/server.test.ts
@@ -30,6 +30,7 @@ import {
mockRenderingService,
mockMetricsService,
mockStatusService,
+ mockLoggingService,
} from './server.test.mocks';
import { BehaviorSubject } from 'rxjs';
@@ -37,11 +38,11 @@ import { Env } from './config';
import { Server } from './server';
import { getEnvOptions } from './config/__mocks__/env';
-import { loggingServiceMock } from './logging/logging_service.mock';
+import { loggingSystemMock } from './logging/logging_system.mock';
import { rawConfigServiceMock } from './config/raw_config_service.mock';
const env = new Env('.', getEnvOptions());
-const logger = loggingServiceMock.create();
+const logger = loggingSystemMock.create();
const rawConfigService = rawConfigServiceMock.create({});
beforeEach(() => {
@@ -68,6 +69,7 @@ test('sets up services on "setup"', async () => {
expect(mockRenderingService.setup).not.toHaveBeenCalled();
expect(mockMetricsService.setup).not.toHaveBeenCalled();
expect(mockStatusService.setup).not.toHaveBeenCalled();
+ expect(mockLoggingService.setup).not.toHaveBeenCalled();
await server.setup();
@@ -80,6 +82,7 @@ test('sets up services on "setup"', async () => {
expect(mockRenderingService.setup).toHaveBeenCalledTimes(1);
expect(mockMetricsService.setup).toHaveBeenCalledTimes(1);
expect(mockStatusService.setup).toHaveBeenCalledTimes(1);
+ expect(mockLoggingService.setup).toHaveBeenCalledTimes(1);
});
test('injects legacy dependency to context#setup()', async () => {
@@ -151,6 +154,7 @@ test('stops services on "stop"', async () => {
expect(mockUiSettingsService.stop).not.toHaveBeenCalled();
expect(mockMetricsService.stop).not.toHaveBeenCalled();
expect(mockStatusService.stop).not.toHaveBeenCalled();
+ expect(mockLoggingService.stop).not.toHaveBeenCalled();
await server.stop();
@@ -162,6 +166,7 @@ test('stops services on "stop"', async () => {
expect(mockUiSettingsService.stop).toHaveBeenCalledTimes(1);
expect(mockMetricsService.stop).toHaveBeenCalledTimes(1);
expect(mockStatusService.stop).toHaveBeenCalledTimes(1);
+ expect(mockLoggingService.stop).toHaveBeenCalledTimes(1);
});
test(`doesn't setup core services if config validation fails`, async () => {
@@ -179,6 +184,7 @@ test(`doesn't setup core services if config validation fails`, async () => {
expect(mockRenderingService.setup).not.toHaveBeenCalled();
expect(mockMetricsService.setup).not.toHaveBeenCalled();
expect(mockStatusService.setup).not.toHaveBeenCalled();
+ expect(mockLoggingService.setup).not.toHaveBeenCalled();
});
test(`doesn't setup core services if legacy config validation fails`, async () => {
@@ -200,4 +206,5 @@ test(`doesn't setup core services if legacy config validation fails`, async () =
expect(mockUiSettingsService.setup).not.toHaveBeenCalled();
expect(mockMetricsService.setup).not.toHaveBeenCalled();
expect(mockStatusService.setup).not.toHaveBeenCalled();
+ expect(mockLoggingService.setup).not.toHaveBeenCalled();
});
diff --git a/src/core/server/server.ts b/src/core/server/server.ts
index ae1a02cf71b88..3bbcd0e37e142 100644
--- a/src/core/server/server.ts
+++ b/src/core/server/server.ts
@@ -32,7 +32,7 @@ import { HttpService } from './http';
import { HttpResourcesService } from './http_resources';
import { RenderingService } from './rendering';
import { LegacyService, ensureValidConfiguration } from './legacy';
-import { Logger, LoggerFactory } from './logging';
+import { Logger, LoggerFactory, LoggingService, ILoggingSystem } from './logging';
import { UiSettingsService } from './ui_settings';
import { PluginsService, config as pluginsConfig } from './plugins';
import { SavedObjectsService } from '../server/saved_objects';
@@ -74,20 +74,23 @@ export class Server {
private readonly metrics: MetricsService;
private readonly httpResources: HttpResourcesService;
private readonly status: StatusService;
+ private readonly logging: LoggingService;
private readonly coreApp: CoreApp;
#pluginsInitialized?: boolean;
private coreStart?: InternalCoreStart;
+ private readonly logger: LoggerFactory;
constructor(
rawConfigProvider: RawConfigurationProvider,
public readonly env: Env,
- private readonly logger: LoggerFactory
+ private readonly loggingSystem: ILoggingSystem
) {
+ this.logger = this.loggingSystem.asLoggerFactory();
this.log = this.logger.get('server');
- this.configService = new ConfigService(rawConfigProvider, env, logger);
+ this.configService = new ConfigService(rawConfigProvider, env, this.logger);
- const core = { coreId, configService: this.configService, env, logger };
+ const core = { coreId, configService: this.configService, env, logger: this.logger };
this.context = new ContextService(core);
this.http = new HttpService(core);
this.rendering = new RenderingService(core);
@@ -102,6 +105,7 @@ export class Server {
this.status = new StatusService(core);
this.coreApp = new CoreApp(core);
this.httpResources = new HttpResourcesService(core);
+ this.logging = new LoggingService(core);
}
public async setup() {
@@ -164,6 +168,10 @@ export class Server {
savedObjects: savedObjectsSetup,
});
+ const loggingSetup = this.logging.setup({
+ loggingSystem: this.loggingSystem,
+ });
+
const coreSetup: InternalCoreSetup = {
capabilities: capabilitiesSetup,
context: contextServiceSetup,
@@ -176,6 +184,7 @@ export class Server {
metrics: metricsSetup,
rendering: renderingSetup,
httpResources: httpResourcesSetup,
+ logging: loggingSetup,
};
const pluginsSetup = await this.plugins.setup(coreSetup);
@@ -244,6 +253,7 @@ export class Server {
await this.rendering.stop();
await this.metrics.stop();
await this.status.stop();
+ await this.logging.stop();
}
private registerCoreContext(coreSetup: InternalCoreSetup) {
diff --git a/src/core/server/ui_settings/create_or_upgrade_saved_config/create_or_upgrade_saved_config.test.ts b/src/core/server/ui_settings/create_or_upgrade_saved_config/create_or_upgrade_saved_config.test.ts
index 9c5a0625e8fd0..10a30db038174 100644
--- a/src/core/server/ui_settings/create_or_upgrade_saved_config/create_or_upgrade_saved_config.test.ts
+++ b/src/core/server/ui_settings/create_or_upgrade_saved_config/create_or_upgrade_saved_config.test.ts
@@ -21,7 +21,7 @@ import Chance from 'chance';
import { SavedObjectsErrorHelpers } from '../../saved_objects';
import { savedObjectsClientMock } from '../../saved_objects/service/saved_objects_client.mock';
-import { loggingServiceMock } from '../../logging/logging_service.mock';
+import { loggingSystemMock } from '../../logging/logging_system.mock';
import { getUpgradeableConfigMock } from './get_upgradeable_config.test.mock';
import { createOrUpgradeSavedConfig } from './create_or_upgrade_saved_config';
@@ -35,7 +35,7 @@ describe('uiSettings/createOrUpgradeSavedConfig', function () {
const buildNum = chance.integer({ min: 1000, max: 5000 });
function setup() {
- const logger = loggingServiceMock.create();
+ const logger = loggingSystemMock.create();
const getUpgradeableConfig = getUpgradeableConfigMock;
const savedObjectsClient = savedObjectsClientMock.create();
savedObjectsClient.create.mockImplementation(
@@ -137,7 +137,7 @@ describe('uiSettings/createOrUpgradeSavedConfig', function () {
});
await run();
- expect(loggingServiceMock.collect(logger).debug).toMatchInlineSnapshot(`
+ expect(loggingSystemMock.collect(logger).debug).toMatchInlineSnapshot(`
Array [
Array [
"Upgrade config from 4.0.0 to 4.0.1",
@@ -169,7 +169,7 @@ describe('uiSettings/createOrUpgradeSavedConfig', function () {
expect(error.message).toBe('foo');
}
- expect(loggingServiceMock.collect(logger).debug).toHaveLength(0);
+ expect(loggingSystemMock.collect(logger).debug).toHaveLength(0);
});
});
diff --git a/src/core/server/ui_settings/create_or_upgrade_saved_config/integration_tests/create_or_upgrade.test.ts b/src/core/server/ui_settings/create_or_upgrade_saved_config/integration_tests/create_or_upgrade.test.ts
index adf36e4491b79..d2e31dad58e55 100644
--- a/src/core/server/ui_settings/create_or_upgrade_saved_config/integration_tests/create_or_upgrade.test.ts
+++ b/src/core/server/ui_settings/create_or_upgrade_saved_config/integration_tests/create_or_upgrade.test.ts
@@ -26,10 +26,10 @@ import {
TestUtils,
} from '../../../../../test_utils/kbn_server';
import { createOrUpgradeSavedConfig } from '../create_or_upgrade_saved_config';
-import { loggingServiceMock } from '../../../logging/logging_service.mock';
+import { loggingSystemMock } from '../../../logging/logging_system.mock';
import { httpServerMock } from '../../../http/http_server.mocks';
-const logger = loggingServiceMock.create().get();
+const logger = loggingSystemMock.create().get();
describe('createOrUpgradeSavedConfig()', () => {
let savedObjectsClient: SavedObjectsClientContract;
let servers: TestUtils;
diff --git a/src/core/server/ui_settings/ui_settings_client.test.ts b/src/core/server/ui_settings/ui_settings_client.test.ts
index 4ce33eed267a3..a38fb2ab7e06c 100644
--- a/src/core/server/ui_settings/ui_settings_client.test.ts
+++ b/src/core/server/ui_settings/ui_settings_client.test.ts
@@ -20,7 +20,7 @@
import Chance from 'chance';
import { schema } from '@kbn/config-schema';
-import { loggingServiceMock } from '../logging/logging_service.mock';
+import { loggingSystemMock } from '../logging/logging_system.mock';
import { createOrUpgradeSavedConfigMock } from './create_or_upgrade_saved_config/create_or_upgrade_saved_config.test.mock';
import { SavedObjectsClient } from '../saved_objects';
@@ -28,7 +28,7 @@ import { savedObjectsClientMock } from '../saved_objects/service/saved_objects_c
import { UiSettingsClient } from './ui_settings_client';
import { CannotOverrideError } from './ui_settings_errors';
-const logger = loggingServiceMock.create().get();
+const logger = loggingSystemMock.create().get();
const TYPE = 'config';
const ID = 'kibana-version';
@@ -375,7 +375,7 @@ describe('ui settings', () => {
},
});
- expect(loggingServiceMock.collect(logger).warn).toMatchInlineSnapshot(`
+ expect(loggingSystemMock.collect(logger).warn).toMatchInlineSnapshot(`
Array [
Array [
"Ignore invalid UiSettings value. Error: [validation [id]]: expected value of type [number] but got [string].",
@@ -517,7 +517,7 @@ describe('ui settings', () => {
user: 'foo',
});
- expect(loggingServiceMock.collect(logger).warn).toMatchInlineSnapshot(`
+ expect(loggingSystemMock.collect(logger).warn).toMatchInlineSnapshot(`
Array [
Array [
"Ignore invalid UiSettings value. Error: [validation [id]]: expected value of type [number] but got [string].",
@@ -645,7 +645,7 @@ describe('ui settings', () => {
expect(await uiSettings.get('id')).toBe(42);
- expect(loggingServiceMock.collect(logger).warn).toMatchInlineSnapshot(`
+ expect(loggingSystemMock.collect(logger).warn).toMatchInlineSnapshot(`
Array [
Array [
"Ignore invalid UiSettings value. Error: [validation [id]]: expected value of type [number] but got [string].",
diff --git a/src/core/server/uuid/resolve_uuid.test.ts b/src/core/server/uuid/resolve_uuid.test.ts
index eab027b532ddb..1a873a1cea0cf 100644
--- a/src/core/server/uuid/resolve_uuid.test.ts
+++ b/src/core/server/uuid/resolve_uuid.test.ts
@@ -21,7 +21,7 @@ import { join } from 'path';
import { readFile, writeFile } from './fs';
import { resolveInstanceUuid, UUID_7_6_0_BUG } from './resolve_uuid';
import { configServiceMock } from '../config/config_service.mock';
-import { loggingServiceMock } from '../logging/logging_service.mock';
+import { loggingSystemMock } from '../logging/logging_system.mock';
import { BehaviorSubject } from 'rxjs';
import { Logger } from '../logging';
@@ -93,7 +93,7 @@ describe('resolveInstanceUuid', () => {
mockReadFile({ uuid: DEFAULT_FILE_UUID });
mockWriteFile();
configService = getConfigService(DEFAULT_CONFIG_UUID);
- logger = loggingServiceMock.create().get() as any;
+ logger = loggingSystemMock.create().get() as any;
});
describe('when file is present and config property is set', () => {
diff --git a/src/core/server/uuid/uuid_service.test.ts b/src/core/server/uuid/uuid_service.test.ts
index a61061ff84263..092216303080e 100644
--- a/src/core/server/uuid/uuid_service.test.ts
+++ b/src/core/server/uuid/uuid_service.test.ts
@@ -21,7 +21,7 @@ import { UuidService } from './uuid_service';
import { resolveInstanceUuid } from './resolve_uuid';
import { CoreContext } from '../core_context';
-import { loggingServiceMock } from '../logging/logging_service.mock';
+import { loggingSystemMock } from '../logging/logging_system.mock';
import { mockCoreContext } from '../core_context.mock';
import { Env } from '../config';
import { getEnvOptions } from '../config/__mocks__/env';
@@ -31,12 +31,12 @@ jest.mock('./resolve_uuid', () => ({
}));
describe('UuidService', () => {
- let logger: ReturnType;
+ let logger: ReturnType;
let coreContext: CoreContext;
beforeEach(() => {
jest.clearAllMocks();
- logger = loggingServiceMock.create();
+ logger = loggingSystemMock.create();
coreContext = mockCoreContext.create({ logger });
});
diff --git a/src/dev/typescript/projects.ts b/src/dev/typescript/projects.ts
index 1e0b631308d9e..065321e355256 100644
--- a/src/dev/typescript/projects.ts
+++ b/src/dev/typescript/projects.ts
@@ -34,6 +34,10 @@ export const PROJECTS = [
name: 'apm/cypress',
disableTypeCheck: true,
}),
+ new Project(resolve(REPO_ROOT, 'x-pack/plugins/apm/scripts/tsconfig.json'), {
+ name: 'apm/scripts',
+ disableTypeCheck: true,
+ }),
// NOTE: using glob.sync rather than glob-all or globby
// because it takes less than 10 ms, while the other modules
diff --git a/src/legacy/core_plugins/kibana/index.js b/src/legacy/core_plugins/kibana/index.js
index ae613e0e80904..9648ff29a95e7 100644
--- a/src/legacy/core_plugins/kibana/index.js
+++ b/src/legacy/core_plugins/kibana/index.js
@@ -21,13 +21,8 @@ import Fs from 'fs';
import { resolve } from 'path';
import { promisify } from 'util';
-import { importApi } from './server/routes/api/import';
-import { exportApi } from './server/routes/api/export';
import { getUiSettingDefaults } from './server/ui_setting_defaults';
import { registerCspCollector } from './server/lib/csp_usage_collector';
-import { injectVars } from './inject_vars';
-
-import { kbnBaseUrl } from '../../../plugins/kibana_legacy/server';
const mkdirAsync = promisify(Fs.mkdir);
@@ -45,35 +40,7 @@ export default function (kibana) {
},
uiExports: {
- app: {
- id: 'kibana',
- title: 'Kibana',
- listed: false,
- main: 'plugins/kibana/kibana',
- },
styleSheetPaths: resolve(__dirname, 'public/index.scss'),
- links: [],
-
- injectDefaultVars(server, options) {
- const mapConfig = server.config().get('map');
- const tilemap = mapConfig.tilemap;
-
- return {
- kbnIndex: options.index,
- kbnBaseUrl,
-
- // required on all pages due to hacks that use these values
- mapConfig,
- tilemapsConfig: {
- deprecated: {
- // If url is set, old settings must be used for backward compatibility
- isOverridden: typeof tilemap.url === 'string' && tilemap.url !== '',
- config: tilemap,
- },
- },
- };
- },
-
uiSettingDefaults: getUiSettingDefaults(),
},
@@ -91,11 +58,7 @@ export default function (kibana) {
init: async function (server) {
const { usageCollection } = server.newPlatform.setup.plugins;
- // routes
- importApi(server);
- exportApi(server);
registerCspCollector(usageCollection, server);
- server.injectUiAppVars('kibana', () => injectVars(server));
},
});
}
diff --git a/src/legacy/core_plugins/kibana/public/__tests__/vis_type_table/legacy.ts b/src/legacy/core_plugins/kibana/public/__tests__/vis_type_table/legacy.ts
index c6467a5beae68..216afe5920408 100644
--- a/src/legacy/core_plugins/kibana/public/__tests__/vis_type_table/legacy.ts
+++ b/src/legacy/core_plugins/kibana/public/__tests__/vis_type_table/legacy.ts
@@ -35,4 +35,5 @@ const pluginInstance = new TableVisPlugin({} as PluginInitializerContext);
export const setup = pluginInstance.setup(npSetup.core, plugins);
export const start = pluginInstance.start(npStart.core, {
data: npStart.plugins.data,
+ kibanaLegacy: npStart.plugins.kibanaLegacy,
});
diff --git a/src/legacy/core_plugins/kibana/public/index.scss b/src/legacy/core_plugins/kibana/public/index.scss
index 56a2543dbca78..e9810a747c8c7 100644
--- a/src/legacy/core_plugins/kibana/public/index.scss
+++ b/src/legacy/core_plugins/kibana/public/index.scss
@@ -7,12 +7,3 @@
// Public UI styles
@import 'src/legacy/ui/public/index';
-// Has to come after visualize because of some
-// bad cascading in the Editor layout
-@import '../../../../plugins/maps_legacy/public/index';
-
-// Management styles
-@import './management/index';
-
-// Local application mount wrapper styles
-@import 'local_application_service/index';
diff --git a/src/legacy/core_plugins/kibana/public/kibana.js b/src/legacy/core_plugins/kibana/public/kibana.js
deleted file mode 100644
index 51dedcc629c76..0000000000000
--- a/src/legacy/core_plugins/kibana/public/kibana.js
+++ /dev/null
@@ -1,59 +0,0 @@
-/*
- * 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.
- */
-
-// autoloading
-
-// preloading (for faster webpack builds)
-import routes from 'ui/routes';
-import { npSetup } from 'ui/new_platform';
-
-// import the uiExports that we want to "use"
-import 'uiExports/savedObjectTypes';
-import 'uiExports/fieldFormatEditors';
-import 'uiExports/navbarExtensions';
-import 'uiExports/contextMenuActions';
-import 'uiExports/managementSections';
-import 'uiExports/indexManagement';
-import 'uiExports/embeddableFactories';
-import 'uiExports/embeddableActions';
-import 'uiExports/inspectorViews';
-import 'uiExports/search';
-import 'uiExports/shareContextMenuExtensions';
-import 'uiExports/interpreter';
-
-import 'ui/autoload/all';
-
-import { localApplicationService } from './local_application_service';
-
-npSetup.plugins.kibanaLegacy.registerLegacyAppAlias('doc', 'discover', { keepPrefix: true });
-npSetup.plugins.kibanaLegacy.registerLegacyAppAlias('context', 'discover', { keepPrefix: true });
-
-npSetup.plugins.kibanaLegacy.forwardApp('management', 'management', (path) => {
- return path.replace('/management', '');
-});
-
-localApplicationService.attachToAngular(routes);
-
-routes.enable();
-
-const { config } = npSetup.plugins.kibanaLegacy;
-
-routes.otherwise({
- redirectTo: `/${config.defaultAppId || 'discover'}`,
-});
diff --git a/src/legacy/core_plugins/kibana/public/local_application_service/_index.scss b/src/legacy/core_plugins/kibana/public/local_application_service/_index.scss
deleted file mode 100644
index 12cc1444101e7..0000000000000
--- a/src/legacy/core_plugins/kibana/public/local_application_service/_index.scss
+++ /dev/null
@@ -1 +0,0 @@
-@import 'local_application_service';
diff --git a/src/legacy/core_plugins/kibana/public/local_application_service/_local_application_service.scss b/src/legacy/core_plugins/kibana/public/local_application_service/_local_application_service.scss
deleted file mode 100644
index 33a6100c43975..0000000000000
--- a/src/legacy/core_plugins/kibana/public/local_application_service/_local_application_service.scss
+++ /dev/null
@@ -1,5 +0,0 @@
-.kbnLocalApplicationWrapper {
- display: flex;
- flex-direction: column;
- flex-grow: 1;
-}
diff --git a/src/legacy/core_plugins/kibana/public/local_application_service/local_application_service.ts b/src/legacy/core_plugins/kibana/public/local_application_service/local_application_service.ts
deleted file mode 100644
index 59e5238578d25..0000000000000
--- a/src/legacy/core_plugins/kibana/public/local_application_service/local_application_service.ts
+++ /dev/null
@@ -1,134 +0,0 @@
-/*
- * 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 { App, AppUnmount, AppMountDeprecated } from 'kibana/public';
-import { UIRoutes } from 'ui/routes';
-import { ILocationService, IScope } from 'angular';
-import { npStart } from 'ui/new_platform';
-import { htmlIdGenerator } from '@elastic/eui';
-
-const matchAllWithPrefix = (prefixOrApp: string | App) =>
- `/${typeof prefixOrApp === 'string' ? prefixOrApp : prefixOrApp.id}/:tail*?`;
-
-/**
- * To be able to migrate and shim parts of the Kibana app plugin
- * while still running some parts of it in the legacy world, this
- * service emulates the core application service while using the global
- * angular router to switch between apps without page reload.
- *
- * The id of the apps is used as prefix of the route - when switching between
- * to apps, the current application is unmounted.
- *
- * This service becomes unnecessary once the platform provides a central
- * router that handles switching between applications without page reload.
- */
-export class LocalApplicationService {
- private idGenerator = htmlIdGenerator('kibanaAppLocalApp');
-
- /**
- * Wires up listeners to handle mounting and unmounting of apps to
- * the legacy angular route manager. Once all apps within the Kibana
- * plugin are using the local route manager, this implementation can
- * be switched to a more lightweight implementation.
- *
- * @param angularRouteManager The current `ui/routes` instance
- */
- attachToAngular(angularRouteManager: UIRoutes) {
- npStart.plugins.kibanaLegacy.getApps().forEach((app) => {
- const wrapperElementId = this.idGenerator();
- angularRouteManager.when(matchAllWithPrefix(app), {
- outerAngularWrapperRoute: true,
- reloadOnSearch: false,
- reloadOnUrl: false,
- template: ``,
- controller($scope: IScope) {
- const element = document.getElementById(wrapperElementId)!;
- let unmountHandler: AppUnmount | null = null;
- let isUnmounted = false;
- $scope.$on('$destroy', () => {
- if (unmountHandler) {
- unmountHandler();
- }
- isUnmounted = true;
- });
- (async () => {
- const params = {
- element,
- appBasePath: '',
- onAppLeave: () => undefined,
- // TODO: adapt to use Core's ScopedHistory
- history: {} as any,
- };
- unmountHandler = isAppMountDeprecated(app.mount)
- ? await app.mount({ core: npStart.core }, params)
- : await app.mount(params);
- // immediately unmount app if scope got destroyed in the meantime
- if (isUnmounted) {
- unmountHandler();
- }
- })();
- },
- });
-
- if (app.updater$) {
- app.updater$.subscribe((updater) => {
- const updatedFields = updater(app);
- if (updatedFields && updatedFields.activeUrl) {
- npStart.core.chrome.navLinks.update(app.navLinkId || app.id, {
- url: updatedFields.activeUrl,
- });
- }
- });
- }
- });
-
- npStart.plugins.kibanaLegacy.getForwards().forEach((forwardDefinition) => {
- angularRouteManager.when(matchAllWithPrefix(forwardDefinition.legacyAppId), {
- outerAngularWrapperRoute: true,
- reloadOnSearch: false,
- reloadOnUrl: false,
- template: '',
- controller($location: ILocationService) {
- const newPath = forwardDefinition.rewritePath($location.url());
- window.location.replace(
- npStart.core.http.basePath.prepend(`/app/${forwardDefinition.newAppId}${newPath}`)
- );
- },
- });
- });
-
- npStart.plugins.kibanaLegacy
- .getLegacyAppAliases()
- .forEach(({ legacyAppId, newAppId, keepPrefix }) => {
- angularRouteManager.when(matchAllWithPrefix(legacyAppId), {
- resolveRedirectTo: ($location: ILocationService) => {
- const url = $location.url();
- return `/${newAppId}${keepPrefix ? url : url.replace(legacyAppId, '')}`;
- },
- });
- });
- }
-}
-
-export const localApplicationService = new LocalApplicationService();
-
-function isAppMountDeprecated(mount: (...args: any[]) => any): mount is AppMountDeprecated {
- // Mount functions with two arguments are assumed to expect deprecated `context` object.
- return mount.length === 2;
-}
diff --git a/src/legacy/core_plugins/kibana/public/management/index.scss b/src/legacy/core_plugins/kibana/public/management/index.scss
deleted file mode 100644
index fb267b714f1c9..0000000000000
--- a/src/legacy/core_plugins/kibana/public/management/index.scss
+++ /dev/null
@@ -1,13 +0,0 @@
-// This file is imported into src/core_plugings/kibana/publix/index.scss
-
-// Prefix all styles with "dsh" to avoid conflicts.
-// Examples
-// mgtChart
-// mgtChart__legend
-// mgtChart__legend--small
-// mgtChart__legend-isLoading
-
-// Core
-@import '../../../../../plugins/advanced_settings/public/index';
-
-@import 'sections/index_patterns/index';
diff --git a/src/legacy/core_plugins/kibana/public/management/sections/index_patterns/index.scss b/src/legacy/core_plugins/kibana/public/management/sections/index_patterns/index.scss
deleted file mode 100644
index c5cf844ebdc34..0000000000000
--- a/src/legacy/core_plugins/kibana/public/management/sections/index_patterns/index.scss
+++ /dev/null
@@ -1,25 +0,0 @@
-#indexPatternListReact {
- display: flex;
-
- .indexPatternList__headerWrapper {
- padding-bottom: $euiSizeS;
- }
-
- .euiButtonEmpty__content {
- justify-content: left;
- padding: 0;
-
- span {
- text-overflow: ellipsis;
- overflow: hidden;
- }
- }
-
- .indexPatternListPrompt__descList {
- text-align: left;
- }
-}
-
-.indexPatternList__badge {
- margin-left: $euiSizeS;
-}
diff --git a/src/legacy/core_plugins/kibana/server/lib/__tests__/relationships.js b/src/legacy/core_plugins/kibana/server/lib/__tests__/relationships.js
deleted file mode 100644
index 4df0e7a140205..0000000000000
--- a/src/legacy/core_plugins/kibana/server/lib/__tests__/relationships.js
+++ /dev/null
@@ -1,645 +0,0 @@
-/*
- * 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 expect from '@kbn/expect';
-import { findRelationships } from '../management/saved_objects/relationships';
-
-function getManagementaMock(savedObjectSchemas) {
- return {
- isImportAndExportable(type) {
- return (
- !savedObjectSchemas[type] || savedObjectSchemas[type].isImportableAndExportable !== false
- );
- },
- getDefaultSearchField(type) {
- return savedObjectSchemas[type] && savedObjectSchemas[type].defaultSearchField;
- },
- getIcon(type) {
- return savedObjectSchemas[type] && savedObjectSchemas[type].icon;
- },
- getTitle(savedObject) {
- const { type } = savedObject;
- const getTitle = savedObjectSchemas[type] && savedObjectSchemas[type].getTitle;
- if (getTitle) {
- return getTitle(savedObject);
- }
- },
- getEditUrl(savedObject) {
- const { type } = savedObject;
- const getEditUrl = savedObjectSchemas[type] && savedObjectSchemas[type].getEditUrl;
- if (getEditUrl) {
- return getEditUrl(savedObject);
- }
- },
- getInAppUrl(savedObject) {
- const { type } = savedObject;
- const getInAppUrl = savedObjectSchemas[type] && savedObjectSchemas[type].getInAppUrl;
- if (getInAppUrl) {
- return getInAppUrl(savedObject);
- }
- },
- };
-}
-
-const savedObjectsManagement = getManagementaMock({
- 'index-pattern': {
- icon: 'indexPatternApp',
- defaultSearchField: 'title',
- getTitle(obj) {
- return obj.attributes.title;
- },
- getEditUrl(obj) {
- return `/management/kibana/indexPatterns/patterns/${encodeURIComponent(obj.id)}`;
- },
- getInAppUrl(obj) {
- return {
- path: `/app/management/kibana/indexPatterns/patterns/${encodeURIComponent(obj.id)}`,
- uiCapabilitiesPath: 'management.kibana.index_patterns',
- };
- },
- },
- visualization: {
- icon: 'visualizeApp',
- defaultSearchField: 'title',
- getTitle(obj) {
- return obj.attributes.title;
- },
- getEditUrl(obj) {
- return `/management/kibana/objects/savedVisualizations/${encodeURIComponent(obj.id)}`;
- },
- getInAppUrl(obj) {
- return {
- path: `/app/visualize#/edit/${encodeURIComponent(obj.id)}`,
- uiCapabilitiesPath: 'visualize.show',
- };
- },
- },
- search: {
- icon: 'search',
- defaultSearchField: 'title',
- getTitle(obj) {
- return obj.attributes.title;
- },
- getEditUrl(obj) {
- return `/management/kibana/objects/savedSearches/${encodeURIComponent(obj.id)}`;
- },
- getInAppUrl(obj) {
- return {
- path: `/app/discover#//${encodeURIComponent(obj.id)}`,
- uiCapabilitiesPath: 'discover.show',
- };
- },
- },
- dashboard: {
- icon: 'dashboardApp',
- defaultSearchField: 'title',
- getTitle(obj) {
- return obj.attributes.title;
- },
- getEditUrl(obj) {
- return `/management/kibana/objects/savedDashboards/${encodeURIComponent(obj.id)}`;
- },
- getInAppUrl(obj) {
- return {
- path: `/app/kibana#/dashboard/${encodeURIComponent(obj.id)}`,
- uiCapabilitiesPath: 'dashboard.show',
- };
- },
- },
-});
-
-describe('findRelationships', () => {
- it('should find relationships for dashboards', async () => {
- const type = 'dashboard';
- const id = 'foo';
- const size = 10;
-
- const savedObjectsClient = {
- get: () => ({
- attributes: {
- panelsJSON: JSON.stringify([
- { panelRefName: 'panel_0' },
- { panelRefName: 'panel_1' },
- { panelRefName: 'panel_2' },
- ]),
- },
- references: [
- {
- name: 'panel_0',
- type: 'visualization',
- id: '1',
- },
- {
- name: 'panel_1',
- type: 'visualization',
- id: '2',
- },
- {
- name: 'panel_2',
- type: 'visualization',
- id: '3',
- },
- ],
- }),
- bulkGet: () => ({ saved_objects: [] }),
- find: () => ({
- saved_objects: [
- {
- id: '1',
- type: 'visualization',
- attributes: {
- title: 'Foo',
- },
- },
- {
- id: '2',
- type: 'visualization',
- attributes: {
- title: 'Bar',
- },
- },
- {
- id: '3',
- type: 'visualization',
- attributes: {
- title: 'FooBar',
- },
- },
- ],
- }),
- };
- const result = await findRelationships(type, id, {
- size,
- savedObjectsClient,
- savedObjectsManagement,
- savedObjectTypes: ['dashboard', 'visualization', 'search', 'index-pattern'],
- });
- expect(result).to.eql([
- {
- id: '1',
- type: 'visualization',
- relationship: 'parent',
- meta: {
- icon: 'visualizeApp',
- title: 'Foo',
- editUrl: '/management/kibana/objects/savedVisualizations/1',
- inAppUrl: {
- path: '/app/visualize#/edit/1',
- uiCapabilitiesPath: 'visualize.show',
- },
- },
- },
- {
- id: '2',
- type: 'visualization',
- relationship: 'parent',
- meta: {
- icon: 'visualizeApp',
- title: 'Bar',
- editUrl: '/management/kibana/objects/savedVisualizations/2',
- inAppUrl: {
- path: '/app/visualize#/edit/2',
- uiCapabilitiesPath: 'visualize.show',
- },
- },
- },
- {
- id: '3',
- type: 'visualization',
- relationship: 'parent',
- meta: {
- icon: 'visualizeApp',
- title: 'FooBar',
- editUrl: '/management/kibana/objects/savedVisualizations/3',
- inAppUrl: {
- path: '/app/visualize#/edit/3',
- uiCapabilitiesPath: 'visualize.show',
- },
- },
- },
- ]);
- });
-
- it('should find relationships for visualizations', async () => {
- const type = 'visualization';
- const id = 'foo';
- const size = 10;
-
- const savedObjectsClient = {
- get: () => ({
- attributes: {
- kibanaSavedObjectMeta: {
- searchSourceJSON: JSON.stringify({
- indexRefName: 'kibanaSavedObjectMeta.searchSourceJSON.index',
- }),
- },
- },
- references: [
- {
- name: 'kibanaSavedObjectMeta.searchSourceJSON.index',
- type: 'index-pattern',
- id: '1',
- },
- ],
- }),
- bulkGet: () => ({
- saved_objects: [
- {
- id: '1',
- type: 'index-pattern',
- attributes: {
- title: 'My Index Pattern',
- },
- },
- ],
- }),
- find: () => ({
- saved_objects: [
- {
- id: '1',
- type: 'dashboard',
- attributes: {
- title: 'My Dashboard',
- panelsJSON: JSON.stringify([
- {
- type: 'visualization',
- id,
- },
- {
- type: 'visualization',
- id: 'foobar',
- },
- ]),
- },
- },
- {
- id: '2',
- type: 'dashboard',
- attributes: {
- title: 'Your Dashboard',
- panelsJSON: JSON.stringify([
- {
- type: 'visualization',
- id,
- },
- {
- type: 'visualization',
- id: 'foobar',
- },
- ]),
- },
- },
- ],
- }),
- };
-
- const result = await findRelationships(type, id, {
- size,
- savedObjectsClient,
- savedObjectsManagement,
- savedObjectTypes: ['dashboard', 'visualization', 'search', 'index-pattern'],
- });
- expect(result).to.eql([
- {
- id: '1',
- type: 'index-pattern',
- relationship: 'child',
- meta: {
- icon: 'indexPatternApp',
- title: 'My Index Pattern',
- editUrl: '/management/kibana/indexPatterns/patterns/1',
- inAppUrl: {
- path: '/app/management/kibana/indexPatterns/patterns/1',
- uiCapabilitiesPath: 'management.kibana.index_patterns',
- },
- },
- },
- {
- id: '1',
- type: 'dashboard',
- relationship: 'parent',
- meta: {
- icon: 'dashboardApp',
- title: 'My Dashboard',
- editUrl: '/management/kibana/objects/savedDashboards/1',
- inAppUrl: {
- path: '/app/kibana#/dashboard/1',
- uiCapabilitiesPath: 'dashboard.show',
- },
- },
- },
- {
- id: '2',
- type: 'dashboard',
- relationship: 'parent',
- meta: {
- icon: 'dashboardApp',
- title: 'Your Dashboard',
- editUrl: '/management/kibana/objects/savedDashboards/2',
- inAppUrl: {
- path: '/app/kibana#/dashboard/2',
- uiCapabilitiesPath: 'dashboard.show',
- },
- },
- },
- ]);
- });
-
- it('should find relationships for saved searches', async () => {
- const type = 'search';
- const id = 'foo';
- const size = 10;
-
- const savedObjectsClient = {
- get: () => ({
- id: '1',
- type: 'search',
- attributes: {
- kibanaSavedObjectMeta: {
- searchSourceJSON: JSON.stringify({
- indexRefName: 'kibanaSavedObjectMeta.searchSourceJSON.index',
- }),
- },
- },
- references: [
- {
- name: 'kibanaSavedObjectMeta.searchSourceJSON.index',
- type: 'index-pattern',
- id: '1',
- },
- ],
- }),
- bulkGet: () => ({
- saved_objects: [
- {
- id: '1',
- type: 'index-pattern',
- attributes: {
- title: 'My Index Pattern',
- },
- },
- ],
- }),
- find: () => ({
- saved_objects: [
- {
- id: '1',
- type: 'visualization',
- attributes: {
- title: 'Foo',
- },
- },
- {
- id: '2',
- type: 'visualization',
- attributes: {
- title: 'Bar',
- },
- },
- {
- id: '3',
- type: 'visualization',
- attributes: {
- title: 'FooBar',
- },
- },
- ],
- }),
- };
-
- const result = await findRelationships(type, id, {
- size,
- savedObjectsClient,
- savedObjectsManagement,
- savedObjectTypes: ['dashboard', 'visualization', 'search', 'index-pattern'],
- });
- expect(result).to.eql([
- {
- id: '1',
- type: 'index-pattern',
- relationship: 'child',
- meta: {
- icon: 'indexPatternApp',
- title: 'My Index Pattern',
- editUrl: '/management/kibana/indexPatterns/patterns/1',
- inAppUrl: {
- path: '/app/management/kibana/indexPatterns/patterns/1',
- uiCapabilitiesPath: 'management.kibana.index_patterns',
- },
- },
- },
- {
- id: '1',
- type: 'visualization',
- relationship: 'parent',
- meta: {
- icon: 'visualizeApp',
- title: 'Foo',
- editUrl: '/management/kibana/objects/savedVisualizations/1',
- inAppUrl: {
- path: '/app/visualize#/edit/1',
- uiCapabilitiesPath: 'visualize.show',
- },
- },
- },
- {
- id: '2',
- type: 'visualization',
- relationship: 'parent',
- meta: {
- icon: 'visualizeApp',
- title: 'Bar',
- editUrl: '/management/kibana/objects/savedVisualizations/2',
- inAppUrl: {
- path: '/app/visualize#/edit/2',
- uiCapabilitiesPath: 'visualize.show',
- },
- },
- },
- {
- id: '3',
- type: 'visualization',
- relationship: 'parent',
- meta: {
- icon: 'visualizeApp',
- title: 'FooBar',
- editUrl: '/management/kibana/objects/savedVisualizations/3',
- inAppUrl: {
- path: '/app/visualize#/edit/3',
- uiCapabilitiesPath: 'visualize.show',
- },
- },
- },
- ]);
- });
-
- it('should find relationships for index patterns', async () => {
- const type = 'index-pattern';
- const id = 'foo';
- const size = 10;
-
- const savedObjectsClient = {
- get: () => ({
- id: '1',
- type: 'index-pattern',
- attributes: {
- title: 'My Index Pattern',
- },
- }),
- find: () => ({
- saved_objects: [
- {
- id: '1',
- type: 'visualization',
- attributes: {
- title: 'Foo',
- kibanaSavedObjectMeta: {
- searchSourceJSON: JSON.stringify({
- index: 'foo',
- }),
- },
- },
- },
- {
- id: '2',
- type: 'visualization',
- attributes: {
- title: 'Bar',
- kibanaSavedObjectMeta: {
- searchSourceJSON: JSON.stringify({
- index: 'foo',
- }),
- },
- },
- },
- {
- id: '3',
- type: 'visualization',
- attributes: {
- title: 'FooBar',
- kibanaSavedObjectMeta: {
- searchSourceJSON: JSON.stringify({
- index: 'foo2',
- }),
- },
- },
- },
- {
- id: '1',
- type: 'search',
- attributes: {
- title: 'My Saved Search',
- },
- },
- ],
- }),
- };
-
- const result = await findRelationships(type, id, {
- size,
- savedObjectsClient,
- savedObjectsManagement,
- savedObjectTypes: ['dashboard', 'visualization', 'search', 'index-pattern'],
- });
- expect(result).to.eql([
- {
- id: '1',
- type: 'visualization',
- relationship: 'parent',
- meta: {
- icon: 'visualizeApp',
- title: 'Foo',
- editUrl: '/management/kibana/objects/savedVisualizations/1',
- inAppUrl: {
- path: '/app/visualize#/edit/1',
- uiCapabilitiesPath: 'visualize.show',
- },
- },
- },
- {
- id: '2',
- type: 'visualization',
- relationship: 'parent',
- meta: {
- icon: 'visualizeApp',
- title: 'Bar',
- editUrl: '/management/kibana/objects/savedVisualizations/2',
- inAppUrl: {
- path: '/app/visualize#/edit/2',
- uiCapabilitiesPath: 'visualize.show',
- },
- },
- },
- {
- id: '3',
- type: 'visualization',
- relationship: 'parent',
- meta: {
- icon: 'visualizeApp',
- title: 'FooBar',
- editUrl: '/management/kibana/objects/savedVisualizations/3',
- inAppUrl: {
- path: '/app/visualize#/edit/3',
- uiCapabilitiesPath: 'visualize.show',
- },
- },
- },
- {
- id: '1',
- type: 'search',
- relationship: 'parent',
- meta: {
- icon: 'search',
- title: 'My Saved Search',
- editUrl: '/management/kibana/objects/savedSearches/1',
- inAppUrl: {
- path: '/app/discover#//1',
- uiCapabilitiesPath: 'discover.show',
- },
- },
- },
- ]);
- });
-
- it('should return an empty object for non related objects', async () => {
- const type = 'invalid';
- const id = 'foo';
- const size = 10;
-
- const savedObjectsClient = {
- get: () => ({
- id: '1',
- type: 'index-pattern',
- attributes: {
- title: 'My Index Pattern',
- },
- references: [],
- }),
- find: () => ({ saved_objects: [] }),
- };
-
- const result = await findRelationships(type, id, {
- size,
- savedObjectsClient,
- savedObjectsManagement,
- savedObjectTypes: ['dashboard', 'visualization', 'search', 'index-pattern'],
- });
- expect(result).to.eql({});
- });
-});
diff --git a/src/legacy/core_plugins/kibana/server/lib/import/import_dashboards.test.js b/src/legacy/core_plugins/kibana/server/lib/import/import_dashboards.test.js
deleted file mode 100644
index 13e04e1e9e16e..0000000000000
--- a/src/legacy/core_plugins/kibana/server/lib/import/import_dashboards.test.js
+++ /dev/null
@@ -1,87 +0,0 @@
-/*
- * 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 { importDashboards } from './import_dashboards';
-import sinon from 'sinon';
-
-describe('importDashboards(req)', () => {
- let req;
- let bulkCreateStub;
- beforeEach(() => {
- bulkCreateStub = sinon.stub().returns(Promise.resolve({ saved_objects: [] }));
- req = {
- query: {},
- payload: {
- version: '6.0.0',
- objects: [
- { id: 'dashboard-01', type: 'dashboard', attributes: { panelJSON: '{}' } },
- { id: 'panel-01', type: 'visualization', attributes: { visState: '{}' } },
- ],
- },
- getSavedObjectsClient() {
- return {
- bulkCreate: bulkCreateStub,
- };
- },
- };
- });
-
- test('should call bulkCreate with each asset', () => {
- return importDashboards(req).then(() => {
- expect(bulkCreateStub.calledOnce).toEqual(true);
- expect(bulkCreateStub.args[0][0]).toEqual([
- {
- id: 'dashboard-01',
- type: 'dashboard',
- attributes: { panelJSON: '{}' },
- migrationVersion: {},
- },
- {
- id: 'panel-01',
- type: 'visualization',
- attributes: { visState: '{}' },
- migrationVersion: {},
- },
- ]);
- });
- });
-
- test('should call bulkCreate with overwrite true if force is truthy', () => {
- req.query = { force: 'true' };
- return importDashboards(req).then(() => {
- expect(bulkCreateStub.calledOnce).toEqual(true);
- expect(bulkCreateStub.args[0][1]).toEqual({ overwrite: true });
- });
- });
-
- test('should exclude types based on exclude argument', () => {
- req.query = { exclude: 'visualization' };
- return importDashboards(req).then(() => {
- expect(bulkCreateStub.calledOnce).toEqual(true);
- expect(bulkCreateStub.args[0][0]).toEqual([
- {
- id: 'dashboard-01',
- type: 'dashboard',
- attributes: { panelJSON: '{}' },
- migrationVersion: {},
- },
- ]);
- });
- });
-});
diff --git a/src/legacy/core_plugins/kibana/server/lib/management/saved_objects/inject_meta_attributes.test.js b/src/legacy/core_plugins/kibana/server/lib/management/saved_objects/inject_meta_attributes.test.js
deleted file mode 100644
index b98160346011a..0000000000000
--- a/src/legacy/core_plugins/kibana/server/lib/management/saved_objects/inject_meta_attributes.test.js
+++ /dev/null
@@ -1,148 +0,0 @@
-/*
- * 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 { injectMetaAttributes } from './inject_meta_attributes';
-
-function getManagementMock(savedObjectSchemas) {
- return {
- isImportAndExportable(type) {
- return (
- !savedObjectSchemas[type] || savedObjectSchemas[type].isImportableAndExportable !== false
- );
- },
- getDefaultSearchField(type) {
- return savedObjectSchemas[type] && savedObjectSchemas[type].defaultSearchField;
- },
- getIcon(type) {
- return savedObjectSchemas[type] && savedObjectSchemas[type].icon;
- },
- getTitle(savedObject) {
- const { type } = savedObject;
- const getTitle = savedObjectSchemas[type] && savedObjectSchemas[type].getTitle;
- if (getTitle) {
- return getTitle(savedObject);
- }
- },
- getEditUrl(savedObject) {
- const { type } = savedObject;
- const getEditUrl = savedObjectSchemas[type] && savedObjectSchemas[type].getEditUrl;
- if (getEditUrl) {
- return getEditUrl(savedObject);
- }
- },
- getInAppUrl(savedObject) {
- const { type } = savedObject;
- const getInAppUrl = savedObjectSchemas[type] && savedObjectSchemas[type].getInAppUrl;
- if (getInAppUrl) {
- return getInAppUrl(savedObject);
- }
- },
- };
-}
-
-test('works when no schema is defined for the type', () => {
- const savedObject = { type: 'a' };
- const savedObjectsManagement = getManagementMock({});
- const result = injectMetaAttributes(savedObject, savedObjectsManagement);
- expect(result).toEqual({ type: 'a', meta: {} });
-});
-
-test('inject icon into meta attribute', () => {
- const savedObject = {
- type: 'a',
- };
- const savedObjectsManagement = getManagementMock({
- a: {
- icon: 'my-icon',
- },
- });
- const result = injectMetaAttributes(savedObject, savedObjectsManagement);
- expect(result).toEqual({
- type: 'a',
- meta: {
- icon: 'my-icon',
- },
- });
-});
-
-test('injects title into meta attribute', () => {
- const savedObject = {
- type: 'a',
- };
- const savedObjectsManagement = getManagementMock({
- a: {
- getTitle() {
- return 'my-title';
- },
- },
- });
- const result = injectMetaAttributes(savedObject, savedObjectsManagement);
- expect(result).toEqual({
- type: 'a',
- meta: {
- title: 'my-title',
- },
- });
-});
-
-test('injects editUrl into meta attribute', () => {
- const savedObject = {
- type: 'a',
- };
- const savedObjectsManagement = getManagementMock({
- a: {
- getEditUrl() {
- return 'my-edit-url';
- },
- },
- });
- const result = injectMetaAttributes(savedObject, savedObjectsManagement);
- expect(result).toEqual({
- type: 'a',
- meta: {
- editUrl: 'my-edit-url',
- },
- });
-});
-
-test('injects inAppUrl meta attribute', () => {
- const savedObject = {
- type: 'a',
- };
- const savedObjectsManagement = getManagementMock({
- a: {
- getInAppUrl() {
- return {
- path: 'my-in-app-url',
- uiCapabilitiesPath: 'ui.path',
- };
- },
- },
- });
- const result = injectMetaAttributes(savedObject, savedObjectsManagement);
- expect(result).toEqual({
- type: 'a',
- meta: {
- inAppUrl: {
- path: 'my-in-app-url',
- uiCapabilitiesPath: 'ui.path',
- },
- },
- });
-});
diff --git a/src/legacy/core_plugins/kibana/server/lib/management/saved_objects/relationships.js b/src/legacy/core_plugins/kibana/server/lib/management/saved_objects/relationships.js
deleted file mode 100644
index e0a6c574b7ad8..0000000000000
--- a/src/legacy/core_plugins/kibana/server/lib/management/saved_objects/relationships.js
+++ /dev/null
@@ -1,64 +0,0 @@
-/*
- * 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 { pick } from 'lodash';
-import { injectMetaAttributes } from './inject_meta_attributes';
-
-export async function findRelationships(type, id, options = {}) {
- const { size, savedObjectsClient, savedObjectTypes, savedObjectsManagement } = options;
-
- const { references = [] } = await savedObjectsClient.get(type, id);
-
- // Use a map to avoid duplicates, it does happen but have a different "name" in the reference
- const referencedToBulkGetOpts = new Map(
- references.map(({ type, id }) => [`${type}:${id}`, { id, type }])
- );
-
- const [referencedObjects, referencedResponse] = await Promise.all([
- referencedToBulkGetOpts.size > 0
- ? savedObjectsClient.bulkGet([...referencedToBulkGetOpts.values()])
- : Promise.resolve({ saved_objects: [] }),
- savedObjectsClient.find({
- hasReference: { type, id },
- perPage: size,
- type: savedObjectTypes,
- }),
- ]);
-
- return [].concat(
- referencedObjects.saved_objects
- .map((obj) => injectMetaAttributes(obj, savedObjectsManagement))
- .map(extractCommonProperties)
- .map((obj) => ({
- ...obj,
- relationship: 'child',
- })),
- referencedResponse.saved_objects
- .map((obj) => injectMetaAttributes(obj, savedObjectsManagement))
- .map(extractCommonProperties)
- .map((obj) => ({
- ...obj,
- relationship: 'parent',
- }))
- );
-}
-
-function extractCommonProperties(savedObject) {
- return pick(savedObject, ['id', 'type', 'meta']);
-}
diff --git a/src/legacy/core_plugins/kibana/server/routes/api/export/index.js b/src/legacy/core_plugins/kibana/server/routes/api/export/index.js
deleted file mode 100644
index ef556ed53f4fc..0000000000000
--- a/src/legacy/core_plugins/kibana/server/routes/api/export/index.js
+++ /dev/null
@@ -1,52 +0,0 @@
-/*
- * 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 Joi from 'joi';
-import moment from 'moment';
-
-import { exportDashboards } from '../../../lib/export/export_dashboards';
-
-export function exportApi(server) {
- server.route({
- path: '/api/kibana/dashboards/export',
- config: {
- validate: {
- query: Joi.object().keys({
- dashboard: Joi.alternatives()
- .try(Joi.string(), Joi.array().items(Joi.string()))
- .required(),
- }),
- },
- tags: ['api'],
- },
- method: ['GET'],
- handler: async (req, h) => {
- const currentDate = moment.utc();
- return exportDashboards(req).then((resp) => {
- const json = JSON.stringify(resp, null, ' ');
- const filename = `kibana-dashboards.${currentDate.format('YYYY-MM-DD-HH-mm-ss')}.json`;
- return h
- .response(json)
- .header('Content-Disposition', `attachment; filename="${filename}"`)
- .header('Content-Type', 'application/json')
- .header('Content-Length', Buffer.byteLength(json, 'utf8'));
- });
- },
- });
-}
diff --git a/src/legacy/core_plugins/timelion/public/legacy.ts b/src/legacy/core_plugins/timelion/public/legacy.ts
index acb95e80fe18c..7980291e2d462 100644
--- a/src/legacy/core_plugins/timelion/public/legacy.ts
+++ b/src/legacy/core_plugins/timelion/public/legacy.ts
@@ -18,7 +18,7 @@
*/
import { PluginInitializerContext } from 'kibana/public';
-import { npSetup } from 'ui/new_platform';
+import { npSetup, npStart } from 'ui/new_platform';
import { plugin } from '.';
import { TimelionPluginSetupDependencies } from './plugin';
import { LegacyDependenciesPlugin } from './shim';
@@ -32,4 +32,4 @@ const setupPlugins: Readonly = {
const pluginInstance = plugin({} as PluginInitializerContext);
export const setup = pluginInstance.setup(npSetup.core, setupPlugins);
-export const start = pluginInstance.start();
+export const start = pluginInstance.start(npStart.core, npStart.plugins);
diff --git a/src/legacy/core_plugins/timelion/public/plugin.ts b/src/legacy/core_plugins/timelion/public/plugin.ts
index 8b021cda4bfb0..1f837303a2b3d 100644
--- a/src/legacy/core_plugins/timelion/public/plugin.ts
+++ b/src/legacy/core_plugins/timelion/public/plugin.ts
@@ -16,10 +16,17 @@
* specific language governing permissions and limitations
* under the License.
*/
-import { CoreSetup, Plugin, PluginInitializerContext, IUiSettingsClient } from 'kibana/public';
+import {
+ CoreSetup,
+ Plugin,
+ PluginInitializerContext,
+ IUiSettingsClient,
+ CoreStart,
+} from 'kibana/public';
import { getTimeChart } from './panels/timechart/timechart';
import { Panel } from './panels/panel';
import { LegacyDependenciesPlugin, LegacyDependenciesPluginSetup } from './shim';
+import { KibanaLegacyStart } from '../../../../plugins/kibana_legacy/public';
/** @internal */
export interface TimelionVisualizationDependencies extends LegacyDependenciesPluginSetup {
@@ -59,7 +66,9 @@ export class TimelionPlugin implements Plugin, void> {
dependencies.timelionPanels.set(timeChartPanel.name, timeChartPanel);
}
- public start() {}
+ public start(core: CoreStart, { kibanaLegacy }: { kibanaLegacy: KibanaLegacyStart }) {
+ kibanaLegacy.loadFontAwesome();
+ }
public stop(): void {}
}
diff --git a/src/legacy/ui/public/autoload/all.js b/src/legacy/ui/public/autoload/all.js
index 5c95afb7a0628..be9b29aa944c9 100644
--- a/src/legacy/ui/public/autoload/all.js
+++ b/src/legacy/ui/public/autoload/all.js
@@ -20,4 +20,3 @@
import './accessibility';
import './modules';
import './settings';
-import './styles';
diff --git a/src/legacy/ui/public/directives/__tests__/input_focus.js b/src/legacy/ui/public/directives/__tests__/input_focus.js
index 45b1821cbfd21..a9cd9b3c87974 100644
--- a/src/legacy/ui/public/directives/__tests__/input_focus.js
+++ b/src/legacy/ui/public/directives/__tests__/input_focus.js
@@ -21,6 +21,7 @@ import expect from '@kbn/expect';
import ngMock from 'ng_mock';
import $ from 'jquery';
import '../input_focus';
+import uiRoutes from 'ui/routes';
describe('Input focus directive', function () {
let $compile;
@@ -32,6 +33,8 @@ describe('Input focus directive', function () {
let selectedText;
const inputValue = 'Input Text Value';
+ uiRoutes.enable();
+
beforeEach(ngMock.module('kibana'));
beforeEach(
ngMock.inject(function (_$compile_, _$rootScope_, _$timeout_) {
diff --git a/src/legacy/ui/public/new_platform/new_platform.karma_mock.js b/src/legacy/ui/public/new_platform/new_platform.karma_mock.js
index d98770842a0f0..35380ada51a0a 100644
--- a/src/legacy/ui/public/new_platform/new_platform.karma_mock.js
+++ b/src/legacy/ui/public/new_platform/new_platform.karma_mock.js
@@ -263,7 +263,6 @@ export const npSetup = {
},
kibanaLegacy: {
registerLegacyApp: () => {},
- registerLegacyAppAlias: () => {},
forwardApp: () => {},
config: {
defaultAppId: 'home',
@@ -379,9 +378,8 @@ export const npStart = {
registerType: sinon.fake(),
},
kibanaLegacy: {
- getApps: () => [],
getForwards: () => [],
- getLegacyAppAliases: () => [],
+ loadFontAwesome: () => {},
config: {
defaultAppId: 'home',
},
diff --git a/src/legacy/ui/public/styles/font_awesome.less b/src/legacy/ui/public/styles/font_awesome.less
deleted file mode 100644
index 428e3c6b83f89..0000000000000
--- a/src/legacy/ui/public/styles/font_awesome.less
+++ /dev/null
@@ -1,10 +0,0 @@
-// Needs to remain a LESS file to point to the correct path for the fonts themeselves
-@import "~font-awesome/less/font-awesome";
-
-// new file icon
-.@{fa-css-prefix}-file-new-o:before { content: @fa-var-file-o; }
-.@{fa-css-prefix}-file-new-o:after { content: @fa-var-plus; position: relative; margin-left: -1.0em; font-size: 0.5em; }
-
-// alias for alert types - allows class="fa fa-{{alertType}}"
-.fa-success:before { content: @fa-var-check; }
-.fa-danger:before { content: @fa-var-exclamation-circle; }
diff --git a/src/legacy/ui/public/visualize/loader/pipeline_helpers/utilities.ts b/src/legacy/ui/public/visualize/loader/pipeline_helpers/utilities.ts
deleted file mode 100644
index cb25c66dfd2fe..0000000000000
--- a/src/legacy/ui/public/visualize/loader/pipeline_helpers/utilities.ts
+++ /dev/null
@@ -1,31 +0,0 @@
-/*
- * 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 { npStart } from 'ui/new_platform';
-import { fieldFormats, IFieldFormat } from '../../../../../../plugins/data/public';
-import { SerializedFieldFormat } from '../../../../../../plugins/expressions/common/types';
-
-type FormatFactory = (mapping?: SerializedFieldFormat) => IFieldFormat;
-
-const createFormat = fieldFormats.serialize;
-const getFormat: FormatFactory = (mapping?) => {
- return npStart.plugins.data.fieldFormats.deserialize(mapping as any);
-};
-
-export { getFormat, createFormat, FormatFactory };
diff --git a/src/legacy/ui/ui_render/ui_render_mixin.js b/src/legacy/ui/ui_render/ui_render_mixin.js
index b4f8255297240..0cfcb91aa94ef 100644
--- a/src/legacy/ui/ui_render/ui_render_mixin.js
+++ b/src/legacy/ui/ui_render/ui_render_mixin.js
@@ -130,7 +130,6 @@ export function uiRenderMixin(kbnServer, server, config) {
`${basePath}/node_modules/@kbn/ui-framework/dist/kui_light.css`,
`${regularBundlePath}/light_theme.style.css`,
]),
- `${regularBundlePath}/commons.style.css`,
...(isCore
? []
: [
@@ -155,13 +154,7 @@ export function uiRenderMixin(kbnServer, server, config) {
(filename) => `${regularBundlePath}/kbn-ui-shared-deps/${filename}`
),
`${regularBundlePath}/kbn-ui-shared-deps/${UiSharedDeps.jsFilename}`,
- ...(isCore
- ? []
- : [
- `${dllBundlePath}/vendors_runtime.bundle.dll.js`,
- ...dllJsChunks,
- `${regularBundlePath}/commons.bundle.js`,
- ]),
+ ...(isCore ? [] : [`${dllBundlePath}/vendors_runtime.bundle.dll.js`, ...dllJsChunks]),
`${regularBundlePath}/core/core.entry.js`,
...kpPluginIds.map(
diff --git a/src/optimize/base_optimizer.js b/src/optimize/base_optimizer.js
index 12131b89e03c1..55752db55e28a 100644
--- a/src/optimize/base_optimizer.js
+++ b/src/optimize/base_optimizer.js
@@ -266,13 +266,6 @@ export default class BaseOptimizer {
optimization: {
splitChunks: {
cacheGroups: {
- commons: {
- name: 'commons',
- chunks: (chunk) =>
- chunk.canBeInitial() && chunk.name !== 'light_theme' && chunk.name !== 'dark_theme',
- minChunks: 2,
- reuseExistingChunk: true,
- },
light_theme: {
name: 'light_theme',
test: (m) =>
diff --git a/src/plugins/advanced_settings/public/management_app/advanced_settings.scss b/src/plugins/advanced_settings/public/management_app/_advanced_settings.scss
similarity index 100%
rename from src/plugins/advanced_settings/public/management_app/advanced_settings.scss
rename to src/plugins/advanced_settings/public/management_app/_advanced_settings.scss
diff --git a/src/plugins/advanced_settings/public/management_app/_index.scss b/src/plugins/advanced_settings/public/management_app/index.scss
similarity index 100%
rename from src/plugins/advanced_settings/public/management_app/_index.scss
rename to src/plugins/advanced_settings/public/management_app/index.scss
diff --git a/src/plugins/advanced_settings/public/management_app/mount_management_section.tsx b/src/plugins/advanced_settings/public/management_app/mount_management_section.tsx
index b4779d051ab02..ab348451b1eef 100644
--- a/src/plugins/advanced_settings/public/management_app/mount_management_section.tsx
+++ b/src/plugins/advanced_settings/public/management_app/mount_management_section.tsx
@@ -29,6 +29,8 @@ import { AdvancedSettings } from './advanced_settings';
import { ManagementAppMountParams } from '../../../management/public';
import { ComponentRegistry } from '../types';
+import './index.scss';
+
const title = i18n.translate('advancedSettings.advancedSettingsLabel', {
defaultMessage: 'Advanced Settings',
});
diff --git a/src/plugins/dashboard/public/application/application.ts b/src/plugins/dashboard/public/application/application.ts
index 543450916c505..08eeb19dcda93 100644
--- a/src/plugins/dashboard/public/application/application.ts
+++ b/src/plugins/dashboard/public/application/application.ts
@@ -68,11 +68,12 @@ export interface RenderDeps {
embeddable: EmbeddableStart;
localStorage: Storage;
share?: SharePluginStart;
- config: KibanaLegacyStart['config'];
usageCollection?: UsageCollectionSetup;
navigateToDefaultApp: KibanaLegacyStart['navigateToDefaultApp'];
+ navigateToLegacyKibanaUrl: KibanaLegacyStart['navigateToLegacyKibanaUrl'];
scopedHistory: () => ScopedHistory;
savedObjects: SavedObjectsStart;
+ restorePreviousUrl: () => void;
}
let angularModuleInstance: IModule | null = null;
diff --git a/src/plugins/dashboard/public/application/dashboard_app_controller.tsx b/src/plugins/dashboard/public/application/dashboard_app_controller.tsx
index 206ef4f3d4313..3c559a6cde211 100644
--- a/src/plugins/dashboard/public/application/dashboard_app_controller.tsx
+++ b/src/plugins/dashboard/public/application/dashboard_app_controller.tsx
@@ -75,7 +75,7 @@ import { getDashboardTitle } from './dashboard_strings';
import { DashboardAppScope } from './dashboard_app';
import { convertSavedDashboardPanelToPanelState } from './lib/embeddable_saved_object_converters';
import { RenderDeps } from './application';
-import { IKbnUrlStateStorage, removeQueryParam, unhashUrl } from '../../../kibana_utils/public';
+import { IKbnUrlStateStorage, unhashUrl } from '../../../kibana_utils/public';
import {
addFatalError,
AngularHttpError,
@@ -132,6 +132,7 @@ export class DashboardAppController {
embeddable,
share,
dashboardCapabilities,
+ scopedHistory,
embeddableCapabilities: { visualizeCapabilities, mapsCapabilities },
data: { query: queryService },
core: {
@@ -425,15 +426,13 @@ export class DashboardAppController {
refreshDashboardContainer();
});
- // This code needs to be replaced with a better mechanism for adding new embeddables of
- // any type from the add panel. Likely this will happen via creating a visualization "inline",
- // without navigating away from the UX.
- if ($routeParams[DashboardConstants.ADD_EMBEDDABLE_TYPE]) {
- const type = $routeParams[DashboardConstants.ADD_EMBEDDABLE_TYPE];
- const id = $routeParams[DashboardConstants.ADD_EMBEDDABLE_ID];
- container.addNewEmbeddable(type, { savedObjectId: id });
- removeQueryParam(history, DashboardConstants.ADD_EMBEDDABLE_TYPE);
- removeQueryParam(history, DashboardConstants.ADD_EMBEDDABLE_ID);
+ const incomingState = embeddable
+ .getStateTransfer(scopedHistory())
+ .getIncomingEmbeddablePackage();
+ if (incomingState) {
+ container.addNewEmbeddable(incomingState.type, {
+ savedObjectId: incomingState.id,
+ });
}
}
diff --git a/src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx b/src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx
index 27bbc2ef675a1..f1ecd0f221926 100644
--- a/src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx
+++ b/src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx
@@ -46,6 +46,7 @@ import {
} from '../../../../kibana_react/public';
import { PLACEHOLDER_EMBEDDABLE } from './placeholder';
import { PanelPlacementMethod, IPanelPlacementArgs } from './panel/dashboard_panel_placement';
+import { EmbeddableStateTransfer } from '../../../../embeddable/public';
export interface DashboardContainerInput extends ContainerInput {
viewMode: ViewMode;
@@ -98,9 +99,12 @@ export class DashboardContainer extends Container React.ReactNode);
+ private embeddablePanel: EmbeddableStart['EmbeddablePanel'];
+
constructor(
initialInput: DashboardContainerInput,
private readonly options: DashboardContainerOptions,
+ stateTransfer?: EmbeddableStateTransfer,
parent?: Container
) {
super(
@@ -111,6 +115,7 @@ export class DashboardContainer extends Container
,
diff --git a/src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx b/src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx
index 514b4e7ca8588..4107a00ba80ce 100644
--- a/src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx
+++ b/src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx
@@ -19,7 +19,7 @@
import { i18n } from '@kbn/i18n';
import { UiActionsStart } from 'src/plugins/ui_actions/public';
-import { CoreStart } from 'src/core/public';
+import { CoreStart, ScopedHistory } from 'src/core/public';
import { Start as InspectorStartContract } from 'src/plugins/inspector/public';
import { EmbeddableFactory, EmbeddableStart } from '../../../../embeddable/public';
import {
@@ -54,7 +54,10 @@ export class DashboardContainerFactoryDefinition
public readonly isContainerType = true;
public readonly type = DASHBOARD_CONTAINER_TYPE;
- constructor(private readonly getStartServices: () => Promise) {}
+ constructor(
+ private readonly getStartServices: () => Promise,
+ private getHistory: () => ScopedHistory
+ ) {}
public isEditable = async () => {
const { capabilities } = await this.getStartServices();
@@ -81,6 +84,7 @@ export class DashboardContainerFactoryDefinition
parent?: Container
): Promise => {
const services = await this.getStartServices();
- return new DashboardContainer(initialInput, services, parent);
+ const stateTransfer = services.embeddable.getStateTransfer(this.getHistory());
+ return new DashboardContainer(initialInput, services, stateTransfer, parent);
};
}
diff --git a/src/plugins/dashboard/public/application/embeddable/grid/dashboard_grid.test.tsx b/src/plugins/dashboard/public/application/embeddable/grid/dashboard_grid.test.tsx
index 9a2610a82b97d..493ae8eb51797 100644
--- a/src/plugins/dashboard/public/application/embeddable/grid/dashboard_grid.test.tsx
+++ b/src/plugins/dashboard/public/application/embeddable/grid/dashboard_grid.test.tsx
@@ -64,6 +64,7 @@ function prepare(props?: Partial) {
embeddable: {
getTriggerCompatibleActions: (() => []) as any,
getEmbeddableFactories: start.getEmbeddableFactories,
+ getEmbeddablePanel: jest.fn(),
getEmbeddableFactory,
} as any,
notifications: {} as any,
diff --git a/src/plugins/dashboard/public/application/embeddable/viewport/dashboard_viewport.test.tsx b/src/plugins/dashboard/public/application/embeddable/viewport/dashboard_viewport.test.tsx
index 25e451dc7f793..733ea11c1eb64 100644
--- a/src/plugins/dashboard/public/application/embeddable/viewport/dashboard_viewport.test.tsx
+++ b/src/plugins/dashboard/public/application/embeddable/viewport/dashboard_viewport.test.tsx
@@ -54,6 +54,7 @@ function getProps(
application: applicationServiceMock.createStartContract(),
embeddable: {
getTriggerCompatibleActions: (() => []) as any,
+ getEmbeddablePanel: jest.fn(),
getEmbeddableFactories: start.getEmbeddableFactories,
getEmbeddableFactory: start.getEmbeddableFactory,
} as any,
diff --git a/src/plugins/dashboard/public/application/embeddable/viewport/dashboard_viewport.tsx b/src/plugins/dashboard/public/application/embeddable/viewport/dashboard_viewport.tsx
index 9ee50426b19bb..15a486f99a37f 100644
--- a/src/plugins/dashboard/public/application/embeddable/viewport/dashboard_viewport.tsx
+++ b/src/plugins/dashboard/public/application/embeddable/viewport/dashboard_viewport.tsx
@@ -26,8 +26,8 @@ import { context } from '../../../../../kibana_react/public';
export interface DashboardViewportProps {
container: DashboardContainer;
- renderEmpty?: () => React.ReactNode;
PanelComponent: EmbeddableStart['EmbeddablePanel'];
+ renderEmpty?: () => React.ReactNode;
}
interface State {
diff --git a/src/plugins/dashboard/public/application/legacy_app.js b/src/plugins/dashboard/public/application/legacy_app.js
index 2d99a2c6a2253..8b8fdcb7a76ac 100644
--- a/src/plugins/dashboard/public/application/legacy_app.js
+++ b/src/plugins/dashboard/public/application/legacy_app.js
@@ -242,9 +242,17 @@ export function initDashboardApp(app, deps) {
},
})
.otherwise({
- template: '',
- controller: function () {
- deps.navigateToDefaultApp();
+ resolveRedirectTo: function ($rootScope) {
+ const path = window.location.hash.substr(1);
+ deps.restorePreviousUrl();
+ $rootScope.$applyAsync(() => {
+ const { navigated } = deps.navigateToLegacyKibanaUrl(path);
+ if (!navigated) {
+ deps.navigateToDefaultApp();
+ }
+ });
+ // prevent angular from completing the navigation
+ return new Promise(() => {});
},
});
});
diff --git a/src/plugins/dashboard/public/plugin.tsx b/src/plugins/dashboard/public/plugin.tsx
index e99b8ad616cb9..041a02a251e8a 100644
--- a/src/plugins/dashboard/public/plugin.tsx
+++ b/src/plugins/dashboard/public/plugin.tsx
@@ -206,13 +206,22 @@ export class DashboardPlugin
};
};
- const factory = new DashboardContainerFactoryDefinition(getStartServices);
+ const factory = new DashboardContainerFactoryDefinition(
+ getStartServices,
+ () => this.currentHistory!
+ );
embeddable.registerEmbeddableFactory(factory.type, factory);
const placeholderFactory = new PlaceholderEmbeddableFactory();
embeddable.registerEmbeddableFactory(placeholderFactory.type, placeholderFactory);
- const { appMounted, appUnMounted, stop: stopUrlTracker, getActiveUrl } = createKbnUrlTracker({
+ const {
+ appMounted,
+ appUnMounted,
+ stop: stopUrlTracker,
+ getActiveUrl,
+ restorePreviousUrl,
+ } = createKbnUrlTracker({
baseUrl: core.http.basePath.prepend('/app/dashboards'),
defaultSubUrl: `#${DashboardConstants.LANDING_PAGE_PATH}`,
storageKey: `lastUrl:${core.http.basePath.get()}:dashboard`,
@@ -257,7 +266,7 @@ export class DashboardPlugin
navigation,
share: shareStart,
data: dataStart,
- kibanaLegacy: { dashboardConfig, navigateToDefaultApp },
+ kibanaLegacy: { dashboardConfig, navigateToDefaultApp, navigateToLegacyKibanaUrl },
savedObjects,
} = pluginsStart;
@@ -266,6 +275,7 @@ export class DashboardPlugin
core: coreStart,
dashboardConfig,
navigateToDefaultApp,
+ navigateToLegacyKibanaUrl,
navigation,
share: shareStart,
data: dataStart,
@@ -274,7 +284,6 @@ export class DashboardPlugin
chrome: coreStart.chrome,
addBasePath: coreStart.http.basePath.prepend,
uiSettings: coreStart.uiSettings,
- config: kibanaLegacy.config,
savedQueryService: dataStart.query.savedQueries,
embeddable: embeddableStart,
dashboardCapabilities: coreStart.application.capabilities.dashboard,
@@ -286,6 +295,7 @@ export class DashboardPlugin
usageCollection,
scopedHistory: () => this.currentHistory!,
savedObjects,
+ restorePreviousUrl,
};
// make sure the index pattern list is up to date
await dataStart.indexPatterns.clearCache();
@@ -302,6 +312,15 @@ export class DashboardPlugin
initAngularBootstrap();
core.application.register(app);
+ kibanaLegacy.forwardApp(
+ DashboardConstants.DASHBOARDS_ID,
+ DashboardConstants.DASHBOARDS_ID,
+ (path) => {
+ const [, tail] = /(\?.*)/.exec(path) || [];
+ // carry over query if it exists
+ return `#/list${tail || ''}`;
+ }
+ );
kibanaLegacy.forwardApp(
DashboardConstants.DASHBOARD_ID,
DashboardConstants.DASHBOARDS_ID,
@@ -319,15 +338,6 @@ export class DashboardPlugin
return `#/view/${id}${tail || ''}`;
}
);
- kibanaLegacy.forwardApp(
- DashboardConstants.DASHBOARDS_ID,
- DashboardConstants.DASHBOARDS_ID,
- (path) => {
- const [, tail] = /(\?.*)/.exec(path) || [];
- // carry over query if it exists
- return `#/list${tail || ''}`;
- }
- );
if (home) {
home.featureCatalogue.register({
diff --git a/src/plugins/data/common/field_formats/index.ts b/src/plugins/data/common/field_formats/index.ts
index 5c67073c07dd5..104ff030873aa 100644
--- a/src/plugins/data/common/field_formats/index.ts
+++ b/src/plugins/data/common/field_formats/index.ts
@@ -40,7 +40,7 @@ export {
TruncateFormat,
} from './converters';
-export { getHighlightRequest, serializeFieldFormat } from './utils';
+export { getHighlightRequest } from './utils';
export { DEFAULT_CONVERTER_COLOR } from './constants/color_default';
export { FIELD_FORMAT_IDS } from './types';
diff --git a/src/plugins/data/common/field_formats/utils/index.ts b/src/plugins/data/common/field_formats/utils/index.ts
index 3832c941ffad7..eb020c17ca09c 100644
--- a/src/plugins/data/common/field_formats/utils/index.ts
+++ b/src/plugins/data/common/field_formats/utils/index.ts
@@ -22,6 +22,5 @@ import { IFieldFormat } from '../index';
export { asPrettyString } from './as_pretty_string';
export { getHighlightHtml, getHighlightRequest } from './highlight';
-export { serializeFieldFormat } from './serialize';
export type FormatFactory = (mapping?: SerializedFieldFormat) => IFieldFormat;
diff --git a/src/plugins/data/common/field_formats/utils/serialize.ts b/src/plugins/data/common/field_formats/utils/serialize.ts
deleted file mode 100644
index 1092c90d19451..0000000000000
--- a/src/plugins/data/common/field_formats/utils/serialize.ts
+++ /dev/null
@@ -1,53 +0,0 @@
-/*
- * 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 { IAggConfig } from 'src/plugins/data/public';
-import { SerializedFieldFormat } from '../../../../expressions/common/types';
-
-export const serializeFieldFormat = (agg: IAggConfig): SerializedFieldFormat => {
- const format: SerializedFieldFormat = agg.params.field ? agg.params.field.format.toJSON() : {};
- const formats: Record SerializedFieldFormat> = {
- date_range: () => ({ id: 'date_range', params: format }),
- ip_range: () => ({ id: 'ip_range', params: format }),
- percentile_ranks: () => ({ id: 'percent' }),
- count: () => ({ id: 'number' }),
- cardinality: () => ({ id: 'number' }),
- date_histogram: () => ({
- id: 'date',
- params: {
- pattern: (agg as any).buckets.getScaledDateFormat(),
- },
- }),
- terms: () => ({
- id: 'terms',
- params: {
- id: format.id,
- otherBucketLabel: agg.params.otherBucketLabel,
- missingBucketLabel: agg.params.missingBucketLabel,
- ...format.params,
- },
- }),
- range: () => ({
- id: 'range',
- params: { id: format.id, ...format.params },
- }),
- };
-
- return formats[agg.type.name] ? formats[agg.type.name]() : format;
-};
diff --git a/src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts b/src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts
index 666d99362ce80..cd39a965ae6fc 100644
--- a/src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts
+++ b/src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts
@@ -198,7 +198,7 @@ export class IndexPattern implements IIndexPattern {
private updateFromElasticSearch(response: any, forceFieldRefresh: boolean = false) {
if (!response.found) {
- throw new SavedObjectNotFound(type, this.id, 'kibana#/management/kibana/indexPatterns');
+ throw new SavedObjectNotFound(type, this.id, 'management/kibana/indexPatterns');
}
_.forOwn(this.mapping, (fieldMapping: FieldMappingSpec, name: string | undefined) => {
diff --git a/src/plugins/data/public/field_formats/utils/deserialize.ts b/src/plugins/data/public/field_formats/utils/deserialize.ts
index d9c713c8b1eb4..26baa5fdeb1e4 100644
--- a/src/plugins/data/public/field_formats/utils/deserialize.ts
+++ b/src/plugins/data/public/field_formats/utils/deserialize.ts
@@ -18,107 +18,42 @@
*/
import { identity } from 'lodash';
-import { i18n } from '@kbn/i18n';
-import { convertDateRangeToString, DateRangeKey } from '../../search/aggs/buckets/lib/date_range';
-import { convertIPRangeToString, IpRangeKey } from '../../search/aggs/buckets/lib/ip_range';
+
import { SerializedFieldFormat } from '../../../../expressions/common/types';
-import { FieldFormatId, FieldFormatsContentType, IFieldFormat } from '../..';
+
import { FieldFormat } from '../../../common';
-import { DataPublicPluginStart } from '../../../public';
-import { getUiSettings } from '../../../public/services';
import { FormatFactory } from '../../../common/field_formats/utils';
-
-interface TermsFieldFormatParams {
- otherBucketLabel: string;
- missingBucketLabel: string;
- id: string;
-}
-
-function isTermsFieldFormat(
- serializedFieldFormat: SerializedFieldFormat
-): serializedFieldFormat is SerializedFieldFormat {
- return serializedFieldFormat.id === 'terms';
-}
+import { DataPublicPluginStart, IFieldFormat } from '../../../public';
+import { getUiSettings } from '../../../public/services';
+import { getFormatWithAggs } from '../../search/aggs/utils';
const getConfig = (key: string, defaultOverride?: any): any =>
getUiSettings().get(key, defaultOverride);
const DefaultFieldFormat = FieldFormat.from(identity);
-const getFieldFormat = (
- fieldFormatsService: DataPublicPluginStart['fieldFormats'],
- id?: FieldFormatId,
- params: object = {}
-): IFieldFormat => {
- if (id) {
- const Format = fieldFormatsService.getType(id);
-
- if (Format) {
- return new Format(params, getConfig);
- }
- }
-
- return new DefaultFieldFormat();
-};
-
export const deserializeFieldFormat: FormatFactory = function (
this: DataPublicPluginStart['fieldFormats'],
- mapping?: SerializedFieldFormat
+ serializedFieldFormat?: SerializedFieldFormat
) {
- if (!mapping) {
+ if (!serializedFieldFormat) {
return new DefaultFieldFormat();
}
- const { id } = mapping;
- if (id === 'range') {
- const RangeFormat = FieldFormat.from((range: any) => {
- const nestedFormatter = mapping.params as SerializedFieldFormat;
- const format = getFieldFormat(this, nestedFormatter.id, nestedFormatter.params);
- const gte = '\u2265';
- const lt = '\u003c';
- return i18n.translate('data.aggTypes.buckets.ranges.rangesFormatMessage', {
- defaultMessage: '{gte} {from} and {lt} {to}',
- values: {
- gte,
- from: format.convert(range.gte),
- lt,
- to: format.convert(range.lt),
- },
- });
- });
- return new RangeFormat();
- } else if (id === 'date_range') {
- const nestedFormatter = mapping.params as SerializedFieldFormat;
- const DateRangeFormat = FieldFormat.from((range: DateRangeKey) => {
- const format = getFieldFormat(this, nestedFormatter.id, nestedFormatter.params);
- return convertDateRangeToString(range, format.convert.bind(format));
- });
- return new DateRangeFormat();
- } else if (id === 'ip_range') {
- const nestedFormatter = mapping.params as SerializedFieldFormat;
- const IpRangeFormat = FieldFormat.from((range: IpRangeKey) => {
- const format = getFieldFormat(this, nestedFormatter.id, nestedFormatter.params);
- return convertIPRangeToString(range, format.convert.bind(format));
- });
- return new IpRangeFormat();
- } else if (isTermsFieldFormat(mapping) && mapping.params) {
- const { params } = mapping;
- const convert = (val: string, type: FieldFormatsContentType) => {
- const format = getFieldFormat(this, params.id, mapping.params);
- if (val === '__other__') {
- return params.otherBucketLabel;
- }
- if (val === '__missing__') {
- return params.missingBucketLabel;
+ const getFormat = (mapping: SerializedFieldFormat): IFieldFormat => {
+ const { id, params = {} } = mapping;
+ if (id) {
+ const Format = this.getType(id);
+
+ if (Format) {
+ return new Format(params, getConfig);
}
+ }
+
+ return new DefaultFieldFormat();
+ };
- return format.convert(val, type);
- };
+ // decorate getFormat to handle custom types created by aggs
+ const getFieldFormat = getFormatWithAggs(getFormat);
- return {
- convert,
- getConverterFor: (type: FieldFormatsContentType) => (val: string) => convert(val, type),
- } as IFieldFormat;
- } else {
- return getFieldFormat(this, id, mapping.params);
- }
+ return getFieldFormat(serializedFieldFormat);
};
diff --git a/src/plugins/data/public/index.ts b/src/plugins/data/public/index.ts
index 1554ac71f8c55..984ce18aa4d83 100644
--- a/src/plugins/data/public/index.ts
+++ b/src/plugins/data/public/index.ts
@@ -168,7 +168,6 @@ import {
UrlFormat,
StringFormat,
TruncateFormat,
- serializeFieldFormat,
} from '../common/field_formats';
import { DateFormat } from './field_formats';
@@ -179,8 +178,6 @@ export const fieldFormats = {
FieldFormat,
FieldFormatsRegistry, // exported only for tests. Consider mock.
- serialize: serializeFieldFormat,
-
DEFAULT_CONVERTER_COLOR,
HTML_CONTEXT_TYPE,
TEXT_CONTEXT_TYPE,
diff --git a/src/plugins/data/public/public.api.md b/src/plugins/data/public/public.api.md
index 23213d4d1165a..31dc5b51a06f5 100644
--- a/src/plugins/data/public/public.api.md
+++ b/src/plugins/data/public/public.api.md
@@ -154,6 +154,7 @@ import { SearchParams } from 'elasticsearch';
import { SearchResponse as SearchResponse_2 } from 'elasticsearch';
import { SearchShardsParams } from 'elasticsearch';
import { SearchTemplateParams } from 'elasticsearch';
+import { SerializedFieldFormat as SerializedFieldFormat_2 } from 'src/plugins/expressions/public';
import { SimpleSavedObject } from 'src/core/public';
import { SnapshotCreateParams } from 'elasticsearch';
import { SnapshotCreateRepositoryParams } from 'elasticsearch';
@@ -621,7 +622,6 @@ export type FieldFormatInstanceType = (new (params?: any, getConfig?: FieldForma
export const fieldFormats: {
FieldFormat: typeof FieldFormat;
FieldFormatsRegistry: typeof FieldFormatsRegistry;
- serialize: (agg: import("./search").AggConfig) => import("../../expressions").SerializedFieldFormat
);
}
-
-Agg.propTypes = {
- disableDelete: PropTypes.bool,
- fields: PropTypes.object,
- model: PropTypes.object,
- onAdd: PropTypes.func,
- onChange: PropTypes.func,
- onDelete: PropTypes.func,
- panel: PropTypes.object,
- series: PropTypes.object,
- siblings: PropTypes.array,
- uiRestrictions: PropTypes.object,
- dragHandleProps: PropTypes.object,
-};
diff --git a/src/plugins/vis_type_timeseries/public/application/components/aggs/agg_row.js b/src/plugins/vis_type_timeseries/public/application/components/aggs/agg_row.tsx
similarity index 86%
rename from src/plugins/vis_type_timeseries/public/application/components/aggs/agg_row.js
rename to src/plugins/vis_type_timeseries/public/application/components/aggs/agg_row.tsx
index a2f1640904dd0..0363ba486a775 100644
--- a/src/plugins/vis_type_timeseries/public/application/components/aggs/agg_row.js
+++ b/src/plugins/vis_type_timeseries/public/application/components/aggs/agg_row.tsx
@@ -17,15 +17,26 @@
* under the License.
*/
-import PropTypes from 'prop-types';
import React from 'react';
import { last } from 'lodash';
-import { AddDeleteButtons } from '../add_delete_buttons';
import { EuiIcon, EuiFlexGroup, EuiFlexItem } from '@elastic/eui';
-import { SeriesDragHandler } from '../series_drag_handler';
import { i18n } from '@kbn/i18n';
+import { AddDeleteButtons } from '../add_delete_buttons';
+import { SeriesDragHandler } from '../series_drag_handler';
+import { MetricsItemsSchema } from '../../../../common/types';
+import { DragHandleProps } from '../../../types';
-export function AggRow(props) {
+interface AggRowProps {
+ disableDelete: boolean;
+ model: MetricsItemsSchema;
+ siblings: MetricsItemsSchema[];
+ dragHandleProps: DragHandleProps;
+ children: React.ReactNode;
+ onAdd: () => void;
+ onDelete: () => void;
+}
+
+export function AggRow(props: AggRowProps) {
let iconType = 'eyeClosed';
let iconColor = 'subdued';
const lastSibling = last(props.siblings);
@@ -71,12 +82,3 @@ export function AggRow(props) {