chore: merge branch 'develop' into feature/asyncapi-basic-e2e

Author: b41ex

jest.config.ts

@@ -25,5 +25,8 @@ module.exports = {
   //    "^@netcracker/qubership-apihub-graphapi$":'<rootDir>/../qubership-apihub-graphapi/src',
   //    "^@netcracker/qubership-apihub-compatibility-suites$":'<rootDir>/../apihub-compatibility-suites/generation/suite-service',
   // },
-  setupFilesAfterEnv: ['jest-extended/all'],
+  setupFilesAfterEnv: [
+    'jest-extended/all',
+    '<rootDir>/test/setup/jest-wrappers.ts',
+  ],
 }

package-lock.json

@@ -9,9 +9,9 @@
   ],
   "exports": {
     ".": {
+      "types": "./dist/index.d.ts",
       "import": "./dist/index.es.js",
-      "require": "./dist/index.cjs.js",
-      "types": "./dist/index.d.ts"
+      "require": "./dist/index.cjs.js"
     }
   },
   "scripts": {
@@ -22,41 +22,41 @@
     "development:link": "npm link && npm link @netcracker/qubership-apihub-json-crawl && npm link @netcracker/qubership-apihub-graphapi && npm link @netcracker/qubership-apihub-api-unifier && npm link @netcracker/qubership-apihub-compatibility-suites",
     "development:unlink": "npm unlink && npm unlink @netcracker/qubership-apihub-json-crawl && npm unlink @netcracker/qubership-apihub-graphapi && npm unlink @netcracker/qubership-apihub-api-unifier && npm unlink @netcracker/qubership-apihub-compatibility-suites",
     "test": "jest --maxWorkers 3 --verbose",
-    "test:compatibility-suites": "jest --findRelatedTests --detectOpenHandles test/compatibility-suites/*",
-    "test:human-readble": "jest --findRelatedTests --detectOpenHandles test/human-readable/*",
+    "test:compatibility-suites": "jest --detectOpenHandles test/compatibility-suites",
+    "test:human-readable": "jest --detectOpenHandles test/human-readable",
     "update-lock-file": "update-lock-file @netcracker"
   },
   "dependencies": {
     "@netcracker/qubership-apihub-api-unifier": "feature-asyncapi-basic-e2e",
     "@netcracker/qubership-apihub-json-crawl": "dev",
-    "fast-equals": "4.0.3"
+    "fast-equals": "6.0.0"
   },
   "devDependencies": {
     "@netcracker/qubership-apihub-compatibility-suites": "dev",
     "@netcracker/qubership-apihub-graphapi": "dev",
     "@netcracker/qubership-apihub-npm-gitflow": "3.1.0",
-    "@types/jest": "29.5.11",
-    "@types/node": "20.11.6",
-    "@typescript-eslint/eslint-plugin": "6.13.2",
-    "@typescript-eslint/parser": "6.13.2",
-    "eslint": "8.55.0",
-    "eslint-plugin-sort-exports": "0.8.0",
-    "jest": "29.7.0",
-    "jest-extended": "^4.0.2",
+    "@types/jest": "30.0.0",
+    "@types/js-yaml": "4.0.9",
+    "@types/node": "25.0.3",
+    "@typescript-eslint/eslint-plugin": "7.18.0",
+    "@typescript-eslint/parser": "7.18.0",
+    "eslint": "8.57.1",
+    "eslint-plugin-sort-exports": "0.9.1",
+    "fast-json-patch": "3.1.1",
+    "graphql": "16.12.0",
+    "jest": "30.2.0",
+    "jest-extended": "7.0.0",
+    "js-yaml": "4.1.1",
     "openapi-types": "12.1.3",
-    "@types/js-yaml": "^4.0.5",
-    "fast-json-patch": "^3.1.1",
-    "graphql": "16.9.0",
-    "js-yaml": "^4.1.0",
-    "rimraf": "^5.0.5",
-    "ts-loader": "^8.4.0",
-    "ts-node": "^10.9.2",
-    "tslint": "^6.1.3",
-    "ts-jest": "29.1.1",
-    "typescript": "5.3.3",
-    "vite": "5.2.6",
-    "vite-plugin-dts": "3.6.4",
-    "vite-plugin-singlefile": "2.0.1"
+    "rimraf": "6.1.2",
+    "ts-jest": "29.4.6",
+    "ts-loader": "9.5.4",
+    "ts-node": "10.9.2",
+    "tslint": "6.1.3",
+    "typescript": "5.9.3",
+    "vite": "7.3.1",
+    "vite-plugin-dts": "4.5.4",
+    "vite-plugin-singlefile": "2.3.0"
   },
   "eslintConfig": {
     "extends": ".eslintrc.json"

package.json

@@ -16,6 +16,8 @@ import { deepEqual } from 'fast-equals'
 import {
   AdapterContext,
   AdapterResolver,
+  API_COMPATIBILITY_KIND_BACKWARD_COMPATIBLE,
+  ApiCompatibilityKind,
   CompareContext,
   CompareResult,
   CompareRule,
@@ -75,6 +77,7 @@ export const createContext = (data: ContextInput, options: InternalCompareOption
     rules,
     compareScope,
     parentContext,
+    apiCompatibilityScope,
   } = data
   return {
     parentContext: parentContext,
@@ -84,6 +87,7 @@ export const createContext = (data: ContextInput, options: InternalCompareOption
     mergeKey,
     rules,
     options,
+    apiCompatibilityScope: apiCompatibilityScope,
   }
 }
 
@@ -92,6 +96,7 @@ export const createChildContext = (
   mergedKey: PropertyKey,
   beforeChildKey: PropertyKey | undefined,
   afterChildKey: PropertyKey | undefined,
+  apiCompatibilityScope: ApiCompatibilityKind = ctx.apiCompatibilityScope,
 ): CompareContext => {
   const { before, after, rules, options, scope } = ctx
   let beforeContext: NodeContext
@@ -133,6 +138,7 @@ export const createChildContext = (
     ) ?? {},
     options,
     scope: scope,
+    apiCompatibilityScope: apiCompatibilityScope,
   }
 }
 
@@ -156,7 +162,19 @@ const cleanUpRecursive = (ctx: NodeContext): NodeContext => {
 }
 
 export const getOrCreateChildDiffAdd = (diffUniquenessCache: EvaluationCacheService, childCtx: CompareContext) => {
-  const diff = diffUniquenessCache.cacheEvaluationResultByFootprint<[unknown, string, CompareScope, typeof DiffAction.add], DiffAdd>([childCtx.after.value, buildPathsIdentifier(childCtx.after.declarativePaths), childCtx.scope, DiffAction.add], () => {
+  const diff = diffUniquenessCache.cacheEvaluationResultByFootprint<[
+    unknown,
+    string,
+    CompareScope,
+    typeof DiffAction.add,
+    ApiCompatibilityKind
+  ], DiffAdd>([
+    childCtx.after.value,
+    buildPathsIdentifier(childCtx.after.declarativePaths),
+    childCtx.scope,
+    DiffAction.add,
+    childCtx.apiCompatibilityScope,
+  ], () => {
     return diffFactory.added(childCtx)
   }, {} as DiffAdd, (result, guard) => {
     Object.assign(guard, result)
@@ -167,7 +185,19 @@ export const getOrCreateChildDiffAdd = (diffUniquenessCache: EvaluationCacheServ
 }
 
 export const getOrCreateChildDiffRemove = (diffUniquenessCache: EvaluationCacheService, childCtx: CompareContext) => {
-  const diff = diffUniquenessCache.cacheEvaluationResultByFootprint<[unknown, string, CompareScope, typeof DiffAction.remove], DiffRemove>([childCtx.before.value, buildPathsIdentifier(childCtx.before.declarativePaths), childCtx.scope, DiffAction.remove], () => {
+  const diff = diffUniquenessCache.cacheEvaluationResultByFootprint<[
+    unknown,
+    string,
+    CompareScope,
+    typeof DiffAction.remove,
+    ApiCompatibilityKind
+  ], DiffRemove>([
+    childCtx.before.value,
+    buildPathsIdentifier(childCtx.before.declarativePaths),
+    childCtx.scope,
+    DiffAction.remove,
+    childCtx.apiCompatibilityScope,
+  ], () => {
     return diffFactory.removed(childCtx)
   }, {} as DiffRemove, (result, guard) => {
     Object.assign(guard, result)
@@ -201,9 +231,8 @@ const adaptValues = (beforeJso: JsonNode, beforeKey: PropertyKey, afterJso: Json
   })
   return [beforeValueAdapted, afterValueAdapted]
 }
-
 const useMergeFactory = (onDiff: DiffCallback, options: InternalCompareOptions): SyncCrawlHook<MergeState, CompareRule> => {
-  const { metaKey } = options
+  const { metaKey, apiCompatibilityScopeFunction } = options
   const diffs: Set<Diff> = new Set()
   const addDiff: (diff: Diff) => void = (diff) => {
     const oldSize = diffs.size
@@ -218,6 +247,7 @@ const useMergeFactory = (onDiff: DiffCallback, options: InternalCompareOptions):
       compare,
       mapping,
       ignoreKeyDifference,
+      syntheticDiffs: mappingSyntheticDiffsPostProcessor,
       newCompareScope,
     } = rules
     const {
@@ -229,6 +259,7 @@ const useMergeFactory = (onDiff: DiffCallback, options: InternalCompareOptions):
       diffUniquenessCache,
       createdMergedJso,
       compareScope,
+      apiCompatibilityScope: parentApiCompatibilityScope,
     } = state
 
     if (typeof unsafeKey === 'symbol') {
@@ -252,6 +283,8 @@ const useMergeFactory = (onDiff: DiffCallback, options: InternalCompareOptions):
       afterValueAdapted,
     ] = adaptValues(beforeJso, beforeKey, afterJso, afterKey, adapter, options)
 
+    const computedApiCompatibilityScope = apiCompatibilityScopeFunction?.(crawlContext.path, beforeValueAdapted, afterValueAdapted) ?? parentApiCompatibilityScope
+
     const ctx = createContext({
       ...state,
       beforeValue: beforeValueAdapted,
@@ -261,12 +294,27 @@ const useMergeFactory = (onDiff: DiffCallback, options: InternalCompareOptions):
       mergeKey,
       rules,
       compareScope: newCompareScope ?? compareScope,
+      apiCompatibilityScope: computedApiCompatibilityScope,
     }, options)
 
     const beforeDeclarativePathsId = buildPathsIdentifier(cleanUpRecursive(ctx.before).declarativePaths)
     const afterDeclarativePathsId = buildPathsIdentifier(cleanUpRecursive(ctx.after).declarativePaths)
 
-    const reuseResult: ReusableMergeResult = mergedJsoCache.cacheEvaluationResultByFootprint<[typeof ctx.before.value, typeof ctx.after.value, typeof beforeDeclarativePathsId, typeof afterDeclarativePathsId, CompareScope], ReusableMergeResult>([ctx.before.value, ctx.after.value, beforeDeclarativePathsId, afterDeclarativePathsId, ctx.scope], ([beforeValue, afterValue]) => {
+    const reuseResult: ReusableMergeResult = mergedJsoCache.cacheEvaluationResultByFootprint<[
+      typeof ctx.before.value,
+      typeof ctx.after.value,
+      typeof beforeDeclarativePathsId,
+      typeof afterDeclarativePathsId,
+      CompareScope,
+      ApiCompatibilityKind
+    ], ReusableMergeResult>([
+      ctx.before.value,
+      ctx.after.value,
+      beforeDeclarativePathsId,
+      afterDeclarativePathsId,
+      ctx.scope,
+      computedApiCompatibilityScope,
+    ], ([beforeValue, afterValue]) => {
       if (!ignoreKeyDifference && beforeKey !== afterKey) {
         const diffEntry = createDiffEntry(ctx, diffFactory.renamed(ctx))
         addDiff(diffEntry.diff)
@@ -291,11 +339,17 @@ const useMergeFactory = (onDiff: DiffCallback, options: InternalCompareOptions):
       if (isObject(beforeValue) && isObject(afterValue)) {
         const mergedJsoValue: JsonNode = isArray(beforeValue) ? [] as JsonNode<number> : {} as JsonNode<string | symbol>
         const mapKeys = mapping ?? (isArray(beforeValue) ? arrayMappingResolver : objectMappingResolver)
+        const mappingData = mapKeys(beforeValue as any, afterValue as any, ctx)
+
+        // Adding synthetic diffs if necessary
+        mappingSyntheticDiffsPostProcessor?.(mappingData, beforeValue, afterValue)
+
         const {
           added: addedKeys,
           removed: removedKeys,
           mapped: mappedKeys,
-        } = mapKeys(beforeValue as any, afterValue as any, ctx)
+        } = mappingData
+
         const jsoDiffEntries: DiffEntry<Diff>[] = []
         const keyToRemove = removedKeys
           .filter(key => !isDefaultValue(beforeValue, key, options.defaultsFlag))
@@ -310,13 +364,15 @@ const useMergeFactory = (onDiff: DiffCallback, options: InternalCompareOptions):
           once = true
 
           keyToRemove.forEach((keyToBefore) => {
-            const childCtx = createChildContext(ctx, keyToBefore, keyToBefore, undefined)
+            const removalBwc = apiCompatibilityScopeFunction?.([...crawlContext.path, keyToBefore], beforeValue[keyToBefore]) || computedApiCompatibilityScope
+            const childCtx = createChildContext(ctx, keyToBefore, keyToBefore, undefined, removalBwc)
             jsoDiffEntries.push(getOrCreateChildDiffRemove(diffUniquenessCache, childCtx))
           })
 
           keysToAdd.forEach((keyInAfter) => {
+            const additionBwc = apiCompatibilityScopeFunction?.([...crawlContext.path, keyInAfter], undefined, afterJso[keyInAfter]) || computedApiCompatibilityScope
             const keyInMerge = isArray(mergedJsoValue) ? mergedJsoValue.length : keyInAfter
-            const childCtx = createChildContext(ctx, keyInMerge, undefined, keyInAfter)
+            const childCtx = createChildContext(ctx, keyInMerge, undefined, keyInAfter, additionBwc)
             jsoDiffEntries.push(getOrCreateChildDiffAdd(diffUniquenessCache, childCtx))
             mergedJsoValue[keyInMerge] = afterValue[keyInAfter]
           })
@@ -363,6 +419,7 @@ const useMergeFactory = (onDiff: DiffCallback, options: InternalCompareOptions):
         afterJso: afterValueAdapted as JsonNode/*safe cause it only happens for object*/,
         mergedJso: mergedValue,
         compareScope: newCompareScope ?? compareScope,
+        apiCompatibilityScope: computedApiCompatibilityScope,
       }
       return { value: reuseResult.nextValue, state: childState, exitHook: reuseResult.exitHook }
     } else {
@@ -532,6 +589,8 @@ const compareInternal = (before: unknown, after: unknown, onDiff: DiffCallback,
   const beforeRootJso = root.before
   const afterRootJso = root.after
 
+  const apiCompatibilityScope = options?.apiCompatibilityScopeFunction?.() || API_COMPATIBILITY_KIND_BACKWARD_COMPATIBLE
+
   if (!isObject(beforeRootJso) || !isObject(afterRootJso)) {
     // TODO
     throw new Error('Not ready to compare primitive')
@@ -548,6 +607,7 @@ const compareInternal = (before: unknown, after: unknown, onDiff: DiffCallback,
     diffUniquenessCache: options.diffUniquenessCache,
     createdMergedJso: options.createdMergedJso,
     compareScope: options.compareScope,
+    apiCompatibilityScope: apiCompatibilityScope,
   }
   syncCrawl<MergeState, CompareRule>(before, [hook], { state: rootState, rules: options.rules })
   return root.merged[JSO_ROOT]

src/core/compare.ts

@@ -1,7 +1,20 @@
 import { JsonPath } from '@netcracker/qubership-apihub-json-crawl'
 
-import { CompareContext, Diff, DiffAdd, DiffRemove, DiffReplace, DiffRename, DiffEntry, DiffFactory, DiffMetaRecord, NodeContext } from '../types'
-import { allUnclassified, DiffAction, unclassified } from './constants'
+import {
+  CompareContext,
+  Diff,
+  DiffAdd,
+  DiffEntry,
+  DiffFactory,
+  DiffMetaRecord,
+  DiffRemove,
+  DiffRename,
+  DiffReplace,
+  DiffType,
+  NodeContext,
+  API_COMPATIBILITY_KIND_NOT_BACKWARD_COMPATIBLE,
+} from '../types'
+import { allUnclassified, breaking, DiffAction, risky, unclassified } from './constants'
 import { getKeyValue, isFunc } from '../utils'
 import { calculateDefaultDiffDescription } from './description'
 
@@ -18,7 +31,8 @@ export const createDiff = <D extends Diff>(diff: Omit<D, 'type'>, ctx: CompareCo
     const changeType = classifier[index]
 
     try {
-      mutableDiffCopy.type = isFunc(changeType) ? changeType(ctx) : changeType
+      const type = isFunc(changeType) ? changeType(ctx) : changeType
+      mutableDiffCopy.type = reclassifyBreakingToRisky(type, ctx)
     } catch (error) {
       ctx.options.onCreateDiffError?.(`Unable to find diff type. ${error instanceof Error ? error.message : ''}`, mutableDiffCopy, ctx)
     }
@@ -31,6 +45,10 @@ export const createDiff = <D extends Diff>(diff: Omit<D, 'type'>, ctx: CompareCo
   return mutableDiffCopy
 }
 
+export const reclassifyBreakingToRisky = (type: DiffType, ctx: CompareContext): DiffType => {
+  return type === breaking && ctx.apiCompatibilityScope === API_COMPATIBILITY_KIND_NOT_BACKWARD_COMPATIBLE ? risky : type
+}
+
 export function createDiffEntry(ctx: CompareContext, diff: Diff): DiffEntry<Diff> {
   return ({
     propertyKey: ctx.mergeKey,

src/core/diff.ts

@@ -80,7 +80,6 @@ export const transformClassifyRule = ([add, remove, replace, reverseAdd, reverse
     transformedRule(remove, DiffAction.remove),
     transformedRule(replace, DiffAction.replace),
   ]
-
 }
 
 export const breakingIf = (v: boolean): DiffType => (v ? breaking : nonBreaking)

src/core/rules.ts

@@ -1,4 +1,4 @@
-export { COMPARE_MODE_DEFAULT, COMPARE_MODE_OPERATION } from './types'
+export { COMPARE_MODE_DEFAULT, COMPARE_MODE_OPERATION, API_COMPATIBILITY_KIND_BACKWARD_COMPATIBLE, API_COMPATIBILITY_KIND_NOT_BACKWARD_COMPATIBLE } from './types'
 
 export {
   ClassifierType,
@@ -17,6 +17,8 @@ export { apiDiff } from './api'
 export type {
   CompareResult,
   CompareOptions,
+  ApiCompatibilityScopeFunction,
+  ApiCompatibilityKind,
   DiffType,
   ActionType,
   Diff,

src/index.ts

@@ -9,6 +9,7 @@ export const compareOpenApi = (version: OpenApiSpecVersion) => (before: unknown,
       rules: openApi3Rules({
         mode: options.mode,
         version: version,
+        operationSyntheticDiffs: options.openApiPathItemPerOperationDiffs
       }),
     },
   )