3.3.4 release (#3357)

* updated changelog

* fixed tests, added changelog and docs

* version bump, docs updated

Author: DavertMik

CHANGELOG.md

@@ -1,3 +1,41 @@
+## 3.3.4
+
+* Added support for masking fields in objects via `secret` function:
+
+```js
+I.sendPostRequest('/auth', secret({ name: 'jon', password: '123456' }, 'password'));
+```
+* Added [a guide about using of `secret`](/secrets) function
+* [Appium] Use `touchClick` when interacting with elements in iOS. See #3317 by @mikk150
+* [Playwright] Added `cdpConnection` option to connect over CDP. See #3309 by @Hmihaly 
+* [customLocator plugin] Allowed to specify multiple attributes for custom locator. Thanks to @aruiz-caritsqa
+
+```js
+plugins: {
+ customLocator: {
+   enabled: true,
+   prefix: '$',
+   attribute: ['data-qa', 'data-test'],
+ }
+}
+```
+* [retryTo plugin] Fixed #3147 using `pollInterval` option. See #3351 by @cyonkee
+* [Playwright] Fixed grabbing of browser console messages and window resize in new tab. Thanks to @mirao
+* [REST] Added `prettyPrintJson` option to print JSON in nice way by @PeterNgTr 
+* [JSONResponse] Updated response validation to iterate over array items if response is array. Thanks to @PeterNgTr
+
+```js
+// response.data == [
+//   { user: { name: 'jon', email: '[email protected]' } },
+//   { user: { name: 'matt', email: '[email protected]' } },
+//]
+
+I.seeResponseContainsKeys(['user']);
+I.seeResponseContainsJson({ user: { email: '[email protected]' } });
+I.seeResponseContainsJson({ user: { email: '[email protected]' } });
+I.dontSeeResponseContainsJson({ user: 2 });
+```
+
 ## 3.3.3
 
 * Fixed `DataCloneError: () => could not be cloned` when running data tests in run-workers

docs/api.md

@@ -263,6 +263,8 @@ The most basic thing to check in response is existence of keys in JSON object. U
 I.seeResponseContainsKeys(['name', 'email']);
 ```
 
+> ℹ️ If response is an array, it will check that every element in array have provided keys
+
 However, this is a very naive approach. It won't work for arrays or nested objects.
 To check complex JSON structures `JSONResponse` helper uses [`joi`](https://joi.dev) library. 
 It has rich API to validate JSON by the schema defined using JavaScript. 
@@ -296,6 +298,8 @@ I.seeResponseContainsJson({
 })
 ```
 
+> ℹ️ If response is an array, it will check that at least one element in array matches JSON
+
 To perform arbitrary assertions on a response object use `seeResponseValidByCallback`. 
 It allows you to do any kind of assertions by using `expect` from [`chai`](https://www.chaijs.com) library.
 

docs/helpers/JSONResponse.md

@@ -92,8 +92,10 @@ Checks for deep inclusion of a provided json in a response data.
 I.dontSeeResponseContainsJson({ user: 2 });
 ```
 
+If an array is received, checks that no element of array contains json:
+
 ```js
-// response.data == [{ data: { user: 1 } }]
+// response.data == [{ user: 1 }, { user: 3 }]
 
 I.dontSeeResponseContainsJson({ user: 2 });
 ```
@@ -145,6 +147,8 @@ Checks for deep inclusion of a provided json in a response data.
 I.seeResponseContainsJson({ user: { email: '[email protected]' } });
 ```
 
+If an array is received, checks that at least one element contains JSON
+
 ```js
 // response.data == [{ user: { name: 'jon', email: '[email protected]' } }]
 
@@ -165,8 +169,10 @@ Checks for deep inclusion of a provided json in a response data.
 I.seeResponseContainsKeys(['user']);
 ```
 
+If an array is received, check is performed for each element of array:
+
 ```js
-// response.data == [{ user: { name: 'jon', email: '[email protected]' } }]
+// response.data == [{ user: 'jon' }, { user: 'matt'}]
 
 I.seeResponseContainsKeys(['user']);
 ```

docs/plugins.md

@@ -1,3 +1,10 @@
+---
+permalink: plugins
+sidebarDepth: 
+sidebar: auto
+title: Plugins
+---
+
 <!-- Generated by documentation.js. Update this documentation by updating the source code. -->
 
 ## allure

docs/secrets.md

@@ -27,4 +27,4 @@ I.sendPostRequest('/login', secret({
 
 The object created from `secret` is as Proxy to the object passed in. When printed password will be replaced with ****. 
 
-> ⚠️ Currently, properties of nested objects can't be masked via `secret`
+> ⚠️ Only direct properties of the object can be masked via `secret`

lib/helper/JSONResponse.js

@@ -1,3 +1,4 @@
+const assert = require('assert');
 const chai = require('chai');
 const joi = require('joi');
 const chaiDeepMatch = require('chai-deep-match');
@@ -173,6 +174,7 @@ class JSONResponse extends Helper {
    *
    * I.seeResponseContainsJson({ user: { email: 'jon@doe.com' } });
    * ```
+   * If an array is received, checks that at least one element contains JSON
    * ```js
    * // response.data == [{ user: { name: 'jon', email: 'jon@doe.com' } }]
    *
@@ -184,7 +186,15 @@ class JSONResponse extends Helper {
   seeResponseContainsJson(json = {}) {
     this._checkResponseReady();
     if (Array.isArray(this.response.data)) {
-      this.response.data.forEach(data => expect(data).to.deep.match(json));
+      let fails = 0;
+      for (const el of this.response.data) {
+        try {
+          expect(el).to.deep.match(json);
+        } catch (err) {
+          fails++;
+        }
+      }
+      assert.ok(fails < this.response.data.length, `No elements in array matched ${JSON.stringify(json)}`);
     } else {
       expect(this.response.data).to.deep.match(json);
     }
@@ -198,8 +208,9 @@ class JSONResponse extends Helper {
    *
    * I.dontSeeResponseContainsJson({ user: 2 });
    * ```
+   * If an array is received, checks that no element of array contains json:
    * ```js
-   * // response.data == [{ data: { user: 1 } }]
+   * // response.data == [{ user: 1 }, { user: 3 }]
    *
    * I.dontSeeResponseContainsJson({ user: 2 });
    * ```
@@ -224,8 +235,10 @@ class JSONResponse extends Helper {
    * I.seeResponseContainsKeys(['user']);
    * ```
    *
+   * If an array is received, check is performed for each element of array:
+   *
    * ```js
-   * // response.data == [{ user: { name: 'jon', email: 'jon@doe.com' } }]
+   * // response.data == [{ user: 'jon' }, { user: 'matt'}]
    *
    * I.seeResponseContainsKeys(['user']);
    * ```

package.json

@@ -1,6 +1,6 @@
 {
   "name": "codeceptjs",
-  "version": "3.3.3",
+  "version": "3.3.4",
   "description": "Supercharged End 2 End Testing Framework for NodeJS",
   "keywords": [
     "acceptance",

test/helper/JSONResponse_test.js

@@ -99,7 +99,15 @@ describe('JSONResponse', () => {
           { id: 1, author: 'davert' },
         ],
       });
-      expect(() => I.seeResponseContainsJson({ posts: [{ id: 2, author: 'boss' }] })).to.throw('expected { …(2) } to deeply match { Object (posts) }');
+      expect(() => I.seeResponseContainsJson({ posts: [{ id: 2, author: 'boss' }] })).to.throw('No elements in array matched {"posts":[{"id":2,"author":"boss"}]}');
+    });
+
+    it('should check for json inclusion - returned Array of 2 items', () => {
+      const arrayData = [{ ...data }, { posts: { id: 3 } }];
+      restHelper.config.onResponse({ data: arrayData });
+      I.seeResponseContainsJson({
+        posts: { id: 3 },
+      });
     });
 
     it('should simply check for json inclusion', () => {
@@ -123,7 +131,7 @@ describe('JSONResponse', () => {
 
     it('should simply check for json equality - returned Array', () => {
       restHelper.config.onResponse({ data: [{ user: 1 }] });
-      I.seeResponseEquals({ user: 1 });
+      I.seeResponseEquals([{ user: 1 }]);
     });
 
     it('should check json contains keys', () => {