Merge branch 'main' into fix-enhanceErrorBe-ambigious-isNot-failure-message

christian-bromann · web-flow · commit 82f527a0a3c5 · 2026-01-31T20:19:09.000-08:00
diff --git a/.github/workflows/update.yaml b/.github/workflows/update.yaml
@@ -27,7 +27,7 @@ jobs:
               # Don't merge updates to GitHub Actions versions automatically.
               # (Some repos may wish to limit by version range (major/minor/patch), or scope (dep vs dev-dep), too.)
               if: contains(steps.metadata.outputs.package-ecosystem, 'npm')
-              uses: lewagon/wait-on-check-action@v1.4.1
+              uses: lewagon/wait-on-check-action@v1.5.0
               with:
                   ref: ${{ github.event.pull_request.head.sha }}
                   repo-token: ${{ secrets.GITHUB_TOKEN }}
diff --git a/docs/API.md b/docs/API.md
@@ -880,6 +880,29 @@ await expect(elem).toHaveElementClass(/Container/i)
 
 In addition to the `expect-webdriverio` matchers you can use builtin Jest's [expect](https://jestjs.io/docs/expect) assertions or [expect/expectAsync](https://jasmine.github.io/api/edge/global.html#expect) for Jasmine.
 
+## Modifiers
+
+WebdriverIO supports usage of modifiers as `.not` and it will wait until the reverse condition is meet
+
+```ts
+// Wait until the element is no longer present
+await expect(element).not.toBeDisplayed()
+
+// Wait until the text is no more 'some title'
+await expect(browser).not.toHaveTitle('some title')
+```
+
+In case immediate assertion is required, use `{ wait: 0 }`
+```ts
+// Ensure element is not present right now
+await expect(element).not.toBeDisplayed({ wait: 0 })
+
+// Ensure the text is not 'some title' right now
+await expect(browser).not.toHaveTitle('some title', { wait: 0 })
+```
+
+Note: You can pair `.not` with asymmetric matchers, but to enable the wait-until behavior, `.not` must be used directly on the `expect()` call. 
+
 ## Asymmetric Matchers
 
 WebdriverIO supports usage of asymmetric matchers wherever you compare text values, e.g.:
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "expect-webdriverio",
-  "version": "5.6.3",
+  "version": "5.6.4",
   "author": "Mykola Grybyk <mykola.grybyk@gmail.com>",
   "description": "WebdriverIO Assertion Library",
   "license": "MIT",
