fix(browser): keep querying elements even if locator is created with elementLocator, add pubic @vitest/browser/utils (#6296)

sheremet-va · web-flow · commit 30dc57930931 · 2024-08-07T13:40:18.000+02:00
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -40,13 +40,15 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest]
-        node_version: [18, 20]
+        # Reset back to 20 after https://github.com/nodejs/node/issues/53648
+        # (The issues is closed, but the error persist even after 20.14)
+        node_version: [18, 20.14]
         # node_version: [18, 20, 22] 22 when LTS is close enough
         include:
           - os: macos-14
-            node_version: 20
+            node_version: 20.14
           - os: windows-latest
-            node_version: 20
+            node_version: 20.14
       fail-fast: false
 
     steps:
diff --git a/packages/browser/package.json b/packages/browser/package.json
@@ -44,6 +44,10 @@
       "types": "./dist/locators/index.d.ts",
       "default": "./dist/locators/index.js"
     },
+    "./utils": {
+      "types": "./utils.d.ts",
+      "default": "./dist/utils.js"
+    },
     "./*": "./*"
   },
   "main": "./dist/index.js",
diff --git a/packages/browser/rollup.config.js b/packages/browser/rollup.config.js
@@ -66,6 +66,7 @@ export default () =>
         'locators/webdriverio': './src/client/tester/locators/webdriverio.ts',
         'locators/preview': './src/client/tester/locators/preview.ts',
         'locators/index': './src/client/tester/locators/index.ts',
