[Reporting] Restore legacy compatibility shim for PDF job creation #108271

tsullivan · 2021-08-11T20:00:19Z

This PR reverts a breaking change Reporting had in the master branch, but not 7.x. This is a low-risk PR: when it is backported to 7.x it will largely be clean-up since logic already exists there, but uses JS not TypeScript.

7.x versions have a "compatibility shim" that gives support for POST URLs that were copied in Kibana 6.2 and below. This shim was removed from the master branch in fef8485 as a way to ease the TypeScript conversion of export types and improve maintainability. New initiatives emphasize a more careful approach to removing support for deprecated features. Before removing this support we will collect telemetry to understand the impact to users.

This PR restores the behavior from 7.x, which is to fully support a URL that was copied in Kibana 6.2.4 or below.

Testing

Start a cluster with Elasticsearch and Kibana version 6.2.4
Import data and create a visualization. Save the visualization and copy the POST URL from the Reporting menu
Confirm that the POST URL has a savedObjectId parameter, and not a relativeUrls parameter
Upgrade the cluster to 7.14.0.
- Note that the POST URL copied in 6.2.4 still works
Upgrading to 8.0 can be tricky, because the existence of system indices that were created in 6.2.4 will not allow ES 8.0 to run. To ease testing, I did the following:
1. Export all of the Kibana saved objects
2. Start a new ES using the latest 8.0-snapshot, and Kibana running this branch of Kibana.
3. Import the original test data and the saved objects that were exported in 7.14.
Confirm that the POST URL copied in 6.2.4 still works.
Confirm that the job listing shows an appropriate warning:

Resources:
Docker-compose config: https://gist.github.com/tsullivan/07ce488527265e9ddbdb5f0e7f5df13e
Test data to import: https://gist.github.com/tsullivan/1f999db105499e553aee020ab21c1e9b
Example saved objects: https://gist.github.com/tsullivan/9247922158b077c449415bc429ff5e7e
Script to fire post url: https://gist.github.com/tsullivan/0b86d5e1165f6460a876b4f63012fdd0

tsullivan · 2021-08-13T20:33:43Z

x-pack/plugins/reporting/server/export_types/printable_pdf/types.d.ts

+export interface TaskPayloadPDF extends BasePayload {
+  layout: LayoutParams;
+  forceNow?: string;
+  objects: Array<{ relativeUrl: string }>;


Note, previously in the master branch, this TaskPayloadPDF field was called relativeUrls, which matches the interface data in the incoming BaseParamsPDF data. This was done to ease TypeScript conversion of the PDF export type: the compatibility shim was not converted into TypeScript until now.

tsullivan · 2021-08-13T20:34:49Z

x-pack/plugins/reporting/server/export_types/printable_pdf/create_job/compatibility_shim.ts

+ * 2.0.
+ */
+
+import type { KibanaRequest } from 'kibana/server';


This file was restored and re-written from this source: https://github.com/elastic/kibana/blob/57af846/x-pack/plugins/reporting/server/export_types/printable_pdf/create_job/compatibility_shim.js

tsullivan · 2021-08-13T20:35:32Z

x-pack/plugins/reporting/server/export_types/common/get_full_urls.test.ts

@@ -28,7 +28,7 @@ const getMockJob = (base: object) => base as TaskPayloadPNG & TaskPayloadPDF;
 test(`fails if no URL is passed`, async () => {
  const fn = () => getFullUrls(mockConfig, getMockJob({}));
  expect(fn).toThrowErrorMatchingInlineSnapshot(
-    `"No valid URL fields found in Job Params! Expected \`job.relativeUrl: string\` or \`job.relativeUrls: string[]\`"`
+    `"No valid URL fields found in Job Params! Expected \`job.relativeUrl\` or \`job.objects[{ relativeUrl }]\`"`


See https://github.com/elastic/kibana/pull/108271/files#r688766347

Restore the legacy shim for PDF job creation from the 7.x branch.

tsullivan · 2021-08-13T20:42:26Z

x-pack/plugins/reporting/server/export_types/common/validate_urls.ts

+      throw new Error('Invalid Relative URL in relativeUrls. String is expected.');
+    }
+  });
+


Factored this out of the compatibility shim: https://github.com/elastic/kibana/blob/57af846/x-pack/plugins/reporting/server/export_types/printable_pdf/create_job/compatibility_shim.js#L67

elasticmachine · 2021-08-14T00:51:40Z

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

elasticmachine · 2021-08-14T00:51:40Z

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

tsullivan · 2021-08-14T00:51:58Z

@elasticmachine merge upstream

…ity-shim

tsullivan · 2021-08-14T00:53:27Z

x-pack/plugins/reporting/server/export_types/printable_pdf/create_job/compatibility_shim.ts

+        }
+      }
+
+      isDeprecated = true;


After https://github.com/elastic/kibana/pull/108614/files, we can collect telemetry for any export type that has this flag set to true in the job payload.

tsullivan · 2021-08-16T14:57:53Z

@elasticmachine merge upstream

…ity-shim

jloleysens

Code changes look good to me! I tested and the compatibility shim seems to work as expected.

…ity-shim

kibanamachine · 2021-08-17T19:45:32Z

💚 Build Succeeded

Metrics [docs]

✅ unchanged

History

💚 Build #145748 succeeded 1a95fe5
💚 Build #145454 succeeded e37d0b3
💛 Build #145410 was flaky 0007a27
💚 Build #145392 succeeded f455996498d7eaaed80116ad8f90cbe08ca4678b
💔 Build #145377 failed cc6c7c95d49265a65589778a85ec49857c60fd5f

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

