feat: add pagination and limit handling for API keys

connect/src/wg/cosmo/platform/v1/platform_pb.ts

@@ -8275,6 +8275,16 @@ export class APIKey_Group extends Message<APIKey_Group> {
  * @generated from message wg.cosmo.platform.v1.GetAPIKeysRequest
  */
 export class GetAPIKeysRequest extends Message<GetAPIKeysRequest> {
+  /**
+   * @generated from field: int32 limit = 1;
+   */
+  limit = 0;
+
+  /**
+   * @generated from field: int32 offset = 2;
+   */
+  offset = 0;
+
   constructor(data?: PartialMessage<GetAPIKeysRequest>) {
     super();
     proto3.util.initPartial(data, this);
@@ -8283,6 +8293,8 @@ export class GetAPIKeysRequest extends Message<GetAPIKeysRequest> {
   static readonly runtime: typeof proto3 = proto3;
   static readonly typeName = "wg.cosmo.platform.v1.GetAPIKeysRequest";
   static readonly fields: FieldList = proto3.util.newFieldList(() => [
+    { no: 1, name: "limit", kind: "scalar", T: 5 /* ScalarType.INT32 */ },
+    { no: 2, name: "offset", kind: "scalar", T: 5 /* ScalarType.INT32 */ },
   ]);
 
   static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): GetAPIKeysRequest {
@@ -8316,6 +8328,11 @@ export class GetAPIKeysResponse extends Message<GetAPIKeysResponse> {
    */
   apiKeys: APIKey[] = [];
 
+  /**
+   * @generated from field: int32 count = 3;
+   */
+  count = 0;
+
   constructor(data?: PartialMessage<GetAPIKeysResponse>) {
     super();
     proto3.util.initPartial(data, this);
@@ -8326,6 +8343,7 @@ export class GetAPIKeysResponse extends Message<GetAPIKeysResponse> {
   static readonly fields: FieldList = proto3.util.newFieldList(() => [
     { no: 1, name: "response", kind: "message", T: Response },
     { no: 2, name: "apiKeys", kind: "message", T: APIKey, repeated: true },
+    { no: 3, name: "count", kind: "scalar", T: 5 /* ScalarType.INT32 */ },
   ]);
 
   static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): GetAPIKeysResponse {

controlplane/src/core/bufservices/api-key/createAPIKey.ts

@@ -32,6 +32,21 @@ export function createAPIKey(
 
     const keyName = req.name.trim();
 
+    // Check if the organization has reached the limit of 200 API keys
+    const apiKeysCount = await apiKeyRepo.getAPIKeysCount({
+      organizationID: authContext.organizationId,
+    });
+
+    if (apiKeysCount >= 200) {
+      return {
+        response: {
+          code: EnumStatusCode.ERR,
+          details: 'Cannot create API key. Organization has reached the maximum limit of 200 API keys',
+        },
+        apiKey: '',
+      };
+    }
+
     const apiKeyModel = await apiKeyRepo.getAPIKeyByName({
       organizationID: authContext.organizationId,
       name: keyName,

controlplane/src/core/bufservices/api-key/getAPIKeys.ts

@@ -4,7 +4,7 @@ import { EnumStatusCode } from '@wundergraph/cosmo-connect/dist/common/common_pb
 import { GetAPIKeysRequest, GetAPIKeysResponse } from '@wundergraph/cosmo-connect/dist/platform/v1/platform_pb';
 import { ApiKeyRepository } from '../../repositories/ApiKeyRepository.js';
 import type { RouterOptions } from '../../routes.js';
-import { enrichLogger, getLogger, handleError } from '../../util.js';
+import { clamp, enrichLogger, getLogger, handleError } from '../../util.js';
 
 export function getAPIKeys(
   opts: RouterOptions,
@@ -19,13 +19,27 @@ export function getAPIKeys(
 
     const apiKeyRepo = new ApiKeyRepository(opts.db);
 
-    const apiKeys = await apiKeyRepo.getAPIKeys({ organizationID: authContext.organizationId });
+    // default to 10 if no limit is provided
+    req.limit = clamp(req.limit || 10, 1, 50);
+    // the max no of api keys is 200, but set the max to 1000 to be safe
+    req.offset = clamp(req.offset || 0, 0, 1000);
+
+    const apiKeys = await apiKeyRepo.getAPIKeys({
+      organizationID: authContext.organizationId,
+      limit: req.limit,
+      offset: req.offset,
+    });
+
+    const count = await apiKeyRepo.getAPIKeysCount({
+      organizationID: authContext.organizationId,
+    });
 
     return {
       response: {
         code: EnumStatusCode.OK,
       },
       apiKeys,
+      count,
     };
   });
 }

controlplane/src/core/bufservices/check/getCheckOperations.ts

@@ -10,7 +10,7 @@ import { OperationsRepository } from '../../repositories/OperationsRepository.js
 import { SchemaCheckRepository } from '../../repositories/SchemaCheckRepository.js';
 import { SubgraphRepository } from '../../repositories/SubgraphRepository.js';
 import type { RouterOptions } from '../../routes.js';
-import { enrichLogger, getLogger, handleError } from '../../util.js';
+import { clamp, enrichLogger, getLogger, handleError } from '../../util.js';
 import { UnauthorizedError } from '../../errors/errors.js';
 
 export function getCheckOperations(
@@ -73,22 +73,9 @@ export function getCheckOperations(
       };
     }
 
-    // check that the limit is less than the max option provided in the ui
-    if (req.limit > 200) {
-      return {
-        response: {
-          code: EnumStatusCode.ERR,
-          details: 'Invalid limit',
-        },
-        operations: [],
-        trafficCheckDays: 0,
-        createdAt: '',
-        clientTrafficCheckSkipped: false,
-        totalOperationsCount: 0,
-        doAllOperationsHaveIgnoreAllOverride: false,
-        doAllOperationsHaveAllTheirChangesMarkedSafe: false,
-      };
-    }
+    // default to 10 if no limit is provided
+    req.limit = clamp(req.limit || 10, 1, 200);
+    req.offset = clamp(req.offset || 0, 0, 500_000);
 
     const affectedOperations = await schemaCheckRepo.getAffectedOperationsByCheckId({
       checkId: req.checkId,

controlplane/src/core/bufservices/check/getChecksByFederatedGraphName.ts

@@ -11,7 +11,7 @@ import { DefaultNamespace } from '../../repositories/NamespaceRepository.js';
 import { OrganizationRepository } from '../../repositories/OrganizationRepository.js';
 import { SubgraphRepository } from '../../repositories/SubgraphRepository.js';
 import type { RouterOptions } from '../../routes.js';
-import { enrichLogger, getLogger, handleError, validateDateRanges } from '../../util.js';
+import { clamp, enrichLogger, getLogger, handleError, validateDateRanges } from '../../util.js';
 import { UnauthorizedError } from '../../errors/errors.js';
 
 export function getChecksByFederatedGraphName(
@@ -70,17 +70,9 @@ export function getChecksByFederatedGraphName(
       };
     }
 
-    // check that the limit is less than the max option provided in the ui
-    if (req.limit > 50) {
-      return {
-        response: {
-          code: EnumStatusCode.ERR,
-          details: 'Invalid limit',
-        },
-        checks: [],
-        checksCountBasedOnDateRange: 0,
-      };
-    }
+    // default to 10 if no limit is provided
+    req.limit = clamp(req.limit || 10, 1, 50);
+    req.offset = clamp(req.offset || 0, 0, 500_000);
 
     const includeSubgraphs = req.filters?.subgraphs?.filter((id) => isValidUuid(id)) ?? [];
     const checksData = await subgraphRepo.checks({

controlplane/src/core/bufservices/federated-graph/getCompositions.ts

@@ -10,7 +10,7 @@ import { GraphCompositionRepository } from '../../repositories/GraphCompositionR
 import { DefaultNamespace } from '../../repositories/NamespaceRepository.js';
 import { OrganizationRepository } from '../../repositories/OrganizationRepository.js';
 import type { RouterOptions } from '../../routes.js';
-import { enrichLogger, getLogger, handleError, validateDateRanges } from '../../util.js';
+import { clamp, enrichLogger, getLogger, handleError, validateDateRanges } from '../../util.js';
 import { UnauthorizedError } from '../../errors/errors.js';
 
 export function getCompositions(
@@ -71,17 +71,9 @@ export function getCompositions(
       };
     }
 
-    // check that the limit is less than the max option provided in the ui
-    if (req.limit > 50) {
-      return {
-        response: {
-          code: EnumStatusCode.ERR,
-          details: 'Invalid limit',
-        },
-        compositions: [],
-        count: 0,
-      };
-    }
+    // default to 10 if no limit is provided
+    req.limit = clamp(req.limit || 10, 1, 50);
+    req.offset = clamp(req.offset || 0, 0, 500_000);
 
     const compositions = await graphCompositionRepository.getGraphCompositions({
       fedGraphTargetId: federatedGraph.targetId,

controlplane/src/core/bufservices/organization/getAuditLogs.ts

@@ -9,7 +9,7 @@ import {
 import { AuditLogRepository } from '../../repositories/AuditLogRepository.js';
 import { OrganizationRepository } from '../../repositories/OrganizationRepository.js';
 import type { RouterOptions } from '../../routes.js';
-import { enrichLogger, getLogger, handleError, validateDateRanges } from '../../util.js';
+import { clamp, enrichLogger, getLogger, handleError, validateDateRanges } from '../../util.js';
 import { UnauthorizedError } from '../../errors/errors.js';
 
 export function getAuditLogs(
@@ -54,17 +54,9 @@ export function getAuditLogs(
       };
     }
 
-    // check that the limit is less than the max option provided in the ui
-    if (req.limit > 50) {
-      return {
-        response: {
-          code: EnumStatusCode.ERR,
-          details: 'Invalid limit',
-        },
-        logs: [],
-        count: 0,
-      };
-    }
+    // default to 10 if no limit is provided
+    req.limit = clamp(req.limit || 10, 1, 50);
+    req.offset = clamp(req.offset || 0, 0, 500_000);
 
     const auditLogs = await auditLogRepo.getAuditLogs({
       organizationId: authContext.organizationId,

controlplane/src/core/bufservices/proposal/getProposalChecks.ts

@@ -8,7 +8,7 @@ import {
 import { OrganizationRepository } from '../../repositories/OrganizationRepository.js';
 import { ProposalRepository } from '../../repositories/ProposalRepository.js';
 import type { RouterOptions } from '../../routes.js';
-import { enrichLogger, getLogger, handleError, validateDateRanges } from '../../util.js';
+import { clamp, enrichLogger, getLogger, handleError, validateDateRanges } from '../../util.js';
 import { FederatedGraphRepository } from '../../repositories/FederatedGraphRepository.js';
 
 export function getProposalChecks(
@@ -75,17 +75,9 @@ export function getProposalChecks(
       };
     }
 
-    // check that the limit is less than the max option provided in the ui
-    if (req.limit > 50) {
-      return {
-        response: {
-          code: EnumStatusCode.ERR,
-          details: 'Invalid limit',
-        },
-        checks: [],
-        totalChecksCount: 0,
-      };
-    }
+    // default to 10 if no limit is provided
+    req.limit = clamp(req.limit || 10, 1, 50);
+    req.offset = clamp(req.offset || 0, 0, 500_000);
 
     // Get checks for the proposal
     const { checks, checksCount } = await proposalRepo.getChecksByProposalId({

controlplane/src/core/bufservices/proposal/getProposalsByFederatedGraph.ts

@@ -9,7 +9,7 @@ import {
 import { FederatedGraphRepository } from '../../repositories/FederatedGraphRepository.js';
 import { ProposalRepository } from '../../repositories/ProposalRepository.js';
 import type { RouterOptions } from '../../routes.js';
-import { enrichLogger, fromProposalOriginEnum, getLogger, handleError, validateDateRanges } from '../../util.js';
+import { clamp, enrichLogger, fromProposalOriginEnum, getLogger, handleError, validateDateRanges } from '../../util.js';
 import { OrganizationRepository } from '../../repositories/OrganizationRepository.js';
 import { DefaultNamespace, NamespaceRepository } from '../../repositories/NamespaceRepository.js';
 import { UnauthorizedError } from '../../errors/errors.js';
@@ -95,17 +95,9 @@ export function getProposalsByFederatedGraph(
       };
     }
 
-    // check that the limit is less than the max option provided in the ui
-    if (req.limit > 50) {
-      return {
-        response: {
-          code: EnumStatusCode.ERR,
-          details: 'Invalid limit',
-        },
-        proposals: [],
-        isProposalsEnabled: namespace.enableProposals,
-      };
-    }
+    // default to 10 if no limit is provided
+    req.limit = clamp(req.limit || 10, 1, 50);
+    req.offset = clamp(req.offset || 0, 0, 500_000);
 
     const { proposals } = await proposalRepo.ByFederatedGraphId({
       federatedGraphId: federatedGraph.id,

controlplane/src/core/repositories/ApiKeyRepository.ts

@@ -1,5 +1,5 @@
 import { ExpiresAt } from '@wundergraph/cosmo-connect/dist/platform/v1/platform_pb';
-import { and, asc, eq } from 'drizzle-orm';
+import { and, asc, count, eq } from 'drizzle-orm';
 import { PostgresJsDatabase } from 'drizzle-orm/postgres-js';
 import * as schema from '../../db/schema.js';
 import { apiKeyPermissions, apiKeyResources, apiKeys, users } from '../../db/schema.js';
@@ -110,8 +110,8 @@ export class ApiKeyRepository {
     } as APIKeyDTO;
   }
 
-  public async getAPIKeys(input: { organizationID: string }): Promise<APIKeyDTO[]> {
-    const keys = await this.db
+  public async getAPIKeys(input: { organizationID: string; limit: number; offset: number }): Promise<APIKeyDTO[]> {
+    const query = this.db
       .select({
         id: apiKeys.id,
         name: apiKeys.name,
@@ -127,8 +127,17 @@ export class ApiKeyRepository {
       .innerJoin(users, eq(users.id, apiKeys.userId))
       .leftJoin(schema.organizationGroups, eq(schema.organizationGroups.id, apiKeys.groupId))
       .where(eq(apiKeys.organizationId, input.organizationID))
-      .orderBy(asc(apiKeys.createdAt))
-      .execute();
+      .orderBy(asc(apiKeys.createdAt));
+
+    if (input.limit) {
+      query.limit(input.limit);
+    }
+
+    if (input.offset) {
+      query.offset(input.offset);
+    }
+
+    const keys = await query.execute();
 
     return keys.map(
       ({ groupId, groupName, ...key }) =>
@@ -145,6 +154,18 @@ export class ApiKeyRepository {
     );
   }
 
+  public async getAPIKeysCount(input: { organizationID: string }): Promise<number> {
+    const result = await this.db
+      .select({
+        count: count(),
+      })
+      .from(apiKeys)
+      .where(eq(apiKeys.organizationId, input.organizationID))
+      .execute();
+
+    return result[0]?.count ?? 0;
+  }
+
   public updateAPIKeyGroup(input: { apiKeyId: string; groupId: string }) {
     return this.db
       .update(schema.apiKeys)