@applitools/driver 1.9.35 → 1.10.1

package/dist/driver.js

@@ -117,10 +117,14 @@ class Driver {
     }
     get isNative() {
         var _a, _b;
-        return (_b = (_a = this._driverInfo) === null || _a === void 0 ? void 0 : _a.isNative) !== null && _b !== void 0 ? _b : false;
+        return (_b = (!this.isWebView && ((_a = this._driverInfo) === null || _a === void 0 ? void 0 : _a.isNative))) !== null && _b !== void 0 ? _b : false;
+    }
+    get isWebView() {
+        var _a, _b;
+        return (_b = (_a = this._driverInfo) === null || _a === void 0 ? void 0 : _a.isWebView) !== null && _b !== void 0 ? _b : false;
     }
     get isWeb() {
-        return !this.isNative;
+        return this.isWebView || !this.isNative;
     }
     get isMobile() {
         var _a, _b;
@@ -156,6 +160,8 @@ class Driver {
         if (this.isMobile) {
             this._driverInfo.orientation =
                 (_g = (await this.getOrientation().catch(() => undefined))) !== null && _g !== void 0 ? _g : this._driverInfo.orientation;
+            const world = this.isMobile && (await this.getCurrentWorld());
+            this._driverInfo.isWebView = !!(world === null || world === void 0 ? void 0 : world.isWebView);
         }
         if (this.isWeb) {
             (_h = (_6 = this._driverInfo).pixelRatio) !== null && _h !== void 0 ? _h : (_6.pixelRatio = await this.execute(snippets.getPixelRatio));
@@ -271,6 +277,85 @@ class Driver {
         this._logger.log('Combined driver info', this._driverInfo);
         return this;
     }
+    // begin world
+    //
+    // About the concept of a  "World":
+    //
+    // Since "context" is an overloaded term from frames, we have decided to use
+    // the concept of a "world" when switching between mobile app contexts (e.g., native and webview(s))
+    //
+    // Notes:
+    // - two new functions need to be added to a spec driver for this to work (`getCurrentWorld` and `switchWorld`)
+    // - you can see a reference implementation of this in spec-driver-webdriverio
+    // - if a world id is provided it will be used for switching
+    // - if a world id is not provided, the first non-native world will be used
+    //    (regardless of which world the driver is currently switched into)
+    // - before switching, the current world context is stored so it can switched back to later
+    //    (with the `restoreState` option)
+    // - the native app world can be switched to (with the `goHome` option)
+    async switchWorld(options) {
+        var _a, _b;
+        if ((options === null || options === void 0 ? void 0 : options.restoreState) && !this._previousWorld)
+            return;
+        if (!this._spec.getCurrentWorld || !this._spec.switchWorld) {
+            this._logger.warn('world switching not implemented in the spec driver, skipping');
+            return;
+        }
+        this._logger.log('switchWorld called with', options ? options : 'no options');
+        const { id, home, next } = await this.getCurrentWorld();
+        if (!this._previousWorld) {
+            this._logger.log('storing current world id for future restoration', id);
+            this._previousWorld = id;
+        }
+        const providedTarget = (options === null || options === void 0 ? void 0 : options.restoreState)
+            ? this._previousWorld
+            : (options === null || options === void 0 ? void 0 : options.goHome)
+                ? home
+                : (options === null || options === void 0 ? void 0 : options.id)
+                    ? options.id
+                    : next;
+        this._logger.log('switching world with', providedTarget ? providedTarget : 'no id');
+        try {
+            await ((_b = (_a = this._spec).switchWorld) === null || _b === void 0 ? void 0 : _b.call(_a, this.target, providedTarget));
+            await this.init();
+        }
+        catch (error) {
+            throw new Error(`Unable to switch worlds, the original error was: ${error.message}`);
+        }
+    }
+    async getWorlds(attempt = 1) {
+        var _a, _b;
+        if (!this._spec.getWorlds)
+            return;
+        this._logger.log('attempting to find worlds');
+        await utils.general.sleep(500);
+        const worlds = await ((_b = (_a = this._spec).getWorlds) === null || _b === void 0 ? void 0 : _b.call(_a, this.target));
+        if (!worlds[1]) {
+            if (attempt > 5) {
+                this._logger.warn(`just one world found - ${worlds}. done looking.`);
+                return worlds;
+            }
+            this._logger.log(`just one world found, retrying to see if there are others (attempt #${attempt})`);
+            await this.getWorlds(attempt + 1);
+        }
+        this._logger.log(`worlds found - ${worlds}`);
+        return worlds;
+    }
+    async getCurrentWorld() {
+        var _a, _b;
+        if (!this._spec.getCurrentWorld)
+            return;
+        const [origin, next] = await this.getWorlds();
+        const currentWorld = await ((_b = (_a = this._spec).getCurrentWorld) === null || _b === void 0 ? void 0 : _b.call(_a, this.target));
+        return {
+            id: currentWorld,
+            home: origin,
+            next,
+            isNative: currentWorld === origin,
+            isWebView: currentWorld !== origin,
+        };
+    }
+    // end world
     async refreshContexts() {
         if (this.isNative)
             return this.currentContext;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/driver",
-  "version": "1.9.35",
+  "version": "1.10.1",
   "description": "Applitools universal framework wrapper",
   "keywords": [
     "applitools",
@@ -87,9 +87,9 @@
     }
   },
   "dependencies": {
-    "@applitools/logger": "1.1.23",
+    "@applitools/logger": "1.1.24",
     "@applitools/snippets": "2.4.5",
-    "@applitools/types": "1.5.16",
+    "@applitools/types": "1.5.17",
     "@applitools/utils": "1.3.12",
     "semver": "7.3.7"
   },

package/types/driver.d.ts

@@ -19,6 +19,7 @@ export declare class Driver<TDriver, TContext, TElement, TSelector> {
     private _logger;
     private _customConfig;
     private _helper?;
+    private _previousWorld;
     protected readonly _spec: types.SpecDriver<TDriver, TContext, TElement, TSelector>;
     constructor(options: DriverOptions<TDriver, TContext, TElement, TSelector>);
     get target(): TDriver;
@@ -41,6 +42,7 @@ export declare class Driver<TDriver, TContext, TElement, TSelector> {
     get statusBarSize(): number;
     get navigationBarSize(): number;
     get isNative(): boolean;
+    get isWebView(): boolean;
     get isWeb(): boolean;
     get isMobile(): boolean;
     get isIOS(): boolean;
@@ -49,6 +51,13 @@ export declare class Driver<TDriver, TContext, TElement, TSelector> {
     get isEdgeLegacy(): boolean;
     updateCurrentContext(context: Context<TDriver, TContext, TElement, TSelector>): void;
     init(): Promise<this>;
+    switchWorld(options?: {
+        id?: string;
+        restoreState?: boolean;
+        goHome?: boolean;
+    }): Promise<void>;
+    getWorlds(attempt?: number): Promise<string[]>;
+    getCurrentWorld(): Promise<types.WorldInfo>;
     refreshContexts(): Promise<Context<TDriver, TContext, TElement, TSelector>>;
     switchTo(context: Context<TDriver, TContext, TElement, TSelector>): Promise<Context<TDriver, TContext, TElement, TSelector>>;
     switchToMainContext(): Promise<Context<TDriver, TContext, TElement, TSelector>>;