fix DEFAULT_OPTIONS_TO_BE_DISPLAYED not aligne with global options

Author: dprevost-LMI

playgrounds/mocha/test/specs/options.test.ts

@@ -0,0 +1,30 @@
+import { $ } from '@wdio/globals'
+import { setOptions, getConfig } from 'expect-webdriverio'
+
+describe('Global Options', () => {
+
+    before(() => {
+        // Verify we can set the option to 1ms
+        setOptions({ wait: 1 })
+        expect(getConfig().wait).toBe(1)
+    })
+
+    it('should allow setting and using global wait option', async () => {
+        const start = Date.now()
+
+        // This should fail almost immediately because the element doesn't exist
+        // and the wait time is set to 1ms
+        await expect(expect($('non-existent-element-' + Date.now())).toBeDisplayed()).rejects.toThrow()
+        const duration = Date.now() - start
+
+        // It should take significantly less time than the default or the 250ms set in wdio.conf
+        // 1ms wait + overhead. 500ms should be a safe upper bound for "immediate" failure
+        // vs a standard 3000ms timeout
+        expect(duration).toBeLessThan(500)
+    })
+
+    after(() => {
+        // Restore the option to 250ms as inferred from wdio.conf.ts to not pollute other tests
+        setOptions({ wait: 250 })
+    })
+})

src/constants.ts

@@ -4,3 +4,16 @@ export const DEFAULT_OPTIONS: Required<ExpectWebdriverIO.DefaultOptions> = {
     beforeAssertion: async () => {},
     afterAssertion: async () => {},
 }
+
+export const DEFAULT_OPTIONS_TO_BE_DISPLAYED: Required<Omit<ExpectWebdriverIO.ToBeDisplayedOptions, 'message'>> = {
+    ...DEFAULT_OPTIONS,
+    withinViewport: false,
+    contentVisibilityAuto: true,
+    opacityProperty: true,
+    visibilityProperty: true
+}
+
+export const defaultOptionsList = [
+    DEFAULT_OPTIONS,
+    DEFAULT_OPTIONS_TO_BE_DISPLAYED
+]

src/index.ts

@@ -2,7 +2,7 @@
 import { expect as expectLib } from 'expect'
 import type { WdioMatchersObject } from './types.js'
 import * as wdioMatchers from './matchers.js'
-import { DEFAULT_OPTIONS } from './constants.js'
+import { DEFAULT_OPTIONS, defaultOptionsList } from './constants.js'
 import createSoftExpect from './softExpect.js'
 import { SoftAssertService } from './softAssert.js'
 
@@ -52,12 +52,14 @@ Object.defineProperty(expectWithSoft, 'clearSoftFailures', {
 export const expect = expectWithSoft
 
 export const getConfig = (): ExpectWebdriverIO.DefaultOptions => DEFAULT_OPTIONS
-export const setDefaultOptions = (options = {}): void => {
+export const setDefaultOptions = (options: Partial<ExpectWebdriverIO.DefaultOptions>): void => {
     Object.entries(options).forEach(([key, value]) => {
-        if (key in DEFAULT_OPTIONS) {
-            // @ts-ignore
-            DEFAULT_OPTIONS[key] = value
-        }
+        defaultOptionsList.forEach((option) => {
+            if (key in option) {
+                // @ts-ignore
+                option[key] = value
+            }
+        })
     })
 }
 export const setOptions = setDefaultOptions

src/matchers/element/toBeDisplayed.ts

@@ -1,18 +1,10 @@
 import { executeCommandBe } from '../../utils.js'
-import { DEFAULT_OPTIONS } from '../../constants.js'
 import type { WdioElementMaybePromise } from '../../types.js'
-
-const DEFAULT_OPTIONS_DISPLAYED: ExpectWebdriverIO.ToBeDisplayedOptions = {
-    ...DEFAULT_OPTIONS,
-    withinViewport: false,
-    contentVisibilityAuto: true,
-    opacityProperty: true,
-    visibilityProperty: true
-}
+import { DEFAULT_OPTIONS_TO_BE_DISPLAYED } from '../../constants.js'
 
 export async function toBeDisplayed(
     received: WdioElementMaybePromise,
-    options: ExpectWebdriverIO.ToBeDisplayedOptions = DEFAULT_OPTIONS_DISPLAYED,
+    options: ExpectWebdriverIO.ToBeDisplayedOptions = DEFAULT_OPTIONS_TO_BE_DISPLAYED,
 ) {
     this.expectation = this.expectation || 'displayed'
 
@@ -27,7 +19,7 @@ export async function toBeDisplayed(
         opacityProperty,
         visibilityProperty,
         ...commandOptions
-    } = { ...DEFAULT_OPTIONS_DISPLAYED, ...options }
+    } = { ...DEFAULT_OPTIONS_TO_BE_DISPLAYED, ...options }
 
     const result = await executeCommandBe.call(this, received, el => el?.isDisplayed({
         withinViewport,