+
+
-
-
[//]: contributor-faces
diff --git a/docs/ai.md b/docs/ai.md
index b3b1ea5ee..9d1776b77 100644
--- a/docs/ai.md
+++ b/docs/ai.md
@@ -533,7 +533,7 @@ ai: {
* `maxLength`: the size of HTML to cut to not reach the token limit. 50K is the current default but you may try to increase it or even set it to null.
* `simplify`: should we process HTML before sending to GPT. This will remove all non-interactive elements from HTML.
-* `minify`: shold HTML be additionally minified. This removed empty attributes, shortens notations, etc.
+* `minify`: should HTML be additionally minified. This removed empty attributes, shortens notations, etc.
* `interactiveElements`: explicit list of all elements that are considered interactive.
* `textElements`: elements that contain text which can be used for test automation.
* `allowedAttrs`: explicit list of attributes that may be used to construct locators. If you use special `data-` attributes to enable locators, add them to the list.
diff --git a/docs/api.md b/docs/api.md
index a2bb24c78..80bc146e1 100644
--- a/docs/api.md
+++ b/docs/api.md
@@ -148,6 +148,7 @@ REST helper can send GET/POST/PATCH/etc requests to REST API endpoint:
* [`I.sendPutRequest()`](/helpers/REST#sendPutRequest)
* [`I.sendPatchRequest()`](/helpers/REST#sendPatchRequest)
* [`I.sendDeleteRequest()`](/helpers/REST#sendDeleteRequest)
+* [`I.sendDeleteRequestWithPayload()`](/helpers/REST#sendDeleteRequestWithPayload)
* ...
Authentication headers can be set in [helper's config](https://codecept.io/helpers/REST/#configuration) or per test with headers or special methods like `I.amBearerAuthenticated`.
diff --git a/docs/changelog.md b/docs/changelog.md
index d028f8a18..bd22e1210 100644
--- a/docs/changelog.md
+++ b/docs/changelog.md
@@ -7,6 +7,68 @@ layout: Section
# Releases
+## 3.6.6
+
+❤️ Thanks all to those who contributed to make this release! ❤️
+
+🛩️ *Features*
+* feat(locator): add withAttrEndsWith, withAttrStartsWith, withAttrContains ([#4334](https://github.com/codeceptjs/CodeceptJS/issues/4334)) - by **[Maksym-Artemenko](https://github.com/Maksym-Artemenko)**
+* feat: soft assert ([#4473](https://github.com/codeceptjs/CodeceptJS/issues/4473)) - by **[kobenguyent](https://github.com/kobenguyent)**
+ * Soft assert
+
+Zero-configuration when paired with other helpers like REST, Playwright:
+
+```js
+// inside codecept.conf.js
+{
+ helpers: {
+ Playwright: {...},
+ SoftExpectHelper: {},
+ }
+}
+```
+
+```js
+// in scenario
+I.softExpectEqual('a', 'b')
+I.flushSoftAssertions() // Throws an error if any soft assertions have failed. The error message contains all the accumulated failures.
+```
+* feat(cli): print failed hooks ([#4476](https://github.com/codeceptjs/CodeceptJS/issues/4476)) - by **[kobenguyent](https://github.com/kobenguyent)**
+ * run command
+ 
+
+ * run workers command
+
+
+🐛 *Bug Fixes*
+* fix(AI): minor AI improvements - by **[DavertMik](https://github.com/DavertMik)**
+* fix(AI): add missing await in AI.js ([#4486](https://github.com/codeceptjs/CodeceptJS/issues/4486)) - by **[tomaculum](https://github.com/tomaculum)**
+* fix(playwright): no async save video page ([#4472](https://github.com/codeceptjs/CodeceptJS/issues/4472)) - by **[kobenguyent](https://github.com/kobenguyent)**
+* fix(rest): httpAgent condition ([#4484](https://github.com/codeceptjs/CodeceptJS/issues/4484)) - by **[kobenguyent](https://github.com/kobenguyent)**
+* fix: DataCloneError error when `I.executeScript` command is used with `run-workers` ([#4483](https://github.com/codeceptjs/CodeceptJS/issues/4483)) - by **[code4muktesh](https://github.com/code4muktesh)**
+* fix: no error thrown from rerun script ([#4494](https://github.com/codeceptjs/CodeceptJS/issues/4494)) - by **[lin-brian-l](https://github.com/lin-brian-l)**
+
+
+```js
+// fix the validation of httpAgent config. we could now pass ca, instead of key/cert.
+{
+ helpers: {
+ REST: {
+ endpoint: 'http://site.com/api',
+ prettyPrintJson: true,
+ httpAgent: {
+ ca: fs.readFileSync(__dirname + '/path/to/ca.pem'),
+ rejectUnauthorized: false,
+ keepAlive: true
+ }
+ }
+ }
+}
+```
+
+📖 *Documentation*
+* doc(AI): minor AI improvements - by **[DavertMik](https://github.com/DavertMik)**
+
## 3.6.5
❤️ Thanks all to those who contributed to make this release! ❤️
diff --git a/docs/community-helpers.md b/docs/community-helpers.md
index 2f135e440..7394b79eb 100644
--- a/docs/community-helpers.md
+++ b/docs/community-helpers.md
@@ -43,6 +43,7 @@ Please **add your own** by editing this page.
* [codeceptjs-slack-reporter](https://www.npmjs.com/package/codeceptjs-slack-reporter) Get a Slack notification when one or more scenarios fail.
* [codeceptjs-browserlogs-plugin](https://github.com/pavkam/codeceptjs-browserlogs-plugin) Record the browser logs for failed tests.
* [codeceptjs-testrail](https://github.com/PeterNgTr/codeceptjs-testrail) - a plugin to integrate with [Testrail](https://www.gurock.com/testrail)
+* [codeceptjs-monocart-coverage](https://github.com/cenfun/codeceptjs-monocart-coverage) - a plugin to generate coverage reports, it integrate with [monocart coverage reports](https://github.com/cenfun/monocart-coverage-reports)
## Browser request control
* [codeceptjs-resources-check](https://github.com/luarmr/codeceptjs-resources-check) Load a URL with Puppeteer and listen to the requests while the page is loading. Enabling count the number or check the sizes of the requests.
diff --git a/docs/data.md b/docs/data.md
index 91d8f4a22..6c8bc4288 100644
--- a/docs/data.md
+++ b/docs/data.md
@@ -54,6 +54,7 @@ I.sendPostRequest()
I.sendPutRequest()
I.sendPatchRequest()
I.sendDeleteRequest()
+I.sendDeleteRequestWithPayload()
```
As well as a method for setting headers: `haveRequestHeaders`.
@@ -210,7 +211,7 @@ var Factory = require('rosie').Factory;
var faker = require('@faker-js/faker');
module.exports = new Factory()
- .attr('name', () => faker.name.findName())
+ .attr('name', () => faker.person.findName())
.attr('email', () => faker.internet.email());
```
@@ -270,7 +271,7 @@ module.exports = new Factory((buildObj) => {
input: { ...buildObj },
}
})
- .attr('name', () => faker.name.findName())
+ .attr('name', () => faker.person.findName())
.attr('email', () => faker.internet.email());
```
diff --git a/docs/email.md b/docs/email.md
index 1a1a567c0..db8ee3297 100644
--- a/docs/email.md
+++ b/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)
diff --git a/docs/helpers/AI.md b/docs/helpers/AI.md
index a3b6082ea..96e0dc607 100644
--- a/docs/helpers/AI.md
+++ b/docs/helpers/AI.md
@@ -22,11 +22,11 @@ Use it only in development mode. It is recommended to run it only inside pause()
This helper should be configured in codecept.conf.{js|ts}
-- `chunkSize`: - The maximum number of characters to send to the AI API at once. We split HTML fragments by 8000 chars to not exceed token limit. Increase this value if you use GPT-4.
+* `chunkSize`: - The maximum number of characters to send to the AI API at once. We split HTML fragments by 8000 chars to not exceed token limit. Increase this value if you use GPT-4.
### Parameters
-- `config`
+* `config`
### askForPageObject
@@ -50,11 +50,11 @@ Asks for a page object based on the provided page name, locator, and extra promp
#### Parameters
-- `pageName` **[string][1]** The name of the page to retrieve the object for.
-- `extraPrompt` **([string][1] | null)** An optional extra prompt for additional context or information.
-- `locator` **([string][1] | null)** An optional locator to find a specific element on the page.
+* `pageName` **[string][1]** The name of the page to retrieve the object for.
+* `extraPrompt` **([string][1] | null)** An optional extra prompt for additional context or information.
+* `locator` **([string][1] | null)** An optional locator to find a specific element on the page.
-Returns **[Promise][2]<[Object][3]>** A promise that resolves to the requested page object.
+Returns **[Promise][2]<[Object][3]>** A promise that resolves to the requested page object.
### askGptGeneralPrompt
@@ -62,9 +62,9 @@ Send a general request to AI and return response.
#### Parameters
-- `prompt` **[string][1]**
+* `prompt` **[string][1]**
-Returns **[Promise][2]<[string][1]>** A Promise that resolves to the generated response from the GPT model.
+Returns **[Promise][2]<[string][1]>** A Promise that resolves to the generated response from the GPT model.
### askGptOnPage
@@ -76,9 +76,9 @@ I.askGptOnPage('what does this page do?');
#### Parameters
-- `prompt` **[string][1]** The question or prompt to ask the GPT model.
+* `prompt` **[string][1]** The question or prompt to ask the GPT model.
-Returns **[Promise][2]<[string][1]>** A Promise that resolves to the generated responses from the GPT model, joined by newlines.
+Returns **[Promise][2]<[string][1]>** A Promise that resolves to the generated responses from the GPT model, joined by newlines.
### askGptOnPageFragment
@@ -90,10 +90,10 @@ I.askGptOnPageFragment('describe features of this screen', '.screen');
#### Parameters
-- `prompt` **[string][1]** The question or prompt to ask the GPT-3.5 model.
-- `locator` **[string][1]** The locator or selector used to identify the HTML fragment on the page.
+* `prompt` **[string][1]** The question or prompt to ask the GPT-3.5 model.
+* `locator` **[string][1]** The locator or selector used to identify the HTML fragment on the page.
-Returns **[Promise][2]<[string][1]>** A Promise that resolves to the generated response from the GPT model.
+Returns **[Promise][2]<[string][1]>** A Promise that resolves to the generated response from the GPT model.
[1]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
diff --git a/docs/helpers/ApiDataFactory.md b/docs/helpers/ApiDataFactory.md
index 2e25d1636..d76af53e0 100644
--- a/docs/helpers/ApiDataFactory.md
+++ b/docs/helpers/ApiDataFactory.md
@@ -58,7 +58,7 @@ const { faker } = require('@faker-js/faker');
module.exports = new Factory()
// no need to set id, it will be set by REST API
- .attr('author', () => faker.name.findName())
+ .attr('author', () => faker.person.findName())
.attr('title', () => faker.lorem.sentence())
.attr('body', () => faker.lorem.paragraph());
```
@@ -71,12 +71,12 @@ Then configure ApiDataHelper to match factories and REST API:
ApiDataFactory has following config options:
-- `endpoint`: base URL for the API to send requests to.
-- `cleanup` (default: true): should inserted records be deleted up after tests
-- `factories`: list of defined factories
-- `returnId` (default: false): return id instead of a complete response when creating items.
-- `headers`: list of headers
-- `REST`: configuration for REST requests
+* `endpoint`: base URL for the API to send requests to.
+* `cleanup` (default: true): should inserted records be deleted up after tests
+* `factories`: list of defined factories
+* `returnId` (default: false): return id instead of a complete response when creating items.
+* `headers`: list of headers
+* `REST`: configuration for REST requests
See the example:
@@ -121,25 +121,26 @@ For instance, to set timeout you should add:
By default to create a record ApiDataFactory will use endpoint and plural factory name:
-- create: `POST {endpoint}/{resource} data`
-- delete: `DELETE {endpoint}/{resource}/id`
+* create: `POST {endpoint}/{resource} data`
+* delete: `DELETE {endpoint}/{resource}/id`
Example (`endpoint`: `http://app.com/api`):
-- create: POST request to `http://app.com/api/users`
-- delete: DELETE request to `http://app.com/api/users/1`
+* create: POST request to `http://app.com/api/users`
+* delete: DELETE request to `http://app.com/api/users/1`
This behavior can be configured with following options:
-- `uri`: set different resource uri. Example: `uri: account` => `http://app.com/api/account`.
-- `create`: override create options. Expected format: `{ method: uri }`. Example: `{ "post": "/users/create" }`
-- `delete`: override delete options. Expected format: `{ method: uri }`. Example: `{ "post": "/users/delete/{id}" }`
+* `uri`: set different resource uri. Example: `uri: account` => `http://app.com/api/account`.
+* `create`: override create options. Expected format: `{ method: uri }`. Example: `{ "post": "/users/create" }`
+* `delete`: override delete options. Expected format: `{ method: uri }`. Example: `{ "post": "/users/delete/{id}" }`
Requests can also be overridden with a function which returns [axois request config][4].
```js
create: (data) => ({ method: 'post', url: '/posts', data }),
delete: (id) => ({ method: 'delete', url: '/posts', data: { id } })
+
```
Requests can be updated on the fly by using `onRequest` function. For instance, you can pass in current session from a cookie.
@@ -189,7 +190,7 @@ By default `id` property of response is taken. This behavior can be changed by s
### Parameters
-- `config`
+* `config`
### _requestCreate
@@ -198,8 +199,8 @@ Can be replaced from a in custom helper.
#### Parameters
-- `factory` **any**
-- `data` **any**
+* `factory` **any**
+* `data` **any**
### _requestDelete
@@ -208,8 +209,8 @@ Can be replaced from a custom helper.
#### Parameters
-- `factory` **any**
-- `id` **any**
+* `factory` **any**
+* `id` **any**
### have
@@ -227,11 +228,11 @@ I.have('user', { }, { age: 33, height: 55 })
#### Parameters
-- `factory` **any** factory to use
-- `params` **any?** predefined parameters
-- `options` **any?** options for programmatically generate the attributes
+* `factory` **any** factory to use
+* `params` **any?** predefined parameters
+* `options` **any?** options for programmatically generate the attributes
-Returns **[Promise][5]<any>**
+Returns **[Promise][5]