feat: Refactoring

Author: makeev-pavel

src/apitypes/rest/rest.changes.ts

@@ -82,7 +82,7 @@ import {
   getOperationTags,
   OperationsMap,
 } from '../../components'
-import { checkApiKind, calculateApiKind } from '../../components/compare/bwc.validation'
+import { checkApiKind, getApiKindFormLabels } from '../../components/compare/bwc.validation'
 
 export const compareDocuments: DocumentsCompare = async (
   operationsMap: OperationsMap,
@@ -136,8 +136,8 @@ export const compareDocuments: DocumentsCompare = async (
       afterValueNormalizedProperty: AFTER_VALUE_NORMALIZED_PROPERTY,
       beforeValueNormalizedProperty: BEFORE_VALUE_NORMALIZED_PROPERTY,
       apiCompatibilityScopeFunction: checkApiKind(
-        prevDoc?.apiKind ?? calculateApiKind(prevDocData?.info, prevDoc?.labels, previousVersionLabels),
-        currDoc?.apiKind ?? calculateApiKind(currDocData?.info, currDoc?.labels, currentVersionLabels),
+        prevDoc?.apiKind ?? getApiKindFormLabels(prevDocData?.info, prevDoc?.labels, previousVersionLabels),
+        currDoc?.apiKind ?? getApiKindFormLabels(currDocData?.info, currDoc?.labels, currentVersionLabels),
       ),
     },
   ) as { merged: OpenAPIV3.Document; diffs: Diff[] }

src/components/compare/bwc.validation.ts

@@ -22,22 +22,49 @@ import {
   ApiCompatibilityScope,
   ApiCompatibilityScopeFunction,
 } from '@netcracker/qubership-apihub-api-diff'
-import { ApiKind, Labels } from '../../types'
+import { Labels } from '../../types'
 import { findApiKindLabel, getApiKind } from '../document'
 import { OpenAPIV3 } from 'openapi-types'
 
