feat: enhance stacktraces

package.json

@@ -62,6 +62,7 @@
     "clear-require": "1.0.1",
     "debug": "2.6.9",
     "devtools": "8.21.0",
+    "error-stack-parser": "2.1.4",
     "expect-webdriverio": "3.5.3",
     "fastq": "1.13.0",
     "fs-extra": "5.0.0",
@@ -106,6 +107,7 @@
     "@types/chai": "4.3.4",
     "@types/chai-as-promised": "7.1.5",
     "@types/debug": "4.1.12",
+    "@types/fs-extra": "11.0.4",
     "@types/lodash": "4.14.191",
     "@types/node": "18.19.3",
     "@types/proxyquire": "1.3.28",

src/browser/browser.js

@@ -5,6 +5,7 @@ const _ = require("lodash");
 const { SAVE_HISTORY_MODE } = require("../constants/config");
 const { X_REQUEST_ID_DELIMITER } = require("../constants/browser");
 const history = require("./history");
+const stacktrace = require("./stacktrace");
 const addRunStepCommand = require("./commands/runStep").default;
 
 const CUSTOM_SESSION_OPTS = [
@@ -64,6 +65,10 @@ module.exports = class Browser {
         addRunStepCommand(this);
     }
 
+    _extendStacktrace() {
+        stacktrace.enhanceStacktraces(this._session);
+    }
+
     _addHistory() {
         if (this._config.saveHistoryMode !== SAVE_HISTORY_MODE.NONE) {
             this._callstackHistory = history.initCommandHistory(this._session);

src/browser/commands/clearSession.ts

@@ -1,7 +1,7 @@
 import type { Browser } from "../types";
 import logger from "../../utils/logger";
 
-export default async (browser: Browser): Promise<void> => {
+export default (browser: Browser): void => {
     const { publicAPI: session } = browser;
 
     const clearStorage = async (storageName: "localStorage" | "sessionStorage"): Promise<void> => {

src/browser/commands/moveCursorTo.ts

@@ -29,7 +29,7 @@ const makeMoveCursorToCommand = (session: WebdriverIO.Browser) =>
     };
 
 // TODO: remove after next major version
-export default async (browser: Browser): Promise<void> => {
+export default (browser: Browser): void => {
     const { publicAPI: session } = browser;
 
     session.addCommand("moveCursorTo", makeMoveCursorToCommand(session), true);

src/browser/commands/scrollIntoView.ts

@@ -1,7 +1,7 @@
 import type { Browser } from "../types";
 
 // TODO: remove after fix https://github.com/webdriverio/webdriverio/issues/9620
-export default async (browser: Browser): Promise<void> => {
+export default (browser: Browser): void => {
     const { publicAPI: session } = browser;
 
     session.overwriteCommand(

src/browser/commands/switchToRepl.ts

@@ -8,7 +8,7 @@ import type { Browser } from "../types";
 
 const REPL_LINE_EVENT = "line";
 
-export default async (browser: Browser): Promise<void> => {
+export default (browser: Browser): void => {
     const { publicAPI: session } = browser;
 
     const applyContext = (replServer: repl.REPLServer, ctx: Record<string, unknown> = {}): void => {

src/browser/existing-browser.js

@@ -40,6 +40,7 @@ module.exports = class ExistingBrowser extends Browser {
             this._startCollectingCustomCommands();
         }
 
+        this._extendStacktrace();
         this._addSteps();
         this._addHistory();
 

src/browser/history/utils.js

@@ -53,7 +53,7 @@ exports.runWithHooks = ({ fn, before, after, error }) => {
 
             return value
                 .catch(err => {
-                    error();
+                    error(err);
 
                     throw err;
                 })
@@ -63,7 +63,7 @@ exports.runWithHooks = ({ fn, before, after, error }) => {
         return value;
     } catch (err) {
         if (!isReturnedValuePromise) {
-            error();
+            error(err);
 
             throw err;
         }

src/browser/new-browser.js

@@ -46,6 +46,7 @@ module.exports = class NewBrowser extends Browser {
     async init() {
         this._session = await this._createSession();
 
+        this._extendStacktrace();
         this._addSteps();
         this._addHistory();
 

src/browser/stacktrace/constants.ts

@@ -0,0 +1,8 @@
+export const WDIO_STACK_TRACE_LIMIT = 64;
+export const WDIO_IGNORED_STACK_FUNCTIONS = [
+    "Browser.wrapCommandFn",
+    "Element.wrapCommandFn",
+    "Element.<anonymous>",
+    "Element.newCommand",
+    "Element.elementErrorHandlerCallbackFn",
+];