Simplify workflow for dashboard copy creation in both view and edit interaction modes #180938

eokoneyo · 2024-04-16T14:46:29Z

Summary

Closes #161047

Removes the save as top nav menu button
Also renames nav menu item clone to duplicate and make it available in edit mode.
The save dashboard modal no longer displays and open to save the dashboard in context as new, given that we've chosen to explicitly create a copy of the dashboard in context when either of the the duplicate or saveas menu option is selected.
includes bug fix for an issue where clicking the dashboard modal scrolled the user to the content bottom, see Simplify workflow for dashboard copy creation in both view and edit interaction modes #180938 (comment)

Before

View mode

Edit mode

After

Managed Dashboard

Screen.Recording.2024-05-15.at.10.39.21.mov

View mode

Screen.Recording.2024-05-15.at.10.42.09.mov

Edit mode

Screen.Recording.2024-05-15.at.10.40.59.mov

cqliu1

Code LGTM. I ran this locally and have just a few nits on the UI side:

Can we move the Switch to view mode button left of the Settings button in edit mode? That way the Share button doesn't jump around when switching between view and edit mode.

Also, I noticed when switching to the edit mode, the Duplicate button flashes and appears to disable for a second. The Reset button also does the same thing where it's enabled before it's disabled when switching back to view mode. Not a blocker for this PR if it isn't an easy fix, and we can file a issue to resolve later.

eokoneyo · 2024-04-16T17:56:53Z

Code LGTM. I ran this locally and have just a few nits on the UI side:

Can we move the Switch to view mode button left of the Settings button in edit mode? That way the Share button doesn't jump around when switching between view and edit mode.

Also, I noticed when switching to the edit mode, the Duplicate button flashes and appears to disable for a second. The Reset button also does the same thing where it's enabled before it's disabled when switching back to view mode. Not a blocker for this PR if it isn't an easy fix, and we can file a issue to resolve later.

@cqliu1 so there's already an existing grouping for rendering nav menu items, that been said I think I think modifying it with would be out of the scope of this PR. I did make some change still so that the existing grouping is preserved and keeps us close to how the nav item has been. Let me know what you think?

elasticmachine · 2024-04-16T20:58:29Z

Pinging @elastic/kibana-presentation (Team:Presentation)

eokoneyo · 2024-04-16T22:11:28Z

/ci

cqliu1 · 2024-04-16T22:30:43Z

@cqliu1 so there's already an existing grouping for rendering nav menu items, that been said I think I think modifying it with would be out of the scope of this PR. I did make some change still so that the existing grouping is preserved and keeps us close to how the nav item has been. Let me know what you think?

That works for now 👍

eokoneyo · 2024-05-03T14:41:17Z

Reverting to draft given the work scope changed. Will transition when ready for review

eokoneyo · 2024-05-03T15:20:35Z

/ci

eokoneyo · 2024-05-09T16:22:02Z

/ci

eokoneyo · 2024-05-13T11:35:13Z

/ci

…r to show time restore switch

…s behaviour

…ethod

fix failing accessibility test

… helper method

…fix'

eokoneyo · 2024-05-29T08:11:34Z

... Only one nit: I'd prefer if this description for the Store time with dashboard setting was a tooltip instead, but I'll approve to unblock.

Good callout with the moving the store time with dashboard description into a tooltip, it looks so much better!

kibana-ci · 2024-05-29T08:55:34Z

💛 Build succeeded, but was flaky

Failed CI Steps

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
`savedObjects`	120	121	+1

Async chunks

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

id	before	after	diff
`dashboard`	495.1KB	494.9KB	-206.0B

Page load bundle

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

id	before	after	diff
`savedObjects`	25.3KB	25.5KB	+152.0B

Unknown metric groups

API count

id	before	after	diff
`savedObjects`	131	132	+1

ESLint disabled line counts

id	before	after	diff
`savedObjects`	0	1	+1

Total ESLint disabled count

id	before	after	diff
`savedObjects`	0	1	+1

