Merge branch 'main' into develop

Author: b41ex

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@netcracker/qubership-apihub-api-processor",
-  "version": "4.2.5",
+  "version": "5.0.0",
   "description": "",
   "license": "Apache-2.0",
   "module": "dist/esm/src/index.js",
@@ -31,10 +31,10 @@
     "update-lock-file": "update-lock-file @netcracker"
   },
   "dependencies": {
-    "@netcracker/qubership-apihub-api-diff": "dev",
-    "@netcracker/qubership-apihub-api-unifier": "dev",
-    "@netcracker/qubership-apihub-graphapi": "dev",
-    "@netcracker/qubership-apihub-json-crawl": "dev",
+    "@netcracker/qubership-apihub-api-diff": "3.0.0",
+    "@netcracker/qubership-apihub-api-unifier": "2.5.0",
+    "@netcracker/qubership-apihub-graphapi": "1.0.9",
+    "@netcracker/qubership-apihub-json-crawl": "1.2.0",
     "adm-zip": "0.5.10",
     "ajv": "^8.12.0",
     "ajv-formats": "^2.1.1",

package.json

@@ -58,7 +58,7 @@ export const compareDocuments: DocumentsCompare = async (
   ctx: CompareOperationsPairContext,
 ): Promise<DocumentsCompareData> => {
   const { apiType, rawDocumentResolver, previousVersion, currentVersion, previousPackageId, currentPackageId } = ctx
-  const comparisonInternalDocumentId = createComparisonInternalDocumentId(prevDoc, currDoc, previousVersion, currentVersion)
+  const comparisonInternalDocumentId = createComparisonInternalDocumentId(previousVersion, previousPackageId, prevDoc?.slug, currentVersion, currentPackageId, currDoc?.slug)
   const prevFile = prevDoc && await rawDocumentResolver(previousVersion, previousPackageId, prevDoc.slug)
   const currFile = currDoc && await rawDocumentResolver(currentVersion, currentPackageId, currDoc.slug)
   const prevDocSchema = prevFile && buildSchema(await prevFile.text(), { noLocation: true })

src/apitypes/graphql/graphql.changes.ts

@@ -103,7 +103,7 @@ export const compareDocuments: DocumentsCompare = async (
     previousVersionLabels,
     currentVersionLabels,
   } = ctx
-  const comparisonInternalDocumentId = createComparisonInternalDocumentId(prevDoc, currDoc, previousVersion, currentVersion)
+  const comparisonInternalDocumentId = createComparisonInternalDocumentId(previousVersion, previousPackageId, prevDoc?.slug, currentVersion, currentPackageId, currDoc?.slug)
   const prevFile = prevDoc && await rawDocumentResolver(previousVersion, previousPackageId, prevDoc.slug)
   const currFile = currDoc && await rawDocumentResolver(currentVersion, currentPackageId, currDoc.slug)
   let prevDocData = prevFile && JSON.parse(await prevFile.text())

src/apitypes/rest/rest.changes.ts

@@ -32,8 +32,7 @@ import {
 import {
   _calculateRestOperationIdV1,
   buildSearchScope,
-  calculateRestOperationId,
-  capitalize,
+  calculateRestOperationId, calculateRestOperationTitle,
   extractSymbolProperty,
   getKeyValue,
   getSplittedVersionKey,
@@ -174,7 +173,7 @@ export const buildRestOperation = (
     apiType: REST_API_TYPE,
     apiKind: operationApiKind,
     deprecated: !!effectiveOperationObject.deprecated,
-    title: effectiveOperationObject.summary || operationId.split('-').map(str => capitalize(str)).join(' '),
+    title: effectiveOperationObject.summary || calculateRestOperationTitle(basePath, method, path),
     metadata: {
       customTags: customTags,
       path: normalizePath(basePath + path),

src/apitypes/rest/rest.operation.ts

@@ -35,7 +35,6 @@ import YAML from 'js-yaml'
 import { Diff, DIFF_META_KEY, DIFFS_AGGREGATED_META_KEY } from '@netcracker/qubership-apihub-api-diff'
 import { isPathParamRenameDiff } from '../../utils'
 
-
 export function getCustomTags(data: object): CustomTags {
   const initialValue: CustomTags = {}
   if (!data || typeof data !== 'object') {

src/apitypes/rest/rest.utils.ts

@@ -19,7 +19,8 @@ import {
   ApiDocument,
   ChangeSummary,
   CompareOperationsPairContext,
-  ComparisonDocument, ComparisonInternalDocument,
+  ComparisonDocument,
+  ComparisonInternalDocument,
   DIFF_TYPES,
   ImpactedOperationSummary,
   NormalizedOperationId,
@@ -39,9 +40,9 @@ import {
   difference,
   intersection,
   removeFirstSlash,
+  serializeDocument,
   SLUG_OPTIONS_OPERATION_ID,
   slugify,
-  serializeDocument,
   takeIfDefined,
 } from '../../utils'
 import { Diff } from '@netcracker/qubership-apihub-api-diff'
@@ -296,7 +297,6 @@ export function createOperationChange(
   }
 }
 
-
 export function createComparisonDocument(comparisonDocumentId: string, apiDocument: ApiDocument): ComparisonDocument {
   return {
     comparisonDocumentId,
@@ -305,19 +305,21 @@ export function createComparisonDocument(comparisonDocumentId: string, apiDocume
 }
 
 type FileParam = string | undefined
-type FileParams = [FileParam, FileParam] | null
+type FileParams = FileParam[] | null
 
 export const createComparisonFileId = (prev: FileParams | null, curr: FileParams): string => {
-  return [...prev || [], ...curr || []].filter(Boolean).join('_')
+  return [...prev || [], ...curr || []].filter(Boolean).join('_').replace(/\//g, '_')
 }
 
 export const createComparisonInternalDocumentId = (
-  prevDoc: ResolvedVersionDocument | undefined,
-  currDoc: ResolvedVersionDocument | undefined,
-  previousVersion: FileParam,
-  currentVersion: FileParam,
+  previousVersion: string,
+  previousPackageId: string,
+  prevSlug: string | undefined,
+  currentVersion: string,
+  currentPackageId: string,
+  currSlug: string | undefined,
 ): string => {
-  return createComparisonFileId([prevDoc?.slug, previousVersion], [currDoc?.slug, currentVersion])
+  return createComparisonFileId([prevSlug, previousVersion, previousPackageId || currentPackageId], [currSlug, currentVersion, currentPackageId])
 }
 
 export const removeGroupPrefixFromOperationId = (operationId: string, groupPrefix: string): string => {

src/components/compare/compare.utils.ts

@@ -18,8 +18,14 @@ import { ApiDocument, ApiOperation, BuildResult, OperationIdNormalizer, VersionD
 import { GraphApiComponents, GraphApiDirectiveDefinition } from '@netcracker/qubership-apihub-graphapi'
 import { OpenAPIV3 } from 'openapi-types'
 import { isObject } from './objects'
-import { serializeDocument } from './document'
-import { SLUG_OPTIONS_DOCUMENT_ID, SLUG_OPTIONS_NORMALIZED_OPERATION_ID, SLUG_OPTIONS_OPERATION_ID, slugify } from './slugify'
+import { capitalize, serializeDocument } from './document'
+import {
+  SLUG_OPTIONS_DOCUMENT_ID,
+  SLUG_OPTIONS_NORMALIZED_OPERATION_ID,
+  SLUG_OPTIONS_OPERATION_ID,
+  SLUG_OPTIONS_TITLE,
+  slugify,
+} from './slugify'
 import { normalizePath, removeFirstSlash } from './builder'
 import { Diff, DiffAction } from '@netcracker/qubership-apihub-api-diff'
 import {
@@ -146,6 +152,27 @@ export const calculateRestOperationId = (
   return _calculateRestOperationIdV2(basePath, path, method)
 }
 
+/**
+ * Calculates a human-readable REST operation title.
+ *
+ * @param basePath - The base path from servers configuration
+ * @param key - Operation key (usually HTTP method)
+ * @param path - The operation path
+ * @returns The formatted operation title (space-separated, title-cased)
+ */
+export const calculateRestOperationTitle = (
+  basePath: string,
+  key: string,
+  path: string,
+): string => {
+  const operationPath = `${basePath}${path}`
+  return slugify(`${removeFirstSlash(operationPath)}-${key}`, SLUG_OPTIONS_TITLE)
+    .split(' ')
+    .filter(Boolean)
+    .map(capitalize)
+    .join(' ')
+}
+
 export const calculateGraphqlOperationId = (
   operationType: string,
   operationName: string,

src/utils/operations.utils.ts

@@ -13,6 +13,24 @@ export const SLUG_OPTIONS_DOCUMENT_ID: Options = {
     },
 }
 
+// Intended for human-readable titles (keeps original casing, uses spaces as separators)
+export const SLUG_OPTIONS_TITLE: Options = {
+    replacement: ' ',
+    lower: false,
+    trim: true,
+    charmap: {
+        ...createSlug.charmap,
+        ...{
+            '/': ' ',
+            '_': ' ',
+            '.': ' ',
+            '(': ' ',
+            ')': ' ',
+            '-': ' ',
+        },
+    },
+}
+
 // additional characters are added for more selectivity
 export const SLUG_OPTIONS_OPERATION_ID: Options = {
     charmap: {

src/utils/slugify.ts

@@ -18,6 +18,7 @@ import { API_AUDIENCE_INTERNAL, APIHUB_API_COMPATIBILITY_KIND_BWC, APIHUB_API_CO
 import { Editor, LocalRegistry } from './helpers'
 
 import { describe, expect, test } from '@jest/globals'
+import { calculateRestOperationTitle } from '../src/utils'
 
 const bugsPackage = LocalRegistry.openPackage('bugs')
 const swaggerPackage = LocalRegistry.openPackage('basic_swagger')
@@ -367,4 +368,26 @@ describe('Operation Bugs', () => {
     expect(data).toHaveProperty(['paths', '/test', 'post', 'responses', '200', 'content', 'application/json', 'schema', 'properties', 'testConnectionDate', 'example'], '2022-03-10T16:15:50Z')
   })
 
+  test('should format rest operationId title without extra characters', async () => {
+    type TestCase = [string, string, string, string]
+
+    const testData: TestCase[] = [
+      ['', 'get', '/path1', 'Path1 Get'],
+      ['', 'get', '/items/{itemId}', 'Items ItemId Get'],
+      ['api/v1', 'get', '/path1', 'Api V1 Path1 Get'],
+      ['api/v1', 'get', '/items/{itemId}', 'Api V1 Items ItemId Get'],
+      ['api/v1/rest', 'get', '/items/{itemId}', 'Api V1 Rest Items ItemId Get'],
+    ]
+    testData.forEach(([basePath, key, path, expectedTitle]) =>{
+      const title = calculateRestOperationTitle(basePath, key, path)
+      expect(title).toEqual(expectedTitle)
+    })
+
+    const editor = await Editor.openProject('bugs', bugsPackage)
+    const result = await editor.run({
+      files: [{ fileId: 'title-rest-operation-id-format.yaml', publish: true }],
+    })
+    const restOperationTitle = result.operations.get('api-v1-items-_item_-get')?.title
+    expect(restOperationTitle).toEqual('Api V1 Items Item Get')
+  })
 })