@wdio/browserstack-service 7.30.3 → 7.32.0

package/build/util.js

@@ -26,21 +26,24 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.sleep = exports.getObservabilityBuildTags = exports.getObservabilityBuild = exports.getObservabilityProject = exports.getObservabilityKey = exports.getObservabilityUser = exports.batchAndPostEvents = exports.shouldAddServiceVersion = exports.isScreenshotCommand = exports.getHookType = exports.getHierarchy = exports.uploadEventData = exports.getLogTag = exports.removeAnsiColors = exports.getScenarioExamples = exports.isBrowserstackSession = exports.getCloudProvider = exports.getUniqueIdentifierForCucumber = exports.getUniqueIdentifier = exports.getGitMetaData = exports.getCiInfo = exports.stopBuildUpstream = exports.launchTestSession = exports.getParentSuiteName = exports.isBrowserstackCapability = exports.getBrowserCapabilities = exports.getBrowserDescription = void 0;
+exports.sleep = exports.frameworkSupportsHook = exports.getObservabilityBuildTags = exports.getObservabilityBuild = exports.getObservabilityProject = exports.getObservabilityKey = exports.getObservabilityUser = exports.batchAndPostEvents = exports.shouldAddServiceVersion = exports.isBStackSession = exports.isScreenshotCommand = exports.getHookType = exports.getHierarchy = exports.uploadEventData = exports.getLogTag = exports.removeAnsiColors = exports.getScenarioExamples = exports.isBrowserstackSession = exports.getCloudProvider = exports.getUniqueIdentifierForCucumber = exports.getUniqueIdentifier = exports.getGitMetaData = exports.getCiInfo = exports.stopBuildUpstream = exports.launchTestSession = exports.o11yClassErrorHandler = exports.o11yErrorHandler = exports.getParentSuiteName = exports.isBrowserstackCapability = exports.getBrowserCapabilities = exports.getBrowserDescription = exports.DEFAULT_REQUEST_CONFIG = void 0;
 const os_1 = require("os");
 const util_1 = require("util");
 const http_1 = __importDefault(require("http"));
 const https_1 = __importDefault(require("https"));
 const path_1 = __importDefault(require("path"));
+const util_2 = __importDefault(require("util"));
 const logger_1 = __importDefault(require("@wdio/logger"));
 const got_1 = __importStar(require("got"));
 const git_repo_info_1 = __importDefault(require("git-repo-info"));
 const gitconfiglocal_1 = __importDefault(require("gitconfiglocal"));
+const crash_reporter_1 = __importDefault(require("./crash-reporter"));
 const constants_1 = require("./constants");
 const request_handler_1 = __importDefault(require("./request-handler"));
+const performance_tester_1 = __importDefault(require("./performance-tester"));
 const pGitconfig = (0, util_1.promisify)(gitconfiglocal_1.default);
 const log = (0, logger_1.default)('@wdio/browserstack-service');
