[Reporting/New Platform] Use the logger service from core #55442

tsullivan · 2020-01-21T18:07:48Z

Summary

Depends on [Reporting] Convert CSV Export libs to Typescript #55117
~~[ ] Blocked on [New Platform / LoggerFactory] Debug messages are not appearing #55456~~

This PR integrates the core New Platform server-side logger with the legacy Reporting plugin.

NOTE: This breaks a technique that users have used to print verbose logs for Reporting.
This config:

logging.events.log: ['warning', 'error', 'fatal', 'info', 'reporting']

Will no longer show debug messages for Reporting. The workaround is to just use:

logging.verbose: true

If that becomes a breaking change when this code is released, then it should be documented. We'll have to keep an eye on this because maybe there will be a better solution before this code is released.

Checklist

Use ~~strikethroughs~~ to remove checklist items you don't feel are applicable to this PR.

~~[ ] This was checked for cross-browser compatibility, including a check against IE11~~
~~[ ] Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support~~
~~[ ] Documentation was added for features that require explanation or tutorials~~
Unit or functional tests were updated or added to match the most common scenarios
~~[ ] This was checked for keyboard-only and screenreader accessibility~~

For maintainers

This was checked for breaking API changes and was labeled appropriately
~~[ ] This includes a feature addition or change that requires a release note and was labeled appropriately~~

tsullivan · 2020-01-21T18:30:22Z

