add createSubscriptionsFromCallbacks option ; code cleaning

Author: getlarge

packages/openapi-to-graphql/lib/index.js

@@ -129,6 +129,13 @@ export declare type Options = {
             };
         };
     };
+    /**
+     * Allow to generate subscription fields from CallbackObjects in OpenAPI schema.
+     *
+     * Path ( runtime expression ) of the CallbackObject will be interpolated,
+     * as topic of publish / subscription to use with a pubsub instance.
+     */
+    createSubscriptionsFromCallbacks?: boolean;
     /**
      * Determines whether OpenAPI-to-GraphQL should create viewers that allow users to pass
      * basic auth and API key credentials.
@@ -276,6 +283,13 @@ export declare type InternalOptions = {
             };
         };
     };
+    /**
+     * Allow to generate subscription fields from CallbackObjects in OpenAPI schema.
+     *
+     * Path ( runtime expression ) of the CallbackObject will be interpolated,
+     * as topic of publish / subscription to use with a pubsub instance.
+     */
+    createSubscriptionsFromCallbacks?: boolean;
     /**
      * Determines whether OpenAPI-to-GraphQL should create viewers that allow users to pass
      * basic auth and API key credentials.

packages/openapi-to-graphql/lib/index.js.map

@@ -99,6 +99,11 @@ export async function createGraphQLSchema(
       ? options.genericPayloadArgName
       : false
 
+  options.createSubscriptionsFromCallbacks =
+    typeof options.createSubscriptionsFromCallbacks === 'boolean'
+      ? options.createSubscriptionsFromCallbacks
+      : false
+
   // Authentication options
   options.viewer = typeof options.viewer === 'boolean' ? options.viewer : true
   options.sendOAuthTokenInQuery =
@@ -181,6 +186,7 @@ async function translateOpenAPIToGraphQL(
     connectOptions,
     baseUrl,
     customResolvers,
+    createSubscriptionsFromCallbacks,
 
     // Authentication options
     viewer,
@@ -211,6 +217,7 @@ async function translateOpenAPIToGraphQL(
     baseUrl,
     customResolvers,
     selectQueryOrMutationField,
+    createSubscriptionsFromCallbacks,
 
     // Authentication options
     viewer,
@@ -231,8 +238,6 @@ async function translateOpenAPIToGraphQL(
 
   preliminaryChecks(options, data)
 
-  // console.log('PREPROCESS OPENAPI', data)
-
   /**
    * Create GraphQL fields for every operation and structure them based on their
    * characteristics (query vs. mutation, auth vs. non-auth).
@@ -244,6 +249,8 @@ async function translateOpenAPIToGraphQL(
   let authMutationFields = {}
   let authSubscriptionFields = {}
 
+  // todo parse data.callbacks to recompose subscription ?
+
   Object.entries(data.operations).forEach(([operationId, operation]) => {
     translationLog(`Process operation '${operationId}'...`)
 
@@ -383,7 +390,7 @@ async function translateOpenAPIToGraphQL(
           mutationFields[saneFieldName] = field
         }
       }
-    } else {
+    } else if (operation.isSubscription) {
       // handle subscriptions from operation.callbacks
       // 1) cbName would be the subscription field name
       // each paths contained in operation.callbacks[cbName]
@@ -592,7 +599,7 @@ function getFieldForOperation(
 
   if (operation.isSubscription) {
     const responseSchemaName = operation.responseDefinition
-      ? operation.responseDefinition.graphQLInputObjectTypeName
+      ? operation.responseDefinition.graphQLTypeName
       : null
 
     const resolve = getPublishResolver({

packages/openapi-to-graphql/lib/oas_3_tools.js

@@ -982,10 +982,10 @@ export function getEndpointCallbacks(
   data: PreprocessingData
 ): { [key: string]: CallbackObject } {
   const callbacks = {}
-  const endpoint: OperationObject = oas.paths[path][method]
+  const operation: OperationObject = oas.paths[path][method]
 
-  if (typeof endpoint.callbacks === 'object') {
-    let callbacksObject: CallbacksObject = endpoint.callbacks
+  if (typeof operation.callbacks === 'object') {
+    let callbacksObject: CallbacksObject = operation.callbacks
     for (let callbackName in callbacksObject) {
       if (typeof callbacksObject[callbackName] === 'object') {
         let callbackObject: CallbackObject | ReferenceObject =
@@ -999,12 +999,9 @@ export function getEndpointCallbacks(
         } else {
           callbackObject = (callbackObject as any) as CallbackObject
         }
-        // console.log("CHECK CALLBACK OBJ", callbackName, callbackObject)
-
         // Make sure CallbackObject contains PathItemObject:
         for (let expression in callbackObject) {
           let pathItem: PathItemObject = callbackObject[expression]
-          // console.log("CHECK CALLBACK ITEM", expression, pathItem)
           if (typeof (pathItem as ReferenceObject).$ref === 'string') {
             pathItem = resolveRef(callbackObject[callbackName]['$ref'], oas)
           } else {

packages/openapi-to-graphql/lib/oas_3_tools.js.map

@@ -194,6 +194,8 @@ function processOperationCallbacks(
           oas
         }
 
+        // todo register in data.callbacks instead ?
+
         /**
          * Handle operationId property name collision
          * May occur if multiple OAS are provided
@@ -244,9 +246,13 @@ export function preprocessOas(
     data.options.report.numOps += Oas3Tools.countOperations(oas)
     data.options.report.numOpsMutation += Oas3Tools.countOperationsMutation(oas)
     data.options.report.numOpsQuery += Oas3Tools.countOperationsQuery(oas)
-    data.options.report.numOpsSubscription += Oas3Tools.countOperationsSubscription(
-      oas
-    )
+    if (data.options.createSubscriptionsFromCallbacks) {
+      data.options.report.numOpsSubscription += Oas3Tools.countOperationsSubscription(
+        oas
+      )
+    } else {
+      data.options.report.numOpsSubscription = 0
+    }
 
     // Get security schemes
     const currentSecurity = getProcessedSecuritySchemes(oas, data)
@@ -355,16 +361,15 @@ export function preprocessOas(
         // Links
         const links = Oas3Tools.getEndpointLinks(path, method, oas, data)
 
-        // Callbacks containing [key: string]:PathItemObject
-        const callbacks = Oas3Tools.getEndpointCallbacks(
-          path,
-          method,
-          oas,
-          data
-        )
+        let callbacks = {}
+
+        if (options.createSubscriptionsFromCallbacks) {
+          // Callbacks containing [key: string]:PathItemObject
+          callbacks = Oas3Tools.getEndpointCallbacks(path, method, oas, data)
 
-        // should every callback items be registered as operations ?
-        processOperationCallbacks(callbacks, oas, data, options)
+          // should every callback items be registered as operations ?
+          processOperationCallbacks(callbacks, oas, data, options)
+        }
 
         const responseDefinition = createDataDef(
           responseSchemaNames,