diff --git a/src/matchers/browser/toHaveClipboardText.ts b/src/matchers/browser/toHaveClipboardText.ts
@@ -10,6 +10,7 @@ export async function toHaveClipboardText(
     expectedValue: string | RegExp | WdioAsymmetricMatcher<string>,
     options: ExpectWebdriverIO.StringOptions = DEFAULT_OPTIONS
 ) {
+    const isNot = this.isNot
     const { expectation = 'clipboard text', verb = 'have' } = this
 
     await options.beforeAssertion?.({
@@ -27,7 +28,7 @@ export async function toHaveClipboardText(
             .catch((err) => log.warn(`Couldn't set clipboard permissions: ${err}`))
         actual = await browser.execute(() => window.navigator.clipboard.readText())
         return compareText(actual, expectedValue, options).result
-    }, options)
+    }, isNot, options)
 
     const message = enhanceError('browser', expectedValue, actual, this, verb, expectation, '', options)
     const result: ExpectWebdriverIO.AssertionResult = {
diff --git a/src/matchers/browser/toHaveTitle.ts b/src/matchers/browser/toHaveTitle.ts
@@ -6,6 +6,7 @@ export async function toHaveTitle(
     expectedValue: string | RegExp | WdioAsymmetricMatcher<string>,
     options: ExpectWebdriverIO.StringOptions = DEFAULT_OPTIONS
 ) {
+    const isNot = this.isNot
     const { expectation = 'title', verb = 'have' } = this
 
     await options.beforeAssertion?.({
@@ -19,7 +20,7 @@ export async function toHaveTitle(
         actual = await browser.getTitle()
 
         return compareText(actual, expectedValue, options).result
-    }, options)
+    }, isNot, options)
 
     const message = enhanceError('window', expectedValue, actual, this, verb, expectation, '', options)
     const result: ExpectWebdriverIO.AssertionResult = {
diff --git a/src/matchers/browser/toHaveUrl.ts b/src/matchers/browser/toHaveUrl.ts
@@ -6,6 +6,7 @@ export async function toHaveUrl(
     expectedValue: string | RegExp | WdioAsymmetricMatcher<string>,
     options: ExpectWebdriverIO.StringOptions = DEFAULT_OPTIONS
 ) {
+    const isNot = this.isNot
     const { expectation = 'url', verb = 'have' } = this
 
     await options.beforeAssertion?.({
@@ -19,7 +20,7 @@ export async function toHaveUrl(
         actual = await browser.getUrl()
 
         return compareText(actual, expectedValue, options).result
-    }, options)
+    }, isNot, options)
 
     const message = enhanceError('window', expectedValue, actual, this, verb, expectation, '', options)
     const result: ExpectWebdriverIO.AssertionResult = {
diff --git a/src/matchers/element/toHaveAttribute.ts b/src/matchers/element/toHaveAttribute.ts
@@ -27,6 +27,7 @@ async function conditionAttrAndValue(el: WebdriverIO.Element, attribute: string,
 }
 
 export async function toHaveAttributeAndValue(received: WdioElementMaybePromise, attribute: string, value: string | RegExp | WdioAsymmetricMatcher<string>, options: ExpectWebdriverIO.StringOptions = DEFAULT_OPTIONS) {
+    const isNot = this.isNot
     const { expectation = 'attribute', verb = 'have' } = this
 
     let el = await received?.getElement()
@@ -37,7 +38,7 @@ export async function toHaveAttributeAndValue(received: WdioElementMaybePromise,
         attr = result.values
 
         return result.success
-    }, options)
+    }, isNot, options)
 
     const expected = wrapExpectedWithArray(el, attr, value)
     const message = enhanceError(el, expected, attr, this, verb, expectation, attribute, options)
@@ -48,8 +49,9 @@ export async function toHaveAttributeAndValue(received: WdioElementMaybePromise,
     } as ExpectWebdriverIO.AssertionResult
 }
 
-async function toHaveAttributeFn(received: WdioElementMaybePromise, attribute: string, options: ExpectWebdriverIO.StringOptions) {
-    const { expectation = 'attribute', verb = 'have', isNot } = this
+async function toHaveAttributeFn(received: WdioElementMaybePromise, attribute: string) {
+    const isNot = this.isNot
+    const { expectation = 'attribute', verb = 'have' } = this
 
     let el = await received?.getElement()
 
@@ -58,9 +60,9 @@ async function toHaveAttributeFn(received: WdioElementMaybePromise, attribute: s
         el = result.el as WebdriverIO.Element
 
         return result.success
-    }, options)
+    }, isNot, {})
 
