Skip to content

Commit

Permalink
Merge branch 'main' into dg-sanity-ui-tests
Browse files Browse the repository at this point in the history
  • Loading branch information
gurevichdmitry committed Jul 8, 2024
2 parents d49e666 + bac808a commit dc44e4e
Show file tree
Hide file tree
Showing 195 changed files with 2,442 additions and 2,053 deletions.
6 changes: 4 additions & 2 deletions .buildkite/ftr_configs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,10 @@ disabled:
- x-pack/test_serverless/api_integration/test_suites/security/config.feature_flags.ts
- x-pack/test_serverless/functional/test_suites/security/config.feature_flags.ts

# http/2 security muted tests
- x-pack/test/security_functional/saml.http2.config.ts
- x-pack/test/security_functional/oidc.http2.config.ts

defaultQueue: 'n2-4-spot'
enabled:
- test/accessibility/config.ts
Expand Down Expand Up @@ -401,8 +405,6 @@ enabled:
- x-pack/test/security_functional/login_selector.config.ts
- x-pack/test/security_functional/oidc.config.ts
- x-pack/test/security_functional/saml.config.ts
- x-pack/test/security_functional/saml.http2.config.ts
- x-pack/test/security_functional/oidc.http2.config.ts
- x-pack/test/security_functional/insecure_cluster_warning.config.ts
- x-pack/test/security_functional/user_profiles.config.ts
- x-pack/test/security_functional/expired_session.config.ts
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ export class FullStoryShipper implements IShipper {
)
.subscribe((pageVars) => {
this.initContext.logger.debug(
`Calling FS.setVars with context ${JSON.stringify(pageVars)}`
() => `Calling FS.setVars with context ${JSON.stringify(pageVars)}`
);
this.fullStoryApi.setVars('page', {
...formatPayload(pageVars),
Expand All @@ -145,7 +145,7 @@ export class FullStoryShipper implements IShipper {
* @param newContext The full new context to set {@link EventContext}
*/
public extendContext(newContext: EventContext): void {
this.initContext.logger.debug(`Received context ${JSON.stringify(newContext)}`);
this.initContext.logger.debug(() => `Received context ${JSON.stringify(newContext)}`);

// FullStory requires different APIs for different type of contexts:
// User-level context.
Expand Down Expand Up @@ -226,7 +226,9 @@ export class FullStoryShipper implements IShipper {
cloudIsElasticStaffOwned,
cloudTrialEndDate,
};
this.initContext.logger.debug(`Calling FS.setUserVars with ${JSON.stringify(userVars)}`);
this.initContext.logger.debug(
() => `Calling FS.setUserVars with ${JSON.stringify(userVars)}`
);
this.fullStoryApi.setUserVars(formatPayload(userVars));
}
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@ describe('AbstractLogger', () => {
});

describe('log level', () => {
it('does not calls appenders for records with unsupported levels', () => {
it('does not call appender for records with unsupported levels', () => {
logger = new TestLogger(context, LogLevel.Warn, appenderMocks, factory);

logger.trace('some trace message');
Expand Down Expand Up @@ -215,19 +215,49 @@ describe('AbstractLogger', () => {
);
}
});

it('does not call appender for records with unsupported levels for closure syntax', () => {
logger = new TestLogger(context, LogLevel.Warn, appenderMocks, factory);

logger.trace(() => 'some trace message');
logger.debug(() => 'some debug message');
logger.info(() => 'some info message');
logger.warn(() => 'some warn message');
logger.error(() => 'some error message');
logger.fatal(() => 'some fatal message');

for (const appenderMock of appenderMocks) {
expect(appenderMock.append).toHaveBeenCalledTimes(3);
expect(appenderMock.append).toHaveBeenCalledWith(
expect.objectContaining({
level: LogLevel.Warn,
})
);
expect(appenderMock.append).toHaveBeenCalledWith(
expect.objectContaining({
level: LogLevel.Error,
})
);
expect(appenderMock.append).toHaveBeenCalledWith(
expect.objectContaining({
level: LogLevel.Fatal,
})
);
}
});
});

describe('isLevelEnabled', () => {
const orderedLogLevels = [
LogLevel.Fatal,
LogLevel.Error,
LogLevel.Warn,
LogLevel.Info,
LogLevel.Debug,
LogLevel.Trace,
LogLevel.All,
];
const orderedLogLevels = [
LogLevel.Fatal,
LogLevel.Error,
LogLevel.Warn,
LogLevel.Info,
LogLevel.Debug,
LogLevel.Trace,
LogLevel.All,
];

describe('isLevelEnabled', () => {
for (const logLevel of orderedLogLevels) {
it(`returns the correct value for a '${logLevel.id}' level logger`, () => {
const levelLogger = new TestLogger(context, logLevel, appenderMocks, factory);
Expand All @@ -238,4 +268,22 @@ describe('AbstractLogger', () => {
});
}
});

describe('closure syntax', () => {
for (const logLevel of orderedLogLevels) {
it(`evaluates the log function for '${logLevel.id}' level if enabled`, () => {
logger = new TestLogger(context, LogLevel.All, appenderMocks, factory);
const logFn = jest.fn(() => 'some message');
logger.trace(logFn);
expect(logFn).toHaveBeenCalledTimes(1);
});

it(`does not evaluate the log function for '${logLevel.id}' level if not enabled`, () => {
logger = new TestLogger(context, LogLevel.Off, appenderMocks, factory);
const logFn = jest.fn(() => 'some message');
logger.trace(logFn);
expect(logFn).not.toHaveBeenCalled();
});
}
});
});
80 changes: 65 additions & 15 deletions packages/core/logging/core-logging-common-internal/src/logger.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ import {
LoggerFactory,
LogMeta,
Logger,
LogMessageSource,
LogLevelId,
} from '@kbn/logging';

Expand Down Expand Up @@ -43,28 +44,73 @@ export abstract class AbstractLogger implements Logger {
meta?: Meta
): LogRecord;

public trace<Meta extends LogMeta = LogMeta>(message: string, meta?: Meta): void {
this.log(this.createLogRecord<Meta>(LogLevel.Trace, message, meta));
public trace<Meta extends LogMeta = LogMeta>(message: LogMessageSource, meta?: Meta): void {
if (!this.level.supports(LogLevel.Trace)) {
return;
}
if (typeof message === 'function') {
message = message();
}
this.performLog(this.createLogRecord<Meta>(LogLevel.Trace, message, meta));
}

public debug<Meta extends LogMeta = LogMeta>(message: string, meta?: Meta): void {
this.log(this.createLogRecord<Meta>(LogLevel.Debug, message, meta));
public debug<Meta extends LogMeta = LogMeta>(message: LogMessageSource, meta?: Meta): void {
if (!this.level.supports(LogLevel.Debug)) {
return;
}
if (typeof message === 'function') {
message = message();
}
this.performLog(this.createLogRecord<Meta>(LogLevel.Debug, message, meta));
}

public info<Meta extends LogMeta = LogMeta>(message: string, meta?: Meta): void {
this.log(this.createLogRecord<Meta>(LogLevel.Info, message, meta));
public info<Meta extends LogMeta = LogMeta>(message: LogMessageSource, meta?: Meta): void {
if (!this.level.supports(LogLevel.Info)) {
return;
}
if (typeof message === 'function') {
message = message();
}
this.performLog(this.createLogRecord<Meta>(LogLevel.Info, message, meta));
}

public warn<Meta extends LogMeta = LogMeta>(errorOrMessage: string | Error, meta?: Meta): void {
this.log(this.createLogRecord<Meta>(LogLevel.Warn, errorOrMessage, meta));
public warn<Meta extends LogMeta = LogMeta>(
errorOrMessage: LogMessageSource | Error,
meta?: Meta
): void {
if (!this.level.supports(LogLevel.Warn)) {
return;
}
if (typeof errorOrMessage === 'function') {
errorOrMessage = errorOrMessage();
}
this.performLog(this.createLogRecord<Meta>(LogLevel.Warn, errorOrMessage, meta));
}

public error<Meta extends LogMeta = LogMeta>(errorOrMessage: string | Error, meta?: Meta): void {
this.log(this.createLogRecord<Meta>(LogLevel.Error, errorOrMessage, meta));
public error<Meta extends LogMeta = LogMeta>(
errorOrMessage: LogMessageSource | Error,
meta?: Meta
): void {
if (!this.level.supports(LogLevel.Error)) {
return;
}
if (typeof errorOrMessage === 'function') {
errorOrMessage = errorOrMessage();
}
this.performLog(this.createLogRecord<Meta>(LogLevel.Error, errorOrMessage, meta));
}

public fatal<Meta extends LogMeta = LogMeta>(errorOrMessage: string | Error, meta?: Meta): void {
this.log(this.createLogRecord<Meta>(LogLevel.Fatal, errorOrMessage, meta));
public fatal<Meta extends LogMeta = LogMeta>(
errorOrMessage: LogMessageSource | Error,
meta?: Meta
): void {
if (!this.level.supports(LogLevel.Fatal)) {
return;
}
if (typeof errorOrMessage === 'function') {
errorOrMessage = errorOrMessage();
}
this.performLog(this.createLogRecord<Meta>(LogLevel.Fatal, errorOrMessage, meta));
}

public isLevelEnabled(levelId: LogLevelId): boolean {
Expand All @@ -75,12 +121,16 @@ export abstract class AbstractLogger implements Logger {
if (!this.level.supports(record.level)) {
return;
}
for (const appender of this.appenders) {
appender.append(record);
}
this.performLog(record);
}

public get(...childContextPaths: string[]): Logger {
return this.factory.get(...[this.context, ...childContextPaths]);
}

private performLog(record: LogRecord) {
for (const appender of this.appenders) {
appender.append(record);
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,9 @@ export const registerBulkCreateRoute = (
{
path: '/_bulk_create',
options: {
summary: `Create saved objects`,
tags: ['oas-tag:saved objects'],
access,
description: `Create saved objects`,
},
validate: {
query: schema.object({
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,9 @@ export const registerBulkDeleteRoute = (
{
path: '/_bulk_delete',
options: {
summary: `Delete saved objects`,
tags: ['oas-tag:saved objects'],
access,
description: `Remove saved objects`,
},
validate: {
body: schema.arrayOf(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,9 @@ export const registerBulkGetRoute = (
{
path: '/_bulk_get',
options: {
summary: `Get saved objects`,
tags: ['oas-tag:saved objects'],
access,
description: `Get saved objects`,
},
validate: {
body: schema.arrayOf(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,9 @@ export const registerBulkResolveRoute = (
{
path: '/_bulk_resolve',
options: {
summary: `Resolve saved objects`,
tags: ['oas-tag:saved objects'],
access,
description: `Resolve saved objects`,
},
validate: {
body: schema.arrayOf(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,9 @@ export const registerBulkUpdateRoute = (
{
path: '/_bulk_update',
options: {
summary: `Update saved objects`,
tags: ['oas-tag:saved objects'],
access,
description: `Update saved objects`,
},
validate: {
body: schema.arrayOf(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,9 @@ export const registerCreateRoute = (
{
path: '/{type}/{id?}',
options: {
summary: `Create a saved object`,
tags: ['oas-tag:saved objects'],
access,
description: `Create a saved object`,
},
validate: {
params: schema.object({
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,9 @@ export const registerDeleteRoute = (
{
path: '/{type}/{id}',
options: {
summary: `Delete a saved object`,
tags: ['oas-tag:saved objects'],
access,
description: `Delete a saved object`,
},
validate: {
params: schema.object({
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -144,8 +144,9 @@ export const registerExportRoute = (
{
path: '/_export',
options: {
summary: `Export saved objects`,
tags: ['oas-tag:saved objects'],
access: 'public',
description: `Export saved objects`,
},
validate: {
body: schema.object({
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,9 @@ export const registerFindRoute = (
{
path: '/_find',
options: {
summary: `Search for saved objects`,
tags: ['oas-tag:saved objects'],
access,
description: `Search for saved objects`,
},
validate: {
query: schema.object({
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,9 @@ export const registerGetRoute = (
{
path: '/{type}/{id}',
options: {
summary: `Get a saved object`,
tags: ['oas-tag:saved objects'],
access,
description: `Get a saved object`,
},
validate: {
params: schema.object({
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,9 @@ export const registerImportRoute = (
{
path: '/_import',
options: {
summary: `Import saved objects`,
tags: ['oas-tag:saved objects'],
access: 'public',
description: `Import saved objects`,
body: {
maxBytes: maxImportPayloadBytes,
output: 'stream',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,9 @@ export const registerResolveRoute = (
{
path: '/resolve/{type}/{id}',
options: {
summary: `Resolve a saved object`,
tags: ['oas-tag:saved objects'],
access,
description: `Resolve a saved object`,
},
validate: {
params: schema.object({
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,9 @@ export const registerResolveImportErrorsRoute = (
{
path: '/_resolve_import_errors',
options: {
summary: `Resolve import errors`,
tags: ['oas-tag:saved objects'],
access: 'public',
description: `Resolve import errors`,
body: {
maxBytes: maxImportPayloadBytes,
output: 'stream',
Expand Down
Loading

0 comments on commit dc44e4e

Please sign in to comment.