Merge pull request #28 from Netcracker/feature/export-build-tasks-support-fixes

fix: export issues

Author: alagishev

package-lock.json

@@ -67,7 +67,6 @@
     "jest-extended": "^4.0.2",
     "mime-types": "^3.0.1",
     "openapi-types": "^12.1.0",
-    "rollup-plugin-copy": "^3.5.0",
     "ts-jest": "29.1.2",
     "ts-node": "^10.9.1",
     "tslint": "^6.1.3",

package.json

@@ -52,11 +52,5 @@ export const buildGraphQLDocument: DocumentBuilder<GraphApiSchema> = async (pars
 }
 
 export const dumpGraphQLDocument: DocumentDumper<GraphApiSchema> = (document) => {
-  if (document.data) {
-    return new Blob([printGraphApi(document.data)], { type: 'text/plain' })
-  }
-  if (document.source) {
-    return document.source
-  }
-  throw new Error(`Document ${document.fileId} has neither data nor source`)
+  return new Blob([printGraphApi(document.data)], { type: 'text/plain' })
 }

src/apitypes/graphql/graphql.document.ts

@@ -16,7 +16,7 @@
 
 import { OpenAPIV3 } from 'openapi-types'
 
-import { buildRestDocument, dumpRestDocument } from './rest.document'
+import { buildRestDocument, createRestExportDocument, dumpRestDocument } from './rest.document'
 import { REST_API_TYPE, REST_DOCUMENT_TYPE } from './rest.consts'
 import { compareRestOperationsData } from './rest.changes'
 import { buildRestOperations, createNormalizedOperationId } from './rest.operations'
@@ -35,4 +35,5 @@ export const restApiBuilder: ApiBuilder<OpenAPIV3.Document> = {
   dumpDocument: dumpRestDocument,
   compareOperationsData: compareRestOperationsData,
   createNormalizedOperationId: createNormalizedOperationId,
+  createExportDocument: createRestExportDocument,
 }

src/apitypes/rest/index.ts

@@ -20,10 +20,24 @@ import { convertObj } from 'swagger2openapi'
 import { REST_DOCUMENT_TYPE, REST_KIND_KEY } from './rest.consts'
 import type { RestDocumentInfo } from './rest.types'
 