-    const message = enhanceError(el, !isNot, pass, this, verb, expectation, attribute, options)
+    const message = enhanceError(el, !isNot, pass, this, verb, expectation, attribute, {})
 
     return {
         pass,
@@ -84,7 +86,7 @@ export async function toHaveAttribute(
         // Name and value is passed in e.g. el.toHaveAttribute('attr', 'value', (opts))
         ? await toHaveAttributeAndValue.call(this, received, attribute, value, options)
         // Only name is passed in e.g. el.toHaveAttribute('attr')
-        : await toHaveAttributeFn.call(this, received, attribute, options)
+        : await toHaveAttributeFn.call(this, received, attribute)
 
     await options.afterAssertion?.({
         matcherName: 'toHaveAttribute',
diff --git a/src/matchers/element/toHaveChildren.ts b/src/matchers/element/toHaveChildren.ts
@@ -35,6 +35,7 @@ export async function toHaveChildren(
     expectedValue?: number | ExpectWebdriverIO.NumberOptions,
     options: ExpectWebdriverIO.StringOptions = DEFAULT_OPTIONS
 ) {
+    const isNot = this.isNot
     const { expectation = 'children', verb = 'have' } = this
 
     await options.beforeAssertion?.({
@@ -55,7 +56,7 @@ export async function toHaveChildren(
         children = result.values
 
         return result.success
-    }, { ...numberOptions, ...options })
+    }, isNot, { ...numberOptions, ...options })
 
     const error = numberError(numberOptions)
     const expectedArray = wrapExpectedWithArray(el, children, error)
diff --git a/src/matchers/element/toHaveClass.ts b/src/matchers/element/toHaveClass.ts
@@ -42,6 +42,7 @@ export async function toHaveElementClass(
     expectedValue: string | RegExp | Array<string | RegExp> | WdioAsymmetricMatcher<string>,
     options: ExpectWebdriverIO.StringOptions = DEFAULT_OPTIONS
 ) {
+    const isNot = this.isNot
     const { expectation = 'class', verb = 'have' } = this
 
     await options.beforeAssertion?.({
@@ -61,7 +62,7 @@ export async function toHaveElementClass(
         attr = result.values
 
         return result.success
-    }, options)
+    }, isNot, options)
 
     const message = enhanceError(el, wrapExpectedWithArray(el, attr, expectedValue), attr, this, verb, expectation, '', options)
     const result: ExpectWebdriverIO.AssertionResult = {
diff --git a/src/matchers/element/toHaveComputedLabel.ts b/src/matchers/element/toHaveComputedLabel.ts
@@ -26,6 +26,7 @@ export async function toHaveComputedLabel(
     expectedValue: string | RegExp | WdioAsymmetricMatcher<string> | Array<string | RegExp>,
     options: ExpectWebdriverIO.StringOptions = DEFAULT_OPTIONS
 ) {
+    const isNot = this.isNot
     const { expectation = 'computed label', verb = 'have' } = this
 
     await options.beforeAssertion?.({
@@ -45,6 +46,7 @@ export async function toHaveComputedLabel(
 
             return result.success
         },
+        isNot,
         options
     )
 
diff --git a/src/matchers/element/toHaveComputedRole.ts b/src/matchers/element/toHaveComputedRole.ts
@@ -26,6 +26,7 @@ export async function toHaveComputedRole(
     expectedValue: string | RegExp | WdioAsymmetricMatcher<string> | Array<string | RegExp>,
     options: ExpectWebdriverIO.StringOptions = DEFAULT_OPTIONS
 ) {
+    const isNot = this.isNot
     const { expectation = 'computed role', verb = 'have' } = this
 
     await options.beforeAssertion?.({
@@ -45,6 +46,7 @@ export async function toHaveComputedRole(
 
             return result.success
         },
+        isNot,
         options
     )
 
diff --git a/src/matchers/element/toHaveElementProperty.ts b/src/matchers/element/toHaveElementProperty.ts
@@ -42,7 +42,8 @@ export async function toHaveElementProperty(
     value?: string | RegExp | WdioAsymmetricMatcher<string> | null,
     options: ExpectWebdriverIO.StringOptions = DEFAULT_OPTIONS
 ) {
-    const { expectation = 'property', verb = 'have', isNot } = this
+    const isNot = this.isNot
+    const { expectation = 'property', verb = 'have' } = this
 
     await options.beforeAssertion?.({
         matcherName: 'toHaveElementProperty',
@@ -60,6 +61,7 @@ export async function toHaveElementProperty(
 
             return result.success
         },
+        isNot,
         options
     )
 
diff --git a/src/matchers/element/toHaveHTML.ts b/src/matchers/element/toHaveHTML.ts
@@ -22,6 +22,7 @@ export async function toHaveHTML(
     expectedValue: string | RegExp | WdioAsymmetricMatcher<string> | Array<string | RegExp>,
     options: ExpectWebdriverIO.HTMLOptions = DEFAULT_OPTIONS
 ) {
+    const isNot = this.isNot
     const { expectation = 'HTML', verb = 'have' } = this
 
     await options.beforeAssertion?.({
@@ -43,7 +44,7 @@ export async function toHaveHTML(
         actualHTML = result.values
 
         return result.success
-    }, options)
+    }, isNot, options)
 
     const message = enhanceError(el, wrapExpectedWithArray(el, actualHTML, expectedValue), actualHTML, this, verb, expectation, '', options)
 
diff --git a/src/matchers/element/toHaveHeight.ts b/src/matchers/element/toHaveHeight.ts
@@ -22,6 +22,7 @@ export async function toHaveHeight(
     expectedValue: number | ExpectWebdriverIO.NumberOptions,
     options: ExpectWebdriverIO.CommandOptions = DEFAULT_OPTIONS
 ) {
+    const isNot = this.isNot
     const { expectation = 'height', verb = 'have' } = this
 
     await options.beforeAssertion?.({
@@ -52,6 +53,7 @@ export async function toHaveHeight(
 
             return result.success
         },
+        isNot,
         { ...numberOptions, ...options }
     )
 
diff --git a/src/matchers/element/toHaveSize.ts b/src/matchers/element/toHaveSize.ts
@@ -19,6 +19,7 @@ export async function toHaveSize(
     expectedValue: { height: number; width: number },
     options: ExpectWebdriverIO.CommandOptions = DEFAULT_OPTIONS
 ) {
+    const isNot = this.isNot
     const { expectation = 'size', verb = 'have' } = this
 
     await options.beforeAssertion?.({
@@ -39,6 +40,7 @@ export async function toHaveSize(
 
             return result.success
         },
+        isNot,
         options
     )
 
diff --git a/src/matchers/element/toHaveStyle.ts b/src/matchers/element/toHaveStyle.ts
@@ -17,6 +17,7 @@ export async function toHaveStyle(
     expectedValue: { [key: string]: string; },
     options: ExpectWebdriverIO.StringOptions = DEFAULT_OPTIONS
 ) {
+    const isNot = this.isNot
     const { expectation = 'style', verb = 'have' } = this
 
     await options.beforeAssertion?.({
@@ -34,7 +35,7 @@ export async function toHaveStyle(
         actualStyle = result.values
 
         return result.success
-    }, options)
+    }, isNot, options)
 
     const message = enhanceError(el, wrapExpectedWithArray(el, actualStyle, expectedValue), actualStyle, this, verb, expectation, '', options)
 
diff --git a/src/matchers/element/toHaveText.ts b/src/matchers/element/toHaveText.ts
@@ -42,6 +42,7 @@ export async function toHaveText(
     expectedValue: string | RegExp | WdioAsymmetricMatcher<string> | Array<string | RegExp>,
     options: ExpectWebdriverIO.StringOptions = DEFAULT_OPTIONS
 ) {
+    const isNot = this.isNot
     const { expectation = 'text', verb = 'have' } = this
 
     await options.beforeAssertion?.({
@@ -63,7 +64,7 @@ export async function toHaveText(
         actualText = result.values
 
         return result.success
-    }, options)
+    }, isNot, options)
 
     const message = enhanceError(el, wrapExpectedWithArray(el, actualText, expectedValue), actualText, this, verb, expectation, '', options)
     const result: ExpectWebdriverIO.AssertionResult = {
diff --git a/src/matchers/element/toHaveWidth.ts b/src/matchers/element/toHaveWidth.ts
@@ -22,6 +22,7 @@ export async function toHaveWidth(
     expectedValue: number | ExpectWebdriverIO.NumberOptions,
     options: ExpectWebdriverIO.CommandOptions = DEFAULT_OPTIONS
 ) {
+    const isNot = this.isNot
     const { expectation = 'width', verb = 'have' } = this
 
     await options.beforeAssertion?.({
@@ -52,6 +53,7 @@ export async function toHaveWidth(
 
             return result.success
         },
+        isNot,
         { ...numberOptions, ...options }
     )
 
diff --git a/src/matchers/elements/toBeElementsArrayOfSize.ts b/src/matchers/elements/toBeElementsArrayOfSize.ts
@@ -8,6 +8,7 @@ export async function toBeElementsArrayOfSize(
     expectedValue: number | ExpectWebdriverIO.NumberOptions,
     options: ExpectWebdriverIO.StringOptions = DEFAULT_OPTIONS
 ) {
+    const isNot = this.isNot
     const { expectation = 'elements array of size', verb = 'be' } = this
 
     await options.beforeAssertion?.({
@@ -37,7 +38,7 @@ export async function toBeElementsArrayOfSize(
         }
         elements = await refetchElements(elements, numberOptions.wait, true)
         return false
-    }, { ...numberOptions, ...options })
+    }, isNot, { ...numberOptions, ...options })
 
     if (Array.isArray(received) && pass) {
         for (let index = originalLength; index < elements.length; index++) {
diff --git a/src/matchers/mock/toBeRequestedTimes.ts b/src/matchers/mock/toBeRequestedTimes.ts
@@ -7,6 +7,7 @@ export async function toBeRequestedTimes(
     expectedValue: number | ExpectWebdriverIO.NumberOptions = {},
     options: ExpectWebdriverIO.StringOptions = DEFAULT_OPTIONS
 ) {
+    const isNot = this.isNot || false
     const { expectation = `called${typeof expectedValue === 'number' ? ' ' + expectedValue : '' } time${expectedValue !== 1 ? 's' : ''}`, verb = 'be' } = this
 
     await options.beforeAssertion?.({
@@ -24,7 +25,7 @@ export async function toBeRequestedTimes(
     const pass = await waitUntil(async () => {
         actual = received.calls.length
         return compareNumbers(actual, numberOptions)
-    }, { ...numberOptions, ...options })
+    }, isNot, { ...numberOptions, ...options })
 
     const error = numberError(numberOptions)
     const message = enhanceError('mock', error, actual, this, verb, expectation, '', numberOptions)
diff --git a/src/matchers/mock/toBeRequestedWith.ts b/src/matchers/mock/toBeRequestedWith.ts
@@ -24,7 +24,8 @@ export async function toBeRequestedWith(
     expectedValue: ExpectWebdriverIO.RequestedWith = {},
     options: ExpectWebdriverIO.CommandOptions = DEFAULT_OPTIONS
 ) {
-    const { expectation = 'called with', verb = 'be', isNot } = this
+    const isNot = this.isNot || false
+    const { expectation = 'called with', verb = 'be' } = this
 
     await options.beforeAssertion?.({
         matcherName: 'toBeRequestedWith',
@@ -53,6 +54,7 @@ export async function toBeRequestedWith(
 
             return false
         },
+        isNot,
         { ...options, wait: isNot ? 0 : options.wait }
     )
 
diff --git a/src/util/refetchElements.ts b/src/util/refetchElements.ts
diff --git a/src/utils.ts b/src/utils.ts
diff --git a/test/matchers.test.ts b/test/matchers.test.ts
diff --git a/test/util/refetchElements.test.ts b/test/util/refetchElements.test.ts
diff --git a/test/utils.test.ts b/test/utils.test.ts

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "expect-webdriverio",`
`3`		`- "version": "5.6.3",`
	`3`	`+ "version": "5.6.4",`
`4`	`4`	`"author": "Mykola Grybyk <[email protected]>",`
`5`	`5`	`"description": "WebdriverIO Assertion Library",`
`6`	`6`	`"license": "MIT",`