feat: Added tests and review

Author: makeev-pavel

src/strategies/document-group.strategy.ts

@@ -29,7 +29,6 @@ import {
   EXPORT_FORMAT_TO_FILE_FORMAT,
   fromBase64,
   removeFirstSlash,
-  setValueByPath,
   slugify,
   takeIfDefined,
   toVersionDocument,
@@ -149,7 +148,7 @@ function transformDocumentData(versionDocument: VersionDocument): OpenAPIV3.Docu
         continue
       }
 
-      const { updatedPathItem, extraComponents } = buildPathAndComponents(
+      const updatedPathItem = buildPath(
         sourceDocument,
         path,
         inferredMethod,
@@ -163,7 +162,6 @@ function transformDocumentData(versionDocument: VersionDocument): OpenAPIV3.Docu
       }
       resultDocument.components = {
         ...takeIfDefined({ securitySchemes: sourceComponents?.securitySchemes }),
-        ...extraComponents,
       }
     }
   }
@@ -190,42 +188,28 @@ function isNonNullObject(value: unknown): value is Record<string, unknown> {
   return typeof value === 'object' && value !== null
 }
 
-function buildPathAndComponents(
+function buildPath(
   sourceDocument: OpenAPIV3.Document,
   path: string,
   method: OpenAPIV3.HttpMethods,
   commonPathProps: Partial<OpenAPIV3.PathItemObject>,
   pathItemRef?: string,
-): { updatedPathItem: OpenAPIV3.PathItemObject; extraComponents?: OpenAPIV3.ComponentsObject } {
+): OpenAPIV3.PathItemObject {
   if (!pathItemRef) {
     const originalPathItem = sourceDocument.paths[path]!
     return {
-      updatedPathItem: {
-        ...commonPathProps,
-        [method]: { ...originalPathItem[method] },
-      } as OpenAPIV3.PathItemObject,
-    }
+      ...commonPathProps,
+      [method]: { ...originalPathItem[method] },
+    } as OpenAPIV3.PathItemObject
   }
 
   const { jsonPath } = parseRef(pathItemRef)
   const targetPathItem = getValueByPath(sourceDocument, jsonPath) as OpenAPIV3.PathItemObject
-  if (!targetPathItem) return { updatedPathItem: {} }
-
-  const resolvedPathItem = {
-    ...extractCommonPathItemProperties(targetPathItem),
-    [method]: { ...targetPathItem[method] },
-  }
-  const componentsContainer: any = {}
-  setValueByPath(componentsContainer, jsonPath, resolvedPathItem)
+  if (!targetPathItem) return {}
 
   const originalPathItem = sourceDocument.paths[path]!
-  const mergedPathItem: OpenAPIV3.PathItemObject = {
+  return {
     ...(originalPathItem),
     ...commonPathProps,
   }
-
-  return {
-    updatedPathItem: mergedPathItem,
-    extraComponents: componentsContainer.components,
-  }
 }

test/document-group.test.ts

@@ -47,39 +47,6 @@ describe('Document Group test', () => {
     await runMergeOperationsCase('case1')
   })
 
-  describe('PathItems tests', () => {
-    test('should have properly merged documents', async () => {
-      await runMergeOperationsCase('case2')
-    })
-
-    test('should have properly merged documents and delete unused operations', async () => {
-      await runMergeOperationsCase('case3')
-    })
-
-    test('should have properly merged documents mixed formats (operation + pathItems operation)', async () => {
-      await runMergeOperationsCase('case4')
-    })
-  })
-
-  async function runMergeOperationsCase(caseName: string): Promise<void> {
-    const pkg = LocalRegistry.openPackage(`merge-operations/${caseName}`, groupToOperationIdsMap)
-    const editor = await Editor.openProject(pkg.packageId, pkg)
-
-    await pkg.publish(pkg.packageId, { packageId: pkg.packageId })
-
-    const result = await editor.run({
-      packageId: pkg.packageId,
-      buildType: BUILD_TYPE.MERGED_SPECIFICATION,
-      groupName: GROUP_NAME,
-      apiType: REST_API_TYPE,
-    })
-
-    const expectedResult = load(
-      (await loadFileAsString(pkg.projectsDir, pkg.packageId, EXPECTED_RESULT_FILE))!,
-    )
-
-    expect(result.merged?.data).toEqual(expectedResult)
-  }
 
   test('should rename documents with matching names', async () => {
     const dashboard = LocalRegistry.openPackage('documents-collision', groupToOperationIdsMap2)
@@ -113,4 +80,67 @@ describe('Document Group test', () => {
       expect(Object.keys(document.data.paths).length).toEqual(document.operationIds.length)
     }
   })
+
+  describe('PathItems tests', () => {
+    test('should have documents with keep pathItems in components', async () => {
+      const pkg = LocalRegistry.openPackage('document-group/case1', groupToOperationIdsMap)
+      const editor = await Editor.openProject(pkg.packageId, pkg)
+      await pkg.publish(pkg.packageId, { packageId: pkg.packageId })
+
+      const result = await editor.run({
+        packageId: pkg.packageId,
+        groupName: GROUP_NAME,
+        buildType: BUILD_TYPE.REDUCED_SOURCE_SPECIFICATIONS,
+      })
+
+      for (const document of Array.from(result.documents.values())) {
+        expect(Object.keys(document.data.components.pathItems).length).toEqual(document.operationIds.length)
+      }
+    })
+
+    test('should have documents stripped of operations other than from provided group', async () => {
+      const pkg = LocalRegistry.openPackage('document-group/case2', groupToOperationIdsMap)
+      const editor = await Editor.openProject(pkg.packageId, pkg)
+      await pkg.publish(pkg.packageId, { packageId: pkg.packageId })
+
+      const result = await editor.run({
+        packageId: pkg.packageId,
+        groupName: GROUP_NAME,
+        buildType: BUILD_TYPE.REDUCED_SOURCE_SPECIFICATIONS,
+      })
+      for (const document of Array.from(result.documents.values())) {
+        expect(Object.keys(document.data.paths).length).toEqual(document.operationIds.length)
+      }
+    })
+
+    describe('Merge Operations', () => {
+      test('should have properly merged documents', async () => {
+        await runMergeOperationsCase('case2')
+      })
+
+      test('should have properly merged documents mixed formats (operation + pathItems operation)', async () => {
+        await runMergeOperationsCase('case3')
+      })
+    })
+  })
+
+  async function runMergeOperationsCase(caseName: string): Promise<void> {
+    const pkg = LocalRegistry.openPackage(`merge-operations/${caseName}`, groupToOperationIdsMap)
+    const editor = await Editor.openProject(pkg.packageId, pkg)
+
+    await pkg.publish(pkg.packageId, { packageId: pkg.packageId })
+
+    const result = await editor.run({
+      packageId: pkg.packageId,
+      buildType: BUILD_TYPE.MERGED_SPECIFICATION,
+      groupName: GROUP_NAME,
+      apiType: REST_API_TYPE,
+    })
+
+    const expectedResult = load(
+      (await loadFileAsString(pkg.projectsDir, pkg.packageId, EXPECTED_RESULT_FILE))!,
+    )
+
+    expect(result.merged?.data).toEqual(expectedResult)
+  }
 })

