perf: improve get environment api key latency (#1380)

Signed-off-by: Alessandro Yuichi Okimoto <[email protected]>
bucketeer-io · Dec 13, 2024 · d9d5895 · d9d5895
1 parent 9788305
commit d9d5895
Show file tree

Hide file tree

Showing 28 changed files with 1,388 additions and 1,482 deletions.
diff --git a/api-description/web-api.swagger.yaml b/api-description/web-api.swagger.yaml
@@ -725,15 +725,15 @@ paths:
       tags:
         - API Key
   /v1/account/get_environment_api_key:
-    post:
+    get:
       summary: Get Environment API Key
       description: Get an environment API Key.
       operationId: web.v1.account.get_environment_api_key
       responses:
         "200":
           description: A successful response.
           schema:
-            $ref: '#/definitions/accountGetAPIKeyBySearchingAllEnvironmentsResponse'
+            $ref: '#/definitions/accountGetEnvironmentAPIKeyResponse'
         "400":
           description: Returned for bad requests that may have failed validation.
           schema:
@@ -766,11 +766,10 @@ paths:
           schema:
             $ref: '#/definitions/rpcStatus'
       parameters:
-        - name: body
-          in: body
-          required: true
-          schema:
-            $ref: '#/definitions/accountGetAPIKeyBySearchingAllEnvironmentsRequest'
+        - name: apiKey
+          in: query
+          required: false
+          type: string
       tags:
         - API Key
   /v1/account/get_me:
@@ -3309,18 +3308,6 @@ definitions:
       - UNKNOWN
       - FEATURE_FLAG
     default: UNKNOWN
-  accountGetAPIKeyBySearchingAllEnvironmentsRequest:
-    type: object
-    properties:
-      id:
-        type: string
-      apiKey:
-        type: string
-  accountGetAPIKeyBySearchingAllEnvironmentsResponse:
-    type: object
-    properties:
-      environmentApiKey:
-        $ref: '#/definitions/accountEnvironmentAPIKey'
   accountGetAPIKeyResponse:
     type: object
     properties:
@@ -3350,6 +3337,11 @@ definitions:
     properties:
       account:
         $ref: '#/definitions/accountAccountV2'
+  accountGetEnvironmentAPIKeyResponse:
+    type: object
+    properties:
+      environmentApiKey:
+        $ref: '#/definitions/accountEnvironmentAPIKey'
   accountGetMeRequest:
     type: object
     properties:

diff --git a/manifests/bucketeer/charts/api/values.yaml b/manifests/bucketeer/charts/api/values.yaml
diff --git a/manifests/bucketeer/charts/web/values.yaml b/manifests/bucketeer/charts/web/values.yaml
diff --git a/pkg/account/api/api.go b/pkg/account/api/api.go
@@ -106,47 +106,6 @@ func (s *AccountService) makeProjectSet(projects []*environmentproto.Project) ma
 	return projectSet
 }
 
