Clean-up tests & finalize

directus · May 3, 2024 · 267c946 · 267c946
1 parent a5eca6f
commit 267c946
Show file tree

Hide file tree

Showing 6 changed files with 226 additions and 215 deletions.
diff --git a/api/src/middleware/authenticate/extract-token.test.ts b/api/src/middleware/authenticate/extract-token.test.ts
@@ -19,10 +19,10 @@ beforeEach(() => {
 });
 
 describe('General', () => {
-	test('Null if no token passed', () => {
+	test('Null if no token in request', () => {
 		const result = extractToken(mockRequest);
 
-		expect(mockRequest.token).toBeNull();
+		expect(result.token).toBeNull();
 		expect(result.source).toBeNull();
 	});
 
@@ -49,7 +49,7 @@ describe('General', () => {
 
 		const result = extractToken(mockRequest);
 
-		expect(mockRequest.token).toBe('test');
+		expect(result.token).toBe('test');
 		expect(result.source).toBe('query');
 	});
 });
@@ -62,7 +62,7 @@ describe('Query', () => {
 
 		const result = extractToken(mockRequest);
 
-		expect(mockRequest.token).toBe('test');
+		expect(result.token).toBe('test');
 		expect(result.source).toBe('query');
 	});
 
@@ -73,7 +73,7 @@ describe('Query', () => {
 
 		const result = extractToken(mockRequest);
 
-		expect(mockRequest.token).toBeNull();
+		expect(result.token).toBeNull();
 		expect(result.source).toBeNull();
 	});
 
@@ -84,7 +84,7 @@ describe('Query', () => {
 
 		const result = extractToken(mockRequest);
 
-		expect(mockRequest.token).toBeNull();
+		expect(result.token).toBeNull();
 		expect(result.source).toBeNull();
 	});
 });
@@ -97,7 +97,7 @@ describe('Header', () => {
 
 		const result = extractToken(mockRequest);
 
-		expect(mockRequest.token).toBe('test');
+		expect(result.token).toBe('test');
 		expect(result.source).toBe('header');
 	});
 
@@ -108,7 +108,7 @@ describe('Header', () => {
 
 		const result = extractToken(mockRequest);
 
-		expect(mockRequest.token).toBe('test');
+		expect(result.token).toBe('test');
 		expect(result.source).toBe('header');
 	});
 
@@ -119,7 +119,7 @@ describe('Header', () => {
 
 		const result = extractToken(mockRequest);
 
-		expect(mockRequest.token).toBeNull();
+		expect(result.token).toBeNull();
 		expect(result.source).toBeNull();
 	});
 
@@ -130,7 +130,7 @@ describe('Header', () => {
 
 		const result = extractToken(mockRequest);
 
-		expect(mockRequest.token).toBeNull();
+		expect(result.token).toBeNull();
 		expect(result.source).toBeNull();
 	});
 });
@@ -143,7 +143,7 @@ describe('Cookie', () => {
 
 		const result = extractToken(mockRequest);
 
-		expect(mockRequest.token).toBe('test');
+		expect(result.token).toBe('test');
 		expect(result.source).toBe('cookie');
 	});
 
@@ -154,7 +154,7 @@ describe('Cookie', () => {
 
 		const result = extractToken(mockRequest);
 
-		expect(mockRequest.token).toBeNull();
+		expect(result.token).toBeNull();
 		expect(result.source).toBeNull();
 	});
 });
diff --git a/api/src/middleware/authenticate/get-accountability.test.ts b/api/src/middleware/authenticate/get-accountability.test.ts
@@ -30,7 +30,7 @@ afterEach(() => {
 	vi.resetAllMocks();
 });
 
-test('Short-circuits when "authenticate" filter is used', async () => {
+test('Short-circuit when "authenticate" filter is used', async () => {
 	const customAccountability = {};
 
 	vi.spyOn(emitter, 'emitFilter').mockResolvedValue(customAccountability);
@@ -40,7 +40,7 @@ test('Short-circuits when "authenticate" filter is used', async () => {
 	expect(result).toBe(customAccountability);
 });
 
-test('Uses default public accountability when no token is given', async () => {
+test('Use default public accountability when no token is given', async () => {
 	vi.spyOn(emitter, 'emitFilter').mockImplementation(async (_, payload) => payload);
 
 	const result = await getAccountability(mockRequest, null);
@@ -56,7 +56,7 @@ test('Uses default public accountability when no token is given', async () => {
 	});
 });
 
-test('Gets accountability from token if valid token is passed', async () => {
+test('Get accountability from token if valid token is passed', async () => {
 	vi.spyOn(emitter, 'emitFilter').mockImplementation(async (_, payload) => payload);
 
 	const tokenAccountability = {} as Accountability;

diff --git a/api/src/middleware/authenticate/get-accountability.ts b/api/src/middleware/authenticate/get-accountability.ts
@@ -8,6 +8,8 @@ import { getIPFromReq } from '../../utils/get-ip-from-req.js';
 
 /**
  * Get accountability for request / token.
+ *
+ * @throws If provided token is invalid.
  */
 export async function getAccountability(req: Request, token: string | null) {
 	const defaultAccountability: Accountability = {