Fix bug checking for duplicateLinkKey

Signed-off-by: Alan Cha <[email protected]>

Author: Alan-Cha

packages/oasgraph/lib/preprocessor.js

@@ -386,13 +386,20 @@ export function createDataDef(
     )
   }
 
-  const preferredName = getPreferredName(names)
-
   // resolve allOf element in schema if applicable
   if ('allOf' in schema) {
     schema = mergeAllOf(schema)
   }
 
+  const preferredName = getPreferredName(names)
+  
+  const saneLinks = {}
+  if (typeof links === 'object') {
+    Object.keys(links).forEach((linkKey) => {
+      saneLinks[Oas3Tools.beautify(linkKey)] = links[linkKey]
+    })
+  }
+
   // Determine the index of possible existing data definition
   const index = getSchemaIndex(preferredName, schema, data.defs)
   if (index !== -1) {
@@ -402,25 +409,29 @@ export function createDataDef(
     // Collapse links if possible
     // I.e. if the current operation has links, combine them with the prexisting
     // ones
-    if (typeof links !== 'undefined') {
+    if (typeof saneLinks !== 'undefined') {
       if (typeof existingDataDef.links !== 'undefined') {
         // Check if there are any overlapping links
-        Object.keys(existingDataDef.links).forEach(linkKey => {
-          if (!deepEqual(existingDataDef[linkKey], links[linkKey])) {
+        Object.keys(existingDataDef.links).forEach(saneLinkKey => {
+          if (typeof saneLinks[saneLinkKey] !== 'undefined' 
+          && !deepEqual(existingDataDef.links[saneLinkKey], saneLinks[saneLinkKey])) {
             handleWarning({
               typeKey: 'DUPLICATE_LINK_KEY',
-              culprit: linkKey,
+              culprit: `Multiple operations with the same response body share the same sanitized ` + 
+                `link key '${saneLinkKey}' but have different link definitions ` +
+                `'${JSON.stringify(existingDataDef.links[saneLinkKey])}' and ` +
+                `'${JSON.stringify(saneLinks[saneLinkKey])}'.`,
               data,
               log: preprocessingLog
             })
           }
         })
 
         // Collapse the links
-        Object.assign(existingDataDef.links, links)
+        Object.assign(existingDataDef.links, saneLinks)
       } else {
         // No preexisting links, so simply assign the links
-        existingDataDef.links = links
+        existingDataDef.links = saneLinks
       }
     }
 
@@ -455,7 +466,7 @@ export function createDataDef(
       schema,
       type,
       subDefinitions: undefined,
-      links,
+      links: saneLinks,
       otName: saneName,
       iotName: saneInputName
     }

packages/oasgraph/lib/preprocessor.js.map

@@ -552,6 +552,7 @@ function createFields({
 
         // finally, add the object type to the fields (using sanitized field name)
         const saneLinkKey = Oas3Tools.beautifyAndStore(linkKey, data.saneMap)
+        // TODO: check if fields already has this field name
         fields[saneLinkKey] = {
           type: resObjectType,
           resolve: linkResolver,

packages/oasgraph/lib/schema_builder.js

@@ -23,7 +23,7 @@ export const WarningTypes: {
     return {
       type: 'MultipleResponses',
       message:
-        `Operation '${culprit}' has more than one success status ` +
+        `Operation ${culprit} has more than one success status ` +
         `codes (200 - 299).`,
       mitigation: `Will select response for status code '${solution}'.`
     }
@@ -32,7 +32,7 @@ export const WarningTypes: {
     return {
       type: 'MissingResponseSchema',
       message:
-        `Operation '${culprit}' has no (valid) response schema. ` +
+        `Operation ${culprit} has no (valid) response schema. ` +
         `If this operation has a 204 HTTP code, you can create a placeholder ` +
         `schema using the fillEmptyResponses option.`,
       mitigation: `Ignore operation`
@@ -113,9 +113,8 @@ export const WarningTypes: {
   DUPLICATE_LINK_KEY: (culprit: string, solution: string) => {
     return {
       type: 'duplicateLinkKey',
-      message: `Multiple operations with the same response body schema share the same link key '${culprit}'.`,
-      // TODO: improve mitigation message
-      mitigation: `The link will replace the previous one.`
+      message: culprit,
+      mitigation: `The latter link definition will replace the previous one.`,
     }
   },
   UNRESOLVABLE_REFERENCE: (culprit: string, solution: string) => {