(bugfix): allow failing condition to fail with proper error (#1445)

christian-bromann · web-flow · commit 95d97bd98460 · 2024-01-31T17:51:17.000-08:00
* (chore): update deps

* (bugfix): allow failing condition to fail with proper error
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -48,7 +48,7 @@
     "compile": "tsc --build tsconfig.build.json",
     "test": "run-s test:*",
     "test:lint": "eslint . --ext .js,.jsx,.ts,.tsx",
-    "test:unit": "vitest",
+    "test:unit": "vitest --run",
     "test:types": "node test-types/copy && npm run ts && npm run clean:tests",
     "ts": "run-s ts:*",
     "ts:default": "cd test-types/default && tsc -p ./tsconfig.json --incremental",
@@ -61,30 +61,30 @@
     "@types/debug": "^4.1.12",
     "@types/jest": "^29.5.11",
     "@types/lodash.isequal": "^4.5.8",
-    "@types/node": "^20.10.6",
-    "@typescript-eslint/eslint-plugin": "^6.17.0",
-    "@typescript-eslint/parser": "^6.17.0",
-    "@vitest/coverage-v8": "^1.1.3",
-    "c8": "^9.0.0",
+    "@types/node": "^20.11.14",
+    "@typescript-eslint/eslint-plugin": "^6.20.0",
+    "@typescript-eslint/parser": "^6.20.0",
+    "@vitest/coverage-v8": "^1.2.2",
+    "c8": "^9.1.0",
     "eslint": "^8.56.0",
     "eslint-plugin-import": "^2.29.1",
     "eslint-plugin-unicorn": "^50.0.1",
-    "husky": "^9.0.6",
+    "husky": "^9.0.7",
     "npm-run-all": "^4.1.5",
-    "release-it": "^17.0.1",
+    "release-it": "^17.0.3",
     "rimraf": "^5.0.5",
     "shelljs": "^0.8.5",
     "typescript": "^5.3.3",
     "vitest": "1.2.2",
     "webdriverio": "8.29.1"
   },
   "optionalDependencies": {
-    "@wdio/globals": "^8.27.0",
-    "@wdio/logger": "^8.24.12",
-    "webdriverio": "^8.27.0"
+    "@wdio/globals": "^8.29.3",
+    "@wdio/logger": "^8.28.0",
+    "webdriverio": "^8.29.3"
   },
   "dependencies": {
-    "@vitest/snapshot": "^1.2.1",
+    "@vitest/snapshot": "^1.2.2",
     "expect": "^29.7.0",
     "jest-matcher-utils": "^29.7.0",
     "lodash.isequal": "^4.5.0"
diff --git a/src/matchers/element/toBeClickable.ts b/src/matchers/element/toBeClickable.ts
@@ -12,13 +12,7 @@ export async function toBeClickable(
         options,
     })
 