-const DEFAULT_REQUEST_CONFIG = {
+exports.DEFAULT_REQUEST_CONFIG = {
     agent: {
         http: new http_1.default.Agent({ keepAlive: true }),
         https: new https_1.default.Agent({ keepAlive: true }),
@@ -109,7 +112,66 @@ function getParentSuiteName(fullTitle, testSuiteTitle) {
     return parentSuiteName.trim();
 }
 exports.getParentSuiteName = getParentSuiteName;
-async function launchTestSession(options, config, bsConfig) {
+function processError(error, fn, args) {
+    log.error(`Error in executing ${fn.name} with args ${args}: ${error}`);
+    let argsString;
+    try {
+        argsString = JSON.stringify(args);
+    }
+    catch (e) {
+        argsString = util_2.default.inspect(args, { depth: 2 });
+    }
+    crash_reporter_1.default.uploadCrashReport(`Error in executing ${fn.name} with args ${argsString} : ${error}`, error && error.stack);
+}
+function o11yErrorHandler(fn) {
+    return function (...args) {
+        try {
+            let functionToHandle = fn;
+            if (process.env.BROWSERSTACK_O11Y_PERF_MEASUREMENT) {
+                functionToHandle = performance_tester_1.default.getPerformance().timerify(functionToHandle);
+            }
+            const result = functionToHandle(...args);
+            if (result instanceof Promise) {
+                return result.catch(error => processError(error, fn, args));
+            }
+            return result;
+        }
+        catch (error) {
+            processError(error, fn, args);
+        }
+    };
+}
+exports.o11yErrorHandler = o11yErrorHandler;
+function o11yClassErrorHandler(errorClass) {
+    const prototype = errorClass.prototype;
+    if (Object.getOwnPropertyNames(prototype).length < 2) {
+        return errorClass;
+    }
+    Object.getOwnPropertyNames(prototype).forEach((methodName) => {
+        const method = prototype[methodName];
+        if (typeof method === 'function' && methodName !== 'constructor') {
+            // In order to preserve this context, need to define like this
+            Object.defineProperty(prototype, methodName, {
+                writable: true,
+                value: function (...args) {
+                    try {
+                        const result = (process.env.BROWSERSTACK_O11Y_PERF_MEASUREMENT ? performance_tester_1.default.getPerformance().timerify(method) : method).call(this, ...args);
+                        if (result instanceof Promise) {
+                            return result.catch(error => processError(error, method, args));
+                        }
+                        return result;
+                    }
+                    catch (err) {
+                        processError(err, method, args);
+                    }
+                }
+            });
+        }
+    });
+    return errorClass;
+}
+exports.o11yClassErrorHandler = o11yClassErrorHandler;
+exports.launchTestSession = o11yErrorHandler(async function launchTestSession(options, config, bsConfig) {
     const data = {
         format: 'json',
         project_name: getObservabilityProject(options, bsConfig.projectName),
@@ -131,12 +193,22 @@ async function launchTestSession(options, config, bsConfig) {
         observability_version: {
             frameworkName: 'WebdriverIO-' + config.framework,
             sdkVersion: bsConfig.bstackServiceVersion
-        }
+        },
+        config: {}
     };
+    try {
+        if (Object.keys(crash_reporter_1.default.userConfigForReporting).length === 0) {
+            crash_reporter_1.default.userConfigForReporting = process.env.USER_CONFIG_FOR_REPORTING !== undefined ? JSON.parse(process.env.USER_CONFIG_FOR_REPORTING) : {};
+        }
+    }
+    catch (error) {
+        log.error(`[Crash_Report_Upload] Failed to parse user config while sending build start event due to ${error}`);
+    }
+    data.config = crash_reporter_1.default.userConfigForReporting;
     try {
         const url = `${constants_1.DATA_ENDPOINT}/api/v1/builds`;
         const response = await got_1.default.post(url, {
-            ...DEFAULT_REQUEST_CONFIG,
+            ...exports.DEFAULT_REQUEST_CONFIG,
             username: getObservabilityUser(options, config),
             password: getObservabilityKey(options, config),
             json: data
@@ -172,9 +244,8 @@ async function launchTestSession(options, config, bsConfig) {
             log.error(`Data upload to BrowserStack Test Observability failed due to ${error}`);
         }
     }
-}
-exports.launchTestSession = launchTestSession;
-async function stopBuildUpstream() {
+});
+exports.stopBuildUpstream = o11yErrorHandler(async function stopBuildUpstream() {
     if (!process.env.BS_TESTOPS_BUILD_COMPLETED) {
         return;
     }
@@ -191,9 +262,9 @@ async function stopBuildUpstream() {
     try {
         const url = `${constants_1.DATA_ENDPOINT}/api/v1/builds/${process.env.BS_TESTOPS_BUILD_HASHED_ID}/stop`;
         const response = await got_1.default.put(url, {
-            agent: DEFAULT_REQUEST_CONFIG.agent,
+            agent: exports.DEFAULT_REQUEST_CONFIG.agent,
             headers: {
-                ...DEFAULT_REQUEST_CONFIG.headers,
+                ...exports.DEFAULT_REQUEST_CONFIG.headers,
                 'Authorization': `Bearer ${process.env.BS_TESTOPS_JWT}`
             },
             json: data
@@ -211,8 +282,7 @@ async function stopBuildUpstream() {
             message: error.message
         };
     }
-}
-exports.stopBuildUpstream = stopBuildUpstream;
+});
 function getCiInfo() {
     var env = process.env;
     // Jenkins
@@ -335,8 +405,17 @@ async function getGitMetaData() {
     };
 }
 exports.getGitMetaData = getGitMetaData;
-function getUniqueIdentifier(test) {
-    return `${test.parent} - ${test.title}`;
+function getUniqueIdentifier(test, framework) {
+    if (framework === 'jasmine') {
+        return test.fullName;
+    }
+    let parentTitle = test.parent;
+    // Sometimes parent will be an object instead of a string
+    if (typeof test.parent === 'object') {
+        // @ts-ignore
+        parentTitle = parentTitle.title;
+    }
+    return `${parentTitle} - ${test.title}`;
 }
 exports.getUniqueIdentifier = getUniqueIdentifier;
 function getUniqueIdentifierForCucumber(world) {
@@ -435,9 +514,9 @@ async function uploadEventData(eventData, eventUrl = constants_1.DATA_EVENT_ENDP
         const url = `${constants_1.DATA_ENDPOINT}/${eventUrl}`;
         request_handler_1.default.getInstance().pendingUploads += 1;
         const data = await got_1.default.post(url, {
-            agent: DEFAULT_REQUEST_CONFIG.agent,
+            agent: exports.DEFAULT_REQUEST_CONFIG.agent,
             headers: {
-                ...DEFAULT_REQUEST_CONFIG.headers,
+                ...exports.DEFAULT_REQUEST_CONFIG.headers,
                 'Authorization': `Bearer ${process.env.BS_TESTOPS_JWT}`
             },
             json: eventData
@@ -459,16 +538,16 @@ function getHierarchy(fullTitle) {
 }
 exports.getHierarchy = getHierarchy;
 function getHookType(hookName) {
-    if (hookName.includes('before each')) {
+    if (hookName.startsWith('"before each"')) {
         return 'BEFORE_EACH';
     }
-    else if (hookName.includes('before all')) {
+    else if (hookName.startsWith('"before all"')) {
         return 'BEFORE_ALL';
     }
-    else if (hookName.includes('after each')) {
+    else if (hookName.startsWith('"after each"')) {
         return 'AFTER_EACH';
     }
-    else if (hookName.includes('after all')) {
+    else if (hookName.startsWith('"after all"')) {
         return 'AFTER_ALL';
     }
     return 'unknown';
@@ -478,6 +557,13 @@ function isScreenshotCommand(args) {
     return args.endpoint && args.endpoint.includes('/screenshot');
 }
 exports.isScreenshotCommand = isScreenshotCommand;
+function isBStackSession(config) {
+    if (typeof config.user === 'string' && typeof config.key === 'string' && config.key.length === 20) {
+        return true;
+    }
+    return false;
+}
+exports.isBStackSession = isBStackSession;
 function shouldAddServiceVersion(config, testObservability) {
     if (config.services && config.services.toString().includes('chromedriver') && testObservability != false) {
         return false;
@@ -492,9 +578,9 @@ async function batchAndPostEvents(eventUrl, kind, data) {
     try {
         const url = `${constants_1.DATA_ENDPOINT}/${eventUrl}`;
         const response = await got_1.default.post(url, {
-            agent: DEFAULT_REQUEST_CONFIG.agent,
+            agent: exports.DEFAULT_REQUEST_CONFIG.agent,
             headers: {
-                ...DEFAULT_REQUEST_CONFIG.headers,
+                ...exports.DEFAULT_REQUEST_CONFIG.headers,
                 'Authorization': `Bearer ${process.env.BS_TESTOPS_JWT}`
             },
             json: data
@@ -559,5 +645,12 @@ function getObservabilityBuildTags(options, bstackBuildTag) {
     return [];
 }
 exports.getObservabilityBuildTags = getObservabilityBuildTags;
+function frameworkSupportsHook(hook, framework) {
+    if (framework === 'mocha' && (hook === 'before' || hook === 'after' || hook === 'beforeEach' || hook === 'afterEach')) {
+        return true;
+    }
+    return false;
+}
+exports.frameworkSupportsHook = frameworkSupportsHook;
 const sleep = (ms = 100) => new Promise((resolve) => setTimeout(resolve, ms));
 exports.sleep = sleep;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wdio/browserstack-service",
-  "version": "7.30.3",
+  "version": "7.32.0",
   "description": "WebdriverIO service for better Browserstack integration",
   "author": "Adam Bjerstedt <abjerstedt@gmail.com>",
   "homepage": "https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-browserstack-service",
@@ -28,12 +28,13 @@
     "@wdio/reporter": "7.25.4",
     "@wdio/types": "7.30.2",
     "browserstack-local": "^1.4.5",
+    "csv-writer": "^1.6.0",
     "form-data": "^4.0.0",
     "git-repo-info": "^2.1.1",
     "gitconfiglocal": "^2.1.0",
     "got": "^11.0.2",
     "uuid": "^8.3.2",
-    "webdriverio": "7.30.2"
+    "webdriverio": "7.32.0"
   },
   "peerDependencies": {
     "@wdio/cli": "^5.0.0 || ^6.0.0 || ^7.0.0"
@@ -42,5 +43,5 @@
     "access": "public"
   },
   "types": "./build/index.d.ts",
-  "gitHead": "cdc92da66a3cd9ab3ce5c6333ec2ab9541313a9d"
+  "gitHead": "c413d9310c8abb487bd9e1d2f82124c15a71b134"
 }