Database governance built for humans and agents — controlling changes and access across every major database.
Go cicddata-governancedata-maskingdata-securitydatabase-accessdatabase-governancedevopsdevsecopsflywaygitopsliquibasemongodbmysqloraclepostgresqlschema-migrationssecuritysql-clientsqlservertidb
refactor(iam): move role cache to store with LRU+TTL (#18866)
p0ny16081dfea77f
diff --git a/backend/api/v1/role_service.go b/backend/api/v1/role_service.goindex 0a637a9f43..2a95bba8ea 100644--- a/backend/api/v1/role_service.go+++ b/backend/api/v1/role_service.go@@ -85,9 +85,9 @@ func (s *RoleService) CreateRole(ctx context.Context, req *connect.Request[v1pb.return nil, err}- permissions := make(map[string]bool)+ permissions := make(map[permission.Permission]bool)for _, v := range req.Msg.GetRole().GetPermissions() {- permissions[v] = true+ permissions[permission.Permission(v)] = true}create := &store.RoleMessage{ResourceID: req.Msg.RoleId,@@ -152,9 +152,9 @@ func (s *RoleService) UpdateRole(ctx context.Context, req *connect.Request[v1pb.case "description":patch.Description = &req.Msg.Role.Descriptioncase "permissions":- permissions := make(map[string]bool)+ permissions := make(map[permission.Permission]bool)for _, v := range req.Msg.GetRole().GetPermissions() {- permissions[v] = true+ permissions[permission.Permission(v)] = true}patch.Permissions = &permissionsif ok := permission.Exists(req.Msg.Role.Permissions...); !ok {diff --git a/backend/api/v1/sql_service.go b/backend/api/v1/sql_service.goindex 59a427b0db..e27764ef2a 100644--- a/backend/api/v1/sql_service.go+++ b/backend/api/v1/sql_service.go@@ -1642,7 +1642,7 @@ func (s *SQLService) hasDatabaseAccessRights() (bool, error) {bindings := utils.GetUserIAMPolicyBindings(ctx, s.store, user, iamPolicies...)for _, binding := range bindings {- permissions, err := s.iamManager.GetPermissions(binding.Role)+ permissions, err := s.iamManager.GetPermissions(ctx, binding.Role)if err != nil {return false, errors.Wrapf(err, "failed to get permissions")}diff --git a/backend/component/iam/manager.go b/backend/component/iam/manager.goindex f66854c941..fd25915277 100644--- a/backend/component/iam/manager.go+++ b/backend/component/iam/manager.go@@ -2,6 +2,7 @@ package iamimport ("context"+ "maps""strings""github.com/pkg/errors"@@ -15,9 +16,7 @@ import ()type Manager struct {- // rolePermissions is a map from role to permissions. Key is "roles/{role}".- rolePermissions map[string]map[permission.Permission]bool- groupMembers map[string]map[string]bool+ groupMembers map[string]map[string]bool// member - groups mappingmemberGroups map[string][]stringstore *store.Store@@ -36,11 +35,16 @@ func NewManager(store *store.Store, licenseService *enterprise.LicenseService) (// CEL on the binding is not considered.// When multiple projects are specified, the user should have permission on every projects.func (m *Manager) CheckPermission(ctx context.Context, p permission.Permission, user *store.UserMessage, projectIDs ...string) (bool, error) {+ getPermissions := func(role string) map[permission.Permission]bool {+ perms, _ := m.GetPermissions(ctx, role)+ return perms+ }+policyMessage, err := m.store.GetWorkspaceIamPolicy(ctx)if err != nil {return false, err}- if ok := check(user, p, policyMessage.Policy, m.rolePermissions, m.groupMembers); ok {+ if ok := check(user, p, policyMessage.Policy, getPermissions, m.groupMembers); ok {return true, nil}@@ -61,7 +65,7 @@ func (m *Manager) CheckPermission(ctx context.Context, p permission.Permission,if err != nil {return false, err}- if ok := check(user, p, policyMessage.Policy, m.rolePermissions, m.groupMembers); !ok {+ if ok := check(user, p, policyMessage.Policy, getPermissions, m.groupMembers); !ok {allOK = falsebreak}@@ -72,17 +76,6 @@ func (m *Manager) CheckPermission(ctx context.Context, p permission.Permission,}func (m *Manager) ReloadCache(ctx context.Context) error {- roles, err := m.store.ListRoles(ctx, &store.FindRoleMessage{})- if err != nil {- return err- }-- rolePermissions := make(map[string]map[permission.Permission]bool)- for _, role := range roles {- rolePermissions[common.FormatRole(role.ResourceID)] = role.Permissions- }- m.rolePermissions = rolePermissions-groups, err := m.store.ListGroups(ctx, &store.FindGroupMessage{})if err != nil {return err@@ -108,24 +101,28 @@ func (m *Manager) ReloadCache(ctx context.Context) error {// GetPermissions returns all permissions for the given role.// Role format is roles/{role}.-func (m *Manager) GetPermissions(role string) (map[permission.Permission]bool, error) {- permissions, ok := m.rolePermissions[role]- if !ok {+func (m *Manager) GetPermissions(ctx context.Context, roleName string) (map[permission.Permission]bool, error) {+ resourceID := strings.TrimPrefix(roleName, "roles/")+ role, err := m.store.GetRoleSnapshot(ctx, resourceID)+ if err != nil {+ return nil, err+ }+ if role == nil {return nil, nil}- return permissions, nil+ return maps.Clone(role.Permissions), nil}func (m *Manager) GetUserGroups(email string) []string {return m.memberGroups[common.FormatUserEmail(email)]}-func check(user *store.UserMessage, p permission.Permission, policy *storepb.IamPolicy, rolePermissions map[string]map[permission.Permission]bool, groupMembers map[string]map[string]bool) bool {+func check(user *store.UserMessage, p permission.Permission, policy *storepb.IamPolicy, getPermissions func(role string) map[permission.Permission]bool, groupMembers map[string]map[string]bool) bool {userName := common.FormatUserEmail(user.Email)for _, binding := range policy.GetBindings() {- permissions, ok := rolePermissions[binding.GetRole()]- if !ok {+ permissions := getPermissions(binding.GetRole())+ if permissions == nil {continue}if !permissions[p] {diff --git a/backend/component/iam/manager_test.go b/backend/component/iam/manager_test.goindex e229bbde0f..e023d5c3c9 100644--- a/backend/component/iam/manager_test.go+++ b/backend/component/iam/manager_test.go@@ -21,6 +21,9 @@ func TestCheck(t *testing.T) {for _, role := range store.PredefinedRoles {rolePermissions[common.FormatRole(role.ResourceID)] = role.Permissions}+ getPermissions := func(role string) map[permission.Permission]bool {+ return rolePermissions[role]+ }tests := []struct {permission permission.Permission@@ -99,7 +102,7 @@ func TestCheck(t *testing.T) {}}for i, test := range tests {- got := check(testUser, test.permission, test.policy, rolePermissions, test.groupMembers)+ got := check(testUser, test.permission, test.policy, getPermissions, test.groupMembers)if got != test.want {require.Equal(t, test.want, got, i)}diff --git a/backend/store/predefined_roles.go b/backend/store/predefined_roles.goindex a721c2f92a..aca39778b4 100644--- a/backend/store/predefined_roles.go+++ b/backend/store/predefined_roles.go@@ -15,8 +15,8 @@ const (ProjectViewerRole = "projectViewer")-func permissionSet(perms ...permission.Permission) map[string]bool {- m := make(map[string]bool, len(perms))+func permissionSet(perms ...permission.Permission) map[permission.Permission]bool {+ m := make(map[permission.Permission]bool, len(perms))for _, p := range perms {m[p] = true}diff --git a/backend/store/role.go b/backend/store/role.goindex 70b64ac3b3..3e58d673ac 100644--- a/backend/store/role.go+++ b/backend/store/role.go@@ -7,6 +7,7 @@ import ("google.golang.org/protobuf/encoding/protojson""github.com/bytebase/bytebase/backend/common"+ "github.com/bytebase/bytebase/backend/common/permission""github.com/bytebase/bytebase/backend/common/qb"storepb "github.com/bytebase/bytebase/backend/generated-go/store")@@ -16,7 +17,7 @@ type RoleMessage struct {ResourceID stringName stringDescription string- Permissions map[string]bool+ Permissions map[permission.Permission]boolPredefined bool}@@ -26,7 +27,7 @@ type UpdateRoleMessage struct {Name *stringDescription *string- Permissions *map[string]bool+ Permissions *map[permission.Permission]bool}// FindRoleMessage is the message for finding roles.@@ -107,14 +108,8 @@ func (s *Store) CreateRole(ctx context.Context, create *RoleMessage) (*RoleMessareturn create, nil}-// GetRole returns a role by ID.+// GetRole returns a role by ID with strong/consistent reads (no cache).func (s *Store) GetRole(ctx context.Context, find *FindRoleMessage) (*RoleMessage, error) {- if find.ResourceID != nil {- if v, ok := s.rolesCache.Get(*find.ResourceID); ok && s.enableCache {- return v, nil- }- }-roles, err := s.ListRoles(ctx, find)if err != nil {return nil, err@@ -131,6 +126,15 @@ func (s *Store) GetRole(ctx context.Context, find *FindRoleMessage) (*RoleMessagreturn role, nil}+// GetRoleSnapshot returns a role by ID with snapshot reads (with cache).+// Trades consistency for performance.+func (s *Store) GetRoleSnapshot(ctx context.Context, resourceID string) (*RoleMessage, error) {+ if v, ok := s.rolesCache.Get(resourceID); ok {+ return v, nil+ }+ return s.GetRole(ctx, &FindRoleMessage{ResourceID: &resourceID})+}+// ListRoles returns a list of roles.func (s *Store) ListRoles(ctx context.Context, find *FindRoleMessage) ([]*RoleMessage, error) {// If looking for a specific role, check predefined first@@ -165,7 +169,7 @@ func (s *Store) ListRoles(ctx context.Context, find *FindRoleMessage) ([]*RoleMevar roles []*RoleMessagefor rows.Next() {role := &RoleMessage{- Permissions: map[string]bool{},+ Permissions: map[permission.Permission]bool{},}var permissionBytes []byteif err := rows.Scan(&role.ResourceID, &role.Name, &role.Description, &permissionBytes); err != nil {@@ -232,7 +236,7 @@ func (s *Store) UpdateRole(ctx context.Context, patch *UpdateRoleMessage) (*Rolerole := &RoleMessage{ResourceID: patch.ResourceID,- Permissions: map[string]bool{},+ Permissions: map[permission.Permission]bool{},}var permissionBytes []byteif err := s.GetDB().QueryRowContext(ctx, query, args...).Scan(&role.Name, &role.Description, &permissionBytes); err != nil {diff --git a/backend/store/store.go b/backend/store/store.goindex 853252749c..b9c6bf9cfe 100644--- a/backend/store/store.go+++ b/backend/store/store.go@@ -5,8 +5,10 @@ import ("context""database/sql""fmt"+ "time"lru "github.com/hashicorp/golang-lru/v2"+ "github.com/hashicorp/golang-lru/v2/expirable"storepb "github.com/bytebase/bytebase/backend/generated-go/store")@@ -24,7 +26,7 @@ type Store struct {projectCache *lru.Cache[string, *ProjectMessage]policyCache *lru.Cache[string, *PolicyMessage]settingCache *lru.Cache[storepb.SettingName, *SettingMessage]- rolesCache *lru.Cache[string, *RoleMessage]+ rolesCache *expirable.LRU[string, *RoleMessage]groupCache *lru.Cache[string, *GroupMessage]// Large objects.@@ -58,10 +60,7 @@ func New(ctx context.Context, pgURL string, enableCache bool) (*Store, error) {if err != nil {return nil, err}- rolesCache, err := lru.New[string, *RoleMessage](64)- if err != nil {- return nil, err- }+ rolesCache := expirable.NewLRU[string, *RoleMessage](128, nil, time.Minute)sheetFullCache, err := lru.New[string, *SheetMessage](10)if err != nil {return nil, err