feat: Review

Author: makeev-pavel

src/apitypes/rest/rest.operation.ts

@@ -32,8 +32,10 @@ import {
 import {
   buildSearchScope,
   capitalize,
+  copySymbolIfDefined,
   getKeyValue,
   getSplittedVersionKey,
+  getSymbolValueIfDefined,
   isDeprecatedOperationItem,
   isObject,
   isOperationDeprecated,
@@ -247,12 +249,12 @@ export const calculateSpecRefs = (
   })
 
   if (operations?.length) {
-    resolveComponentsPathItemOperationSpec(resultSpec, normalizedSpec, operations)
+    reduceComponentPathItemsToOperations(resultSpec, normalizedSpec, operations)
   }
 }
 
-export function resolveComponentsPathItemOperationSpec(
-  sourceDocument: RestOperationData,
+export function reduceComponentPathItemsToOperations(
+  resultSpec: RestOperationData,
   normalizedDocument: RestOperationData,
   operations: OperationId[],
 ): void {
@@ -263,16 +265,16 @@ export function resolveComponentsPathItemOperationSpec(
     if (!isNonNullObject(sourcePathItem)) {
       continue
     }
-    const refs: string[] = hasInlineRefsFlag(sourcePathItem) ? sourcePathItem[INLINE_REFS_FLAG] : []
-    if (refs.length === 0) {
+    const refs = getSymbolValueIfDefined(sourcePathItem, INLINE_REFS_FLAG) as string[] | undefined
+    if (!refs || refs?.length === 0) {
       continue
     }
     const { jsonPath } = parseRef(refs[0])
     if (!jsonPath) {
       continue
     }
 
-    const valueByPath = getValueByPath(sourceDocument, jsonPath) as OpenAPIV3.PathItemObject
+    const valueByPath = getValueByPath(resultSpec, jsonPath) as OpenAPIV3.PathItemObject
 
     const operationIds: OpenAPIV3.HttpMethods[] = (Object.keys(valueByPath) as OpenAPIV3.HttpMethods[])
       .filter((httpMethod) => isValidHttpMethod(httpMethod))
@@ -284,7 +286,7 @@ export function resolveComponentsPathItemOperationSpec(
           sourcePathItem?.servers ||
           [],
         )
-        const operationId = getOperationId(basePath, httpMethod, path)
+        const operationId = calculateOperationId(basePath, httpMethod, path)
         return operations.includes(operationId)
       })
 
@@ -299,7 +301,7 @@ export function resolveComponentsPathItemOperationSpec(
           return pathItemObject
         }, {}),
       }
-      setValueByPath(sourceDocument, jsonPath, pathItemObject)
+      setValueByPath(resultSpec, jsonPath, pathItemObject)
     }
   }
 }
@@ -322,10 +324,6 @@ const isOperationPaths = (paths: JsonPath[]): boolean => {
   )
 }
 
-function hasInlineRefsFlag(obj: unknown): obj is { [INLINE_REFS_FLAG]: string[] } {
-  return typeof obj === 'object' && obj !== null && INLINE_REFS_FLAG in obj
-}
-
 // todo output of this method disrupts document normalization.
 //  origin symbols are not being transferred to the resulting spec.
 //  DO NOT pass output of this method to apiDiff
