@wdio/runner 7.16.16 → 7.17.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wdio/runner",
-  "version": "7.16.16",
+  "version": "7.17.0",
   "description": "A WebdriverIO service that runs tests in arbitrary environments",
   "author": "Christian Bromann <christian@saucelabs.com>",
   "homepage": "https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-runner",
@@ -25,14 +25,14 @@
     "@wdio/config": "7.16.16",
     "@wdio/logger": "7.16.0",
     "@wdio/types": "7.16.14",
-    "@wdio/utils": "7.16.14",
+    "@wdio/utils": "7.17.0",
     "deepmerge": "^4.0.0",
     "gaze": "^1.1.2",
-    "webdriver": "7.16.16",
-    "webdriverio": "7.16.16"
+    "webdriver": "7.17.0",
+    "webdriverio": "7.17.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "10597a2afe43b2f64ed9bf0ddae3f3f77d280047"
+  "gitHead": "e18d2cde6ff979758830bdff4c3bc82ca9818b24"
 }

package/build/index.d.ts

@@ -1,86 +0,0 @@
-/// <reference types="node" />
-import { EventEmitter } from 'events';
-import type { Options, Capabilities } from '@wdio/types';
-/**
- * user types for globals are set in webdriverio
- * putting this here to make compiler happy
- */
-declare global {
-    namespace NodeJS {
-        interface Global {
-            $: any;
-            $$: any;
-            browser: any;
-            driver: any;
-            multiremotebrowser: any;
-        }
-    }
-}
-interface Args extends Partial<Options.Testrunner> {
-    ignoredWorkerServices?: string[];
-    watch?: boolean;
-}
-declare type RunParams = {
-    cid: string;
-    args: Args;
-    specs: string[];
-    caps: Capabilities.RemoteCapability;
-    configFile: string;
-    retries: number;
-};
-declare global {
-    var _HAS_FIBER_CONTEXT: boolean;
-}
-export default class Runner extends EventEmitter {
-    private _configParser;
-    private _sigintWasCalled;
-    private _isMultiremote;
-    private _specFileRetryAttempts;
-    private _reporter?;
-    private _framework?;
-    private _config?;
-    private _cid?;
-    private _specs?;
-    private _caps?;
-    /**
-     * run test suite
-     * @param  {String}    cid            worker id (e.g. `0-0`)
-     * @param  {Object}    args           config arguments passed into worker process
-     * @param  {String[]}  specs          list of spec files to run
-     * @param  {Object}    caps           capabilities to run session with
-     * @param  {String}    configFile     path to config file to get config from
-     * @param  {Number}    retries        number of retries remaining
-     * @return {Promise}                  resolves in number of failures for testrun
-     */
-    run({ cid, args, specs, caps, configFile, retries }: RunParams): Promise<number>;
-    /**
-     * init protocol session
-     * @param  {object}  config        configuration of sessions
-     * @param  {Object}  caps          desired capabilities of session
-     * @param  {Object}  browserStub   stubbed `browser` object with only capabilities, config and env flags
-     * @return {Promise}               resolves with browser object or null if session couldn't get established
-     */
-    private _initSession;
-    /**
-     * start protocol session
-     * @param  {object}  config        configuration of sessions
-     * @param  {Object}  caps          desired capabilities of session
-     * @return {Promise}               resolves with browser object or null if session couldn't get established
-     */
-    private _startSession;
-    /**
-     * fetch logs provided by browser driver
-     */
-    private _fetchDriverLogs;
-    /**
-     * kill worker session
-     */
-    private _shutdown;
-    /**
-     * end WebDriver session, a config object can be applied if object has changed
-     * within a hook by the user
-     */
-    endSession(): Promise<void>;
-}
-export {};
-//# sourceMappingURL=index.d.ts.map

