Added improved protocol error handler for main transports

beatfactor · beatfactor · commit 0b76aa56a1af · 2020-08-15T13:47:19.000+02:00
diff --git a/lib/http/response.js b/lib/http/response.js
@@ -102,6 +102,11 @@ class HttpResponse extends EventEmitter {
       };
     }
 
+    if (result.value && result.value.stacktrace) {
+      // this is in order to not pollute verbose logs
+      result.value.stacktrace = '';
+    }
+
     return result;
   }
 }
diff --git a/lib/transport/jsonwire.js b/lib/transport/jsonwire.js
@@ -143,40 +143,52 @@ class JsonWireProtocol extends Transport {
   // Error handling
   ////////////////////////////////////////////////////////////////////////
   handleProtocolError(result, response, screenshotContent) {
-    let errorMessage = response && response.statusCode === 404 ? 'Unknown command' : 'An unknown error has occurred.';
+    result = result || {};
+    response = response || {};
+
+    const {status = '', value = null, code = '', message = null} = result;
+    let errorMessage;
+    let {state = ''} = result;
+
+    if (code && message) {
+      errorMessage = `Error ${code}: ${message}`;
+    } else {
+      errorMessage = response.statusCode === 404 ? 'Unknown command' : 'An unknown error has occurred.';
+    }
 
     if (screenshotContent) {
       this.reporter && this.reporter.saveErrorScreenshot(result, screenshotContent);
     }
 
-    if (result && result.status) {
-      if (result.value && result.value.message) {
-        errorMessage = result.value && result.value.message;
-      } else {
-        let error = Errors.findErrorById(result.status);
-        if (error) {
-          errorMessage = Errors.findErrorById(result.status).message;
-        }
+    if (status) {
+      let error = Errors.findErrorById(status);
+      if (error) {
+         errorMessage = Errors.findErrorById(result.status).message;
+      }
+
+      if (value && value.message) {
+        errorMessage = `${errorMessage} – ${result.value.message}`;
       }
-    } else if (response && response.statusCode && response.statusMessage) {
+    } else if (response.statusCode && response.statusMessage) {
       errorMessage += ` ${response.statusCode} ${response.statusMessage}`;
     }
 
-    if (response && response.headers && (response.headers['content-type'] === 'text/html' || response.headers['content-type'] === 'text/plain')) {
+    if (response.headers && (response.headers['content-type'] === 'text/html' || response.headers['content-type'] === 'text/plain')) {
       errorMessage = errorMessage.replace(/(<([^>]+)>)/gi, ''); // strip html tags
     }
 
-    if (errorMessage.length > 50) {
-      errorMessage = errorMessage.substr(0, 50) + '...';
+    if (errorMessage.length > 120) {
+      errorMessage = errorMessage.substr(0, 120) + '...';
     }
 
     return {
       status: -1,
-      state: result.state || '',
-      value : result && result.value || null,
-      errorStatus: result && result.status || '',
+      state,
+      code,
+      value,
+      errorStatus: status,
       error : errorMessage,
-      httpStatusCode: response && response.statusCode
+      httpStatusCode: response.statusCode || null
     };
   }
 
diff --git a/lib/transport/selenium3.js b/lib/transport/selenium3.js
@@ -8,6 +8,10 @@ class SeleniumProtocol extends Selenium2 {
     return MethodMappings;
   }
 
+  get defaultPathPrefix() {
+    return '/wd/hub';
+  }
+
   ////////////////////////////////////////////////////////////////////
   // Elements related
   ////////////////////////////////////////////////////////////////////
@@ -19,28 +23,58 @@ class SeleniumProtocol extends Selenium2 {
     return resultValue.ELEMENT;
   }
 
+  formatCommandResponseData(result) {
+    if (!result.value || typeof result.value != 'object') {
+      return;
+    }
+
+    if (result['[[isNightwatch]]']) {
+      delete result['[[isNightwatch]]'];
+
+      return;
+    }
+
+    if (typeof result.value.stackTrace != 'undefined') {
+      delete result.value.stackTrace;
+    }
+  }
+
   handleProtocolError(result, response, screenshotContent) {
-    let errorMessage = response && response.statusCode === 404 ? 'Unknown command' : 'An unknown error has occurred.';
+    result = result || {};
+    response = response || {};
+
+    const {status = '', code = '', message = null, state = '', value = null} = result;
+    const {statusCode = null} = response;
+
+    let errorMessage = response.statusCode === 404 ? 'Unknown command' : 'An unknown error has occurred.';
 
     if (screenshotContent) {
       this.reporter && this.reporter.saveErrorScreenshot(result, screenshotContent);
     }
 
-    if (result && result.value && result.value.message) {
-      errorMessage = result.value.message;
-    } else if (result && result.state && WebdriverErrors.Response[result.state]) {
-      errorMessage = WebdriverErrors.Response[result.state].message;
-    } else if (response && response.status && response.statusMessage) {
+    if (code && message) {
+      errorMessage = `Error ${code}: ${message}`;
+    } else if (value && value.message) {
+      errorMessage = '';
+      if (value.error) {
+        errorMessage = `${value.error} – `;
+      }
+
+      errorMessage += value.message.split('\n')[0];
+    } else if (state && WebdriverErrors.Response[state]) {
+      errorMessage = WebdriverErrors.Response[state].message;
+    } else if (response.status && response.statusMessage) {
       errorMessage += ` ${response.status} ${response.statusMessage}`;
     }
 
     return {
       status: -1,
-      state: result && result.state || '',
-      value : result && result.value || null,
-      errorStatus: result && result.status || '',
+      code,
+      state,
+      value,
+      errorStatus: status,
       error : errorMessage,
-      httpStatusCode: response && response.statusCode || -1
+      httpStatusCode: statusCode
     };
   }
 }
diff --git a/lib/transport/webdriver.js b/lib/transport/webdriver.js
@@ -47,22 +47,35 @@ class WebdriverProtocol extends Transport {
   }
 
   handleProtocolError(result, response = {}) {
-    let errorMessage = response && response.statusCode === 404 ? 'Unknown command' : 'An unknown error has occurred.';
+    result = result || {};
 
-    if (result.value && result.value.message) {
-      errorMessage = result.value.message;
-    } else if (result.value && result.value.error && this.Errors.Response[result.value.error]) {
-      errorMessage = this.Errors.Response[result.value.error].message;
-    } else if (result.error) {
-      errorMessage = result.error;
+    const {status = '', value = null, error, code = '', message = null} = result;
+    const {statusCode = null} = response;
+    let errorMessage;
+
+    // node.js errors
+    if (code && message) {
+      errorMessage = `Error ${code}: ${message}`;
+    } else {
+      // default error message;
+      errorMessage = response && response.statusCode === 404 ? 'Unknown command' : 'An unknown error has occurred.';
+    }
+
+    if (value && value.message) {
+      errorMessage = value.message;
+    } else if (value && value.error && this.Errors.Response[value.error]) {
+      errorMessage = this.Errors.Response[value.error].message;
+    } else if (error) {
+      errorMessage = error;
     }
 
     return {
       status: -1,
-      value : result && result.value || null,
-      errorStatus: result && result.status || '',
-      error : errorMessage,
-      httpStatusCode: response.statusCode
+      value,
+      code,
+      errorStatus: status,
+      error: errorMessage,
+      httpStatusCode: statusCode
     };
   }
 }
diff --git a/lib/utils/index.js b/lib/utils/index.js
@@ -226,6 +226,7 @@ class Utils {
         '(events.js:',
         '(util.js:',
         '(net.js:',
+        '_http_client.js:',
         'process._tickCallback'
       ])) {
         return list;
diff --git a/test/src/transport/testRunProtocolAction.js b/test/src/transport/testRunProtocolAction.js

Original file line number	Diff line number	Diff line change
`@@ -102,6 +102,11 @@ class HttpResponse extends EventEmitter {`
`102`	`102`	`};`
`103`	`103`	`}`
`104`	`104`
	`105`	`+ if (result.value && result.value.stacktrace) {`
	`106`	`+ // this is in order to not pollute verbose logs`
	`107`	`+ result.value.stacktrace = '';`
	`108`	`+ }`
	`109`	`+`
`105`	`110`	`return result;`
`106`	`111`	`}`
`107`	`112`	`}`