playwright-bdd/dist/playwright/getLocationInFile.js

BDD Testing with Playwright runner

"use strict";
var __importDefault = (this && this.__importDefault) || function (mod) {
    return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.getLocationInFile = getLocationInFile;
exports.getLocationByOffset = getLocationByOffset;
const url_1 = __importDefault(require("url"));
const utils_1 = require("./utils");
/**
 * Finds first frame in the callstack that matches provided file.
 * Constructs location object from that frame.
 *
 * Example:
 * Calling getLocationInFile('file-3.js');
 * Call stack:
 * - at <anonymous> (file-1.js:1:2)
 * - at myFunction2 (file-2.js:3:4)
 * - at myFunction3 (file-3.js:5:6)
 * - at myFunction4 (file-4.js:7:8)
 *
 * Returned value: { file: 'file-3.js', line: 5, column: 6 }
 */
function getLocationInFile(absFilePath) {
    const absFileUrl = url_1.default.pathToFileURL(absFilePath).toString();
    return getLocationBy((stackFrames) => {
        return stackFrames.find((frame) => {
            const frameFile = frame.getFileName();
            return frameFile === absFilePath || frameFile === absFileUrl;
        });
    });
}
/**
 * Returns location of function call <offset> stack frames upper.
 */
function getLocationByOffset(offset) {
    return getLocationBy((stackFrames) => stackFrames[offset]);
}
/**
 * Iterates stacktrace of the call of this function
 * and finds frame using provided findFrame predicate.
 * Constructs location object from the found frame.
 *
 * This function is based on Playwright's wrapFunctionWithLocation().
 * See: https://github.com/microsoft/playwright/blob/main/packages/playwright/src/transform/transform.ts#L261
 */
function getLocationBy(findFrame) {
    const { sourceMapSupport } = (0, utils_1.requirePlaywrightModule)('lib/utilsBundle.js');
    const oldPrepareStackTrace = Error.prepareStackTrace;
    // modify prepareStackTrace to return Location object instead of string
    Error.prepareStackTrace = (_error, stackFrames) => {
        // useful for debug:
        // const lines = stackFrames.map((frame) => {
        //   const f: NodeJS.CallSite = sourceMapSupport.wrapCallSite(frame);
        //   return `${f.getFileName()}:${f.getLineNumber()}:${f.getColumnNumber()}`;
        // });
        // if (lines.some((l) => l.includes('poms'))) console.log(lines);
        const foundFrame = findFrame(stackFrames);
        if (!foundFrame)
            return { file: '', line: 0, column: 0 };
        const frame = sourceMapSupport.wrapCallSite(foundFrame);
        const fileName = frame.getFileName();
        // Node error stacks for modules use file:// urls instead of paths.
        const file = fileName?.startsWith('file://') ? url_1.default.fileURLToPath(fileName) : fileName;
        return {
            file,
            line: frame.getLineNumber(),
            column: frame.getColumnNumber(),
        };
    };
    // commented stackTraceLImit modification, todo: check if it has perf impact
    // const oldStackTraceLimit = Error.stackTraceLimit;
    // Error.stackTraceLimit = level + 1;
    // eslint-disable-next-line @typescript-eslint/no-explicit-any
    const obj = {};
    Error.captureStackTrace(obj);
    const location = obj.stack;
    // Error.stackTraceLimit = oldStackTraceLimit;
    Error.prepareStackTrace = oldPrepareStackTrace;
    return location;
}
//# sourceMappingURL=getLocationInFile.js.map