package/build/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAGA,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAA;AAKrC,OAAO,KAAK,EAAE,OAAO,EAAE,YAAY,EAAY,MAAM,aAAa,CAAA;AAalE;;;GAGG;AACH,OAAO,CAAC,MAAM,CAAC;IACX,UAAU,MAAM,CAAC;QACb,UAAU,MAAM;YACZ,CAAC,EAAE,GAAG,CAAA;YACN,EAAE,EAAE,GAAG,CAAA;YACP,OAAO,EAAE,GAAG,CAAA;YACZ,MAAM,EAAE,GAAG,CAAA;YACX,kBAAkB,EAAE,GAAG,CAAA;SAC1B;KACJ;CACJ;AAED,UAAU,IAAK,SAAQ,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC;IAC9C,qBAAqB,CAAC,EAAE,MAAM,EAAE,CAAA;IAChC,KAAK,CAAC,EAAE,OAAO,CAAA;CAClB;AAED,aAAK,SAAS,GAAG;IACb,GAAG,EAAE,MAAM,CAAA;IACX,IAAI,EAAE,IAAI,CAAA;IACV,KAAK,EAAE,MAAM,EAAE,CAAA;IACf,IAAI,EAAE,YAAY,CAAC,gBAAgB,CAAA;IACnC,UAAU,EAAE,MAAM,CAAA;IAClB,OAAO,EAAE,MAAM,CAAA;CAClB,CAAA;AAmBD,OAAO,CAAC,MAAM,CAAC;IACX,IAAI,kBAAkB,EAAE,OAAO,CAAA;CAClC;AAED,MAAM,CAAC,OAAO,OAAO,MAAO,SAAQ,YAAY;IAC5C,OAAO,CAAC,aAAa,CAAqB;IAC1C,OAAO,CAAC,gBAAgB,CAAQ;IAChC,OAAO,CAAC,cAAc,CAAQ;IAC9B,OAAO,CAAC,sBAAsB,CAAI;IAElC,OAAO,CAAC,SAAS,CAAC,CAAc;IAChC,OAAO,CAAC,UAAU,CAAC,CAAe;IAClC,OAAO,CAAC,OAAO,CAAC,CAAoB;IACpC,OAAO,CAAC,IAAI,CAAC,CAAQ;IACrB,OAAO,CAAC,MAAM,CAAC,CAAU;IACzB,OAAO,CAAC,KAAK,CAAC,CAA+B;IAE7C;;;;;;;;;OASG;IACG,GAAG,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,UAAU,EAAE,OAAO,EAAE,EAAE,SAAS;IA0JpE;;;;;;OAMG;YACW,YAAY;IA+C1B;;;;;OAKG;YACW,aAAa;IA0B3B;;OAEG;YACW,gBAAgB;IAoE9B;;OAEG;YACW,SAAS;IAkBvB;;;OAGG;IACG,UAAU;CAmDnB"}

package/build/index.js

