fix: remove prefix from servers case

Author: CountRedClaw

src/apitypes/rest/rest.changes.ts

@@ -60,7 +60,7 @@ import {
   extractPathParamRenameDiff,
   extractRootSecurityDiffs,
   extractRootServersDiffs,
-  getOperationBasePath,
+  extractOperationBasePath,
 } from './rest.utils'
 import { createOperationChange, getOperationTags, OperationsMap } from '../../components'
 
@@ -141,14 +141,15 @@ export const compareDocuments = async (
 
       const methodData = pathData[inferredMethod]
       // todo if there were actually servers here, we wouldn't have handle it, add a test
-      const basePath = getOperationBasePath(methodData?.servers || pathData?.servers || merged.servers || [])
-      const operationPath = basePath + path
-      const operationId = slugify(`${operationPath}-${inferredMethod}`)
-      const normalizedOperationId = slugify(`${normalizePath(operationPath)}-${inferredMethod}`, [], IGNORE_PATH_PARAM_UNIFIED_PLACEHOLDER)
+      const previousBasePath = extractOperationBasePath(methodData?.servers || pathData?.servers || prevDocData.servers || [])
+      const currentBasePath = extractOperationBasePath(methodData?.servers || pathData?.servers || currDocData.servers || [])
+      const prevNormalizedOperationId = slugify(`${normalizePath(previousBasePath + path)}-${inferredMethod}`, [], IGNORE_PATH_PARAM_UNIFIED_PLACEHOLDER)
+      const currNormalizedOperationId = slugify(`${normalizePath(currentBasePath + path)}-${inferredMethod}`, [], IGNORE_PATH_PARAM_UNIFIED_PLACEHOLDER)
 
-      const { current, previous } = operationsMap[normalizedOperationId] ?? operationsMap[operationId] ?? {}
+      const { current, previous } = operationsMap[prevNormalizedOperationId] ?? operationsMap[currNormalizedOperationId] /*?? operationsMap[operationId]*/ ?? {}
       if (!current && !previous) {
-        throw new Error(`Can't find the operation ${operationId} from documents pair ${prevDoc?.fileId} and ${currDoc?.fileId}`)
+        const missingOperations = prevNormalizedOperationId === currNormalizedOperationId ? `the ${prevNormalizedOperationId} operation` : `the ${prevNormalizedOperationId} and ${currNormalizedOperationId} operations`
+        throw new Error(`Can't find ${missingOperations} from documents pair ${prevDoc?.fileId} and ${currDoc?.fileId}`)
       }
       const operationChanged = Boolean(current && previous)
       const operationAddedOrRemoved = !operationChanged

src/apitypes/rest/rest.operations.ts

@@ -76,7 +76,7 @@ export const buildRestOperations: OperationsBuilder<OpenAPIV3.Document> = async
 
       await asyncFunction(() => {
         const methodData = pathData[key as OpenAPIV3.HttpMethods]
-        const basePath = getOperationBasePath(methodData?.servers || pathData?.servers || servers || [])
+        const basePath = extractOperationBasePath(methodData?.servers || pathData?.servers || servers || [])
         const operationPath = basePath + path
 
         const operationId = slugify(`${removeFirstSlash(operationPath)}-${key}`)

src/apitypes/rest/rest.utils.ts

@@ -29,7 +29,7 @@ import YAML from 'js-yaml'
 import { Diff, DIFF_META_KEY } from '@netcracker/qubership-apihub-api-diff'
 import { isPathParamRenameDiff } from '../../utils'
 
-export const getOperationBasePath = (servers?: OpenAPIV3.ServerObject[]): string => {
+export const extractOperationBasePath = (servers?: OpenAPIV3.ServerObject[]): string => {
   if (!Array.isArray(servers) || !servers.length) { return '' }
 
   try {

src/strategies/document-group.strategy.ts

@@ -34,7 +34,7 @@ import {
   toVersionDocument,
 } from '../utils'
 import { OpenAPIV3 } from 'openapi-types'
-import { getOperationBasePath } from '../apitypes/rest/rest.utils'
+import { extractOperationBasePath } 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'
@@ -140,7 +140,7 @@ function transformDocumentData(versionDocument: VersionDocument): OpenAPIV3.Docu
       }
 
       const methodData = pathData[inferredMethod]
-      const basePath = getOperationBasePath(methodData?.servers || pathData?.servers || documentData?.servers || [])
+      const basePath = extractOperationBasePath(methodData?.servers || pathData?.servers || documentData?.servers || [])
       const operationPath = basePath + path
 
       const operationId = slugify(`${removeFirstSlash(operationPath)}-${method}`)

test/changes.test.ts

@@ -106,6 +106,19 @@ describe('Changes test', () => {
       expect(result).toEqual(changesSummaryMatcher({ [ANNOTATION_CHANGE_TYPE]: 2 }))
       expect(result).toEqual(numberOfImpactedOperationsMatcher({ [ANNOTATION_CHANGE_TYPE]: 1 }))
     })
+
+    test('Remove prefix from server', async () => {
+      const result = await buildChangelogPackage('changelog/remove-prefix-from-server')
+
+      expect(result).toEqual(changesSummaryMatcher({
+        [BREAKING_CHANGE_TYPE]: 1,
+        [NON_BREAKING_CHANGE_TYPE]: 1,
+      }))
+      expect(result).toEqual(numberOfImpactedOperationsMatcher({
+        [BREAKING_CHANGE_TYPE]: 1,
+        [NON_BREAKING_CHANGE_TYPE]: 1,
+      }))
+    })
   })
 
   describe('Diffs collecting in the root-level properties', () => {

test/projects/changelog/remove-prefix-from-server/after.yaml

@@ -0,0 +1,14 @@
+openapi: 3.0.3
+info:
+  title: test
+  version: 0.1.0
+servers:
+  - url: https://example2.com
+    description: It is a description of server
+paths:
+  /path1:
+    get:
+      responses:
+        '200':
+          description: OK
+          content: { }

test/projects/changelog/remove-prefix-from-server/before.yaml

@@ -0,0 +1,14 @@
+openapi: 3.0.3
+info:
+  title: test
+  version: 0.1.0
+servers:
+  - url: https://example1.com/api/v2
+    description: It is a description of server
+paths:
+  /path1:
+    get:
+      responses:
+        '200':
+          description: OK
+          content: { }

test/utils.test.ts

@@ -15,7 +15,7 @@
  */
 
 import { findSharedPath, removeObjectDuplicates, removeSecurityDuplicates, slugify } from '../src/utils'
-import { getOperationBasePath } from '../src/apitypes/rest/rest.utils'
+import { extractOperationBasePath } from '../src/apitypes/rest/rest.utils'
 
 describe('Utils', () => {
   describe('Unit tests for \'slugify\' function', () => {
@@ -42,20 +42,20 @@ describe('Utils', () => {
         },
       }]
 
-      expect(getOperationBasePath(servers)).toEqual('/api')
+      expect(extractOperationBasePath(servers)).toEqual('/api')
     })
 
     test('Should handle Servers with absolute url correctly', () => {
-      expect(getOperationBasePath([{ url: 'https://example.com/v1' }])).toEqual('/v1')
-      expect(getOperationBasePath([{ url: 'https://example.com/v1/' }])).toEqual('/v1')
+      expect(extractOperationBasePath([{ url: 'https://example.com/v1' }])).toEqual('/v1')
+      expect(extractOperationBasePath([{ url: 'https://example.com/v1/' }])).toEqual('/v1')
     })
 
     test('Should handle Servers with relative url correctly', () => {
-      expect(getOperationBasePath([{ url: '/v1' }])).toEqual('/v1')
-      expect(getOperationBasePath([{ url: 'v1' }])).toEqual('/v1')
-      expect(getOperationBasePath([{ url: 'v1/' }])).toEqual('/v1')
-      expect(getOperationBasePath([{ url: '/v1/' }])).toEqual('/v1')
-      expect(getOperationBasePath([{ url: '/' }])).toEqual('')
+      expect(extractOperationBasePath([{ url: '/v1' }])).toEqual('/v1')
+      expect(extractOperationBasePath([{ url: 'v1' }])).toEqual('/v1')
+      expect(extractOperationBasePath([{ url: 'v1/' }])).toEqual('/v1')
+      expect(extractOperationBasePath([{ url: '/v1/' }])).toEqual('/v1')
+      expect(extractOperationBasePath([{ url: '/' }])).toEqual('')
     })
   })