Folders: Migrate getFolder API to app platform #107617

aocenas · 2025-07-04T09:55:43Z

Changes the getFolder and it's useGetFolderQueryHook to use APP latform APIs.

This is done by creating a useGetFolderQueryFacade that based on the foldersAppPlatformAPI either uses the legacy client or the recreates the same FolderDTO from multiple app platform API calls.

This should make this change mostly transparent to the front end so no changes to the rendering is needed.

# Conflicts: # packages/grafana-data/src/types/featureToggles.gen.ts # pkg/services/featuremgmt/registry.go # pkg/services/featuremgmt/toggles_gen.csv # pkg/services/featuremgmt/toggles_gen.go

…o aocenas/folders/migrate-api # Conflicts: # packages/grafana-data/src/types/featureToggles.gen.ts # pkg/services/featuremgmt/registry.go # pkg/services/featuremgmt/toggles_gen.csv # pkg/services/featuremgmt/toggles_gen.go

# Conflicts: # packages/grafana-data/src/types/featureToggles.gen.ts # pkg/services/featuremgmt/registry.go # pkg/services/featuremgmt/toggles_gen.csv # pkg/services/featuremgmt/toggles_gen.go # pkg/services/featuremgmt/toggles_gen.json

# Conflicts: # public/app/api/clients/folder/v1beta1/index.ts # public/app/core/components/NestedFolderPicker/useFoldersQueryAppPlatform.ts

# Conflicts: # public/app/features/alerting/unified/hooks/useFolder.ts

tomratcliffe · 2025-07-18T13:07:17Z

public/app/api/clients/folder/v1beta1/hooks.ts

+  const results = needsUserData
+    ? [result, resultParents, resultAccess]
+    : [result, resultParents, resultAccess, resultUserDisplay];


Is this the wrong way round? 🤔
It's reading as "if needs user data, don't check the resultUserDisplay query". I would have expected it to be the other way round here

Good catch, need to add some tests for this hook to at least check the merging behavior

tomratcliffe · 2025-07-18T15:55:08Z

Not sure if this one is out of scope for the current implementation, but I think its a bug in the new hook? Or an issue with permissions on the new API.

Minimal reproduction, using enterprise...:

