From 9d096c5623066fbd8464d61cd745fbea8a1692bf Mon Sep 17 00:00:00 2001 From: Marco Liberati Date: Tue, 18 Apr 2023 11:31:21 +0200 Subject: [PATCH] [Lens] Improve reporting size for Lens visualizations (#154931) ## Summary Fix #154894 This PR "rotate" most of Lens visualizations to have a landscape version of the PNG/PDF exports. ### Checklist Delete any items that are not applicable to this PR. - [ ] Any text added follows [EUI's writing guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses sentence case text and includes [i18n support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md) - [ ] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials - [ ] [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 - [ ] Any UI touched in this PR is usable by keyboard only (learn more about [keyboard accessibility](https://webaim.org/techniques/keyboard/)) - [ ] Any UI touched in this PR does not create any new axe failures (run axe in browser: [FF](https://addons.mozilla.org/en-US/firefox/addon/axe-devtools/), [Chrome](https://chrome.google.com/webstore/detail/axe-web-accessibility-tes/lhdoppojpmngadmnindnejefpokejbdd?hl=en-US)) - [ ] If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the [docker list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker) - [ ] This renders correctly on smaller devices using a responsive layout. (You can test this [in your browser](https://www.browserstack.com/guide/responsive-testing-on-local-server)) - [ ] This was checked for [cross-browser compatibility](https://www.elastic.co/support/matrix#matrix_browsers) ### Risk Matrix Delete this section if it is not applicable to this PR. Before closing this PR, invite QA, stakeholders, and other developers to identify risks that should be tested prior to the change/feature release. When forming the risk matrix, consider some of the following examples and how they may potentially impact the change: | Risk | Probability | Severity | Mitigation/Notes | |---------------------------|-------------|----------|-------------------------| | Multiple Spaces—unexpected behavior in non-default Kibana Space. | Low | High | Integration tests will verify that all features are still supported in non-default Kibana Space and when user switches between spaces. | | Multiple nodes—Elasticsearch polling might have race conditions when multiple Kibana nodes are polling for the same tasks. | High | Low | Tasks are idempotent, so executing them multiple times will not result in logical error, but will degrade performance. To test for this case we add plenty of unit tests around this logic and document manual testing procedure. | | Code should gracefully handle cases when feature X or plugin Y are disabled. | Medium | High | Unit tests will verify that any feature flag or plugin combination still results in our service operational. | | [See more potential risk examples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx) | ### For maintainers - [ ] This was checked for breaking API changes and was [labeled appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process) --- .../plugins/lens/public/app_plugin/lens_top_nav.tsx | 12 +++++++++++- .../plugins/lens/public/app_plugin/share_action.ts | 8 ++++++++ x-pack/plugins/lens/public/types.ts | 4 ++++ 3 files changed, 23 insertions(+), 1 deletion(-) diff --git a/x-pack/plugins/lens/public/app_plugin/lens_top_nav.tsx b/x-pack/plugins/lens/public/app_plugin/lens_top_nav.tsx index 2678b5a0368fb..50d70bb58ae75 100644 --- a/x-pack/plugins/lens/public/app_plugin/lens_top_nav.tsx +++ b/x-pack/plugins/lens/public/app_plugin/lens_top_nav.tsx @@ -37,7 +37,7 @@ import { import { combineQueryAndFilters, getLayerMetaInfo } from './show_underlying_data'; import { changeIndexPattern } from '../state_management/lens_slice'; import { LensByReferenceInput } from '../embeddable'; -import { getShareURL } from './share_action'; +import { DEFAULT_LENS_LAYOUT_DIMENSIONS, getShareURL } from './share_action'; function getSaveButtonMeta({ contextFromEmbeddable, @@ -578,6 +578,10 @@ export const LensTopNavMenu = ({ return; } + if (visualization.activeId == null || !visualizationMap[visualization.activeId]) { + return; + } + const { shareableUrl, savedObjectURL, @@ -608,6 +612,12 @@ export const LensTopNavMenu = ({ id: LENS_APP_LOCATOR, params: locatorParams, }, + layout: { + dimensions: + visualizationMap[visualization.activeId].getReportingLayout?.( + visualization.state + ) ?? DEFAULT_LENS_LAYOUT_DIMENSIONS, + }, }; share.toggleShareContextMenu({ diff --git a/x-pack/plugins/lens/public/app_plugin/share_action.ts b/x-pack/plugins/lens/public/app_plugin/share_action.ts index 55e4b978f015d..c9ec3a11ef5e7 100644 --- a/x-pack/plugins/lens/public/app_plugin/share_action.ts +++ b/x-pack/plugins/lens/public/app_plugin/share_action.ts @@ -27,6 +27,14 @@ interface ShareableConfiguration adHocDataViews?: DataViewSpec[]; } +// This approximate Lens workspace dimensions ratio on a typical widescreen +export const DEFAULT_LENS_LAYOUT_DIMENSIONS = { + width: 1793, + // this is a magic number from the reporting tool implementation + // see: x-pack/plugins/screenshotting/server/browsers/chromium/driver_factory/index.ts#L146 + height: 1086, +}; + function getShareURLForSavedObject( { application, data }: Pick, currentDoc: Document | undefined diff --git a/x-pack/plugins/lens/public/types.ts b/x-pack/plugins/lens/public/types.ts index 786d75816cafa..786fc50450a94 100644 --- a/x-pack/plugins/lens/public/types.ts +++ b/x-pack/plugins/lens/public/types.ts @@ -1292,6 +1292,10 @@ export interface Visualization { ) => Suggestion | undefined; getVisualizationInfo?: (state: T) => VisualizationInfo; + /** + * A visualization can return custom dimensions for the reporting tool + */ + getReportingLayout?: (state: T) => { height: number; width: number }; } // Use same technique as TriggerContext