Skip to content

Modern Docker Management, Designed for Everyone

perf: batch API key permission hydration (#3277)

Kyle Mendellba21ac265edf
diff --git a/backend/internal/models/api_key.go b/backend/internal/models/api_key.go
index cbe9729cd..438b992cd 100644
--- a/backend/internal/models/api_key.go
+++ b/backend/internal/models/api_key.go
@@ -15,16 +15,17 @@ const (
type ApiKey struct {
BaseModel
- Name string `json:"name" gorm:"column:name;not null" sortable:"true"`
- Description *string `json:"description,omitempty" gorm:"column:description"`
- KeyHash string `json:"-" gorm:"column:key_hash;not null"`
- KeyPrefix string `json:"keyPrefix" gorm:"column:key_prefix;not null"`
- ManagedBy *string `json:"-" gorm:"column:managed_by"`
- Kind string `json:"kind" gorm:"column:kind;not null;default:scoped"`
- UserID *string `json:"userId,omitempty" gorm:"column:user_id"`
- EnvironmentID *string `json:"environmentId,omitempty" gorm:"column:environment_id"`
- ExpiresAt *time.Time `json:"expiresAt,omitempty" gorm:"column:expires_at" sortable:"true"`
- LastUsedAt *time.Time `json:"lastUsedAt,omitempty" gorm:"column:last_used_at" sortable:"true"`
+ Name string `json:"name" gorm:"column:name;not null" sortable:"true"`
+ Description *string `json:"description,omitempty" gorm:"column:description"`
+ KeyHash string `json:"-" gorm:"column:key_hash;not null"`
+ KeyPrefix string `json:"keyPrefix" gorm:"column:key_prefix;not null"`
+ ManagedBy *string `json:"-" gorm:"column:managed_by"`
+ Kind string `json:"kind" gorm:"column:kind;not null;default:scoped"`
+ UserID *string `json:"userId,omitempty" gorm:"column:user_id"`
+ EnvironmentID *string `json:"environmentId,omitempty" gorm:"column:environment_id"`
+ ExpiresAt *time.Time `json:"expiresAt,omitempty" gorm:"column:expires_at" sortable:"true"`
+ LastUsedAt *time.Time `json:"lastUsedAt,omitempty" gorm:"column:last_used_at" sortable:"true"`
+ PermissionGrants []ApiKeyPermission `json:"-" gorm:"foreignKey:ApiKeyID;references:ID;constraint:OnDelete:CASCADE"`
}
func (ApiKey) TableName() string {
diff --git a/backend/internal/services/api_key_service.go b/backend/internal/services/api_key_service.go
index 2b712029f..e0ca3b6f8 100644
--- a/backend/internal/services/api_key_service.go
+++ b/backend/internal/services/api_key_service.go
@@ -299,9 +299,15 @@ func toAPIKeyDTOInternal(ak *models.ApiKey) apikey.ApiKey {
// toAPIKeyDTOWithPermissionsInternal is like toAPIKeyDTOInternal but
// additionally attaches the key's persisted permission grants.
-func (s *ApiKeyService) toAPIKeyDTOWithPermissionsInternal(ctx context.Context, ak *models.ApiKey) apikey.ApiKey {
+func toAPIKeyDTOWithPermissionsInternal(ak *models.ApiKey) apikey.ApiKey {
dto := toAPIKeyDTOInternal(ak)
- dto.Permissions = s.loadKeyGrantsInternal(ctx, ak.ID)
+ dto.Permissions = make([]apikey.PermissionGrant, len(ak.PermissionGrants))
+ for i, grant := range ak.PermissionGrants {
+ dto.Permissions[i] = apikey.PermissionGrant{
+ Permission: grant.Permission,
+ EnvironmentID: grant.EnvironmentID,
+ }
+ }
return dto
}
@@ -488,18 +494,25 @@ func (s *ApiKeyService) CreateEnvironmentApiKey(ctx context.Context, environment
func (s *ApiKeyService) GetApiKey(ctx context.Context, id string) (*apikey.ApiKey, error) {
var ak models.ApiKey
- if err := s.db.WithContext(ctx).Where("id = ?", id).First(&ak).Error; err != nil {
+ query := s.db.WithContext(ctx)
+ if s.roleService != nil {
+ query = query.Preload("PermissionGrants")
+ }
+ if err := query.Where("id = ?", id).First(&ak).Error; err != nil {
if errors.Is(err, gorm.ErrRecordNotFound) {
return nil, ErrApiKeyNotFound
}
return nil, fmt.Errorf("failed to get API key: %w", err)
}
- return new(s.toAPIKeyDTOWithPermissionsInternal(ctx, &ak)), nil
+ return new(toAPIKeyDTOWithPermissionsInternal(&ak)), nil
}
func (s *ApiKeyService) ListApiKeys(ctx context.Context, params pagination.QueryParams) ([]apikey.ApiKey, pagination.Response, error) {
var apiKeys []models.ApiKey
query := s.db.WithContext(ctx).Model(&models.ApiKey{})
+ if s.roleService != nil {
+ query = query.Preload("PermissionGrants")
+ }
if term := strings.TrimSpace(params.Search); term != "" {
searchPattern := "%" + term + "%"
@@ -519,7 +532,7 @@ func (s *ApiKeyService) ListApiKeys(ctx context.Context, params pagination.Query
// Include per-key permission grants so the edit form preloads with the
// key's actual current grants. Without this, the form starts empty and
// "Save" would wipe whatever grants the DB has.
- result[i] = s.toAPIKeyDTOWithPermissionsInternal(ctx, &apiKeys[i])
+ result[i] = toAPIKeyDTOWithPermissionsInternal(&apiKeys[i])
}
return result, paginationResp, nil
@@ -529,7 +542,11 @@ func (s *ApiKeyService) ListApiKeys(ctx context.Context, params pagination.Query
// userID. Used by the self-service personal-keys flow.
func (s *ApiKeyService) ListApiKeysByUser(ctx context.Context, userID string) ([]apikey.ApiKey, error) {
var apiKeys []models.ApiKey
- if err := s.db.WithContext(ctx).
+ query := s.db.WithContext(ctx)
+ if s.roleService != nil {
+ query = query.Preload("PermissionGrants")
+ }
+ if err := query.
Where("user_id = ?", userID).
Order("created_at DESC").
Find(&apiKeys).Error; err != nil {
@@ -541,7 +558,7 @@ func (s *ApiKeyService) ListApiKeysByUser(ctx context.Context, userID string) ([
if isStaticAPIKeyInternal(apiKeys[i]) || isEnvironmentBootstrapKeyInternal(apiKeys[i]) {
continue
}
- result = append(result, s.toAPIKeyDTOWithPermissionsInternal(ctx, &apiKeys[i]))
+ result = append(result, toAPIKeyDTOWithPermissionsInternal(&apiKeys[i]))
}
return result, nil
}
diff --git a/backend/internal/services/api_key_service_test.go b/backend/internal/services/api_key_service_test.go
index 5d766b45d..1f1bed5c2 100644
--- a/backend/internal/services/api_key_service_test.go
+++ b/backend/internal/services/api_key_service_test.go
@@ -4,6 +4,7 @@ import (
"context"
"fmt"
"strings"
+ "sync/atomic"
"testing"
"time"
@@ -15,6 +16,7 @@ import (
"github.com/getarcaneapp/arcane/backend/v2/internal/database"
"github.com/getarcaneapp/arcane/backend/v2/internal/models"
"github.com/getarcaneapp/arcane/backend/v2/pkg/authz"
+ "github.com/getarcaneapp/arcane/backend/v2/pkg/pagination"
"github.com/getarcaneapp/arcane/types/v2/apikey"
)
@@ -125,6 +127,69 @@ func createDefaultAdminUser(t *testing.T, ctx context.Context, userService *User
return created
}
+func TestListApiKeysPermissionQueryCountIsConstant(t *testing.T) {
+ queryCounts := make(map[int]int64, 2)
+ userQueryCounts := make(map[int]int64, 2)
+
+ for _, keyCount := range []int{1, 5} {
+ t.Run(fmt.Sprintf("%d_keys", keyCount), func(t *testing.T) {
+ db := setupAuthServiceTestDB(t)
+ service := NewApiKeyService(db, NewUserService(db)).WithRoleService(NewRoleService(db))
+ userID := "query-count-user"
+
+ apiKeys := make([]models.ApiKey, keyCount)
+ permissions := make([]models.ApiKeyPermission, keyCount)
+ for i := range keyCount {
+ keyID := fmt.Sprintf("key-%d", i)
+ apiKeys[i] = models.ApiKey{
+ BaseModel: models.BaseModel{ID: keyID},
+ Name: keyID,
+ KeyHash: "hash",
+ KeyPrefix: fmt.Sprintf("arc_%04d", i),
+ Kind: models.ApiKeyKindScoped,
+ UserID: &userID,
+ }
+ permissions[i] = models.ApiKeyPermission{
+ BaseModel: models.BaseModel{ID: fmt.Sprintf("permission-%d", i)},
+ ApiKeyID: keyID,
+ Permission: authz.PermContainersList,
+ }
+ }
+ require.NoError(t, db.Create(&apiKeys).Error)
+ require.NoError(t, db.Create(&permissions).Error)
+
+ var queryCount atomic.Int64
+ require.NoError(t, db.Callback().Query().Before("gorm:query").Register("count_api_key_list_queries", func(*gorm.DB) {
+ queryCount.Add(1)
+ }))
+
+ result, _, err := service.ListApiKeys(context.Background(), pagination.QueryParams{
+ Params: pagination.Params{Limit: 100},
+ })
+ require.NoError(t, err)
+ require.Len(t, result, keyCount)
+ for _, apiKey := range result {
+ require.Len(t, apiKey.Permissions, 1)
+ }
+ queryCounts[keyCount] = queryCount.Load()
+
+ queryCount.Store(0)
+ result, err = service.ListApiKeysByUser(context.Background(), userID)
+ require.NoError(t, err)
+ require.Len(t, result, keyCount)
+ for _, apiKey := range result {
+ require.Len(t, apiKey.Permissions, 1)
+ }
+ userQueryCounts[keyCount] = queryCount.Load()
+ })
+ }
+
+ require.Equal(t, int64(3), queryCounts[1])
+ require.Equal(t, int64(3), queryCounts[5])
+ require.Equal(t, int64(2), userQueryCounts[1])
+ require.Equal(t, int64(2), userQueryCounts[5])
+}
+
func TestCreateDefaultAdminAPIKeyUsesProvidedRawKey(t *testing.T) {
ctx := context.Background()
service, db, userService := setupAPIKeyService(t)