Dont use browser object directly

percy · Apr 23, 2024 · 0b92478 · 0b92478
1 parent deeb5c9
commit 0b92478
Show file tree

Hide file tree

Showing 4 changed files with 26 additions and 30 deletions.
diff --git a/percy/driver/driverWrapper.js b/percy/driver/driverWrapper.js
@@ -14,7 +14,7 @@ class AppiumDriver {
     // in real world when you get wd driver passed so need to ignore coverage on it
 
     // In typescript for wdio we get driver.constuctor.name as 'BoundBrowser'
-    if (driver.constructor.name.includes('Browser') && !Undefined(driver.getSession)) {
+    if (driver.constructor.name.includes('Browser') && !Undefined(driver.capabilities)) {
       this.type = 'wdio';
     } else if ((driver.constructor.name === '' ||
       driver.constructor.name === 'Object') && // Object check is only added for tests
@@ -30,7 +30,7 @@ class AppiumDriver {
         return await TimeIt.run('getCapabilities', async () => {
           if (this.wd) return await this.driver.sessionCapabilities();
           /* istanbul ignore next */ // not sure why its marking it when its covered
-          if (this.wdio) return await this.driver.getSession();
+          if (this.wdio) return await this.driver.capabilities;
         });
       });
   }
@@ -108,6 +108,12 @@ class AppiumDriver {
     });
   }
 
+  async getWindowSize() {
+    return await TimeIt.run('getWindowSize', async () => {
+      return await this.driver.getWindowSize();
+    });
+  }
+
   get commandExecutorUrl() {
     if (this.wd) return `${this.driver.configUrl.protocol}//${this.remoteHostname}${this.driver.configUrl.path}`;
     /* istanbul ignore next */

diff --git a/percy/metadata/iosMetadata.js b/percy/metadata/iosMetadata.js
@@ -10,13 +10,11 @@ class IosMetadata extends Metadata {
       const data = await this.staticData();
       return data.statusBarHeight * data.pixelRatio;
     }
-    /* istanbul ignore next */
-    if (typeof browser !== 'undefined') {
-      const viewportRect = await this.viewportRect();
-      return viewportRect.top;
+
+    if (this.driver.wdio) {
+      return (await this.viewportRect()).top;
     } else {
       const caps = await this.caps();
-      // In Ios the height of statusBarHeight in caps needs to be multiplied by pixel ratio
       return (caps.statBarHeight || 1) * (caps.pixelRatio || 1);
     }
   }
@@ -35,18 +33,18 @@ class IosMetadata extends Metadata {
       const data = await this.staticData();
       return { width: data.screenWidth, height: data.screenHeight };
     }
-    /* istanbul ignore next */
-    if (typeof browser !== 'undefined') {
+
+    var height, width;
+    if (this.driver.wdio) {
       const viewportRect = await this.viewportRect();
-      const height = viewportRect.top + viewportRect.height;
-      const width = viewportRect.width;
-      return { width, height };
+      height = viewportRect.top + viewportRect.height;
+      width = viewportRect.width;
     } else {
       const caps = await this.caps();
-      const height = caps.statBarHeight * caps.pixelRatio + caps.viewportRect?.height;
-      const width = caps.viewportRect?.width;
-      return { width, height };
+      height = caps.statBarHeight * caps.pixelRatio + caps.viewportRect?.height;
+      width = caps.viewportRect?.width;
     }
+    return { width, height };
   }
 
   async viewportRect() {
@@ -71,13 +69,10 @@ class IosMetadata extends Metadata {
   }
 
   async scaleFactor() {
-    /* istanbul ignore next */
-    if (typeof browser !== 'undefined') {
+    if (this.driver.wdio) {
       const viewportRect = await this.viewportRect();
       const actualWidth = viewportRect.width;
-      /* eslint-disable */
-      const windowSize = await browser.getWindowSize();
-      /* eslint-enable */
+      const windowSize = await this.driver.getWindowSize();
       const width = windowSize.width;
       return actualWidth / width;
     } else {

diff --git a/percy/metadata/metadata.js b/percy/metadata/metadata.js
@@ -22,14 +22,7 @@ class Metadata {
   // items that need caps are moved to getters as caps are not stored on wd driver object
   // So we need to make a lazy call to avoid making session get call in app automate context
   async caps() {
-    /* istanbul ignore next */
-    if (typeof browser !== 'undefined') {
-      /* eslint-disable */
-      return await browser.capabilities;
-      /* eslint-enable */
-    } else {
-      return await this.driver.getCapabilities();
-    }
+    return await this.driver.getCapabilities();
   }
 
   async osName() {

diff --git a/test/mocks/appium/wdio_driver.js b/test/mocks/appium/wdio_driver.js
@@ -11,7 +11,7 @@ class Browser {
     appAutomate = appAutomate || false;
     const ios = platform === 'iOS' || false;
     const android = !ios;
-    deviceName = deviceName || android ? 'GenericAndroid' : 'iPhone 8 Plus'; // some device from static config
+    deviceName = deviceName || android ? 'GenericAndroid' : 'iPhone 14'; // some device from static config
     enabled = enabled === undefined ? true : enabled;
     ignoreErrors = ignoreErrors === undefined ? false : ignoreErrors;
 
@@ -45,7 +45,7 @@ class Browser {
     };
 
     this.capabilities = sessionCaps;
-
+    this.getWindowSize = jasmine.createSpy().and.resolveTo({ width: 390, height: 844, x: 0, y: 0 });
     this.getSession = jasmine.createSpy().and.returnValue(sessionCaps);
     this.takeScreenshot = jasmine.createSpy().and.resolveTo('some screenshot data');
     this.getSystemBars = jasmine.createSpy().and.resolveTo({
@@ -77,6 +77,8 @@ class Browser {
             ])
           });
         }
+      } else if (str.includes('viewportRect')) {
+        return { width: 100, height: 200 };
       }
     });
     this.getOrientation = jasmine.createSpy().and.returnValue('PORTRAIT');