Add preliminaryChecks method

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

Author: Alan-Cha

packages/oasgraph/lib/index.js

@@ -172,6 +172,8 @@ async function translateOpenApiToGraphQL(
    */
   const data: PreprocessingData = preprocessOas(oass, options)
 
+  preliminaryChecks(options, data, oass)
+
   /**
    * Create GraphQL fields for every operation and structure them based on their
    * characteristics (query vs. mutation, auth vs. non-auth).
@@ -447,3 +449,66 @@ function sortOperations(op1: Operation, op2: Operation): number {
     }
   }
 }
+
+/**
+ * Ensures that the options are valid
+ */
+function preliminaryChecks(options: InternalOptions, data: PreprocessingData, oass: Oas3[]): void {
+  // Check if OASs have unique titles
+  const titles = oass.map((oas) => {
+    return oas.info.title
+  })
+
+  // Find duplicates among titles
+  new Set(titles.filter((title, index) => {
+    return titles.indexOf(title) !== index
+  })).forEach((title) => {
+    handleWarning({
+      typeKey: 'MULTIPLE_OAS_SAME_TITLE',
+      culprit: title,
+      data,
+      log: translationLog
+    })
+  })
+
+  // Check customResolvers
+  if (typeof options.customResolvers === 'object') {
+    // Check that all OASs that are referenced in the customResolvers are provided
+    Object.keys(options.customResolvers).filter((title) => {
+      // If no OAS contains this title
+      return !oass.some((oas) => {
+        return title === oas.info.title
+      })
+    }).forEach((title) => {
+      handleWarning({
+        typeKey: 'CUSTOM_RESOLVER_UNKNOWN_OAS',
+        culprit: title,
+        data,
+        log: translationLog
+      })
+    })
+
+    Object.keys(options.customResolvers).forEach((title) => {
+
+      // Get all operations from a particular OAS
+      const operations = Object.values(data.operations).filter((operation) => {
+        return title === operation.oas.info.title
+      })
+
+      Object.keys(options.customResolvers[title]).forEach((path) => {
+        Object.keys(options.customResolvers[title][path]).forEach((method) => {
+          if (!operations.some((operation) => {
+            return path === operation.path && method === operation.method
+          })) {
+            handleWarning({
+              typeKey: 'CUSTOM_RESOLVER_UNKNOWN_PATH_METHOD',
+              culprit: `A custom resolver references an operation with path "${path}" and method "${method}" but no such operation exists in OAS with title "${title}"`,
+              data,
+              log: translationLog
+            })
+          }
+        }) 
+      }) 
+    })
+  }
+}

packages/oasgraph/lib/index.js.map

@@ -124,6 +124,28 @@ export const WarningTypes: {
       message: `A schema reference could not be resolved due to unknown OAS origin.`,
       mitigation: `The schema will not be resolved, which may cause issues.`
     }
+  },
+  MULTIPLE_OAS_SAME_TITLE: (culprit: string, solution: string) => {
+    return {
+      type: 'multipleOasSameTitle',
+      message: `Multiple OASs share the same title "${culprit}"`,
+      mitigation: `Continue as is - may break other features`
+    }
+  },
+  CUSTOM_RESOLVER_UNKNOWN_OAS: (culprit: string, solution: string) => {
+    return {
+      type: 'customResolverUnknownOAS',
+      message: `Some custom resolvers reference OAS with title "${culprit}" but no OAS with such title is provided`,
+      mitigation: `Ignore this set of custom resolvers`
+    }
+  },
+  CUSTOM_RESOLVER_UNKNOWN_PATH_METHOD: (culprit: string, solution: string) => {
+    return {
+      type: 'customResolverUnknownOperation',
+      // TODO: improve message
+      message: culprit,
+      mitigation: `Ignore this set of custom resolvers`
+    }
   }
 }
 

packages/oasgraph/lib/utils.js

@@ -12,7 +12,7 @@ const OasGraph = require('../lib/index.js')
 
 let oas = require('./fixtures/example_oas.json')
 // let oas2 = require('./fixtures/example_oas2.json')
-// let oas3 = require('./fixtures/example_oas3.json')
+let oas3 = require('./fixtures/example_oas3.json')
 
 // let oas = require('./fixtures/github_oas.json')
 // let oas = require('./fixtures/instagram.json')
@@ -24,7 +24,7 @@ let oas = require('./fixtures/example_oas.json')
 // // requires Box API from API Guru
 // let oas = yamljs.parse(fs.readFileSync('../tmp/APIs/box.com/content/2.0/swagger.yaml', 'utf8'))
 
-OasGraph.createGraphQlSchema(oas, { provideErrorExtension: false, customResolvers: {
+OasGraph.createGraphQlSchema([oas, oas3], { provideErrorExtension: false, customResolvers: {
   'Example API': {
     '/users/{username}': {
       'get': () => {