[Reporting Management] Consolidate report job warnings and add warning for deprecated types by tsullivan · Pull Request #106184 · elastic/kibana

tsullivan · 2021-07-19T22:12:45Z

Summary

Release note:

There are changes to the Reporting page under Stack Management. Any report job that has completed with warnings will now show all the warnings in a popover, same as the failure message for jobs that have failed. There is a new type of warning for "deprecated" export types. Deprecated export types of reports can only show in the list of jobs if you have an automated report that was created in an older version of Kibana, and the warning will tell you to redo the automation with a new POST URL in order for the report to keep working in future versions.

List of changes:

Takes the "Max size reached" message out of the report listing table.
Removes specific warnings in the "hover" tooltips
Adds EuiPopover elements that show all warnings (or the failure message) in one place
Adds reports with varying statuses to the reporting/archived_reports ES test archive
Changed the "error button" to show the error message without a call to an API
Removes code for a non-existent cancelled status
Includes various improvements for type strictness
Minor renaming of props/variable names ("record" -> "job") to match the TS type
Changes language of "Job" to "Report" in the user-facing text.
Fixed some user facing text that was not wrapped in a translation function

Removed API endpoint:

Removed the /api/reporting/output/<jobId> (private API) which was inefficiently being used to fetch the error message of a job. The same can be achieved using /api/reporting/info/<jobId> since the returned data type includes warnings, which for a failed job, is the failure message.

How to test with the updated archived reports

You can start Kibana in normal dev mode, and load the archive of various kinds of report jobs, which is being used in functional testing:

> node scripts/es_archiver.js \
  --config x-pack/test/functional/config.js \
  load x-pack/test/functional/es_archives/reporting/archived_reports \
  --es-url https://elastic:changeme@localhost:9200 \
  --es-ca config/cert-bundle/ca/ca.crt \ #  (use this example if you run Elasticsearch over HTTPS)
  --kibana-url http://elastic:changeme@localhost:5601

Sign in as test_user to see the archived reports show up in Stack Management > Reporting.

Screenshots

List of reports from the reporting/archived_reports archive:
Before/After

List of reports from the reporting/archived_reports archive showing pending and processing reports:
Before/After

Note: The UI changes to the table are to give more focus to the errors and warnings in a consistent way. There is a separate issue for redesigning the table to manage reports, which is still unstarted: #39620

Checklist

Delete any items that are not applicable to this PR.

Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
Unit or functional tests were updated or added to match the most common scenarios
Any UI touched in this PR is usable by keyboard only (learn more about keyboard accessibility)
Any UI touched in this PR does not create any new axe failures (run axe in browser: FF, Chrome)
This renders correctly on smaller devices using a responsive layout. (You can test this in your browser)
This was checked for cross-browser compatibility

tsullivan · 2021-07-21T18:54:45Z

The PR still needs additional functional tests and unit tests for the tsx files, but it is ready for review

elasticmachine · 2021-07-21T18:55:29Z

Pinging @elastic/kibana-app-services (Team:AppServices)

elasticmachine · 2021-07-21T18:55:29Z

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

tsullivan · 2021-07-27T21:46:12Z

x-pack/plugins/reporting/common/constants.ts

This const was only used in 1 place, so I took an opportunity to clean up this file by removing the const

tsullivan · 2021-07-27T21:47:05Z

x-pack/plugins/reporting/common/types.ts

This line of code was accidentally added in an earlier PR #88303

tsullivan · 2021-07-27T21:47:49Z

x-pack/plugins/reporting/public/lib/job.tsx

This file has taken a lot of code moved out of report_listing.tsx

tsullivan · 2021-07-27T21:50:16Z

x-pack/plugins/reporting/public/management/index.ts

Making this interface shared since a lot of components that are downstream of ReportListing receive the same props as their parent.

x-pack/plugins/reporting/public/lib/job.tsx

dokmic

LGTM 👍

Co-authored-by: Michael Dokolin <dokmic@gmail.com>

tsullivan · 2021-07-29T17:36:40Z

@elasticmachine merge upstream

kibanamachine · 2021-07-29T19:58:28Z

💚 Build Succeeded

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`reporting`	60	59	-1

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id	before	after	diff
`reporting`	71.2KB	68.4KB	-2.8KB

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id	before	after	diff
`reporting`	59.5KB	64.7KB	+5.1KB

History

💚 Build #141158 succeeded c03c96c
💚 Build #141081 succeeded 807fe0c
💔 Build #140566 failed 93bad17
💔 Build #140531 failed e7c1925
💔 Build #140517 failed 6aa86e0

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

tsullivan · 2021-07-29T20:21:23Z

I will work with @elastic/kibana-docs in a separate issue to make sure they approve the modified text before the 7.15 release. It could be easier to get that review after this is merged.

#107238

