feat: Review

Author: makeev-pavel

src/apitypes/rest/rest.changes.ts

@@ -82,7 +82,7 @@ import {
   getOperationTags,
   OperationsMap,
 } from '../../components'
-import { createApiKindChecker, getApiKindFormLabels } from '../../components/compare/bwc.validation'
+import { createApiKindChecker, getApiKindFromLabels } 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: createApiKindChecker(
-        prevDoc?.apiKind ?? getApiKindFormLabels(prevDocData?.info, prevDoc?.labels, previousVersionLabels),
-        currDoc?.apiKind ?? getApiKindFormLabels(currDocData?.info, currDoc?.labels, currentVersionLabels),
+        prevDoc?.apiKind ?? getApiKindFromLabels(prevDocData?.info, prevDoc?.labels, previousVersionLabels),
+        currDoc?.apiKind ?? getApiKindFromLabels(currDocData?.info, currDoc?.labels, currentVersionLabels),
       ),
     },
   ) as { merged: OpenAPIV3.Document; diffs: Diff[] }

src/apitypes/rest/rest.document.ts

@@ -76,7 +76,7 @@ export const buildRestDocument: DocumentBuilder<OpenAPIV3.Document> = async (par
 
   let bundledFileData = data
 
-  const documentKind = getApiKind(bundledFileData?.info, apiKind)
+  const documentApiKind = getApiKind(bundledFileData?.info, apiKind)
 
   if (parsedFile.type === REST_DOCUMENT_TYPE.SWAGGER) {
     try {
@@ -99,7 +99,7 @@ export const buildRestDocument: DocumentBuilder<OpenAPIV3.Document> = async (par
     fileId: parsedFileId,
     type: type,
     format: FILE_FORMAT.JSON,
-    apiKind: documentKind,
+    apiKind: documentApiKind,
     data: bundledFileData,
     slug, // unique slug should be already generated
     filename: `${slug}.${FILE_FORMAT.JSON}`,

src/components/compare/bwc.validation.ts

@@ -23,7 +23,7 @@ import {
   ApiCompatibilityScopeFunction,
 } from '@netcracker/qubership-apihub-api-diff'
 import { Labels } from '../../types'
-import { findApiKindLabel, getApiKind } from '../document'
+import { calculateApiKindFromLabels, getApiKind } from '../document'
 import { OpenAPIV3 } from 'openapi-types'
 
 export const getApiCompatibilityKind = (beforeJson: unknown, afterJson: unknown): ApiCompatibilityKind | undefined => {
@@ -63,10 +63,6 @@ const checkAllMethodsHaveSameApiKind = (obj: unknown, apiKind: string): boolean
   if (!isObject(obj)) {
     return false
   }
-
-  if (hasApiKind(obj, apiKind)) {
-    return true
-  }
   const entries = Object.entries(obj)
 
   return entries.length > 0 &&
@@ -110,39 +106,40 @@ export const createApiKindChecker = (
     * Level 3: When individual operations are deleted/added
      */
     const isFirstPathSegmentPaths = path?.[0] === 'paths'
-    if (!isFirstPathSegmentPaths || pathLength < PATH_ITEM_PATH_LENGTH || pathLength > OPERATION_OBJECT_PATH_LENGTH) {
+    if (!isFirstPathSegmentPaths) {
       return undefined
     }
-
     const beforeExists = isObject(beforeJson)
     const afterExists = isObject(afterJson)
 
     if (!beforeExists && !afterExists) {
       return undefined
     }
 
-    if (beforeExists && afterExists) {
-      return getApiCompatibilityKind(beforeJson, afterJson)
+    if (pathLength === PATH_ITEM_PATH_LENGTH) {
+      // 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 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 getMethodsApiCompatibilityKind(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 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 getMethodsApiCompatibilityKind(afterJson)
+    if (pathLength === OPERATION_OBJECT_PATH_LENGTH) {
+      return getApiCompatibilityKind(beforeJson, afterJson)
     }
 
     return undefined
   }
 }
 
-export const getApiKindFormLabels = (
+export const getApiKindFromLabels = (
   info?: OpenAPIV3.InfoObject,
   fileLabels?: Labels,
   versionLabels?: Labels,
@@ -152,6 +149,6 @@ export const getApiKindFormLabels = (
     return infoApiKind.toLowerCase()
   }
 
-  const apiKind = findApiKindLabel(fileLabels, versionLabels)
+  const apiKind = calculateApiKindFromLabels(fileLabels, versionLabels)
   return apiKind?.toLowerCase()
 }

src/components/document.ts

@@ -48,15 +48,15 @@ export const buildDocument = async (parsedFile: SourceFile, file: BuildConfigFil
   const apiBuilder = ctx.apiBuilders.find(({ types }) => types.includes(parsedFile.type)) || unknownApiBuilder
 
   try {
-    file.apiKind = findApiKindLabel(file.labels, ctx.versionLabels)
+    file.apiKind = calculateApiKindFromLabels(file.labels, ctx.versionLabels)
 
     return await apiBuilder.buildDocument(parsedFile, file, ctx)
   } catch (error) {
     throw new Error(`Cannot process the "${file.fileId}" document. ${error instanceof Error ? error.message : 'Unknown error'}`)
   }
 }
 
-export const findApiKindLabel = (fileLabels: unknown, versionLabels: unknown): ApiKind => {
+export const calculateApiKindFromLabels = (fileLabels: unknown, versionLabels: unknown): ApiKind => {
   if (!Array.isArray(fileLabels) && !Array.isArray(versionLabels)) {
     return API_KIND.BWC
   }