@@ -1,366 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const fs_1 = __importDefault(require("fs"));
-const path_1 = __importDefault(require("path"));
-const util_1 = __importDefault(require("util"));
-const events_1 = require("events");
-const logger_1 = __importDefault(require("@wdio/logger"));
-const utils_1 = require("@wdio/utils");
-const config_1 = require("@wdio/config");
-const reporter_1 = __importDefault(require("./reporter"));
-const utils_2 = require("./utils");
-const log = (0, logger_1.default)('@wdio/runner');
-class Runner extends events_1.EventEmitter {
-    constructor() {
-        super(...arguments);
-        this._configParser = new config_1.ConfigParser();
-        this._sigintWasCalled = false;
-        this._isMultiremote = false;
-        this._specFileRetryAttempts = 0;
-    }
-    /**
-     * run test suite
-     * @param  {String}    cid            worker id (e.g. `0-0`)
-     * @param  {Object}    args           config arguments passed into worker process
-     * @param  {String[]}  specs          list of spec files to run
-     * @param  {Object}    caps           capabilities to run session with
-     * @param  {String}    configFile     path to config file to get config from
-     * @param  {Number}    retries        number of retries remaining
-     * @return {Promise}                  resolves in number of failures for testrun
-     */
-    async run({ cid, args, specs, caps, configFile, retries }) {
-        var _a;
-        this._cid = cid;
-        this._specs = specs;
-        this._caps = caps;
-        /**
-         * autocompile after parsing configs so we support ES6 features in tests with config driven by users
-         */
-        if ((_a = args.autoCompileOpts) === null || _a === void 0 ? void 0 : _a.autoCompile) {
-            this._configParser.merge({ autoCompileOpts: args.autoCompileOpts });
-            this._configParser.autoCompile();
-        }
-        /**
-         * add config file
-         */
-        try {
-            this._configParser.addConfigFile(configFile);
-        }
-        catch (err) {
-            return this._shutdown(1, retries);
-        }
-        /**
-         * merge cli arguments again as some might have been overwritten by the config
-         */
-        this._configParser.merge(args);
-        this._config = this._configParser.getConfig();
-        this._specFileRetryAttempts = (this._config.specFileRetries || 0) - (retries || 0);
-        logger_1.default.setLogLevelsConfig(this._config.logLevels, this._config.logLevel);
-        const isMultiremote = this._isMultiremote = !Array.isArray(this._configParser.getCapabilities());
-        /**
-         * create `browser` stub only if `specFiltering` feature is enabled
-         */
-        let browser = await this._startSession({
-            ...this._config,
-            // @ts-ignore used in `/packages/webdriverio/src/protocol-stub.ts`
-            _automationProtocol: this._config.automationProtocol,
-            automationProtocol: './protocol-stub'
-        }, caps);
-        /**
-         * run `beforeSession` command before framework and browser are initiated
-         */
-        (0, utils_1.initialiseWorkerService)(this._config, caps, args.ignoredWorkerServices).map(this._configParser.addService.bind(this._configParser));
-        const beforeSessionParams = [this._config, this._caps, this._specs, this._cid];
-        await (0, utils_1.executeHooksWithArgs)('beforeSession', this._config.beforeSession, beforeSessionParams);
-        this._reporter = new reporter_1.default(this._config, this._cid, { ...caps });
-        /**
-         * initialise framework
-         */
-        this._framework = (0, utils_1.initialisePlugin)(this._config.framework, 'framework').default;
-        this._framework = await this._framework.init(cid, this._config, specs, caps, this._reporter);
-        process.send({ name: 'testFrameworkInit', content: { cid, caps, specs, hasTests: this._framework.hasTests() } });
-        if (!this._framework.hasTests()) {
-            return this._shutdown(0, retries);
-        }
-        browser = await this._initSession(this._config, this._caps, browser);
-        /**
-         * return if session initialisation failed
-         */
-        if (!browser) {
-            const afterArgs = [1, this._caps, this._specs];
-            await (0, utils_1.executeHooksWithArgs)('after', this._config.after, afterArgs);
-            return this._shutdown(1, retries);
-        }
-        this._reporter.caps = browser.capabilities;
-        const beforeArgs = [this._caps, this._specs, browser];
-        await (0, utils_1.executeHooksWithArgs)('before', this._config.before, beforeArgs);
-        /**
-         * kill session of SIGINT signal showed up while trying to
-         * get a session ID
-         */
-        if (this._sigintWasCalled) {
-            log.info('SIGINT signal detected while starting session, shutting down...');
-            await this.endSession();
-            return this._shutdown(0, retries);
-        }
-        /**
-         * initialisation successful, send start message
-         */
-        const multiRemoteBrowser = browser;
-        this._reporter.emit('runner:start', {
-            cid,
-            specs,
-            config: browser.options,
-            isMultiremote,
-            instanceOptions: isMultiremote
-                ? multiRemoteBrowser.instances.reduce((prev, browserName) => {
-                    prev[multiRemoteBrowser[browserName].sessionId] = multiRemoteBrowser[browserName].options;
-                    return prev;
-                }, {})
-                : {
-                    [browser.sessionId]: browser.options
-                },
-            sessionId: browser.sessionId,
-            capabilities: isMultiremote
-                ? multiRemoteBrowser.instances.reduce((caps, browserName) => {
-                    caps[browserName] = multiRemoteBrowser[browserName].capabilities;
-                    caps[browserName].sessionId = multiRemoteBrowser[browserName].sessionId;
-                    return caps;
-                }, {})
-                : { ...browser.capabilities, sessionId: browser.sessionId },
-            retry: this._specFileRetryAttempts
-        });
-        /**
-         * report sessionId and target connection information to worker
-         */
-        const { protocol, hostname, port, path, queryParams } = browser.options;
-        const { isW3C, sessionId } = browser;
-        const instances = (0, utils_2.getInstancesData)(browser, isMultiremote);
-        process.send({
-            origin: 'worker',
-            name: 'sessionStarted',
-            content: { sessionId, isW3C, protocol, hostname, port, path, queryParams, isMultiremote, instances }
-        });
-        /**
-         * kick off tests in framework
-         */
-        let failures = 0;
-        try {
-            failures = await this._framework.run();
-            await this._fetchDriverLogs(this._config, caps.excludeDriverLogs);
-        }
-        catch (err) {
-            log.error(err);
-            this.emit('error', err);
-            failures = 1;
-        }
-        /**
-         * in watch mode we don't close the session and leave current page opened
-         */
-        if (!args.watch) {
-            await this.endSession();
-        }
-        return this._shutdown(failures, retries);
-    }
-    /**
-     * init protocol session
-     * @param  {object}  config        configuration of sessions
-     * @param  {Object}  caps          desired capabilities of session
-     * @param  {Object}  browserStub   stubbed `browser` object with only capabilities, config and env flags
-     * @return {Promise}               resolves with browser object or null if session couldn't get established
-     */
-    async _initSession(config, caps, browserStub) {
-        const browser = await this._startSession(config, caps);
-        // return null if session couldn't get established
-        if (!browser) {
-            return;
-        }
-        // add flags declared by user to browser object
-        if (browserStub) {
-            Object.entries(browserStub).forEach(([key, value]) => {
-                if (typeof browser[key] === 'undefined') {
-                    // @ts-ignore allow to set value for undefined props
-                    browser[key] = value;
-                }
-            });
-        }
-        /**
-         * register global helper method to fetch elements
-         */
-        // @ts-ignore
-        global.$ = (selector) => browser.$(selector);
-        // @ts-ignore
-        global.$$ = (selector) => browser.$$(selector);
-        /**
-         * register command event
-         */
-        browser.on('command', (command) => {
-            var _a;
-            return (_a = this._reporter) === null || _a === void 0 ? void 0 : _a.emit('client:beforeCommand', Object.assign(command, { sessionId: browser.sessionId }));
-        });
-        /**
-         * register result event
-         */
-        browser.on('result', (result) => {
-            var _a;
-            return (_a = this._reporter) === null || _a === void 0 ? void 0 : _a.emit('client:afterCommand', Object.assign(result, { sessionId: browser.sessionId }));
-        });
-        return browser;
-    }
-    /**
-     * start protocol session
-     * @param  {object}  config        configuration of sessions
-     * @param  {Object}  caps          desired capabilities of session
-     * @return {Promise}               resolves with browser object or null if session couldn't get established
-     */
-    async _startSession(config, caps) {
-        let browser;
-        try {
-            // @ts-ignore
-            browser = global.browser = global.driver = await (0, utils_2.initialiseInstance)(config, caps, this._isMultiremote);
-            /**
-             * attach browser to `multiremotebrowser` so user have better typing support
-             */
-            if (this._isMultiremote) {
-                // @ts-ignore
-                global.multiremotebrowser = browser;
-            }
-        }
-        catch (err) {
-            log.error(err);
-            return;
-        }
-        browser.config = config;
-        return browser;
-    }
-    /**
-     * fetch logs provided by browser driver
-     */
-    async _fetchDriverLogs(config, excludeDriverLogs) {
-        /**
-         * only fetch logs if
-         */
-        if (
-        /**
-         * a log directory is given in config
-         */
-        !config.outputDir ||
-            /**
-             * the session wasn't killed during start up phase
-             */
-            !global.browser.sessionId ||
-            /**
-             * driver supports it
-             */
-            typeof global.browser.getLogs === 'undefined') {
-            return;
-        }
-        /**
-         * suppress @wdio/sync warnings of not running commands inside of
-         * a Fibers context
-         */
-        global._HAS_FIBER_CONTEXT = true;
-        let logTypes;
-        try {
-            logTypes = await global.browser.getLogTypes();
-        }
-        catch (errIgnored) {
-            /**
-             * getLogTypes is not supported by browser
-             */
-            return;
-        }
-        logTypes = (0, utils_2.filterLogTypes)(excludeDriverLogs, logTypes);
-        log.debug(`Fetching logs for ${logTypes.join(', ')}`);
-        return Promise.all(logTypes.map(async (logType) => {
-            let logs;
-            try {
-                logs = await global.browser.getLogs(logType);
-            }
-            catch (e) {
-                return log.warn(`Couldn't fetch logs for ${logType}: ${e.message}`);
-            }
-            /**
-             * don't write to file if no logs were captured
-             */
-            if (logs.length === 0) {
-                return;
-            }
-            const stringLogs = logs.map((log) => JSON.stringify(log)).join('\n');
-            return util_1.default.promisify(fs_1.default.writeFile)(path_1.default.join(config.outputDir, `wdio-${this._cid}-${logType}.log`), stringLogs, 'utf-8');
-        }));
-    }
-    /**
-     * kill worker session
-     */
-    async _shutdown(failures, retries) {
-        this._reporter.emit('runner:end', {
-            failures,
-            cid: this._cid,
-            retries
-        });
-        try {
-            await this._reporter.waitForSync();
-        }
-        catch (err) {
-            log.error(err);
-        }
-        this.emit('exit', failures === 0 ? 0 : 1);
-        return failures;
-    }
-    /**
-     * end WebDriver session, a config object can be applied if object has changed
-     * within a hook by the user
-     */
-    async endSession() {
-        /**
-         * make sure instance(s) exist and have `sessionId`
-         */
-        const multiremoteBrowser = global.browser;
-        const hasSessionId = Boolean(global.browser) && (this._isMultiremote
-            /**
-             * every multiremote instance should exist and should have `sessionId`
-             */
-            ? !multiremoteBrowser.instances.some(i => multiremoteBrowser[i] && !multiremoteBrowser[i].sessionId)
-            /**
-             * browser object should have `sessionId` in regular mode
-             */
-            : global.browser.sessionId);
-        /**
-         * don't do anything if test framework returns after SIGINT
-         * if endSession is called without payload we expect a session id
-         */
-        if (!hasSessionId) {
-            return;
-        }
-        /**
-         * store capabilities for afterSession hook
-         */
-        const capabilities = global.browser.capabilities || {};
-        if (this._isMultiremote) {
-            multiremoteBrowser.instances.forEach((browserName) => {
-                capabilities[browserName] = multiremoteBrowser[browserName].capabilities;
-            });
-        }
-        await global.browser.deleteSession();
-        /**
-         * delete session(s)
-         */
-        if (this._isMultiremote) {
-            multiremoteBrowser.instances.forEach(i => {
-                // @ts-ignore sessionId is usually required
-                delete multiremoteBrowser[i].sessionId;
-            });
-        }
-        else {
-            // @ts-ignore sessionId is usually required
-            delete global.browser.sessionId;
-        }
-        const afterSessionArgs = [this._config, capabilities, this._specs];
-        await (0, utils_1.executeHooksWithArgs)('afterSession', global.browser.config.afterSession, afterSessionArgs);
-    }
-}
-exports.default = Runner;

