[8.x] [Reporting] fix dashboard "Copy Post URL" action (#192530) #195334
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
## 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)
3 tasks
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
💚 Build Succeeded
Metrics [docs]Public APIs missing comments
Public APIs missing exports
Page load bundle
Unknown metric groupsAPI count
References to deprecated APIs
cc @tsullivan |
tsullivan
added a commit
that referenced
this pull request
Oct 22, 2024
…96928) # Backport This will backport the following commits from `main` to `8.15`: - [[Reporting] fix dashboard "Copy Post URL" action (#192530)](#192530) <!--- Backport version: 8.9.8 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport) <!--BACKPORT [{"author":{"name":"Tim Sullivan","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-10-07T23:54:21Z","message":"[Reporting] fix dashboard \"Copy Post URL\" action (#192530)\n\n## Summary\r\n\r\nCloses https://github.com/elastic/kibana/issues/191673\r\nCloses https://github.com/elastic/kibana/issues/183566\r\n\r\nFixes the ability for the POST URL used to automate generation of\r\nreports by adding a `generateExportUrl` function to the ShareMenuItemV2\r\ninterface. This function returns a dynamic export URL for PDF generation\r\nby using the selected layout option.\r\n\r\nOther changes: provides more strictness in type definitions by:\r\n * splitting the types that define `ShareMenuProvider`:\r\n * `ShareMenuProviderV2` provides the `getShareMenuItems` function\r\n* `ShareMenuProviderLegacy` provides the `getShareMenuItemsLegacy`\r\nfunction\r\n\r\n### Release note\r\nFixed an issue with the export options for PNG/PDF reports in a\r\ndashboard.\r\n\r\n### Checklist\r\n\r\nDelete any items that are not applicable to this PR.\r\n\r\n- [x] Use the `generateExportUrl` function inputs to return a POST URL\r\nthat is aware of the layout mode (`print` or `preserve_layout`) and\r\nscreen dimensions\r\n- [x] [Unit or functional\r\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\r\nwere updated or added to match the most common scenarios\r\n- [x] Flaky test runner:\r\nhttps://buildkite.com/elastic/kibana-flaky-test-suite-runner/builds/6986","sha":"38407ae6b01e071757083fe358116b6dd75c4422","branchLabelMapping":{"^v9.0.0$":"main","^v8.16.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:fix","v9.0.0","v8.16.0","backport:version","v8.15.2"],"number":192530,"url":"https://github.com/elastic/kibana/pull/192530","mergeCommit":{"message":"[Reporting] fix dashboard \"Copy Post URL\" action (#192530)\n\n## Summary\r\n\r\nCloses https://github.com/elastic/kibana/issues/191673\r\nCloses https://github.com/elastic/kibana/issues/183566\r\n\r\nFixes the ability for the POST URL used to automate generation of\r\nreports by adding a `generateExportUrl` function to the ShareMenuItemV2\r\ninterface. This function returns a dynamic export URL for PDF generation\r\nby using the selected layout option.\r\n\r\nOther changes: provides more strictness in type definitions by:\r\n * splitting the types that define `ShareMenuProvider`:\r\n * `ShareMenuProviderV2` provides the `getShareMenuItems` function\r\n* `ShareMenuProviderLegacy` provides the `getShareMenuItemsLegacy`\r\nfunction\r\n\r\n### Release note\r\nFixed an issue with the export options for PNG/PDF reports in a\r\ndashboard.\r\n\r\n### Checklist\r\n\r\nDelete any items that are not applicable to this PR.\r\n\r\n- [x] Use the `generateExportUrl` function inputs to return a POST URL\r\nthat is aware of the layout mode (`print` or `preserve_layout`) and\r\nscreen dimensions\r\n- [x] [Unit or functional\r\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\r\nwere updated or added to match the most common scenarios\r\n- [x] Flaky test runner:\r\nhttps://buildkite.com/elastic/kibana-flaky-test-suite-runner/builds/6986","sha":"38407ae6b01e071757083fe358116b6dd75c4422"}},"sourceBranch":"main","suggestedTargetBranches":["8.15"],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","labelRegex":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/192530","number":192530,"mergeCommit":{"message":"[Reporting] fix dashboard \"Copy Post URL\" action (#192530)\n\n## Summary\r\n\r\nCloses https://github.com/elastic/kibana/issues/191673\r\nCloses https://github.com/elastic/kibana/issues/183566\r\n\r\nFixes the ability for the POST URL used to automate generation of\r\nreports by adding a `generateExportUrl` function to the ShareMenuItemV2\r\ninterface. This function returns a dynamic export URL for PDF generation\r\nby using the selected layout option.\r\n\r\nOther changes: provides more strictness in type definitions by:\r\n * splitting the types that define `ShareMenuProvider`:\r\n * `ShareMenuProviderV2` provides the `getShareMenuItems` function\r\n* `ShareMenuProviderLegacy` provides the `getShareMenuItemsLegacy`\r\nfunction\r\n\r\n### Release note\r\nFixed an issue with the export options for PNG/PDF reports in a\r\ndashboard.\r\n\r\n### Checklist\r\n\r\nDelete any items that are not applicable to this PR.\r\n\r\n- [x] Use the `generateExportUrl` function inputs to return a POST URL\r\nthat is aware of the layout mode (`print` or `preserve_layout`) and\r\nscreen dimensions\r\n- [x] [Unit or functional\r\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\r\nwere updated or added to match the most common scenarios\r\n- [x] Flaky test runner:\r\nhttps://buildkite.com/elastic/kibana-flaky-test-suite-runner/builds/6986","sha":"38407ae6b01e071757083fe358116b6dd75c4422"}},{"branch":"8.x","label":"v8.16.0","labelRegex":"^v8.16.0$","isSourceBranch":false,"url":"https://github.com/elastic/kibana/pull/195334","number":195334,"state":"MERGED","mergeCommit":{"sha":"c6cb2f710e58fb2ea3908735d27653602fdf16ec","message":"[8.x] [Reporting] fix dashboard "Copy Post URL" action (#192530) (#195334)\n\n# Backport\n\nThis will backport the following commits from `main` to `8.x`:\n- [[Reporting] fix dashboard "Copy Post URL" action\n(#192530)](https://github.com/elastic/kibana/pull/192530)\n\n<!--- Backport version: 9.4.3 -->\n\n### Questions ?\nPlease refer to the [Backport tool\ndocumentation](https://github.com/sqren/backport)\n\n<!--BACKPORT [{\"author\":{\"name\":\"Tim\nSullivan\",\"email\":\"[email protected]\"},\"sourceCommit\":{\"committedDate\":\"2024-10-07T23:54:21Z\",\"message\":\"[Reporting]\nfix dashboard \\\"Copy Post URL\\\" action (#192530)\\n\\n##\nSummary\\r\\n\\r\\nCloses\nhttps://github.com//issues/191673\\r\\nCloses\nhttps://github.com//issues/183566\\r\\n\\r\\nFixes the ability\nfor the POST URL used to automate generation of\\r\\nreports by adding a\n`generateExportUrl` function to the ShareMenuItemV2\\r\\ninterface. This\nfunction returns a dynamic export URL for PDF generation\\r\\nby using the\nselected layout option.\\r\\n\\r\\nOther changes: provides more strictness\nin type definitions by:\\r\\n * splitting the types that define\n`ShareMenuProvider`:\\r\\n * `ShareMenuProviderV2` provides the\n`getShareMenuItems` function\\r\\n* `ShareMenuProviderLegacy` provides the\n`getShareMenuItemsLegacy`\\r\\nfunction\\r\\n\\r\\n### Release note\\r\\nFixed\nan issue with the export options for PNG/PDF reports in\na\\r\\ndashboard.\\r\\n\\r\\n### Checklist\\r\\n\\r\\nDelete any items that are\nnot applicable to this PR.\\r\\n\\r\\n- [x] Use the `generateExportUrl`\nfunction inputs to return a POST URL\\r\\nthat is aware of the layout mode\n(`print` or `preserve_layout`) and\\r\\nscreen dimensions\\r\\n- [x] [Unit\nor\nfunctional\\r\\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\\r\\nwere\nupdated or added to match the most common scenarios\\r\\n- [x] Flaky test\nrunner:\\r\\nhttps://buildkite.com/elastic/kibana-flaky-test-suite-runner/builds/6986\",\"sha\":\"38407ae6b01e071757083fe358116b6dd75c4422\",\"branchLabelMapping\":{\"^v9.0.0$\":\"main\",\"^v8.16.0$\":\"8.x\",\"^v(\\\\d+).(\\\\d+).\\\\d+$\":\"$1.$2\"}},\"sourcePullRequest\":{\"labels\":[\"release_note:fix\",\"v9.0.0\",\"v8.16.0\",\"backport:version\",\"v8.15.2\"],\"title\":\"[Reporting]\nfix dashboard \\\"Copy Post URL\\\"\naction\",\"number\":192530,\"url\":\"https://github.com/elastic/kibana/pull/192530\",\"mergeCommit\":{\"message\":\"[Reporting]\nfix dashboard \\\"Copy Post URL\\\" action (#192530)\\n\\n##\nSummary\\r\\n\\r\\nCloses\nhttps://github.com//issues/191673\\r\\nCloses\nhttps://github.com//issues/183566\\r\\n\\r\\nFixes the ability\nfor the POST URL used to automate generation of\\r\\nreports by adding a\n`generateExportUrl` function to the ShareMenuItemV2\\r\\ninterface. This\nfunction returns a dynamic export URL for PDF generation\\r\\nby using the\nselected layout option.\\r\\n\\r\\nOther changes: provides more strictness\nin type definitions by:\\r\\n * splitting the types that define\n`ShareMenuProvider`:\\r\\n * `ShareMenuProviderV2` provides the\n`getShareMenuItems` function\\r\\n* `ShareMenuProviderLegacy` provides the\n`getShareMenuItemsLegacy`\\r\\nfunction\\r\\n\\r\\n### Release note\\r\\nFixed\nan issue with the export options for PNG/PDF reports in\na\\r\\ndashboard.\\r\\n\\r\\n### Checklist\\r\\n\\r\\nDelete any items that are\nnot applicable to this PR.\\r\\n\\r\\n- [x] Use the `generateExportUrl`\nfunction inputs to return a POST URL\\r\\nthat is aware of the layout mode\n(`print` or `preserve_layout`) and\\r\\nscreen dimensions\\r\\n- [x] [Unit\nor\nfunctional\\r\\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\\r\\nwere\nupdated or added to match the most common scenarios\\r\\n- [x] Flaky test\nrunner:\\r\\nhttps://buildkite.com/elastic/kibana-flaky-test-suite-runner/builds/6986\",\"sha\":\"38407ae6b01e071757083fe358116b6dd75c4422\"}},\"sourceBranch\":\"main\",\"suggestedTargetBranches\":[\"8.x\",\"8.15\"],\"targetPullRequestStates\":[{\"branch\":\"main\",\"label\":\"v9.0.0\",\"branchLabelMappingKey\":\"^v9.0.0$\",\"isSourceBranch\":true,\"state\":\"MERGED\",\"url\":\"https://github.com/elastic/kibana/pull/192530\",\"number\":192530,\"mergeCommit\":{\"message\":\"[Reporting]\nfix dashboard \\\"Copy Post URL\\\" action (#192530)\\n\\n##\nSummary\\r\\n\\r\\nCloses\nhttps://github.com//issues/191673\\r\\nCloses\nhttps://github.com//issues/183566\\r\\n\\r\\nFixes the ability\nfor the POST URL used to automate generation of\\r\\nreports by adding a\n`generateExportUrl` function to the ShareMenuItemV2\\r\\ninterface. This\nfunction returns a dynamic export URL for PDF generation\\r\\nby using the\nselected layout option.\\r\\n\\r\\nOther changes: provides more strictness\nin type definitions by:\\r\\n * splitting the types that define\n`ShareMenuProvider`:\\r\\n * `ShareMenuProviderV2` provides the\n`getShareMenuItems` function\\r\\n* `ShareMenuProviderLegacy` provides the\n`getShareMenuItemsLegacy`\\r\\nfunction\\r\\n\\r\\n### Release note\\r\\nFixed\nan issue with the export options for PNG/PDF reports in\na\\r\\ndashboard.\\r\\n\\r\\n### Checklist\\r\\n\\r\\nDelete any items that are\nnot applicable to this PR.\\r\\n\\r\\n- [x] Use the `generateExportUrl`\nfunction inputs to return a POST URL\\r\\nthat is aware of the layout mode\n(`print` or `preserve_layout`) and\\r\\nscreen dimensions\\r\\n- [x] [Unit\nor\nfunctional\\r\\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\\r\\nwere\nupdated or added to match the most common scenarios\\r\\n- [x] Flaky test\nrunner:\\r\\nhttps://buildkite.com/elastic/kibana-flaky-test-suite-runner/builds/6986\",\"sha\":\"38407ae6b01e071757083fe358116b6dd75c4422\"}},{\"branch\":\"8.x\",\"label\":\"v8.16.0\",\"branchLabelMappingKey\":\"^v8.16.0$\",\"isSourceBranch\":false,\"state\":\"NOT_CREATED\"},{\"branch\":\"8.15\",\"label\":\"v8.15.2\",\"branchLabelMappingKey\":\"^v(\\\\d+).(\\\\d+).\\\\d+$\",\"isSourceBranch\":false,\"state\":\"NOT_CREATED\"}]}]\nBACKPORT-->\n\nCo-authored-by: Tim Sullivan <[email protected]>"}},{"branch":"8.15","label":"v8.15.2","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"}]}] BACKPORT--> --------- Co-authored-by: kibanamachine <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Backport
This will backport the following commits from
mainto8.x:Questions ?
Please refer to the Backport tool documentation