-func (s *AccountService) listProjects(ctx context.Context) ([]*environmentproto.Project, error) {
-	projects := []*environmentproto.Project{}
-	cursor := ""
-	for {
-		resp, err := s.environmentClient.ListProjects(ctx, &environmentproto.ListProjectsRequest{
-			PageSize: listRequestPageSize,
-			Cursor:   cursor,
-		})
-		if err != nil {
-			return nil, err
-		}
-		projects = append(projects, resp.Projects...)
-		projectSize := len(resp.Projects)
-		if projectSize == 0 || projectSize < listRequestPageSize {
-			return projects, nil
-		}
-		cursor = resp.Cursor
-	}
-}
-
-func (s *AccountService) listEnvironments(ctx context.Context) ([]*environmentproto.EnvironmentV2, error) {
-	var environments []*environmentproto.EnvironmentV2
-	cursor := ""
-	for {
-		resp, err := s.environmentClient.ListEnvironmentsV2(ctx, &environmentproto.ListEnvironmentsV2Request{
-			PageSize: listRequestPageSize,
-			Cursor:   cursor,
-			Archived: wrapperspb.Bool(false),
-		})
-		if err != nil {
-			return nil, err
-		}
-		environments = append(environments, resp.Environments...)
-		environmentSize := len(resp.Environments)
-		if environmentSize == 0 || environmentSize < listRequestPageSize {
-			return environments, nil
-		}
-		cursor = resp.Cursor
-	}
-}
-
 func (s *AccountService) listProjectsByOrganizationID(
 	ctx context.Context,
 	organizationID string,

diff --git a/pkg/account/api/api_key.go b/pkg/account/api/api_key.go
@@ -649,21 +649,15 @@ func (s *AccountService) newAPIKeyListOrders(
 	return []*mysql.Order{mysql.NewOrder(column, direction)}, nil
 }
 
-func (s *AccountService) GetAPIKeyBySearchingAllEnvironments(
+func (s *AccountService) GetEnvironmentAPIKey(
 	ctx context.Context,
-	req *proto.GetAPIKeyBySearchingAllEnvironmentsRequest,
-) (*proto.GetAPIKeyBySearchingAllEnvironmentsResponse, error) {
+	req *proto.GetEnvironmentAPIKeyRequest,
+) (*proto.GetEnvironmentAPIKeyResponse, error) {
 	localizer := locale.NewLocalizer(ctx)
 	_, err := s.checkSystemAdminRole(ctx, localizer)
 	if err != nil {
 		return nil, err
 	}
-
-	// TODO: support both fields, when migration finished, remove this block
-	if req.ApiKey == "" {
-		req.ApiKey = req.Id
-	}
-
 	if req.ApiKey == "" {
 		dt, err := statusMissingAPIKeyID.WithDetails(&errdetails.LocalizedMessage{
 			Locale:  localizer.GetLocale(),
@@ -674,54 +668,24 @@ func (s *AccountService) GetAPIKeyBySearchingAllEnvironments(
 		}
 		return nil, dt.Err()
 	}
-	projects, err := s.listProjects(ctx)
+	envAPIKey, err := s.accountStorage.GetEnvironmentAPIKey(ctx, req.ApiKey)
 	if err != nil {
-		s.logger.Error(
-			"Failed to get project list",
-			log.FieldsFromImcomingContext(ctx).AddFields(zap.Error(err))...,
-		)
-		dt, err := statusInternal.WithDetails(&errdetails.LocalizedMessage{
-			Locale:  localizer.GetLocale(),
-			Message: localizer.MustLocalize(locale.InternalServerError),
-		})
-		if err != nil {
-			return nil, statusInternal.Err()
-		}
-		return nil, dt.Err()
-	}
-	if len(projects) == 0 {
-		s.logger.Error(
-			"Could not find any projects",
-			log.FieldsFromImcomingContext(ctx).AddFields(zap.Error(err))...,
-		)
-		dt, err := statusInternal.WithDetails(&errdetails.LocalizedMessage{
-			Locale:  localizer.GetLocale(),
-			Message: localizer.MustLocalize(locale.InternalServerError),
-		})
-		if err != nil {
-			return nil, statusInternal.Err()
-		}
-		return nil, dt.Err()
-	}
-	environments, err := s.listEnvironments(ctx)
-	if err != nil {
-		s.logger.Error(
-			"Failed to get environment list",
-			log.FieldsFromImcomingContext(ctx).AddFields(zap.Error(err))...,
-		)
-		dt, err := statusInternal.WithDetails(&errdetails.LocalizedMessage{
-			Locale:  localizer.GetLocale(),
-			Message: localizer.MustLocalize(locale.InternalServerError),
-		})
-		if err != nil {
-			return nil, statusInternal.Err()
+		if errors.Is(err, v2as.ErrAPIKeyNotFound) {
+			dt, err := statusNotFound.WithDetails(&errdetails.LocalizedMessage{
+				Locale:  localizer.GetLocale(),
+				Message: localizer.MustLocalize(locale.NotFoundError),
+			})
+			if err != nil {
+				return nil, statusInternal.Err()
+			}
+			return nil, dt.Err()
 		}
-		return nil, dt.Err()
-	}
-	if len(environments) == 0 {
 		s.logger.Error(
-			"Could not find any environments",
-			log.FieldsFromImcomingContext(ctx).AddFields(zap.Error(err))...,
+			"Failed to get environment api key",
+			log.FieldsFromImcomingContext(ctx).AddFields(
+				zap.Error(err),
+				zap.String("apiKey", req.ApiKey),
+			)...,
 		)
 		dt, err := statusInternal.WithDetails(&errdetails.LocalizedMessage{
 			Locale:  localizer.GetLocale(),
@@ -732,55 +696,13 @@ func (s *AccountService) GetAPIKeyBySearchingAllEnvironments(
 		}
 		return nil, dt.Err()
 	}
-	projectSet := s.makeProjectSet(projects)
-	for _, e := range environments {
-		p, ok := projectSet[e.ProjectId]
-		if !ok || p.Disabled {
-			continue
-		}
-		apiKey, err := s.accountStorage.GetAPIKeyByAPIKey(ctx, req.ApiKey, e.Id)
-		if err != nil {
-			if errors.Is(err, v2as.ErrAPIKeyNotFound) {
-				continue
-			}
-			s.logger.Error(
-				"Failed to get api key",
-				log.FieldsFromImcomingContext(ctx).AddFields(
-					zap.Error(err),
-					zap.String("environmentId", e.Id),
-				)...,
-			)
-			dt, err := statusInternal.WithDetails(&errdetails.LocalizedMessage{
-				Locale:  localizer.GetLocale(),
-				Message: localizer.MustLocalize(locale.InternalServerError),
-			})
-			if err != nil {
-				return nil, statusInternal.Err()
-			}
-			return nil, dt.Err()
-		}
-
-		// for security, obfuscate the returned key
-		shadowLen := int(float64(len(apiKey.ApiKey)) * apiKeyShadowPercentage)
-		apiKey.ApiKey = apiKey.ApiKey[shadowLen:]
+	// for security, obfuscate the returned key
+	shadowLen := int(float64(len(envAPIKey.ApiKey.ApiKey)) * apiKeyShadowPercentage)
+	envAPIKey.ApiKey.ApiKey = envAPIKey.ApiKey.ApiKey[shadowLen:]
 
-		return &proto.GetAPIKeyBySearchingAllEnvironmentsResponse{
-			EnvironmentApiKey: &proto.EnvironmentAPIKey{
-				ApiKey:         apiKey.APIKey,
-				ProjectId:      p.Id,
-				ProjectUrlCode: p.UrlCode,
-				Environment:    e,
-			},
-		}, nil
-	}
-	dt, err := statusNotFound.WithDetails(&errdetails.LocalizedMessage{
-		Locale:  localizer.GetLocale(),
-		Message: localizer.MustLocalize(locale.NotFoundError),
-	})
-	if err != nil {
-		return nil, statusInternal.Err()
-	}
-	return nil, dt.Err()
+	return &proto.GetEnvironmentAPIKeyResponse{
+		EnvironmentApiKey: envAPIKey.EnvironmentAPIKey,
+	}, nil
 }
 
 func (s *AccountService) UpdateAPIKey(

diff --git a/pkg/account/client/mock/client.go b/pkg/account/client/mock/client.go
diff --git a/pkg/account/domain/api_key.go b/pkg/account/domain/api_key.go
@@ -31,6 +31,10 @@ type APIKey struct {
 	*proto.APIKey
 }
 
+type EnvironmentAPIKey struct {
+	*proto.EnvironmentAPIKey
+}
+
 func NewAPIKey(
 	name string,
 	role proto.APIKey_Role,