test/projects/merge-operations/case4/1.yaml renamed to test/projects/document-group/case1/1.yaml

@@ -5,10 +5,17 @@ info:
 paths:
   /path1:
     $ref: '#/components/pathItems/pathItem1'
+  /path2:
+    $ref: '#/components/pathItems/pathItem2'
 components:
   pathItems:
     pathItem1:
       get:
         responses:
           '200':
             description: response description main
+    pathItem2:
+      post:
+        responses:
+          '200':
+            description: response description main

test/projects/merge-operations/case4/config.json renamed to test/projects/document-group/case1/config.json

@@ -7,12 +7,6 @@
       "fileId": "1.yaml",
       "publish": true,
       "labels": [],
-      "commitId": "6c778b1f44200bd19944a6a8eac10a4e5a21a1cd"
-    },
-    {
-      "fileId": "2.yaml",
-      "publish": true,
-      "labels": [],
       "commitId": "6c778b1f44200bd19944a6a8eac10a4e5a21a3cd"
     }
   ]

test/projects/document-group/case2/1.yaml

@@ -0,0 +1,29 @@
+openapi: "3.1.0"
+info:
+  title: test
+  version: 0.1.0
+paths:
+  /path1:
+    $ref: '#/components/pathItems/pathItem1'
+  /path2:
+    $ref: '#/components/pathItems/pathItem2'
+  # operation other than from provided group
+  /path3:
+    $ref: '#/components/pathItems/pathItem3'
+components:
+  pathItems:
+    pathItem1:
+      get:
+        responses:
+          '200':
+            description: response description main
+    pathItem2:
+      post:
+        responses:
+          '200':
+            description: response description main
+    pathItem3:
+      post:
+        responses:
+          '200':
+            description: response description main

test/projects/document-group/case2/config.json

@@ -0,0 +1,13 @@
+{
+  "packageId": "55",
+  "apiType": "rest",
+  "version": "v1",
+  "files": [
+    {
+      "fileId": "1.yaml",
+      "publish": true,
+      "labels": [],
+      "commitId": "6c778b1f44200bd19944a6a8eac10a4e5a21a3cd"
+    }
+  ]
+}

test/projects/merge-operations/case3/2.yaml

@@ -4,16 +4,7 @@ info:
   version: 0.1.0
 paths:
   /path2:
-    $ref: '#/components/pathItems/pathItem2'
-components:
-  pathItems:
-    pathItem2:
-      post:
-        responses:
-          '200':
-            description: response description main
-    pathItem3:
-      post:
-        responses:
-          '200':
-            description: response description unused
+    post:
+      responses:
+        '200':
+          description: response description main

test/projects/merge-operations/case3/result.yaml

@@ -6,16 +6,14 @@ paths:
   /path1:
     $ref: '#/components/pathItems/pathItem1'
   /path2:
-    $ref: '#/components/pathItems/pathItem2'
+    post:
+      responses:
+        '200':
+          description: response description main
 components:
   pathItems:
     pathItem1:
       get:
         responses:
           '200':
             description: response description main
-    pathItem2:
-      post:
-        responses:
-          '200':
-            description: response description main