feat: adding more tests

- fix the LT capability support

Author: wswebcreation

package.json

@@ -41,6 +41,7 @@
     "test.saucelabs.sims.web": "SAUCE_ENV=sims wdio ./tests/configs/wdio.saucelabs.web.conf.ts",
     "test.lambdatest.desktop": "LT_ENV=desktop wdio ./tests/configs/wdio.lambdatest.web.conf.ts",
     "test.lambdatest.web": "wdio ./tests/configs/wdio.lambdatest.web.conf.ts",
+    "test.lambdatest.emu.web": "LT_ENV=emu wdio ./tests/configs/wdio.lambdatest.web.conf.ts",
     "pnpm.install.workaround": "pnpm install --shamefully-hoist",
     "update.packages": "node ./scripts/update.packages.mjs",
     "prepare": "husky",
@@ -71,6 +72,7 @@
     "@wdio/appium-service": "^9.4.2",
     "@wdio/cli": "^9.4.2",
     "@wdio/globals": "^9.4.2",
+    "wdio-lambdatest-service": "^3.0.3",
     "@wdio/local-runner": "^9.4.2",
     "@wdio/mocha-framework": "^9.4.2",
     "@wdio/sauce-service": "^9.4.2",

packages/visual-service/src/utils.ts

@@ -151,6 +151,17 @@ async function getMobileInstanceData({
     }
 }
 
+/**
+ * Get the LambdaTest options, these can be case insensitive
+ */
+export function getLtOptions(capabilities: WebdriverIO.Capabilities): any | undefined {
+    const key = Object.keys(capabilities).find(
+        (k) => k.toLowerCase() === 'lt:options'
+    )
+
+    return key ? (capabilities as Record<string, any>)[key] : undefined
+}
+
 /**
  * Get the device name
  */
@@ -167,11 +178,18 @@ function getDeviceName(currentBrowser: WebdriverIO.Browser): string {
     // - return the "requested" deviceName in the session capabilities
     // - don't use the `appium:deviceName` capability
     const isBrowserStack = 'bstack:options' in requestedCapabilities
-    const bsOptions = (requestedCapabilities as WebdriverIO.Capabilities)['bstack:options']
+    const bsOptions = requestedCapabilities['bstack:options']
     const capName = 'deviceName'
     if (isBrowserStack && bsOptions && capName in bsOptions){
         deviceName = bsOptions[capName as keyof typeof bsOptions] as string
     }
+    // Same for LabdaTest
+    const isLambdaTest = 'lt:options' in requestedCapabilities
+    const ltOptions = getLtOptions(requestedCapabilities)
+    if (isLambdaTest && ltOptions && capName in ltOptions){
+        deviceName = ltOptions[capName as keyof typeof ltOptions] as string
+    }
+
     const { 'appium:deviceName': requestedDeviceName } = requestedCapabilities as AppiumCapabilities
 
     return (deviceName !== NOT_KNOWN ? deviceName : requestedDeviceName || returnedDeviceName || NOT_KNOWN).toLowerCase()
@@ -217,7 +235,10 @@ export async function getInstanceData(currentBrowser: WebdriverIO.Browser): Prom
         ? rawApp.replace(/\\/g, '/').split('/').pop().replace(/[^a-zA-Z0-9.]/g, '_')
         : NOT_KNOWN
     const deviceName = getDeviceName(currentBrowser)
-    const nativeWebScreenshot = !!((requestedCapabilities as Capabilities.AppiumAndroidCapabilities)['appium:nativeWebScreenshot'])
+    const ltOptions = getLtOptions(requestedCapabilities)
+    // @TODO: Figure this one out in the future when we know more about the Appium capabilities from LT
+    // 20241216: LT doesn't have the option to take a ChromeDriver screenshot, so if it's Android it's always native
+    const nativeWebScreenshot = isAndroid && ltOptions || !!((requestedCapabilities as Capabilities.AppiumAndroidCapabilities)['appium:nativeWebScreenshot'])
     const platformVersion = (rawPlatformVersion === undefined || rawPlatformVersion === '') ? NOT_KNOWN : rawPlatformVersion.toLowerCase()
 
     const { devicePixelRatio: mobileDevicePixelRatio, devicePlatformRect, deviceScreenSize, } = await getMobileInstanceData({ currentBrowser, isAndroid, isMobile })
@@ -269,6 +290,7 @@ export function determineNativeContext(
     }
 
     // If not check if it's a mobile
+    // @TODO: Also check for LT
     if (driver.isMobile) {
         const isAppiumAppCapPresent = (capabilities: AppiumCapabilities) => {
             const appiumKeys = [

packages/visual-service/tests/__snapshots__/utils.test.ts.snap

@@ -268,6 +268,45 @@ exports[`utils > getInstanceData > should return instance data when the browsers
 }
 `;
 
+exports[`utils > getInstanceData > should return instance data when the lambdatest capabilities are provided 1`] = `
+{
+  "appName": "not-known",
+  "browserName": "chrome",
+  "browserVersion": "75.123",
+  "deviceName": "samsung galaxy s22 lt",
+  "devicePixelRatio": 1,
+  "devicePlatformRect": {
+    "homeBar": {
+      "height": 0,
+      "width": 0,
+      "x": 0,
+      "y": 0,
+    },
+    "statusBar": {
+      "height": 0,
+      "width": 0,
+      "x": 0,
+      "y": 0,
+    },
+  },
+  "deviceScreenSize": {
+    "height": 200,
+    "width": 100,
+  },
+  "isAndroid": true,
+  "isIOS": false,
+  "isMobile": true,
+  "logName": "",
+  "name": "",
+  "nativeWebScreenshot": {
+    "deviceName": "Samsung Galaxy S22 LT",
+    "platformVersion": "11",
+  },
+  "platformName": "osx",
+  "platformVersion": "11",
+}
+`;
+
 exports[`utils > getInstanceData > should return instance data when the minimum of capabilities is provided 1`] = `
 {
   "appName": "not-known",

packages/visual-service/tests/utils.test.ts

@@ -338,10 +338,33 @@ describe('utils', () => {
             })
             expect(await getInstanceData(driver)).toMatchSnapshot()
         })
+
+        it('should return instance data when the lambdatest capabilities are provided', async() => {
+            const driver = createDriverMock({
+                ...DEFAULT_DESKTOP_BROWSER,
+                requestedCapabilities:{
+                    ...DEFAULT_DESKTOP_BROWSER.requestedCapabilities,
+                    'lt:options': {
+                        deviceName: 'Samsung Galaxy S22 LT',
+                        platformVersion: '11',
+                    },
+                },
+                capabilities: {
+                    ...DEFAULT_DESKTOP_BROWSER.capabilities,
+                    // @ts-expect-error
+                    platformVersion: '11',
+                },
+                isAndroid: true,
+                isMobile: true,
+                getWindowSize: vi.fn().mockResolvedValueOnce({ width: 100, height: 200 }),
+            })
+            expect(await getInstanceData(driver)).toMatchSnapshot()
+        })
     })
 
     describe('getBrowserObject', () => {
         function createElementMock(parent: WebdriverIO.Browser): WebdriverIO.Element {
+            // @ts-expect-error
             return {
                 isMultiremote: false,
                 sessionId: 'mock-session-id',