fix: export files should use version without revision

Author: CountRedClaw

src/strategies/export-rest-document.strategy.ts

@@ -25,7 +25,7 @@ import {
   ZippableDocument,
 } from '../types'
 import { REST_DOCUMENT_TYPE } from '../apitypes'
-import { getDocumentTitle } from '../utils'
+import { getDocumentTitle, getSplittedVersionKey } from '../utils'
 import { OpenApiExtensionKey } from '@netcracker/qubership-apihub-api-unifier'
 import { removeOasExtensions } from '../utils/removeOasExtensions'
 import {
@@ -67,12 +67,13 @@ export class ExportRestDocumentStrategy implements BuilderStrategy {
   async execute(config: ExportRestDocumentBuildConfig, buildResult: BuildResult, contexts: BuildTypeContexts): Promise<BuildResult> {
     const { builderContext } = contexts
     const { rawDocumentResolver, templateResolver, packageResolver } = builderContext(config)
-    const { packageId, version, documentId, format, allowedOasExtensions } = config
+    const { packageId, version: versionWithRevision, documentId, format, allowedOasExtensions } = config
+    const [version] = getSplittedVersionKey(versionWithRevision)
 
     const file = await rawDocumentResolver(
-      version,
+      versionWithRevision,
       packageId,
-      documentId, //document.slug,
+      documentId,
     )
     const { name: packageName } = await packageResolver(packageId)
 

src/strategies/export-rest-operations-group.strategy.ts

@@ -30,7 +30,7 @@ import {
 } from '../types'
 import { DocumentGroupStrategy } from './document-group.strategy'
 import { MergedDocumentGroupStrategy } from './merged-document-group.strategy'
-import { EXPORT_FORMAT_TO_FILE_FORMAT, getDocumentTitle } from '../utils'
+import { EXPORT_FORMAT_TO_FILE_FORMAT, getDocumentTitle, getSplittedVersionKey } from '../utils'
 import { OpenApiExtensionKey } from '@netcracker/qubership-apihub-api-unifier'
 import { BUILD_TYPE } from '../consts'
 import { isRestDocument, REST_DOCUMENT_TYPE } from '../apitypes'
@@ -57,7 +57,8 @@ export class ExportRestOperationsGroupStrategy implements BuilderStrategy {
 }
 
 async function exportMergedDocument(config: ExportRestOperationsGroupBuildConfig, buildResult: BuildResult, contexts: BuildTypeContexts): Promise<BuildResult> {
-  const { packageId, version, groupName, format = JSON_EXPORT_GROUP_FORMAT, allowedOasExtensions } = config
+  const { packageId, version: versionWithRevision, groupName, format = JSON_EXPORT_GROUP_FORMAT, allowedOasExtensions } = config
+  const [version] = getSplittedVersionKey(versionWithRevision)
   const { templateResolver, packageResolver } = contexts.builderContext(config)
   const { name: packageName } = await packageResolver(packageId)
 
@@ -96,7 +97,8 @@ async function exportMergedDocument(config: ExportRestOperationsGroupBuildConfig
 }
 
 async function exportReducedDocuments(config: ExportRestOperationsGroupBuildConfig, buildResult: BuildResult, contexts: BuildTypeContexts): Promise<BuildResult> {
-  const { packageId, version, groupName, format = JSON_EXPORT_GROUP_FORMAT, allowedOasExtensions } = config
+  const { packageId, version: versionWithRevision, groupName, format = JSON_EXPORT_GROUP_FORMAT, allowedOasExtensions } = config
+  const [version] = getSplittedVersionKey(versionWithRevision)
   const { templateResolver, packageResolver } = contexts.builderContext(config)
   const { name: packageName } = await packageResolver(packageId)
 

src/strategies/export-version.strategy.ts

@@ -26,7 +26,7 @@ import {
   ResolvedVersionDocument,
   ZippableDocument,
 } from '../types'
-import { getDocumentTitle } from '../utils'
+import { getDocumentTitle, getSplittedVersionKey } from '../utils'
 import {
   createCommonStaticExportDocuments,
   createExportDocument,
@@ -94,17 +94,18 @@ export class ExportVersionStrategy implements BuilderStrategy {
   async execute(config: ExportVersionBuildConfig, buildResult: BuildResult, contexts: BuildTypeContexts): Promise<BuildResult> {
     const { builderContext } = contexts
     const { versionDocumentsResolver, rawDocumentResolver, templateResolver, packageResolver } = builderContext(config)
-    const { packageId, version, format = JSON_EXPORT_GROUP_FORMAT, allowedOasExtensions } = config
+    const { packageId, version: versionWithRevision, format = JSON_EXPORT_GROUP_FORMAT, allowedOasExtensions } = config
+    const [version] = getSplittedVersionKey(versionWithRevision)
     const { name: packageName } = await packageResolver(packageId)
 
     const { documents } = await versionDocumentsResolver(
-      version,
+      versionWithRevision,
       packageId,
     ) ?? { documents: [] }
 
     const generatedHtmlExportDocuments: ZippableDocument[] = []
     const transformedDocuments = await Promise.all(documents.map(async document => {
-      const file = await rawDocumentResolver(version, packageId, document.slug)
+      const file = await rawDocumentResolver(versionWithRevision, packageId, document.slug)
       return await createTransformedDocument(document, file, format, packageName, version, generatedHtmlExportDocuments, templateResolver, allowedOasExtensions)
     }))
 

test/export.test.ts

@@ -38,9 +38,12 @@ const groupToOperationIdsMap2 = {
   ],
 }
 
+const REGULAR_VERSION = 'regular-version@123'
+const SINGLE_DOCUMENT_VERSION = 'single-document-version@24'
+
 const COMMON_GROUP_EXPORT_CONFIG = {
   packageId: 'export',
-  version: 'regular-version',
+  version: REGULAR_VERSION,
   groupName: GROUP_NAME,
 }
 
@@ -61,8 +64,8 @@ const COMMON_MERGED_GROUP_EXPORT_CONFIG: Partial<ExportRestOperationsGroupBuildC
 describe('Export test', () => {
   beforeAll(async () => {
     pkg = LocalRegistry.openPackage('export')
-    await pkg.publish(pkg.packageId, {version: 'regular-version'})
-    await pkg.publish(pkg.packageId, {version: 'single-document-version', files: [{fileId: '1.yaml'}]})
+    await pkg.publish(pkg.packageId, {version: REGULAR_VERSION})
+    await pkg.publish(pkg.packageId, {version: SINGLE_DOCUMENT_VERSION, files: [{fileId: '1.yaml'}]})
 
     editor = await Editor.openProject(pkg.packageId, pkg)
 
@@ -138,7 +141,7 @@ describe('Export test', () => {
 
   test('should export single document version to html', async () => {
     const result = await editor.run({
-      version: 'single-document-version',
+      version: SINGLE_DOCUMENT_VERSION,
       buildType: BUILD_TYPE.EXPORT_VERSION,
       format: 'html',
     })
@@ -148,7 +151,7 @@ describe('Export test', () => {
 
   test('should export single document version to json', async () => {
     const result = await editor.run({
-      version: 'single-document-version',
+      version: SINGLE_DOCUMENT_VERSION,
       buildType: BUILD_TYPE.EXPORT_VERSION,
       format: 'json',
     })
@@ -158,7 +161,7 @@ describe('Export test', () => {
 
   test('should export single document version to yaml', async () => {
     const result = await editor.run({
-      version: 'single-document-version',
+      version: SINGLE_DOCUMENT_VERSION,
       buildType: BUILD_TYPE.EXPORT_VERSION,
       format: 'yaml',
     })