package/build/reporter.d.ts

@@ -1,37 +0,0 @@
-import type { Options, Capabilities, Reporters } from '@wdio/types';
-/**
- * BaseReporter
- * responsible for initialising reporters for every testrun and propagating events
- * to all these reporters
- */
-export default class BaseReporter {
-    private _config;
-    private _cid;
-    caps: Capabilities.RemoteCapability;
-    private _reporters;
-    constructor(_config: Options.Testrunner, _cid: string, caps: Capabilities.RemoteCapability);
-    /**
-     * emit events to all registered reporter and wdio launcer
-     *
-     * @param  {String} e       event name
-     * @param  {object} payload event payload
-     */
-    emit(e: string, payload: any): void;
-    getLogFile(name: string): string | undefined;
-    /**
-     * return write stream object based on reporter name
-     */
-    getWriteStreamObject(reporter: string): {
-        write: (content: unknown) => boolean;
-    };
-    /**
-     * wait for reporter to finish synchronization, e.g. when sending data asynchronous
-     * to a server (e.g. sumo reporter)
-     */
-    waitForSync(): Promise<unknown>;
-    /**
-     * initialise reporters
-     */
-    initReporter(reporter: Reporters.ReporterEntry): Reporters.ReporterInstance;
-}
-//# sourceMappingURL=reporter.d.ts.map

