[FE][Part 2] Rename Semi-breaking change

Author: Iurii Golovinskii

package-lock.json

@@ -25,7 +25,11 @@ import {
   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'
@@ -147,7 +151,7 @@ async function reclassifyBreakingChanges(
 
     requiredProperties?.forEach(prop => {
    //   console.log('requiredProperties----->', prop.propDiff)
-      if (prop.propDiff.type === SEMI_BREAKING_CHANGE_TYPE && prop.requiredDiff?.type === BREAKING_CHANGE_TYPE) {
+      if (prop.propDiff.type === RISKY_CHANGE_TYPE && prop.requiredDiff?.type === BREAKING_CHANGE_TYPE) {
         prop.requiredDiff.type = risky
       }
     })

src/apitypes/rest/rest.changes.ts

@@ -17,7 +17,7 @@
 import type {
   BuildConfig,
   BuildConfigFile,
-  BuildConfigRef,
+  BuildConfigRef, DiffTypeDto,
   FileId,
   OperationId,
   OperationsApiType,
@@ -73,7 +73,7 @@ export class PackageVersionBuilder implements IPackageVersionBuilder {
   apiBuilders: ApiBuilder[] = []
   documents = new Map<string, VersionDocument>()
   operations = new Map<string, ApiOperation>()
-  comparisons: VersionsComparisonDto[] = []
+  comparisons: VersionsComparisonDto<DiffTypeDto>[] = []
 
   versionsCache = new Map<string, VersionCache>()
   referencesCache = new Map<string, BuildConfigRef[]>()

src/builder.ts

@@ -14,7 +14,14 @@
  * limitations under the License.
  */
 
-import { BuildConfigRef, CompareContext, VersionParams, VersionsComparison, VersionsComparisonDto } from '../../types'
+import {
+  BuildConfigRef,
+  CompareContext,
+  DiffTypeDto,
+  VersionParams,
+  VersionsComparison,
+  VersionsComparisonDto,
+} from '../../types'
 import { compareVersionsOperations } from './compare.operations'
 import { getSplittedVersionKey } from '../../utils'
 import { toVersionsComparisonDto } from '../../utils/transformToDto'
@@ -26,7 +33,7 @@ export async function compareVersions(
   curr: VersionParams,
   ctx: CompareContext,
   debugCtx?: DebugPerformanceContext,
-): Promise<VersionsComparisonDto[]> {
+): Promise<VersionsComparisonDto<DiffTypeDto>[]> {
   let comparisons: VersionsComparison[] = []
   await asyncDebugPerformance('[CompareVersions]', async (versionsDebugContext) => {
     comparisons = await compareVersionsReferences(prev, curr, ctx)

src/components/compare/compare.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,
 } from './types'
 
@@ -132,6 +132,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

@@ -16,7 +16,15 @@
 
 import { ApiAudience } from '../package'
 import { OperationsApiType, PackageId, VersionId } from './types'
-import { ClassifierType, DiffType, risky } from '@netcracker/qubership-apihub-api-diff'
+import {
+  annotation,
+  breaking,
+  ClassifierType, deprecated,
+  DiffType,
+  nonBreaking,
+  risky,
+  unclassified,
+} from '@netcracker/qubership-apihub-api-diff'
 
 export type VersionComparisonResolver = (
   version: VersionId,
@@ -37,28 +45,39 @@ export interface ResolvedComparisonSummary {
   operationTypes: OperationType[]
 }
 
-export interface OperationType {
+export interface OperationType<T extends string | number | symbol = DiffType> {
   apiType: OperationsApiType
-  changesSummary: ChangeSummary
-  numberOfImpactedOperations: ChangeSummary
+  changesSummary: ChangeSummary<T>
+  numberOfImpactedOperations: ChangeSummary<T>
   apiAudienceTransitions: ApiAudienceTransition[]
   tags?: string[]
 }
 
-export const BREAKING_CHANGE_TYPE = 'breaking'
-export const NON_BREAKING_CHANGE_TYPE = 'non-breaking'
-export const UNCLASSIFIED_CHANGE_TYPE = 'unclassified'
-export const SEMI_BREAKING_CHANGE_TYPE = risky
-export const DEPRECATED_CHANGE_TYPE = 'deprecated'
-export const ANNOTATION_CHANGE_TYPE = 'annotation'
+export const BREAKING_CHANGE_TYPE = breaking
+export const NON_BREAKING_CHANGE_TYPE = nonBreaking
+export const UNCLASSIFIED_CHANGE_TYPE = unclassified
+export const RISKY_CHANGE_TYPE = risky
+export const DEPRECATED_CHANGE_TYPE = deprecated
+export const ANNOTATION_CHANGE_TYPE = annotation
+export const SEMI_BREAKING_CHANGE_TYPE = 'semi-breaking'
 
-export type ChangeSummary = Record<DiffType, number>
+export type ChangeSummary<T extends string | number | symbol = DiffType> = Record<T, number>
 export type ImpactedOperationSummary = Record<DiffType, boolean>
-
 export const DIFF_TYPES: DiffType[] = Object.values(ClassifierType)
 
 export interface ApiAudienceTransition {
   previousAudience: ApiAudience
   currentAudience: ApiAudience
   operationsCount: number
 }
+
+export type ChangeSummaryDto = Record<DiffTypeDto, number>
+export type DiffTypeDto = typeof ClassifierTypeDto[keyof typeof ClassifierTypeDto]
+export const ClassifierTypeDto = {
+  breaking,
+  nonBreaking,
+  SEMI_BREAKING_CHANGE_TYPE,
+  annotation,
+  unclassified,
+  deprecated,
+} as const

src/types/external/comparison.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-import { BuildConfig, BuilderResolvers, FileId, PackageId, ResolvedVersion, VersionId } from '../external'
+import { BuildConfig, BuilderResolvers, DiffTypeDto, FileId, PackageId, ResolvedVersion, VersionId } from '../external'
 import { VersionsComparisonDto } from './compare'
 import { PackageConfig } from '../package/config'
 import { NotificationMessage } from '../package/notifications'
@@ -29,7 +29,7 @@ export type VersionCache = ResolvedVersion & {
 
 export interface BuildResult {
   config: PackageConfig
-  comparisons: VersionsComparisonDto[]
+  comparisons: VersionsComparisonDto<DiffTypeDto>[]
   notifications: NotificationMessage[]
   documents: Map<string, VersionDocument>
   operations: Map<string, ApiOperation>

src/types/internal/builder.ts

@@ -14,11 +14,11 @@
  * limitations under the License.
  */
 
-import { Diff } from '@netcracker/qubership-apihub-api-diff'
+import { Diff, DiffType } from '@netcracker/qubership-apihub-api-diff'
 import {
   ApiKind,
   BuildConfig,
-  ChangeSummary,
+  ChangeSummary, DiffTypeDto,
   ImpactedOperationSummary,
   OperationType,
   PackageId,
@@ -48,27 +48,27 @@ export type OperationChangesMetadata = {
   previousOperationMetadata?: OperationChangesMetadata
 } & Partial<RestChangesMetadata> & Partial<GraphQLChangesMetadata>
 
-export interface OperationChanges {
+export interface OperationChanges<T extends string | number | symbol = DiffType> {
   operationId: string
   apiType: BuilderType
   apiKind?: ApiKind
   previousApiKind?: ApiKind
   dataHash?: string
   previousDataHash?: string
-  changeSummary: ChangeSummary
+  changeSummary: ChangeSummary<T>
   impactedSummary: ImpactedOperationSummary
   // @deprecated. OOM problem
-  diffs?: Diff[] 
+  diffs?: Diff[]
   metadata?: OperationChangesMetadata & {
     [key: string]: unknown
   }
 }
 
-export interface OperationChangesDto extends Omit<OperationChanges, 'diffs' | 'impactedSummary' | 'mergedJso'> {
-  changes?: ChangeMessage[]
+export interface OperationChangesDto extends Omit<OperationChanges<DiffTypeDto>, 'diffs' | 'impactedSummary' | 'mergedJso'> {
+  changes?: ChangeMessage<DiffTypeDto>[]
 }
 
-export interface VersionsComparison {
+export interface VersionsComparison<T extends string | number | symbol = DiffType> {
   comparisonFileId?: string
   packageId: PackageId
   version: VersionId
@@ -77,11 +77,11 @@ export interface VersionsComparison {
   previousVersionPackageId: PackageId
   previousVersionRevision?: number
   fromCache: boolean
-  operationTypes: OperationType[]
+  operationTypes: OperationType<T>[]
   data?: OperationChanges[]
 }
 
-export interface VersionsComparisonDto extends Omit<VersionsComparison, 'data'> {
+export interface VersionsComparisonDto<T extends string | number | symbol = DiffTypeDto> extends Omit<VersionsComparison<T>, 'data'> {
   data?: OperationChangesDto[]
 }
 

src/types/internal/compare.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-import { ChangeSummary, OperationId, OperationType, PackageId, VersionId } from '../external'
+import { ChangeSummary, DiffTypeDto, OperationId, OperationType, PackageId, VersionId } from '../external'
 import { ActionType, DiffAction, DiffType } from '@netcracker/qubership-apihub-api-diff'
 import { JsonPath } from '@netcracker/qubership-apihub-json-crawl'
 
@@ -31,7 +31,7 @@ export interface PackageComparison {
   previousVersionPackageId: PackageId
   previousVersionRevision?: number
   fromCache: boolean
-  operationTypes: OperationType[]
+  operationTypes: OperationType<DiffTypeDto>[]
 }
 
 export interface PackageComparisonOperations {
@@ -42,45 +42,45 @@ export interface PackageComparisonOperation {
   operationId: OperationId
   dataHash?: string
   previousDataHash?: string
-  changeSummary?: ChangeSummary
-  changes?: ChangeMessage[]
+  changeSummary?: ChangeSummary<DiffTypeDto>
+  changes?: ChangeMessage<DiffTypeDto>[]
 }
 
-interface ChangeBase {
-  severity: DiffType
+interface ChangeBase<T> {
+  severity: T
   action: ActionType
   description?: string
   scope: string
 }
 
 type Hash = string
 
-export interface ChangeAdd extends ChangeBase {
+export interface ChangeAdd<T> extends ChangeBase<T> {
   action: typeof DiffAction.add
   currentDeclarationJsonPaths: JsonPath[]
   currentValueHash: Hash
 }
 
-export interface ChangeRemove extends ChangeBase {
+export interface ChangeRemove<T> extends ChangeBase<T> {
   action: typeof DiffAction.remove
   previousDeclarationJsonPaths: JsonPath[]
   previousValueHash: Hash
 }
 
-export interface ChangeReplace extends ChangeBase {
+export interface ChangeReplace<T> extends ChangeBase<T> {
   action: typeof DiffAction.replace
   previousDeclarationJsonPaths: JsonPath[]
   currentDeclarationJsonPaths: JsonPath[]
   currentValueHash: Hash
   previousValueHash: Hash
 }
 
-export interface ChangeRename extends ChangeBase {
+export interface ChangeRename<T> extends ChangeBase<T> {
   action: typeof DiffAction.rename
   previousDeclarationJsonPaths: JsonPath[]
   currentDeclarationJsonPaths: JsonPath[]
   currentKey: unknown
   previousKey: unknown
 }
 
-export type ChangeMessage = ChangeAdd | ChangeRemove | ChangeReplace | ChangeRename
+export type ChangeMessage<T = DiffType> = ChangeAdd<T> | ChangeRemove<T> | ChangeReplace<T> | ChangeRename<T>

src/types/package/comparisons.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-import { ApiAudienceTransition } from './../types/external/comparison'
+import { ApiAudienceTransition, RISKY_CHANGE_TYPE } from './../types/external/comparison'
 import { ApiKind, ChangeSummary, ResolvedOperation } from '../types'
 import {
   ANNOTATION_CHANGE_TYPE,
@@ -108,7 +108,7 @@ export const calculateChangeSummary = (changes: Diff[]): ChangeSummary => ({
   [BREAKING_CHANGE_TYPE]: countByType(BREAKING_CHANGE_TYPE, changes),
   [NON_BREAKING_CHANGE_TYPE]: countByType(NON_BREAKING_CHANGE_TYPE, changes),
   [UNCLASSIFIED_CHANGE_TYPE]: countByType(UNCLASSIFIED_CHANGE_TYPE, changes),
-  [SEMI_BREAKING_CHANGE_TYPE]: countByType(SEMI_BREAKING_CHANGE_TYPE, changes),
+  [RISKY_CHANGE_TYPE]: countByType(RISKY_CHANGE_TYPE, changes),
   [DEPRECATED_CHANGE_TYPE]: countByType(DEPRECATED_CHANGE_TYPE, changes),
   [ANNOTATION_CHANGE_TYPE]: countByType(ANNOTATION_CHANGE_TYPE, changes),
 })
@@ -121,7 +121,7 @@ export const calculateImpactedSummary = (changeSummaries: ChangeSummary[]): Impa
   [BREAKING_CHANGE_TYPE]: checkIfHaveChanges(BREAKING_CHANGE_TYPE, changeSummaries),
   [NON_BREAKING_CHANGE_TYPE]: checkIfHaveChanges(NON_BREAKING_CHANGE_TYPE, changeSummaries),
   [UNCLASSIFIED_CHANGE_TYPE]: checkIfHaveChanges(UNCLASSIFIED_CHANGE_TYPE, changeSummaries),
-  [SEMI_BREAKING_CHANGE_TYPE]: checkIfHaveChanges(SEMI_BREAKING_CHANGE_TYPE, changeSummaries),
+  [RISKY_CHANGE_TYPE]: checkIfHaveChanges(RISKY_CHANGE_TYPE, changeSummaries),
   [DEPRECATED_CHANGE_TYPE]: checkIfHaveChanges(DEPRECATED_CHANGE_TYPE, changeSummaries),
   [ANNOTATION_CHANGE_TYPE]: checkIfHaveChanges(ANNOTATION_CHANGE_TYPE, changeSummaries),
 })