feat: Review

Author: makeev-pavel

src/apitypes/rest/index.ts

@@ -19,10 +19,10 @@ import { OpenAPIV3 } from 'openapi-types'
 import { buildRestDocument, createRestExportDocument, dumpRestDocument } from './rest.document'
 import { REST_API_TYPE, REST_DOCUMENT_TYPE } from './rest.consts'
 import { compareRestOperationsData } from './rest.changes'
-import { buildRestOperations, createNormalizedOperationId } from './rest.operations'
+import { buildRestOperations } from './rest.operations'
 import { parseRestFile } from './rest.parser'
-
 import { ApiBuilder } from '../../types'
+import { createNormalizedOperationId } from '../../utils'
 
 export * from './rest.consts'
 

src/apitypes/rest/rest.operation.ts

@@ -31,6 +31,7 @@ import {
 } from '../../types'
 import {
   buildSearchScope,
+  calculateOperationId,
   capitalize,
   copySymbolIfDefined,
   getKeyValue,
@@ -41,9 +42,7 @@ import {
   isValidHttpMethod,
   normalizePath,
   rawToApiKind,
-  removeFirstSlash,
   setValueByPath,
-  slugify,
   takeIf,
   takeIfDefined,
 } from '../../utils'
@@ -362,12 +361,3 @@ export const extractCommonPathItemProperties = (
   ...takeIfDefined({ servers: pathData?.servers }),
   ...takeIfDefined({ parameters: pathData?.parameters }),
 })
-
-export const calculateOperationId = (
-  basePath: string,
-  key: string,
-  path: string,
-): string => {
-  const operationPath = basePath + path
-  return slugify(`${removeFirstSlash(operationPath)}-${key}`)
-}

src/apitypes/rest/rest.operations.ts

@@ -16,14 +16,9 @@
 
 import { OpenAPIV3 } from 'openapi-types'
 
-import { buildRestOperation, calculateOperationId } from './rest.operation'
-import { OperationIdNormalizer, OperationsBuilder } from '../../types'
-import {
-  createBundlingErrorHandler,
-  IGNORE_PATH_PARAM_UNIFIED_PLACEHOLDER,
-  removeComponents,
-  slugify,
-} from '../../utils'
+import { buildRestOperation } from './rest.operation'
+import { OperationsBuilder } from '../../types'
+import { calculateOperationId, createBundlingErrorHandler, removeComponents } from '../../utils'
 import { getOperationBasePath } from './rest.utils'
 import type * as TYPE from './rest.types'
 import { HASH_FLAG, INLINE_REFS_FLAG, MESSAGE_SEVERITY, NORMALIZE_OPTIONS, ORIGINS_SYMBOL } from '../../consts'
@@ -110,8 +105,3 @@ export const buildRestOperations: OperationsBuilder<OpenAPIV3.Document> = async
   }
   return operations
 }
-
-export const createNormalizedOperationId: OperationIdNormalizer = (operation) => {
-  const { metadata: { path, method } } = operation
-  return slugify(`${path}-${method}`, [], IGNORE_PATH_PARAM_UNIFIED_PLACEHOLDER)
-}

src/consts.ts

@@ -27,6 +27,7 @@ import {
   VALIDATION_RULES_SEVERITY_LEVEL_WARNING,
   ValidationRulesSeverity,
 } from './types'
+import { OpenAPIV3 } from 'openapi-types'
 
 export const DEFAULT_BATCH_SIZE = 32
 
@@ -169,3 +170,4 @@ export const EMPTY_CHANGE_SUMMARY_DTO = {
 }
 
 export const CUSTOM_PARAMETER_API_AUDIENCE = 'x-api-audience'
+export const HTTP_METHODS_SET = new Set(Object.values(OpenAPIV3.HttpMethods) as string[])

src/strategies/document-group.strategy.ts

@@ -25,17 +25,20 @@ import {
   VersionDocument,
 } from '../types'
 import { REST_API_TYPE } from '../apitypes'
-import { EXPORT_FORMAT_TO_FILE_FORMAT, fromBase64, isValidHttpMethod, takeIfDefined, toVersionDocument } from '../utils'
+import {
+  calculateOperationId,
+  EXPORT_FORMAT_TO_FILE_FORMAT,
+  fromBase64,
+  isValidHttpMethod,
+  takeIfDefined,
+  toVersionDocument,
+} from '../utils'
 import { OpenAPIV3 } from 'openapi-types'
 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 {
-  calculateOperationId,
-  calculateSpecRefs,
-  extractCommonPathItemProperties,
-} from '../apitypes/rest/rest.operation'
+import { calculateSpecRefs, extractCommonPathItemProperties } from '../apitypes/rest/rest.operation'
 
 function getTransformedDocument(document: ResolvedGroupDocument, format: FileFormat, packages: ResolvedReferenceMap): VersionRestDocument {
   const versionDocument = toVersionDocument(document, format)

src/utils/operations.utils.ts

@@ -14,15 +14,16 @@
  * limitations under the License.
  */
 
-import { ApiOperation, BuildResult } from '../types'
+import { ApiOperation, BuildResult, OperationIdNormalizer } from '../types'
 import { GraphApiComponents, GraphApiDirectiveDefinition } from '@netcracker/qubership-apihub-graphapi'
 import { OpenAPIV3 } from 'openapi-types'
 import { isObject } from './objects'
-import { slugify } from './document'
+import { IGNORE_PATH_PARAM_UNIFIED_PLACEHOLDER, slugify } from './document'
 import { removeFirstSlash } from './builder'
 import { Diff, DiffAction } from '@netcracker/qubership-apihub-api-diff'
 import { matchPaths, OPEN_API_PROPERTY_PATHS, PREDICATE_ANY_VALUE } from '@netcracker/qubership-apihub-api-unifier'
 import { DirectiveLocation } from 'graphql/language'
+import { HTTP_METHODS_SET } from '../consts'
 
 export function getOperationsList(buildResult: BuildResult): ApiOperation[] {
   return [...buildResult.operations.values()]
@@ -83,8 +84,20 @@ export function isOperationRemove(operationDiff: Diff): boolean {
   return operationDiff.action === DiffAction.remove && !!matchPaths(operationDiff.beforeDeclarationPaths, [[OPEN_API_PROPERTY_PATHS, PREDICATE_ANY_VALUE]])
 }
 
-const HTTP_METHODS_SET = new Set(Object.values(OpenAPIV3.HttpMethods) as string[])
-
 export const isValidHttpMethod = (method: string): method is OpenAPIV3.HttpMethods => {
   return HTTP_METHODS_SET.has(method)
 }
+
+export const createNormalizedOperationId: OperationIdNormalizer = (operation) => {
+  const { metadata: { path, method } } = operation
+  return slugify(`${path}-${method}`, [], IGNORE_PATH_PARAM_UNIFIED_PLACEHOLDER)
+}
+
+export const calculateOperationId = (
+  basePath: string,
+  key: string,
+  path: string,
+): string => {
+  const operationPath = basePath + path
+  return slugify(`${removeFirstSlash(operationPath)}-${key}`)
+}