package/build/reporter.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"reporter.d.ts","sourceRoot":"","sources":["../src/reporter.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAMnE;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,YAAY;IAIzB,OAAO,CAAC,OAAO;IACf,OAAO,CAAC,IAAI;IACL,IAAI,EAAE,YAAY,CAAC,gBAAgB;IAL9C,OAAO,CAAC,UAAU,CAA8B;gBAGpC,OAAO,EAAE,OAAO,CAAC,UAAU,EAC3B,IAAI,EAAE,MAAM,EACb,IAAI,EAAE,YAAY,CAAC,gBAAgB;IAM9C;;;;;OAKG;IACH,IAAI,CAAE,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG;IAW7B,UAAU,CAAE,IAAI,EAAE,MAAM;IAoCxB;;OAEG;IACH,oBAAoB,CAAE,QAAQ,EAAE,MAAM;yBAEc,OAAO;;IAQ3D;;;OAGG;IACH,WAAW;IA2BX;;OAEG;IACH,YAAY,CAAE,QAAQ,EAAE,SAAS,CAAC,aAAa;CAgElD"}

package/build/reporter.js

@@ -1,165 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const path_1 = __importDefault(require("path"));
-const logger_1 = __importDefault(require("@wdio/logger"));
-const utils_1 = require("@wdio/utils");
-const utils_2 = require("./utils");
-const log = (0, logger_1.default)('@wdio/runner');
-/**
- * BaseReporter
- * responsible for initialising reporters for every testrun and propagating events
- * to all these reporters
- */
-class BaseReporter {
-    constructor(_config, _cid, caps) {
-        this._config = _config;
-        this._cid = _cid;
-        this.caps = caps;
-        // ensure all properties are set before initializing the reporters
-        this._reporters = this._config.reporters.map(this.initReporter.bind(this));
-    }
-    /**
-     * emit events to all registered reporter and wdio launcer
-     *
-     * @param  {String} e       event name
-     * @param  {object} payload event payload
-     */
-    emit(e, payload) {
-        payload.cid = this._cid;
-        /**
-         * Send failure message (only once) in case of test or hook failure
-         */
-        (0, utils_2.sendFailureMessage)(e, payload);
-        this._reporters.forEach((reporter) => reporter.emit(e, payload));
-    }
-    getLogFile(name) {
-        // clone the config to avoid changing original properties
-        let options = Object.assign({}, this._config);
-        let filename = `wdio-${this._cid}-${name}-reporter.log`;
-        const reporterOptions = this._config.reporters.find((reporter) => (Array.isArray(reporter) &&
-            (reporter[0] === name ||
-                typeof reporter[0] === 'function' && reporter[0].name === name)));
-        if (reporterOptions) {
-            const fileformat = reporterOptions[1].outputFileFormat;
-            options.cid = this._cid;
-            options.capabilities = this.caps;
-            Object.assign(options, reporterOptions[1]);
-            if (fileformat) {
-                if (typeof fileformat !== 'function') {
-                    throw new Error('outputFileFormat must be a function');
-                }
-                filename = fileformat(options);
-            }
-        }
-        if (!options.outputDir) {
-            return;
-        }
-        return path_1.default.join(options.outputDir, filename);
-    }
-    /**
-     * return write stream object based on reporter name
-     */
-    getWriteStreamObject(reporter) {
-        return {
-            write: /* istanbul ignore next */ (content) => process.send({
-                origin: 'reporter',
-                name: reporter,
-                content
-            })
-        };
-    }
-    /**
-     * wait for reporter to finish synchronization, e.g. when sending data asynchronous
-     * to a server (e.g. sumo reporter)
-     */
-    waitForSync() {
-        const startTime = Date.now();
-        return new Promise((resolve, reject) => {
-            const interval = setInterval(() => {
-                const unsyncedReporter = this._reporters
-                    .filter((reporter) => !reporter.isSynchronised)
-                    .map((reporter) => reporter.constructor.name);
-                if ((Date.now() - startTime) > this._config.reporterSyncTimeout && unsyncedReporter.length) {
-                    clearInterval(interval);
-                    return reject(new Error(`Some reporters are still unsynced: ${unsyncedReporter.join(', ')}`));
-                }
-                /**
-                 * no reporter are in need to sync anymore, continue
-                 */
-                if (!unsyncedReporter.length) {
-                    clearInterval(interval);
-                    return resolve(true);
-                }
-                log.info(`Wait for ${unsyncedReporter.length} reporter to synchronise`);
-                // wait otherwise
-            }, this._config.reporterSyncInterval);
-        });
-    }
-    /**
-     * initialise reporters
-     */
-    initReporter(reporter) {
-        let ReporterClass;
-        let options = {};
-        /**
-         * check if reporter has custom options
-         */
-        if (Array.isArray(reporter)) {
-            options = Object.assign({}, options, reporter[1]);
-            reporter = reporter[0];
-        }
-        /**
-         * check if reporter was passed in from a file, e.g.
-         *
-         * ```js
-         * const MyCustomReporter = require('/some/path/MyCustomReporter.js')
-         * export.config = {
-         *     //...
-         *     reporters: [
-         *         MyCustomReporter, // or
-         *         [MyCustomReporter, { custom: 'option' }]
-         *     ]
-         *     //...
-         * }
-         * ```
-         */
-        if (typeof reporter === 'function') {
-            ReporterClass = reporter;
-            options.logFile = options.setLogFile
-                ? options.setLogFile(this._cid, ReporterClass.name)
-                : this.getLogFile(ReporterClass.name);
-            options.writeStream = this.getWriteStreamObject(ReporterClass.name);
-            return new ReporterClass(options);
-        }
-        /**
-         * check if reporter is a node package, e.g. wdio-dot reporter
-         *
-         * ```js
-         * export.config = {
-         *     //...
-         *     reporters: [
-         *         'dot', // or
-         *         ['dot', { custom: 'option' }]
-         *     ]
-         *     //...
-         * }
-         * ```
-         */
-        if (typeof reporter === 'string') {
-            ReporterClass = (0, utils_1.initialisePlugin)(reporter, 'reporter').default;
-            options.logFile = options.setLogFile
-                ? options.setLogFile(this._cid, reporter)
-                : this.getLogFile(reporter);
-            options.writeStream = this.getWriteStreamObject(reporter);
-            return new ReporterClass(options);
-        }
-        /**
-         * throw error if reporter property was invalid
-         */
-        throw new Error('Invalid reporters config');
-    }
-}
-exports.default = BaseReporter;

