From bb2e0dad2217cbcc1c4a581886cbef4004fb3993 Mon Sep 17 00:00:00 2001 From: Sofia Papagiannaki <1632407+papagian@users.noreply.github.com> Date: Thu, 18 Jan 2024 16:12:49 +0200 Subject: [PATCH] Chore: Rename folder service query variables for consistency (#80735) Chore: Rename service query variables for consistency --- pkg/services/folder/folderimpl/folder.go | 48 ++++++++++---------- pkg/services/folder/folderimpl/sqlstore.go | 6 +-- pkg/services/folder/folderimpl/store.go | 6 +-- pkg/services/folder/folderimpl/store_fake.go | 2 +- pkg/services/folder/foldertest/foldertest.go | 6 +-- pkg/services/folder/service.go | 6 +-- 6 files changed, 37 insertions(+), 37 deletions(-) diff --git a/pkg/services/folder/folderimpl/folder.go b/pkg/services/folder/folderimpl/folder.go index 5ac459669d9..a5c15b246af 100644 --- a/pkg/services/folder/folderimpl/folder.go +++ b/pkg/services/folder/folderimpl/folder.go @@ -77,31 +77,31 @@ func ProvideService( return srv } -func (s *Service) Get(ctx context.Context, cmd *folder.GetFolderQuery) (*folder.Folder, error) { - if cmd.SignedInUser == nil { +func (s *Service) Get(ctx context.Context, q *folder.GetFolderQuery) (*folder.Folder, error) { + if q.SignedInUser == nil { return nil, folder.ErrBadRequest.Errorf("missing signed in user") } - if s.features.IsEnabled(ctx, featuremgmt.FlagNestedFolders) && cmd.UID != nil && *cmd.UID == folder.SharedWithMeFolderUID { + if s.features.IsEnabled(ctx, featuremgmt.FlagNestedFolders) && q.UID != nil && *q.UID == folder.SharedWithMeFolderUID { return folder.SharedWithMeFolder.WithURL(), nil } var dashFolder *folder.Folder var err error switch { - case cmd.UID != nil && *cmd.UID != "": - dashFolder, err = s.getFolderByUID(ctx, cmd.OrgID, *cmd.UID) + case q.UID != nil && *q.UID != "": + dashFolder, err = s.getFolderByUID(ctx, q.OrgID, *q.UID) if err != nil { return nil, err } // nolint:staticcheck - case cmd.ID != nil: - dashFolder, err = s.getFolderByID(ctx, *cmd.ID, cmd.OrgID) + case q.ID != nil: + dashFolder, err = s.getFolderByID(ctx, *q.ID, q.OrgID) if err != nil { return nil, err } - case cmd.Title != nil: - dashFolder, err = s.getFolderByTitle(ctx, cmd.OrgID, *cmd.Title) + case q.Title != nil: + dashFolder, err = s.getFolderByTitle(ctx, q.OrgID, *q.Title) if err != nil { return nil, err } @@ -116,7 +116,7 @@ func (s *Service) Get(ctx context.Context, cmd *folder.GetFolderQuery) (*folder. // do not get guardian by the folder ID because it differs from the nested folder ID // and the legacy folder ID has been associated with the permissions: // use the folde UID instead that is the same for both - g, err := guardian.NewByFolder(ctx, dashFolder, dashFolder.OrgID, cmd.SignedInUser) + g, err := guardian.NewByFolder(ctx, dashFolder, dashFolder.OrgID, q.SignedInUser) if err != nil { return nil, err } @@ -133,12 +133,12 @@ func (s *Service) Get(ctx context.Context, cmd *folder.GetFolderQuery) (*folder. } // nolint:staticcheck - if cmd.ID != nil { - cmd.ID = nil - cmd.UID = &dashFolder.UID + if q.ID != nil { + q.ID = nil + q.UID = &dashFolder.UID } - f, err := s.store.Get(ctx, *cmd) + f, err := s.store.Get(ctx, *q) if err != nil { return nil, err } @@ -270,14 +270,14 @@ func (s *Service) getRootFolders(ctx context.Context, q *folder.GetChildrenQuery } // GetSharedWithMe returns folders available to user, which cannot be accessed from the root folders -func (s *Service) GetSharedWithMe(ctx context.Context, cmd *folder.GetChildrenQuery) ([]*folder.Folder, error) { +func (s *Service) GetSharedWithMe(ctx context.Context, q *folder.GetChildrenQuery) ([]*folder.Folder, error) { start := time.Now() - availableNonRootFolders, err := s.getAvailableNonRootFolders(ctx, cmd.OrgID, cmd.SignedInUser) + availableNonRootFolders, err := s.getAvailableNonRootFolders(ctx, q.OrgID, q.SignedInUser) if err != nil { s.metrics.sharedWithMeFetchFoldersRequestsDuration.WithLabelValues("failure").Observe(time.Since(start).Seconds()) return nil, folder.ErrInternal.Errorf("failed to fetch subfolders to which the user has explicit access: %w", err) } - rootFolders, err := s.GetChildren(ctx, &folder.GetChildrenQuery{UID: "", OrgID: cmd.OrgID, SignedInUser: cmd.SignedInUser}) + rootFolders, err := s.GetChildren(ctx, &folder.GetChildrenQuery{UID: "", OrgID: q.OrgID, SignedInUser: q.SignedInUser}) if err != nil { s.metrics.sharedWithMeFetchFoldersRequestsDuration.WithLabelValues("failure").Observe(time.Since(start).Seconds()) return nil, folder.ErrInternal.Errorf("failed to fetch root folders to which the user has access: %w", err) @@ -835,22 +835,22 @@ func (s *Service) nestedFolderDelete(ctx context.Context, cmd *folder.DeleteFold return result, nil } -func (s *Service) GetDescendantCounts(ctx context.Context, cmd *folder.GetDescendantCountsQuery) (folder.DescendantCounts, error) { +func (s *Service) GetDescendantCounts(ctx context.Context, q *folder.GetDescendantCountsQuery) (folder.DescendantCounts, error) { logger := s.log.FromContext(ctx) - if cmd.SignedInUser == nil { + if q.SignedInUser == nil { return nil, folder.ErrBadRequest.Errorf("missing signed-in user") } - if *cmd.UID == "" { + if *q.UID == "" { return nil, folder.ErrBadRequest.Errorf("missing UID") } - if cmd.OrgID < 1 { + if q.OrgID < 1 { return nil, folder.ErrBadRequest.Errorf("invalid orgID") } - result := []string{*cmd.UID} + result := []string{*q.UID} countsMap := make(folder.DescendantCounts, len(s.registry)+1) if s.features.IsEnabled(ctx, featuremgmt.FlagNestedFolders) { - subfolders, err := s.getNestedFolders(ctx, cmd.OrgID, *cmd.UID) + subfolders, err := s.getNestedFolders(ctx, q.OrgID, *q.UID) if err != nil { logger.Error("failed to get subfolders", "error", err) return nil, err @@ -861,7 +861,7 @@ func (s *Service) GetDescendantCounts(ctx context.Context, cmd *folder.GetDescen for _, v := range s.registry { for _, folder := range result { - c, err := v.CountInFolder(ctx, cmd.OrgID, folder, cmd.SignedInUser) + c, err := v.CountInFolder(ctx, q.OrgID, folder, q.SignedInUser) if err != nil { logger.Error("failed to count folder descendants", "error", err) return nil, err diff --git a/pkg/services/folder/folderimpl/sqlstore.go b/pkg/services/folder/folderimpl/sqlstore.go index af2ff915ea3..5f526da5801 100644 --- a/pkg/services/folder/folderimpl/sqlstore.go +++ b/pkg/services/folder/folderimpl/sqlstore.go @@ -286,10 +286,10 @@ func (ss *sqlStore) GetChildren(ctx context.Context, q folder.GetChildrenQuery) return folders, err } -func (ss *sqlStore) getParentsMySQL(ctx context.Context, cmd folder.GetParentsQuery) (folders []*folder.Folder, err error) { +func (ss *sqlStore) getParentsMySQL(ctx context.Context, q folder.GetParentsQuery) (folders []*folder.Folder, err error) { err = ss.db.WithDbSession(ctx, func(sess *db.Session) error { uid := "" - ok, err := sess.SQL("SELECT parent_uid FROM folder WHERE org_id=? AND uid=?", cmd.OrgID, cmd.UID).Get(&uid) + ok, err := sess.SQL("SELECT parent_uid FROM folder WHERE org_id=? AND uid=?", q.OrgID, q.UID).Get(&uid) if err != nil { return err } @@ -298,7 +298,7 @@ func (ss *sqlStore) getParentsMySQL(ctx context.Context, cmd folder.GetParentsQu } for { f := &folder.Folder{} - ok, err := sess.SQL("SELECT * FROM folder WHERE org_id=? AND uid=?", cmd.OrgID, uid).Get(f) + ok, err := sess.SQL("SELECT * FROM folder WHERE org_id=? AND uid=?", q.OrgID, uid).Get(f) if err != nil { return err } diff --git a/pkg/services/folder/folderimpl/store.go b/pkg/services/folder/folderimpl/store.go index b6dca0ef4b5..4472593c268 100644 --- a/pkg/services/folder/folderimpl/store.go +++ b/pkg/services/folder/folderimpl/store.go @@ -21,14 +21,14 @@ type store interface { Update(ctx context.Context, cmd folder.UpdateFolderCommand) (*folder.Folder, error) // Get returns a folder. - Get(ctx context.Context, cmd folder.GetFolderQuery) (*folder.Folder, error) + Get(ctx context.Context, q folder.GetFolderQuery) (*folder.Folder, error) // GetParents returns an ordered list of parent folder of the given folder. - GetParents(ctx context.Context, cmd folder.GetParentsQuery) ([]*folder.Folder, error) + GetParents(ctx context.Context, q folder.GetParentsQuery) ([]*folder.Folder, error) // GetChildren returns the set of immediate children folders (depth=1) of the // given folder. - GetChildren(ctx context.Context, cmd folder.GetChildrenQuery) ([]*folder.Folder, error) + GetChildren(ctx context.Context, q folder.GetChildrenQuery) ([]*folder.Folder, error) // GetHeight returns the height of the folder tree. When parentUID is set, the function would // verify in the meanwhile that parentUID is not present in the subtree of the folder with the given UID. diff --git a/pkg/services/folder/folderimpl/store_fake.go b/pkg/services/folder/folderimpl/store_fake.go index 7c6a63457cc..c373d44674c 100644 --- a/pkg/services/folder/folderimpl/store_fake.go +++ b/pkg/services/folder/folderimpl/store_fake.go @@ -45,7 +45,7 @@ func (f *fakeStore) Get(ctx context.Context, cmd folder.GetFolderQuery) (*folder return f.ExpectedFolder, f.ExpectedError } -func (f *fakeStore) GetParents(ctx context.Context, cmd folder.GetParentsQuery) ([]*folder.Folder, error) { +func (f *fakeStore) GetParents(ctx context.Context, q folder.GetParentsQuery) ([]*folder.Folder, error) { return f.ExpectedParentFolders, f.ExpectedError } diff --git a/pkg/services/folder/foldertest/foldertest.go b/pkg/services/folder/foldertest/foldertest.go index a1fbf4368bb..8a0864985b4 100644 --- a/pkg/services/folder/foldertest/foldertest.go +++ b/pkg/services/folder/foldertest/foldertest.go @@ -19,7 +19,7 @@ func NewFakeService() *FakeService { var _ folder.Service = (*FakeService)(nil) -func (s *FakeService) GetChildren(ctx context.Context, cmd *folder.GetChildrenQuery) ([]*folder.Folder, error) { +func (s *FakeService) GetChildren(ctx context.Context, q *folder.GetChildrenQuery) ([]*folder.Folder, error) { return s.ExpectedFolders, s.ExpectedError } @@ -30,7 +30,7 @@ func (s *FakeService) GetParents(ctx context.Context, q folder.GetParentsQuery) func (s *FakeService) Create(ctx context.Context, cmd *folder.CreateFolderCommand) (*folder.Folder, error) { return s.ExpectedFolder, s.ExpectedError } -func (s *FakeService) Get(ctx context.Context, cmd *folder.GetFolderQuery) (*folder.Folder, error) { +func (s *FakeService) Get(ctx context.Context, q *folder.GetFolderQuery) (*folder.Folder, error) { return s.ExpectedFolder, s.ExpectedError } func (s *FakeService) Update(ctx context.Context, cmd *folder.UpdateFolderCommand) (*folder.Folder, error) { @@ -48,6 +48,6 @@ func (s *FakeService) RegisterService(service folder.RegistryService) error { return s.ExpectedError } -func (s *FakeService) GetDescendantCounts(ctx context.Context, cmd *folder.GetDescendantCountsQuery) (folder.DescendantCounts, error) { +func (s *FakeService) GetDescendantCounts(ctx context.Context, q *folder.GetDescendantCountsQuery) (folder.DescendantCounts, error) { return s.ExpectedDescendantCounts, s.ExpectedError } diff --git a/pkg/services/folder/service.go b/pkg/services/folder/service.go index 03d2bc3a777..7bca2417a9d 100644 --- a/pkg/services/folder/service.go +++ b/pkg/services/folder/service.go @@ -6,7 +6,7 @@ import ( type Service interface { // GetChildren returns an array containing all child folders. - GetChildren(ctx context.Context, cmd *GetChildrenQuery) ([]*Folder, error) + GetChildren(ctx context.Context, q *GetChildrenQuery) ([]*Folder, error) // GetParents returns an array containing add parent folders if nested folders are enabled // otherwise it returns an empty array GetParents(ctx context.Context, q GetParentsQuery) ([]*Folder, error) @@ -16,7 +16,7 @@ type Service interface { // request. One of UID, ID or Title must be included. If multiple values // are included in the request, Grafana will select one in order of // specificity (UID, ID, Title). - Get(ctx context.Context, cmd *GetFolderQuery) (*Folder, error) + Get(ctx context.Context, q *GetFolderQuery) (*Folder, error) // Update is used to update a folder's UID, Title and Description. To change // a folder's parent folder, use Move. @@ -25,7 +25,7 @@ type Service interface { // Move changes a folder's parent folder to the requested new parent. Move(ctx context.Context, cmd *MoveFolderCommand) (*Folder, error) RegisterService(service RegistryService) error - GetDescendantCounts(ctx context.Context, cmd *GetDescendantCountsQuery) (DescendantCounts, error) + GetDescendantCounts(ctx context.Context, q *GetDescendantCountsQuery) (DescendantCounts, error) } // FolderStore is a folder store.