[BREAKINGCHANGE] remove dashbaord resource dependecy by shahrokni · Pull Request #97 · perses/shared

shahrokni · 2026-04-02T12:40:16Z

Description

There is an ongoing effort to remove the core the dependency and replace them with what we have in the Spec.
This PR removes some of the dependencies (mostly DashboardResource, EphemeralDashboardResource) which have been already mentioned by @Nexucis

How does it replace the dependencies?

The PR introduces a new interface which represents an internal definition of any-Dashboard-Resource named DashboardMinimalResource.

DashboardResource, EphemeralDashboardResource from EditDatasourcesButton.tsx
DashboardResource, EphemeralDashboardResource from serializeDashboard.ts
DashboardResource, EphemeralDashboardResource from LeaveDialog.tsx
DashboardResource, EphemeralDashboardResource from common.ts
DashboardResource, EphemeralDashboardResource from dashboard-provider-api.ts
DashboardResource, EphemeralDashboardResource from DatasourceStoreProvider.tsx
DashboardResource, EphemeralDashboardResource from useDashboard.tsx
DashboardResource from dashboard-provider.tsx
DashboardResource, EphemeralDashboardResource from DashboardApp.tsx
Some important changes in dashboards/src/context/DashboardProvider/DashboardProvider.tsx

Checklist

Pull request has a descriptive title and context useful to a reviewer.
Pull request title follows the [<catalog_entry>] <commit message> naming convention using one of the
following catalog_entry values: FEATURE, ENHANCEMENT, BUGFIX, BREAKINGCHANGE, DOC,IGNORE.
All commits have DCO signoffs.

UI Changes

Changes that impact the UI include screenshots and/or screencasts of the relevant changes.
Code follows the UI guidelines.
E2E tests are stable and unlikely to be flaky.
See e2e docs for more details. Common issues include:
- Is the data inconsistent? You need to mock API requests.
- Does the time change? You need to use consistent time values or mock time utilities.
- Does it have loading states? You need to wait for loading to complete.

jgbernalp · 2026-04-13T10:59:37Z

dashboards/src/context/DashboardProvider/DashboardProvider.tsx