-    const result = await executeCommandBe.call(this, received, async el => {
-        try {
-            return el.isClickable()
-        } catch {
-            return false
-        }
-    }, options)
+    const result = await executeCommandBe.call(this, received, el => el.isClickable(), options)
 
     await options.afterAssertion?.({
         matcherName: 'toBeClickable',
diff --git a/src/matchers/element/toBeDisplayed.ts b/src/matchers/element/toBeDisplayed.ts
@@ -13,13 +13,7 @@ export async function toBeDisplayed(
         options,
     })
 
-    const result = await executeCommandBe.call(this, received, async el => {
-        try {
-            return el.isDisplayed()
-        } catch {
-            return false
-        }
-    }, options)
+    const result = await executeCommandBe.call(this, received, el => el.isDisplayed(), options)
 
     await options.afterAssertion?.({
         matcherName: 'toBeDisplayed',
diff --git a/src/matchers/element/toBeDisplayedInViewport.ts b/src/matchers/element/toBeDisplayedInViewport.ts
@@ -12,13 +12,7 @@ export async function toBeDisplayedInViewport(
         options,
     })
 
-    const result = await executeCommandBe.call(this, received, async el => {
-        try {
-            return el.isDisplayedInViewport()
-        } catch {
-            return false
-        }
-    }, options)
+    const result = await executeCommandBe.call(this, received, el => el.isDisplayedInViewport(), options)
 
     await options.afterAssertion?.({
         matcherName: 'toBeDisplayedInViewport',
diff --git a/src/matchers/element/toBeExisting.ts b/src/matchers/element/toBeExisting.ts
@@ -14,13 +14,7 @@ export async function toExist(
         options,
     })
 
-    const result = await executeCommandBe.call(this, received, async el => {
-        try {
-            return el.isExisting()
-        } catch {
-            return false
-        }
-    }, options)
+    const result = await executeCommandBe.call(this, received, el => el.isExisting(), options)
 
     await options.afterAssertion?.({
         matcherName: 'toExist',
diff --git a/src/utils.ts b/src/utils.ts
@@ -30,9 +30,10 @@ const waitUntil = async (
         return await condition()
     }
 
+    let error: Error | undefined
+
     // wait for condition to be truthy
     try {
-        let error
         const start = Date.now()
         // eslint-disable-next-line no-constant-condition
         while (true) {
@@ -43,6 +44,7 @@ const waitUntil = async (
             error = undefined
             try {
                 const result = isNot !== (await condition())
+                error = undefined
                 if (result) {
                     break
                 }
@@ -59,6 +61,10 @@ const waitUntil = async (
 
         return !isNot
     } catch (err) {
+        if (error) {
+            throw error
+        }
+
         return isNot
     }
 }
diff --git a/test/matchers/beMatchers.test.ts b/test/matchers/beMatchers.test.ts
@@ -42,8 +42,8 @@ describe('be* matchers', () => {
                     throw new Error('some error')
                 }
 
-                const result = await fn.call({}, el)
-                expect(result.pass).toBe(false)
+                await expect(() => fn.call({}, el, 10, {}))
+                    .rejects.toThrow('some error')
             })
 
             test('success on the first attempt', async () => {
diff --git a/test/matchers/browserMatchers.test.ts b/test/matchers/browserMatchers.test.ts
@@ -40,8 +40,8 @@ describe('browser matchers', () => {
                     throw new Error('some error')
                 }
 
-                const result = await fn.call({}, browser, validText, { trim: false })
-                expect(result.pass).toBe(false)
+                await expect(() => fn.call({}, browser, validText, { trim: false }))
+                    .rejects.toThrow('some error')
             })
 
             test('success on the first attempt', async () => {
diff --git a/test/matchers/element/toBeDisabled.test.ts b/test/matchers/element/toBeDisabled.test.ts
@@ -44,8 +44,8 @@ describe('toBeDisabled', () => {
             throw new Error('some error')
         }
 
-        const result = await toBeDisabled.call({}, el)
-        expect(result.pass).toBe(false)
+        await expect(() => toBeDisabled.call({}, el))
+            .rejects.toThrow('some error')
     })
 
     test('success on the first attempt', async () => {
diff --git a/test/matchers/element/toHaveComputedLabel.test.ts b/test/matchers/element/toHaveComputedLabel.test.ts
@@ -42,8 +42,8 @@ describe('toHaveComputedLabel', () => {
             throw new Error('some error')
         }
 
-        const result = await toHaveComputedLabel.call({}, el, 'WebdriverIO', { ignoreCase: true })
-        expect(result.pass).toBe(false)
+        await expect(() => toHaveComputedLabel.call({}, el, 'WebdriverIO', { ignoreCase: true }))
+            .rejects.toThrow('some error')
     })
 
     test('success on the first attempt', async () => {
diff --git a/test/matchers/element/toHaveComputedRole.test.ts b/test/matchers/element/toHaveComputedRole.test.ts
@@ -42,8 +42,8 @@ describe('toHaveComputedcomputed role', () => {
             throw new Error('some error')
         }
 
-        const result = await toHaveComputedRole.call({}, el, 'WebdriverIO', { ignoreCase: true })
-        expect(result.pass).toBe(false)
+        await expect(() => toHaveComputedRole.call({}, el, 'WebdriverIO', { ignoreCase: true }))
+            .rejects.toThrow('some error')
     })
 
     test('success on the first attempt', async () => {
diff --git a/test/matchers/element/toHaveHTML.test.ts b/test/matchers/element/toHaveHTML.test.ts
@@ -42,8 +42,8 @@ describe('toHaveHTML', () => {
             throw new Error('some error')
         }
 
-        const result = await toHaveHTML.call({}, el, '<div>foo</div>', { ignoreCase: true })
-        expect(result.pass).toBe(false)
+        await expect(() => toHaveHTML.call({}, el, '<div>foo</div>', { ignoreCase: true }))
+            .rejects.toThrow('some error')
     })
 
     test('success on the first attempt', async () => {
diff --git a/test/matchers/element/toHaveHeight.test.ts b/test/matchers/element/toHaveHeight.test.ts
@@ -48,8 +48,8 @@ describe('toHaveHeight', () => {
             throw new Error('some error')
         }
 
-        const result = await toHaveHeight.call({}, el, 10, {})
-        expect(result.pass).toBe(false)
+        await expect(() => toHaveHeight.call({}, el, 10, {}))
+            .rejects.toThrow('some error')
     })
 
     test('success on the first attempt', async () => {
diff --git a/test/matchers/element/toHaveSize.test.ts b/test/matchers/element/toHaveSize.test.ts
@@ -42,8 +42,8 @@ describe('toHaveSize', () => {
             throw new Error('some error')
         }
 
-        const result = await toHaveSize.call({}, el, { width: 32, height: 32 }, {})
-        expect(result.pass).toBe(false)
+        await expect(() => toHaveSize.call({}, el, { width: 32, height: 32 }, {}))
+            .rejects.toThrow('some error')
     })
 
     test('success on the first attempt', async () => {
diff --git a/test/matchers/element/toHaveStyle.test.ts b/test/matchers/element/toHaveStyle.test.ts
@@ -59,8 +59,8 @@ describe('toHaveStyle', () => {
             }
             throw new Error('some error');
         })
-        const result = await toHaveStyle.call({}, el, mockStyle, { ignoreCase: true });
-        expect(result.pass).toBe(false)
+        await expect(() => toHaveStyle.call({}, el, mockStyle, { ignoreCase: true }))
+            .rejects.toThrow('some error')
     })
 
     test('success on the first attempt', async () => {
diff --git a/test/matchers/element/toHaveText.test.ts b/test/matchers/element/toHaveText.test.ts
@@ -42,8 +42,8 @@ describe('toHaveText', () => {
             throw new Error('some error')
         }
 
-        const result = await toHaveText.call({}, el, 'WebdriverIO', { ignoreCase: true })
-        expect(result.pass).toBe(false)
+        await expect(() => toHaveText.call({}, el, 'WebdriverIO', { ignoreCase: true }))
+            .rejects.toThrow('some error')
     })
 
     test('success on the first attempt', async () => {
diff --git a/test/matchers/element/toHaveWidth.test.ts b/test/matchers/element/toHaveWidth.test.ts
@@ -48,8 +48,8 @@ describe('toHaveWidth', () => {
             throw new Error('some error')
         }
 
-        const result = await toHaveWidth.call({}, el, 10, {})
-        expect(result.pass).toBe(false)
+        await expect(() => toHaveWidth.call({}, el, 10, {}))
+            .rejects.toThrow('some error')
     })
 
     test('success on the first attempt', async () => {
diff --git a/vitest.config.ts b/vitest.config.ts
@@ -8,17 +8,29 @@ export default defineConfig({
          * not to ESM ported packages
          */
         exclude: [
-            'dist', '.idea', '.git', '.cache',
+            'dist', '.idea', '.git', '.cache', 'lib',
             '**/node_modules/**'
         ],
         testTimeout: 15 * 1000,
         coverage: {
             enabled: true,
-            exclude: ['**/build/**', '**/__fixtures__/**', '**/*.test.ts'],
-            lines: 92,
-            functions: 87,
-            branches: 89,
-            statements: 92
+            exclude: [
+                '**/build/**',
+                '**/__fixtures__/**',
+                '**/*.test.ts',
+                'lib',
+                'test-types',
+                '.eslintrc.cjs',
+                'jasmine.d.ts',
+                'jest.d.ts',
+                'types'
+            ],
+            thresholds: {
+                lines: 93,
+                functions: 87,
+                branches: 91,
+                statements: 93
+            }
         }
     }
 })

Original file line number	Diff line number	Diff line change
`@@ -42,8 +42,8 @@ describe('be* matchers', () => {`
`42`	`42`	`throw new Error('some error')`
`43`	`43`	`}`
`44`	`44`
`45`		`- const result = await fn.call({}, el)`
`46`		`- expect(result.pass).toBe(false)`
	`45`	`+ await expect(() => fn.call({}, el, 10, {}))`
	`46`	`+ .rejects.toThrow('some error')`
`47`	`47`	`})`
`48`	`48`
`49`	`49`	`test('success on the first attempt', async () => {`
Original file line number	Diff line number	Diff line change
`@@ -40,8 +40,8 @@ describe('browser matchers', () => {`
`40`	`40`	`throw new Error('some error')`
`41`	`41`	`}`
`42`	`42`
`43`		`- const result = await fn.call({}, browser, validText, { trim: false })`
`44`		`- expect(result.pass).toBe(false)`
	`43`	`+ await expect(() => fn.call({}, browser, validText, { trim: false }))`
	`44`	`+ .rejects.toThrow('some error')`
`45`	`45`	`})`
`46`	`46`
`47`	`47`	`test('success on the first attempt', async () => {`
Original file line number	Diff line number	Diff line change
`@@ -44,8 +44,8 @@ describe('toBeDisabled', () => {`
`44`	`44`	`throw new Error('some error')`
`45`	`45`	`}`
`46`	`46`
`47`		`- const result = await toBeDisabled.call({}, el)`
`48`		`- expect(result.pass).toBe(false)`
	`47`	`+ await expect(() => toBeDisabled.call({}, el))`
	`48`	`+ .rejects.toThrow('some error')`
`49`	`49`	`})`
`50`	`50`
`51`	`51`	`test('success on the first attempt', async () => {`