Skip to content

Commit 9db3bc9

Browse files
ryantxuryantxu
authored
Identity: Rename "namespace" to "type" in the requester interface (#90567)
1 parent 8cdf5ee commit 9db3bc9

File tree

109 files changed

+651
-634
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

109 files changed

+651
-634
lines changed

‎pkg/api/admin_users.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@ import (
1010

1111
"github.com/grafana/grafana/pkg/api/dtos"
1212
"github.com/grafana/grafana/pkg/api/response"
13+
"github.com/grafana/grafana/pkg/apimachinery/identity"
1314
"github.com/grafana/grafana/pkg/infra/metrics"
1415
"github.com/grafana/grafana/pkg/services/accesscontrol"
1516
"github.com/grafana/grafana/pkg/services/auth"
16-
"github.com/grafana/grafana/pkg/services/authn"
1717
contextmodel "github.com/grafana/grafana/pkg/services/contexthandler/model"
1818
"github.com/grafana/grafana/pkg/services/login"
1919
"github.com/grafana/grafana/pkg/services/org"
@@ -366,7 +366,7 @@ func (hs *HTTPServer) AdminLogoutUser(c *contextmodel.ReqContext) response.Respo
366366
return response.Error(http.StatusBadRequest, "id is invalid", err)
367367
}
368368

369-
if c.SignedInUser.GetID() == authn.NewNamespaceID(authn.NamespaceUser, userID) {
369+
if c.SignedInUser.GetID() == identity.NewTypedID(identity.TypeUser, userID) {
370370
return response.Error(http.StatusBadRequest, "You cannot logout yourself", nil)
371371
}
372372

‎pkg/api/common_test.go‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ import (
1616

1717
"github.com/grafana/grafana/pkg/api/response"
1818
"github.com/grafana/grafana/pkg/api/routing"
19+
"github.com/grafana/grafana/pkg/apimachinery/identity"
1920
"github.com/grafana/grafana/pkg/infra/db"
2021
"github.com/grafana/grafana/pkg/infra/fs"
2122
"github.com/grafana/grafana/pkg/infra/tracing"
@@ -189,7 +190,7 @@ func getContextHandler(t *testing.T, cfg *setting.Cfg) *contexthandler.ContextHa
189190
return contexthandler.ProvideService(
190191
cfg,
191192
tracing.InitializeTracerForTest(),
192-
&authntest.FakeService{ExpectedIdentity: &authn.Identity{ID: authn.AnonymousNamespaceID, SessionToken: &usertoken.UserToken{}}},
193+
&authntest.FakeService{ExpectedIdentity: &authn.Identity{ID: identity.AnonymousTypedID, SessionToken: &usertoken.UserToken{}}},
193194
)
194195
}
195196

‎pkg/api/dashboard.go‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -43,9 +43,9 @@ func (hs *HTTPServer) isDashboardStarredByUser(c *contextmodel.ReqContext, dashI
4343
return false, nil
4444
}
4545

46-
namespaceID, userIDstr := c.SignedInUser.GetNamespacedID()
46+
namespaceID, userIDstr := c.SignedInUser.GetTypedID()
4747

48-
if namespaceID != identity.NamespaceUser {
48+
if namespaceID != identity.TypeUser {
4949
return false, nil
5050
}
5151

@@ -436,7 +436,7 @@ func (hs *HTTPServer) deleteDashboard(c *contextmodel.ReqContext) response.Respo
436436
return response.Error(http.StatusBadRequest, "Use folders endpoint for deleting folders.", nil)
437437
}
438438

439-
namespaceID, userIDStr := c.SignedInUser.GetNamespacedID()
439+
namespaceID, userIDStr := c.SignedInUser.GetTypedID()
440440

441441
// disconnect all library elements for this dashboard
442442
err = hs.LibraryElementService.DisconnectElementsFromDashboard(c.Req.Context(), dash.ID)
@@ -513,8 +513,8 @@ func (hs *HTTPServer) postDashboard(c *contextmodel.ReqContext, cmd dashboards.S
513513
var err error
514514

515515
userID := int64(0)
516-
namespaceID, userIDstr := c.SignedInUser.GetNamespacedID()
517-
if namespaceID != identity.NamespaceUser && namespaceID != identity.NamespaceServiceAccount {
516+
namespaceID, userIDstr := c.SignedInUser.GetTypedID()
517+
if namespaceID != identity.TypeUser && namespaceID != identity.TypeServiceAccount {
518518
hs.log.Debug("User does not belong to a user or service account namespace", "namespaceID", namespaceID, "userID", userIDstr)
519519
} else {
520520
userID, err = identity.IntIdentifier(namespaceID, userIDstr)
@@ -631,8 +631,8 @@ func (hs *HTTPServer) postDashboard(c *contextmodel.ReqContext, cmd dashboards.S
631631
func (hs *HTTPServer) GetHomeDashboard(c *contextmodel.ReqContext) response.Response {
632632
userID := int64(0)
633633
var err error
634-
namespaceID, userIDstr := c.SignedInUser.GetNamespacedID()
635-
if namespaceID != identity.NamespaceUser && namespaceID != identity.NamespaceServiceAccount {
634+
namespaceID, userIDstr := c.SignedInUser.GetTypedID()
635+
if namespaceID != identity.TypeUser && namespaceID != identity.TypeServiceAccount {
636636
hs.log.Debug("User does not belong to a user or service account namespace", "namespaceID", namespaceID, "userID", userIDstr)
637637
} else {
638638
userID, err = identity.IntIdentifier(namespaceID, userIDstr)
@@ -1083,8 +1083,8 @@ func (hs *HTTPServer) RestoreDashboardVersion(c *contextmodel.ReqContext) respon
10831083
}
10841084

10851085
userID := int64(0)
1086-
namespaceID, userIDstr := c.SignedInUser.GetNamespacedID()
1087-
if namespaceID != identity.NamespaceUser && namespaceID != identity.NamespaceServiceAccount {
1086+
namespaceID, userIDstr := c.SignedInUser.GetTypedID()
1087+
if namespaceID != identity.TypeUser && namespaceID != identity.TypeServiceAccount {
10881088
hs.log.Warn("User does not belong to a user or service account namespace", "namespaceID", namespaceID, "userID", userIDstr)
10891089
} else {
10901090
userID, err = identity.IntIdentifier(namespaceID, userIDstr)

‎pkg/api/datasources.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -442,7 +442,7 @@ func (hs *HTTPServer) AddDataSource(c *contextmodel.ReqContext) response.Respons
442442
return response.Error(http.StatusBadRequest, "bad request data", err)
443443
}
444444

445-
userID, err := identity.UserIdentifier(c.SignedInUser.GetNamespacedID())
445+
userID, err := identity.UserIdentifier(c.SignedInUser.GetTypedID())
446446
if err != nil {
447447
return response.Error(http.StatusInternalServerError,
448448
"Failed to add datasource", err)

‎pkg/api/folder.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -194,8 +194,8 @@ func (hs *HTTPServer) setDefaultFolderPermissions(ctx context.Context, orgID int
194194
var permissions []accesscontrol.SetResourcePermissionCommand
195195
var userID int64
196196

197-
namespace, id := user.GetNamespacedID()
198-
if namespace == identity.NamespaceUser {
197+
namespace, id := user.GetTypedID()
198+
if namespace == identity.TypeUser {
199199
var errID error
200200
userID, errID = identity.IntIdentifier(namespace, id)
201201
if errID != nil {

‎pkg/api/index.go‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ func (hs *HTTPServer) setIndexViewData(c *contextmodel.ReqContext) (*dtos.IndexV
2828
return nil, err
2929
}
3030

31-
userID, _ := identity.UserIdentifier(c.SignedInUser.GetNamespacedID())
31+
userID, _ := identity.UserIdentifier(c.SignedInUser.GetTypedID())
3232

3333
prefsQuery := pref.GetPreferenceWithDefaultsQuery{UserID: userID, OrgID: c.SignedInUser.GetOrgID(), Teams: c.Teams}
3434
prefs, err := hs.preferenceService.GetWithDefaults(c.Req.Context(), &prefsQuery)
@@ -166,10 +166,10 @@ func (hs *HTTPServer) setIndexViewData(c *contextmodel.ReqContext) (*dtos.IndexV
166166
}
167167

168168
func (hs *HTTPServer) buildUserAnalyticsSettings(c *contextmodel.ReqContext) dtos.AnalyticsSettings {
169-
namespace, _ := c.SignedInUser.GetNamespacedID()
169+
namespace, _ := c.SignedInUser.GetTypedID()
170170

171171
// Anonymous users do not have an email or auth info
172-
if namespace != identity.NamespaceUser {
172+
if namespace != identity.TypeUser {
173173
return dtos.AnalyticsSettings{Identifier: "@" + hs.Cfg.AppURL}
174174
}
175175

‎pkg/api/login.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -257,7 +257,7 @@ func (hs *HTTPServer) Logout(c *contextmodel.ReqContext) {
257257
return
258258
}
259259

260-
_, id := c.SignedInUser.GetNamespacedID()
260+
_, id := c.SignedInUser.GetTypedID()
261261
hs.log.Info("Successful Logout", "userID", id)
262262
c.Redirect(redirect.URL)
263263
}
@@ -305,7 +305,7 @@ func (hs *HTTPServer) redirectURLWithErrorCookie(c *contextmodel.ReqContext, err
305305
var userID int64
306306
if c.SignedInUser != nil && !c.SignedInUser.IsNil() {
307307
var errID error
308-
userID, errID = identity.UserIdentifier(c.SignedInUser.GetNamespacedID())
308+
userID, errID = identity.UserIdentifier(c.SignedInUser.GetTypedID())
309309
if errID != nil {
310310
hs.log.Error("failed to retrieve user ID", "error", errID)
311311
}

‎pkg/api/login_test.go‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ import (
1818
"github.com/grafana/grafana/pkg/api/dtos"
1919
"github.com/grafana/grafana/pkg/api/response"
2020
"github.com/grafana/grafana/pkg/api/routing"
21+
"github.com/grafana/grafana/pkg/apimachinery/identity"
2122
"github.com/grafana/grafana/pkg/components/simplejson"
2223
"github.com/grafana/grafana/pkg/infra/log"
2324
"github.com/grafana/grafana/pkg/login/social"
@@ -331,7 +332,7 @@ func TestLoginPostRedirect(t *testing.T) {
331332
HooksService: &hooks.HooksService{},
332333
License: &licensing.OSSLicensingService{},
333334
authnService: &authntest.FakeService{
334-
ExpectedIdentity: &authn.Identity{ID: authn.MustParseNamespaceID("user:42"), SessionToken: &usertoken.UserToken{}},
335+
ExpectedIdentity: &authn.Identity{ID: identity.MustParseTypedID("user:42"), SessionToken: &usertoken.UserToken{}},
335336
},
336337
AuthTokenService: authtest.NewFakeUserAuthTokenService(),
337338
Features: featuremgmt.WithFeatures(),

‎pkg/api/org.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -132,8 +132,8 @@ func (hs *HTTPServer) CreateOrg(c *contextmodel.ReqContext) response.Response {
132132
return response.Error(http.StatusBadRequest, "bad request data", err)
133133
}
134134

135-
namespace, identifier := c.SignedInUser.GetNamespacedID()
136-
if namespace != identity.NamespaceUser {
135+
namespace, identifier := c.SignedInUser.GetTypedID()
136+
if namespace != identity.TypeUser {
137137
return response.Error(http.StatusForbidden, "Only users can create organizations", nil)
138138
}
139139

‎pkg/api/org_invite.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -101,9 +101,9 @@ func (hs *HTTPServer) AddOrgInvite(c *contextmodel.ReqContext) response.Response
101101
cmd.Name = inviteDto.Name
102102
cmd.Status = tempuser.TmpUserInvitePending
103103

104-
namespace, identifier := c.SignedInUser.GetNamespacedID()
104+
namespace, identifier := c.SignedInUser.GetTypedID()
105105
var userID int64
106-
if namespace == identity.NamespaceUser || namespace == identity.NamespaceServiceAccount {
106+
if namespace == identity.TypeUser || namespace == identity.TypeServiceAccount {
107107
var err error
108108
userID, err = strconv.ParseInt(identifier, 10, 64)
109109
if err != nil {

0 commit comments

Comments
 (0)