Feat: Allow non conflicting path methods to merge

package.json

@@ -28,8 +28,8 @@
     "@types/js-yaml": "^3.12.5",
     "@types/lodash": "^4.14.150",
     "@types/node": "^13.13.5",
-    "@typescript-eslint/eslint-plugin": "^2.31.0",
-    "@typescript-eslint/parser": "^2.31.0",
+    "@typescript-eslint/eslint-plugin": "^5.30.7",
+    "@typescript-eslint/parser": "^5.30.7",
     "ajv": "^6.12.2",
     "atlassian-openapi": "^1.0.8",
     "babel-jest": "^26.0.1",

packages/openapi-merge/.prettierrc.js

@@ -0,0 +1,6 @@
+module.exports = {
+  printWidth: 160,
+  trailingComma: 'none',
+  singleQuote: true,
+  endOfLine: 'lf'
+};

packages/openapi-merge/src/__tests__/paths.test.ts

@@ -1,7 +1,7 @@
-import { merge } from "..";
-import { toOAS } from "./oas-generation";
-import { expectMergeResult, toMergeInputs, expectErrorType } from "./test-utils";
-import { SingleMergeInput } from "../data";
+import { merge } from '..';
+import { toOAS } from './oas-generation';
+import { expectMergeResult, toMergeInputs, expectErrorType } from './test-utils';
+import { SingleMergeInput, SingleMergeInputV2 } from '../data';
 
 describe('OAS Path Merge', () => {
   it('should merge paths where one paths is null', () => {
@@ -104,6 +104,49 @@ describe('OAS Path Merge', () => {
     });
   });
 
+  it('should allow duplicate operationIds when flagged to do so', () => {
+    const first = toOAS({
+      '/path/a': {
+        get: {
+          operationId: 'same',
+          responses: {}
+        }
+      }
+    });
+
+    const second = toOAS({
+      '/path/b': {
+        post: {
+          operationId: 'same',
+          responses: {}
+        }
+      }
+    });
+
+    const output = toOAS({
+      '/path/a': {
+        get: {
+          operationId: 'same',
+          responses: {}
+        }
+      },
+      '/path/b': {
+        post: {
+          operationId: 'same',
+          responses: {}
+        }
+      }
+    });
+
+    const mergeInputs: SingleMergeInputV2[] = toMergeInputs([first, second]);
+
+    mergeInputs[1]['uniqueOperations'] = false;
+
+    expectMergeResult(merge(mergeInputs), {
+      output
+    });
+  });
+
   it('should prefix paths correctly', () => {
     const first = toOAS({
       '/path/a': {
@@ -121,7 +164,7 @@ describe('OAS Path Merge', () => {
       }
     });
 
-    expectMergeResult(merge([{ oas: first, pathModification: { prepend: '/service'}}]), {
+    expectMergeResult(merge([{ oas: first, pathModification: { prepend: '/service' } }]), {
       output
     });
   });
@@ -143,7 +186,7 @@ describe('OAS Path Merge', () => {
       }
     });
 
-    expectMergeResult(merge([{ oas: first, pathModification: { stripStart: '/rest'}}]), {
+    expectMergeResult(merge([{ oas: first, pathModification: { stripStart: '/rest' } }]), {
       output
     });
   });
@@ -165,17 +208,12 @@ describe('OAS Path Merge', () => {
       }
     });
 
-    expectMergeResult(merge([{ oas: first, pathModification: { stripStart: '/rest', prepend: '/service' }}]), {
+    expectMergeResult(merge([{ oas: first, pathModification: { stripStart: '/rest', prepend: '/service' } }]), {
       output
     });
   });
 
-  /**
-   * TODO this is simpler logic to implement for now but, ideally, we would merge paths together if we could, if
-   * the HTTP methods do not overlap. I can see a use case for two different services providing different methods
-   * on the same path.
-   */
-  it('should return an error if there are duplicate paths (simple case)', () => {
+  it('should return an error if there are duplicate paths and methods (simple case)', () => {
     const first = toOAS({
       '/path/a': {
         get: {
@@ -186,7 +224,7 @@ describe('OAS Path Merge', () => {
 
     const second = toOAS({
       '/path/a': {
-        post: {
+        get: {
           responses: {}
         }
       }
@@ -195,7 +233,7 @@ describe('OAS Path Merge', () => {
     expectErrorType(merge(toMergeInputs([first, second])), 'duplicate-paths');
   });
 
-  it('should return an error if modifying a path would result in a duplicate', () => {
+  it('should return an error if modifying a path would result in a duplicate method', () => {
     const first = toOAS({
       '/path/a': {
         get: {
@@ -206,7 +244,7 @@ describe('OAS Path Merge', () => {
 
     const second = toOAS({
       '/service/rest/path/a': {
-        post: {
+        get: {
           responses: {}
         }
       }
@@ -229,6 +267,86 @@ describe('OAS Path Merge', () => {
     expectErrorType(merge([firstInput, secondInput]), 'duplicate-paths');
   });
 
+  it('should allow duplicate paths with non-overlapping methods, resulting in a merged path', () => {
+    const first = toOAS({
+      '/path/a': {
+        get: {
+          responses: {}
+        }
+      }
+    });
+
+    const second = toOAS({
+      '/path/a': {
+        post: {
+          responses: {}
+        }
+      }
+    });
+
+    const output = toOAS({
+      '/path/a': {
+        get: {
+          responses: {}
+        },
+        post: {
+          responses: {}
+        }
+      }
+    });
+
+    expectMergeResult(merge(toMergeInputs([first, second])), {
+      output
+    });
+  });
+
+  it('should allow duplicate path with alternate methods if ther is no conflict', () => {
+    const first = toOAS({
+      '/path/a': {
+        get: {
+          responses: {}
+        }
+      }
+    });
+
+    const second = toOAS({
+      '/service/rest/path/a': {
+        post: {
+          responses: {}
+        }
+      }
+    });
+
+    const firstInput: SingleMergeInput = {
+      oas: first,
+      pathModification: {
+        prepend: '/rest'
+      }
+    };
+
+    const secondInput: SingleMergeInput = {
+      oas: second,
+      pathModification: {
+        stripStart: '/service'
+      }
+    };
+
+    const output = toOAS({
+      '/rest/path/a': {
+        get: {
+          responses: {}
+        },
+        post: {
+          responses: {}
+        }
+      }
+    });
+
+    expectMergeResult(merge([firstInput, secondInput]), {
+      output
+    });
+  });
+
   describe('Tag Exclusion', () => {
     it('should strip out Path Items with no operations', () => {
       const first = toOAS({
@@ -359,7 +477,7 @@ describe('OAS Path Merge', () => {
         }
       });
 
-      expectMergeResult(merge([{ oas: first, operationSelection: { excludeTags: ['excluded'] }}, { oas: second }]), {
+      expectMergeResult(merge([{ oas: first, operationSelection: { excludeTags: ['excluded'] } }, { oas: second }]), {
         output
       });
     });
@@ -428,7 +546,7 @@ describe('OAS Path Merge', () => {
         }
       });
 
-      expectMergeResult(merge([{ oas: first, operationSelection: { includeTags: ['included'] }}, { oas: second }]), {
+      expectMergeResult(merge([{ oas: first, operationSelection: { includeTags: ['included'] } }, { oas: second }]), {
         output
       });
     });
@@ -491,7 +609,7 @@ describe('OAS Path Merge', () => {
         }
       });
 
-      expectMergeResult(merge([{ oas: first, operationSelection: { includeTags: ['included'], excludeTags: ['excluded'] }}, { oas: second }]), {
+      expectMergeResult(merge([{ oas: first, operationSelection: { includeTags: ['included'], excludeTags: ['excluded'] } }, { oas: second }]), {
         output
       });
     });
@@ -521,16 +639,20 @@ describe('OAS Path Merge', () => {
         }
       });
 
-      first.tags = [{
-        name: 'included',
-        description: 'This tag is included'
-      }, {
-        name: 'excluded',
-        description: 'This tag is excluded'
-      }, {
-        name: 'unused',
-        description: 'This tag is not used'
-      }];
+      first.tags = [
+        {
+          name: 'included',
+          description: 'This tag is included'
+        },
+        {
+          name: 'excluded',
+          description: 'This tag is excluded'
+        },
+        {
+          name: 'unused',
+          description: 'This tag is not used'
+        }
+      ];
 
       const second = toOAS({
         '/path/b': {
@@ -554,17 +676,20 @@ describe('OAS Path Merge', () => {
         }
       });
 
-      output.tags = [{
-        name: 'included',
-        description: 'This tag is included'
-      }, {
-        name: 'unused',
-        description: 'This tag is not used'
-      }];
+      output.tags = [
+        {
+          name: 'included',
+          description: 'This tag is included'
+        },
+        {
+          name: 'unused',
+          description: 'This tag is not used'
+        }
+      ];
 
       expectMergeResult(merge([{ oas: first, operationSelection: { excludeTags: ['excluded'] } }, { oas: second }]), {
         output
       });
     });
   });
-});
+});