Merge pull request #718 from dherault/display-stack-trace-on-failure

[Feature] Output stack trace on failure

README.md

@@ -99,6 +99,7 @@ All CLI options are optional:
 --providedRuntime           Sets the runtime for "provided" lambda runtimes
 --disableModelValidation    Disables the model validation
 --showDuration              Show the execution time duration of the lambda function.
+--hideStackTraces           Hide the stack trace on lambda failure. Default: false
 ```
 
 Any of the CLI options can be added to your `serverless.yml`. For example:

manual_test_nodejs/handler.js

@@ -97,3 +97,7 @@ module.exports.pathParams = (event, context, cb) => {
 
   cb(null, response);
 };
+
+module.exports.failure = (event, context, cb) => {
+  throw new Error('Unexpected error!')
+};

manual_test_nodejs/serverless.yml

@@ -158,19 +158,28 @@ functions:
           method: POST
           private: true
 
-  catchAll:
-    handler: handler.catchAll
-    events:
-      - http:
-          path: /{proxy+}
-          method: ANY
   pathParams:
     handler: handler.pathParams
     events:
       - http:
           path: /pathParams/{id}
           method: GET
 
+  failure:
+    handler: handler.failure
+    events:
+      - http:
+          path: /failure
+          method: GET
+
+  catchAll:
+    handler: handler.catchAll
+    events:
+      - http:
+          path: /{proxy+}
+          method: ANY
+
+
 # you can add CloudFormation resource templates here
 resources:
   Resources:

src/index.js

@@ -87,6 +87,9 @@ class Offline {
           exec: {
             usage: 'When provided, a shell script is executed when the server starts up, and the server will shut down after handling this command.',
           },
+          hideStackTraces: {
+            usage: 'Hide the stack trace on lambda failure. Default: false',
+          },
           host: {
             usage: 'The host name to listen on. Default: localhost',
             shortcut: 'o',
@@ -284,6 +287,7 @@ class Offline {
       resourceRoutes: false,
       skipCacheInvalidation: false,
       useSeparateProcesses: false,
+      hideStackTraces: false,
     };
 
     // In the constructor, stage and regions are set to undefined
@@ -776,8 +780,8 @@ class Offline {
 
                   this.serverlessLog(`Failure: ${errorMessage}`);
 
-                  if (result.stackTrace) {
-                    debugLog(result.stackTrace.join('\n  '));
+                  if (!this.options.hideStackTraces) {
+                    console.error(err.stack);
                   }
 
                   for (const key in endpoint.responses) {
@@ -1175,36 +1179,31 @@ class Offline {
   }
 
   // Bad news
-  _replyError(responseCode, response, message, err) {
-    const stackTrace = this._getArrayStackTrace(err.stack);
+  _replyError(responseCode, response, message, error) {
+    const stackTrace = this._getArrayStackTrace(error.stack);
 
     this.serverlessLog(message);
-    if (stackTrace && stackTrace.length > 0) {
-      console.log(stackTrace);
-    }
-    else {
-      console.log(err);
-    }
+
+    console.error(error);
 
     response.header('Content-Type', 'application/json');
 
     /* eslint-disable no-param-reassign */
     response.statusCode = responseCode;
     response.source = {
       errorMessage: message,
-      errorType: err.constructor.name,
+      errorType: error.constructor.name,
       stackTrace,
-      offlineInfo: 'If you believe this is an issue with the plugin please submit it, thanks. https://github.com/dherault/serverless-offline/issues',
+      offlineInfo: 'If you believe this is an issue with serverless-offline please submit it, thanks. https://github.com/dherault/serverless-offline/issues',
     };
     /* eslint-enable no-param-reassign */
-    this.serverlessLog('Replying error in handler');
 
     return response;
   }
 
-  _reply500(response, message, err) {
+  _reply500(response, message, error) {
     // APIG replies 200 by default on failures
-    return this._replyError(200, response, message, err);
+    return this._replyError(200, response, message, error);
   }
 
   _replyTimeout(response, resolve, funName, funTimeout, requestId) {