Remove extraneous comments

Alan-Cha · Alan-Cha · commit f5049bc01106 · 2020-04-23T10:10:57.000-04:00
Signed-off-by: Alan Cha &lt;Alan.cha1@ibm.com&gt;
diff --git a/packages/openapi-to-graphql/lib/index.js b/packages/openapi-to-graphql/lib/index.js
diff --git a/packages/openapi-to-graphql/lib/index.js.map b/packages/openapi-to-graphql/lib/index.js.map
diff --git a/packages/openapi-to-graphql/lib/oas_3_tools.js b/packages/openapi-to-graphql/lib/oas_3_tools.js
diff --git a/packages/openapi-to-graphql/lib/oas_3_tools.js.map b/packages/openapi-to-graphql/lib/oas_3_tools.js.map
diff --git a/packages/openapi-to-graphql/lib/resolver_builder.js b/packages/openapi-to-graphql/lib/resolver_builder.js
diff --git a/packages/openapi-to-graphql/lib/types/options.d.ts b/packages/openapi-to-graphql/lib/types/options.d.ts
@@ -132,8 +132,8 @@ export declare type Options = {
      */
     baseUrl?: string;
     /**
-     * Allows to define custom resolvers for fields on the Query/Mutation |
-     * Subscription root operation type.
+     * Allows to define custom resolvers for fields on the Query/Mutation/Subscription
+     * root operation type.
      *
      * In other words, instead of resolving on an operation (REST call) defined in
      * the OAS, the field will resolve on the custom resolver. Note that this will
@@ -310,8 +310,8 @@ export declare type InternalOptions = {
      */
     baseUrl?: string;
     /**
-     * Allows to define custom resolvers for fields on the Query/Mutation |
-     * Subscription root operation type.
+     * Allows to define custom resolvers for fields on the Query/Mutation/Subscription
+     * root operation type.
      *
      * In other words, instead of resolving on an operation (REST call) defined in
      * the OAS, the field will resolve on the custom resolver. Note that this will
diff --git a/packages/openapi-to-graphql/src/index.ts b/packages/openapi-to-graphql/src/index.ts
@@ -106,7 +106,7 @@ export async function createGraphQLSchema(
     typeof options.createSubscriptionsFromCallbacks === 'boolean'
       ? options.createSubscriptionsFromCallbacks
       : false
-      
+
   // Authentication options
   options.viewer = typeof options.viewer === 'boolean' ? options.viewer : true
   options.sendOAuthTokenInQuery =
@@ -138,9 +138,7 @@ export async function createGraphQLSchema(
   let oass: Oas3[]
 
   if (Array.isArray(spec)) {
-    /**
-     * Convert all non-OAS 3.0.x into OAS 3.0.x
-     */
+    // Convert all non-OAS 3.0.x into OAS 3.0.x
     oass = await Promise.all(
       spec.map(ele => {
         return Oas3Tools.getValidOAS3(ele)
@@ -436,19 +434,6 @@ async function translateOpenAPIToGraphQL(
         Oas3Tools.CaseStyle.camelCase
       )
 
-      // handle subscriptions from operation.callbacks
-      // 1) cbName would be the subscription field name
-      // each paths contained in operation.callbacks[cbName]
-      // would be a channel to subscribe on the resolver
-      // but if callback object contains several operations
-      // how to be sure that the returned Graphql type would be the same ?
-      // By "forcing' a common response schema for every operation within the CB ?
-      // 2) cbName would be a prefix to the subscription field name
-      // each paths contained in operation.callbacks[cbName] would be appended to create a unique subscription
-
-      // console.log('SUB FIELD', field.args, field.subscribe.toString(), field.resolve.toString())
-      // console.log('SUB FIELD', operation)
-
       let saneFieldName = Oas3Tools.storeSaneName(
         saneOperationId,
         operationId,
diff --git a/packages/openapi-to-graphql/src/oas_3_tools.ts b/packages/openapi-to-graphql/src/oas_3_tools.ts
@@ -137,12 +137,6 @@ export function countOperations(oas: Oas3): number {
           for (let cbName in oas.paths[path][method].callbacks) {
             for (let cbPath in oas.paths[path][method].callbacks[cbName]) {
               numOps++
-              // resolve $ref ??
-              // for (let cbMethod in oas.paths[path][method].callbacks[cbName][cbPath]) {
-              //   if (isOperation(cbMethod)) {
-              //     numOps++
-              //   }
-              // }
             }
           }
         }
@@ -197,12 +191,6 @@ export function countOperationsSubscription(oas: Oas3): number {
         for (let cbName in oas.paths[path][method].callbacks) {
           for (let cbPath in oas.paths[path][method].callbacks[cbName]) {
             numOps++
-            // resolve $ref ??
-            // for (let cbMethod in oas.paths[path][method].callbacks[cbName][cbPath]) {
-            //   if (isOperation(cbMethod)) {
-            //     numOps++
-            //   }
-            // }
           }
         }
       }
diff --git a/packages/openapi-to-graphql/test/example_api2_server.js b/packages/openapi-to-graphql/test/example_api2_server.js
@@ -51,7 +51,7 @@ function stopServer() {
   })
 }
 
-// if run from command line, start server:
+// If run from command line, start server:
 if (require.main === module) {
   startServer(3002)
 }
diff --git a/packages/openapi-to-graphql/test/example_api3_server.js b/packages/openapi-to-graphql/test/example_api3_server.js
@@ -229,7 +229,7 @@ function stopServer() {
   })
 }
 
-// if run from command line, start server:
+// If run from command line, start server:
 if (require.main === module) {
   startServer(3003)
 }
diff --git a/packages/openapi-to-graphql/test/example_api5_server.js b/packages/openapi-to-graphql/test/example_api5_server.js
@@ -72,7 +72,7 @@ function stopServer() {
   })
 }
 