package/build/utils.d.ts

@@ -1,51 +0,0 @@
-import type { Options, Capabilities } from '@wdio/types';
-import type { Browser, MultiRemoteBrowser } from 'webdriverio';
-export interface ConfigWithSessionId extends Omit<Options.Testrunner, 'capabilities'> {
-    sessionId?: string;
-    capabilities: Capabilities.RemoteCapability;
-}
-/**
- * sanitizes wdio config from capability properties
- * @param  {Object} caps  desired session capabilities
- * @return {Object}       sanitized caps
- */
-export declare function sanitizeCaps(caps: Capabilities.RemoteCapability, filterOut?: boolean): Omit<Capabilities.RemoteCapability, 'logLevel'>;
-/**
- * initialise browser instance depending whether remote or multiremote is requested
- * @param  {Object}  config        configuration of sessions
- * @param  {Object}  capabilities  desired session capabilities
- * @param  {boolean} isMultiremote isMultiremote
- * @return {Promise}               resolves with browser object
- */
-export declare function initialiseInstance(config: ConfigWithSessionId, capabilities: Capabilities.RemoteCapability, isMultiremote?: boolean): Promise<Browser<'async'> | MultiRemoteBrowser<'async'>>;
-/**
- * Filter logTypes based on filter
- * @param  {string[]} excludeDriverLogs logTypes filter
- * @param  {string[]} driverLogTypes    available driver log types
- * @return {string[]}                   logTypes
- */
-export declare function filterLogTypes(excludeDriverLogs: string[], driverLogTypes: string[]): string[];
-/**
- * Send event to WDIOCLInterface if test or before/after all hook failed
- * @param {string} e        event
- * @param {object} payload  payload
- */
-export declare function sendFailureMessage(e: string, payload: any): void;
-declare type BrowserData = {
-    sessionId: string;
-    isW3C: boolean;
-    protocol: string;
-    hostname: string;
-    port: number;
-    path: string;
-    queryParams: Record<string, string>;
-};
-/**
- * Gets { sessionId, isW3C, protocol, hostname, port, path, queryParams } of every Multiremote instance
- * @param {object} browser browser
- * @param {boolean} isMultiremote isMultiremote
- * @return {object}
- */
-export declare function getInstancesData(browser: Browser<'async'> | MultiRemoteBrowser<'async'>, isMultiremote: boolean): Record<string, Partial<BrowserData>> | undefined;
-export {};
-//# sourceMappingURL=utils.d.ts.map

