feat: add organization_id condition for list api key

api-description/web-api.swagger.yaml

@@ -934,6 +934,9 @@ paths:
             - NAME
             - CREATED_AT
             - UPDATED_AT
+            - ROLE
+            - ENVIRONMENT
+            - STATE
           default: DEFAULT
         - name: orderDirection
           in: query
@@ -962,6 +965,10 @@ paths:
           items:
             type: string
           collectionFormat: multi
+        - name: organizationId
+          in: query
+          required: true
+          type: string
       tags:
         - API Key
   /v1/account/my_organizations:
@@ -3381,6 +3388,9 @@ definitions:
       - NAME
       - CREATED_AT
       - UPDATED_AT
+      - ROLE
+      - ENVIRONMENT
+      - STATE
     default: DEFAULT
   accountListAPIKeysRequestOrderDirection:
     type: string

manifests/bucketeer/values.dev.yaml

@@ -220,6 +220,21 @@ batch-server:
       - name: mau-partition-creator
         jobId: MauPartitionCreator
         schedule: "0 2 2 * *"
+      - name: feature-flag-cacher
+        jobId: FeatureFlagCacher
+        schedule: "* * * * *"
+      - name: segment-user-cacher
+        jobId: SegmentUserCacher
+        schedule: "* * * * *"
+      - name: api-key-cacher
+        jobId: ApiKeyCacher
+        schedule: "* * * * *"
+      - name: experiment-cacher
+        jobId: ExperimentCacher
+        schedule: "* * * * *"
+      - name: auto-ops-rules-cacher
+        jobId: AutoOpsRulesCacher
+        schedule: "* * * * *"
 
 
 subscriber:

pkg/account/api/api_key.go