Get a test user that has granular read permissions on just 2 folders (and no basic role, so they can't see any other folders)
Go to the Move Folder modal and try to move one folder to a new one
- There will be no results shown in the dropdown list (just the Dashboards item in the nested picker)
- There will be a 403 response from /apis/folder.grafana.app/v1beta1/namespaces/default/folders/general/children

IevaVasiljeva

LGTM access control wise. I feel like we could eventually simplify the returned info a bit (eg, we don't really need both CanEdit, CanSave etc and the access control metadata). But this should work for now 🤞

IevaVasiljeva · 2025-07-18T16:57:51Z

public/app/api/clients/folder/v1beta1/virtualFolders.ts

+  metadata: {
+    name: 'general',
+    namespace: 'org-0',
+    uid: 'DvhY6m059FraHn96xsOKsb8GRtHy2ftVDUPkqZTzP4kX',


question: where is this UID coming from? On the backend, we use general for general folder UID.

I copied what I get if the dualWriterMode == 1 so the backend uses the legacy path. As far as I know this uid is not grafana uid but k8s uid and so will be different from general.

This one though is generated here

grafana/pkg/registry/apis/folders/conversions.go

Line 94 in 18b5a9e

f.UID = gapiutil.CalculateClusterWideUID(f)

and the function depends on group/kind/name/namespace so I assume this should be stable for these virtual folders?

At the same time it's not actually used right now anyway and does not get into the final FolderDTO right now the exact value does not matter.

Gotcha, thanks for the explanation. I still find it hard to tell where the old Grafana style UIDs should be used, and where it's the new k8s UIDs. I agree that it sounds like it'd be a fixed value. And that it's fine to keep it as it is if it's currently not used.

tomratcliffe · 2025-07-18T13:16:45Z

public/app/api/clients/folder/v1beta1/hooks.ts

+import {
+  AnnoKeyCreatedBy,
+  AnnoKeyFolder,
+  // AnnoKeyFolderUrl,


(nit: commented code)

tomratcliffe · 2025-07-21T09:38:25Z

public/app/api/clients/folder/v1beta1/hooks.ts

+    const resultAccess = useGetFolderAccessQuery(params);
+
+    // Load users info if needed.
+    const userKeys = getUserKeys(resultFolder);


Overall, might it be better to make the user information dependent on a parameter passed to the hook? Then the consumer can decide whether its needed to be fetched, rather than always doing it.

I would imagine that not every consumer of the hook requires the user information for its display, perhaps?

Something for the future, as I get that here we're just trying to move over to the new API

The reason this is done is that the k8s object has user references (like created by) in different format, like user:1 while in the old folderDTO the references are actual logins of the users so user:1 => admin. To resolve that here we need to use the userDisplay API call, but in case the references in the k8s object is empty we don't need to do that. So it's not really something user would decide.

In the future we will just have to change the front end to understand the new data types and deal with it case by case because yeah most time it probably isn't needed.

tomratcliffe · 2025-07-21T09:58:08Z

public/app/api/clients/folder/v1beta1/virtualFolders.ts

+  metadata: {
+    name: 'sharedwithme',
+    namespace: 'org-0',
+    uid: 'DlDSzXw31VwXu6LHMw0JMoFvfVtYzyf3NEPzsOXHtxQX',


Should this be config.sharedWithMeFolderUID? Not sure how its best to handle all of these virtual folders 🤔

No, see #107617 (comment) this UID is totally separate thing from the UID we have in grafana. UID we use in grafana == metadata.name in the k8s objects.

tomratcliffe · 2025-07-21T09:59:04Z

public/app/api/clients/folder/v1beta1/virtualFolders.ts

+    title: 'Shared with me',
+    description: 'Dashboards and folders shared with me',


nit: If these are actually being displayed, then we'll need to turn these into get methods (getSharedWithMeFolder) and add translations

tomratcliffe · 2025-07-21T10:00:17Z

public/app/features/browse-dashboards/components/FolderActionsButton.tsx

+    const result = await (config.featureToggles.foldersAppPlatformAPI
+      ? deleteFolderAppPlatform({ name: folder.uid })
+      : deleteFolderLegacy(folder));


Might be worth moving the feature toggle check/logic into the hook as we've done for the get case

aocenas and others added 22 commits June 18, 2025 16:16

Add /children endpoint

4ea5a35

Update folder client

fe84c8c

Add comment

a9c2f4c

Add feature toggle

d867638

Add new version of useFoldersQuery

187e977

Merge branch 'main' into aocenas/folders/migrate-api

db5b914

# Conflicts: # packages/grafana-data/src/types/featureToggles.gen.ts # pkg/services/featuremgmt/registry.go # pkg/services/featuremgmt/toggles_gen.csv # pkg/services/featuremgmt/toggles_gen.go

Error handling

c70aaff

Format

8e8ad40

Rename feature toggle

2a00788

Remove options and move root folder constant

c7f3908

Fix feature toggle merge

34bc654

Add feature toggle again

d1d959d

Rename useFoldersQuery files

421958b

Update API spec

d529ed1

Fix test

ea906e8

Add test

634cd2a

Migrate delete folder button

b86b98d

useGetFolderQueryFacade

845bbe6

Merge branch 'main' into aocenas/folders/migrate-api-2

a873b99

# Conflicts: # public/app/api/clients/folder/v1beta1/index.ts # public/app/core/components/NestedFolderPicker/useFoldersQueryAppPlatform.ts

Use getFolder facade hook

e7b4f3e

github-actions bot added the area/frontend label Jul 4, 2025

Recreate legacy getFolder from the APIs

06f0baa

github-actions bot added area/backend area/alerting Grafana Alerting labels Jul 9, 2025

github-project-automation bot added this to Alerting Jul 9, 2025

github-project-automation bot moved this to In review in Alerting Jul 9, 2025

aocenas added 2 commits July 9, 2025 19:05

Merge branch 'main' into aocenas/folders/migrate-api-2

802fa46

# Conflicts: # public/app/features/alerting/unified/hooks/useFolder.ts

Fix imports

7b30613

aocenas requested a review from a team as a code owner July 18, 2025 10:58

aocenas requested review from joshhunt, ashharrison90, gillesdemey, konrad147, soniaAguilarPeiron and konsalex and removed request for a team July 18, 2025 10:58

github-actions bot added this to the 12.1.x milestone Jul 18, 2025

ArturWierzbicki requested a review from ryantxu July 18, 2025 11:54

tomratcliffe reviewed Jul 18, 2025

View reviewed changes

aocenas added the no-changelog Skip including change in changelog/release notes label Jul 18, 2025

Add basic test for the hook

641c091

IevaVasiljeva approved these changes Jul 18, 2025

View reviewed changes

aocenas removed request for a team, joshhunt, ashharrison90, gillesdemey, konrad147, soniaAguilarPeiron, konsalex and chaudyg July 21, 2025 09:12

tomratcliffe reviewed Jul 21, 2025

View reviewed changes

ArturWierzbicki requested a review from stephaniehingtgen July 21, 2025 10:08

aocenas mentioned this pull request Jul 21, 2025

Epic: Folders: Migrate folder api to app platform #106768

Open

8 tasks

aocenas added 2 commits July 21, 2025 17:20

Remove commented import

d715ddb

Merge branch 'main' into aocenas/folders/migrate-api-2

d1b2fb9

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Folders: Migrate getFolder API to app platform #107617

Folders: Migrate getFolder API to app platform #107617

Uh oh!

aocenas commented Jul 4, 2025 •

edited

Loading

Uh oh!

tomratcliffe Jul 18, 2025

Uh oh!

aocenas Jul 18, 2025

Uh oh!

tomratcliffe commented Jul 18, 2025

Uh oh!

IevaVasiljeva left a comment

Uh oh!

IevaVasiljeva Jul 18, 2025

Uh oh!

aocenas Jul 21, 2025

Uh oh!

IevaVasiljeva Jul 21, 2025

Uh oh!

tomratcliffe Jul 18, 2025

Uh oh!

tomratcliffe Jul 21, 2025

Uh oh!

aocenas Jul 21, 2025

Uh oh!

tomratcliffe Jul 21, 2025

Uh oh!

aocenas Jul 21, 2025

Uh oh!

tomratcliffe Jul 21, 2025

Uh oh!

tomratcliffe Jul 21, 2025

Uh oh!

Uh oh!

		title: 'Shared with me',
		description: 'Dashboards and folders shared with me',

Folders: Migrate getFolder API to app platform #107617

Are you sure you want to change the base?

Folders: Migrate getFolder API to app platform #107617

Uh oh!

Conversation

aocenas commented Jul 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tomratcliffe commented Jul 18, 2025

Uh oh!

IevaVasiljeva left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

aocenas commented Jul 4, 2025 •

edited

Loading