+   Such a decision would affect DashbaordProvider and buildDatasourceProxyUrl
+   https://github.com/perses/perses/issues/4016
+*/
+export interface DashboardMinimalResource {


If we are moving this out of the spec, why don't we use the same name. It would be a breaking change but for consumers just the import will change.

Suggested change

export interface DashboardMinimalResource {

export interface DashboardResource {

This probably should have its own file.

jgbernalp · 2026-04-13T11:05:54Z

dashboards/src/components/DownloadButton/serializeDashboard.ts


  if (shape === 'cr-v1alpha1') {
-    const name = dashboard.metadata.name.toLowerCase().replace(/[^a-z0-9-]/g, '-');
+    const name = (dashboard.metadata.name as string)?.toLowerCase().replace(/[^a-z0-9-]/g, '-');


We should not cast without prior validation or adding a typeGuard, otherwise we will get runtime errors. Is this cast necessary?

jgbernalp · 2026-04-13T11:09:46Z

dashboards/src/context/DashboardProvider/DashboardProvider.tsx

+*/
+export interface DashboardMinimalResource {
+  kind: DashboardKind;
+  name: string;


Why are we adding the name if metadata already has it? Which one would be the source of thruth?

jgbernalp · 2026-04-13T11:10:58Z

dashboards/src/context/DatasourceStoreProvider.tsx

          proxyUrl: buildDatasourceProxyUrl(datasourceApi, {
-            project: dashboardResource.metadata.project,
-            dashboard: dashboardResource.metadata.name,
+            project: dashboardResource.metadata.project as string,


we should avoid casting without verification or fix the underlining types

jgbernalp · 2026-04-13T11:12:02Z

dashboards/src/context/DashboardProvider/DashboardProvider.tsx

 import { createLinksSlice, LinksSlice } from './links-slice';

+export type DashboardKind = 'Dashboard' | 'EphemeralDashboard';
+export type DashboardGenericMetaData = Record<string, string | number | string[] | undefined>;


We probably have a better type for this, this is too generic and reduces type safety (casting)

I picked number and string array for the version and tags fields respectively. If they have no usage here, then the type could be limited to

interface Metadata { name: string, project: string }

I myself have some doubts there would be any usage of those fields. WDYT?

Signed-off-by: Seyed Mahmoud SHAHROKNI <seyedmahmoud.shahrokni@amadeus.com> Signed-off-by: Seyed Mahmoud SHAHROKNI <seyedmahmoud.shahrokni@amadeus.com> Signed-off-by: Seyed Mahmoud SHAHROKNI <seyedmahmoud.shahrokni@amadeus.com> Signed-off-by: Seyed Mahmoud SHAHROKNI <seyedmahmoud.shahrokni@amadeus.com> Signed-off-by: Seyed Mahmoud SHAHROKNI <seyedmahmoud.shahrokni@amadeus.com> Signed-off-by: Seyed Mahmoud SHAHROKNI <seyedmahmoud.shahrokni@amadeus.com> Signed-off-by: Seyed Mahmoud SHAHROKNI <seyedmahmoud.shahrokni@amadeus.com> Signed-off-by: Seyed Mahmoud SHAHROKNI <seyedmahmoud.shahrokni@amadeus.com> Signed-off-by: Seyed Mahmoud SHAHROKNI <seyedmahmoud.shahrokni@amadeus.com>

jgbernalp · 2026-04-13T13:58:25Z

dashboards/src/model/DashboardResource.ts

+import { DashboardSpec } from '@perses-dev/spec';
+
+export type DashboardKind = 'Dashboard' | 'EphemeralDashboard';
+export type DashboardMetaData = { name: string; project: string };


Do we have this type as part of the spec? I believe we are using the same metadata for all resources, so define a new one only for this resource might create discrepancies

We don't have them in the Spec as far as I know. And it seems they should not be part of the Spec as they are irrelevant there. At the moment the the original ones reside in the Core and should not be moved to the Spec. At least this is what I have understood. If we want to eventually drop the Core, we need to take care of the dependency in Shared.

A solution

What I can do is to flatten the DashboardMetaData and keep its filed in the main object (name and project). But, still not sure if this mitigate your concern. For the Kind however, there is nothing I can do. Kind has been used in the Shared, and has been exposed from the Shared. I am not sure what consequence we may encounter, if we drop it. > The main question is if removing the Kind would be a BREAKINGCHANGE which could be resolved.

shahrokni force-pushed the refactor/remove_dashbaord_Resource_core branch 4 times, most recently from facc8a6 to 872354c Compare April 13, 2026 10:16

shahrokni requested a review from jgbernalp April 13, 2026 10:47

shahrokni marked this pull request as ready for review April 13, 2026 10:47

shahrokni requested a review from a team as a code owner April 13, 2026 10:47

jgbernalp reviewed Apr 13, 2026

View reviewed changes

jgbernalp changed the title ~~[BREAKINGCHANE] remove dashbaord resource dependecy~~ [BREAKINGCHANGE] remove dashbaord resource dependecy Apr 13, 2026

jgbernalp reviewed Apr 13, 2026

View reviewed changes

shahrokni force-pushed the refactor/remove_dashbaord_Resource_core branch 4 times, most recently from dc6f02e to 2f6e05e Compare April 13, 2026 13:07

shahrokni force-pushed the refactor/remove_dashbaord_Resource_core branch from 2f6e05e to 5b15e50 Compare April 13, 2026 13:22

shahrokni requested a review from jgbernalp April 13, 2026 13:26

jgbernalp reviewed Apr 13, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[BREAKINGCHANGE] remove dashbaord resource dependecy#97

[BREAKINGCHANGE] remove dashbaord resource dependecy#97
shahrokni wants to merge 1 commit intomainfrom
refactor/remove_dashbaord_Resource_core

shahrokni commented Apr 2, 2026 •

edited

Loading

Uh oh!

jgbernalp Apr 13, 2026

Uh oh!

jgbernalp Apr 13, 2026

Uh oh!

jgbernalp Apr 13, 2026

Uh oh!

jgbernalp Apr 13, 2026

Uh oh!

jgbernalp Apr 13, 2026

Uh oh!

jgbernalp Apr 13, 2026

Uh oh!

shahrokni Apr 13, 2026 •

edited

Loading

Uh oh!

jgbernalp Apr 13, 2026

Uh oh!

shahrokni Apr 13, 2026 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	export interface DashboardMinimalResource {
	export interface DashboardResource {

Conversation

shahrokni commented Apr 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

How does it replace the dependencies?

Checklist

UI Changes

Uh oh!

jgbernalp Apr 13, 2026

Choose a reason for hiding this comment

Uh oh!

jgbernalp Apr 13, 2026

Choose a reason for hiding this comment

Uh oh!

jgbernalp Apr 13, 2026

Choose a reason for hiding this comment

Uh oh!

jgbernalp Apr 13, 2026

Choose a reason for hiding this comment

Uh oh!

jgbernalp Apr 13, 2026

Choose a reason for hiding this comment

Uh oh!

jgbernalp Apr 13, 2026

Choose a reason for hiding this comment

Uh oh!

shahrokni Apr 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jgbernalp Apr 13, 2026

Choose a reason for hiding this comment

Uh oh!

shahrokni Apr 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

A solution

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

shahrokni commented Apr 2, 2026 •

edited

Loading

shahrokni Apr 13, 2026 •

edited

Loading

shahrokni Apr 13, 2026 •

edited

Loading