refactor: move extractOperationBasePath and corresponding tests from api-processor to avoid code duplication

Author: b41ex

src/index.ts

@@ -34,6 +34,9 @@ export {
   isDiffReplace,
 } from './utils'
 
-export { onlyExistedArrayIndexes } from './utils'
+export {
+  aggregateDiffsWithRollup,
+  extractOperationBasePath,
+  onlyExistedArrayIndexes
+} from './utils'
 
-export { aggregateDiffsWithRollup } from './utils'

src/openapi/openapi3.mapping.ts

@@ -1,6 +1,7 @@
 import { MapKeysResult, MappingResolver, NodeContext } from '../types'
 import {
   difference,
+  extractOperationBasePath,
   getStringValue,
   intersection,
   objectKeys,
@@ -194,26 +195,6 @@ function isWildcardCompatible(beforeType: string, afterType: string): boolean {
   return true
 }
 
-// todo copy-paste from api-processor
-export const extractOperationBasePath = (servers?: OpenAPIV3.ServerObject[]): string => {
-  if (!Array.isArray(servers) || !servers.length) { return '' }
-
-  try {
-    const [firstServer] = servers
-    let serverUrl = firstServer.url
-    const { variables = {} } = firstServer
-
-    for (const param of Object.keys(variables)) {
-      serverUrl = serverUrl.replace(new RegExp(`{${param}}`, 'g'), variables[param].default)
-    }
-
-    const { pathname } = new URL(serverUrl, 'https://localhost')
-    return pathname.slice(-1) === '/' ? pathname.slice(0, -1) : pathname
-  } catch (error) {
-    return ''
-  }
-}
-
 export function createPathUnifier(rootServers?: OpenAPIV3.ServerObject[]): (path: string, pathServers?: OpenAPIV3.ServerObject[]) => string {
   return (path, pathServers) => {
     // Prioritize path-level servers over root-level servers

src/utils.ts

@@ -23,6 +23,7 @@ import {
   JSON_SCHEMA_NODE_TYPE_STRING,
   JsonSchemaNodesNormalizedType,
 } from '@netcracker/qubership-apihub-api-unifier'
+import { OpenAPIV3 } from 'openapi-types'
 
 export const isObject = (value: unknown): value is Record<string | symbol, unknown> => {
   return typeof value === 'object' && value !== null
@@ -309,3 +310,29 @@ export function aggregateDiffsWithRollup(obj: any, diffProperty: any, aggregated
   return _aggregateDiffsWithRollup(obj)
 }
 
+/**
+ * Extracts the base path (path after the domain) from the first server URL in an array of OpenAPI ServerObjects.
+ * It replaces any URL variable placeholders (e.g. {host}) with their default values from the 'variables' property.
+ * The function will return the normalized pathname (without trailing slash) or an empty string on error or if the input is empty.
+ *
+ * @param {OpenAPIV3.ServerObject[]} [servers] - An array of OpenAPI ServerObject definitions.
+ * @returns {string} The base path (pathname) part of the URL, without a trailing slash, or an empty string if unavailable.
+ */
+export const extractOperationBasePath = (servers?: OpenAPIV3.ServerObject[]): string => {
+  if (!Array.isArray(servers) || !servers.length) { return '' }
+
+  try {
+    const [firstServer] = servers
+    let serverUrl = firstServer.url
+    const { variables = {} } = firstServer
+
+    for (const param of Object.keys(variables)) {
+      serverUrl = serverUrl.replace(new RegExp(`{${param}}`, 'g'), variables[param].default)
+    }
+
+    const { pathname } = new URL(serverUrl, 'https://localhost')
+    return pathname.slice(-1) === '/' ? pathname.slice(0, -1) : pathname
+  } catch (error) {
+    return ''
+  }
+}

test/utils.test.ts

@@ -0,0 +1,54 @@
+/**
+ * Copyright 2024-2025 NetCracker Technology Corporation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { extractOperationBasePath } from '../src/utils'
+
+describe('Unit test for extractOperationBasePath', () => {
+  test('Should handle Servers with parameters correctly', () => {
+    const servers = [{
+      url: '{protocol}://{host}/api',
+      description: 'Remote server',
+      variables: {
+        protocol: {
+          description: 'Request protocol.',
+          enum: ['http', 'https'],
+          default: 'https',
+        },
+        host: {
+          description: 'Name of the server, for remote development.',
+          enum: ['billing-ui-api.com'],
+          default: 'billing-ui-api.com',
+        },
+      },
+    }]
+
+    expect(extractOperationBasePath(servers)).toEqual('/api')
+  })
+
+  test('Should handle Servers with absolute url correctly', () => {
+    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(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('')
+  })
+})
+