(fix): allow partial matcher type in matchers

christian-bromann · christian-bromann · commit ad9c9ac0730d · 2023-11-09T00:46:04.000-08:00
diff --git a/src/matchers/browser/toHaveTitle.ts b/src/matchers/browser/toHaveTitle.ts
@@ -1,6 +1,6 @@
 import { waitUntil, enhanceError, compareText } from '../../utils.js'
 
-export async function toHaveTitle(browser: WebdriverIO.Browser, title: string | RegExp, options: ExpectWebdriverIO.StringOptions = {}) {
+export async function toHaveTitle(browser: WebdriverIO.Browser, title: string | RegExp | ExpectWebdriverIO.PartialMatcher, options: ExpectWebdriverIO.StringOptions = {}) {
     const isNot = this.isNot
     const { expectation = 'title', verb = 'have' } = this
 
diff --git a/src/matchers/browser/toHaveUrl.ts b/src/matchers/browser/toHaveUrl.ts
@@ -1,6 +1,6 @@
 import { waitUntil, enhanceError, compareText } from '../../utils.js'
 
-export async function toHaveUrl(browser: WebdriverIO.Browser, url: string | RegExp, options: ExpectWebdriverIO.StringOptions = {}) {
+export async function toHaveUrl(browser: WebdriverIO.Browser, url: string | RegExp | ExpectWebdriverIO.PartialMatcher, options: ExpectWebdriverIO.StringOptions = {}) {
     const isNot = this.isNot
     const { expectation = 'url', verb = 'have' } = this
 
diff --git a/src/matchers/element/toHaveAttribute.ts b/src/matchers/element/toHaveAttribute.ts
@@ -12,7 +12,7 @@ async function conditionAttr(el: WebdriverIO.Element, attribute: string) {
     }
 }
 
-async function conditionAttrAndValue(el: WebdriverIO.Element, attribute: string, value: string | RegExp, options: ExpectWebdriverIO.StringOptions) {
+async function conditionAttrAndValue(el: WebdriverIO.Element, attribute: string, value: string | RegExp | ExpectWebdriverIO.PartialMatcher, options: ExpectWebdriverIO.StringOptions) {
     const attr = await el.getAttribute(attribute)
     if (typeof attr !== 'string') {
         return { result: false, value: attr }
@@ -21,7 +21,7 @@ async function conditionAttrAndValue(el: WebdriverIO.Element, attribute: string,
     return compareText(attr, value, options)
 }
 
-export async function toHaveAttributeAndValueFn(received: WebdriverIO.Element | WebdriverIO.ElementArray, attribute: string, value: string | RegExp, options: ExpectWebdriverIO.StringOptions = {}) {
+export async function toHaveAttributeAndValueFn(received: WebdriverIO.Element | WebdriverIO.ElementArray, attribute: string, value: string | RegExp | ExpectWebdriverIO.PartialMatcher, options: ExpectWebdriverIO.StringOptions = {}) {
     const isNot = this.isNot
     const { expectation = 'attribute', verb = 'have' } = this
 
diff --git a/src/matchers/element/toHaveClass.ts b/src/matchers/element/toHaveClass.ts
@@ -1,6 +1,6 @@
-import { waitUntil, enhanceError, executeCommand, wrapExpectedWithArray, updateElementsArray } from '../../utils.js'
+import { waitUntil, enhanceError, executeCommand, wrapExpectedWithArray, updateElementsArray, compareText } from '../../utils.js'
 
-async function condition(el: WebdriverIO.Element, attribute: string, value: string | RegExp, options: ExpectWebdriverIO.StringOptions) {
+async function condition(el: WebdriverIO.Element, attribute: string, value: string | RegExp | ExpectWebdriverIO.PartialMatcher, options: ExpectWebdriverIO.StringOptions) {
     const { ignoreCase = false, trim = false, containing = false } = options
 
     let attr = await el.getAttribute(attribute)
@@ -13,15 +13,19 @@ async function condition(el: WebdriverIO.Element, attribute: string, value: stri
     }
     if (ignoreCase) {
         attr = attr.toLowerCase()
-        if (! (value instanceof RegExp)) {
+        if (typeof value === 'string') {
             value = value.toLowerCase()
         }
     }
 
     const classes = attr.split(' ')
 
     const valueInClasses = classes.some((t) => {
-        return value instanceof RegExp ? !!t.match(value) : containing ? t.includes(value) : t === value
+        return value instanceof RegExp
+            ? !!t.match(value)
+            : containing && typeof value === 'string'
+                ? t.includes(value)
+                : compareText(t, value, options)
     })
     return {
         value: attr,
@@ -33,7 +37,7 @@ export function toHaveElementClass(...args: any): any {
     return toHaveClass.call(this || {}, ...args)
 }
 
-export async function toHaveClass(received: WebdriverIO.Element | WebdriverIO.ElementArray, className: string | RegExp, options: ExpectWebdriverIO.StringOptions = {}) {
+export async function toHaveClass(received: WebdriverIO.Element | WebdriverIO.ElementArray, className: string | RegExp | ExpectWebdriverIO.PartialMatcher, options: ExpectWebdriverIO.StringOptions = {}) {
     const isNot = this.isNot
     const { expectation = 'class', verb = 'have' } = this
 
diff --git a/src/matchers/element/toHaveClassContaining.ts b/src/matchers/element/toHaveClassContaining.ts
@@ -4,7 +4,7 @@ export function toHaveElementClassContaining (...args: any) {
     return toHaveClassContaining.call(this, ...args)
 }
 
-export function toHaveClassContaining(el: WebdriverIO.Element, className: string | RegExp, options: ExpectWebdriverIO.StringOptions = {}) {
+export function toHaveClassContaining(el: WebdriverIO.Element, className: string | RegExp | ExpectWebdriverIO.PartialMatcher, options: ExpectWebdriverIO.StringOptions = {}) {
     return toHaveAttributeAndValueFn.call(this, el, 'class', className, {
         ...options,
         containing: true
diff --git a/src/matchers/element/toHaveComputedLabel.ts b/src/matchers/element/toHaveComputedLabel.ts
@@ -10,7 +10,7 @@ import {
 
 async function condition(
     el: WebdriverIO.Element,
-    label: string | RegExp | Array<string | RegExp>,
+    label: string | RegExp | ExpectWebdriverIO.PartialMatcher | Array<string | RegExp>,
     options: ExpectWebdriverIO.HTMLOptions
 ) {
     const actualLabel = await el.getComputedLabel()
@@ -22,7 +22,7 @@ async function condition(
 
 export async function toHaveComputedLabel(
     received: WebdriverIO.Element | WebdriverIO.ElementArray,
-    label: string | RegExp | Array<string | RegExp>,
+    label: string | RegExp | ExpectWebdriverIO.PartialMatcher | Array<string | RegExp>,
     options: ExpectWebdriverIO.StringOptions = {}
 ) {
     const isNot = this.isNot
diff --git a/src/matchers/element/toHaveComputedLabelContaining.ts b/src/matchers/element/toHaveComputedLabelContaining.ts
@@ -1,6 +1,6 @@
 import { toHaveComputedLabel } from './toHaveComputedLabel.js'
 
-export function toHaveComputedLabelContaining(el: WebdriverIO.Element, label: string | RegExp | Array<string | RegExp>, options: ExpectWebdriverIO.StringOptions = {}) {
+export function toHaveComputedLabelContaining(el: WebdriverIO.Element, label: string | RegExp | ExpectWebdriverIO.PartialMatcher | Array<string | RegExp>, options: ExpectWebdriverIO.StringOptions = {}) {
     return toHaveComputedLabel.call(this, el, label, {
         ...options,
         containing: true
diff --git a/src/matchers/element/toHaveComputedRole.ts b/src/matchers/element/toHaveComputedRole.ts
@@ -10,7 +10,7 @@ import {
 
 async function condition(
     el: WebdriverIO.Element,
-    role: string | RegExp | Array<string | RegExp>,
+    role: string | RegExp | ExpectWebdriverIO.PartialMatcher | Array<string | RegExp>,
     options: ExpectWebdriverIO.HTMLOptions
 ) {
     const actualRole = await el.getComputedRole()
@@ -22,7 +22,7 @@ async function condition(
 
 export async function toHaveComputedRole(
     received: WebdriverIO.Element | WebdriverIO.ElementArray,
-    role: string | RegExp | Array<string | RegExp>,
+    role: string | RegExp | ExpectWebdriverIO.PartialMatcher | Array<string | RegExp>,
     options: ExpectWebdriverIO.StringOptions = {}
 ) {
     const isNot = this.isNot
diff --git a/src/matchers/element/toHaveComputedRoleContaining.ts b/src/matchers/element/toHaveComputedRoleContaining.ts
@@ -1,6 +1,6 @@
 import { toHaveComputedRole } from './toHaveComputedRole.js'
 
-export function toHaveComputedRoleContaining(el: WebdriverIO.Element, role: string | RegExp | Array<string | RegExp>, options: ExpectWebdriverIO.StringOptions = {}) {
+export function toHaveComputedRoleContaining(el: WebdriverIO.Element, role: string | RegExp | ExpectWebdriverIO.PartialMatcher | Array<string | RegExp>, options: ExpectWebdriverIO.StringOptions = {}) {
     return toHaveComputedRole.call(this, el, role, {
         ...options,
         containing: true
diff --git a/src/matchers/element/toHaveElementProperty.ts b/src/matchers/element/toHaveElementProperty.ts
@@ -36,7 +36,7 @@ async function condition(
 export async function toHaveElementProperty(
     received: WebdriverIO.Element | WebdriverIO.ElementArray,
     property: string,
-    value?: string | RegExp,
+    value?: string | RegExp | ExpectWebdriverIO.PartialMatcher,
     options: ExpectWebdriverIO.StringOptions = {}
 ) {
     const isNot = this.isNot
diff --git a/src/matchers/element/toHaveHTML.ts b/src/matchers/element/toHaveHTML.ts
@@ -3,15 +3,15 @@ import {
     wrapExpectedWithArray, updateElementsArray
 } from '../../utils.js'
 
-async function condition(el: WebdriverIO.Element, html: string | RegExp | Array<string | RegExp>, options: ExpectWebdriverIO.HTMLOptions) {
+async function condition(el: WebdriverIO.Element, html: string | RegExp | ExpectWebdriverIO.PartialMatcher | Array<string | RegExp>, options: ExpectWebdriverIO.HTMLOptions) {
     const actualHTML = await el.getHTML(options.includeSelectorTag)
     if (Array.isArray(html)) {
         return compareTextWithArray(actualHTML, html, options)
     }
     return compareText(actualHTML, html, options)
 }
 
-export async function toHaveHTML(received: WebdriverIO.Element | WebdriverIO.ElementArray, html: string | RegExp | Array<string | RegExp>, options: ExpectWebdriverIO.HTMLOptions = {}) {
+export async function toHaveHTML(received: WebdriverIO.Element | WebdriverIO.ElementArray, html: string | RegExp | ExpectWebdriverIO.PartialMatcher | Array<string | RegExp>, options: ExpectWebdriverIO.HTMLOptions = {}) {
     const isNot = this.isNot
     const { expectation = 'HTML', verb = 'have' } = this
 
diff --git a/src/matchers/element/toHaveHTMLContaining.ts b/src/matchers/element/toHaveHTMLContaining.ts
@@ -1,6 +1,6 @@
 import { toHaveHTML } from './toHaveHTML.js'
 
-export function toHaveHTMLContaining(el: WebdriverIO.Element, html: string | RegExp | Array<string | RegExp>, options: ExpectWebdriverIO.HTMLOptions = {}) {
+export function toHaveHTMLContaining(el: WebdriverIO.Element, html: string | RegExp | ExpectWebdriverIO.PartialMatcher | Array<string | RegExp>, options: ExpectWebdriverIO.HTMLOptions = {}) {
     return toHaveHTML.call(this, el, html, {
         ...options,
         containing: true
diff --git a/src/matchers/element/toHaveId.ts b/src/matchers/element/toHaveId.ts
@@ -1,5 +1,5 @@
 import { toHaveAttributeAndValueFn } from './toHaveAttribute.js'
 
-export function toHaveId(el: WebdriverIO.Element, id: string | RegExp, options: ExpectWebdriverIO.StringOptions = {}) {
+export function toHaveId(el: WebdriverIO.Element, id: string | RegExp | ExpectWebdriverIO.PartialMatcher, options: ExpectWebdriverIO.StringOptions = {}) {
     return toHaveAttributeAndValueFn.call(this, el, 'id', id, options)
 }
diff --git a/src/matchers/element/toHaveText.ts b/src/matchers/element/toHaveText.ts
@@ -3,15 +3,15 @@ import {
     wrapExpectedWithArray, updateElementsArray
 } from '../../utils.js'
 
-async function condition(el: WebdriverIO.Element, text: string | RegExp | Array<string | RegExp>, options: ExpectWebdriverIO.StringOptions) {
+async function condition(el: WebdriverIO.Element, text: string | RegExp | ExpectWebdriverIO.PartialMatcher | Array<string | RegExp>, options: ExpectWebdriverIO.StringOptions) {
     const actualText = await el.getText()
     if (Array.isArray(text)) {
         return compareTextWithArray(actualText, text, options)
     }
     return compareText(actualText, text, options)
 }
 
-export async function toHaveText(received: WebdriverIO.Element | WebdriverIO.ElementArray, text: string | RegExp | Array<string | RegExp>, options: ExpectWebdriverIO.StringOptions = {}) {
+export async function toHaveText(received: WebdriverIO.Element | WebdriverIO.ElementArray, text: string | RegExp | ExpectWebdriverIO.PartialMatcher | Array<string | RegExp>, options: ExpectWebdriverIO.StringOptions = {}) {
     const isNot = this.isNot
     const { expectation = 'text', verb = 'have' } = this
 
diff --git a/src/matchers/element/toHaveTextContaining.ts b/src/matchers/element/toHaveTextContaining.ts
@@ -1,6 +1,6 @@
 import { toHaveText } from './toHaveText.js'
 
-export function toHaveTextContaining(el: WebdriverIO.Element, text: string | RegExp | Array<string | RegExp>, options: ExpectWebdriverIO.StringOptions = {}) {
+export function toHaveTextContaining(el: WebdriverIO.Element, text: string | RegExp | ExpectWebdriverIO.PartialMatcher | Array<string | RegExp>, options: ExpectWebdriverIO.StringOptions = {}) {
     return toHaveText.call(this, el, text, {
         ...options,
         containing: true
diff --git a/src/matchers/element/toHaveValue.ts b/src/matchers/element/toHaveValue.ts
@@ -2,7 +2,7 @@ import { toHaveElementProperty } from './toHaveElementProperty.js'
 
 export function toHaveValue(
     el: WebdriverIO.Element,
-    value: string | RegExp,
+    value: string | RegExp | ExpectWebdriverIO.PartialMatcher,
     options: ExpectWebdriverIO.StringOptions = {}
 ) {
     return toHaveElementProperty.call(this, el, 'value', value, options)
diff --git a/src/matchers/element/toHaveValueContaining.ts b/src/matchers/element/toHaveValueContaining.ts
@@ -1,6 +1,6 @@
 import { toHaveValue } from './toHaveValue.js'
 
-export function toHaveValueContaining(el: WebdriverIO.Element, value: string | RegExp, options: ExpectWebdriverIO.StringOptions = {}) {
+export function toHaveValueContaining(el: WebdriverIO.Element, value: string | RegExp | ExpectWebdriverIO.PartialMatcher, options: ExpectWebdriverIO.StringOptions = {}) {
     return toHaveValue.call(this, el, value, {
         ...options,
         containing: true
diff --git a/src/utils.ts b/src/utils.ts
@@ -1,5 +1,4 @@
 import type { ParsedCSSValue } from 'webdriverio'
-import type { AsymmetricMatcher } from 'expect'
 import isEqual from 'lodash.isequal'
 
 import { executeCommand } from './util/executeCommand.js'
@@ -127,7 +126,7 @@ const compareNumbers = (actual: number, options: ExpectWebdriverIO.NumberOptions
 
 export const compareText = (
     actual: string,
-    expected: string | RegExp | AsymmetricMatcher<string>,
+    expected: string | RegExp | ExpectWebdriverIO.PartialMatcher | ExpectWebdriverIO.PartialMatcher,
     {
         ignoreCase = false,
         trim = true,
@@ -144,15 +143,6 @@ export const compareText = (
             result: false,
         }
     }
-    if (typeof expected === 'object' && '$$typeof' in expected && expected.$$typeof === asymmetricMatcher) {
-        const result = expected.asymmetricMatch(actual)
-        return {
-            value: actual,
-            result
-        }
-    }
-
-    expected = expected as string | RegExp
 
     if (trim) {
         actual = actual.trim()
@@ -162,11 +152,20 @@ export const compareText = (
     }
     if (ignoreCase) {
         actual = actual.toLowerCase()
-        if (!(expected instanceof RegExp)) {
+        if (typeof expected === 'string') {
             expected = expected.toLowerCase()
         }
     }
 
+    if (typeof expected === 'object' && '$$typeof' in expected && expected.$$typeof === asymmetricMatcher && expected.asymmetricMatch) {
+        const result = expected.asymmetricMatch(actual)
+        return {
+            value: actual,
+            result
+        }
+    }
+
+    expected = expected as string | RegExp
     if (expected instanceof RegExp) {
         return {
             value: actual,
diff --git a/types/expect-webdriverio.d.ts b/types/expect-webdriverio.d.ts
diff --git a/types/standalone.d.ts b/types/standalone.d.ts

Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@ async function conditionAttr(el: WebdriverIO.Element, attribute: string) {`
`12`	`12`	`}`
`13`	`13`	`}`
`14`	`14`
`15`		`-async function conditionAttrAndValue(el: WebdriverIO.Element, attribute: string, value: string \| RegExp, options: ExpectWebdriverIO.StringOptions) {`
	`15`	`+async function conditionAttrAndValue(el: WebdriverIO.Element, attribute: string, value: string \| RegExp \| ExpectWebdriverIO.PartialMatcher, options: ExpectWebdriverIO.StringOptions) {`
`16`	`16`	`const attr = await el.getAttribute(attribute)`
`17`	`17`	`if (typeof attr !== 'string') {`
`18`	`18`	`return { result: false, value: attr }`
`@@ -21,7 +21,7 @@ async function conditionAttrAndValue(el: WebdriverIO.Element, attribute: string,`
`21`	`21`	`return compareText(attr, value, options)`
`22`	`22`	`}`
`23`	`23`
`24`		`-export async function toHaveAttributeAndValueFn(received: WebdriverIO.Element \| WebdriverIO.ElementArray, attribute: string, value: string \| RegExp, options: ExpectWebdriverIO.StringOptions = {}) {`
	`24`	`+export async function toHaveAttributeAndValueFn(received: WebdriverIO.Element \| WebdriverIO.ElementArray, attribute: string, value: string \| RegExp \| ExpectWebdriverIO.PartialMatcher, options: ExpectWebdriverIO.StringOptions = {}) {`
`25`	`25`	`const isNot = this.isNot`
`26`	`26`	`const { expectation = 'attribute', verb = 'have' } = this`
`27`	`27`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@ export function toHaveElementClassContaining (...args: any) {`
`4`	`4`	`return toHaveClassContaining.call(this, ...args)`
`5`	`5`	`}`
`6`	`6`
`7`		`-export function toHaveClassContaining(el: WebdriverIO.Element, className: string \| RegExp, options: ExpectWebdriverIO.StringOptions = {}) {`
	`7`	`+export function toHaveClassContaining(el: WebdriverIO.Element, className: string \| RegExp \| ExpectWebdriverIO.PartialMatcher, options: ExpectWebdriverIO.StringOptions = {}) {`
`8`	`8`	`return toHaveAttributeAndValueFn.call(this, el, 'class', className, {`
`9`	`9`	`...options,`
`10`	`10`	`containing: true`