kibanamachine · 2021-08-19T19:47:06Z

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create backports run node scripts/backport --pr 108271 or prevent reminders by adding the backport:skip label.

kibanamachine · 2021-08-20T19:57:06Z

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create backports run node scripts/backport --pr 108271 or prevent reminders by adding the backport:skip label.

kibanamachine · 2021-08-23T19:57:23Z

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create backports run node scripts/backport --pr 108271 or prevent reminders by adding the backport:skip label.

tsullivan · 2021-08-24T18:24:59Z

This PR was effectively backported in #108979

tsullivan force-pushed the reporting/restore-pdf-createjob-compatibility-shim branch 9 times, most recently from 52360d9 to cc6c7c9 Compare August 13, 2021 17:08

tsullivan mentioned this pull request Aug 13, 2021

[Reporting] Add telemetry for deprecated export type usage #105868

Closed

tsullivan force-pushed the reporting/restore-pdf-createjob-compatibility-shim branch from cc6c7c9 to f455996 Compare August 13, 2021 20:17

tsullivan commented Aug 13, 2021

View reviewed changes

restore legacy shim

6c4d699

Restore the legacy shim for PDF job creation from the 7.x branch.

tsullivan commented Aug 13, 2021

View reviewed changes

strip relativeUrls from pdf payload

0007a27

tsullivan force-pushed the reporting/restore-pdf-createjob-compatibility-shim branch from f455996 to 0007a27 Compare August 13, 2021 21:29

tsullivan marked this pull request as ready for review August 14, 2021 00:50

tsullivan added release_note:skip Skip the PR/issue when compiling release notes Team:AppServices v7.15.0 v8.0.0 labels Aug 14, 2021

Merge branch 'master' into reporting/restore-pdf-createjob-compatibil…

e37d0b3

…ity-shim

tsullivan requested review from jloleysens and dokmic August 14, 2021 00:52

tsullivan requested review from stacey-gammon and ppisljar August 14, 2021 00:52

tsullivan commented Aug 14, 2021

View reviewed changes

Merge branch 'master' into reporting/restore-pdf-createjob-compatibil…

1a95fe5

…ity-shim

jloleysens reviewed Aug 16, 2021

View reviewed changes

jloleysens approved these changes Aug 16, 2021

View reviewed changes

Merge branch 'master' into reporting/restore-pdf-createjob-compatibil…

497f375

…ity-shim

tsullivan enabled auto-merge (squash) August 17, 2021 18:54

tsullivan mentioned this pull request Aug 17, 2021

[Reporting] Restore legacy compatibility shim for PDF job creation - 7.15 backport/cleanup #108979

Merged

tsullivan merged commit 468daeb into elastic:master Aug 17, 2021

tsullivan deleted the reporting/restore-pdf-createjob-compatibility-shim branch August 17, 2021 20:01

kibanamachine added the backport missing Added to PRs automatically when the are determined to be missing a backport. label Aug 19, 2021

tsullivan added the backport:skip This commit does not require backporting label Aug 24, 2021

kibanamachine removed the backport missing Added to PRs automatically when the are determined to be missing a backport. label Aug 24, 2021

tsullivan mentioned this pull request Sep 20, 2021

Reporting: Failing test: X-Pack Reporting API Integration Tests.x-pack/test/reporting_api_integration/reporting_and_security/bwc_generation_urls·ts - Reporting APIs BWC report generation urls 6_2 multiple jobs posted #93891

Closed

sophiec20 added the (Deprecated) Feature:Reporting Use Reporting:Screenshot, Reporting:CSV, or Reporting:Framework instead label Aug 21, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Reporting] Restore legacy compatibility shim for PDF job creation #108271

[Reporting] Restore legacy compatibility shim for PDF job creation #108271

tsullivan commented Aug 11, 2021 •

edited

Loading

tsullivan Aug 13, 2021

tsullivan Aug 13, 2021

tsullivan Aug 13, 2021

tsullivan Aug 13, 2021

elasticmachine commented Aug 14, 2021

elasticmachine commented Aug 14, 2021

tsullivan commented Aug 14, 2021

tsullivan Aug 14, 2021

tsullivan commented Aug 16, 2021

jloleysens left a comment

kibanamachine commented Aug 17, 2021

kibanamachine commented Aug 19, 2021

kibanamachine commented Aug 20, 2021

kibanamachine commented Aug 23, 2021

tsullivan commented Aug 24, 2021

[Reporting] Restore legacy compatibility shim for PDF job creation #108271

[Reporting] Restore legacy compatibility shim for PDF job creation #108271

Conversation

tsullivan commented Aug 11, 2021 • edited Loading

Testing

tsullivan Aug 13, 2021

Choose a reason for hiding this comment

tsullivan Aug 13, 2021

Choose a reason for hiding this comment

tsullivan Aug 13, 2021

Choose a reason for hiding this comment

tsullivan Aug 13, 2021

Choose a reason for hiding this comment

elasticmachine commented Aug 14, 2021

elasticmachine commented Aug 14, 2021

tsullivan commented Aug 14, 2021

tsullivan Aug 14, 2021

Choose a reason for hiding this comment

tsullivan commented Aug 16, 2021

jloleysens left a comment

Choose a reason for hiding this comment

kibanamachine commented Aug 17, 2021

💚 Build Succeeded

Metrics [docs]

History

kibanamachine commented Aug 19, 2021

kibanamachine commented Aug 20, 2021

kibanamachine commented Aug 23, 2021

tsullivan commented Aug 24, 2021

tsullivan commented Aug 11, 2021 •

edited

Loading