fix: add validation of api-processor version for previous and current package versions when building changelog

Author: b41ex

src/builder.ts

@@ -14,6 +14,7 @@
  * limitations under the License.
  */
 
+import { version as apiProcessorVersion } from '../package.json'
 import {
   BuildConfig,
   BuildConfigBase,
@@ -650,6 +651,7 @@ export class PackageVersionBuilder implements IPackageVersionBuilder {
       version: this.config.version,
       revision: 0,
       operationTypes: this.operationsTypes,
+      apiProcessorVersion: apiProcessorVersion,
     }
   }
 

src/components/compare/compare.operations.ts

@@ -40,6 +40,7 @@ import {
   removeObjectDuplicates,
 } from '../../utils'
 import { asyncDebugPerformance, DebugPerformanceContext, syncDebugPerformance } from '../../utils/logs'
+import { validateApiProcessorVersion } from '../../validators'
 
 export async function compareVersionsOperations(
   prev: VersionParams,
@@ -52,9 +53,13 @@ export async function compareVersionsOperations(
 
   const { versionResolver } = ctx
 
-  // resolve all version with operation hashes
-  const prevVersionData = prev && (await versionResolver(...prev) ?? { version: prev?.[0], packageId: prev?.[1] })
-  const currVersionData = curr && (await versionResolver(...curr) ?? { version: curr?.[0], packageId: curr?.[1] })
+  // resolve both versions
+  const prevVersionData = prev && await versionResolver(...prev)
+  const currVersionData = curr && await versionResolver(...curr)
+
+  // validate api-processor version compatibility
+  validateApiProcessorVersion(prevVersionData, 'Can\'t build the changelog if previous version was built using an outdated api-processor.')
+  validateApiProcessorVersion(currVersionData, 'Can\'t build the changelog if current version was built using an outdated api-processor.')
 
   // compare operations of each type
   for (const apiType of getUniqueApiTypesFromVersions(prevVersionData, currVersionData)) {

src/types/external/version.ts

@@ -28,6 +28,7 @@ export type ResolvedVersion = {
   previousVersionPackageId?: string
   operationTypes?: OperationTypes[]
   version: string
+  apiProcessorVersion: string
 
   // other params (not used in builder logic)
   [key: string]: unknown

src/validators.ts

@@ -14,9 +14,10 @@
  * limitations under the License.
  */
 
-import { BuildConfig } from './types'
+import { BuildConfig, VersionCache } from './types'
 import { assert } from './utils'
 import { BUILD_TYPE } from './consts'
+import { version as apiProcessorVersion } from '../package.json'
 
 export function validateConfig(config: BuildConfig): void {
   assert(config.packageId, 'builder config: packageId required')
@@ -28,3 +29,15 @@ export function validateConfig(config: BuildConfig): void {
     throw new Error('Incorrect config. Got no files and refs')
   }
 }
+
+export function validateApiProcessorVersion(resolvedVersion: VersionCache | null, errorPrefix?: string): void {
+
+  if (!resolvedVersion?.apiProcessorVersion) {
+    return
+  }
+
+  if (resolvedVersion.apiProcessorVersion !== apiProcessorVersion) {
+    errorPrefix = errorPrefix ? `${errorPrefix} ` : ''
+    throw new Error(`${errorPrefix}Expected api-processor version:  ${apiProcessorVersion}, got ${resolvedVersion.apiProcessorVersion} for package ${resolvedVersion.packageId} version ${resolvedVersion.version}`)
+  }
+}

test/helpers/registry/apihub.ts

@@ -164,7 +164,7 @@ export class ApihubRegistry implements IRegistry {
     const encodedPackageKey = encodeURIComponent(packageId)
     const encodedVersionKey = encodeURIComponent(versionId)
 
-    const { data } = await this.axios.get(`/api/v2/packages/${encodedPackageKey}/versions/${encodedVersionKey}?includeOperations=${includeOperations}`)
+    const { data } = await this.axios.get(`/api/v3/packages/${encodedPackageKey}/versions/${encodedVersionKey}?includeOperations=${includeOperations}`)
     return data
   }
 

test/helpers/registry/local.ts

@@ -86,6 +86,7 @@ import { calculateTotalChangeSummary } from '../../../src/components/compare'
 import { toVersionsComparisonDto } from '../../../src/utils/transformToDto'
 import path from 'path'
 import { ResolvedPackage } from '../../../src/types/external/package'
+import { version as apiProcessorVersion } from '../../../package.json'
 
 const VERSIONS_PATH = 'test/versions'
 const DEFAULT_PROJECTS_PATH = 'test/projects'
@@ -175,6 +176,7 @@ export class LocalRegistry implements IRegistry {
       versionLabels: [],
       revision: 0,
       operationTypes: apiTypes.map(apiType => ({ apiType: apiType, changesSummary: getChangesSummary(apiType) })),
+      apiProcessorVersion: apiProcessorVersion,
     }
   }