Change logic of useDefaultBrowserType (#588)

* Change logic of useDefaultBrowserType

close #586

* Fix getDeviceBrowserType

* Fix getDeviceBrowserType test

* Fix PlaywrightEnv

Author: mmarkelov

src/PlaywrightEnvironment.ts

@@ -282,7 +282,7 @@ export const getPlaywrightEnv = (basicEnv = 'node'): unknown => {
           const { device } = config
           const browserName =
             config.useDefaultBrowserType && device
-              ? getDeviceBrowserType(device, devices)
+              ? getDeviceBrowserType(device, devices) || CHROMIUM
               : config.browser || browserType
           const deviceName = device ? getDeviceName(device) : null
           checkDevice(deviceName, devices)

src/PlaywrightRunner.ts

@@ -129,73 +129,52 @@ class PlaywrightRunner extends JestRunner {
     const { browsers, devices, connectOptions, useDefaultBrowserType } = config
     const pwTests: Test[] = []
     for (const test of tests) {
-      if (useDefaultBrowserType) {
-        const { devices: availableDevices, instance } = getPlaywrightInstance()
+      for (const browser of browsers) {
+        const browserType = getBrowserType(
+          typeof browser === 'string' ? browser : browser.name,
+        )
+        const browserConfig =
+          typeof browser === 'string'
+            ? config
+            : deepMerge(config, browser || {})
+        checkBrowserEnv(browserType)
+        const { devices: availableDevices, instance } = getPlaywrightInstance(
+          browserType,
+        )
         const resultDevices = getDevices(devices, availableDevices)
+        const key =
+          typeof browser === 'string'
+            ? browser
+            : generateKey(browser.name, browserConfig)
+        const wsEndpoint: WsEndpointType = await this.launchServer(
+          browserConfig,
+          getBrowserOptions(browserType, connectOptions)?.wsEndpoint || null,
+          browserType,
+          key,
+          instance as GenericBrowser,
+        )
 
         const browserTest = {
           test: test as JestPlaywrightTest,
-          config,
+          config: browserConfig,
+          wsEndpoint,
+          browser: browserType,
         }
-        if (resultDevices.length) {
-          for (const device of resultDevices) {
-            const browser = getDeviceBrowserType(device, availableDevices)
-            const wsEndpoint: WsEndpointType = await this.launchServer(
-              config,
-              getBrowserOptions(browser, connectOptions)?.wsEndpoint || null,
-              browser,
-              browser,
-              (instance as Record<BrowserType, GenericBrowser>)[browser],
-            )
 
+        if (resultDevices.length) {
+          resultDevices.forEach((device: DeviceType) => {
             checkDevice(device, availableDevices)
-
-            pwTests.push(
-              getBrowserTest({ ...browserTest, browser, wsEndpoint, device }),
-            )
-          }
-        }
-      } else {
-        for (const browser of browsers) {
-          const browserType = getBrowserType(
-            typeof browser === 'string' ? browser : browser.name,
-          )
-          const browserConfig =
-            typeof browser === 'string'
-              ? config
-              : deepMerge(config, browser || {})
-          checkBrowserEnv(browserType)
-          const { devices: availableDevices, instance } = getPlaywrightInstance(
-            browserType,
-          )
-          const resultDevices = getDevices(devices, availableDevices)
-          const key =
-            typeof browser === 'string'
-              ? browser
-              : generateKey(browser.name, browserConfig)
-          const wsEndpoint: WsEndpointType = await this.launchServer(
-            browserConfig,
-            getBrowserOptions(browserType, connectOptions)?.wsEndpoint || null,
-            browserType,
-            key,
-            instance as GenericBrowser,
-          )
-
-          const browserTest = {
-            test: test as JestPlaywrightTest,
-            config: browserConfig,
-            wsEndpoint,
-            browser: browserType,
-          }
-
-          if (resultDevices.length) {
-            resultDevices.forEach((device: DeviceType) => {
-              checkDevice(device, availableDevices)
-              pwTests.push(getBrowserTest({ ...browserTest, device }))
-            })
-          } else {
-            pwTests.push(getBrowserTest({ ...browserTest, device: null }))
-          }
+            if (useDefaultBrowserType) {
+              const deviceBrowser = getDeviceBrowserType(
+                device!,
+                availableDevices,
+              )
+              if (deviceBrowser !== null && deviceBrowser !== browser) return
+            }
+            pwTests.push(getBrowserTest({ ...browserTest, device }))
+          })
+        } else {
+          pwTests.push(getBrowserTest({ ...browserTest, device: null }))
         }
       }
     }

src/utils.test.ts

@@ -284,11 +284,11 @@ describe('getDeviceBrowserType', () => {
     },
   } as Playwright['devices']
 
-  it('should return "chromium" as default', async () => {
+  it('should return "null" as default', async () => {
     const device = {
       name: 'Custom',
     }
-    expect(getDeviceBrowserType(device, devices)).toBe(CHROMIUM)
+    expect(getDeviceBrowserType(device, devices)).toBe(null)
   })
 
   it('should return default browser if it is defined', async () => {

src/utils.ts

@@ -113,12 +113,12 @@ export const generateKey = (
 export const getDeviceBrowserType = (
   device: ConfigDeviceType,
   availableDevices: Playwright['devices'],
-): BrowserType => {
+): BrowserType | null => {
   if (typeof device === 'string') {
     return availableDevices[device].defaultBrowserType as BrowserType
   }
 
-  return device?.defaultBrowserType || CHROMIUM
+  return device?.defaultBrowserType || null
 }
 
 export const getPlaywrightInstance = (