@wdio/browserstack-service 9.0.0-alpha.78 → 9.0.0

package/build/crash-reporter.js

@@ -1,138 +0,0 @@
-import { BSTACK_SERVICE_VERSION, DATA_ENDPOINT, TESTOPS_BUILD_ID_ENV } from './constants.js';
-import { DEFAULT_REQUEST_CONFIG, getObservabilityKey, getObservabilityUser } from './util.js';
-import { BStackLogger } from './bstackLogger.js';
-export default class CrashReporter {
-    /* User test config for build run minus PII */
-    static userConfigForReporting = {};
-    /* User credentials used for reporting crashes in browserstack service */
-    static credentialsForCrashReportUpload = {};
-    static setCredentialsForCrashReportUpload(options, config) {
-        this.credentialsForCrashReportUpload = {
-            username: getObservabilityUser(options, config),
-            password: getObservabilityKey(options, config)
-        };
-        process.env.CREDENTIALS_FOR_CRASH_REPORTING = JSON.stringify(this.credentialsForCrashReportUpload);
-    }
-    static setConfigDetails(userConfig, capabilities, options) {
-        const configWithoutPII = this.filterPII(userConfig);
-        const filteredCapabilities = this.filterCapabilities(capabilities);
-        this.userConfigForReporting = {
-            framework: userConfig.framework,
-            services: configWithoutPII.services,
-            capabilities: filteredCapabilities,
-            env: {
-                'BROWSERSTACK_BUILD': process.env.BROWSERSTACK_BUILD,
-                'BROWSERSTACK_BUILD_NAME': process.env.BROWSERSTACK_BUILD_NAME,
-                'BUILD_TAG': process.env.BUILD_TAG
-            }
-        };
-        process.env.USER_CONFIG_FOR_REPORTING = JSON.stringify(this.userConfigForReporting);
-        this.setCredentialsForCrashReportUpload(options, userConfig);
-    }
-    static async uploadCrashReport(exception, stackTrace) {
-        try {
-            if (!this.credentialsForCrashReportUpload.username || !this.credentialsForCrashReportUpload.password) {
-                this.credentialsForCrashReportUpload = process.env.CREDENTIALS_FOR_CRASH_REPORTING !== undefined ? JSON.parse(process.env.CREDENTIALS_FOR_CRASH_REPORTING) : this.credentialsForCrashReportUpload;
-            }
-        }
-        catch (error) {
-            return BStackLogger.error(`[Crash_Report_Upload] Failed to parse user credentials while reporting crash due to ${error}`);
-        }
-        if (!this.credentialsForCrashReportUpload.username || !this.credentialsForCrashReportUpload.password) {
-            return BStackLogger.error('[Crash_Report_Upload] Failed to parse user credentials while reporting crash');
-        }
-        try {
-            if (Object.keys(this.userConfigForReporting).length === 0) {
-                this.userConfigForReporting = process.env.USER_CONFIG_FOR_REPORTING !== undefined ? JSON.parse(process.env.USER_CONFIG_FOR_REPORTING) : {};
-            }
-        }
-        catch (error) {
-            BStackLogger.error(`[Crash_Report_Upload] Failed to parse user config while reporting crash due to ${error}`);
-            this.userConfigForReporting = {};
-        }
-        const data = {
-            hashed_id: process.env[TESTOPS_BUILD_ID_ENV],
-            observability_version: {
-                frameworkName: 'WebdriverIO-' + (this.userConfigForReporting.framework || 'null'),
-                sdkVersion: BSTACK_SERVICE_VERSION
-            },
-            exception: {
-                error: exception.toString(),
-                stackTrace: stackTrace
-            },
-            config: this.userConfigForReporting
-        };
-        const url = `${DATA_ENDPOINT}/api/v1/analytics`;
-        const encodedAuth = Buffer.from(`${this.credentialsForCrashReportUpload.username}:${this.credentialsForCrashReportUpload.password}`, 'utf8').toString('base64');
-        const headers = {
-            ...DEFAULT_REQUEST_CONFIG.headers,
-            Authorization: `Basic ${encodedAuth}`,
-        };
-        const response = await fetch(url, {
-            method: 'POST',
-            body: JSON.stringify(data),
-            headers
-        });
-        if (response.ok) {
-            BStackLogger.debug(`[Crash_Report_Upload] Success response: ${JSON.stringify(await response.json())}`);
-        }
-        else {
-            BStackLogger.error(`[Crash_Report_Upload] Failed due to ${response.body}`);
-        }
-    }
-    static recursivelyRedactKeysFromObject(obj, keys) {
-        if (!obj) {
-            return;
-        }
-        if (Array.isArray(obj)) {
-            obj.map(ele => this.recursivelyRedactKeysFromObject(ele, keys));
-        }
-        else {
-            for (const prop in obj) {
-                if (keys.includes(prop.toLowerCase())) {
-                    obj[prop] = '[REDACTED]';
-                }
-                else if (typeof obj[prop] === 'object') {
-                    this.recursivelyRedactKeysFromObject(obj[prop], keys);
-                }
-            }
-        }
-    }
-    static deletePIIKeysFromObject(obj) {
-        if (!obj) {
-            return;
-        }
-        ['user', 'username', 'key', 'accessKey'].forEach(key => delete obj[key]);
-    }
-    static filterCapabilities(capabilities) {
-        const capsCopy = JSON.parse(JSON.stringify(capabilities));
-        this.recursivelyRedactKeysFromObject(capsCopy, ['extensions']);
-        return capsCopy;
-    }
-    static filterPII(userConfig) {
-        const configWithoutPII = JSON.parse(JSON.stringify(userConfig));
-        this.deletePIIKeysFromObject(configWithoutPII);
-        const finalServices = [];
-        const initialServices = configWithoutPII.services;
-        delete configWithoutPII.services;
-        try {
-            for (const serviceArray of initialServices) {
-                if (Array.isArray(serviceArray) && serviceArray.length >= 2 && serviceArray[0] === 'browserstack') {
-                    for (let idx = 1; idx < serviceArray.length; idx++) {
-                        this.deletePIIKeysFromObject(serviceArray[idx]);
-                        serviceArray[idx] && this.deletePIIKeysFromObject(serviceArray[idx].testObservabilityOptions);
-                    }
-                    finalServices.push(serviceArray);
-                    break;
-                }
-            }
-        }
-        catch (err) {
-            /* Wrong configuration like strings instead of json objects could break this method, needs no action */
-            BStackLogger.error(`Error in parsing user config PII with error ${err ? (err.stack || err) : err}`);
-            return configWithoutPII;
-        }
-        configWithoutPII.services = finalServices;
-        return configWithoutPII;
-    }
-}

