add name to apiKey

Author: jjnp

package.json

@@ -17,7 +17,7 @@
 		"test:integration": "cross-env DATABASE_LOCATION=:memory: vitest run --project integration",
 		"test:e2e": "playwright test",
 		"---- DB ------------------------------------------------------------": "",
-		"setupdb": "pnpm migrate && pnpm db-types",
+		"setupdb": "pnpm migrate:latest && pnpm db-types",
 		"migrate": "tsx ./services/src/kysely/migrator.ts",
 		"migrate:latest": "pnpm run migrate -- latest",
 		"migrate:up": "pnpm run migrate -- up",

services/src/auth/api-key-repository.integration.test.ts

@@ -7,7 +7,8 @@ import {
   createApiKey,
   deleteApiKey,
   getApiKeysForProject,
-  projectHasKey
+  projectHasKey,
+  setApiKeyName
 } from './api-key.repository'
 
 beforeEach(async () => {
@@ -40,6 +41,14 @@ describe('ApiKey Repository', () => {
       expect(result).includes(key2.key)
     })
 
+    it('should retrieve the name of the apiKey when it is created with one', async () => {
+      const name = 'some key name'
+      const key = await createApiKey(projectId, name)
+      const result = await getApiKeysForProject(projectId)
+
+      expect(result.find((it) => it.key === key.key)?.name).toBe(name)
+    })
+
     it('should no longer find deleted keys', async () => {
       const key = await createApiKey(projectId)
 
@@ -62,6 +71,41 @@ describe('ApiKey Repository', () => {
     })
   })
 
+  describe('setApiKeyName', () => {
+    it('should be able to set a name when previously there was none', async () => {
+      const key = await createApiKey(projectId)
+      const initialRetrieval = await getApiKeysForProject(projectId).then((it) =>
+        it.find((apiKey) => apiKey.key === key.key)
+      )
+
+      expect(initialRetrieval?.name).toBeFalsy()
+      const updatedName = 'some new apiKeyName'
+      await setApiKeyName(key.id, updatedName)
+
+      const secondRetrieval = await getApiKeysForProject(projectId).then((it) =>
+        it.find((apiKey) => apiKey.key === key.key)
+      )
+      expect(secondRetrieval?.name).toBe(updatedName)
+    })
+
+    it('should be able to set the name', async () => {
+      const initialName = 'my personal api key'
+      const key = await createApiKey(projectId, initialName)
+      const initialRetrieval = await getApiKeysForProject(projectId).then((it) =>
+        it.find((apiKey) => apiKey.key === key.key)
+      )
+
+      expect(initialRetrieval?.name).toBe(initialName)
+      const updatedName = 'some new apiKeyName'
+      await setApiKeyName(key.id, updatedName)
+
+      const secondRetrieval = await getApiKeysForProject(projectId).then((it) =>
+        it.find((apiKey) => apiKey.key === key.key)
+      )
+      expect(secondRetrieval?.name).toBe(updatedName)
+    })
+  })
+
   describe('projectHasKey', () => {
     it('should return true if there is a key for the project', async () => {
       const key = await createApiKey(projectId)

services/src/auth/api-key.repository.ts

@@ -2,9 +2,13 @@ import { db } from '../db/database'
 import type { ApiKeyCreationParams, SelectableApiKey } from './api-key'
 import { v4 as uuid } from 'uuid'
 
-export function createApiKey(projectId: number): Promise<SelectableApiKey> {
+export function createApiKey(
+	projectId: number,
+	name: string | null = null
+): Promise<SelectableApiKey> {
 	const insertKey: ApiKeyCreationParams = {
 		key: uuid(),
+		name,
 		project_id: projectId
 	}
 	return db
@@ -18,6 +22,16 @@ export function getApiKeysForProject(projectId: number): Promise<SelectableApiKe
 	return db.selectFrom('apikeys').selectAll().where('project_id', '==', projectId).execute()
 }
 
+export async function setApiKeyName(keyId: number, name: string): Promise<void> {
+	await db
+		.updateTable('apikeys')
+		.set({
+			name
+		})
+		.where('id', '==', keyId)
+		.execute()
+}
+
 export async function projectHasKey(projectId: number, key: string): Promise<boolean> {
 	const result = await db
 		.selectFrom('apikeys')

services/src/kysely/migrations/2024-05-16T19:00:00Z_apikey.ts

@@ -4,6 +4,7 @@ import { createTableMigration } from '../migration.util'
 export async function up(db: Kysely<unknown>): Promise<void> {
 	await createTableMigration(db, 'apikeys')
 		.addColumn('key', 'text', (col) => col.unique().notNull())
+		.addColumn('name', 'text')
 		.addColumn('project_id', 'integer', (col) =>
 			col.references('projects.id').onDelete('cascade').notNull()
 		)