Merge branch '3.x' into task-4593-bump-webdriverio

Author: thomashohn

CHANGELOG.md

@@ -1,3 +1,67 @@
+## 3.6.10
+
+❤️ Thanks all to those who contributed to make this release! ❤️
+
+🐛 *Bug Fixes*
+fix(cli): missing failure counts when there is failedHooks (#4633) - by @kobenguyent
+
+## 3.6.9
+
+❤️ Thanks all to those who contributed to make this release! ❤️
+
+🐛 *Hot Fixes*
+fix: could not run tests due to missing `invisi-data` lib - by @kobenguyent
+
+## 3.6.8
+
+❤️ Thanks all to those who contributed to make this release! ❤️
+
+🛩️ *Features*
+* feat(cli): mask sensitive data in logs (#4630) - by @kobenguyent
+```
+export const config: CodeceptJS.MainConfig = {
+  tests:  '**/*.e2e.test.ts',
+  retry: 4,
+  output: './output',
+  maskSensitiveData: true,
+  emptyOutputFolder: true,
+...
+
+    I login {"username":"[email protected]","password": "****"}
+      I send post request "https://localhost:8000/login", {"username":"[email protected]","password": "****"}
+      › [Request] {"baseURL":"https://localhost:8000/login","method":"POST","data":{"username":"[email protected]","password": "****"},"headers":{}}
+      › [Response] {"access-token": "****"}
+```
+
+* feat(REST): DELETE request supports payload (#4493) - by @schaudhary111
+
+```js
+I.sendDeleteRequestWithPayload('/api/users/1', { author: 'john' });
+```
+
+🐛 *Bug Fixes*
+* fix(playwright): Different behavior of see* and waitFor* when used in within (#4557) - by @kobenguyent
+* fix(cli): dry run returns no tests when using a regex grep (#4608) - by @kobenguyent
+```bash
+> codeceptjs dry-run --steps --grep "(?=.*Checkout process)"
+```
+* fix: Replace deprecated faker.name with faker.person (#4581) - by @thomashohn
+* fix(wdio): Remove dependency to devtools (#4563) - by @thomashohn
+* fix(typings): wrong defineParameterType (#4548) - by @kobenguyent
+* fix(typing): `Locator.build` complains the empty locator (#4543) - by @kobenguyent
+* fix: add hint to `I.seeEmailAttachment` treats parameter as regular expression (#4629) - by @ngraf
+```
+Add hint to "I.seeEmailAttachment" that under the hood parameter is treated as RegExp. 
+When you don't know it, it can cause a lot of pain, wondering why your test fails with I.seeEmailAttachment('Attachment(1).pdf') although it looks just fine, but actually I.seeEmailAttachment('Attachment\\(1\\).pdf is required to make the test green, in case the attachment is called "Attachment(1).pdf" with special character in it.
+```
+* fix(playwright): waitForText fails when text contains double quotes (#4528) - by @DavertMik
+* fix(mock-server-helper): move to stand-alone package: https://www.npmjs.com/package/@codeceptjs/mock-server-helper (#4536) - by @kobenguyent
+* fix(appium): issue with async on runOnIos and runOnAndroid (#4525) - by @kobenguyent
+* fix: push ws messages to array (#4513) - by @kobenguyent
+
+📖 *Documentation*
+* fix(docs): typo in ai.md (#4501) - by @tomaculum
+
 ## 3.6.6
 
 ❤️ Thanks all to those who contributed to make this release! ❤️

README.md

@@ -315,10 +315,10 @@ Thanks all to those who are and will have contributing to this awesome project!
 <a href="https://github.com/thomashohn"><img src="https://avatars.githubusercontent.com/u/3414869?v=4" title="thomashohn" width="80" height="80"></a>
 <a href="https://github.com/elaichenkov"><img src="https://avatars.githubusercontent.com/u/29764053?v=4" title="elaichenkov" width="80" height="80"></a>
 <a href="https://github.com/BorisOsipov"><img src="https://avatars.githubusercontent.com/u/6514276?v=4" title="BorisOsipov" width="80" height="80"></a>
+<a href="https://github.com/ngraf"><img src="https://avatars.githubusercontent.com/u/7094389?v=4" title="ngraf" width="80" height="80"></a>
 <a href="https://github.com/nitschSB"><img src="https://avatars.githubusercontent.com/u/39341455?v=4" title="nitschSB" width="80" height="80"></a>
 <a href="https://github.com/hubidu"><img src="https://avatars.githubusercontent.com/u/13134082?v=4" title="hubidu" width="80" height="80"></a>
 <a href="https://github.com/jploskonka"><img src="https://avatars.githubusercontent.com/u/669483?v=4" title="jploskonka" width="80" height="80"></a>
-<a href="https://github.com/ngraf"><img src="https://avatars.githubusercontent.com/u/7094389?v=4" title="ngraf" width="80" height="80"></a>
 <a href="https://github.com/maojunxyz"><img src="https://avatars.githubusercontent.com/u/28778042?v=4" title="maojunxyz" width="80" height="80"></a>
 <a href="https://github.com/abhimanyupandian"><img src="https://avatars.githubusercontent.com/u/36107381?v=4" title="abhimanyupandian" width="80" height="80"></a>
 <a href="https://github.com/martomo"><img src="https://avatars.githubusercontent.com/u/1850135?v=4" title="martomo" width="80" height="80"></a>

docs/configuration.md

@@ -29,6 +29,7 @@ After running `codeceptjs init` it should be saved in test root.
 | `tests` | `string` | Pattern to locate CodeceptJS tests. Allows to enter glob pattern or an Array<string> of patterns to match tests / test file names.  For tests in JavaScript:  ```tests: 'tests/**.test.js' ``` For tests in TypeScript:  ```tests: 'tests/**.test.ts' ``` |
 | `timeout?` | `number` | Set default tests timeout in seconds. Tests will be killed on no response after timeout.  ```timeout: 20, ``` |
 | `translation?` | `string` | Enable [localized test commands](https://codecept.io/translation/) |
+| `maskSensitiveData?` | `boolean` | Enable to mask Sensitive Data in console. |
 
 
 ## Require

docs/email.md

@@ -156,8 +156,8 @@ I.seeEmailIsFrom('@mysite.com');
 I.seeInEmailSubject('Awesome Proposal!');
 I.seeInEmailBody('To unsubscribe click here');
 I.seeNumberOfEmailAttachments(2);
-I.seeEmailAttachment('Attachment_1.pdf')
-I.seeEmailAttachment('Attachment_2.pdf')
+I.seeEmailAttachment('Attachment_1.pdf'); // Regular expression. Escape special characters like '(' or ')' in filename.
+I.seeEmailAttachment('Attachment_2.pdf');
 ```
 
 > More methods are listed in [helper's API reference](https://github.com/codeceptjs/mailslurp-helper/blob/master/README.md#api)

lib/cli.js

@@ -219,7 +219,6 @@ class Cli extends Base {
 
     this.failures.forEach((failure) => {
       if (failure.constructor.name === 'Hook') {
-        stats.failures -= stats.failures
         stats.failedHooks += 1
       }
     })

lib/codecept.js

@@ -92,6 +92,9 @@ class Codecept {
 
       // debug mode
       global.debugMode = false;
+
+      // mask sensitive data
+      global.maskSensitiveData = this.config.maskSensitiveData || false;
     }
   }
 

lib/command/dryRun.js

@@ -7,7 +7,7 @@ const store = require('../store')
 const Container = require('../container')
 
 module.exports = async function (test, options) {
-  if (options.grep) process.env.grep = options.grep.toLowerCase()
+  if (options.grep) process.env.grep = options.grep
   const configFile = options.config
   let codecept
 
@@ -60,35 +60,40 @@ function printTests(files) {
   let numOfTests = 0
   let numOfSuites = 0
   let outputString = ''
-  const filterBy = process.env.grep ? process.env.grep.toLowerCase() : undefined
+  const filterBy = process.env.grep
 
+  let filterRegex
   if (filterBy) {
-    for (const suite of mocha.suite.suites) {
-      const currentSuite = suite.title
-      if (suite.title.toLowerCase().includes(filterBy)) {
-        outputString += `${colors.white.bold(suite.title)} -- ${output.styles.log(suite.file || '')} -- ${mocha.suite.suites.length} tests\n`
-        numOfSuites++
-      }
-
-      for (test of suite.tests) {
-        if (test.title.toLowerCase().includes(filterBy)) {
-          numOfTests++
-          outputString += `${colors.white.bold(test.parent.title)} -- ${output.styles.log(test.parent.file || '')} -- ${mocha.suite.suites.length} tests\n`
-          outputString += `  ${output.styles.scenario(figures.checkboxOff)} ${test.title}\n`
-        }
-      }
+    try {
+      filterRegex = new RegExp(filterBy, 'i') // Case-insensitive matching
+    } catch (err) {
+      console.error(`Invalid grep pattern: ${filterBy}`)
+      process.exit(1)
     }
-    numOfSuites = countSuites(outputString)
-  } else {
-    for (const suite of mocha.suite.suites) {
-      output.print(
-        `${colors.white.bold(suite.title)} -- ${output.styles.log(suite.file || '')} -- ${mocha.suite.suites.length} tests`,
-      )
+  }
+
+  for (const suite of mocha.suite.suites) {
+    const suiteMatches = filterRegex ? filterRegex.test(suite.title) : true
+    let suiteHasMatchingTests = false
+
+    if (suiteMatches) {
+      outputString += `${colors.white.bold(suite.title)} -- ${output.styles.log(suite.file || '')}\n`
+      suiteHasMatchingTests = true
       numOfSuites++
+    }
+
+    for (const test of suite.tests) {
+      const testMatches = filterRegex ? filterRegex.test(test.title) : true
+
+      if (testMatches) {
+        if (!suiteMatches && !suiteHasMatchingTests) {
+          outputString += `${colors.white.bold(suite.title)} -- ${output.styles.log(suite.file || '')}\n`
+          suiteHasMatchingTests = true
+          numOfSuites++
+        }
 
-      for (test of suite.tests) {
         numOfTests++
-        output.print(`  ${output.styles.scenario(figures.checkboxOff)} ${test.title}`)
+        outputString += `  ${output.styles.scenario(figures.checkboxOff)} ${test.title}\n`
       }
     }
   }
@@ -108,15 +113,5 @@ function printFooter() {
 function removeDuplicates(inputString) {
   const array = inputString.split('\n')
   const uniqueLines = [...new Set(array)]
-  const resultString = uniqueLines.join('\n')
-
-  return resultString
-}
-
-function countSuites(inputString) {
-  const array = inputString.split('\n')
-
-  const uniqueLines = [...new Set(array)]
-  const res = uniqueLines.filter((item) => item.includes('-- '))
-  return res.length
+  return uniqueLines.join('\n')
 }

lib/helper/Playwright.js

@@ -1283,7 +1283,7 @@ class Playwright extends Helper {
    * ```
    */
   async _locate(locator) {
-    const context = (await this.context) || (await this._getContext())
+    const context = await this._getContext()
 
     if (this.frame) return findElements(this.frame, locator)
 
@@ -1299,7 +1299,7 @@ class Playwright extends Helper {
    * ```
    */
   async _locateElement(locator) {
-    const context = (await this.context) || (await this._getContext())
+    const context = await this._getContext()
     return findElement(context, locator)
   }
 
@@ -2736,7 +2736,7 @@ class Playwright extends Helper {
   }
 
   async _getContext() {
-    if (this.context && this.context.constructor.name === 'FrameLocator') {
+    if ((this.context && this.context.constructor.name === 'FrameLocator') || this.context) {
       return this.context
     }
     return this.page

lib/output.js

@@ -1,5 +1,6 @@
 const colors = require('chalk');
 const figures = require('figures');
+const { maskSensitiveData } = require('invisi-data')
 
 const styles = {
   error: colors.bgRed.white.bold,
@@ -57,8 +58,9 @@ module.exports = {
    * @param {string} msg
    */
   debug(msg) {
+    const _msg = isMaskedData() ? maskSensitiveData(msg) : msg
     if (outputLevel >= 2) {
-      print(' '.repeat(this.stepShift), styles.debug(`${figures.pointerSmall} ${msg}`));
+      print(' '.repeat(this.stepShift), styles.debug(`${figures.pointerSmall} ${_msg}`));
     }
   },
 
@@ -67,8 +69,9 @@ module.exports = {
    * @param {string} msg
    */
   log(msg) {
+    const _msg = isMaskedData() ? maskSensitiveData(msg) : msg
     if (outputLevel >= 3) {
-      print(' '.repeat(this.stepShift), styles.log(truncate(`   ${msg}`, this.spaceShift)));
+      print(' '.repeat(this.stepShift), styles.log(truncate(`   ${_msg}`, this.spaceShift)));
     }
   },
 
@@ -120,7 +123,8 @@ module.exports = {
       stepLine += colors.grey(step.comment.split('\n').join('\n' + ' '.repeat(4)));
     }
 
-    print(' '.repeat(this.stepShift), truncate(stepLine, this.spaceShift));
+    const _stepLine = isMaskedData() ? maskSensitiveData(stepLine) : stepLine
+    print(' '.repeat(this.stepShift), truncate(_stepLine, this.spaceShift));
   },
 
   /** @namespace */
@@ -167,7 +171,7 @@ module.exports = {
   scenario: {
     /**
      * @param {Mocha.Test} test
-    */
+     */
 
     started(test) {},
 
@@ -254,3 +258,7 @@ function truncate(msg, gap = 0) {
   }
   return msg;
 }
+
+function isMaskedData() {
+  return global.maskSensitiveData === true || false
+}

package.json

@@ -1,6 +1,6 @@
 {
   "name": "codeceptjs",
-  "version": "3.6.7",
+  "version": "3.6.10",
   "description": "Supercharged End 2 End Testing Framework for NodeJS",
   "keywords": [
     "acceptance",
@@ -96,14 +96,15 @@
     "fs-extra": "11.2.0",
     "glob": "6.0.1",
     "html-minifier-terser": "7.2.0",
+    "invisi-data": "^1.0.0",
     "inquirer": "6.5.2",
     "joi": "17.13.3",
     "js-beautify": "1.15.1",
     "lodash.clonedeep": "4.5.0",
     "lodash.merge": "4.6.2",
     "mkdirp": "1.0.4",
     "mocha": "10.8.2",
-    "monocart-coverage-reports": "2.11.2",
+    "monocart-coverage-reports": "2.11.3",
     "ms": "2.1.3",
     "ora-classic": "5.4.2",
     "parse-function": "5.6.10",
@@ -118,14 +119,14 @@
   },
   "devDependencies": {
     "@codeceptjs/mock-request": "0.3.1",
-    "@eslint/eslintrc": "3.1.0",
-    "@eslint/js": "9.14.0",
-    "@faker-js/faker": "9.2.0",
+    "@eslint/eslintrc": "3.2.0",
+    "@eslint/js": "9.16.0",
+    "@faker-js/faker": "9.3.0",
     "@pollyjs/adapter-puppeteer": "6.0.6",
     "@pollyjs/core": "5.1.0",
     "@types/chai": "4.3.19",
     "@types/inquirer": "9.0.3",
-    "@types/node": "22.9.0",
+    "@types/node": "22.10.1",
     "@wdio/sauce-service": "9.2.13",
     "@wdio/selenium-standalone-service": "8.3.2",
     "@wdio/utils": "9.2.8",
@@ -136,28 +137,28 @@
     "cheerio": "^1.0.0",
     "contributor-faces": "1.1.0",
     "documentation": "14.0.3",
-    "electron": "33.2.0",
-    "eslint": "9.14.0",
+    "electron": "33.2.1",
+    "eslint": "9.16.0",
     "eslint-config-airbnb-base": "15.0.0",
     "eslint-plugin-import": "2.31.0",
     "eslint-plugin-mocha": "10.5.0",
     "expect": "29.7.0",
     "express": "4.21.1",
     "globals": "15.12.0",
     "graphql": "16.9.0",
-    "husky": "9.1.6",
+    "husky": "9.1.7",
     "inquirer-test": "2.0.1",
     "jsdoc": "4.0.4",
     "jsdoc-typeof-plugin": "1.0.0",
     "json-server": "0.17.4",
-    "playwright": "1.48.2",
+    "playwright": "1.49.0",
     "prettier": "^3.3.2",
     "puppeteer": "23.8.0",
     "qrcode-terminal": "0.12.0",
     "rosie": "2.1.1",
     "runok": "0.9.3",
     "semver": "7.6.3",
-    "sinon": "18.0.0",
+    "sinon": "19.0.2",
     "sinon-chai": "3.7.0",
     "testcafe": "3.7.0",
     "ts-morph": "24.0.0",
@@ -166,7 +167,7 @@
     "tsd-jsdoc": "2.5.0",
     "typedoc": "0.26.11",
     "typedoc-plugin-markdown": "4.2.10",
-    "typescript": "5.6.3",
+    "typescript": "5.7.2",
     "wdio-docker-service": "1.5.0",
     "webdriverio": "9.2.14",
     "xml2js": "0.6.2",
@@ -183,4 +184,4 @@
       "strict": false
     }
   }
-}
+}