package/build/cucumber-types.js

@@ -1 +0,0 @@
-export {};

package/build/data-store.js

@@ -1,41 +0,0 @@
-import path from 'node:path';
-import fs from 'node:fs';
-import { BStackLogger } from './bstackLogger.js';
-const workersDataDirPath = path.join(process.cwd(), 'logs', 'worker_data');
-export function getDataFromWorkers() {
-    const workersData = [];
-    if (!fs.existsSync(workersDataDirPath)) {
-        return workersData;
-    }
-    const files = fs.readdirSync(workersDataDirPath);
-    files.forEach((file) => {
-        BStackLogger.debug('Reading worker file ' + file);
-        const filePath = path.join(workersDataDirPath, file);
-        const fileContent = fs.readFileSync(filePath, 'utf8');
-        const workerData = JSON.parse(fileContent);
-        workersData.push(workerData);
-    });
-    // Remove worker data after all reading
-    removeWorkersDataDir();
-    return workersData;
-}
-export function saveWorkerData(data) {
-    const filePath = path.join(workersDataDirPath, 'worker-data-' + process.pid + '.json');
-    try {
-        createWorkersDataDir();
-        fs.writeFileSync(filePath, JSON.stringify(data));
-    }
-    catch (e) {
-        BStackLogger.debug('Exception in saving worker data: ' + e);
-    }
-}
-function removeWorkersDataDir() {
-    fs.rmSync(workersDataDirPath, { recursive: true, force: true });
-    return true;
-}
-function createWorkersDataDir() {
-    if (!fs.existsSync(workersDataDirPath)) {
-        fs.mkdirSync(workersDataDirPath, { recursive: true });
-    }
-    return true;
-}

package/build/exitHandler.js

@@ -1,29 +0,0 @@
-import { spawn } from 'node:child_process';
-import path from 'node:path';
-import BrowserStackConfig from './config.js';
-import { saveFunnelData } from './instrumentation/funnelInstrumentation.js';
-import { fileURLToPath } from 'node:url';
-import { TESTOPS_JWT_ENV } from './constants.js';
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = path.dirname(__filename);
-export function setupExitHandlers() {
-    process.on('exit', (code) => {
-        const args = shouldCallCleanup(BrowserStackConfig.getInstance());
-        if (Array.isArray(args) && args.length) {
-            const childProcess = spawn('node', [`${path.join(__dirname, 'cleanup.js')}`, ...args], { detached: true, stdio: 'inherit', env: { ...process.env } });
-            childProcess.unref();
-            process.exit(code);
-        }
-    });
-}
-export function shouldCallCleanup(config) {
-    const args = [];
-    if (!!process.env[TESTOPS_JWT_ENV] && !config.testObservability.buildStopped) {
-        args.push('--observability');
-    }
-    if (config.userName && config.accessKey && !config.funnelDataSent) {
-        const savedFilePath = saveFunnelData('SDKTestSuccessful', config);
-        args.push('--funnelData', savedFilePath);
-    }
-    return args;
-}

package/build/fetchWrapper.js

@@ -1,14 +0,0 @@
-export class ResponseError extends Error {
-    response;
-    constructor(message, res) {
-        super(message);
-        this.response = res;
-    }
-}
-export default async function fetchWrap(input, init) {
-    const res = await fetch(input, init);
-    if (!res.ok) {
-        throw new ResponseError(`Error response from server ${res.status}:  ${await res.text()}`, res);
-    }
-    return res;
-}

package/build/fileStream.js

@@ -1,12 +0,0 @@
-export class FileStream {
-    readableStream;
-    constructor(readableStream) {
-        this.readableStream = readableStream;
-    }
-    stream() {
-        return this.readableStream;
-    }
-    get [Symbol.toStringTag]() {
-        return 'File';
-    }
-}