Skip to content

Commit

Permalink
Simplify workflow for dashboard copy creation in both view and edit i…
Browse files Browse the repository at this point in the history
…nteraction modes (#180938)

## 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
#180938 (comment)

## Before
### View mode
<img width="1728" alt="Screenshot 2024-04-16 at 15 59 10"
src="https://github.com/elastic/kibana/assets/7893459/48dc4565-1f75-4f46-839c-8d76f4fedefe">

### Edit mode
<img width="1725" alt="Screenshot 2024-04-16 at 15 59 00"
src="https://github.com/elastic/kibana/assets/7893459/1ac743ac-33b4-4f68-ab59-ad19ab58fa1c">

## After

#### Managed Dashboard

https://github.com/elastic/kibana/assets/7893459/5072a501-8d16-4f25-9575-6f11fed6e580

#### View mode

https://github.com/elastic/kibana/assets/7893459/610d0952-97f0-46b8-a0ea-1546a799d387

#### Edit mode

https://github.com/elastic/kibana/assets/7893459/4f596c07-7bd1-4c5a-9131-0c78731cb113



<!-- ### 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&mdash;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&mdash;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: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
  • Loading branch information
eokoneyo and kibanamachine authored May 29, 2024
1 parent d5842d7 commit 690690e
Show file tree
Hide file tree
Showing 46 changed files with 743 additions and 577 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -189,11 +189,11 @@ export const topNavStrings = {
defaultMessage: 'Quick save your dashboard without any prompts',
}),
},
saveAs: {
label: i18n.translate('dashboard.topNave.saveAsButtonAriaLabel', {
editModeInteractiveSave: {
label: i18n.translate('dashboard.topNave.editModeInteractiveSaveButtonAriaLabel', {
defaultMessage: 'save as',
}),
description: i18n.translate('dashboard.topNave.saveAsConfigDescription', {
description: i18n.translate('dashboard.topNave.editModeInteractiveSaveConfigDescription', {
defaultMessage: 'Save as a new dashboard',
}),
},
Expand Down Expand Up @@ -229,11 +229,11 @@ export const topNavStrings = {
defaultMessage: 'Open dashboard settings',
}),
},
clone: {
label: i18n.translate('dashboard.topNave.cloneButtonAriaLabel', {
defaultMessage: 'clone',
viewModeInteractiveSave: {
label: i18n.translate('dashboard.topNave.viewModeInteractiveSaveButtonAriaLabel', {
defaultMessage: 'duplicate',
}),
description: i18n.translate('dashboard.topNave.cloneConfigDescription', {
description: i18n.translate('dashboard.topNave.viewModeInteractiveSaveConfigDescription', {
defaultMessage: 'Create a copy of your dashboard',
}),
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -104,23 +104,11 @@ export const useDashboardMenuItems = ({
}, [dashboard]);

/**
* Show the dashboard's save modal
* initiate interactive dashboard copy action
*/
const saveDashboardAs = useCallback(() => {
dashboard.runSaveAs().then((result) => maybeRedirect(result));
}, [maybeRedirect, dashboard]);

/**
* Clone the dashboard
*/
const clone = useCallback(() => {
setIsSaveInProgress(true);

dashboard.runClone().then((result) => {
setIsSaveInProgress(false);
maybeRedirect(result);
});
}, [maybeRedirect, dashboard]);
const dashboardInteractiveSave = useCallback(() => {
dashboard.runInteractiveSave(viewMode).then((result) => maybeRedirect(result));
}, [maybeRedirect, dashboard, viewMode]);

/**
* Show the dashboard's "Confirm reset changes" modal. If confirmed:
Expand Down Expand Up @@ -197,15 +185,22 @@ export const useDashboardMenuItems = ({
run: () => quickSaveDashboard(),
} as TopNavMenuData,

saveAs: {
description: topNavStrings.saveAs.description,
interactiveSave: {
disableButton: disableTopNav,
id: 'save',
emphasize: !Boolean(lastSavedId),
testId: 'dashboardSaveMenuItem',
iconType: Boolean(lastSavedId) ? undefined : 'save',
label: Boolean(lastSavedId) ? topNavStrings.saveAs.label : topNavStrings.quickSave.label,
run: () => saveDashboardAs(),
id: 'interactive-save',
testId: 'dashboardInteractiveSaveMenuItem',
run: dashboardInteractiveSave,
label:
viewMode === ViewMode.VIEW
? topNavStrings.viewModeInteractiveSave.label
: Boolean(lastSavedId)
? topNavStrings.editModeInteractiveSave.label
: topNavStrings.quickSave.label,
description:
viewMode === ViewMode.VIEW
? topNavStrings.viewModeInteractiveSave.description
: topNavStrings.editModeInteractiveSave.description,
} as TopNavMenuData,

switchToViewMode: {
Expand All @@ -230,31 +225,23 @@ export const useDashboardMenuItems = ({
testId: 'dashboardSettingsButton',
disableButton: disableTopNav,
run: () => dashboard.showSettings(),
} as TopNavMenuData,

clone: {
...topNavStrings.clone,
id: 'clone',
testId: 'dashboardClone',
disableButton: disableTopNav,
run: () => clone(),
} as TopNavMenuData,
},
};
}, [
quickSaveDashboard,
disableTopNav,
isSaveInProgress,
hasRunMigrations,
hasUnsavedChanges,
dashboardBackup,
saveDashboardAs,
setIsLabsShown,
disableTopNav,
resetChanges,
isLabsShown,
lastSavedId,
dashboardInteractiveSave,
viewMode,
showShare,
dashboard,
clone,
setIsLabsShown,
isLabsShown,
dashboardBackup,
quickSaveDashboard,
resetChanges,
]);

const resetChangesMenuItem = useMemo(() => {
Expand All @@ -276,15 +263,15 @@ export const useDashboardMenuItems = ({
const viewModeTopNavConfig = useMemo(() => {
const labsMenuItem = isLabsEnabled ? [menuItems.labs] : [];
const shareMenuItem = share ? [menuItems.share] : [];
const cloneMenuItem = showWriteControls ? [menuItems.clone] : [];
const duplicateMenuItem = showWriteControls ? [menuItems.interactiveSave] : [];
const editMenuItem = showWriteControls && !managed ? [menuItems.edit] : [];
const mayberesetChangesMenuItem = showResetChange ? [resetChangesMenuItem] : [];

return [
...labsMenuItem,
menuItems.fullScreen,
...shareMenuItem,
...cloneMenuItem,
...duplicateMenuItem,
...mayberesetChangesMenuItem,
...editMenuItem,
];
Expand All @@ -304,30 +291,18 @@ export const useDashboardMenuItems = ({
const editModeItems: TopNavMenuData[] = [];

if (lastSavedId) {
editModeItems.push(menuItems.saveAs, menuItems.switchToViewMode);
editModeItems.push(menuItems.interactiveSave, menuItems.switchToViewMode);

if (showResetChange) {
editModeItems.push(resetChangesMenuItem);
}

editModeItems.push(menuItems.quickSave);
} else {
editModeItems.push(menuItems.switchToViewMode, menuItems.saveAs);
editModeItems.push(menuItems.switchToViewMode, menuItems.interactiveSave);
}
return [...labsMenuItem, menuItems.settings, ...shareMenuItem, ...editModeItems];
}, [
isLabsEnabled,
menuItems.labs,
menuItems.share,
menuItems.settings,
menuItems.saveAs,
menuItems.switchToViewMode,
menuItems.quickSave,
share,
lastSavedId,
showResetChange,
resetChangesMenuItem,
]);
}, [isLabsEnabled, menuItems, share, lastSavedId, showResetChange, resetChangesMenuItem]);

return { viewModeTopNavConfig, editModeTopNavConfig };
};
Original file line number Diff line number Diff line change
Expand Up @@ -323,7 +323,11 @@ export const DashboardSettings = ({ onClose }: DashboardSettingsProps) => {
<EuiFlyoutFooter>
<EuiFlexGroup justifyContent="spaceBetween">
<EuiFlexItem grow={false}>
<EuiButtonEmpty data-test-subj="cancelCustomizeDashboardButton" onClick={onClose}>
<EuiButtonEmpty
flush="left"
data-test-subj="cancelCustomizeDashboardButton"
onClick={onClose}
>
<FormattedMessage
id="dashboard.embeddableApi.showSettings.flyout.cancelButtonTitle"
defaultMessage="Cancel"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@
export { showSettings } from './show_settings';
export { addFromLibrary } from './add_panel_from_library';
export { addOrUpdateEmbeddable } from './panel_management';
export { runSaveAs, runQuickSave, runClone } from './run_save_functions';
export { runQuickSave, runInteractiveSave } from './run_save_functions';
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,14 @@ describe('extractTitleAndCount', () => {
]);
});

it('defaults to the count to 1 and returns the original title when the provided title does not contain a valid count', () => {
expect(extractTitleAndCount('Test dashboard')).toEqual(['Test dashboard', 1]);
expect(extractTitleAndCount('Test dashboard 2')).toEqual(['Test dashboard 2', 1]);
expect(extractTitleAndCount('Test dashboard (-1)')).toEqual(['Test dashboard (-1)', 1]);
expect(extractTitleAndCount('Test dashboard (0)')).toEqual(['Test dashboard (0)', 1]);
expect(extractTitleAndCount('Test dashboard (3.0)')).toEqual(['Test dashboard (3.0)', 1]);
expect(extractTitleAndCount('Test dashboard (8.4)')).toEqual(['Test dashboard (8.4)', 1]);
expect(extractTitleAndCount('Test dashboard (foo3.0)')).toEqual(['Test dashboard (foo3.0)', 1]);
expect(extractTitleAndCount('Test dashboard (bar7)')).toEqual(['Test dashboard (bar7)', 1]);
it('defaults to the count to 0 and returns the original title when the provided title does not contain a valid count', () => {
expect(extractTitleAndCount('Test dashboard')).toEqual(['Test dashboard', 0]);
expect(extractTitleAndCount('Test dashboard 2')).toEqual(['Test dashboard 2', 0]);
expect(extractTitleAndCount('Test dashboard (-1)')).toEqual(['Test dashboard (-1)', 0]);
expect(extractTitleAndCount('Test dashboard (0)')).toEqual(['Test dashboard (0)', 0]);
expect(extractTitleAndCount('Test dashboard (3.0)')).toEqual(['Test dashboard (3.0)', 0]);
expect(extractTitleAndCount('Test dashboard (8.4)')).toEqual(['Test dashboard (8.4)', 0]);
expect(extractTitleAndCount('Test dashboard (foo3.0)')).toEqual(['Test dashboard (foo3.0)', 0]);
expect(extractTitleAndCount('Test dashboard (bar7)')).toEqual(['Test dashboard (bar7)', 0]);
});
});
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,5 @@ export const extractTitleAndCount = (title: string): [string, number] => {
return [baseTitle, Number(count)];
}
}
return [title, 1];
return [title, 0];
};

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 690690e

Please sign in to comment.