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.

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

Dashboards: Allow dashboards with same name in different folders #70378

Merged
merged 2 commits into from Jun 26, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 0 additions & 5 deletions .betterer.results
Expand Up @@ -2786,11 +2786,6 @@ exports[`better eslint`] = {
"public/app/features/manage-dashboards/components/ImportDashboardLibraryPanelsList.tsx:5381": [
[0, 0, 0, "Do not use any type assertions.", "0"]
],
"public/app/features/manage-dashboards/services/ValidationSrv.ts:5381": [
[0, 0, 0, "Unexpected any. Specify a different type.", "0"],
[0, 0, 0, "Unexpected any. Specify a different type.", "1"],
[0, 0, 0, "Unexpected any. Specify a different type.", "2"]
],
"public/app/features/manage-dashboards/state/actions.test.ts:5381": [
[0, 0, 0, "Unexpected any. Specify a different type.", "0"]
],
Expand Down
Expand Up @@ -52,8 +52,9 @@ export const SaveDashboardAsForm = ({ dashboard, isNew, onSubmit, onCancel, onSu
if (dashboardName && dashboardName === getFormValues().$folder.title?.trim()) {
return 'Dashboard name cannot be the same as folder name';
}

try {
await validationSrv.validateNewDashboardName(getFormValues().$folder.uid, dashboardName);
await validationSrv.validateNewDashboardName(getFormValues().$folder.uid ?? 'general', dashboardName);
return true;
} catch (e) {
return e instanceof Error ? e.message : 'Dashboard name is invalid';
Expand Down
44 changes: 18 additions & 26 deletions public/app/features/manage-dashboards/services/ValidationSrv.ts
@@ -1,9 +1,4 @@
import { backendSrv } from 'app/core/services/backend_srv';

const hitTypes = {
FOLDER: 'dash-folder',
DASHBOARD: 'dash-db',
};
import { getGrafanaSearcher } from 'app/features/search/service';

class ValidationError extends Error {
type: string;
Expand All @@ -17,43 +12,40 @@ class ValidationError extends Error {
export class ValidationSrv {
rootName = 'general';

validateNewDashboardName(folderUid: any, name: string) {
return this.validate(folderUid, name, 'A dashboard or a folder with the same name already exists');
validateNewDashboardName(folderUID: string, name: string) {
return this.validate(folderUID, name, 'A dashboard or a folder with the same name already exists');
}

validateNewFolderName(name?: string) {
return this.validate(0, name, 'A folder or dashboard in the general folder with the same name already exists');
return this.validate(
this.rootName,
name,
'A folder or dashboard in the general folder with the same name already exists'
);
}

private async validate(folderId: any, name: string | undefined, existingErrorMessage: string) {
private async validate(folderUID: string, name: string | undefined, existingErrorMessage: string) {
name = (name || '').trim();
const nameLowerCased = name.toLowerCase();

if (name.length === 0) {
throw new ValidationError('REQUIRED', 'Name is required');
}

if (folderId === 0 && nameLowerCased === this.rootName) {
if (nameLowerCased === this.rootName) {
throw new ValidationError('EXISTING', 'This is a reserved name and cannot be used for a folder.');
}

const promises = [];
promises.push(backendSrv.search({ type: hitTypes.FOLDER, folderIds: [folderId], query: name }));
promises.push(backendSrv.search({ type: hitTypes.DASHBOARD, folderIds: [folderId], query: name }));

const res = await Promise.all(promises);
let hits: any[] = [];
const searcher = getGrafanaSearcher();

if (res.length > 0 && res[0].length > 0) {
hits = res[0];
}

if (res.length > 1 && res[1].length > 0) {
hits = hits.concat(res[1]);
}
const dashboardResults = await searcher.search({
kind: ['dashboard'],
query: name,
location: folderUID || 'general',
});

for (const hit of hits) {
if (nameLowerCased === hit.title.toLowerCase()) {
for (const result of dashboardResults.view) {
if (nameLowerCased === result.name.toLowerCase()) {
throw new ValidationError('EXISTING', existingErrorMessage);
}
}
Expand Down