fix: should fail publication of package version with duplicated operations

Author: b41ex

src/apitypes/graphql/graphql.operations.ts

@@ -67,13 +67,6 @@ export const buildGraphQLOperations: OperationsBuilder<GraphApiSchema> = async (
       await asyncFunction(async () => {
         const operationId = slugify(`${GRAPHQL_TYPE[type]}-${operationKey}`)
 
-        if (ctx.operationResolver(operationId)) {
-          notifications.push({
-            severity: MESSAGE_SEVERITY.Error,
-            message: `Duplicated operation with operationId = ${operationId} found`,
-            operationId: operationId,
-          })
-        }
         syncDebugPerformance('[Operation]', (innerDebugCtx) =>
           logLongBuild(() => {
             const operation: VersionGraphQLOperation = buildGraphQLOperation(

src/apitypes/rest/rest.operations.ts

@@ -82,12 +82,6 @@ export const buildRestOperations: OperationsBuilder<OpenAPIV3.Document> = async
         const basePath = extractOperationBasePath(methodData?.servers || pathData?.servers || servers || [])
         const operationId = calculateOperationId(basePath, key, path)
 
-        if (ctx.operationResolver(operationId)) {
-          ctx.notifications.push({
-            severity: MESSAGE_SEVERITY.Warning,
-            message: `Duplicated operation with operationId = ${operationId} found`,
-          })
-        }
         syncDebugPerformance('[Operation]', (innerDebugCtx) =>
           logLongBuild(() => {
             const operation = buildRestOperation(

src/utils/document.ts

@@ -76,6 +76,9 @@ export function toPackageDocument(document: VersionDocument): PackageDocument {
 export function setDocument(buildResult: BuildResult, document: VersionDocument, operations: ApiOperation[] = []): void {
   buildResult.documents.set(document.fileId, document)
   for (const operation of operations) {
+    if (buildResult.operations.has(operation.operationId)) {
+      throw new Error(`Duplicated operation with operationId '${operation.operationId}' found`)
+    }
     buildResult.operations.set(operation.operationId, operation)
   }
 }
@@ -129,11 +132,11 @@ export interface BundlingError {
 export const createBundlingErrorHandler = (ctx: BuilderContext, fileId: FileId) => (errors: BundlingError[]): void => {
   // Only throw if severity is ERROR and there's at least one critical error
   if (ctx.config.validationRulesSeverity?.brokenRefs === VALIDATION_RULES_SEVERITY_LEVEL_ERROR) {
-    const criticalError = errors.find(error => 
-      error.errorType === RefErrorTypes.REF_NOT_FOUND || 
+    const criticalError = errors.find(error =>
+      error.errorType === RefErrorTypes.REF_NOT_FOUND ||
       error.errorType === RefErrorTypes.REF_NOT_VALID_FORMAT,
     )
-    
+
     if (criticalError) {
       throw new Error(criticalError.message)
     }

test/bugs.test.ts

@@ -371,4 +371,17 @@ describe('Operation Bugs', () => {
       ],
     })).rejects.toThrow('Invalid path \'/res/data/{}\': path parameter name could not be empty')
   })
+
+  test('Should throw error if duplicated operation is found', async () => {
+    const pkg = LocalRegistry.openPackage('duplicated-operation')
+
+    await expect(pkg.publish(pkg.packageId, {
+      packageId: pkg.packageId,
+      version: 'v1',
+      files: [
+        { fileId: 'spec1.json' },
+        { fileId: 'spec2.json' },
+      ],
+    })).rejects.toThrow('Duplicated operation with operationId \'res-data-post\' found')
+  })
 })

test/projects/duplicated-operation/spec1.json

@@ -0,0 +1,38 @@
+{
+  "openapi": "3.0.1",
+  "info": {
+    "title": "API",
+    "description": "",
+    "version": "3.0"
+  },
+  "paths": {
+    "/res/data": {
+      "post": {
+        "summary": "Profile",
+        "operationId": "createProfile",
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object"
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "201": {
+            "description": "Description",
+            "content": {
+              "application/json;charset=UTF-8": {
+                "schema": {
+                  "type": "string"
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+}

test/projects/duplicated-operation/spec2.json

@@ -0,0 +1,38 @@
+{
+  "openapi": "3.0.1",
+  "info": {
+    "title": "API",
+    "description": "",
+    "version": "3.0"
+  },
+  "paths": {
+    "/res/data": {
+      "post": {
+        "summary": "Profile",
+        "operationId": "createProfile",
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object"
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "201": {
+            "description": "Description",
+            "content": {
+              "application/json;charset=UTF-8": {
+                "schema": {
+                  "type": "string"
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+}

test/projects/empty-path-parameter/spec.json

@@ -0,0 +1,38 @@
+{
+  "openapi": "3.0.1",
+  "info": {
+    "title": "API",
+    "description": "",
+    "version": "3.0"
+  },
+  "paths": {
+    "/res/data/{}": {
+      "post": {
+        "summary": "Profile",
+        "operationId": "createProfile",
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object"
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "201": {
+            "description": "Description",
+            "content": {
+              "application/json;charset=UTF-8": {
+                "schema": {
+                  "type": "string"
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+}

test/projects/graphql/spec1.graphql

@@ -5,21 +5,21 @@ directive @deprecated( reason: String = "No longer supported" ) on OBJECT | INPU
 type Query
 {
   """Get list of Pets"""
-  listPets(listId: String):[Pet!]
+  listPets1(listId: String):[Pet!]
 
   """Get Pet by ID"""
-  getPet(id: String!): Pet
+  getPet1(id: String!): Pet
 
   """Get list of Users"""
-  listUsers(listId: String):[User!]
+  listUsers1(listId: String):[User!]
 
    """Get User by ID"""
-   getUser(id: String!): User @deprecated (reason: "New query is developed")
+   getUser1(id: String!): User @deprecated (reason: "New query is developed")
 }
 
 type Mutation {
   """Pet availability check"""
-  petAvailabilityCheck2(input: AvailabilityCheckRequest): [AvailabilityCheckResult!]
+  petAvailabilityCheck1(input: AvailabilityCheckRequest): [AvailabilityCheckResult!]
 }
 
 """Availability Check Request"""