@applitools/driver 1.16.6 → 1.17.2

package/CHANGELOG.md

@@ -1,5 +1,31 @@
 # Changelog
 
+## [1.17.2](https://github.com/Applitools-Dev/sdk/compare/js/driver@1.17.1...js/driver@1.17.2) (2024-05-01)
+
+
+### Bug Fixes
+
+* cache nml client per driver ([#2336](https://github.com/Applitools-Dev/sdk/issues/2336)) ([02c09a5](https://github.com/Applitools-Dev/sdk/commit/02c09a53eb6ca6340c93365908f4c485ab389c21))
+
+## [1.17.1](https://github.com/Applitools-Dev/sdk/compare/js/driver@1.17.0...js/driver@1.17.1) (2024-04-22)
+
+
+### Dependencies
+
+* @applitools/utils bumped to 1.7.2
+  #### Bug Fixes
+
+  * trigger release ([88ba29f](https://github.com/Applitools-Dev/sdk/commit/88ba29f358620a5c0f0861eb31e8929d0b611284))
+* @applitools/logger bumped to 2.0.16
+
+
+## [1.17.0](https://github.com/Applitools-Dev/sdk/compare/js/driver@1.16.6...js/driver@1.17.0) (2024-04-22)
+
+
+### Features
+
+* report batchId and batchUrl to kobiton ([#2329](https://github.com/Applitools-Dev/sdk/issues/2329)) ([5be4356](https://github.com/Applitools-Dev/sdk/commit/5be4356d7f3cd96b70491325d4a788202c06720a))
+
 ## [1.16.6](https://github.com/Applitools-Dev/sdk/compare/js/driver@1.16.5...js/driver@1.16.6) (2024-04-15)
 
 

package/dist/driver.js

@@ -34,6 +34,7 @@ const user_agent_1 = require("./user-agent");
 const capabilities_1 = require("./capabilities");
 const utils = __importStar(require("@applitools/utils"));
 const snippets = require('@applitools/snippets');
+const drivers = new WeakMap();
 class Driver {
     constructor(options) {
         var _a, _b, _c, _d;
@@ -42,12 +43,14 @@ class Driver {
         this._original = this;
         this._logger = (0, logger_1.makeLogger)({ logger: options.logger, format: { label: 'driver' } });
         this._customConfig = (_a = options.customConfig) !== null && _a !== void 0 ? _a : {};
-        this._guid = utils.general.guid();
         this._spec = options.spec;
         this._target = options.driver;
         if (!this._spec.isDriver(this._target)) {
             throw new TypeError('Driver constructor called with argument of unknown type!');
         }
+        if (!drivers.get(options.driver)) {
+            drivers.set(options.driver, utils.general.guid());
+        }
         this._mainContext = new context_1.Context({
             spec: this._spec,
             context: (_d = (_c = (_b = this._spec).extractContext) === null || _c === void 0 ? void 0 : _c.call(_b, this._target)) !== null && _d !== void 0 ? _d : this._target,
@@ -62,7 +65,7 @@ class Driver {
         return this._target;
     }
     get guid() {
-        return this._guid;
+        return drivers.get(this.target);
     }
     get currentContext() {
         return this._currentContext;
@@ -277,8 +280,9 @@ class Driver {
                 this._environment.isMobile = true;
                 this._environment.isEmulation = true;
             }
-            this._environment.isEC =
-                this._environment.isECClient || /exec-wus.applitools.com/.test((_d = (await this.getDriverUrl())) !== null && _d !== void 0 ? _d : '');
+            const driverUrl = (_d = (await this.getDriverUrl())) !== null && _d !== void 0 ? _d : '';
+            this._environment.isEC = this._environment.isECClient || /exec-wus.applitools.com/.test(driverUrl);
+            this._environment.isKobiton = /kobiton/.test(driverUrl);
             this._logger.log('Extracted environment', this._environment);
         }
         return this._environment;
@@ -867,8 +871,6 @@ async function makeDriver(options) {
     let driver;
     if (options.driver instanceof Driver) {
         driver = options.driver;
-        if (options.relaxed)
-            return driver;
     }
     else {
         options.driver = (_c = (await ((_b = (_a = options.spec) === null || _a === void 0 ? void 0 : _a.toDriver) === null || _b === void 0 ? void 0 : _b.call(_a, options.driver)))) !== null && _c !== void 0 ? _c : options.driver;

package/dist/fake/mock-driver.js

@@ -23,7 +23,7 @@ const DEFAULT_PROPS = {
 };
 class MockDriver {
     constructor(options = {}) {
-        const { viewport = { width: 1000, height: 1000 }, device, platform, browser, ua } = options;
+        const { viewport = { width: 1000, height: 1000 }, device, platform, browser, ua, driverServerUrl, capabilities, } = options;
         this._device = device;
         this._platform = platform;
         this._browser = browser;
@@ -33,6 +33,8 @@ class MockDriver {
             url: 'http://default.url',
             rect: { x: 0, y: 0, ...viewport },
         };
+        this._driverServerUrl = driverServerUrl;
+        this._capabilities = capabilities;
         this._methods = new Map();
         this._scripts = new Map();
         this._elements = new Map();
@@ -162,6 +164,9 @@ class MockDriver {
             // TODO get window for context: `this.contexts.get(this._contextId)`
             return { width: this._window.rect.width, height: this._window.rect.height };
         });
+        this.mockScript('mobile:deviceScreenInfo', () => {
+            return { scale: 1, statusBarSize: { height: 1 } };
+        });
     }
     mockScript(scriptMatcher, resultGenerator) {
         this._scripts.set(String(scriptMatcher), resultGenerator);
@@ -262,9 +267,16 @@ class MockDriver {
             browserVersion: this._browser ? this._browser.version : null,
         };
     }
+    get driverServerUrl() {
+        return this._driverServerUrl;
+    }
+    get capabilities() {
+        return this._capabilities;
+    }
     async executeScript(script, args = []) {
-        if (this.environment.isNative)
-            throw new Error("Native context doesn't support this method");
+        if (this.environment.isNative && !/^mobile\:/.test(script)) {
+            throw new Error(`Native context doesn't support this method: ${script}`);
+        }
         let result = this._scripts.get(String(script));
         if (!result) {
             const name = Object.keys(WELL_KNOWN_SCRIPTS).find(name => WELL_KNOWN_SCRIPTS[name](script));

package/dist/fake/spec-driver.js

@@ -23,7 +23,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.performAction = exports.getElementAttribute = exports.getElementRegion = exports.getCurrentWorld = exports.visit = exports.getTitle = exports.getUrl = exports.getOrientation = exports.setWindowSize = exports.getWindowSize = exports.getDriverInfo = exports.takeScreenshot = exports.childContext = exports.parentContext = exports.mainContext = exports.getElementText = exports.findElements = exports.findElement = exports.executeScript = exports.isEqualElements = exports.isStaleElementError = exports.extractSelector = exports.toSimpleCommonSelector = exports.toSelector = exports.isSelector = exports.isElement = exports.isDriver = void 0;
+exports.getCapabilities = exports.performAction = exports.getElementAttribute = exports.getElementRegion = exports.getCurrentWorld = exports.visit = exports.getTitle = exports.getUrl = exports.getOrientation = exports.setWindowSize = exports.getWindowSize = exports.getDriverInfo = exports.takeScreenshot = exports.childContext = exports.parentContext = exports.mainContext = exports.getElementText = exports.findElements = exports.findElement = exports.executeScript = exports.isEqualElements = exports.isStaleElementError = exports.extractSelector = exports.toSimpleCommonSelector = exports.toSelector = exports.isSelector = exports.isElement = exports.isDriver = void 0;
 const utils = __importStar(require("@applitools/utils"));
 function isDriver(driver) {
     return driver && driver.constructor.name === 'MockDriver';
@@ -106,7 +106,7 @@ async function takeScreenshot(driver) {
 }
 exports.takeScreenshot = takeScreenshot;
 async function getDriverInfo(driver) {
-    return { environment: driver.environment };
+    return { environment: driver.environment, driverServerUrl: driver.driverServerUrl };
 }
 exports.getDriverInfo = getDriverInfo;
 async function getWindowSize(driver) {
@@ -153,3 +153,7 @@ async function performAction(_driver, _steps) {
     return;
 }
 exports.performAction = performAction;
+async function getCapabilities(driver) {
+    return driver.capabilities;
+}
+exports.getCapabilities = getCapabilities;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/driver",
-  "version": "1.16.6",
+  "version": "1.17.2",
   "description": "Applitools universal framework wrapper",
   "keywords": [
     "applitools",
@@ -73,9 +73,9 @@
     "test": "run --top-level mocha './test/**/*.spec.ts'"
   },
   "dependencies": {
-    "@applitools/logger": "2.0.15",
+    "@applitools/logger": "2.0.16",
     "@applitools/snippets": "2.4.25",
-    "@applitools/utils": "1.7.1",
+    "@applitools/utils": "1.7.2",
     "semver": "7.5.4"
   },
   "devDependencies": {

package/types/driver.d.ts

@@ -17,7 +17,6 @@ type DriverOptions<T extends SpecType> = {
 };
 export declare class Driver<T extends SpecType> {
     private _target;
-    private _guid;
     private _mainContext;
     private _currentContext;
     private _driverInfo?;
@@ -33,7 +32,7 @@ export declare class Driver<T extends SpecType> {
     constructor(options: DriverOptions<T>);
     get logger(): Logger;
     get target(): T['driver'];
-    get guid(): string;
+    get guid(): string | undefined;
     get currentContext(): Context<T>;
     get mainContext(): Context<T>;
     updateLogger(logger: Logger): void;
@@ -95,7 +94,6 @@ export declare function makeDriver<T extends SpecType>(options: {
         useCeilForViewportSize?: boolean;
     };
     reset?: boolean;
-    relaxed?: boolean;
     logger?: Logger;
 }): Promise<Driver<T>>;
 export {};

package/types/fake/mock-driver.d.ts

@@ -1,5 +1,27 @@
+type Options = {
+    viewport?: {
+        width: number;
+        height: number;
+    };
+    device?: {
+        isMobile?: boolean;
+        isNative?: boolean;
+        name?: string;
+    };
+    platform?: {
+        name?: string;
+        version?: string;
+    };
+    browser?: {
+        name?: string;
+        version?: string;
+    };
+    ua?: string;
+    driverServerUrl?: string;
+    capabilities?: Record<string, any>;
+};
 export declare class MockDriver {
-    constructor(options?: {});
+    constructor(options?: Options);
     mockScript(scriptMatcher: any, resultGenerator: any): void;
     mockElement(selector: any, state: any): any;
     unmockElement(element: any): void;
@@ -23,6 +45,8 @@ export declare class MockDriver {
         browserName: any;
         browserVersion: any;
     };
+    get driverServerUrl(): any;
+    get capabilities(): any;
     executeScript(script: any, args?: never[]): Promise<any>;
     findElement(selector: any, rootElement?: any): Promise<any>;
     findElements(selector: any, rootElement?: any): Promise<any>;
@@ -38,3 +62,4 @@ export declare class MockDriver {
     toJSON(): string;
     getCurrentWorld(): Promise<"NATIVE_APP" | "WEBVIEW_1">;
 }
+export {};

package/types/fake/spec-driver.d.ts

@@ -39,4 +39,5 @@ export declare function getCurrentWorld(driver: Driver): Promise<any>;
 export declare function getElementRegion(_driver: Driver, element: Element): Promise<Region>;
 export declare function getElementAttribute(_driver: Driver, element: Element, attr: string): Promise<string>;
 export declare function performAction(_driver: Driver, _steps: any[]): Promise<void>;
+export declare function getCapabilities(driver: Driver): Promise<Record<string, any>>;
 export {};

package/types/types.d.ts

@@ -49,6 +49,7 @@ export type Environment = {
     isIOS?: boolean;
     isMac?: boolean;
     isWindows?: boolean;
+    isKobiton?: boolean;
 };
 export type Viewport = {
     displaySize?: Size;