package/build/utils.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AACxD,OAAO,KAAK,EAAE,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAA;AAO9D,MAAM,WAAW,mBAAoB,SAAQ,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,cAAc,CAAC;IACjF,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,YAAY,CAAC,gBAAgB,CAAA;CAC9C;AAED;;;;GAIG;AACH,wBAAgB,YAAY,CACxB,IAAI,EAAE,YAAY,CAAC,gBAAgB,EACnC,SAAS,CAAC,EAAE,OAAO,GACpB,IAAI,CAAC,YAAY,CAAC,gBAAgB,EAAE,UAAU,CAAC,CAoBjD;AAED;;;;;;GAMG;AACH,wBAAsB,kBAAkB,CACpC,MAAM,EAAE,mBAAmB,EAC3B,YAAY,EAAE,YAAY,CAAC,gBAAgB,EAC3C,aAAa,CAAC,EAAE,OAAO,GACxB,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,kBAAkB,CAAC,OAAO,CAAC,CAAC,CA4CzD;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAC1B,iBAAiB,EAAE,MAAM,EAAE,EAC3B,cAAc,EAAE,MAAM,EAAE,YAiB3B;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,QAezD;AAED,aAAK,WAAW,GAAG;IACf,SAAS,EAAE,MAAM,CAAA;IACjB,KAAK,EAAE,OAAO,CAAA;IACd,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CACtC,CAAA;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAC5B,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG,kBAAkB,CAAC,OAAO,CAAC,EACvD,aAAa,EAAE,OAAO,oDAgBzB"}

package/build/utils.js