-const hasNoBWC = (obj: unknown): boolean => {
-  return getApiKind(obj) === API_KIND.NO_BWC
+export const getApiCompatibilityKind = (beforeJson: unknown, afterJson: unknown): ApiCompatibilityKind | undefined => {
+  const beforeApiKind = getApiKind(beforeJson)?.toLowerCase() ?? ''
+  const afterApiKind = getApiKind(afterJson)?.toLowerCase() ?? ''
+
+  if (beforeApiKind === API_KIND.NO_BWC || afterApiKind === API_KIND.NO_BWC) {
+    return ApiCompatibilityKind.NOT_BACKWARD_COMPATIBLE
+  }
+
+  if (beforeApiKind === API_KIND.BWC || afterApiKind === API_KIND.BWC) {
+    return ApiCompatibilityKind.BACKWARD_COMPATIBLE
+  }
+
+  return undefined
+}
+
+export const getMethodsApiCompatibilityKind = (obj: unknown): ApiCompatibilityKind | undefined => {
+  if (checkAllMethodsHaveSameApiKind(obj, API_KIND.NO_BWC)) {
+    return ApiCompatibilityKind.NOT_BACKWARD_COMPATIBLE
+  }
+
+  if (checkAllMethodsHaveSameApiKind(obj, API_KIND.BWC)) {
+    return ApiCompatibilityKind.BACKWARD_COMPATIBLE
+  }
+
+  return undefined
+}
+
+const hasApiKind = (obj: unknown, apiKind: string): boolean => {
+  return getApiKind(obj) === apiKind
 }
 
 // If a path object is removed/added, we must ensure every HTTP method under it
 // is explicitly marked NO_BWC before treating the change as risky.
-const checkAllMethodsHaveNoBWC = (obj: unknown): boolean => {
+const checkAllMethodsHaveSameApiKind = (obj: unknown, apiKind: string): boolean => {
   if (!isObject(obj)) {
     return false
   }
 
-  if (hasNoBWC(obj)) {
+  if (hasApiKind(obj, apiKind)) {
     return true
   }
   const entries = Object.entries(obj)
@@ -46,7 +73,7 @@ const checkAllMethodsHaveNoBWC = (obj: unknown): boolean => {
     entries.every(([key, value]) =>
       isValidHttpMethod(key) &&
       isObject(value) &&
-      hasNoBWC(value),
+      hasApiKind(value, apiKind),
     )
 }
 
@@ -95,40 +122,36 @@ export const checkApiKind = (
     }
 
     if (beforeExists && afterExists) {
-      return hasNoBWC(beforeJson) || hasNoBWC(afterJson)
-        ? ApiCompatibilityKind.NOT_BACKWARD_COMPATIBLE
-        : undefined
+      return getApiCompatibilityKind(beforeJson, afterJson)
     }
 
     // case remove: when a node disappears, api-diff emits REMOVE diffs for each
     // operation. We only mark the deletion as NO_BWC if all removed methods were
     // explicitly flagged NO_BWC, keeping deletions consistent with declared scope.
     if (beforeExists && !afterExists) {
-      return checkAllMethodsHaveNoBWC(beforeJson)
-        ? ApiCompatibilityKind.NOT_BACKWARD_COMPATIBLE
-        : undefined
+      return getMethodsApiCompatibilityKind(beforeJson)
     }
 
     // case add: additions are checked the same way. A new path or operation is
     // considered NO_BWC only when every contained method declares NO_BWC.
     if (afterExists && !beforeExists) {
-      return checkAllMethodsHaveNoBWC(afterJson)
-        ? ApiCompatibilityKind.NOT_BACKWARD_COMPATIBLE
-        : undefined
+      return getMethodsApiCompatibilityKind(afterJson)
     }
 
     return undefined
   }
 }
 
-export const calculateApiKind = (info?: OpenAPIV3.InfoObject, fileLabels?: Labels, versionLabels?: Labels): ApiKind => {
+export const getApiKindFormLabels = (
+  info?: OpenAPIV3.InfoObject,
+  fileLabels?: Labels,
+  versionLabels?: Labels,
+): string | undefined => {
   const infoApiKind = getApiKind(info)
-  if (infoApiKind && infoApiKind?.toLowerCase() === API_KIND.NO_BWC) {
-    return API_KIND.NO_BWC
+  if (infoApiKind) {
+    return infoApiKind.toLowerCase()
   }
-  const apiKind = findApiKindLabel(fileLabels, versionLabels)
 
-  return apiKind?.toLowerCase() === API_KIND.NO_BWC
-    ? API_KIND.NO_BWC
-    : API_KIND.BWC
+  const apiKind = findApiKindLabel(fileLabels, versionLabels)
+  return apiKind?.toLowerCase()
 }

test/apiKinds.test.ts

@@ -201,59 +201,123 @@ describe('Check Api Compatibility Function tests', () => {
     })
   })
 
-  describe('Publish ApiKind version Labels and file Labels priority tests', () => {
-    test('should prioritize version label no-BWC over file label BWC in previous version', async () => {
+  describe('ApiKind info section tests', () => {
+    test('should apply api-kind label in previous document info section', async () => {
+      const result = await runApiKindTest('api-kinds/no-bwc-api-kind-info-label-in-prev-document')
+      expect(result).toEqual(changesSummaryMatcher({ [RISKY_CHANGE_TYPE]: 1 }))
+    })
+
+    test('should apply api-kind label in current document info section', async () => {
+      const result = await runApiKindTest('api-kinds/no-bwc-api-kind-info-label-in-curr-document')
+      expect(result).toEqual(changesSummaryMatcher({ [RISKY_CHANGE_TYPE]: 1 }))
+    })
+  })
+
+  describe('ApiKind operations section tests', () => {
+    test('should apply api-kind label in current document operation', async () => {
+      const result = await runApiKindTest('api-kinds/no-bwc-api-kind-operation-label-curr-document')
+      expect(result).toEqual(changesSummaryMatcher({
+        [RISKY_CHANGE_TYPE]: 1,
+        [UNCLASSIFIED_CHANGE_TYPE]: 1, // x-api-kind field in the operation also gives a diff
+      }))
+    })
+
+    test('should apply api-kind label in previous document operation', async () => {
+      const result = await runApiKindTest('api-kinds/no-bwc-api-kind-operation-label-prev-document')
+      expect(result).toEqual(changesSummaryMatcher({
+        [RISKY_CHANGE_TYPE]: 1,
+        [UNCLASSIFIED_CHANGE_TYPE]: 1, // x-api-kind field in the operation also gives a diff
+      }))
+    })
+  })
+
+  describe('Publish ApiKind Priority tests', () => {
+    test('should prioritize version label no-BWC api kind over file label BWC in previous version', async () => {
       const result = await runApiKindTest(
         'api-kinds/no-api-kind-in-documents', [API_KIND_BWC_LABEL], [], [API_KIND_NO_BWC_LABEL],
       )
       expect(result).toEqual(changesSummaryMatcher({ [BREAKING_CHANGE_TYPE]: 1 }))
     })
 
-    test('should prioritize version label no-BWC over file label BWC in current version', async () => {
+    test('should prioritize version label no-BWC api kind over file label BWC in current version', async () => {
       const result = await runApiKindTest(
         'api-kinds/no-api-kind-in-documents', [], [API_KIND_BWC_LABEL], [], [API_KIND_NO_BWC_LABEL],
       )
       expect(result).toEqual(changesSummaryMatcher({ [BREAKING_CHANGE_TYPE]: 1 }))
     })
 
-    test('should prioritize file label no-BWC over version label BWC in previous version', async () => {
+    test('should prioritize file label no-BWC api kind over version label BWC in previous version', async () => {
       const result = await runApiKindTest(
         'api-kinds/no-api-kind-in-documents', [API_KIND_NO_BWC_LABEL], [], [API_KIND_BWC_LABEL],
       )
       expect(result).toEqual(changesSummaryMatcher({ [RISKY_CHANGE_TYPE]: 1 }))
     })
 
-    test('should prioritize file label no-BWC over version label BWC in current version', async () => {
+    test('should prioritize file label no-BWC api kind over version label BWC in current version', async () => {
       const result = await runApiKindTest(
         'api-kinds/no-api-kind-in-documents', [], [API_KIND_NO_BWC_LABEL], [], [API_KIND_BWC_LABEL],
       )
       expect(result).toEqual(changesSummaryMatcher({ [RISKY_CHANGE_TYPE]: 1 }))
     })
-  })
 
-  describe('ApiKind info section tests', () => {
-    test('should apply api-kind label in previous document info section', async () => {
-      const result = await runApiKindTest('api-kinds/api-kind-info-label-in-prev-document')
+    test('should prioritize info label no-BWC api kind over version label BWC in previous version', async () => {
+      const result = await runApiKindTest(
+        'api-kinds/no-bwc-api-kind-info-label-in-prev-document', [API_KIND_BWC_LABEL], [], [API_KIND_BWC_LABEL],
+      )
       expect(result).toEqual(changesSummaryMatcher({ [RISKY_CHANGE_TYPE]: 1 }))
     })
 
-    test('should apply api-kind label in current document info section', async () => {
-      const result = await runApiKindTest('api-kinds/api-kind-info-label-in-curr-document')
+    test('should prioritize info label no-BWC api kind over version label BWC in current version', async () => {
+      const result = await runApiKindTest(
+        'api-kinds/no-bwc-api-kind-info-label-in-curr-document', [], [API_KIND_BWC_LABEL], [], [API_KIND_BWC_LABEL],
+      )
       expect(result).toEqual(changesSummaryMatcher({ [RISKY_CHANGE_TYPE]: 1 }))
     })
-  })
 
-  describe('ApiKind operations section tests', () => {
-    test('should apply api-kind label in current document operation', async () => {
-      const result = await runApiKindTest('api-kinds/api-kind-operation-label-curr-document')
+    test('should prioritize previous info label as BWC when info api-kind overrides no-BWC publish labels', async () => {
+      const result = await runApiKindTest(
+        'api-kinds/bwc-api-kind-info-label-in-prev-document', [API_KIND_NO_BWC_LABEL], [], [API_KIND_NO_BWC_LABEL],
+      )
+      expect(result).toEqual(changesSummaryMatcher({ [BREAKING_CHANGE_TYPE]: 1 }))
+    })
+
+    test('should prioritize current info label as BWC when info api kind overrides no-BWC publish labels', async () => {
+      const result = await runApiKindTest(
+        'api-kinds/bwc-api-kind-info-label-in-curr-document', [], [API_KIND_NO_BWC_LABEL], [], [API_KIND_NO_BWC_LABEL],
+      )
+      expect(result).toEqual(changesSummaryMatcher({ [BREAKING_CHANGE_TYPE]: 1 }))
+    })
+
+    test('should prioritize previous operation-level BWC api kind over current no-BWC publish labels', async () => {
+      const result = await runApiKindTest(
+        'api-kinds/bwc-api-kind-operation-label-prev-document', [], [API_KIND_NO_BWC_LABEL], [], [API_KIND_NO_BWC_LABEL],
+      )
+      expect(result).toEqual(changesSummaryMatcher({
+        [BREAKING_CHANGE_TYPE]: 1,
+        [UNCLASSIFIED_CHANGE_TYPE]: 1, // x-api-kind field in the operation also gives a diff
+      }))
+    })
+
+    test('should prioritize current operation-level BWC api kind over current no-BWC publish labels', async () => {
+      const result = await runApiKindTest(
+        'api-kinds/bwc-api-kind-operation-label-curr-document', [], [API_KIND_NO_BWC_LABEL], [], [API_KIND_NO_BWC_LABEL],
+      )
+      expect(result).toEqual(changesSummaryMatcher({
+        [BREAKING_CHANGE_TYPE]: 1,
+        [UNCLASSIFIED_CHANGE_TYPE]: 1, // x-api-kind field in the operation also gives a diff
+      }))
+    })
+
+    test('should prioritize current operation-level no-BWC api kind over current BWC info label', async () => {
+      const result = await runApiKindTest('api-kinds/double-api-kind-info-label-in-curr-document')
       expect(result).toEqual(changesSummaryMatcher({
         [RISKY_CHANGE_TYPE]: 1,
         [UNCLASSIFIED_CHANGE_TYPE]: 1, // x-api-kind field in the operation also gives a diff
       }))
     })
 
-    test('should apply api-kind label in previous document operation', async () => {
-      const result = await runApiKindTest('api-kinds/api-kind-operation-label-prev-document')
+    test('should prioritize current operation-level no-BWC api kind over previous BWC info label', async () => {
+      const result = await runApiKindTest('api-kinds/double-api-kind-info-label-in-prev-document')
       expect(result).toEqual(changesSummaryMatcher({
         [RISKY_CHANGE_TYPE]: 1,
         [UNCLASSIFIED_CHANGE_TYPE]: 1, // x-api-kind field in the operation also gives a diff

…-kind-info-label-in-curr-document/1.yaml …-kind-info-label-in-curr-document/1.yamltest/projects/api-kinds/api-kind-info-label-in-curr-document/1.yaml renamed to test/projects/api-kinds/bwc-api-kind-info-label-in-curr-document/1.yaml test/projects/api-kinds/api-kind-info-label-in-curr-document/1.yaml renamed to test/projects/api-kinds/bwc-api-kind-info-label-in-curr-document/1.yaml

@@ -0,0 +1,15 @@
+openapi: 3.1.0
+info:
+  title: test
+  version: 0.1.0
+  x-api-kind: BWC
+paths:
+  /path1:
+    post:
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: string

test/projects/api-kinds/bwc-api-kind-info-label-in-curr-document/2.yaml

@@ -0,0 +1,15 @@
+openapi: 3.1.0
+info:
+  title: test
+  version: 0.1.0
+  x-api-kind: BWC
+paths:
+  /path1:
+    post:
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: number