Fix inconsistency for results associated to skipped blocks

uphold · Aug 3, 2024 · 0df7319 · 0df7319
1 parent 29e5e01
commit 0df7319
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 14 deletions.
diff --git a/src/parser/security.js b/src/parser/security.js
@@ -57,7 +57,7 @@ export const parseSecurity = (operation, spec, securityHandlers) => {
       const blockHasMissingValues = Object.keys(block).some(name => readSchemeValue(name) == null);
 
       if (blockHasMissingValues) {
-        report.push({ schemes: {}, status: 'skipped' });
+        report.push({ ok: false, schemes: {} });
         continue;
       }
 

diff --git a/src/parser/security.test.js b/src/parser/security.test.js
@@ -364,12 +364,29 @@ describe('parseSecurity()', () => {
 
     const onRequest = parseSecurity(operation, spec, securityHandlers);
 
-    expect.assertions(2);
+    expect.assertions(3);
 
     await onRequest(request);
 
     expect(securityHandlers.ApiKey).not.toHaveBeenCalled();
     expect(securityHandlers.OAuth2).toHaveBeenCalledTimes(1);
+    expect(request[DECORATOR_NAME].securityReport).toMatchInlineSnapshot(`
+      [
+        {
+          "ok": false,
+          "schemes": {},
+        },
+        {
+          "ok": true,
+          "schemes": {
+            "OAuth2": {
+              "data": "OAuth2 data",
+              "ok": true,
+            },
+          },
+        },
+      ]
+    `);
   });
 
   it('should validate scopes', async () => {

diff --git a/types/index.d.ts b/types/index.d.ts
@@ -8,7 +8,7 @@ declare module 'fastify' {
     [DECORATOR_NAME]: {
       operation: OpenAPI.OpenAPIV3_1.OperationObject,
       security: RequestSecurity
-      securityReport: RequestSecurityReportEntry[]
+      securityReport: RequestSecurityReport
     }
   }
 
@@ -20,11 +20,9 @@ declare module 'fastify' {
   }
 }
 
-export interface RequestSecurity {
-  [key:string]: any
-}
+export interface RequestSecurityReport extends Array<RequestSecurityReportBlock> {}
 
-export interface RequestSecurityReportEntry {
+export interface RequestSecurityReportBlock {
   ok: boolean
   schemes: {
     [key:string]: {
@@ -35,13 +33,6 @@ export interface RequestSecurityReportEntry {
   }
 }
 
-export interface RequestSecurityReportResult {
-  ok: boolean
-  schemes: {
-    [key:string]: RequestSecurityReportResult
-  }
-}
-
 export type SecurityHandler = (value: string, request: FastifyRequest) => SecurityHandlerReturn | undefined
 
 export interface SecurityHandlerReturn { data?: any, scopes?: string[] }