@wdio/browserstack-service 7.19.7 → 7.20.2

package/README.md

@@ -50,7 +50,7 @@ exports.config
 In order to authorize to the BrowserStack service your config needs to contain a [`user`](https://webdriver.io/docs/options#user) and [`key`](https://webdriver.io/docs/options#key) option.
 
 ### browserstackLocal
-Set this to true to enable routing connections from Browserstack cloud through your computer. You will also need to set `browserstack.local` to true in browser capabilities.
+Set this to true to enable routing connections from Browserstack cloud through your computer.
 
 Type: `Boolean`<br />
 Default: `false`
@@ -68,14 +68,126 @@ Type: `Boolean`<br />
 Default: `false`
 
 ### opts
-Specified optional will be passed down to BrowserstackLocal. See [this list](https://www.browserstack.com/local-testing#modifiers) for details.
+Specified optional will be passed down to BrowserstackLocal.
 
 Type: `Object`<br />
 Default: `{}`
 
-## Known Issues
+List of available local testing modifiers to be passed as opts:
 
-- At the moment, it is challenging, if not impossible, to transfer localIdentifier to child-processes reliably because of how webdriverio designed their multi-process model. We recommend using this service without an identifier, which will create an account-wide local tunnel.
+#### Local Identifier
+
+If doing simultaneous multiple local testing connections, set this uniquely for different processes -
+
+```js
+opts = { localIdentifier: "randomstring" };
+```
+
+#### Verbose Logging
+
+To enable verbose logging -
+
+```js
+opts = { verbose: "true" };
+```
+
+Note - Possible values for 'verbose' modifier are '1', '2', '3' and 'true'
+
+#### Force Local
+
+To route all traffic via local(your) machine -
+
+```js
+opts = { forceLocal: "true" };
+```
+
+#### Folder Testing
+
+To test local folder rather internal server, provide path to folder as value of this option -
+
+```js
+opts = { f: "/my/awesome/folder" };
+```
+
+#### Force Start
+
+To kill other running Browserstack Local instances -
+
+```js
+opts = { force: "true" };
+```
+
+#### Only Automate
+
+To disable local testing for Live and Screenshots, and enable only Automate -
+
+```js
+opts = { onlyAutomate: "true" };
+```
+
+#### Proxy
+
+To use a proxy for local testing -
+
+- proxyHost: Hostname/IP of proxy, remaining proxy options are ignored if this option is absent
+- proxyPort: Port for the proxy, defaults to 3128 when -proxyHost is used
+- proxyUser: Username for connecting to proxy (Basic Auth Only)
+- proxyPass: Password for USERNAME, will be ignored if USERNAME is empty or not specified
+
+```js
+opts = {
+  proxyHost: "127.0.0.1",
+  proxyPort: "8000",
+  proxyUser: "user",
+  proxyPass: "password",
+};
+```
+
+#### Local Proxy
+
+To use local proxy in local testing -
+
+- localProxyHost: Hostname/IP of proxy, remaining proxy options are ignored if this option is absent
+- localProxyPort: Port for the proxy, defaults to 8081 when -localProxyHost is used
+- localProxyUser: Username for connecting to proxy (Basic Auth Only)
+- localProxyPass: Password for USERNAME, will be ignored if USERNAME is empty or not specified
+
+```js
+opts = {
+  localProxyHost: "127.0.0.1",
+  localProxyPort: "8000",
+  localProxyUser: "user",
+  localProxyPass: "password",
+};
+```
+
+#### PAC (Proxy Auto-Configuration)
+
+To use PAC (Proxy Auto-Configuration) in local testing -
+
+- pac-file: PAC (Proxy Auto-Configuration) file’s absolute path
+
+```js
+opts = { "pac-file": "<pac_file_abs_path>" };
+```
+
+#### Binary Path
+
+By default, BrowserStack local wrappers try downloading and executing the latest version of BrowserStack binary in ~/.browserstack or the present working directory or the tmp folder by order. But you can override these by passing the -binarypath argument.
+Path to specify local Binary path -
+
+```js
+opts = { binarypath: "/path/to/binary" };
+```
+
+#### Logfile
+
+To save the logs to the file while running with the '-v' argument, you can specify the path of the file. By default the logs are saved in the local.log file in the present woring directory.
+To specify the path to file where the logs will be saved -
+
+```js
+opts = { verbose: "true", logFile: "./local.log" };
+```
 
 ----
 

package/build/launcher.d.ts

@@ -9,7 +9,7 @@ export default class BrowserstackLauncherService implements Services.ServiceInst
     private _options;
     private _config;
     browserstackLocal?: BrowserstackLocal;
-    constructor(_options: BrowserstackConfig, capabilities: Capabilities.RemoteCapability, _config: Options.Testrunner);
+    constructor(_options: BrowserstackConfig & Options.Testrunner, capabilities: Capabilities.RemoteCapability, _config: Options.Testrunner);
     onPrepare(config?: Options.Testrunner, capabilities?: Capabilities.RemoteCapabilities): void | Promise<unknown>;
     onComplete(): true | Promise<unknown> | undefined;
 }

package/build/launcher.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"launcher.d.ts","sourceRoot":"","sources":["../src/launcher.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,yBAAyB,MAAM,oBAAoB,CAAA;AAE/D,OAAO,KAAK,EAAE,YAAY,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAElE,OAAO,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAA;AAI5C,aAAK,iBAAiB,GAAG,yBAAyB,CAAC,KAAK,GAAG;IACvD,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,EAAE,GAAG,KAAK,IAAI,GAAG,IAAI,CAAC;CAC7C,CAAA;AAED,MAAM,CAAC,OAAO,OAAO,2BAA4B,YAAW,QAAQ,CAAC,eAAe;IAI5E,OAAO,CAAC,QAAQ;IAEhB,OAAO,CAAC,OAAO;IALnB,iBAAiB,CAAC,EAAE,iBAAiB,CAAA;gBAGzB,QAAQ,EAAE,kBAAkB,EACpC,YAAY,EAAE,YAAY,CAAC,gBAAgB,EACnC,OAAO,EAAE,OAAO,CAAC,UAAU;IAGvC,SAAS,CAAE,MAAM,CAAC,EAAE,OAAO,CAAC,UAAU,EAAE,YAAY,CAAC,EAAE,YAAY,CAAC,kBAAkB;IA+DtF,UAAU;CAkCb"}
+{"version":3,"file":"launcher.d.ts","sourceRoot":"","sources":["../src/launcher.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,yBAAyB,MAAM,oBAAoB,CAAA;AAE/D,OAAO,KAAK,EAAE,YAAY,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAIlE,OAAO,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAA;AAI5C,aAAK,iBAAiB,GAAG,yBAAyB,CAAC,KAAK,GAAG;IACvD,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,EAAE,GAAG,KAAK,IAAI,GAAG,IAAI,CAAC;CAC7C,CAAA;AAED,MAAM,CAAC,OAAO,OAAO,2BAA4B,YAAW,QAAQ,CAAC,eAAe;IAI5E,OAAO,CAAC,QAAQ;IAEhB,OAAO,CAAC,OAAO;IALnB,iBAAiB,CAAC,EAAE,iBAAiB,CAAA;gBAGzB,QAAQ,EAAE,kBAAkB,GAAG,OAAO,CAAC,UAAU,EACzD,YAAY,EAAE,YAAY,CAAC,gBAAgB,EACnC,OAAO,EAAE,OAAO,CAAC,UAAU;IAqBvC,SAAS,CAAE,MAAM,CAAC,EAAE,OAAO,CAAC,UAAU,EAAE,YAAY,CAAC,EAAE,YAAY,CAAC,kBAAkB;IA6DtF,UAAU;CAkCb"}

package/build/launcher.js

@@ -30,11 +30,31 @@ const util_1 = require("util");
 const perf_hooks_1 = require("perf_hooks");
 const BrowserstackLocalLauncher = __importStar(require("browserstack-local"));
 const logger_1 = __importDefault(require("@wdio/logger"));
+// @ts-ignore
+const package_json_1 = require("../package.json");
 const log = (0, logger_1.default)('@wdio/browserstack-service');
 class BrowserstackLauncherService {
     constructor(_options, capabilities, _config) {
         this._options = _options;
         this._config = _config;
+        // added to maintain backward compatibility with webdriverIO v5
+        this._config || (this._config = _options);
+        if (Array.isArray(capabilities)) {
+            capabilities.forEach((capability) => {
+                if (!capability['bstack:options']) {
+                    capability['bstack:options'] = {};
+                }
+                capability['bstack:options'].wdioService = package_json_1.version;
+            });
+        }
+        else if (typeof capabilities === 'object') {
+            Object.entries(capabilities).forEach(([, caps]) => {
+                if (!caps.capabilities['bstack:options']) {
+                    caps.capabilities['bstack:options'] = {};
+                }
+                caps.capabilities['bstack:options'].wdioService = package_json_1.version;
+            });
+        }
     }
     onPrepare(config, capabilities) {
         if (!this._options.browserstackLocal) {
@@ -42,8 +62,6 @@ class BrowserstackLauncherService {
         }
         const opts = {
             key: this._config.key,
-            forcelocal: true,
-            onlyAutomate: true,
             ...this._options.opts
         };
         this.browserstackLocal = new BrowserstackLocalLauncher.Local();

package/build/service.d.ts

@@ -11,7 +11,7 @@ export default class BrowserstackService implements Services.ServiceInstance {
     private _failureStatuses;
     private _browser?;
     private _fullTitle?;
-    constructor(_options: BrowserstackConfig, _caps: Capabilities.RemoteCapability, _config: Options.Testrunner);
+    constructor(_options: BrowserstackConfig & Options.Testrunner, _caps: Capabilities.RemoteCapability, _config: Options.Testrunner);
     _updateCaps(fn: (caps: Capabilities.Capabilities | Capabilities.DesiredCapabilities) => void): void;
     /**
      * if no user and key is specified even though a browserstack service was

package/build/service.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"service.d.ts","sourceRoot":"","sources":["../src/service.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,QAAQ,EAAE,YAAY,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAC9E,OAAO,KAAK,EAAE,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAA;AAG9D,OAAO,EAAE,kBAAkB,EAAE,iBAAiB,EAAmB,MAAM,SAAS,CAAA;AAIhF,MAAM,CAAC,OAAO,OAAO,mBAAoB,YAAW,QAAQ,CAAC,eAAe;IASpE,OAAO,CAAC,QAAQ;IAChB,OAAO,CAAC,KAAK;IACb,OAAO,CAAC,OAAO;IAVnB,OAAO,CAAC,eAAe,CAAmD;IAC1E,OAAO,CAAC,YAAY,CAAe;IACnC,OAAO,CAAC,iBAAiB,CAAe;IACxC,OAAO,CAAC,gBAAgB,CAA4D;IACpF,OAAO,CAAC,QAAQ,CAAC,CAAgD;IACjE,OAAO,CAAC,UAAU,CAAC,CAAQ;gBAGf,QAAQ,EAAE,kBAAkB,EAC5B,KAAK,EAAE,YAAY,CAAC,gBAAgB,EACpC,OAAO,EAAE,OAAO,CAAC,UAAU;IAUvC,WAAW,CAAE,EAAE,EAAE,CAAC,IAAI,EAAE,YAAY,CAAC,YAAY,GAAG,YAAY,CAAC,mBAAmB,KAAK,IAAI;IAU7F;;;;OAIG;IACH,aAAa,CAAE,MAAM,EAAE,OAAO,CAAC,UAAU;IAYzC,MAAM,CAAC,IAAI,EAAE,YAAY,CAAC,gBAAgB,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG,kBAAkB,CAAC,OAAO,CAAC;IAcpH,WAAW,CAAE,KAAK,EAAE,UAAU,CAAC,KAAK;IAIpC,aAAa,CAAC,GAAG,EAAE,OAAO,EAAE,OAAO,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE;IAKrD,SAAS,CAAC,IAAI,EAAE,UAAU,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,UAAU,CAAC,UAAU;IAqB/E,KAAK,CAAE,MAAM,EAAE,MAAM;IAgBrB;;OAEG;IACH,aAAa,CAAE,KAAK,EAAE,UAAU,CAAC,KAAK;IAmBhC,QAAQ,CAAC,YAAY,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM;IA2BzD,cAAc,IAAI,OAAO;IAOzB,UAAU,CAAE,WAAW,EAAE,GAAG;IAU5B,kBAAkB,CAAE,MAAM,EAAE,iBAAiB;IAqB7C,OAAO,CAAC,SAAS,EAAE,MAAM,EAAE,WAAW,EAAE,GAAG;IAUrC,gBAAgB;CAsBzB"}
+{"version":3,"file":"service.d.ts","sourceRoot":"","sources":["../src/service.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,QAAQ,EAAE,YAAY,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAC9E,OAAO,KAAK,EAAE,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAA;AAG9D,OAAO,EAAE,kBAAkB,EAAE,iBAAiB,EAAmB,MAAM,SAAS,CAAA;AAIhF,MAAM,CAAC,OAAO,OAAO,mBAAoB,YAAW,QAAQ,CAAC,eAAe;IASpE,OAAO,CAAC,QAAQ;IAChB,OAAO,CAAC,KAAK;IACb,OAAO,CAAC,OAAO;IAVnB,OAAO,CAAC,eAAe,CAAmD;IAC1E,OAAO,CAAC,YAAY,CAAe;IACnC,OAAO,CAAC,iBAAiB,CAAe;IACxC,OAAO,CAAC,gBAAgB,CAA4D;IACpF,OAAO,CAAC,QAAQ,CAAC,CAAgD;IACjE,OAAO,CAAC,UAAU,CAAC,CAAQ;gBAGf,QAAQ,EAAE,kBAAkB,GAAG,OAAO,CAAC,UAAU,EACjD,KAAK,EAAE,YAAY,CAAC,gBAAgB,EACpC,OAAO,EAAE,OAAO,CAAC,UAAU;IAYvC,WAAW,CAAE,EAAE,EAAE,CAAC,IAAI,EAAE,YAAY,CAAC,YAAY,GAAG,YAAY,CAAC,mBAAmB,KAAK,IAAI;IAU7F;;;;OAIG;IACH,aAAa,CAAE,MAAM,EAAE,OAAO,CAAC,UAAU;IAYzC,MAAM,CAAC,IAAI,EAAE,YAAY,CAAC,gBAAgB,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG,kBAAkB,CAAC,OAAO,CAAC;IAepH,WAAW,CAAE,KAAK,EAAE,UAAU,CAAC,KAAK;IAIpC,aAAa,CAAC,GAAG,EAAE,OAAO,EAAE,OAAO,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE;IAKrD,SAAS,CAAC,IAAI,EAAE,UAAU,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,UAAU,CAAC,UAAU;IAqB/E,KAAK,CAAE,MAAM,EAAE,MAAM;IAgBrB;;OAEG;IACH,aAAa,CAAE,KAAK,EAAE,UAAU,CAAC,KAAK;IAmBhC,QAAQ,CAAC,YAAY,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM;IA2BzD,cAAc,IAAI,OAAO;IAOzB,UAAU,CAAE,WAAW,EAAE,GAAG;IAU5B,kBAAkB,CAAE,MAAM,EAAE,iBAAiB;IAqB7C,OAAO,CAAC,SAAS,EAAE,MAAM,EAAE,WAAW,EAAE,GAAG;IAUrC,gBAAgB;CAsBzB"}

package/build/service.js

@@ -16,6 +16,8 @@ class BrowserstackService {
         this._failReasons = [];
         this._scenariosThatRan = [];
         this._failureStatuses = ['failed', 'ambiguous', 'undefined', 'unknown'];
+        // added to maintain backward compatibility with webdriverIO v5
+        this._config || (this._config = _options);
         // Cucumber specific
         const strict = Boolean(this._config.cucumberOpts && this._config.cucumberOpts.strict);
         // See https://github.com/cucumber/cucumber-js/blob/master/src/runtime/index.ts#L136
@@ -46,7 +48,8 @@ class BrowserstackService {
         this._config.key = config.key;
     }
     before(caps, specs, browser) {
-        this._browser = browser;
+        // added to maintain backward compatibility with webdriverIO v5
+        this._browser = browser ? browser : global.browser;
         // Ensure capabilities are not null in case of multiremote
         if (this._isAppAutomate()) {
             this._sessionBaseUrl = 'https://api-cloud.browserstack.com/app-automate/sessions';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wdio/browserstack-service",
-  "version": "7.19.7",
+  "version": "7.20.2",
   "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",
@@ -25,10 +25,10 @@
   "dependencies": {
     "@types/node": "^17.0.4",
     "@wdio/logger": "7.19.0",
-    "@wdio/types": "7.19.5",
+    "@wdio/types": "7.20.0",
     "browserstack-local": "^1.4.5",
     "got": "^11.0.2",
-    "webdriverio": "7.19.7"
+    "webdriverio": "7.20.2"
   },
   "peerDependencies": {
     "@wdio/cli": "^7.0.0"
@@ -37,5 +37,5 @@
     "access": "public"
   },
   "types": "./build/index.d.ts",
-  "gitHead": "ed5b7278190953d5e77d11083b59db2209ac99b5"
+  "gitHead": "51b8a952ec1c8e8265472823759e4cb200c272bc"
 }