History

💛 Build #212322 was flaky ff121330f1397f91c5680e8fec4978b64c980304
💔 Build #212049 failed 03f49666c6b29bc8d5d103ed4a3f548e1a072d7b
💔 Build #211903 failed d04b7a536a5ebed8ef928cea3c2b037fa1069060
💚 Build #211683 succeeded 06ad43feef8b92050d937d88239d48a183c2e549
💚 Build #211432 succeeded 72fb5d491e651405ccc01bba4865f426a442c32e

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

cc @eokoneyo

…#184777) ## Summary Follow up to #180938. On `Save as`, the suggested title should always be a unique title. I've added a check for duplicate titles when generating a suggested new dashboard title. If the dashboards `Dashboard A`, `Dashboard A (1)`, and `Dashboard A (2)` already exist, the next suggested dashboard title will be `Dashboard A (3)`. This way the user doesn't end up hitting the duplicate title warning if they want to quickly clone a dashboard without updating the title. ![Jun-04-2024 12-27-59](https://github.com/elastic/kibana/assets/1697105/b1f1ae1a-87d3-4dcd-80cd-395bd6ee9800) ### 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 - [ ] [Flaky Test Runner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was used on any tests changed - [ ] 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) --------- Co-authored-by: Eyo Okon Eyo <eyo.eyo@elastic.co> Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

…elastic#184777) ## Summary Follow up to elastic#180938. On `Save as`, the suggested title should always be a unique title. I've added a check for duplicate titles when generating a suggested new dashboard title. If the dashboards `Dashboard A`, `Dashboard A (1)`, and `Dashboard A (2)` already exist, the next suggested dashboard title will be `Dashboard A (3)`. This way the user doesn't end up hitting the duplicate title warning if they want to quickly clone a dashboard without updating the title. ![Jun-04-2024 12-27-59](https://github.com/elastic/kibana/assets/1697105/b1f1ae1a-87d3-4dcd-80cd-395bd6ee9800) ### 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 - [ ] [Flaky Test Runner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was used on any tests changed - [ ] 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) --------- Co-authored-by: Eyo Okon Eyo <eyo.eyo@elastic.co> Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

eokoneyo added Team:Presentation Presentation Team for Dashboard, Input Controls, and Canvas Project:Dashboard Usability Related to the Dashboard Usability initiative labels Apr 16, 2024

eokoneyo self-assigned this Apr 16, 2024

eokoneyo force-pushed the fix/resolve-161047 branch from 34cd2a3 to 7cf493a Compare April 16, 2024 14:50

cqliu1 self-requested a review April 16, 2024 15:24

cqliu1 added Feature:Dashboard Dashboard related features v8.14.0 release_note:enhancement loe:small Small Level of Effort impact:medium Addressing this issue will have a medium level of impact on the quality/strength of our product. labels Apr 16, 2024

eokoneyo force-pushed the fix/resolve-161047 branch from 7cf493a to c820ff9 Compare April 16, 2024 15:46

cqliu1 approved these changes Apr 16, 2024

View reviewed changes

eokoneyo marked this pull request as ready for review April 16, 2024 20:58

eokoneyo requested a review from a team as a code owner April 16, 2024 20:58

cqliu1 approved these changes Apr 16, 2024

View reviewed changes

eokoneyo added v8.15.0 and removed v8.14.0 labels Apr 17, 2024

cqliu1 self-requested a review April 24, 2024 15:55

eokoneyo marked this pull request as draft May 3, 2024 14:39

eokoneyo force-pushed the fix/resolve-161047 branch from aa4edad to a364956 Compare May 3, 2024 14:42

eokoneyo force-pushed the fix/resolve-161047 branch from a364956 to 24c2ea8 Compare May 9, 2024 16:20

eokoneyo force-pushed the fix/resolve-161047 branch from 24c2ea8 to ec4f5ed Compare May 13, 2024 10:11

eokoneyo and others added 17 commits May 29, 2024 09:40

fix issue with dashboard save related tests

