fix: documents renaming test

Author: CountRedClaw

src/strategies/document-group.strategy.ts

@@ -21,15 +21,14 @@ import {
   BuildTypeContexts,
   FileFormat,
   JSON_EXPORT_GROUP_FORMAT,
-  ResolvedDocument, ResolvedReferenceMap,
+  ResolvedDocument,
+  ResolvedReferenceMap,
   VersionDocument,
 } from '../types'
 import { REST_API_TYPE } from '../apitypes'
 import {
   EXPORT_FORMAT_TO_FILE_FORMAT,
   fromBase64,
-  getDocumentTitle,
-  getFileExtension,
   removeFirstSlash,
   slugify,
   takeIfDefined,
@@ -41,7 +40,6 @@ import { VersionRestDocument } from '../apitypes/rest/rest.types'
 import { INLINE_REFS_FLAG, NORMALIZE_OPTIONS } from '../consts'
 import { normalize } from '@netcracker/qubership-apihub-api-unifier'
 import { calculateSpecRefs, extractCommonPathItemProperties } from '../apitypes/rest/rest.operation'
-import { groupBy } from 'graphql/jsutils/groupBy'
 
 async function getTransformedDocument(document: ResolvedDocument, format: FileFormat, packages: ResolvedReferenceMap): Promise<VersionRestDocument> {
   const versionDocument = toVersionDocument(document, format)
@@ -104,36 +102,15 @@ export class DocumentGroupStrategy implements BuilderStrategy {
     }
 
     const transformedDocuments = await Promise.all(transformTasks)
-    const transformedDocumentsWithoutCollisions = (['fileId', 'filename'] as const).reduce(resolveCollisionsByField, transformedDocuments)
 
-    for (const document of transformedDocumentsWithoutCollisions) {
+    for (const document of transformedDocuments) {
       buildResult.documents.set(document.fileId, document)
     }
 
     return buildResult
   }
 }
 
-// there is a chance that the renamed document will be the same as another document (this case has not been fixed yet)
-function resolveCollisionsByField(docs: VersionRestDocument[], field: 'fileId' | 'filename'): VersionRestDocument[] {
-  const fileIdMap = groupBy(docs, (document) => document[field])
-  return ([...fileIdMap.values()] as VersionRestDocument[][]).reduce((acc, docs) => {
-    const [_, ...duplicates] = docs
-    duplicates.forEach((document, index) => {document[field] = renameDuplicate(document[field], index)})
-    return [...acc, ...docs]
-  }, [] as VersionRestDocument[])
-}
-
-function renameDuplicate(fileName: string, index: number): string {
-  const extension = getFileExtension(fileName)
-  const nameWithPostfix = `${getDocumentTitle(fileName)}-${index + 1}`
-
-  if (extension) {
-    return `${nameWithPostfix}.${extension}`
-  }
-  return nameWithPostfix
-}
-
 function parseBase64String(value: string): object {
   return JSON.parse(fromBase64(value))
 }

src/types/external/references.ts

@@ -41,7 +41,7 @@ export interface ReferencedPackage {
   name: string
   version: string
   status: VersionStatus
-  parentPackages: string[]
+  parentPackages?: string[]
   deletedAt?: string
   deletedBy?: string
   notLatestRevision?: string

test/document-group.test.ts

@@ -79,10 +79,10 @@ describe('Document Group test', () => {
 
     expect(Array.from(result.documents.values())).toEqual(
       expect.toIncludeSameMembers([
-        expect.objectContaining({ fileId: '1.yaml', filename: '1.json' }),
-        expect.objectContaining({ fileId: '2.yaml', filename: '2.json' }),
-        expect.objectContaining({ fileId: '1-1.yaml', filename: '1-1.json' }),
-        expect.objectContaining({ fileId: '1-2.yaml', filename: '1-2.json' }),
+        expect.objectContaining({ fileId: 'documents-collision/package1_1.yaml', filename: 'documents-collision/package1_1.json' }),
+        expect.objectContaining({ fileId: 'documents-collision/package1_2.yaml', filename: 'documents-collision/package1_2.json' }),
+        expect.objectContaining({ fileId: 'documents-collision/package2_1.yaml', filename: 'documents-collision/package2_1.json' }),
+        expect.objectContaining({ fileId: 'documents-collision/package3_1.yaml', filename: 'documents-collision/package3_1.json' }),
       ]),
     )
 

test/helpers/registry/apihub.ts

@@ -239,7 +239,7 @@ export class ApihubRegistry implements IRegistry {
   ): Promise<ResolvedDocuments | null> {
     const encodedPackageKey = encodeURIComponent(packageId)
     const encodedVersionKey = encodeURIComponent(version)
-    const response: ResolvedDocuments = { documents: [] }
+    const response: ResolvedDocuments = { documents: [], packages: {} }
 
     const LIMIT = 100
     let page = 0

test/helpers/registry/local.ts

@@ -26,7 +26,9 @@ import {
   EMPTY_CHANGE_SUMMARY,
   FILE_FORMAT,
   GRAPHQL_API_TYPE,
-  graphqlApiBuilder, MESSAGE_SEVERITY,
+  graphqlApiBuilder,
+  KIND_PACKAGE,
+  MESSAGE_SEVERITY,
   NotificationMessage,
   OperationId,
   OperationsApiType,
@@ -67,7 +69,7 @@ import {
   saveNotifications,
   saveOperationsArray,
 } from './utils'
-import { getCompositeKey, getSplittedVersionKey, isNotEmpty, toBase64 } from '../../../src/utils'
+import { getCompositeKey, getSplittedVersionKey, isNotEmpty, takeIfDefined, toBase64 } from '../../../src/utils'
 import { groupBy } from 'graphql/jsutils/groupBy'
 import { IRegistry } from './types'
 import { calculateTotalChangeSummary } from '../../../src/components/compare'
@@ -199,26 +201,37 @@ export class LocalRegistry implements IRegistry {
     const documentsFromVersion = Array.from(documents?.values() ?? [])
 
     if (isNotEmpty(documentsFromVersion)) {
-      return { documents: this.resolveDocuments(documentsFromVersion, this.filterOperationIdsByGroup(filterByOperationGroup)) }
+      return { documents: this.resolveDocuments(documentsFromVersion, this.filterOperationIdsByGroup(filterByOperationGroup)), packages: {} }
     }
 
     const documentsFromRefs = (
       await Promise.all(refs.map(async ({ refId, version }) => {
         const versionCache = await this.getVersion(refId, version)
         if (!versionCache) return []
         const { documents } = versionCache
-        return Array.from(documents.values())
+        return this.resolveDocuments(Array.from(documents.values()), this.filterOperationIdsByGroup(filterByOperationGroup), refId)
       }))
     ).flat()
 
-    return { documents: this.resolveDocuments(documentsFromRefs, this.filterOperationIdsByGroup(filterByOperationGroup)) }
+    const packages = refs.reduce((acc, ref) => {
+      acc[ref.refId] = {
+        refId: ref.refId,
+        version: ref.version,
+        kind: KIND_PACKAGE,
+        name: ref.refId,
+        status: VERSION_STATUS.DRAFT,
+      }
+      return acc
+    }, {} as ResolvedReferenceMap)
+
+    return { documents: documentsFromRefs, packages: packages }
   }
 
   private filterOperationIdsByGroup(filterByOperationGroup: string): (id: string) => boolean {
     return (id: string): boolean => this.groupToOperationIdsMap[filterByOperationGroup]?.includes(id)
   }
 
-  private resolveDocuments(documents: VersionDocument[], filterOperationIdsByGroup: (id: string) => boolean): ResolvedDocument[] {
+  private resolveDocuments(documents: VersionDocument[], filterOperationIdsByGroup: (id: string) => boolean, refId?: string): ResolvedDocument[] {
     return documents
       .filter(versionDocument => versionDocument.operationIds.some(filterOperationIdsByGroup))
       .map(document => ({
@@ -232,6 +245,7 @@ export class LocalRegistry implements IRegistry {
         title: document.title,
         includedOperationIds: document.operationIds.filter(filterOperationIdsByGroup),
         data: toBase64(JSON.stringify(document.data)),
+        ...takeIfDefined({ packageRef: refId }),
       }))
   }
 
@@ -295,7 +309,9 @@ export class LocalRegistry implements IRegistry {
           packages[packageRef] = {
             refId: ref.refId,
             version: ref.version,
-            versionRevision: 0,
+            kind: KIND_PACKAGE,
+            name: ref.refId,
+            status: VERSION_STATUS.DRAFT,
           }
           references.push({
             packageRef: packageRef,