Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 5 commits into from
Jun 8, 2024
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
0ae0605
Check suggested new dashboard title for duplicates on save as
cqliu1 Jun 4, 2024
95b3c47
Add clone test for unique dashboard title suggestion
cqliu1 Jun 4, 2024
ce1d603
fix failing test and improve implementation so fix is clear in diff
eokoneyo Jun 5, 2024
469ea33
Merge pull request #22 from eokoneyo/suggest-unique-title-on-save-as
cqliu1 Jun 5, 2024
fe1bbad
Merge branch 'main' into dashboard/suggest-unique-title-on-save-as
kibanamachine Jun 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
103 changes: 64 additions & 39 deletions src/plugins/dashboard/public/dashboard_container/embeddable/api/run_save_functions.tsx
View file
Open in desktop
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({
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A possible efficiency improvement for this would be to search for all SO titles like DashboardTitle*, then increment locally with the results. In some cases this could result in many network requests. That said, this seems fairly unlikely, so it isn't a blocker.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

merging... this in, as I've opened another PR that addresses this

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
View file
Open in desktop
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);
});
});
}