feat: Refactoring

Author: makeev-pavel

src/apitypes/rest/rest.operation.ts

@@ -48,6 +48,7 @@ import {
   grepValue,
   JSON_SCHEMA_PROPERTY_DEPRECATED,
   matchPaths,
+  normalize,
   OPEN_API_PROPERTY_COMPONENTS,
   OPEN_API_PROPERTY_PATHS,
   OPEN_API_PROPERTY_SCHEMAS,
@@ -59,7 +60,6 @@ import {
 } from '@netcracker/qubership-apihub-api-unifier'
 import { calculateObjectHash } from '../../utils/hashes'
 import { calculateTolerantHash } from '../../components/deprecated'
-import { getValueByPath } from '../../utils/path'
 
 export const buildRestOperation = (
   operationId: string,
@@ -262,8 +262,7 @@ const createSingleOperationSpec = (
     if (!ref) {
       return null
     }
-    const { jsonPath } = parseRef(ref)
-    const target = getValueByPath(document, jsonPath) as OpenAPIV3.PathItemObject
+    const target = normalize(pathData, { source: document }) as OpenAPIV3.PathItemObject
     if (!target || typeof target !== 'object') {
       return null
     }

test/document-group.test.ts

@@ -32,6 +32,13 @@ const groupToOperationIdsMap2 = {
     'some-path2-post',
   ],
 }
+
+const groupToOnePathOperationIdsMap = {
+  [GROUP_NAME]: [
+    'path1-get',
+    'path1-post',
+  ],
+}
 const EXPECTED_RESULT_FILE = 'result.yaml'
 
 describe('Document Group test', () => {
@@ -44,9 +51,23 @@ describe('Document Group test', () => {
   })
 
   test('should have properly merged documents', async () => {
-    await runMergeOperationsCase('case1')
+    await runMergeOperationsCase('basic-documents-for-merge')
   })
 
+  test('should have keep a few operations in one path', async () => {
+    const pkg = LocalRegistry.openPackage('document-group/few-operations-in-one-path', groupToOnePathOperationIdsMap)
+    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['/path1']).length).toEqual(document.operationIds.length)
+    }
+  })
 
   test('should rename documents with matching names', async () => {
     const dashboard = LocalRegistry.openPackage('documents-collision', groupToOperationIdsMap2)
@@ -83,7 +104,39 @@ describe('Document Group test', () => {
 
   describe('PathItems tests', () => {
     test('should have documents with keep pathItems in components', async () => {
-      const pkg = LocalRegistry.openPackage('document-group/case1', groupToOperationIdsMap)
+      const pkg = LocalRegistry.openPackage('document-group/operations-in-pathitems', 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 keep a few operations in one pathItems', async () => {
+      const pkg = LocalRegistry.openPackage('document-group/few-operations-in-one-pathitems', groupToOnePathOperationIdsMap)
+      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['pathItem1']).length).toEqual(document.operationIds.length)
+      }
+    })
+
+    test('should delete pathItems object which is not referenced', async () => {
+      const pkg = LocalRegistry.openPackage('document-group/pathitems-object-which-is-not-referenced', groupToOperationIdsMap)
       const editor = await Editor.openProject(pkg.packageId, pkg)
       await pkg.publish(pkg.packageId, { packageId: pkg.packageId })
 
@@ -99,7 +152,7 @@ describe('Document Group test', () => {
     })
 
     test('should have documents stripped of operations other than from provided group', async () => {
-      const pkg = LocalRegistry.openPackage('document-group/case2', groupToOperationIdsMap)
+      const pkg = LocalRegistry.openPackage('document-group/stripped-of-pathitems-operations', groupToOperationIdsMap)
       const editor = await Editor.openProject(pkg.packageId, pkg)
       await pkg.publish(pkg.packageId, { packageId: pkg.packageId })
 
@@ -115,11 +168,11 @@ describe('Document Group test', () => {
 
     describe('Merge Operations', () => {
       test('should have properly merged documents', async () => {
-        await runMergeOperationsCase('case2')
+        await runMergeOperationsCase('basic-documents-pathitems-for-merge')
       })
 
       test('should have properly merged documents mixed formats (operation + pathItems operation)', async () => {
-        await runMergeOperationsCase('case3')
+        await runMergeOperationsCase('documents-pathitems-with-mixed-formats')
       })
     })
   })

test/projects/document-group/few-operations-in-one-path/1.yaml

@@ -0,0 +1,16 @@
+openapi: "3.1.0"
+info:
+  title: test
+  version: 0.1.0
+paths:
+  /path1:
+    get:
+      responses:
+        '200':
+          description: response description main
+    post:
+      responses:
+        '200':
+          description: response description main
+
+

test/projects/document-group/case1/config.json renamed to test/projects/document-group/few-operations-in-one-path/config.json

@@ -0,0 +1,18 @@
+openapi: "3.1.0"
+info:
+  title: test
+  version: 0.1.0
+paths:
+  /path1:
+    $ref: '#/components/pathItems/pathItem1'
+components:
+  pathItems:
+    pathItem1:
+      get:
+        responses:
+          '200':
+            description: response description main
+      post:
+        responses:
+          '200':
+            description: response description main

test/projects/document-group/few-operations-in-one-pathitems/1.yaml

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

test/projects/document-group/case2/config.json renamed to test/projects/document-group/few-operations-in-one-pathitems/config.json

@@ -0,0 +1,26 @@
+openapi: "3.1.0"
+info:
+  title: test
+  version: 0.1.0
+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
+    pathItem3:
+      post:
+        responses:
+          '200':
+            description: response description main

test/projects/document-group/case1/1.yaml renamed to test/projects/document-group/operations-in-pathitems/1.yaml

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