chore: merge branch 'feature/performance-optimization' into feature/security-changes-classification

Author: b41ex

src/apitypes/rest/rest.changes.ts

@@ -60,6 +60,7 @@ import { REST_API_TYPE } from './rest.consts'
 import { OpenAPIV3 } from 'openapi-types'
 import {
   extractOperationSecurityDiffs,
+  extractOpenapiVersionDiff,
   extractPathParamRenameDiff,
   extractRootSecurityDiffs,
   extractRootServersDiffs,
@@ -174,6 +175,7 @@ export const compareDocuments = async (
         const relevantSecuritySchemesNames = shouldTakeRootSecurityDiffs ? extractSecuritySchemesNames(merged.security ?? []) : extractSecuritySchemesNames(methodData?.security ?? [])
         operationDiffs = [
           ...(methodData as WithAggregatedDiffs<OpenAPIV3.OperationObject>)[DIFFS_AGGREGATED_META_KEY] ?? [],
+          ...extractOpenapiVersionDiff(merged),
           ...extractRootServersDiffs(merged),
           ...shouldTakeRootSecurityDiffs ? extractRootSecurityDiffs(merged) : [],
           ...extractSecuritySchemesDiffs(merged.components, relevantSecuritySchemesNames),

src/apitypes/rest/rest.utils.ts

@@ -70,6 +70,11 @@ export const dump = (value: unknown, format: typeof FILE_FORMAT_YAML | typeof FI
   throw new Error(`Unsupported format: ${format}`)
 }
 
+export const extractOpenapiVersionDiff = (doc: OpenAPIV3.Document): Diff[] => {
+  const diff = (doc as WithDiffMetaRecord<OpenAPIV3.Document>)[DIFF_META_KEY]?.openapi
+  return diff ? [diff] : []
+}
+
 export const extractPathParamRenameDiff = (doc: OpenAPIV3.Document, path: string): Diff[] => {
   const diff = (doc.paths as WithDiffMetaRecord<OpenAPIV3.PathsObject>)[DIFF_META_KEY]?.[path]
   return diff && isPathParamRenameDiff(diff) ? [diff] : []

test/changes.test.ts

@@ -244,6 +244,13 @@ describe('Changelog build type', () => {
         [UNCLASSIFIED_CHANGE_TYPE]: 1,
       }))
     })
+
+    test('Change openapi version', async () => {
+      const result = await buildChangelogPackage('changelog/change-openapi-version')
+
+      expect(result).toEqual(changesSummaryMatcher({ [ANNOTATION_CHANGE_TYPE]: 1 }))
+      expect(result).toEqual(numberOfImpactedOperationsMatcher({ [ANNOTATION_CHANGE_TYPE]: 1 }))
+    })
   })
 
   test('Operation changes fields are correct', async () => {

test/projects/changelog/change-openapi-version/after.yaml

@@ -0,0 +1,11 @@
+openapi: 3.0.4
+info:
+  title: test
+  version: 0.1.0
+paths:
+  /path1:
+    get:
+      responses:
+        '200':
+          description: OK
+          content: {}

test/projects/changelog/change-openapi-version/before.yaml

@@ -0,0 +1,11 @@
+openapi: 3.0.3
+info:
+  title: test
+  version: 0.1.0
+paths:
+  /path1:
+    get:
+      responses:
+        '200':
+          description: OK
+          content: {}