…g for deprecated types (elastic#106184) * [Reporting Management] Add warning for deprecated types * record -> job rename * restore previous report from archive * more fn testing * better testing * use consts * add table text test * nicer archived reports archive * fix test * add comment about completed * remove warning button * consistent status detail message and callout buttons * rename the deprecated report * fix status messages * update copy * fix duplicated created_at reports * fix 18n * back out text add * fix fn test snapshot * [Reporting] fix binding of methods that are called via event handlers * self review * spot-fix more untranslated content * Update x-pack/plugins/reporting/public/lib/job.tsx Co-authored-by: Michael Dokolin <dokmic@gmail.com> Co-authored-by: Michael Dokolin <dokmic@gmail.com> Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

…g for deprecated types (#106184) (#107243) * [Reporting Management] Add warning for deprecated types * record -> job rename * restore previous report from archive * more fn testing * better testing * use consts * add table text test * nicer archived reports archive * fix test * add comment about completed * remove warning button * consistent status detail message and callout buttons * rename the deprecated report * fix status messages * update copy * fix duplicated created_at reports * fix 18n * back out text add * fix fn test snapshot * [Reporting] fix binding of methods that are called via event handlers * self review * spot-fix more untranslated content * Update x-pack/plugins/reporting/public/lib/job.tsx Co-authored-by: Michael Dokolin <dokmic@gmail.com> Co-authored-by: Michael Dokolin <dokmic@gmail.com> Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> Co-authored-by: Michael Dokolin <dokmic@gmail.com> Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

gchaps

Minor comments on capitalization and ending period.

gchaps · 2021-08-02T14:55:11Z

x-pack/plugins/reporting/public/lib/job.tsx

+    let smallMessage;
+    if (status === PENDING) {
+      smallMessage = i18n.translate('xpack.reporting.jobStatusDetail.pendingStatusReachedText', {
+        defaultMessage: 'Waiting for job to be processed.',


Waiting for job to process.

gchaps · 2021-08-02T14:57:17Z

x-pack/plugins/reporting/public/lib/job.tsx

+        warnings.push(
+          i18n.translate('xpack.reporting.jobWarning.csvContainsFormulas', {
+            defaultMessage:
+              'Your CSV contains characters which spreadsheet applications can interpret as formulas.',


Your CSV contains characters that spreadsheet applications might interpret as formulas.

gchaps · 2021-08-02T15:04:02Z

x-pack/plugins/reporting/public/management/report_info_button.tsx

+      {
+        title: this.props.intl.formatMessage({
+          id: 'xpack.reporting.listing.infoPanel.createdAtInfo',
+          defaultMessage: 'Created At',


gchaps · 2021-08-02T15:07:34Z

x-pack/plugins/reporting/public/management/report_info_button.tsx

+      {
+        title: this.props.intl.formatMessage({
+          id: 'xpack.reporting.listing.infoPanel.tzInfo',
+          defaultMessage: 'Timezone',


gchaps · 2021-08-02T15:07:58Z

x-pack/plugins/reporting/public/management/report_info_button.tsx

-        title: 'Processed By',
+        title: this.props.intl.formatMessage({
+          id: 'xpack.reporting.listing.infoPanel.startedAtInfo',
+          defaultMessage: 'Started At',


gchaps · 2021-08-02T15:15:19Z

x-pack/plugins/reporting/public/management/report_info_button.tsx


+    let message = this.props.intl.formatMessage({
+      id: 'xpack.reporting.listing.table.reportInfoButtonTooltip',
+      defaultMessage: 'See report info',


Previously this text used the ending period:

See report info and error message.

See report info and warnings.

"See report info" is consistently used without the ending period.

gchaps · 2021-08-02T15:16:21Z

x-pack/plugins/reporting/public/management/report_info_button.tsx

-          calloutTitle: 'Unable to fetch report info',
+          calloutTitle: this.props.intl.formatMessage({
+            id: 'xpack.reporting.listing.table.reportInfoUnableToFetch',
+            defaultMessage: 'Unable to fetch report info',


Ending period?

gchaps · 2021-08-02T15:26:07Z

x-pack/test/functional/apps/reporting_management/report_listing.ts

+            "actions": "",
+            "createdAt": "2021-07-19 @ 10:29 PMtest_user",
+            "report": "Automated reportsearch",
+            "status": "Completed at 2021-07-19 @ 10:29 PMSee report info for warnings.",


Space between PM and "See report info..."

gchaps · 2021-08-02T15:31:25Z

x-pack/plugins/reporting/public/lib/job.tsx

+      if (this.max_size_reached) {
+        warnings.push(
+          i18n.translate('xpack.reporting.jobWarning.maxSizeReachedTooltip', {
+            defaultMessage: 'Max size reached, contains partial data.',


Can you rewrite as something like this:

Your search reached the max size and contains partial data.

gchaps · 2021-08-02T15:32:53Z

x-pack/plugins/reporting/public/lib/reporting_api_client/reporting_api_client.ts

+    }
+
+    return i18n.translate('xpack.reporting.apiClient.unknownError', {
+      defaultMessage: `Report job {job} failed: Unknown error.`,


Report job {job} failed. Error unknown.

…g for deprecated types (elastic#106184) * [Reporting Management] Add warning for deprecated types * record -> job rename * restore previous report from archive * more fn testing * better testing * use consts * add table text test * nicer archived reports archive * fix test * add comment about completed * remove warning button * consistent status detail message and callout buttons * rename the deprecated report * fix status messages * update copy * fix duplicated created_at reports * fix 18n * back out text add * fix fn test snapshot * [Reporting] fix binding of methods that are called via event handlers * self review * spot-fix more untranslated content * Update x-pack/plugins/reporting/public/lib/job.tsx Co-authored-by: Michael Dokolin <dokmic@gmail.com> Co-authored-by: Michael Dokolin <dokmic@gmail.com> Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

tsullivan force-pushed the reporting/csv-100363 branch from d6907ba to 80a3803 Compare July 20, 2021 21:31

tsullivan changed the title ~~[Reporting] Add notices to UI when export type is deprecated~~ [Reporting Management] Consolidate report job warnings and add warning for deprecated types Jul 20, 2021

tsullivan force-pushed the reporting/csv-100363 branch 2 times, most recently from 4474720 to 311174e Compare July 21, 2021 04:08

tsullivan added 2 commits July 20, 2021 21:10

[Reporting Management] Add warning for deprecated types

b1e7d24

record -> job rename

45bff4f

tsullivan force-pushed the reporting/csv-100363 branch from 311174e to 45bff4f Compare July 21, 2021 04:10

tsullivan marked this pull request as ready for review July 21, 2021 18:54

tsullivan added v7.15.0 v8.0.0 zDeprecated Feature:Reporting Use Reporting:Screenshot, Reporting:CSV, or Reporting:Framework instead release_note:enhancement Team:AppServices labels Jul 21, 2021

tsullivan requested review from a team, dokmic and jloleysens July 21, 2021 18:55

tsullivan added 9 commits July 21, 2021 18:04

Merge branch 'master' into reporting/csv-100363

a7c7710

restore previous report from archive

c66def6

more fn testing

95e421f

better testing

fa76459

use consts

798a380

add table text test

8b74628

nicer archived reports archive

099ee58

Merge branch 'master' into reporting/csv-100363

97e0b0e

fix test

4554e25

tsullivan added 4 commits July 23, 2021 08:28

back out text add

93bad17

fix fn test snapshot

fdd832d

Merge branch 'master' into reporting/csv-100363

807fe0c

[Reporting] fix binding of methods that are called via event handlers

284df80

tsullivan marked this pull request as ready for review July 27, 2021 21:16

tsullivan commented Jul 27, 2021

View reviewed changes

self review

a7bf40a

tsullivan force-pushed the reporting/csv-100363 branch from 1016195 to a7bf40a Compare July 27, 2021 21:51

spot-fix more untranslated content

c03c96c

dokmic reviewed Jul 28, 2021

View reviewed changes

x-pack/plugins/reporting/public/lib/job.tsx Outdated Show resolved Hide resolved

dokmic approved these changes Jul 28, 2021

View reviewed changes

Update x-pack/plugins/reporting/public/lib/job.tsx

f0ee8ea

Co-authored-by: Michael Dokolin <dokmic@gmail.com>

Merge branch 'master' into reporting/csv-100363

78cacf7

tsullivan mentioned this pull request Jul 29, 2021

[Reporting/Docs] Review the content changes made in #106184 #107238

Closed

tsullivan merged commit 191480a into elastic:master Jul 29, 2021

tsullivan mentioned this pull request Jul 29, 2021

[7.x] [Reporting Management] Consolidate report job warnings and add warning for deprecated types (#106184) #107243

Merged

tsullivan deleted the reporting/csv-100363 branch July 29, 2021 21:55

dokmic mentioned this pull request Jul 30, 2021

Reporting: Generating report for large dashboard fails #106873

Closed

gchaps reviewed Aug 2, 2021

View reviewed changes

This was referenced Aug 10, 2021

[Reporting] implement content changes per feedback #108068

Merged

[Reporting] Guide users to the new CSV export type #102833

Closed

Conversation

tsullivan commented Jul 19, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Release note:

List of changes:

How to test with the updated archived reports

Screenshots

Checklist

Uh oh!

tsullivan commented Jul 21, 2021

Uh oh!

elasticmachine commented Jul 21, 2021

Uh oh!

elasticmachine commented Jul 21, 2021

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

dokmic left a comment

Choose a reason for hiding this comment

Uh oh!

tsullivan commented Jul 29, 2021

Uh oh!

kibanamachine commented Jul 29, 2021

💚 Build Succeeded

Metrics [docs]

Module Count

Async chunks

Page load bundle

History

Uh oh!

tsullivan commented Jul 29, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

gchaps left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

tsullivan commented Jul 19, 2021 •

edited

Loading

tsullivan commented Jul 29, 2021 •

edited

Loading