Add provideErrorExtensions option to CLI

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

Author: Alan-Cha

packages/oasgraph-cli/README.md

@@ -32,6 +32,7 @@ Options:
   -o, --operationIdFieldNames  create field names based on the operationId
   --cors                       enable Cross-origin resource sharing (CORS)
   --no-viewer                  do not create GraphQL viewer objects for passing authentication credentials
+  --no-extensions              do not add extentions, containing information about failed REST calls, to the GraphQL errors objects
   --save <file path>           save schema to path and do not start server
   -h, --help                   output usage information
 ```

packages/oasgraph-cli/lib/oasgraph.js

@@ -25,6 +25,7 @@ program
   .option('-o, --operationIdFieldNames', 'create field names based on the operationId')
   .option('--cors', 'enable Cross-origin resource sharing (CORS)')
   .option('--no-viewer', 'do not create GraphQL viewer objects for passing authentication credentials')
+  .option('--no-extensions', 'do not add extentions, containing information about failed REST calls, to the GraphQL errors objects')
   .option('--save <file path>', 'save schema to path and do not start server')
   .parse(process.argv)
 
@@ -136,7 +137,8 @@ function startGraphQLServer(oas, port) {
     viewer: program.viewer,
     fillEmptyResponses: program.fillEmptyResponses,
     baseUrl: program.url,
-    operationIdFieldNames: program.operationIdFieldNames
+    operationIdFieldNames: program.operationIdFieldNames,
+    provideErrorExtensions: program.extensions
   })
      .then(({schema, report}) => {
       console.log(JSON.stringify(report, null, 2))

packages/oasgraph-cli/lib/oasgraph.js.map

@@ -80,13 +80,13 @@ export declare type Options = {
      */
     requestOptions?: NodeRequest.OptionsWithUrl;
     /**
-     * The error extension is part of the GraphQLErrors that will be returned if
-     * the query cannot be fulfilled. It provides information about the REST call
-     * that could be fulfilled (e.g. the method, path, status code, response
+     * The error extensions is part of the GraphQLErrors that will be returned if
+     * the query cannot be fulfilled. It provides information about the failed
+     * REST call(e.g. the method, path, status code, response
      * headers, and response body). It can be useful for debugging but may
      * unintentionally leak information.
      *
-     * This option prevents the extension from being created.
+     * This option prevents the extensions from being created.
      */
     provideErrorExtensions?: boolean;
 };
@@ -159,13 +159,13 @@ export declare type InternalOptions = {
      */
     requestOptions?: NodeRequest.OptionsWithUrl;
     /**
-     * The error extension is part of the GraphQLErrors that will be returned if
-     * the query cannot be fulfilled. It provides information about the REST call
-     * that could be fulfilled (e.g. the method, path, status code, response
+     * The error extensions is part of the GraphQLErrors that will be returned if
+     * the query cannot be fulfilled. It provides information about the failed
+     * REST call(e.g. the method, path, status code, response
      * headers, and response body). It can be useful for debugging but may
      * unintentionally leak information.
      *
-     * This option prevents the extension from being created.
+     * This option prevents the extensions from being created.
      */
     provideErrorExtensions: boolean;
 };

packages/oasgraph-cli/src/oasgraph.ts

@@ -96,8 +96,8 @@ export type Options = {
 
   /**
    * The error extensions is part of the GraphQLErrors that will be returned if
-   * the query cannot be fulfilled. It provides information about the REST call
-   * that could be fulfilled (e.g. the method, path, status code, response 
+   * the query cannot be fulfilled. It provides information about the failed 
+   * REST call(e.g. the method, path, status code, response 
    * headers, and response body). It can be useful for debugging but may 
    * unintentionally leak information.
    * 
@@ -184,8 +184,8 @@ export type InternalOptions = {
 
   /**
    * The error extensions is part of the GraphQLErrors that will be returned if
-   * the query cannot be fulfilled. It provides information about the REST call
-   * that could be fulfilled (e.g. the method, path, status code, response 
+   * the query cannot be fulfilled. It provides information about the failed 
+   * REST call(e.g. the method, path, status code, response 
    * headers, and response body). It can be useful for debugging but may 
    * unintentionally leak information.
    * 

packages/oasgraph/lib/types/options.d.ts

@@ -689,7 +689,7 @@ test('Error contains extension', () => {
     expect(extensions).toEqual({
       "method": "get",
       "path": "/users/{username}",
-      "statusCode": 401,
+      "statusCode": 404,
       "responseBody": {
         "message": "Wrong username."
       }

packages/oasgraph/src/types/options.ts

@@ -281,7 +281,7 @@ function startServer (PORT) {
     if (req.params.username in Users) {
       res.send(Users[req.params.username])
     } else {
-      res.status(401).send({
+      res.status(404).send({
         message: 'Wrong username.'
       })
     }
@@ -291,7 +291,7 @@ function startServer (PORT) {
     console.log(req.method, req.path)
     if (typeof req.params.username !== 'string' ||
       req.params.username === 'undefined') {
-      res.status(401).send({
+      res.status(404).send({
         message: 'Wrong username.'
       })
     } else {