feat(api, schema): Add preview field in API Key (#680)

keyshade-xyz · Jan 30, 2025 · 06d8c44 · 06d8c44
1 parent b2be010
commit 06d8c44
Show file tree

Hide file tree

Showing 8 changed files with 33 additions and 12 deletions.
diff --git a/apps/api/src/api-key/api-key.e2e.spec.ts b/apps/api/src/api-key/api-key.e2e.spec.ts
@@ -85,8 +85,13 @@ describe('Api Key Role Controller Tests', () => {
       expect(response.json().name).toBe('Test')
       expect(response.json().slug).toBeDefined()
       expect(response.json().value).toMatch(/^ks_*/)
+      expect(response.json().preview).toMatch(/^ks_*/)
       expect(response.json().authorities).toEqual(['READ_API_KEY'])
 
+      const last4CharsOfValue = response.json().value.slice(-4)
+      const last4CharsOfPreview = response.json().preview.slice(-4)
+      expect(last4CharsOfValue).toBe(last4CharsOfPreview)
+
       const apiKey = await prisma.apiKey.findUnique({
         where: {
           id: response.json().id
@@ -254,6 +259,7 @@ describe('Api Key Role Controller Tests', () => {
         id: apiKey.id,
         name: 'Test Key',
         slug: apiKey.slug,
+        preview: apiKey.preview,
         authorities: ['READ_API_KEY', 'CREATE_ENVIRONMENT'],
         expiresAt: expect.any(String),
         createdAt: expect.any(String),

diff --git a/apps/api/src/api-key/service/api-key.service.ts b/apps/api/src/api-key/service/api-key.service.ts
@@ -22,6 +22,7 @@ export class ApiKeyService {
   private apiKeySelect = {
     id: true,
     expiresAt: true,
+    preview: true,
     name: true,
     slug: true,
     authorities: true,
@@ -41,12 +42,20 @@ export class ApiKeyService {
     await this.isApiKeyUnique(user, dto.name)
 
     const plainTextApiKey = generateApiKey()
+
+    // Generate the preview key in format ks_****<last 4 chars>
+    const previewKey = `ks_****${plainTextApiKey.slice(-4)}`
+    this.logger.log(
+      `User ${user.id} created API key ${previewKey} with name ${dto.name}`
+    )
+
     const hashedApiKey = toSHA256(plainTextApiKey)
     const apiKey = await this.prisma.apiKey.create({
       data: {
         name: dto.name,
         slug: await generateEntitySlug(dto.name, 'API_KEY', this.prisma),
         value: hashedApiKey,
+        preview: previewKey,
         authorities: dto.authorities
           ? {
               set: dto.authorities

diff --git a/apps/api/src/environment/service/environment.service.ts b/apps/api/src/environment/service/environment.service.ts
@@ -325,12 +325,10 @@ export class EnvironmentService {
 
     // Parse the secret and variable counts for each environment
     for (const environment of items) {
-      const [secrets, variables] = await Promise.all([
-        this.getSecretCount(environment.id),
-        this.getVariableCount(environment.id)
-      ])
-      environment['secrets'] = secrets
-      environment['variables'] = variables
+      const secretCount = await this.getSecretCount(environment.id)
+      const variableCount = await this.getVariableCount(environment.id)
+      environment['secrets'] = secretCount
+      environment['variables'] = variableCount
     }
 
     // Calculate metadata for pagination

diff --git a/apps/api/src/prisma/migrations/20250130160517_add_preview_in_api_key/migration.sql b/apps/api/src/prisma/migrations/20250130160517_add_preview_in_api_key/migration.sql
@@ -0,0 +1,2 @@
+-- AlterTable
+ALTER TABLE "ApiKey" ADD COLUMN     "preview" TEXT NOT NULL DEFAULT 'ks_******';
diff --git a/apps/api/src/prisma/schema.prisma b/apps/api/src/prisma/schema.prisma
@@ -429,6 +429,7 @@ model Variable {
 model ApiKey {
   id          String      @id @default(cuid())
   name        String
+  preview     String      @default("ks_******")
   slug        String      @unique
   value       String      @unique
   expiresAt   DateTime?

diff --git a/packages/schema/src/api-key/index.ts b/packages/schema/src/api-key/index.ts
@@ -7,6 +7,7 @@ export const ApiKeySchema = z.object({
   name: z.string(),
   slug: z.string(),
   value: z.string(),
+  preview: z.string(),
   expiresAt: z.string().datetime().nullable(),
   createdAt: z.string().datetime(),
   updatedAt: z.string().datetime(),

diff --git a/packages/schema/tests/api-key.spec.ts b/packages/schema/tests/api-key.spec.ts
@@ -22,6 +22,7 @@ describe('API Key Schemas Tests', () => {
         name: 'API Key Name',
         slug: 'api-key-slug',
         value: 'api-key-value',
+        preview: 'api-key-preview',
         expiresAt: '2024-10-10T10:00:00Z',
         createdAt: '2024-10-09T10:00:00Z',
         updatedAt: '2024-10-09T10:00:00Z',
@@ -44,7 +45,7 @@ describe('API Key Schemas Tests', () => {
         // no userId
       })
       expect(result.success).toBe(false)
-      expect(result.error?.issues).toHaveLength(3)
+      expect(result.error?.issues).toHaveLength(4)
     })
   })
 
@@ -95,6 +96,7 @@ describe('API Key Schemas Tests', () => {
         name: 'API Key Name',
         slug: 'api-key-slug',
         value: 'api-key-value',
+        preview: 'api-key-preview',
         expiresAt: '2024-10-10T10:00:00Z',
         createdAt: '2024-10-09T10:00:00Z',
         updatedAt: '2024-10-09T10:00:00Z',
@@ -118,7 +120,7 @@ describe('API Key Schemas Tests', () => {
         // no userId
       })
       expect(result.success).toBe(false)
-      expect(result.error?.issues).toHaveLength(3)
+      expect(result.error?.issues).toHaveLength(4)
     })
   })
 
@@ -151,6 +153,7 @@ describe('API Key Schemas Tests', () => {
         id: 'apikey123',
         name: 'API Key Name',
         slug: 'api-key-slug',
+        preview: 'api-key-preview',
         expiresAt: '2024-10-10T10:00:00Z',
         createdAt: '2024-10-09T10:00:00Z',
         updatedAt: '2024-10-09T10:00:00Z',
@@ -170,7 +173,7 @@ describe('API Key Schemas Tests', () => {
         authorities: ['INVALID_AUTHORITY'] // Invalid authority
       })
       expect(result.success).toBe(false)
-      expect(result.error?.issues).toHaveLength(2)
+      expect(result.error?.issues).toHaveLength(3)
     })
   })
 
@@ -232,6 +235,7 @@ describe('API Key Schemas Tests', () => {
             id: 'apikey123',
             name: 'API Key Name',
             slug: 'api-key-slug',
+            preview: 'api-key-preview',
             expiresAt: '2024-10-10T10:00:00Z',
             createdAt: '2024-10-09T10:00:00Z',
             updatedAt: '2024-10-09T10:00:00Z',
@@ -283,7 +287,7 @@ describe('API Key Schemas Tests', () => {
         }
       })
       expect(result.success).toBe(false)
-      expect(result.error?.issues).toHaveLength(2)
+      expect(result.error?.issues).toHaveLength(3)
     })
   })
 
@@ -310,6 +314,7 @@ describe('API Key Schemas Tests', () => {
         id: 'apikey123',
         name: 'API Key Name',
         slug: 'api-key-slug',
+        preview: 'api-key-preview',
         expiresAt: '2024-10-10T10:00:00Z',
         createdAt: '2024-10-09T10:00:00Z',
         updatedAt: '2024-10-09T10:00:00Z',
@@ -329,7 +334,7 @@ describe('API Key Schemas Tests', () => {
         authorities: ['INVALID_AUTHORITY'] // Invalid authority
       })
       expect(result.success).toBe(false)
-      expect(result.error?.issues).toHaveLength(2)
+      expect(result.error?.issues).toHaveLength(3)
     })
   })
 

diff --git a/packages/schema/tests/variable.spec.ts b/packages/schema/tests/variable.spec.ts
@@ -42,7 +42,6 @@ describe('Variable Schema Tests', () => {
           }
         ]
       })
-      console.log(result.error)
       expect(result.success).toBe(true)
     })
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		-- AlterTable
		ALTER TABLE "ApiKey" ADD COLUMN "preview" TEXT NOT NULL DEFAULT 'ks_******';
-Original file line number
+Diff line change
@@ Expand Up / @@ -42,7 +42,6 @@ describe('Variable Schema Tests', () => { @@
               }
             ]
           })
-          console.log(result.error)
           expect(result.success).toBe(true)
         })
@@ Expand Down @@