-// if run from command line, start server:
+// If run from command line, start server:
 if (require.main === module) {
   startServer(3005)
 }
diff --git a/packages/openapi-to-graphql/test/example_api6_server.js b/packages/openapi-to-graphql/test/example_api6_server.js
@@ -83,7 +83,7 @@ function stopServer() {
   })
 }
 
-// if run from command line, start server:
+// If run from command line, start server:
 if (require.main === module) {
   startServer(3006)
 }
diff --git a/packages/openapi-to-graphql/test/example_api7.test.ts b/packages/openapi-to-graphql/test/example_api7.test.ts
@@ -68,7 +68,7 @@ beforeAll(() => {
             subscribe,
             schema,
             onConnect: (params, socket, ctx) => {
-              // adding pubsub to subscribe context
+              // Add pubsub to subscribe context
               return { pubsub }
             }
           },
diff --git a/packages/openapi-to-graphql/test/example_api7_server.js b/packages/openapi-to-graphql/test/example_api7_server.js
@@ -161,7 +161,7 @@ function stopServers() {
   })
 }
 
-// if run from command line, start server:
+// If run from command line, start server:
 if (require.main === module) {
   startServers(3008, 1885)
 }
diff --git a/packages/openapi-to-graphql/test/example_api_server.js b/packages/openapi-to-graphql/test/example_api_server.js
@@ -590,12 +590,10 @@ function startServer(PORT) {
       typeof req.params.id !== 'undefined' &&
       typeof req.query['product-tag'] !== 'undefined'
     ) {
-      res
-        .status(200)
-        .send([
-          { text: 'Great product', timestamp: 1502787600000000 },
-          { text: 'I love it', timestamp: 1502787400000000 }
-        ])
+      res.status(200).send([
+        { text: 'Great product', timestamp: 1502787600000000 },
+        { text: 'I love it', timestamp: 1502787400000000 }
+      ])
     } else {
       res.status(400).send({
         message: 'wrong data'
@@ -797,7 +795,7 @@ function stopServer() {
   })
 }
 
-// if run from command line, start server:
+// If run from command line, start server:
 if (require.main === module) {
   startServer(3001)
 }
diff --git a/packages/openapi-to-graphql/test/example_gql_server_ws.js b/packages/openapi-to-graphql/test/example_gql_server_ws.js
@@ -16,7 +16,6 @@ openAPIToGraphQL
   .createGraphQLSchema(oas5, {
     fillEmptyResponses: true,
     createSubscriptionsFromCallbacks: true
-    // operationIdFieldNames: true
   })
   .then(({ schema, report }) => {
     console.log(JSON.stringify(report, null, 2))
@@ -37,7 +36,6 @@ openAPIToGraphQL
       client
     })
 
-    // client.on('offline', => { pubsub.unsubscribeAll() })
     app.use(
       '/graphql',
       graphqlHTTP({
@@ -61,7 +59,7 @@ openAPIToGraphQL
           subscribe,
           schema,
           onConnect: (params, socket, ctx) => {
-            // adding pubsub to subscribe context
+            // Add pubsub to subscribe context
             return { pubsub }
           }
         },

Original file line number	Diff line number	Diff line change
`@@ -137,12 +137,6 @@ export function countOperations(oas: Oas3): number {`
`137`	`137`	`for (let cbName in oas.paths[path][method].callbacks) {`
`138`	`138`	`for (let cbPath in oas.paths[path][method].callbacks[cbName]) {`
`139`	`139`	`numOps++`
`140`		`- // resolve $ref ??`
`141`		`- // for (let cbMethod in oas.paths[path][method].callbacks[cbName][cbPath]) {`
`142`		`- // if (isOperation(cbMethod)) {`
`143`		`- // numOps++`
`144`		`- // }`
`145`		`- // }`
`146`	`140`	`}`
`147`	`141`	`}`
`148`	`142`	`}`
`@@ -197,12 +191,6 @@ export function countOperationsSubscription(oas: Oas3): number {`
`197`	`191`	`for (let cbName in oas.paths[path][method].callbacks) {`
`198`	`192`	`for (let cbPath in oas.paths[path][method].callbacks[cbName]) {`
`199`	`193`	`numOps++`
`200`		`- // resolve $ref ??`
`201`		`- // for (let cbMethod in oas.paths[path][method].callbacks[cbName][cbPath]) {`
`202`		`- // if (isOperation(cbMethod)) {`
`203`		`- // numOps++`
`204`		`- // }`
`205`		`- // }`
`206`	`194`	`}`
`207`	`195`	`}`
`208`	`196`	`}`
Original file line number	Diff line number	Diff line change
`@@ -51,7 +51,7 @@ function stopServer() {`
`51`	`51`	`})`
`52`	`52`	`}`
`53`	`53`
`54`		`-// if run from command line, start server:`
	`54`	`+// If run from command line, start server:`
`55`	`55`	`if (require.main === module) {`
`56`	`56`	`startServer(3002)`
`57`	`57`	`}`
Original file line number	Diff line number	Diff line change
`@@ -229,7 +229,7 @@ function stopServer() {`
`229`	`229`	`})`
`230`	`230`	`}`
`231`	`231`
`232`		`-// if run from command line, start server:`
	`232`	`+// If run from command line, start server:`
`233`	`233`	`if (require.main === module) {`
`234`	`234`	`startServer(3003)`
`235`	`235`	`}`