Skip to content

Commit

Permalink
[Dashboard] Check suggested dashboard title for duplicates on save as (
Browse files Browse the repository at this point in the history
…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>
  • Loading branch information
3 people committed Jun 10, 2024
1 parent 38952b1 commit 3fb15c1
Show file tree
Hide file tree
Showing 2 changed files with 71 additions and 39 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -268,47 +268,72 @@ export async function runInteractiveSave(this: DashboardContainer, interactionMo
}
};

let customModalTitle;
let newTitle = currentState.title;

if (lastSavedId) {
const [baseTitle, baseCount] = extractTitleAndCount(currentState.title);
newTitle = `${baseTitle} (${baseCount + 1})`;
(async () => {
try {
let customModalTitle;
let newTitle = currentState.title;

if (lastSavedId) {
const [baseTitle, baseCount] = extractTitleAndCount(newTitle);
let copyCount = baseCount + 1;
newTitle = `${baseTitle} (${copyCount})`;

// increment count until we find a unique title
while (
!(await checkForDuplicateDashboardTitle({
title: newTitle,
lastSavedTitle: currentState.title,
copyOnSave: true,
isTitleDuplicateConfirmed: false,
}))
) {
copyCount++;
newTitle = `${baseTitle} (${copyCount})`;
}

switch (interactionMode) {
case ViewMode.EDIT: {
customModalTitle = i18n.translate('dashboard.topNav.editModeInteractiveSave.modalTitle', {
defaultMessage: 'Save as new dashboard',
});
break;
}
case ViewMode.VIEW: {
customModalTitle = i18n.translate('dashboard.topNav.viewModeInteractiveSave.modalTitle', {
defaultMessage: 'Duplicate dashboard',
});
break;
}
default: {
customModalTitle = undefined;
switch (interactionMode) {
case ViewMode.EDIT: {
customModalTitle = i18n.translate(
'dashboard.topNav.editModeInteractiveSave.modalTitle',
{
defaultMessage: 'Save as new dashboard',
}
);
break;
}
case ViewMode.VIEW: {
customModalTitle = i18n.translate(
'dashboard.topNav.viewModeInteractiveSave.modalTitle',
{
defaultMessage: 'Duplicate dashboard',
}
);
break;
}
default: {
customModalTitle = undefined;
}
}
}
}
}

const dashboardDuplicateModal = (
<DashboardSaveModal
tags={currentState.tags}
title={newTitle}
onClose={() => resolve(undefined)}
timeRestore={currentState.timeRestore}
showStoreTimeOnSave={!lastSavedId}
description={currentState.description ?? ''}
showCopyOnSave={false}
onSave={onSaveAttempt}
customModalTitle={customModalTitle}
/>
);

this.clearOverlays();
showSaveModal(dashboardDuplicateModal);
const dashboardDuplicateModal = (
<DashboardSaveModal
tags={currentState.tags}
title={newTitle}
onClose={() => resolve(undefined)}
timeRestore={currentState.timeRestore}
showStoreTimeOnSave={!lastSavedId}
description={currentState.description ?? ''}
showCopyOnSave={false}
onSave={onSaveAttempt}
customModalTitle={customModalTitle}
/>
);
this.clearOverlays();
showSaveModal(dashboardDuplicateModal);
} catch (error) {
reject(error);
}
})();
});
}
7 changes: 7 additions & 0 deletions test/functional/apps/dashboard/group4/dashboard_clone.ts
Original file line number Diff line number Diff line change
Expand Up @@ -42,5 +42,12 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) {
expect(panelTitles).to.eql(PageObjects.dashboard.getTestVisualizationNames());
});
});

it('Clone should suggest a unique title', async function () {
await PageObjects.dashboard.loadSavedDashboard(clonedDashboardName);
await PageObjects.dashboard.duplicateDashboard();
await PageObjects.dashboard.gotoDashboardLandingPage();
await listingTable.searchAndExpectItemsCount('dashboard', `${dashboardName} (2)`, 1);
});
});
}

0 comments on commit 3fb15c1

Please sign in to comment.