Merge branch 'release'

Author: JayLim2

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@netcracker/qubership-apihub-api-processor",
-  "version": "3.1.0",
+  "version": "4.0.0",
   "description": "",
   "license": "Apache-2.0",
   "module": "dist/esm/src/index.js",
@@ -28,14 +28,11 @@
     "operation:test": "node ./test/operation.js",
     "profile": "node --inspect-brk ./test/profile.js",
     "test:coverage": "jest --verbose --coverage",
-    "feature-start": "feature-start --featureName",
-    "feature-finish": "feature-finish",
-    "release-start": "release-start",
-    "release-finish": "release-finish"
+    "update-lock-file": "update-lock-file @netcracker"
   },
   "dependencies": {
-    "@netcracker/qubership-apihub-api-diff": "1.1.0",
-    "@netcracker/qubership-apihub-api-unifier": "1.0.4",
+    "@netcracker/qubership-apihub-api-diff": "2.0.0",
+    "@netcracker/qubership-apihub-api-unifier": "2.0.0",
     "@netcracker/qubership-apihub-json-crawl": "1.0.4",
     "@netcracker/qubership-apihub-graphapi": "1.0.8",
     "adm-zip": "0.5.10",
@@ -52,7 +49,7 @@
     "swagger2openapi": "^7.0.8"
   },
   "devDependencies": {
-    "@netcracker/qubership-apihub-npm-gitflow": "2.2.2",
+    "@netcracker/qubership-apihub-npm-gitflow": "3.0.1",
     "@types/adm-zip": "0.5.7",
     "@types/jest": "^29.5.12",
     "@types/js-yaml": "^4.0.5",

package.json

@@ -19,7 +19,7 @@ import { OpenAPIV3 } from 'openapi-types'
 import { buildRestDocument, dumpRestDocument } from './rest.document'
 import { REST_API_TYPE, REST_DOCUMENT_TYPE } from './rest.consts'
 import { compareRestOperationsData } from './rest.changes'
-import { buildRestOperations } from './rest.operations'
+import { buildRestOperations, createNormalizedOperationId } from './rest.operations'
 import { parseRestFile } from './rest.parser'
 
 import { ApiBuilder } from '../../types'
@@ -34,4 +34,5 @@ export const restApiBuilder: ApiBuilder<OpenAPIV3.Document> = {
   buildOperations: buildRestOperations,
   dumpDocument: dumpRestDocument,
   compareOperationsData: compareRestOperationsData,
+  createNormalizedOperationId: createNormalizedOperationId,
 }

src/apitypes/rest/index.ts

@@ -16,9 +16,20 @@
 
 import { RestOperationData, VersionRestOperation } from './rest.types'
 import { areDeprecatedOriginsNotEmpty, isOperationRemove, removeComponents } from '../../utils'
-import { apiDiff, breaking, COMPARE_MODE_OPERATION, Diff, DiffAction, semiBreaking } from '@netcracker/qubership-apihub-api-diff'
+import {
+  apiDiff,
+  breaking,
+  COMPARE_MODE_OPERATION,
+  Diff,
+  DiffAction,
+  risky,
+} from '@netcracker/qubership-apihub-api-diff'
 import { MESSAGE_SEVERITY, NORMALIZE_OPTIONS, ORIGINS_SYMBOL } from '../../consts'
-import { BREAKING_CHANGE_TYPE, CompareOperationsPairContext, SEMI_BREAKING_CHANGE_TYPE } from '../../types'
+import {
+  BREAKING_CHANGE_TYPE,
+  CompareOperationsPairContext,
+  RISKY_CHANGE_TYPE,
+} from '../../types'
 import { isObject } from '@netcracker/qubership-apihub-json-crawl'
 import { areDeclarationPathsEqual } from '../../utils/path'
 import { JSON_SCHEMA_PROPERTY_DEPRECATED, pathItemToFullPath, resolveOrigins } from '@netcracker/qubership-apihub-api-unifier'
@@ -48,7 +59,7 @@ export const compareRestOperationsData = async (current: VersionRestOperation |
       normalizedResult: true,
       beforeSource: previous?.data,
       afterSource: current?.data,
-    }
+    },
   )
   const olnyBreaking = diffResult.diffs.filter((diff) => diff.type === breaking)
   if (olnyBreaking.length > 0 && previous?.operationId) {
@@ -61,7 +72,7 @@ async function reclassifyBreakingChanges(
   operationId: string,
   mergedJso: unknown,
   diffs: Diff[],
-  ctx: CompareOperationsPairContext
+  ctx: CompareOperationsPairContext,
 ): Promise<void> {
   if (!ctx.previousVersion || !ctx.previousPackageId) {
     return
@@ -71,6 +82,7 @@ async function reclassifyBreakingChanges(
     return
   }
   previosVersionDeprecations.operations[0]
+
   const previousOperation = previosVersionDeprecations.operations[0]
 
   if (!previousOperation?.deprecatedItems) { return }
@@ -82,7 +94,7 @@ async function reclassifyBreakingChanges(
 
     const deprecatedInVersionsCount = previousOperation?.deprecatedInPreviousVersions?.length ?? 0
     if (isOperationRemove(diff) && deprecatedInVersionsCount > 1) {
-      diff.type = semiBreaking
+      diff.type = risky
       continue
     }
 
@@ -93,7 +105,7 @@ async function reclassifyBreakingChanges(
     if (!isObject(diff.beforeNormalizedValue)) {
       ctx.notifications.push({
         severity: MESSAGE_SEVERITY.Error,
-        message: '[Semi-breaking validation] Something wrong with beforeNormalizedValue from diff',
+        message: '[Risky validation] Something wrong with beforeNormalizedValue from diff',
       })
       continue
     }
@@ -102,7 +114,7 @@ async function reclassifyBreakingChanges(
     if (!areDeprecatedOriginsNotEmpty(diff.beforeNormalizedValue)) {
       ctx.notifications.push({
         severity: MESSAGE_SEVERITY.Error,
-        message: '[Semi-breaking validation] Something wrong with origins',
+        message: '[Risky validation] Something wrong with origins',
       })
       continue
     }
@@ -125,16 +137,16 @@ async function reclassifyBreakingChanges(
     }
 
     if (deprecatedItem && deprecatedItem?.deprecatedInPreviousVersions?.length > 1) {
-      diff.type = semiBreaking
+      diff.type = risky
     }
   }
-  // mark removed required status of the property as semi-breaking
+  // mark removed required status of the property as risky
   if (diffs.length) {
     const requiredProperties = findRequiredRemovedProperties(mergedJso, diffs)
 
     requiredProperties?.forEach(prop => {
-      if (prop.propDiff.type === SEMI_BREAKING_CHANGE_TYPE && prop.requiredDiff?.type === BREAKING_CHANGE_TYPE) {
-        prop.requiredDiff.type = semiBreaking
+      if (prop.propDiff.type === RISKY_CHANGE_TYPE && prop.requiredDiff?.type === BREAKING_CHANGE_TYPE) {
+        prop.requiredDiff.type = risky
       }
     })
   }

src/apitypes/rest/rest.changes.ts

@@ -17,14 +17,20 @@
 import { OpenAPIV3 } from 'openapi-types'
 
 import { buildRestOperation } from './rest.operation'
-import { OperationsBuilder } from '../../types'
-import { createBundlingErrorHandler, removeComponents, removeFirstSlash, slugify } from '../../utils'
+import { OperationIdNormalizer, OperationsBuilder } from '../../types'
+import {
+  createBundlingErrorHandler,
+  IGNORE_PATH_PARAM_UNIFIED_PLACEHOLDER,
+  removeComponents,
+  removeFirstSlash,
+  slugify,
+} 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'
 import { asyncFunction } from '../../utils/async'
 import { logLongBuild, syncDebugPerformance } from '../../utils/logs'
-import { normalize } from '@netcracker/qubership-apihub-api-unifier'
+import { normalize, RefErrorType } from '@netcracker/qubership-apihub-api-unifier'
 
 export const buildRestOperations: OperationsBuilder<OpenAPIV3.Document> = async (document, ctx, debugCtx) => {
   const documentWithoutComponents = removeComponents(document.data)
@@ -38,8 +44,8 @@ export const buildRestOperations: OperationsBuilder<OpenAPIV3.Document> = async
         originsFlag: ORIGINS_SYMBOL,
         hashFlag: HASH_FLAG,
         source: document.data,
-        onRefResolveError: (_: string, __: PropertyKey[], ref: string) =>
-          bundlingErrorHandler([`The $ref "${ref}" references an invalid location in the document.`]),
+        onRefResolveError: (message: string, _path: PropertyKey[], _ref: string, errorType: RefErrorType) =>
+          bundlingErrorHandler([{ message, errorType }]),
       },
     ) as OpenAPIV3.Document
     const refsOnlyDocument = normalize(
@@ -106,3 +112,8 @@ 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/apitypes/rest/rest.operations.ts

@@ -18,13 +18,14 @@ import type { OpenAPIV3 } from 'openapi-types'
 
 import type { ApiOperation, NotificationMessage, VersionDocument } from '../../types'
 import { REST_DOCUMENT_TYPE, REST_KIND_KEY, REST_SCOPES } from './rest.consts'
+import { NormalizedPath } from '../../utils'
 
 export type RestScopeType = keyof typeof REST_SCOPES
 export type RestDocumentType = (typeof REST_DOCUMENT_TYPE)[keyof typeof REST_DOCUMENT_TYPE]
 export type CustomTags = Record<string, unknown>
 
 export interface RestOperationMeta {
-  path: string                            // `/packages/*/version/*`
+  path: NormalizedPath                    // `/packages/*/version/*`
   originalPath: string                    // `/packages/{packageId}/version/{version}`
   method: OpenAPIV3.HttpMethods           // `get` | `post` | ...
   tags?: string[]                         // operations tags

src/apitypes/rest/rest.types.ts

@@ -27,9 +27,8 @@ import {
   ResolvedDeprecatedOperations,
   ResolvedDocuments,
   ResolvedOperations,
-  ResolvedVersionOperationsHashMap,
-  VALIDATION_RULES_SEVERITY_LEVEL_WARNING,
   VersionId,
+  VersionsComparison,
 } from './types'
 import {
   ApiBuilder,
@@ -46,7 +45,6 @@ import {
   OperationChanges,
   VersionCache,
   VersionDocument,
-  VersionsComparisonDto,
 } from './types/internal'
 import type { NotificationMessage, PackageConfig } from './types/package'
 import { graphqlApiBuilder, REST_API_TYPE, restApiBuilder, textApiBuilder, unknownApiBuilder } from './apitypes'
@@ -81,7 +79,7 @@ export class PackageVersionBuilder implements IPackageVersionBuilder {
   apiBuilders: ApiBuilder[] = []
   documents = new Map<string, VersionDocument>()
   operations = new Map<string, ApiOperation>()
-  comparisons: VersionsComparisonDto[] = []
+  comparisons: VersionsComparison[] = []
 
   versionsCache = new Map<string, VersionCache>()
   referencesCache = new Map<string, BuildConfigRef[]>()
@@ -288,7 +286,10 @@ export class PackageVersionBuilder implements IPackageVersionBuilder {
     packageId = packageId ?? this.config.packageId
 
     if (this.canBeResolvedLocally(version, packageId)) {
-      const currentOperations = operationIds ? this.operationList.filter(({ operationId }) => operationIds.includes(operationId)) : this.operationList
+      const currentApiTypeOperations = this.operationList.filter((operation) => operation.apiType === apiType)
+      const currentOperations = operationIds
+        ? currentApiTypeOperations.filter(({ operationId }) => operationIds.includes(operationId))
+        : currentApiTypeOperations
       return { operations: currentOperations }
     }
 
@@ -417,6 +418,8 @@ export class PackageVersionBuilder implements IPackageVersionBuilder {
       throw new Error('No versionResolver provided')
     }
 
+    // includeOperations=true is only used to extract unique apiTypes (see getUniqueApiTypesFromVersions)
+    // the operations map itself is no longer used in processor
     const versionContent = await versionResolver(packageId, version, true)
 
     if (!versionContent) {
@@ -473,7 +476,10 @@ export class PackageVersionBuilder implements IPackageVersionBuilder {
       return []
     }
 
-    const referencesCache: BuildConfigRef[] = Object.values(versionReferences.packages ?? {}).filter(pack => !pack.deletedAt).map(pack => ({ refId: pack.refId, version: pack.version }))
+    const referencesCache: BuildConfigRef[] = Object.values(versionReferences.packages ?? {}).filter(pack => !pack.deletedAt).map(pack => ({
+      refId: pack.refId,
+      version: pack.version,
+    }))
     this.referencesCache.set(compositeKey, referencesCache)
 
     return referencesCache
@@ -492,10 +498,9 @@ export class PackageVersionBuilder implements IPackageVersionBuilder {
     const operationsTypes: OperationTypes[] = []
 
     for (const apiType of this.existingOperationsApiTypes) {
-      const operationsHashMap = this.operationsHashMapByApiType(apiType)
       operationsTypes.push({
         apiType: apiType,
-        operations: operationsHashMap,
+        operationsCount: this.operations.size,
       })
     }
 
@@ -508,18 +513,6 @@ export class PackageVersionBuilder implements IPackageVersionBuilder {
     return new Set(apiTypes)
   }
 
-  private operationsHashMapByApiType(operationsApiType: OperationsApiType): ResolvedVersionOperationsHashMap {
-    const hashMap: ResolvedVersionOperationsHashMap = {}
-
-    for (const { apiType, operationId, dataHash } of this.operations.values()) {
-      if (apiType === operationsApiType) {
-        hashMap[operationId] = dataHash
-      }
-    }
-
-    return hashMap
-  }
-
   async parseFile(fileId: string, source: Blob): Promise<File | null> {
     if (this.parsedFiles.has(fileId)) {
       return this.parsedFiles.get(fileId) ?? null