matman/lib/index.js

"use strict";
var __importDefault = (this && this.__importDefault) || function (mod) {
    return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.getLocalWhistleServer = exports.launchSync = exports.launch = void 0;
const fs_1 = __importDefault(require("fs"));
const matman_core_1 = require("matman-core");
const lodash_1 = __importDefault(require("lodash"));
const PageDriverSync_1 = __importDefault(require("./model/PageDriverSync"));
const PageDriverAsync_1 = __importDefault(require("./model/PageDriverAsync"));
const caller_1 = require("./util/caller");
const whistle_1 = require("./util/whistle");
/**
 * 获取新的 PageDriverOpts
 *
 * @param {PageDriverOpts} opts
 */
function getPageDriverOpts(opts) {
    const pageDriverOpts = lodash_1.default.merge({}, opts);
    let { caseModuleFilePath } = pageDriverOpts;
    // 特殊处理 caseModuleFilePath，如果没有，则自动获取
    if (!caseModuleFilePath || !fs_1.default.existsSync(caseModuleFilePath)) {
        // 注意，这里会有一些局限：假如使用者将该方法放在公共文件里面，则获取的值将会是同一个
        // 此时，需要手动定义并传入 caseModuleFilePath 来规避
        caseModuleFilePath = caller_1.getCallerPath();
        // 如果无法获得 caseModuleFilePath，则直接抛出错误
        if (!caseModuleFilePath || !fs_1.default.existsSync(caseModuleFilePath)) {
            throw new Error(`Could not find caseModuleFilePath!`);
        }
        // 更新
        pageDriverOpts.caseModuleFilePath = caseModuleFilePath;
    }
    // 自动计算是哪个文件在调用 case 脚本，然后以调用者的文件名来做标记
    // 由于调用者脚本本身已经按目录存储，且同一个目录中不同调用者脚本文件名肯定不一样
    // 这样就能够区分标记了
    if (!pageDriverOpts.tag) {
        pageDriverOpts.tag = caller_1.getCallerPath(caseModuleFilePath);
    }
    // 如果标签就是 case 文件本身路径，则清空，否则就会造成生成的文件名重叠
    if (pageDriverOpts.tag === caseModuleFilePath) {
        pageDriverOpts.tag = '';
    }
    return pageDriverOpts;
}
/**
 * 获得同步的 PageDriver
 *
 * @param {BrowserRunner} browserRunner 浏览器运行器，目前支持 puppeteer 和 nightmare 两种
 * @param {PageDriverOpts} pageDriverOpts
 * @param {MatmanConfigOpts} matmanConfigOpts
 */
function launch(browserRunner, pageDriverOpts, matmanConfigOpts) {
    // 处理下原始传入的 pageDriverOpts，部分设置默认值
    const newPageDriverOpts = getPageDriverOpts(pageDriverOpts);
    // 查找 matman config
    const matmanConfig = matman_core_1.findMatmanConfig(newPageDriverOpts.caseModuleFilePath, matmanConfigOpts);
    // matman config 必须得存在
    if (!matmanConfig) {
        throw new Error(`Could not find ${matman_core_1.MATMAN_CONFIG_FILE} or matman config setting!`);
    }
    // console.log('newPageDriverOpts', newPageDriverOpts);
    // console.log('matmanConfig', matmanConfig);
    return new PageDriverAsync_1.default(browserRunner, matmanConfig, newPageDriverOpts);
}
exports.launch = launch;
/**
 * 获得同步的 PageDriver
 *
 * @param {BrowserRunner} browserRunner 浏览器运行器，目前支持 puppeteer 和 nightmare 两种
 * @param {PageDriverOpts} pageDriverOpts
 * @param {MatmanConfigOpts} matmanConfigOpts
 */
function launchSync(browserRunner, pageDriverOpts, matmanConfigOpts) {
    // 处理下原始传入的 pageDriverOpts，部分设置默认值
    const newPageDriverOpts = getPageDriverOpts(pageDriverOpts);
    // 查找 matman config
    const matmanConfig = matman_core_1.findMatmanConfig(newPageDriverOpts.caseModuleFilePath, matmanConfigOpts);
    // matman config 必须得存在
    if (!matmanConfig) {
        throw new Error(`Could not find ${matman_core_1.MATMAN_CONFIG_FILE} or matman config setting!`);
    }
    // console.log('newPageDriverOpts', newPageDriverOpts);
    // console.log('matmanConfig', matmanConfig);
    return new PageDriverSync_1.default(browserRunner, matmanConfig, newPageDriverOpts);
}
exports.launchSync = launchSync;
/**
 * 获得本地 whistle 地址
 *
 * @param {Number} port 指定端口
 * @param {Boolean} doNotAutoCheckStartedPort 不需要自动获得已经启动的端口
 */
async function getLocalWhistleServer(port, doNotAutoCheckStartedPort) {
    // process.env.WHISTLE_PORT 该值拥有最高优先级，主要用于自动化测试场景
    if (process.env.WHISTLE_PORT) {
        return `127.0.0.1:${process.env.WHISTLE_PORT}`;
    }
    let whisltePort;
    if (!doNotAutoCheckStartedPort) {
        try {
            whisltePort = await whistle_1.checkIfWhistleStarted();
        }
        catch (e) {
            if (process.env.IS_DEV === '1') {
                console.log('checkIfWhistleStarted() catch', e);
            }
        }
    }
    if (!whisltePort) {
        // whistle 默认的端口号为 8899
        whisltePort = port || 8899;
    }
    return `127.0.0.1:${whisltePort}`;
}
exports.getLocalWhistleServer = getLocalWhistleServer;