1b666a2

convert dashboard modal to functional component and add idfferentiato…

c791131

…r to show time restore switch

modify dashboard page objects to account for new duplicate and save a…

2662018

…s behaviour

add description to differentiate runClone and runSaveAs method

30a9895

more test fixes

8893c75

adjust existing tests to accomodate change in dashboard page object m…

25c8743

…ethod

extend test expectation adjustment to missed occurrence

3900781

consolidate saveas and clone methods into new interactiveSave method

e32bf84

extend new interactive save method to be used in top nav menu items

2d3c553

adjustment to test to accomodate new changes

1be2054

adjust defaut count for extractTitleAndCount

93bd157

remove comment

7926932

fix issue with dashboard getting scrolled on opening save modal

7fd8089

fix failing accessibility test

incorporate feedback on operation property for the saveDashboard page…

7b87800

… helper method

[CI] Auto-commit changed files from 'node scripts/lint_ts_projects --…

b8a4419

…fix'

fix failing test relating to dashboard duplication behaviour

8b0fc1d

incorporate PR feedback

1796bc9

eokoneyo force-pushed the fix/resolve-161047 branch from ff12133 to 34ea99e Compare May 29, 2024 08:08

condense store time description into tooltip

472d85b

eokoneyo force-pushed the fix/resolve-161047 branch from 34ea99e to 472d85b Compare May 29, 2024 08:13

eokoneyo merged commit 690690e into elastic:main May 29, 2024
20 checks passed

eokoneyo deleted the fix/resolve-161047 branch May 29, 2024 09:46

kibanamachine added the backport:skip This commit does not require backporting label May 29, 2024

cqliu1 mentioned this pull request Jun 4, 2024

[Dashboard] Check suggested dashboard title for duplicates on save as #184777

Merged

10 tasks

mbondyra mentioned this pull request Aug 8, 2024

[Dashboard][Managed Content] Maps and saved search refer to the same saved object after duplicating managed dashboard #190138

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Simplify workflow for dashboard copy creation in both view and edit interaction modes #180938

Simplify workflow for dashboard copy creation in both view and edit interaction modes #180938

eokoneyo commented Apr 16, 2024 •

edited

Loading

cqliu1 left a comment •

edited

Loading

eokoneyo commented Apr 16, 2024

elasticmachine commented Apr 16, 2024

eokoneyo commented Apr 16, 2024

cqliu1 commented Apr 16, 2024

eokoneyo commented May 3, 2024

eokoneyo commented May 3, 2024

eokoneyo commented May 9, 2024

eokoneyo commented May 13, 2024

eokoneyo commented May 29, 2024

kibana-ci commented May 29, 2024 •

edited

Loading

API count

ESLint disabled line counts

Total ESLint disabled count

Simplify workflow for dashboard copy creation in both view and edit interaction modes #180938

Simplify workflow for dashboard copy creation in both view and edit interaction modes #180938

Conversation

eokoneyo commented Apr 16, 2024 • edited Loading

Summary

Before

View mode

Edit mode

After

Managed Dashboard

View mode

Edit mode

cqliu1 left a comment • edited Loading

Choose a reason for hiding this comment

eokoneyo commented Apr 16, 2024

elasticmachine commented Apr 16, 2024

eokoneyo commented Apr 16, 2024

cqliu1 commented Apr 16, 2024

eokoneyo commented May 3, 2024

eokoneyo commented May 3, 2024

eokoneyo commented May 9, 2024

eokoneyo commented May 13, 2024

eokoneyo commented May 29, 2024

kibana-ci commented May 29, 2024 • edited Loading

💛 Build succeeded, but was flaky

Failed CI Steps

Metrics [docs]

Public APIs missing comments

Async chunks

Page load bundle

API count

ESLint disabled line counts

Total ESLint disabled count

History

eokoneyo commented Apr 16, 2024 •

edited

Loading

cqliu1 left a comment •

edited

Loading

kibana-ci commented May 29, 2024 •

edited

Loading