+        'utils': './src/client/tester/public-utils.ts',
       },
       output: {
         dir: 'dist',
@@ -129,9 +130,11 @@ export default () =>
       ],
     },
     {
-      input: './src/client/tester/locators/index.ts',
+      input: {
+        'locators/index': './src/client/tester/locators/index.ts',
+      },
       output: {
-        file: 'dist/locators/index.d.ts',
+        dir: 'dist',
         format: 'esm',
       },
       external,
diff --git a/packages/browser/src/client/tester/locators/index.ts b/packages/browser/src/client/tester/locators/index.ts
@@ -12,7 +12,6 @@ import type { BrowserRPC } from '@vitest/browser/client'
 import {
   Ivya,
   type ParsedSelector,
-  asLocator,
   getByAltTextSelector,
   getByLabelSelector,
   getByPlaceholderSelector,
@@ -24,6 +23,7 @@ import {
 import type { WorkerGlobalState } from 'vitest'
 import type { BrowserRunnerState } from '../../utils'
 import { getBrowserState, getWorkerState } from '../../utils'
+import { getElementError } from '../public-utils'
 
 // we prefer using playwright locators because they are more powerful and support Shadow DOM
 export const selectorEngine = Ivya.create({
@@ -45,8 +45,8 @@ export abstract class Locator {
   public abstract selector: string
 
   private _parsedSelector: ParsedSelector | undefined
+  protected _container?: Element | undefined
   protected _pwSelector?: string | undefined
-  protected _forceElement?: Element | undefined
 
   public click(options: UserEventClickOptions = {}): Promise<void> {
     return this.triggerCommand<void>('__vitest_click', this.selector, options)
@@ -143,25 +143,19 @@ export abstract class Locator {
   }
 
   public query(): Element | null {
-    if (this._forceElement) {
-      return this._forceElement
-    }
     const parsedSelector = this._parsedSelector || (this._parsedSelector = selectorEngine.parseSelector(this._pwSelector || this.selector))
     return selectorEngine.querySelector(parsedSelector, document.documentElement, true)
   }
 
   public element(): Element {
     const element = this.query()
     if (!element) {
-      throw new Error(`element not found: ${asLocator('javascript', this._pwSelector || this.selector)}`)
+      throw getElementError(this._pwSelector || this.selector, this._container || document.documentElement)
     }
     return element
   }
 
   public elements(): Element[] {
-    if (this._forceElement) {
-      return [this._forceElement]
-    }
     const parsedSelector = this._parsedSelector || (this._parsedSelector = selectorEngine.parseSelector(this._pwSelector || this.selector))
     return selectorEngine.querySelectorAll(parsedSelector, document.documentElement)
   }
diff --git a/packages/browser/src/client/tester/locators/playwright.ts b/packages/browser/src/client/tester/locators/playwright.ts
@@ -34,20 +34,26 @@ page.extend({
   },
 
   elementLocator(element: Element) {
-    return new PlaywrightLocator(selectorEngine.generateSelectorSimple(element), element)
+    return new PlaywrightLocator(
+      selectorEngine.generateSelectorSimple(element),
+      element,
+    )
   },
 })
 
 class PlaywrightLocator extends Locator {
-  constructor(public selector: string, protected _forceElement?: Element) {
+  constructor(public selector: string, protected _container?: Element) {
     super()
   }
 
   protected locator(selector: string) {
-    return new PlaywrightLocator(`${this.selector} >> ${selector}`)
+    return new PlaywrightLocator(`${this.selector} >> ${selector}`, this._container)
   }
 
   protected elementLocator(element: Element) {
-    return new PlaywrightLocator(selectorEngine.generateSelectorSimple(element), element)
+    return new PlaywrightLocator(
+      selectorEngine.generateSelectorSimple(element),
+      element,
+    )
   }
 }
diff --git a/packages/browser/src/client/tester/locators/preview.ts b/packages/browser/src/client/tester/locators/preview.ts
@@ -10,6 +10,7 @@ import {
   getByTitleSelector,
 } from 'ivya'
 import { convertElementToCssSelector } from '../../utils'
+import { getElementError } from '../public-utils'
 import { Locator, selectorEngine } from './index'
 
 page.extend({
@@ -36,19 +37,22 @@ page.extend({
   },
 
   elementLocator(element: Element) {
-    return new PreviewLocator(selectorEngine.generateSelectorSimple(element), element)
+    return new PreviewLocator(
+      selectorEngine.generateSelectorSimple(element),
+      element,
+    )
   },
 })
 
 class PreviewLocator extends Locator {
-  constructor(protected _pwSelector: string, protected _forceElement?: Element) {
+  constructor(protected _pwSelector: string, protected _container?: Element) {
     super()
   }
 
   override get selector() {
     const selectors = this.elements().map(element => convertElementToCssSelector(element))
     if (!selectors.length) {
-      throw new Error(`element not found: ${this._pwSelector}`)
+      throw getElementError(this._pwSelector, this._container || document.documentElement)
     }
     return selectors.join(', ')
   }
@@ -100,10 +104,13 @@ class PreviewLocator extends Locator {
   }
 
   protected locator(selector: string) {
-    return new PreviewLocator(`${this._pwSelector} >> ${selector}`)
+    return new PreviewLocator(`${this._pwSelector} >> ${selector}`, this._container)
   }
 
   protected elementLocator(element: Element) {
-    return new PreviewLocator(selectorEngine.generateSelectorSimple(element), element)
+    return new PreviewLocator(
+      selectorEngine.generateSelectorSimple(element),
+      element,
+    )
   }
 }
diff --git a/packages/browser/src/client/tester/locators/webdriverio.ts b/packages/browser/src/client/tester/locators/webdriverio.ts
@@ -9,6 +9,7 @@ import {
   getByTitleSelector,
 } from 'ivya'
 import { convertElementToCssSelector } from '../../utils'
+import { getElementError } from '../public-utils'
 import { Locator, selectorEngine } from './index'
 
 page.extend({
@@ -35,19 +36,19 @@ page.extend({
   },
 
   elementLocator(element: Element) {
-    return new WebdriverIOLocator(selectorEngine.generateSelectorSimple(element), element)
+    return new WebdriverIOLocator(selectorEngine.generateSelectorSimple(element))
   },
 })
 
 class WebdriverIOLocator extends Locator {
-  constructor(protected _pwSelector: string, protected _forceElement?: Element) {
+  constructor(protected _pwSelector: string, protected _container?: Element) {
     super()
   }
 
   override get selector() {
     const selectors = this.elements().map(element => convertElementToCssSelector(element))
     if (!selectors.length) {
-      throw new Error(`element not found: ${this._pwSelector}`)
+      throw getElementError(this._pwSelector, this._container || document.documentElement)
     }
     return selectors.join(', ')
   }
@@ -58,7 +59,7 @@ class WebdriverIOLocator extends Locator {
   }
 
   protected locator(selector: string) {
-    return new WebdriverIOLocator(`${this._pwSelector} >> ${selector}`)
+    return new WebdriverIOLocator(`${this._pwSelector} >> ${selector}`, this._container)
   }
 
   protected elementLocator(element: Element) {
diff --git a/packages/browser/src/client/tester/public-utils.ts b/packages/browser/src/client/tester/public-utils.ts
@@ -0,0 +1,72 @@
+import { type Locator, type LocatorSelectors, page } from '@vitest/browser/context'
+import { type StringifyOptions, stringify } from 'vitest/utils'
+import { asLocator } from 'ivya'
+
+export function getElementLocatorSelectors(element: Element): LocatorSelectors {
+  const locator = page.elementLocator(element)
+  return {
+    getByAltText: (altText, options) => locator.getByAltText(altText, options),
+    getByLabelText: (labelText, options) => locator.getByLabelText(labelText, options),
+    getByPlaceholder: (placeholderText, options) => locator.getByPlaceholder(placeholderText, options),
+    getByRole: (role, options) => locator.getByRole(role, options),
+    getByTestId: testId => locator.getByTestId(testId),
+    getByText: (text, options) => locator.getByText(text, options),
+    getByTitle: (title, options) => locator.getByTitle(title, options),
+  }
+}
+
+type PrettyDOMOptions = Omit<StringifyOptions, 'maxLength'>
+
+export function debug(
+  el?: Element | Locator | null | (Element | Locator)[],
+  maxLength?: number,
+  options?: PrettyDOMOptions,
+): void {
+  if (Array.isArray(el)) {
+    // eslint-disable-next-line no-console
+    el.forEach(e => console.log(prettyDOM(e, maxLength, options)))
+  }
+  else {
+    // eslint-disable-next-line no-console
+    console.log(prettyDOM(el, maxLength, options))
+  }
+}
+
+export function prettyDOM(
+  dom?: Element | Locator | undefined | null,
+  maxLength: number = Number(import.meta.env.DEBUG_PRINT_LIMIT ?? 7000),
+  prettyFormatOptions: PrettyDOMOptions = {},
+): string {
+  if (maxLength === 0) {
+    return ''
+  }
+
+  if (!dom) {
+    dom = document.body
+  }
+
+  if ('element' in dom && 'all' in dom) {
+    dom = dom.element()
+  }
+
+  const type = typeof dom
+  if (type !== 'object' || !dom.outerHTML) {
+    const typeName = type === 'object' ? dom.constructor.name : type
+    throw new TypeError(`Expecting a valid DOM element, but got ${typeName}.`)
+  }
+
+  const pretty = stringify(dom, Number.POSITIVE_INFINITY, {
+    maxLength,
+    highlight: true,
+    ...prettyFormatOptions,
+  })
+  return dom.outerHTML.length > maxLength
+    ? `${pretty.slice(0, maxLength)}...`
+    : pretty
+}
+
+export function getElementError(selector: string, container: Element): Error {
+  const error = new Error(`Cannot find element with locator: ${asLocator('javascript', selector)}\n\n${prettyDOM(container)}`)
+  error.name = 'VitestBrowserElementError'
+  return error
+}
diff --git a/packages/browser/src/client/tester/tester.html b/packages/browser/src/client/tester/tester.html
@@ -21,7 +21,7 @@
     {__VITEST_INTERNAL_SCRIPTS__}
     {__VITEST_SCRIPTS__}
   </head>
-  <body data-vitest-body>
+  <body>
     <script type="module" src="./tester.ts"></script>
     {__VITEST_APPEND__}
   </body>
diff --git a/packages/browser/src/client/tester/tester.ts b/packages/browser/src/client/tester/tester.ts
@@ -1,4 +1,5 @@
 import { SpyModule, collectTests, setupCommonEnv, startTests } from 'vitest/browser'
+import { page } from '@vitest/browser/context'
 import { channel, client, onCancel } from '@vitest/browser/client'
 import { getBrowserState, getConfig, getWorkerState } from '../utils'
 import { setupDialogsSpy } from './dialog'
@@ -8,6 +9,8 @@ import { browserHashMap, initiateRunner } from './runner'
 import { VitestBrowserClientMocker } from './mocker'
 import { setupExpectDom } from './expect-element'
 
+const cleanupSymbol = Symbol.for('vitest:component-cleanup')
+
 const url = new URL(location.href)
 const reloadStart = url.searchParams.get('__reloadStart')
 
@@ -123,6 +126,18 @@ async function executeTests(method: 'run' | 'collect', files: string[]) {
     }
   }
   finally {
+    try {
+      if (cleanupSymbol in page) {
+        (page[cleanupSymbol] as any)()
+      }
+    }
+    catch (error: any) {
+      await client.rpc.onUnhandledError({
+        name: error.name,
+        message: error.message,
+        stack: String(error.stack),
+      }, 'Cleanup Error')
+    }
     state.environmentTeardownRun = true
     debug('finished running tests')
     done(files)
diff --git a/packages/browser/utils.d.ts b/packages/browser/utils.d.ts
@@ -0,0 +1,21 @@
+// should be in sync with tester/public-utils.ts
+// we cannot bundle it because vitest depend on the @vitest/browser and vise versa
+// fortunately, the file is quite small
+
+import { LocatorSelectors } from '@vitest/browser/context'
+import { StringifyOptions } from 'vitest/utils'
+
+type PrettyDOMOptions = Omit<StringifyOptions, 'maxLength'>
+
+export declare function getElementLocatorSelectors(element: Element): LocatorSelectors
+export declare function debug(
+  el?: Element | Locator | null | (Element | Locator)[],
+  maxLength?: number,
+  options?: PrettyDOMOptions,
+): void
+export declare function prettyDOM(
+  dom?: Element | Locator | undefined | null,
+  maxLength?: number,
+  prettyFormatOptions?: PrettyDOMOptions,
+): string
+export declare function getElementError(selector: string, container?: Element): Error
diff --git a/packages/utils/src/display.ts b/packages/utils/src/display.ts
@@ -41,10 +41,14 @@ const PLUGINS = [
   AsymmetricMatcher,
 ]
 
+export interface StringifyOptions extends PrettyFormatOptions {
+  maxLength?: number
+}
+
 export function stringify(
   object: unknown,
   maxDepth = 10,
-  { maxLength, ...options }: PrettyFormatOptions & { maxLength?: number } = {},
+  { maxLength, ...options }: StringifyOptions = {},
 ): string {
   const MAX_LENGTH = maxLength ?? 10000
   let result
diff --git a/packages/utils/src/index.ts b/packages/utils/src/index.ts
@@ -29,6 +29,7 @@ export {
   inspect,
   objDisplay,
 } from './display'
+export type { StringifyOptions } from './display'
 export {
   positionToOffset,
   offsetToLineNumber,
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/test/browser/fixtures/locators/query.test.ts b/test/browser/fixtures/locators/query.test.ts
diff --git a/test/browser/package.json b/test/browser/package.json
diff --git a/test/browser/specs/locators.test.ts b/test/browser/specs/locators.test.ts
diff --git a/test/browser/test/__snapshots__/utils.test.ts.snap b/test/browser/test/__snapshots__/utils.test.ts.snap
diff --git a/test/browser/test/utils.test.ts b/test/browser/test/utils.test.ts