@@ -519,13 +519,24 @@ func (s *AccountService) ListAPIKeys(
 	req *proto.ListAPIKeysRequest,
 ) (*proto.ListAPIKeysResponse, error) {
 	localizer := locale.NewLocalizer(ctx)
-	_, err := s.checkEnvironmentRole(
-		ctx, proto.AccountV2_Role_Environment_VIEWER,
-		req.EnvironmentId, localizer)
+	_, err := s.checkOrganizationRole(
+		ctx, proto.AccountV2_Role_Organization_MEMBER,
+		req.OrganizationId, localizer)
 	if err != nil {
 		return nil, err
 	}
+	if req.OrganizationId == "" {
+		dt, err := statusInvalidListAPIKeyRequest.WithDetails(&errdetails.LocalizedMessage{
+			Locale:  localizer.GetLocale(),
+			Message: localizer.MustLocalizeWithTemplate(locale.RequiredFieldTemplate, "organization_id"),
+		})
+		if err != nil {
+			return nil, statusInternal.Err()
+		}
+		return nil, dt.Err()
+	}
 	whereParts := []mysql.WherePart{}
+	whereParts = append(whereParts, mysql.NewFilter("environment_v2.organization_id", "=", req.OrganizationId))
 	if len(req.EnvironmentIds) > 0 {
 		environmentIds := make([]interface{}, 0, len(req.EnvironmentIds))
 		for _, id := range req.EnvironmentIds {
@@ -615,6 +626,12 @@ func (s *AccountService) newAPIKeyListOrders(
 		column = "api_key.created_at"
 	case proto.ListAPIKeysRequest_UPDATED_AT:
 		column = "api_key.updated_at"
+	case proto.ListAPIKeysRequest_ROLE:
+		column = "api_key.role"
+	case proto.ListAPIKeysRequest_ENVIRONMENT:
+		column = "environment_v2.name"
+	case proto.ListAPIKeysRequest_STATE:
+		column = "api_key.disabled"
 	default:
 		dt, err := statusInvalidOrderBy.WithDetails(&errdetails.LocalizedMessage{
 			Locale:  localizer.GetLocale(),

pkg/account/api/api_key_test.go

@@ -670,9 +670,13 @@ func TestListAPIKeysMySQL(t *testing.T) {
 		getExpectedErr func(localizer locale.Localizer) error
 	}{
 		{
-			desc:     "errInvalidCursor",
-			context:  createContextWithDefaultToken(t, true),
-			input:    &accountproto.ListAPIKeysRequest{Cursor: "XXX"},
+			desc:    "errInvalidCursor",
+			context: createContextWithDefaultToken(t, true),
+			input: &accountproto.ListAPIKeysRequest{
+				EnvironmentIds: []string{"ns0"},
+				OrganizationId: "org0",
+				Cursor:         "XXX",
+			},
 			expected: nil,
 			getExpectedErr: func(localizer locale.Localizer) error {
 				return createError(localizer, statusInvalidCursor, localizer.MustLocalizeWithTemplate(locale.InvalidArgumentError, "cursor"))
@@ -686,7 +690,10 @@ func TestListAPIKeysMySQL(t *testing.T) {
 					gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any(),
 				).Return(nil, 0, int64(0), errors.New("error"))
 			},
-			input:    &accountproto.ListAPIKeysRequest{},
+			input: &accountproto.ListAPIKeysRequest{
+				EnvironmentIds: []string{"ns0"},
+				OrganizationId: "org0",
+			},
 			expected: nil,
 			getExpectedErr: func(localizer locale.Localizer) error {
 				return createError(localizer, statusInternal, localizer.MustLocalize(locale.InternalServerError))
@@ -696,7 +703,7 @@ func TestListAPIKeysMySQL(t *testing.T) {
 			desc:    "errPermissionDenied",
 			context: createContextWithDefaultToken(t, false),
 			setup: func(s *AccountService) {
-				s.accountStorage.(*accstoragemock.MockAccountStorage).EXPECT().GetAccountV2ByEnvironmentID(
+				s.accountStorage.(*accstoragemock.MockAccountStorage).EXPECT().GetAccountV2(
 					gomock.Any(), gomock.Any(), gomock.Any(),
 				).Return(&domain.AccountV2{
 					AccountV2: &accountproto.AccountV2{
@@ -711,7 +718,10 @@ func TestListAPIKeysMySQL(t *testing.T) {
 					},
 				}, nil).AnyTimes()
 			},
-			input:    &accountproto.ListAPIKeysRequest{EnvironmentId: "ns0"},
+			input: &accountproto.ListAPIKeysRequest{
+				EnvironmentIds: []string{"ns0"},
+				OrganizationId: "org0",
+			},
 			expected: nil,
 			getExpectedErr: func(localizer locale.Localizer) error {
 				return createError(localizer, statusPermissionDenied, localizer.MustLocalize(locale.PermissionDenied))
@@ -725,22 +735,26 @@ func TestListAPIKeysMySQL(t *testing.T) {
 					gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any(),
 				).Return([]*accountproto.APIKey{}, 0, int64(0), nil)
 			},
-			input:    &accountproto.ListAPIKeysRequest{PageSize: 2, Cursor: ""},
+			input: &accountproto.ListAPIKeysRequest{
+				OrganizationId: "org0",
+				PageSize:       2,
+				Cursor:         "",
+			},
 			expected: &accountproto.ListAPIKeysResponse{ApiKeys: []*accountproto.APIKey{}, Cursor: "0"},
 			getExpectedErr: func(localizer locale.Localizer) error {
 				return nil
 			},
 		},
 		{
-			desc:    "success with viewer account",
+			desc:    "success with admin account",
 			context: createContextWithDefaultToken(t, false),
 			setup: func(s *AccountService) {
-				s.accountStorage.(*accstoragemock.MockAccountStorage).EXPECT().GetAccountV2ByEnvironmentID(
+				s.accountStorage.(*accstoragemock.MockAccountStorage).EXPECT().GetAccountV2(
 					gomock.Any(), gomock.Any(), gomock.Any(),
 				).Return(&domain.AccountV2{
 					AccountV2: &accountproto.AccountV2{
 						Email:            "email",
-						OrganizationRole: accountproto.AccountV2_Role_Organization_MEMBER,
+						OrganizationRole: accountproto.AccountV2_Role_Organization_ADMIN,
 						EnvironmentRoles: []*accountproto.AccountV2_EnvironmentRole{
 							{
 								EnvironmentId: "ns0",
@@ -753,7 +767,10 @@ func TestListAPIKeysMySQL(t *testing.T) {
 					gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any(),
 				).Return([]*accountproto.APIKey{}, 0, int64(0), nil)
 			},
-			input:    &accountproto.ListAPIKeysRequest{EnvironmentId: "ns0"},
+			input: &accountproto.ListAPIKeysRequest{
+				EnvironmentIds: []string{"ns0"},
+				OrganizationId: "org0",
+			},
 			expected: &accountproto.ListAPIKeysResponse{ApiKeys: []*accountproto.APIKey{}, Cursor: "0"},
 			getExpectedErr: func(localizer locale.Localizer) error {
 				return nil

pkg/account/api/error.go

@@ -56,6 +56,7 @@ var (
 		codes.InvalidArgument,
 		"account: search filter target type is required",
 	)
-	statusSearchFilterIDIsEmpty  = gstatus.New(codes.InvalidArgument, "account: search filter ID is empty")
-	statusSearchFilterIDNotFound = gstatus.New(codes.InvalidArgument, "account: search filter ID not found")
+	statusSearchFilterIDIsEmpty    = gstatus.New(codes.InvalidArgument, "account: search filter ID is empty")
+	statusSearchFilterIDNotFound   = gstatus.New(codes.InvalidArgument, "account: search filter ID not found")
+	statusInvalidListAPIKeyRequest = gstatus.New(codes.InvalidArgument, "account: invalid list api key request")
 )

pkg/account/storage/v2/sql/api_key_v2/select_api_key_v2_count.sql

@@ -2,4 +2,5 @@ SELECT
     COUNT(1)
 FROM
     api_key
+LEFT JOIN environment_v2 ON api_key.environment_id = environment_v2.id
 %s