@@ -340,19 +338,18 @@ const createSingleOperationSpec = (
 ): TYPE.RestOperationData => {
   const pathData = document.paths[path] as OpenAPIV3.PathItemObject
 
-  const isContainsRef = !!pathData.$ref
-  const refFlag = hasInlineRefsFlag(pathData) ? pathData[INLINE_REFS_FLAG] : false
+  const isRefPathData = !!pathData.$ref
   return {
     openapi: openapi ?? '3.0.0',
     ...takeIfDefined({ servers }),
     ...takeIfDefined({ security }), // TODO: remove duplicates in security
     paths: {
-      [path]: isContainsRef
+      [path]: isRefPathData
         ? pathData
         : {
           ...extractCommonPathItemProperties(pathData),
           [method]: { ...pathData[method] },
-          ...(refFlag ? { [INLINE_REFS_FLAG]: refFlag } : {}),
+          ...copySymbolIfDefined(pathData, INLINE_REFS_FLAG),
         },
     },
     components: {
@@ -374,7 +371,7 @@ function isValidHttpMethod(method: string): method is OpenAPIV3.HttpMethods {
   return (Object.values(OpenAPIV3.HttpMethods) as string[]).includes(method)
 }
 
-export function getOperationId(
+export function calculateOperationId(
   basePath: string,
   key: string,
   path: string,

src/apitypes/rest/rest.operations.ts

@@ -16,7 +16,7 @@
 
 import { OpenAPIV3 } from 'openapi-types'
 
-import { buildRestOperation, getOperationId } from './rest.operation'
+import { buildRestOperation, calculateOperationId } from './rest.operation'
 import { OperationIdNormalizer, OperationsBuilder } from '../../types'
 import {
   createBundlingErrorHandler,
@@ -77,7 +77,7 @@ export const buildRestOperations: OperationsBuilder<OpenAPIV3.Document> = async
         const methodData = pathData[key as OpenAPIV3.HttpMethods]
         const basePath = getOperationBasePath(methodData?.servers || pathData?.servers || servers || [])
 
-        const operationId = getOperationId(basePath, key, path)
+        const operationId = calculateOperationId(basePath, key, path)
 
         if (ctx.operationResolver(operationId)) {
           ctx.notifications.push({

src/strategies/document-group.strategy.ts

@@ -38,7 +38,7 @@ import { getOperationBasePath } from '../apitypes/rest/rest.utils'
 import { VersionRestDocument } from '../apitypes/rest/rest.types'
 import { FILE_FORMAT_JSON, INLINE_REFS_FLAG, NORMALIZE_OPTIONS } from '../consts'
 import { normalize } from '@netcracker/qubership-apihub-api-unifier'
-import { calculateSpecRefs, extractCommonPathItemProperties } from '../apitypes/rest/rest.operation'
+import { calculateSpecRefs, extractCommonPathItemProperties, calculateOperationId } from '../apitypes/rest/rest.operation'
 
 function getTransformedDocument(document: ResolvedGroupDocument, format: FileFormat, packages: ResolvedReferenceMap): VersionRestDocument {
   const versionDocument = toVersionDocument(document, format)
@@ -141,17 +141,16 @@ function transformDocumentData(versionDocument: VersionDocument): OpenAPIV3.Docu
         [],
       )
 
-      const operationPath = basePath + path
-      const operationId = slugify(`${removeFirstSlash(operationPath)}-${method}`)
+      const operationId = calculateOperationId(basePath, method, path)
 
       if (!versionDocument.operationIds.includes(operationId)) {
         continue
       }
 
       if (versionDocument.operationIds.includes(operationId)) {
         const pathData = sourceDocument.paths[path]!
-        const isContainsRef = !!pathData.$ref
-        resultDocument.paths[path] = isContainsRef
+        const isRefPathData = !!pathData.$ref
+        resultDocument.paths[path] = isRefPathData
             ? pathData
             : {
               ...resultDocument.paths[path],

src/utils/builder.ts

@@ -29,8 +29,6 @@ import {
 import { API_KIND } from '../consts'
 import { Diff, DiffType } from '@netcracker/qubership-apihub-api-diff'
 import { JsonPath } from '@netcracker/qubership-apihub-json-crawl'
-import { parseRef } from '@netcracker/qubership-apihub-api-unifier'
-import { OpenAPIV3 } from 'openapi-types'
 
 export type ObjPath = (string | number)[]
 

src/utils/objects.ts

@@ -65,3 +65,20 @@ export const isSymbol = (value: unknown): value is symbol => {
 export const isObject = (value: unknown): value is Record<string | symbol, unknown> => {
   return typeof value === 'object' && value !== null
 }
+
+export const getSymbolValueIfDefined = <T extends object>(
+  obj: T,
+  symbol: symbol,
+): unknown => {
+  const symbolObj = obj as { [key: symbol]: unknown }
+
+  return symbol in symbolObj ? symbolObj[symbol] : undefined
+}
+
+export const copySymbolIfDefined = <T extends object>(
+  obj: T,
+  symbol: symbol,
+): { [key: symbol]: unknown } => {
+  const value = getSymbolValueIfDefined(obj, symbol)
+  return value !== undefined ? { [symbol]: value } : {}
+}