-import { DocumentBuilder, DocumentDumper, YAML_EXPORT_GROUP_FORMAT } from '../../types'
-import { FILE_FORMAT } from '../../consts'
-import { createBundlingErrorHandler, getBundledFileDataWithDependencies, getDocumentTitle } from '../../utils'
-import YAML from 'js-yaml'
+import {
+  _TemplateResolver,
+  DocumentBuilder,
+  DocumentDumper,
+  ExportDocument,
+  ExportFormat,
+} from '../../types'
+import { FILE_FORMAT, FILE_FORMAT_HTML, FILE_FORMAT_JSON } from '../../consts'
+import {
+  createBundlingErrorHandler,
+  EXPORT_FORMAT_TO_FILE_FORMAT,
+  getBundledFileDataWithDependencies,
+  getDocumentTitle,
+} from '../../utils'
+import { dump } from './rest.utils'
+import { generateHtmlPage } from '../../utils/export'
+import { removeOasExtensions } from '../../utils/removeOasExtensions'
+import { OpenApiExtensionKey } from '@netcracker/qubership-apihub-api-unifier'
 
 const openApiDocumentMeta = (data: OpenAPIV3.Document): RestDocumentInfo => {
   if (typeof data !== 'object' || !data) {
@@ -99,8 +113,41 @@ export const buildRestDocument: DocumentBuilder<OpenAPIV3.Document> = async (par
 }
 
 export const dumpRestDocument: DocumentDumper<OpenAPIV3.Document> = (document, format) => {
-  if (format === YAML_EXPORT_GROUP_FORMAT) {
-    return new Blob([YAML.dump(document.data)], { type: 'application/yaml' })
+  return new Blob(...dump(document.data, format ?? FILE_FORMAT_JSON))
+}
+
+export async function createRestExportDocument(
+  filename: string,
+  data: string,
+  format: ExportFormat,
+  packageName: string,
+  version: string,
+  templateResolver: _TemplateResolver,
+  allowedOasExtensions?: OpenApiExtensionKey[],
+  generatedHtmlExportDocuments?: ExportDocument[],
+  addBackLink?: boolean,
+): Promise<ExportDocument> {
+  const exportFilename = `${getDocumentTitle(filename)}.${format}`
+  const [[document], blobProperties] = dump(removeOasExtensions(JSON.parse(data), allowedOasExtensions), EXPORT_FORMAT_TO_FILE_FORMAT.get(format)!)
+
+  if (format === FILE_FORMAT_HTML) {
+    const htmlExportDocument = {
+      data: await generateHtmlPage(
+        document,
+        getDocumentTitle(filename),
+        packageName,
+        version,
+        templateResolver,
+        addBackLink,
+      ),
+      filename: exportFilename,
+    }
+    generatedHtmlExportDocuments?.push(htmlExportDocument)
+    return htmlExportDocument
+  }
+
+  return {
+    data: new Blob([document], blobProperties),
+    filename: exportFilename,
   }
-  return new Blob([JSON.stringify(document.data, undefined, 2)], { type: 'application/json' })
 }

src/apitypes/rest/rest.document.ts

@@ -18,7 +18,8 @@ import { OpenAPIV3 } from 'openapi-types'
 import { CustomTags } from './rest.types'
 import { API_AUDIENCE_EXTERNAL, API_AUDIENCE_INTERNAL, API_AUDIENCE_UNKNOWN, ApiAudience } from '../../types'
 import { isObject } from '@netcracker/qubership-apihub-json-crawl'
-import { CUSTOM_PARAMETER_API_AUDIENCE } from '../../consts'
+import { CUSTOM_PARAMETER_API_AUDIENCE, FILE_FORMAT_JSON, FILE_FORMAT_YAML } from '../../consts'
+import YAML from 'js-yaml'
 
 export const getOperationBasePath = (servers?: OpenAPIV3.ServerObject[]): string => {
   if (!Array.isArray(servers) || !servers.length) { return '' }
@@ -65,3 +66,15 @@ export const resolveApiAudience = (info: unknown): ApiAudience => {
   apiAudience = [API_AUDIENCE_INTERNAL, API_AUDIENCE_EXTERNAL].includes(apiAudience) ? apiAudience : API_AUDIENCE_UNKNOWN
   return apiAudience
 }
+
+type TextBlobConstructorParameters = [[string], BlobPropertyBag]
+
+export const dump = (value: unknown, format: typeof FILE_FORMAT_YAML | typeof FILE_FORMAT_JSON): TextBlobConstructorParameters => {
+  if (format === FILE_FORMAT_YAML) {
+    return [[YAML.dump(value)], { type: 'application/yaml' }]
+  }
+  if (format === FILE_FORMAT_JSON) {
+    return [[JSON.stringify(value, undefined, 2)], { type: 'application/json' }]
+  }
+  throw new Error(`Unsupported format: ${format}`)
+}

src/apitypes/rest/rest.utils.ts

@@ -19,6 +19,7 @@ import {
   BuildConfigBase,
   BuildConfigFile,
   BuildConfigRef,
+  ExportDocument,
   FileId,
   isPublishBuildConfig,
   OperationId,
@@ -32,7 +33,6 @@ import {
   ResolvedVersionDocuments,
   VersionId,
   VersionsComparison,
-  ZippableDocument,
 } from './types'
 import {
   ApiBuilder,
@@ -86,7 +86,7 @@ export const DEFAULT_RUN_OPTIONS: BuilderRunOptions = {
 export class PackageVersionBuilder implements IPackageVersionBuilder {
   apiBuilders: ApiBuilder[] = []
   documents = new Map<string, VersionDocument>()
-  exportDocuments: ZippableDocument[] = []
+  exportDocuments: ExportDocument[] = []
   exportFileName?: string
   operations = new Map<string, ApiOperation>()
   comparisons: VersionsComparison[] = []
@@ -816,6 +816,8 @@ export class PackageVersionBuilder implements IPackageVersionBuilder {
     this.packageChangesCache.clear()
     this.operations.clear()
     this.documents.clear()
+    this.exportDocuments = []
+    this.exportFileName = undefined
     this.comparisons = []
 
     this.notifications = []

src/builder.ts

@@ -22,7 +22,7 @@ import {
   BuilderContext,
   BuildResult,
   BuildResultDto,
-  HTML_EXPORT_GROUP_FORMAT,
+  ExportDocument,
   PackageComparison,
   PackageComparisonOperations,
   PackageComparisons,
@@ -36,9 +36,8 @@ import {
 } from '../types'
 import { unknownApiBuilder } from '../apitypes'
 import { BUILD_TYPE, MESSAGE_SEVERITY, PACKAGE } from '../consts'
-import { takeIf, toPackageDocument } from '../utils'
+import { EXPORT_FORMAT_TO_FILE_FORMAT, takeIf, toPackageDocument } from '../utils'
 import { toVersionsComparisonDto } from '../utils/transformToDto'
-import { dumpRestDocument } from '../apitypes/rest/rest.document'
 
 export interface ZipTool {
   // todo method should only accept Blob content, transformation is not a responsibility of this method
@@ -47,25 +46,6 @@ export interface ZipTool {
   buildResult: (options?: JSZip.JSZipGeneratorOptions) => Promise<any>
 }
 
-export const createExportResult = async (
-  buildResult: BuildResult,
-  zip: ZipTool,
-  ctx: BuilderContext,
-  options?: JSZip.JSZipGeneratorOptions,
-): Promise<any> => {
-  const { config: { format } } = ctx
-
-  for (const document of [...buildResult.documents.values()]) {
-    // const apiBuilder = apiBuilders.find(({ types }) => types.includes(document.type)) || unknownApiBuilder
-    // const data = apiBuilder.dumpDocument(document, format)
-    const data = dumpRestDocument(document, format)
-
-    await zip.file(document.filename, data)
-  }
-
-  return await zip.buildResult(options)
-}
-
 export const createVersionPackage = async (
   buildResult: BuildResult,
   zip: ZipTool,
@@ -85,27 +65,14 @@ export const createVersionPackage = async (
 
   const documents = buildResultDto.merged ? [buildResultDto.merged] : [...buildResultDto.documents.values()]
 
-  // todo refactor accordingly to new reqs
   switch (buildResult.config.buildType) {
-    case BUILD_TYPE.EXPORT_REST_DOCUMENT:
-      if (buildResult.exportDocuments.length === 1) {
-        return Buffer.from(await dumpRestDocument(buildResultDto.exportDocuments[0], ctx.config.format).arrayBuffer())
-      }
-      await createExportDocumentDataFiles(zip, buildResultDto.exportDocuments, ctx)
-      return await zip.buildResult(options)
-
     case BUILD_TYPE.EXPORT_VERSION:
-      if (buildResult.exportDocuments.length === 1) {
-        return Buffer.from(await dumpRestDocument(buildResultDto.exportDocuments[0], ctx.config.format).arrayBuffer())
-      }
-      await createExportDocumentDataFiles(zip, buildResultDto.exportDocuments, ctx)
-      return await zip.buildResult(options)
-
+    case BUILD_TYPE.EXPORT_REST_DOCUMENT:
     case BUILD_TYPE.EXPORT_REST_OPERATIONS_GROUP:
       if (buildResult.exportDocuments.length === 1) {
-        return Buffer.from(await dumpRestDocument(buildResultDto.exportDocuments[0], ctx.config.format).arrayBuffer())
+        return Buffer.from(await buildResultDto.exportDocuments[0].data.arrayBuffer())
       }
-      await createExportDocumentDataFiles(zip, buildResultDto.exportDocuments, ctx)
+      await createExportDocumentDataFiles(zip, buildResultDto.exportDocuments)
       return await zip.buildResult(options)
   }
 
@@ -163,7 +130,8 @@ const writeDocumentsToZip = async (zip: ZipTool, documents: ZippableDocument[],
 
     const apiBuilder =
       apiBuilders.find(({ types }) => types.includes(document.type)) || unknownApiBuilder
-    const data = apiBuilder.dumpDocument(document, format)
+    const documentFormat = EXPORT_FORMAT_TO_FILE_FORMAT.get(format!)
+    const data = apiBuilder.dumpDocument(document, documentFormat)
     await zip.file(document.filename, data)
   }
 }
@@ -173,8 +141,10 @@ const createDocumentDataFiles = async (zip: ZipTool, documents: VersionDocument[
   await writeDocumentsToZip(documentsDir, documents, ctx)
 }
 
-const createExportDocumentDataFiles = async (zip: ZipTool, documents: ZippableDocument[], ctx: BuilderContext): Promise<void> => {
-  await writeDocumentsToZip(zip, documents, ctx)
+const createExportDocumentDataFiles = async (zip: ZipTool, documents: ExportDocument[]): Promise<void> => {
+  for (const document of documents) {
+    await zip.file(document.filename, document.data)
+  }
 }
 
 const createOperationsFile = (zip: ZipTool, operations: Map<string, ApiOperation>): void => {