refactor: rename semi-breaking changes to risky in FE code (#4)

Author: iurii-golovinskii

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@netcracker/qubership-apihub-api-processor",
-  "version": "3.1.1-dev.0",
+  "version": "3.1.1",
   "description": "",
   "license": "Apache-2.0",
   "module": "dist/esm/src/index.js",
@@ -34,7 +34,7 @@
     "release-finish": "release-finish"
   },
   "dependencies": {
-    "@netcracker/qubership-apihub-api-diff": "1.1.0",
+    "@netcracker/qubership-apihub-api-diff": "dev",
     "@netcracker/qubership-apihub-api-unifier": "1.0.4",
     "@netcracker/qubership-apihub-json-crawl": "1.0.4",
     "@netcracker/qubership-apihub-graphapi": "1.0.8",
@@ -83,4 +83,4 @@
   "engines": {
     "node": ">=18.0.0"
   }
-}
+}

package.json

@@ -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

@@ -30,6 +30,7 @@ import {
   ResolvedVersionOperationsHashMap,
   VALIDATION_RULES_SEVERITY_LEVEL_WARNING,
   VersionId,
+  VersionsComparison,
 } from './types'
 import {
   ApiBuilder,
@@ -46,7 +47,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 +81,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[]>()
@@ -473,7 +473,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

src/builder.ts

@@ -16,7 +16,7 @@
 
 import { BREAKING_CHANGE_TYPE, OperationChanges } from '../../types'
 import { API_KIND } from '../../consts'
-import { markChangeAsSemiBreaking } from '../../utils/changes'
+import { markChangeAsRisky } from '../../utils/changes'
 
 export function validateBwcBreakingChanges(
   operationChanges: OperationChanges,
@@ -31,6 +31,6 @@ export function validateBwcBreakingChanges(
     if (diff.type !== BREAKING_CHANGE_TYPE) {
       continue
     }
-    markChangeAsSemiBreaking(diff, operationChanges)
+    markChangeAsRisky(diff, operationChanges)
   }
 }

src/components/compare/bwc.validation.ts

@@ -14,19 +14,17 @@
  * limitations under the License.
  */
 
-import { BuildConfigRef, CompareContext, VersionParams, VersionsComparison, VersionsComparisonDto } from '../../types'
+import { BuildConfigRef, CompareContext, VersionParams, VersionsComparison } from '../../types'
 import { compareVersionsOperations } from './compare.operations'
 import { getSplittedVersionKey } from '../../utils'
-import { toVersionsComparisonDto } from '../../utils/transformToDto'
-import { MESSAGE_SEVERITY } from '../../consts'
 import { asyncDebugPerformance, DebugPerformanceContext } from '../../utils/logs'
 
 export async function compareVersions(
   prev: VersionParams,
   curr: VersionParams,
   ctx: CompareContext,
   debugCtx?: DebugPerformanceContext,
-): Promise<VersionsComparisonDto[]> {
+): Promise<VersionsComparison[]> {
   let comparisons: VersionsComparison[] = []
   await asyncDebugPerformance('[CompareVersions]', async (versionsDebugContext) => {
     comparisons = await compareVersionsReferences(prev, curr, ctx)
@@ -37,14 +35,7 @@ export async function compareVersions(
     ))
   }, debugCtx, prev ? [prev[1], prev[0]] : ['empty previous id', 'empty previous version'])
 
-  const logError = (message: string): void => {
-    ctx.notifications.push({
-      severity: MESSAGE_SEVERITY.Error,
-      message: message,
-    })
-  }
-
-  return comparisons.map(comparison => toVersionsComparisonDto(comparison, logError))
+  return comparisons
 }
 
 export async function compareVersionsReferences(

src/components/compare/compare.ts

@@ -17,10 +17,10 @@
 import JSZip from 'jszip'
 import { version } from '../../package.json'
 
-import type {
+import {
   ApiOperation,
   BuilderContext,
-  BuildResult,
+  BuildResultDto,
   PackageComparison,
   PackageComparisonOperations,
   PackageComparisons,
@@ -30,10 +30,12 @@ import type {
   PackageOperation,
   PackageOperations,
   VersionDocument,
+  BuildResult,
 } from '../types'
 import { unknownApiBuilder } from '../apitypes'
-import { PACKAGE } from '../consts'
+import { MESSAGE_SEVERITY, PACKAGE } from '../consts'
 import { takeIf, toPackageDocument } from '../utils'
+import { toVersionsComparisonDto } from '../utils/transformToDto'
 
 export interface ZipTool {
   // todo method should only accept Blob content, transformation is not a responsibility of this method
@@ -48,30 +50,41 @@ export const createVersionPackage = async (
   ctx: BuilderContext,
   options?: JSZip.JSZipGeneratorOptions,
 ): Promise<any> => {
-  await createInfoFile(zip, buildResult.config)
+  const logError = (message: string): void => {
+    ctx.notifications.push({
+      severity: MESSAGE_SEVERITY.Error,
+      message: message,
+    })
+  }
+  const buildResultDto: BuildResultDto = {
+    ...buildResult,
+    comparisons: buildResult.comparisons.map(comparison => toVersionsComparisonDto(comparison, logError)),
+  }
+
+  await createInfoFile(zip, buildResultDto.config)
 
-  const documents = buildResult.merged ? [buildResult.merged] : [...buildResult.documents.values()]
+  const documents = buildResultDto.merged ? [buildResultDto.merged] : [...buildResultDto.documents.values()]
 
   createDocumentsFile(zip, documents)
   await createDocumentDataFiles(zip, documents, ctx)
 
-  createOperationsFile(zip, buildResult.operations)
+  createOperationsFile(zip, buildResultDto.operations)
   const operationsDir = zip.folder(PACKAGE.OPERATIONS_DIR_NAME)!
-  for (const { data, operationId } of buildResult.operations.values()) {
+  for (const { data, operationId } of buildResultDto.operations.values()) {
     createOperationDataFile(operationsDir, operationId, data)
   }
 
-  if (buildResult.comparisons.length) {
-    const comparisons: PackageComparison[] = buildResult.comparisons.map(({ data, ...rest }) => rest)
+  if (buildResultDto.comparisons.length) {
+    const comparisons: PackageComparison[] = buildResultDto.comparisons.map(({ data, ...rest }) => rest)
     createComparisonsFile(zip, { comparisons })
     const comparisonsDir = zip.folder(PACKAGE.COMPARISONS_DIR_NAME)
 
-    for (const comparison of buildResult.comparisons) {
+    for (const comparison of buildResultDto.comparisons) {
       if (!comparison.comparisonFileId || !comparison.data) { continue }
       createComparisonDataFile(comparisonsDir!, comparison.comparisonFileId, { operations: comparison.data })
     }
   }
-  createNotificationsFile(zip, { notifications: buildResult.notifications })
+  createNotificationsFile(zip, { notifications: buildResultDto.notifications })
 
   return await zip.buildResult(options)
 }

src/components/package.ts

@@ -21,7 +21,7 @@ import {
   ChangeSummary,
   DEPRECATED_CHANGE_TYPE,
   NON_BREAKING_CHANGE_TYPE,
-  SEMI_BREAKING_CHANGE_TYPE,
+  RISKY_CHANGE_TYPE, SEMI_BREAKING_CHANGE_TYPE,
   UNCLASSIFIED_CHANGE_TYPE,
   VALIDATION_RULES_SEVERITY_LEVEL_WARNING,
   ValidationRulesSeverity,
@@ -138,6 +138,15 @@ export const NORMALIZE_OPTIONS: NormalizeOptions = {
 }
 
 export const EMPTY_CHANGE_SUMMARY: ChangeSummary = {
+  [BREAKING_CHANGE_TYPE]: 0,
+  [NON_BREAKING_CHANGE_TYPE]: 0,
+  [RISKY_CHANGE_TYPE]: 0,
+  [DEPRECATED_CHANGE_TYPE]: 0,
+  [ANNOTATION_CHANGE_TYPE]: 0,
+  [UNCLASSIFIED_CHANGE_TYPE]: 0,
+}
+
+export const EMPTY_CHANGE_SUMMARY_DTO = {
   [BREAKING_CHANGE_TYPE]: 0,
   [NON_BREAKING_CHANGE_TYPE]: 0,
   [SEMI_BREAKING_CHANGE_TYPE]: 0,

src/consts.ts

@@ -21,3 +21,4 @@ export * from './components'
 export * from './consts'
 export * from './types'
 export { calculateChangeId, calculateDiffId, calculateImpactedSummary, convertToSlug, removeComponents } from './utils'
+export { convertDtoFieldOperationTypes, replacePropertyInChangesSummary } from './utils/transformToDto'