@@ -1,139 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getInstancesData = exports.sendFailureMessage = exports.filterLogTypes = exports.initialiseInstance = exports.sanitizeCaps = void 0;
-const deepmerge_1 = __importDefault(require("deepmerge"));
-const logger_1 = __importDefault(require("@wdio/logger"));
-const webdriverio_1 = require("webdriverio");
-const webdriver_1 = require("webdriver");
-const config_1 = require("@wdio/config");
-const log = (0, logger_1.default)('@wdio/local-runner:utils');
-const MERGE_OPTIONS = { clone: false };
-const mochaAllHooks = ['"before all" hook', '"after all" hook'];
-/**
- * sanitizes wdio config from capability properties
- * @param  {Object} caps  desired session capabilities
- * @return {Object}       sanitized caps
- */
-function sanitizeCaps(caps, filterOut) {
-    const defaultConfigsKeys = [
-        // WDIO config keys
-        ...Object.keys((0, config_1.DEFAULT_CONFIGS)()),
-        // WebDriver config keys
-        ...Object.keys(webdriver_1.DEFAULTS)
-    ];
-    return Object.keys(caps).filter((key) => (
-    /**
-     * filter out all wdio config keys
-     */
-    !defaultConfigsKeys.includes(key) === !filterOut)).reduce((obj, key) => {
-        obj[key] = caps[key];
-        return obj;
-    }, {});
-}
-exports.sanitizeCaps = sanitizeCaps;
-/**
- * initialise browser instance depending whether remote or multiremote is requested
- * @param  {Object}  config        configuration of sessions
- * @param  {Object}  capabilities  desired session capabilities
- * @param  {boolean} isMultiremote isMultiremote
- * @return {Promise}               resolves with browser object
- */
-async function initialiseInstance(config, capabilities, isMultiremote) {
-    /**
-     * check if config has sessionId and attach it to a running session if so
-     */
-    if (config.sessionId) {
-        log.debug(`attach to session with id ${config.sessionId}`);
-        config.capabilities = sanitizeCaps(capabilities);
-        /**
-         * propagate connection details defined by services or user in capabilities
-         */
-        const { protocol, hostname, port, path } = capabilities;
-        return (0, webdriverio_1.attach)({ ...config, ...{ protocol, hostname, port, path } });
-    }
-    if (!isMultiremote) {
-        log.debug('init remote session');
-        const sessionConfig = {
-            ...config,
-            ...sanitizeCaps(capabilities, true),
-            capabilities: sanitizeCaps(capabilities)
-        };
-        return (0, webdriverio_1.remote)(sessionConfig);
-    }
-    const options = {};
-    log.debug('init multiremote session');
-    // @ts-expect-error ToDo(Christian): can be removed?
-    delete config.capabilities;
-    for (let browserName of Object.keys(capabilities)) {
-        options[browserName] = (0, deepmerge_1.default)(config, capabilities[browserName], MERGE_OPTIONS);
-    }
-    const browser = await (0, webdriverio_1.multiremote)(options, config);
-    for (let browserName of Object.keys(capabilities)) {
-        // @ts-ignore allow random global browser names
-        global[browserName] = browser[browserName];
-    }
-    return browser;
-}
-exports.initialiseInstance = initialiseInstance;
-/**
- * Filter logTypes based on filter
- * @param  {string[]} excludeDriverLogs logTypes filter
- * @param  {string[]} driverLogTypes    available driver log types
- * @return {string[]}                   logTypes
- */
-function filterLogTypes(excludeDriverLogs, driverLogTypes) {
-    let logTypes = [...driverLogTypes];
-    if (Array.isArray(excludeDriverLogs)) {
-        log.debug('filtering logTypes', logTypes);
-        if (excludeDriverLogs.length === 1 && excludeDriverLogs[0] === '*') { // exclude all logTypes
-            logTypes = [];
-        }
-        else {
-            logTypes = logTypes.filter(x => !excludeDriverLogs.includes(x)); // exclude specific logTypes
-        }
-        log.debug('filtered logTypes', logTypes);
-    }
-    return logTypes;
-}
-exports.filterLogTypes = filterLogTypes;
-/**
- * Send event to WDIOCLInterface if test or before/after all hook failed
- * @param {string} e        event
- * @param {object} payload  payload
- */
-function sendFailureMessage(e, payload) {
-    if (e === 'test:fail' ||
-        (e === 'hook:end' &&
-            payload.error &&
-            mochaAllHooks.some(hook => payload.title.startsWith(hook)))) {
-        process.send({
-            origin: 'reporter',
-            name: 'printFailureMessage',
-            content: payload
-        });
-    }
-}
-exports.sendFailureMessage = sendFailureMessage;
-/**
- * Gets { sessionId, isW3C, protocol, hostname, port, path, queryParams } of every Multiremote instance
- * @param {object} browser browser
- * @param {boolean} isMultiremote isMultiremote
- * @return {object}
- */
-function getInstancesData(browser, isMultiremote) {
-    if (!isMultiremote) {
-        return;
-    }
-    const multiRemoteBrowser = browser;
-    const instances = {};
-    multiRemoteBrowser.instances.forEach((browserName) => {
-        const { protocol, hostname, port, path, queryParams } = multiRemoteBrowser[browserName].options;
-        const { isW3C, sessionId } = multiRemoteBrowser[browserName];
-        instances[browserName] = { sessionId, isW3C, protocol, hostname, port, path, queryParams };
-    });
-    return instances;
-}
-exports.getInstancesData = getInstancesData;