feat: collect all deep changes in components.securitySchemes

Author: CountRedClaw

src/apitypes/rest/rest.utils.ts

@@ -21,12 +21,13 @@ import {
   API_AUDIENCE_INTERNAL,
   API_AUDIENCE_UNKNOWN,
   ApiAudience,
+  WithAggregatedDiffs,
   WithDiffMetaRecord,
 } from '../../types'
 import { isObject } from '@netcracker/qubership-apihub-json-crawl'
 import { CUSTOM_PARAMETER_API_AUDIENCE, FILE_FORMAT_JSON, FILE_FORMAT_YAML } from '../../consts'
 import YAML from 'js-yaml'
-import { Diff, DIFF_META_KEY } from '@netcracker/qubership-apihub-api-diff'
+import { Diff, DIFF_META_KEY, DIFFS_AGGREGATED_META_KEY } from '@netcracker/qubership-apihub-api-diff'
 import { isPathParamRenameDiff } from '../../utils'
 
 export const extractOperationBasePath = (servers?: OpenAPIV3.ServerObject[]): string => {
@@ -106,7 +107,7 @@ export const extractRootServersDiffs = (doc: OpenAPIV3.Document): Diff[] => {
 export const extractRootSecurityDiffs = (doc: OpenAPIV3.Document): Diff[] => {
   const addedSecurityDiff = (doc as WithDiffMetaRecord<OpenAPIV3.Document>)[DIFF_META_KEY]?.security
   const securityDiffs = Object.values((doc.security as WithDiffMetaRecord<OpenAPIV3.SecurityRequirementObject[]>)?.[DIFF_META_KEY] ?? {})
-  const componentsSecuritySchemesDiffs = Object.values((doc.components?.securitySchemes as WithDiffMetaRecord<Record<string, OpenAPIV3.SecuritySchemeObject>>)[DIFF_META_KEY] ?? {})
+  const componentsSecuritySchemesDiffs = (doc.components?.securitySchemes as WithAggregatedDiffs<Record<string, OpenAPIV3.SecuritySchemeObject>>)[DIFFS_AGGREGATED_META_KEY]
   return [
     ...(addedSecurityDiff ? [addedSecurityDiff] : []),
     ...securityDiffs,

test/changes.test.ts

@@ -22,7 +22,13 @@ import {
   numberOfImpactedOperationsMatcher,
   operationChangesMatcher,
 } from './helpers'
-import { ANNOTATION_CHANGE_TYPE, BREAKING_CHANGE_TYPE, BUILD_TYPE, NON_BREAKING_CHANGE_TYPE } from '../src'
+import {
+  ANNOTATION_CHANGE_TYPE,
+  BREAKING_CHANGE_TYPE,
+  BUILD_TYPE,
+  NON_BREAKING_CHANGE_TYPE,
+  UNCLASSIFIED_CHANGE_TYPE,
+} from '../src'
 
 let beforePackage: LocalRegistry
 let afterPackage: LocalRegistry
@@ -155,6 +161,17 @@ describe('Changes test', () => {
         [NON_BREAKING_CHANGE_TYPE]: 1,
       }))
     })
+
+    test('Change securityScheme content', async () => {
+      const result = await buildChangelogPackage('changelog/change-inside-securityScheme')
+
+      expect(result).toEqual(changesSummaryMatcher({
+        [UNCLASSIFIED_CHANGE_TYPE]: 1,
+      }))
+      expect(result).toEqual(numberOfImpactedOperationsMatcher({
+        [UNCLASSIFIED_CHANGE_TYPE]: 1,
+      }))
+    })
   })
 
   test('Operation changes fields are correct (REST)', async () => {

test/projects/changelog/change-inside-securityScheme/after.yaml

@@ -0,0 +1,26 @@
+openapi: 3.0.3
+info:
+  title: test
+  version: 0.1.0
+security:
+  - ApiKeyAuth1: [ ]
+paths:
+  /path1:
+    post:
+      responses:
+        '200':
+          description: OK
+          content: { }
+      security:
+        - Oauth2:
+            - https://www.googleapis.com/auth/bigquery
+components:
+  securitySchemes:
+    Oauth2:
+      description: Oauth 2.0 authentication
+      type: oauth2
+      flows:
+        implicit:
+          authorizationUrl: https://accounts.google.com/o/oauth2/auth
+          scopes:
+            https://www.googleapis.com/auth/bigquery: View and manage your data in Google BigQuery

test/projects/changelog/change-inside-securityScheme/before.yaml

@@ -0,0 +1,26 @@
+openapi: 3.0.3
+info:
+  title: test
+  version: 0.1.0
+security:
+  - ApiKeyAuth1: [ ]
+paths:
+  /path1:
+    post:
+      responses:
+        '200':
+          description: OK
+          content: { }
+      security:
+        - Oauth2:
+            - https://www.googleapis.com/auth/bigquery
+components:
+  securitySchemes:
+    Oauth2:
+      description: Oauth 2.0 authentication
+      type: oauth2
+      flows:
+        implicit:
+          authorizationUrl: https://accounts.google.com/o/oauth2/auth
+          scopes:
+            https://www.googleapis.com/auth/bigquery: BigQuery