x-pack/legacy/plugins/reporting/server/lib/level_logger.ts

  }

  public debug(msg: string, tags: string[] = []) {
-    this._logger([...this._tags, ...tags, 'debug'], trimStr(msg));
+    this.getLogger(tags).debug(msg);


I am finding that no debug messages are getting logged with the changes from this branch.

@joshdover you asked me to track this for you. I'll give it another run and file a bug if needed.

Filed #55456

elasticmachine · 2020-01-21T18:55:29Z

Pinging @elastic/kibana-reporting-services (Team:Reporting Services)

tsullivan · 2020-01-22T03:36:37Z

x-pack/legacy/plugins/reporting/export_types/csv/server/execute_job.ts

 import { fieldFormatMapFactory } from './lib/field_format_map';
+import { createGenerateCsv } from './lib/generate_csv';


Apologies, but this PR contains some automated changes of an IDE tool that organize the imports

x-pack/legacy/plugins/reporting/server/lib/level_logger.ts

pgayvallet · 2020-01-22T20:01:46Z

Ack: will review tomorrow

tsullivan · 2020-01-22T23:31:21Z

x-pack/legacy/plugins/reporting/export_types/csv/server/execute_job.test.js

-      await expectRejectedPromise(executeJob('job123', jobParams, cancellationToken));
+      await expect(
+        executeJob('job123', jobParams, cancellationToken)
+      ).rejects.toMatchInlineSnapshot(`[TypeError: Cannot read property 'indexOf' of undefined]`);


this seems a little strange. It's worth a look to see if this is the actual expected error

pgayvallet

LGTM

Some NITs and comments:

pgayvallet · 2020-01-23T09:56:55Z

x-pack/legacy/plugins/reporting/export_types/csv/server/execute_job.test.js

+  const mockLogger = new LevelLogger({
+    get: () => ({
+      debug: jest.fn(),
+      warn: jest.fn(),
+      error: jest.fn(),
+    }),
+  });


You can probably use core mocked logger implementation

import { loggingServiceMock } from '[..]/src/core/server/mocks'; const mockLogger = new LevelLogger({ get: () => loggingServiceMock.createLogger(), });

pgayvallet · 2020-01-23T10:07:16Z

x-pack/legacy/plugins/reporting/server/plugin.ts

+      const logger = new LevelLogger(this.initializerContext.logger.get('reporting'));
+      const browserDriverFactory = await createBrowserDriverFactory(__LEGACY, logger);


NOTE: the legacy initializerContext.logger.get returns a logger factory with empty context.

You have to be aware what once migrated to NP and using the actual NP plugin's initializerContext, this will be prefixed with the plugins context, meaning that this.initializerContext.logger.get('reporting') will returns the plugins.reporting-prefixed factory instead of just reporting as of now.

pgayvallet · 2020-01-23T10:10:20Z

x-pack/legacy/plugins/reporting/server/routes/jobs.ts

+function isResponse(response: Boom<null> | ResponseObject): response is ResponseObject {
+  return !(response as Boom<unknown>).isBoom;
+}


NIT: use isBoom instead (import { isBoom } from 'boom'; + return !isBoom(response);)

pgayvallet · 2020-01-23T10:12:08Z

x-pack/legacy/plugins/reporting/server/routes/jobs.ts

+        if (statusCode !== 200) {
+          if (statusCode === 500) {
+            logger.error(`Report ${docId} has failed: ${JSON.stringify(response.source)}`);
+          } else {


NIT: would remove one nesting level with if (statusCode === 500) elif (statusCode !== 200)

pgayvallet · 2020-01-23T10:15:06Z

x-pack/legacy/plugins/reporting/server/routes/lib/reporting_feature_pre_routing.ts

-      const reportingFeatureId = getReportingFeatureId(request);
+      const reportingFeatureId = getReportingFeatureId(request) as string;


NIT: the signature seems to already define the return type, why was the force-cast necessary?

export type GetReportingFeatureIdFn = (request: Legacy.Request) => string;

pgayvallet · 2020-01-23T10:23:00Z

x-pack/legacy/plugins/reporting/server/lib/level_logger.ts

+  constructor(logger: LoggerFactory, tags?: string[]) {
    this._logger = logger;
-    this._tags = tags;
+    this._tags = tags || [];


NIT: avoid || with constructor(logger: LoggerFactory, tags: string[] = []) {

pgayvallet · 2020-01-23T10:24:44Z

x-pack/legacy/plugins/reporting/server/lib/level_logger.ts


 const trimStr = (toTrim: string) => {
  return typeof toTrim === 'string' ? toTrim.trim() : toTrim;
 };

 export class LevelLogger {
-  private _logger: any;
+  private _logger: LoggerFactory;


NIT: would name is _loggerFactory or _factory to be explicit about the type

kibanamachine · 2020-01-23T19:38:14Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request
Commit: 0fc86d4

History

💚 Build #22020 succeeded 9119c9f
💔 Build #21980 failed c4b807e
💔 Build #21959 failed 94ebeeb
💔 Build #21930 failed 93b46ec2626e0e3adc853a5aa62395fff24b79df
💔 Build #21779 failed 604dd2c3272bb5ed9f837b933384352b42342c7c

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

joelgriffith · 2020-01-23T20:10:08Z

x-pack/legacy/plugins/reporting/export_types/csv/server/execute_job.ts


 export const executeJobFactory: ExecuteJobFactory<ESQueueWorkerExecuteFn<
  JobDocPayloadDiscoverCsv
->> = function executeJobFactoryFn(server: ServerFacade) {
+>> = function executeJobFactoryFn(server: ServerFacade, parentLogger: Logger) {


Man the >> threw me for a second. Smelled of merge conflict :/

) * More Typescript Fixes * [Reporting/New Platform] Use the logger service from core * Add log tag * fix jest tests * ts fixes * fix mocha test * convert to jest

…) (#55751) * [Reporting/New Platform] Use the logger service from core (#55442) * More Typescript Fixes * [Reporting/New Platform] Use the logger service from core * Add log tag * fix jest tests * ts fixes * fix mocha test * convert to jest * fix logger usage for legacy shim removed in 8.0

tsullivan commented Jan 21, 2020

View reviewed changes

tsullivan mentioned this pull request Jan 21, 2020

[New Platform / LoggerFactory] Debug messages are not appearing #55456

Closed

tsullivan added enhancement New value added to drive a business result (Deprecated) Feature:Reporting Use Reporting:Screenshot, Reporting:CSV, or Reporting:Framework instead release_note:skip Skip the PR/issue when compiling release notes Team:Reporting Services labels Jan 21, 2020

tsullivan added v7.7.0 v8.0.0 Feature:New Platform labels Jan 21, 2020

tsullivan force-pushed the reporting/np-server-logger branch 2 times, most recently from 08adc15 to 604dd2c Compare January 22, 2020 03:34

tsullivan added the blocked label Jan 22, 2020

tsullivan marked this pull request as ready for review January 22, 2020 03:35

tsullivan requested review from joelgriffith, rudolf, pgayvallet and a team January 22, 2020 03:35

tsullivan commented Jan 22, 2020

View reviewed changes

x-pack/legacy/plugins/reporting/server/lib/level_logger.ts Show resolved Hide resolved

tsullivan added 4 commits January 22, 2020 11:46

More Typescript Fixes

640264f

[Reporting/New Platform] Use the logger service from core

0e75d64

Add log tag

77f91bf

fix jest tests

94ebeeb

tsullivan force-pushed the reporting/np-server-logger branch from 93b46ec to 94ebeeb Compare January 22, 2020 19:05

tsullivan mentioned this pull request Jan 22, 2020

[Reporting] Server Routing and getDocumentPayload Typescript Improvements #55608

Closed

7 tasks

tsullivan added 2 commits January 22, 2020 13:30

ts fixes

c4b807e

Merge branch 'master' into reporting/np-server-logger

cb7b1d1

tsullivan added 2 commits January 22, 2020 16:10

fix mocha test

393f962

convert to jest

9119c9f

tsullivan commented Jan 22, 2020

View reviewed changes

pgayvallet approved these changes Jan 23, 2020

View reviewed changes

Merge branch 'master' into reporting/np-server-logger

0fc86d4

joelgriffith reviewed Jan 23, 2020

View reviewed changes

joelgriffith approved these changes Jan 23, 2020

View reviewed changes

tsullivan merged commit e102ae6 into elastic:master Jan 23, 2020

tsullivan mentioned this pull request Jan 23, 2020

[7.x] [Reporting/New Platform] Use the logger service from core (#55442) #55751

Merged

tsullivan deleted the reporting/np-server-logger branch January 23, 2020 21:28

tsullivan mentioned this pull request Jan 29, 2020

[Reporting] New Platform Migration #53898

Closed

19 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Reporting/New Platform] Use the logger service from core #55442

[Reporting/New Platform] Use the logger service from core #55442

tsullivan commented Jan 21, 2020 •

edited

Loading

tsullivan Jan 21, 2020

tsullivan Jan 21, 2020

elasticmachine commented Jan 21, 2020

tsullivan Jan 22, 2020

pgayvallet commented Jan 22, 2020

tsullivan Jan 22, 2020

pgayvallet left a comment

pgayvallet Jan 23, 2020

pgayvallet Jan 23, 2020

pgayvallet Jan 23, 2020

pgayvallet Jan 23, 2020

pgayvallet Jan 23, 2020

pgayvallet Jan 23, 2020

pgayvallet Jan 23, 2020

kibanamachine commented Jan 23, 2020

joelgriffith Jan 23, 2020

		import { fieldFormatMapFactory } from './lib/field_format_map';
		import { createGenerateCsv } from './lib/generate_csv';

		const logger = new LevelLogger(this.initializerContext.logger.get('reporting'));
		const browserDriverFactory = await createBrowserDriverFactory(__LEGACY, logger);

		const reportingFeatureId = getReportingFeatureId(request);
		const reportingFeatureId = getReportingFeatureId(request) as string;

[Reporting/New Platform] Use the logger service from core #55442

[Reporting/New Platform] Use the logger service from core #55442

Conversation

tsullivan commented Jan 21, 2020 • edited Loading

Summary

Checklist

For maintainers

Choose a reason for hiding this comment

Choose a reason for hiding this comment

elasticmachine commented Jan 21, 2020

Choose a reason for hiding this comment

pgayvallet commented Jan 22, 2020

Choose a reason for hiding this comment

pgayvallet left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kibanamachine commented Jan 23, 2020

💚 Build Succeeded

History

Choose a reason for hiding this comment

tsullivan commented Jan 21, 2020 •

edited

Loading