[Reporting] fix dashboard "Copy Post URL" action #192530

tsullivan · 2024-09-10T22:21:26Z

Summary

Closes #191673
Closes #183566

Fixes the ability for the POST URL used to automate generation of reports by adding a generateExportUrl function to the ShareMenuItemV2 interface. This function returns a dynamic export URL for PDF generation by using the selected layout option.

Other changes: provides more strictness in type definitions by:

splitting the types that define ShareMenuProvider:
- ShareMenuProviderV2 provides the getShareMenuItems function
- ShareMenuProviderLegacy provides the getShareMenuItemsLegacy function

Release note

Fixed an issue with the export options for PNG/PDF reports in a dashboard.

Checklist

Delete any items that are not applicable to this PR.

Use the generateExportUrl function inputs to return a POST URL that is aware of the layout mode (print or preserve_layout) and screen dimensions
Unit or functional tests were updated or added to match the most common scenarios
Flaky test runner: https://buildkite.com/elastic/kibana-flaky-test-suite-runner/builds/6986

tsullivan · 2024-09-18T22:29:13Z

packages/kbn-reporting/public/share/share_context_menu/register_pdf_png_modal_reporting.tsx

 */
-export const reportingScreenshotShareProvider = ({


The Canvas integration doesn't use this export, and doesn't use the Sharing services for its menu. See x-pack/plugins/canvas/public/components/workpad_header/share_menu/share_menu.tsx

tsullivan · 2024-09-18T22:37:59Z

src/plugins/share/public/types.ts

+interface ShareMenuProviderLegacy {
+  readonly id: string;
+  getShareMenuItemsLegacy: (context: ShareContext) => ShareMenuItemLegacy[];
+}


After untangling ShareMenuItemLegacy from this area of code, it appears that nothing is actually using the legacy interface except for example code and test code. This should probably be cleaned up in a later PR.

kibanamachine · 2024-09-20T02:07:17Z

Flaky Test Runner Stats

🎉 All tests passed! - kibana-flaky-test-suite-runner#6986

[✅] x-pack/test/functional/apps/dashboard/group3/config.ts: 50/50 tests passed.

see run history

eokoneyo · 2024-10-04T09:23:03Z

packages/kbn-reporting/public/share/share_context_menu/register_pdf_png_modal_reporting.tsx

+  const el = document.querySelector('[data-shared-items-container]');
+  const { height, width } = el ? el.getBoundingClientRect() : { height: 768, width: 1024 };
+  const dimensions = { height, width };
+  const layoutId = optimizedForPrinting ? ('print' as const) : ('preserve_layout' as const);
+  const layout = { id: layoutId, dimensions };
+  const baseParams = { objectType, layout, title };


Thanks for consolidating this logic!

eokoneyo · 2024-10-04T09:30:38Z

src/plugins/share/public/services/share_menu_registry.ts

@@ -36,7 +36,7 @@ export class ShareMenuRegistry {
    return {
      getShareMenuItems: (context: ShareContext) =>
        Array.from(this.shareMenuProviders.values()).flatMap((shareActionProvider) =>
-          shareActionProvider.getShareMenuItems(context)
+          (shareActionProvider as ShareMenuProviderV2).getShareMenuItems(context)


This causes an error to be thrown when kibana is started with the --run-examples arg in dev, because the share menu of the demo plugin is registered to be retrieved using getShareMenuItemsLegacy, So maybe the following would be more appropriate

Suggested change

(shareActionProvider as ShareMenuProviderV2).getShareMenuItems(context)

(shareActionProvider.getShareMenuItems ?? shareActionProvider.getShareMenuItemsLegacy).call(shareActionProvider, context)

this way we are inclusive of the fact that some menu item might be defined still using the legacy method

@eokoneyo I've made a change that addresses the error: 5b0952f

Unfortunately, registering menu items is broken in Kibana. It looks like this was last working in 8.13

…gacy method

kibana-ci · 2024-10-05T00:04:42Z

💚 Build Succeeded

Buildkite Build
Commit: 5b0952f

Metrics [docs]

Public APIs missing comments

Total count of every public API that lacks a comment. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats comments for more detailed information.

id	before	after	diff
`@kbn/reporting-public`	107	106	-1
`share`	60	72	+12
total			+11

Public APIs missing exports

Total count of every type that is part of your API that should be exported but is not. This will cause broken links in the API documentation system. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats exports for more detailed information.

id	before	after	diff
`share`	12	15	+3

Page load bundle

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

id	before	after	diff
`reporting`	53.4KB	53.3KB	-170.0B
`share`	57.0KB	57.1KB	+144.0B
total			-26.0B

Unknown metric groups

API count

id	before	after	diff
`share`	121	135	+14

References to deprecated APIs

id	before	after	diff
`@kbn/reporting-public`	2	1	-1

History

💚 Build #238577 succeeded b3b707e
💛 Build #235807 was flaky 76a0386
💛 Build #235425 was flaky 3f98ee0
💔 Build #235420 failed 3b32e07
💛 Build #233602 was flaky 5375442
💔 Build #233278 failed 2df967c

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

eokoneyo

Tested locally, code also LGTM

kibanamachine · 2024-10-07T23:54:43Z

Starting backport for target branches: 8.15, 8.x

https://github.com/elastic/kibana/actions/runs/11225905491

elasticmachine · 2024-10-07T23:54:44Z

💚 Build Succeeded

Buildkite Build
Commit: 6c1e7ea

Metrics [docs]

Public APIs missing comments

Total count of every public API that lacks a comment. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats comments for more detailed information.

id	before	after	diff
`@kbn/reporting-public`	107	106	-1
`share`	60	72	+12
total			+11

Public APIs missing exports

Total count of every type that is part of your API that should be exported but is not. This will cause broken links in the API documentation system. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats exports for more detailed information.

id	before	after	diff
`share`	12	15	+3

Page load bundle

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

id	before	after	diff
`reporting`	53.4KB	53.3KB	-170.0B
`share`	57.0KB	57.1KB	+144.0B
total			-26.0B

Unknown metric groups

API count

id	before	after	diff
`share`	121	135	+14

References to deprecated APIs

id	before	after	diff
`@kbn/reporting-public`	2	1	-1

## Summary Closes elastic#191673 Closes elastic#183566 Fixes the ability for the POST URL used to automate generation of reports by adding a `generateExportUrl` function to the ShareMenuItemV2 interface. This function returns a dynamic export URL for PDF generation by using the selected layout option. Other changes: provides more strictness in type definitions by: * splitting the types that define `ShareMenuProvider`: * `ShareMenuProviderV2` provides the `getShareMenuItems` function * `ShareMenuProviderLegacy` provides the `getShareMenuItemsLegacy` function ### Release note Fixed an issue with the export options for PNG/PDF reports in a dashboard. ### Checklist Delete any items that are not applicable to this PR. - [x] Use the `generateExportUrl` function inputs to return a POST URL that is aware of the layout mode (`print` or `preserve_layout`) and screen dimensions - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios - [x] Flaky test runner: https://buildkite.com/elastic/kibana-flaky-test-suite-runner/builds/6986 (cherry picked from commit 38407ae)

kibanamachine · 2024-10-07T23:59:32Z

💔 Some backports could not be created

Status	Branch	Result
❌	8.15	Backport failed because of merge conflicts
✅	8.x

Note: Successful backport PRs will be merged automatically after passing CI.

Manual backport

To create the backport manually run:

node scripts/backport --pr 192530

Questions ?

Please refer to the Backport tool documentation

…2530) (#195334) # Backport This will backport the following commits from `main` to `8.x`: - [[Reporting] fix dashboard "Copy Post URL" action (#192530)](#192530)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport)  Co-authored-by: Tim Sullivan <[email protected]>

tsullivan · 2024-10-18T16:57:34Z

💚 All backports created successfully

Status	Branch	Result
✅	8.15

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

## Summary Closes elastic#191673 Closes elastic#183566 Fixes the ability for the POST URL used to automate generation of reports by adding a `generateExportUrl` function to the ShareMenuItemV2 interface. This function returns a dynamic export URL for PDF generation by using the selected layout option. Other changes: provides more strictness in type definitions by: * splitting the types that define `ShareMenuProvider`: * `ShareMenuProviderV2` provides the `getShareMenuItems` function * `ShareMenuProviderLegacy` provides the `getShareMenuItemsLegacy` function ### Release note Fixed an issue with the export options for PNG/PDF reports in a dashboard. ### Checklist Delete any items that are not applicable to this PR. - [x] Use the `generateExportUrl` function inputs to return a POST URL that is aware of the layout mode (`print` or `preserve_layout`) and screen dimensions - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios - [x] Flaky test runner: https://buildkite.com/elastic/kibana-flaky-test-suite-runner/builds/6986 (cherry picked from commit 38407ae) # Conflicts: # src/plugins/share/public/components/share_tabs.test.tsx # src/plugins/share/public/services/share_menu_manager.tsx

tsullivan force-pushed the fix/share-menu-items-add-generate-url-function branch 2 times, most recently from a75979a to 9b9d2d1 Compare September 11, 2024 04:38

tsullivan changed the title ~~Fix/share menu items add generate url function~~ [Reporting] fix dashboard "Copy Post URL" action Sep 11, 2024

tsullivan force-pushed the fix/share-menu-items-add-generate-url-function branch from 5375442 to 5f6a531 Compare September 18, 2024 20:11

tsullivan commented Sep 18, 2024

View reviewed changes

tsullivan added v8.16.0 backport:version Backport to applied version labels v8.15.2 labels Sep 19, 2024

tsullivan added 17 commits September 19, 2024 17:24

Link to re-opened skipped test issue

c30a593

Add getShareMenuItemsLegacy to ShareMenuProvider

5433322

Add generateExportUrl

aa7d3b4

Ensure ShareMenuItemV2

2b12a8c

cleanup: use a discriminatory type for ShareMenuProvider

cbc09c9

Remove console.log

c265fb4

Declare relative path variables within the generateExportUrl functions

d057a37

Fixme comment

5d33128

Comment

375f0f9

JobParamsProviderLayoutOptions

e58bc38

Cleanup diff

79f5097

ScreenshotExportOpts

9d5531e

Implement the generateExportUrl functions

9946a74

Remove unused menu export option

85e8e47

fix i18n check

2996866

Add functional tests for COPY POST URL button

bf7a09c

unskip flaky test

76a0386

tsullivan force-pushed the fix/share-menu-items-add-generate-url-function branch from 3f98ee0 to 76a0386 Compare September 20, 2024 00:42

tsullivan marked this pull request as ready for review September 20, 2024 02:28

tsullivan requested a review from a team as a code owner September 20, 2024 02:28

nickofthyme approved these changes Sep 20, 2024

View reviewed changes

tsullivan added the release_note:fix label Sep 20, 2024

Merge branch 'main' into fix/share-menu-items-add-generate-url-function

b3b707e

tsullivan requested a review from eokoneyo October 3, 2024 15:46

eokoneyo requested changes Oct 4, 2024

View reviewed changes

tsullivan added 2 commits October 4, 2024 14:26

Merge branch 'main' into fix/share-menu-items-add-generate-url-function

bc88a3d

Handle the fact that some menu item may still be defined using the le…

5b0952f

…gacy method

tsullivan requested a review from eokoneyo October 4, 2024 22:46

eokoneyo approved these changes Oct 7, 2024

View reviewed changes

Merge branch 'main' into fix/share-menu-items-add-generate-url-function

6c1e7ea

tsullivan enabled auto-merge (squash) October 7, 2024 22:32

tsullivan merged commit 38407ae into elastic:main Oct 7, 2024
21 checks passed

kibanamachine added the v9.0.0 label Oct 7, 2024

kibanamachine mentioned this pull request Oct 7, 2024

[8.x] [Reporting] fix dashboard "Copy Post URL" action (#192530) #195334

Merged

tsullivan deleted the fix/share-menu-items-add-generate-url-function branch October 18, 2024 16:44

tsullivan mentioned this pull request Oct 18, 2024

[8.15] [Reporting] fix dashboard "Copy Post URL" action (#192530) #196928

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Reporting] fix dashboard "Copy Post URL" action #192530

[Reporting] fix dashboard "Copy Post URL" action #192530

tsullivan commented Sep 10, 2024 •

edited by kibanamachine

Loading

tsullivan Sep 18, 2024 •

edited

Loading

tsullivan Sep 18, 2024

kibanamachine commented Sep 20, 2024

eokoneyo Oct 4, 2024

eokoneyo Oct 4, 2024

tsullivan Oct 4, 2024 •

edited

Loading

kibana-ci commented Oct 5, 2024

API count

References to deprecated APIs

eokoneyo left a comment

kibanamachine commented Oct 7, 2024

elasticmachine commented Oct 7, 2024

API count

References to deprecated APIs

kibanamachine commented Oct 7, 2024

tsullivan commented Oct 18, 2024

	(shareActionProvider as ShareMenuProviderV2).getShareMenuItems(context)
	(shareActionProvider.getShareMenuItems ?? shareActionProvider.getShareMenuItemsLegacy).call(shareActionProvider, context)

[Reporting] fix dashboard "Copy Post URL" action #192530

[Reporting] fix dashboard "Copy Post URL" action #192530

Conversation

tsullivan commented Sep 10, 2024 • edited by kibanamachine Loading

Summary

Release note

Checklist

tsullivan Sep 18, 2024 • edited Loading

Choose a reason for hiding this comment

tsullivan Sep 18, 2024

Choose a reason for hiding this comment

kibanamachine commented Sep 20, 2024

Flaky Test Runner Stats

🎉 All tests passed! - kibana-flaky-test-suite-runner#6986

eokoneyo Oct 4, 2024

Choose a reason for hiding this comment

eokoneyo Oct 4, 2024

Choose a reason for hiding this comment

tsullivan Oct 4, 2024 • edited Loading

Choose a reason for hiding this comment

kibana-ci commented Oct 5, 2024

💚 Build Succeeded

Metrics [docs]

Public APIs missing comments

Public APIs missing exports

Page load bundle

API count

References to deprecated APIs

History

eokoneyo left a comment

Choose a reason for hiding this comment

kibanamachine commented Oct 7, 2024

elasticmachine commented Oct 7, 2024

💚 Build Succeeded

Metrics [docs]

Public APIs missing comments

Public APIs missing exports

Page load bundle

API count

References to deprecated APIs

kibanamachine commented Oct 7, 2024

💔 Some backports could not be created

Manual backport

Questions ?

tsullivan commented Oct 18, 2024

💚 All backports created successfully

Questions ?

tsullivan commented Sep 10, 2024 •

edited by kibanamachine

Loading

tsullivan Sep 18, 2024 •

edited

Loading

tsullivan Oct 4, 2024 •

edited

Loading