public/grafana
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

DashboardAPI: Remove manual slug creation in dashboards (#111657)

Browse Source 
* remove slug creation on frontend due to slugify issues

* adjust tests

* fix
This commit is contained in:
Sergej-Vlasov
2025-09-30 17:15:56 +03:00
committed by GitHub
parent 48a5ae3980
commit 90da925985
5 changed files with 31 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files
public/app/features/dashboard-scene/saving/useSaveDashboard.ts
+12 -1
View File
@@ -55,7 +55,18 @@ export function useSaveDashboard(isCopy = false) {
throw result.error;
}
const resultData = result.data;
// result.data is readonly so spreading to allow for slug edits
const resultData: typeof result.data = { ...result.data };
// TODO: use slug from response once implemented
// reuse existing slug to avoid "Unsaved changes" modal after save
// due to slugify logic difference between frontend and backend
if (!result.data.slug && scene.state.meta.slug) {
const slug = scene.state.meta.slug;
resultData.slug = slug;
resultData.url = `${result.data.url}/${slug}`;
}
scene.saveCompleted(saveModel, resultData, options.folderUid);
// important that these happen before location redirect below
public/app/features/dashboard/api/v1.test.ts
+11 -5
View File
@@ -24,7 +24,9 @@ const mockDashboardDto: DashboardWithAccessInfo<DashboardDataDTO> = {
uid: '',
schemaVersion: 0,
},
access: {},
access: {
slug: 'test',
},
};
const saveDashboardResponse = {
@@ -224,7 +226,8 @@ describe('v1 dashboard API', () => {
});
describe('saving a existing dashboard', () => {
it('should provide dashboard URL', async () => {
// TODO: unskip once slug implemented in response
it.skip('should provide dashboard URL', async () => {
const api = new K8sDashboardAPI();
const result = await api.saveDashboard({
dashboard: {
@@ -242,7 +245,8 @@ describe('v1 dashboard API', () => {
expect(result.version).toBe(1);
expect(result.url).toBe('/d/adh59cn/new-dashboard-saved');
});
it('should provide dashboard URL with app sub url configured', async () => {
// TODO: unskip once slug implemented in response
it.skip('should provide dashboard URL with app sub url configured', async () => {
const api = new K8sDashboardAPI();
locationUtil.initialize({
@@ -271,7 +275,8 @@ describe('v1 dashboard API', () => {
});
});
describe('saving a new dashboard', () => {
it('should provide dashboard URL', async () => {
// TODO: unskip once slug implemented in response
it.skip('should provide dashboard URL', async () => {
const api = new K8sDashboardAPI();
const result = await api.saveDashboard({
dashboard: {
@@ -289,7 +294,8 @@ describe('v1 dashboard API', () => {
expect(result.url).toBe('/d/adh59cn/new-dashboard-saved');
});
it('should provide dashboard URL with app sub url configured', async () => {
// TODO: unskip once slug implemented in response
it.skip('should provide dashboard URL with app sub url configured', async () => {
const api = new K8sDashboardAPI();
locationUtil.initialize({
public/app/features/dashboard/api/v1.ts
+2 -3
View File
@@ -4,7 +4,6 @@ import { Dashboard } from '@grafana/schema';
import { Status } from '@grafana/schema/src/schema/dashboard/v2';
import { backendSrv } from 'app/core/services/backend_srv';
import { getMessageFromError, getStatusFromError } from 'app/core/utils/errors';
import kbn from 'app/core/utils/kbn';
import { ScopedResourceClient } from 'app/features/apiserver/client';
import {
ResourceClient,
@@ -91,7 +90,8 @@ export class K8sDashboardAPI implements DashboardAPI<DashboardDTO, Dashboard> {
}
asSaveDashboardResponseDTO(v: Resource<DashboardDataDTO>): SaveDashboardResponseDTO {
const slug = kbn.slugifyForUrl(v.spec.title.trim());
//TODO: use slug from response once implemented
const slug = '';
const url = locationUtil.assureBaseUrl(
getDashboardUrl({
@@ -131,7 +131,6 @@ export class K8sDashboardAPI implements DashboardAPI<DashboardDTO, Dashboard> {
const result: DashboardDTO = {
meta: {
...dash.access,
slug: kbn.slugifyForUrl(dash.spec.title.trim()),
isNew: false,
isFolder: false,
uid: dash.metadata.name,
public/app/features/dashboard/api/v2.test.ts
+4 -2
View File
@@ -178,7 +178,8 @@ describe('v2 dashboard API', () => {
},
};
it('should create new dashboard', async () => {
// TODO: unskip once slug implemented in response
it.skip('should create new dashboard', async () => {
const api = new K8sDashboardV2API();
const result = await api.saveDashboard({
...defaultSaveCommand,
@@ -198,7 +199,8 @@ describe('v2 dashboard API', () => {
});
});
it('should update existing dashboard', async () => {
// TODO: unskip once slug implemented in response
it.skip('should update existing dashboard', async () => {
const api = new K8sDashboardV2API();
const result = await api.saveDashboard({
public/app/features/dashboard/api/v2.ts
+2 -8
View File
@@ -4,7 +4,6 @@ import { Spec as DashboardV2Spec } from '@grafana/schema/dist/esm/schema/dashboa
import { Status } from '@grafana/schema/src/schema/dashboard/v2';
import { backendSrv } from 'app/core/services/backend_srv';
import { getMessageFromError, getStatusFromError } from 'app/core/utils/errors';
import kbn from 'app/core/utils/kbn';
import { ScopedResourceClient } from 'app/features/apiserver/client';
import {
AnnoKeyFolder,
@@ -76,12 +75,6 @@ export class K8sDashboardV2API
dashboard.metadata.annotations[AnnoKeyFolder] = '';
}
// Ensure a consistent dashboard slug
if (!dashboard.access?.slug) {
dashboard.access = dashboard.access ?? {};
dashboard.access.slug = kbn.slugifyForUrl(dashboard.spec.title.trim());
}
return dashboard;
} catch (e) {
const status = getStatusFromError(e);
@@ -154,7 +147,8 @@ export class K8sDashboardV2API
}
asSaveDashboardResponseDTO(v: Resource<DashboardV2Spec>): SaveDashboardResponseDTO {
const slug = kbn.slugifyForUrl(v.spec.title.trim());
//TODO: use slug from response once implemented
const slug = '';
const url = locationUtil.assureBaseUrl(
getDashboardUrl({