codeceptjs 3.5.4-beta.1 → 3.5.5

package/docs/changelog.md

@@ -7,6 +7,381 @@ layout: Section
 
 # Releases
 
+## 3.5.5
+
+🐛 Bug Fixes
+* fix(browserstack): issue with vendor prefix ([#3845](https://github.com/codeceptjs/CodeceptJS/issues/3845)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)**
+```
+export const caps = {
+    androidCaps: {
+        appiumV2: true,
+        host: "hub-cloud.browserstack.com",
+        port: 4444,
+        user: process.env.BROWSERSTACK_USER,
+        key: process.env.BROWSERSTACK_KEY,
+        'app': `bs://c700ce60cf13ae8ed97705a55b8e022f1hjhkjh3c5827c`,
+        browser: '',
+        desiredCapabilities: {
+            'appPackage': data.packageName,
+            'deviceName': process.env.DEVICE || 'Google Pixel 3',
+            'platformName': process.env.PLATFORM || 'android',
+            'platformVersion': process.env.OS_VERSION || '10.0',
+            'automationName': process.env.ENGINE || 'UIAutomator2',
+            'newCommandTimeout': 300000,
+            'androidDeviceReadyTimeout': 300000,
+            'androidInstallTimeout': 90000,
+            'appWaitDuration': 300000,
+            'autoGrantPermissions': true,
+            'gpsEnabled': true,
+            'isHeadless': false,
+            'noReset': false,
+            'noSign': true,
+            'bstack:options' : {
+                "appiumVersion" : "2.0.1",
+            },
+        }
+    },
+}
+```
+
+*  switchTo/within now supports strict locator ([#3847](https://github.com/codeceptjs/CodeceptJS/issues/3847)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)**
+
+```
+I.switchTo({ css: 'iframe[id^=number-frame]' }) // support the strict locator
+
+I.amOnPage('/iframe');
+within({
+  frame: { css: '#number-frame-1234' }, // support the strict locator
+}, () => {
+  I.fillField('user[login]', 'User');
+  I.fillField('user[email]', 'user@user.com');
+  I.fillField('user[password]', 'user@user.com');
+  I.click('button');
+});
+```
+
+* Improve the IntelliSense when using other languages  ([#3848](https://github.com/codeceptjs/CodeceptJS/issues/3848)) - by **[andonary](https://github.com/andonary)**
+```
+  include: {
+    Je: './steps_file.js'
+  }
+```
+
+*  bypassCSP support for Playwright helper ([#3865](https://github.com/codeceptjs/CodeceptJS/issues/3865)) - by **[sammeel](https://github.com/sammeel)**
+```
+  helpers: {
+    Playwright: {
+      bypassCSP: true
+    }
+```
+* fix: missing requests when recording network ([#3834](https://github.com/codeceptjs/CodeceptJS/issues/3834)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)**
+
+🛩️ Features and Improvements
+* Show environment info in verbose mode ([#3858](https://github.com/codeceptjs/CodeceptJS/issues/3858)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)**
+
+```
+Environment information:-
+
+codeceptVersion:  "3.5.4"
+nodeInfo:  18.16.0
+osInfo:  macOS 13.5
+cpuInfo:  (8) arm64 Apple M1 Pro
+chromeInfo:  116.0.5845.179
+edgeInfo:  116.0.1938.69
+firefoxInfo:  Not Found
+safariInfo:  16.6
+helpers:  {
+"Playwright": {
+"url": "https://github.com",
+"show": false,
+"browser": "chromium",
+"waitForNavigation": "load",
+"waitForTimeout": 30000,
+"trace": false,
+"keepTraceForPassedTests": true
+},
+"CDPHelper": {
+"require": "./helpers/CDPHelper.ts"
+},
+"OpenAI": {
+"chunkSize": 8000
+},
+"ExpectHelper": {
+"require": "codeceptjs-expect"
+},
+"REST": {
+"endpoint": "https://reqres.in",
+"timeout": 20000
+},
+"AllureHelper": {
+"require": "./helpers/AllureHelper.ts"
+}
+}
+plugins:  {
+"screenshotOnFail": {
+"enabled": true
+},
+"tryTo": {
+"enabled": true
+},
+"retryFailedStep": {
+"enabled": true
+},
+"retryTo": {
+"enabled": true
+},
+"eachElement": {
+"enabled": true
+},
+"pauseOnFail": {}
+}
+***************************************
+If you have questions ask them in our Slack: http://bit.ly/chat-codeceptjs
+Or ask them on our discussion board: https://codecept.discourse.group/
+Please copy environment info when you report issues on GitHub: https://github.com/Codeception/CodeceptJS/issues
+***************************************
+CodeceptJS v3.5.4 #StandWithUkraine
+```
+
+* some typings improvements ([#3855](https://github.com/codeceptjs/CodeceptJS/issues/3855)) - by **[nikzupancic](https://github.com/nikzupancic)**
+* support the puppeteer 21.1.1 ([#3856](https://github.com/codeceptjs/CodeceptJS/issues/3856)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)**
+* fix: support secret value for some methods ([#3837](https://github.com/codeceptjs/CodeceptJS/issues/3837)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)**
+
+```
+await I.amOnPage('/form/field_values');
+await I.dontSeeInField('checkbox[]', secret('not seen one'));
+await I.seeInField('checkbox[]', secret('see test one'));
+await I.dontSeeInField('checkbox[]', secret('not seen two'));
+await I.seeInField('checkbox[]', secret('see test two'));
+await I.dontSeeInField('checkbox[]', secret('not seen three'));
+await I.seeInField('checkbox[]', secret('see test three'));
+```
+
+🛩️  **Several bugfixes and improvements for Codecept-UI**
+* Mask the secret value in UI
+* Improve UX/UI
+* PageObjects are now showing in UI
+
+## 3.5.4
+
+🐛 Bug Fixes:
+ * **[Playwright]** When passing `userDataDir`, it throws error after test execution ([#3814](https://github.com/codeceptjs/CodeceptJS/issues/3814)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)**
+ * [CodeceptJS-CLI] Improve command to generate types ([#3788](https://github.com/codeceptjs/CodeceptJS/issues/3788)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)**
+ * Heal plugin fix ([#3820](https://github.com/codeceptjs/CodeceptJS/issues/3820)) - by **[davert](https://github.com/davert)**
+ * Fix for error in using `all` with `run-workers` ([#3805](https://github.com/codeceptjs/CodeceptJS/issues/3805)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)**
+```js
+  helpers: {
+    Playwright: {
+      url: 'https://github.com',
+      show: false,
+      browser: 'chromium',
+      waitForNavigation: 'load',
+      waitForTimeout: 30_000,
+      trace: true,
+      keepTraceForPassedTests: true
+    },
+  },
+  multiple: {
+    profile1: {
+      browsers: [
+        {
+          browser: "chromium",
+        }
+      ]
+    },
+  },
+```
+ * Highlight elements issues ([#3779](https://github.com/codeceptjs/CodeceptJS/issues/3779)) ([#3778](https://github.com/codeceptjs/CodeceptJS/issues/3778)) - by **[philkas](https://github.com/philkas)**
+ * Support `&nbsp` symbol in `I.see` method ([#3815](https://github.com/codeceptjs/CodeceptJS/issues/3815)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)**
+
+```js
+// HTML code uses   instead of space
+<div class="dJHe_" style="color: rgb(255, 255, 255);">My&nbsp;Text!</div>
+
+I.see("My Text!") // this test would work with both &nbsp; and space
+```
+
+📖 Documentation
+ * Improve the configuration of electron testing when the app is build with electron-forge ([#3802](https://github.com/codeceptjs/CodeceptJS/issues/3802)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)**
+
+```js
+const path = require("path");
+
+exports.config = {
+  helpers: {
+    Playwright: {
+      browser: "electron",
+      electron: {
+        executablePath: require("electron"),
+        args: [path.join(__dirname, ".webpack/main/index.js")],
+      },
+    },
+  },
+  // rest of config
+}
+```
+
+🛩️ Features
+
+#### **[Playwright]** new features and improvements
+ * Parse the response in recording network steps ([#3771](https://github.com/codeceptjs/CodeceptJS/issues/3771)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)**
+
+```js
+      const traffics = await I.grabRecordedNetworkTraffics();
+      expect(traffics[0].url).to.equal('https://reqres.in/api/comments/1');
+      expect(traffics[0].response.status).to.equal(200);
+      expect(traffics[0].response.body).to.contain({ name: 'this was mocked' });
+
+      expect(traffics[1].url).to.equal('https://reqres.in/api/comments/1');
+      expect(traffics[1].response.status).to.equal(200);
+      expect(traffics[1].response.body).to.contain({ name: 'this was another mocked' });
+```
+ * Grab metrics ([#3809](https://github.com/codeceptjs/CodeceptJS/issues/3809)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)**
+
+```js
+const metrics = await I.grabMetrics();
+
+// returned metrics
+
+[
+  { name: 'Timestamp', value: 1584904.203473 },
+  { name: 'AudioHandlers', value: 0 },
+  { name: 'AudioWorkletProcessors', value: 0 },
+  { name: 'Documents', value: 22 },
+  { name: 'Frames', value: 10 },
+  { name: 'JSEventListeners', value: 366 },
+  { name: 'LayoutObjects', value: 1240 },
+  { name: 'MediaKeySessions', value: 0 },
+  { name: 'MediaKeys', value: 0 },
+  { name: 'Nodes', value: 4505 },
+  { name: 'Resources', value: 141 },
+  { name: 'ContextLifecycleStateObservers', value: 34 },
+  { name: 'V8PerContextDatas', value: 4 },
+  { name: 'WorkerGlobalScopes', value: 0 },
+  { name: 'UACSSResources', value: 0 },
+  { name: 'RTCPeerConnections', value: 0 },
+  { name: 'ResourceFetchers', value: 22 },
+  { name: 'AdSubframes', value: 0 },
+  { name: 'DetachedScriptStates', value: 2 },
+  { name: 'ArrayBufferContents', value: 1 },
+  { name: 'LayoutCount', value: 0 },
+  { name: 'RecalcStyleCount', value: 0 },
+  { name: 'LayoutDuration', value: 0 },
+  { name: 'RecalcStyleDuration', value: 0 },
+  { name: 'DevToolsCommandDuration', value: 0.000013 },
+  { name: 'ScriptDuration', value: 0 },
+  { name: 'V8CompileDuration', value: 0 },
+  { name: 'TaskDuration', value: 0.000014 },
+  { name: 'TaskOtherDuration', value: 0.000001 },
+  { name: 'ThreadTime', value: 0.000046 },
+  { name: 'ProcessTime', value: 0.616852 },
+  { name: 'JSHeapUsedSize', value: 19004908 },
+  { name: 'JSHeapTotalSize', value: 26820608 },
+  { name: 'FirstMeaningfulPaint', value: 0 },
+  { name: 'DomContentLoaded', value: 1584903.690491 },
+  { name: 'NavigationStart', value: 1584902.841845 }
+]
+```
+
+* Grab WebSocket (WS) messages ([#3789](https://github.com/codeceptjs/CodeceptJS/issues/3789)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)**
+  * `flushWebSocketMessages`
+  * `grabWebSocketMessages`
+  * `startRecordingWebSocketMessages`
+  * `stopRecordingWebSocketMessages`
+
+```js
+await I.startRecordingWebSocketMessages();
+I.amOnPage('https://websocketstest.com/');
+I.waitForText('Work for You!');
+I.flushNetworkTraffics();
+const wsMessages = I.grabWebSocketMessages();
+expect(wsMessages.length).to.equal(0);
+```
+
+```js
+await I.startRecordingWebSocketMessages();
+await I.amOnPage('https://websocketstest.com/');
+I.waitForText('Work for You!');
+const wsMessages = I.grabWebSocketMessages();
+expect(wsMessages.length).to.greaterThan(0);
+```
+
+```js
+await I.startRecordingWebSocketMessages();
+await I.amOnPage('https://websocketstest.com/');
+I.waitForText('Work for You!');
+const wsMessages = I.grabWebSocketMessages();
+await I.stopRecordingWebSocketMessages();
+await I.amOnPage('https://websocketstest.com/');
+I.waitForText('Work for You!');
+const afterWsMessages = I.grabWebSocketMessages();
+expect(wsMessages.length).to.equal(afterWsMessages.length);
+```
+
+* Move from `ElementHandle` to `Locator`. This change is quite major, but it happened under hood, so should not affect your code.  ([#3738](https://github.com/codeceptjs/CodeceptJS/issues/3738)) - by **[KobeNguyenT](https://github.com/KobeNguyenT)**
+
+## 3.5.3
+
+🛩️ Features
+
+* **[Playwright]** Added commands to check network traffic [#3748](https://github.com/codeceptjs/CodeceptJS/issues/3748) - by **[ngraf](https://github.com/ngraf)** **[KobeNguyenT](https://github.com/KobeNguyenT)**
+  * `startRecordingTraffic`
+  * `grabRecordedNetworkTraffics`
+  * `blockTraffic`
+  * `mockTraffic`
+  * `flushNetworkTraffics`
+  * `stopRecordingTraffic`
+  * `seeTraffic`
+  * `grabTrafficUrl`
+  * `dontSeeTraffic`
+
+Examples:
+
+```js
+// recording traffics and verify the traffic
+  await I.startRecordingTraffic();
+  I.amOnPage('https://codecept.io/');
+  await I.seeTraffic({ name: 'traffics', url: 'https://codecept.io/img/companies/BC_LogoScreen_C.jpg' });
+```
+
+```js
+// block the traffic
+  I.blockTraffic('https://reqres.in/api/comments/*');
+  await I.amOnPage('/form/fetch_call');
+  await I.startRecordingTraffic();
+  await I.click('GET COMMENTS');
+  await I.see('Can not load data!');
+```
+
+```js
+// check the traffic with advanced params
+  I.amOnPage('https://openai.com/blog/chatgpt');
+  await I.startRecordingTraffic();
+  await I.seeTraffic({
+    name: 'sentry event',
+    url: 'https://images.openai.com/blob/cf717bdb-0c8c-428a-b82b-3c3add87a600',
+    parameters: {
+      width: '1919',
+      height: '1138',
+    },
+  });
+```
+
+🐛 Bugfix
+
+* **[retryStepPlugin]** Fix retry step when using global retry [#3768](https://github.com/codeceptjs/CodeceptJS/issues/3768) - by **[KobeNguyenT](https://github.com/KobeNguyenT)**
+
+🗑 Deprecated
+
+* Nightmare and Protractor helpers have been deprecated
+
+## 3.5.2
+
+🐛 Bug Fixes
+
+* **[Playwright]** reverted `clearField` to previous implementation
+* **[OpenAI]** fixed running helper in pause mode. [#3755](https://github.com/codeceptjs/CodeceptJS/issues/3755) by **[KobeNguyenT](https://github.com/KobeNguyenT)**
+
 ## 3.5.1
 
 🛩️ Features

package/docs/community-helpers.md

@@ -31,9 +31,6 @@ Please **add your own** by editing this page.
 * [codeceptjs-bshelper](https://github.com/PeterNgTr/codeceptjs-bshelper) - a helper which updates `Test Names` & `Test Results` on Browserstack 
 * [codeceptjs-tbhelper](https://github.com/testingbot/codeceptjs-tbhelper) - a helper which updates `Test Names` & `Test Results` on TestingBot 
 
-## Integrations
-* [codeceptjs-testrail](https://github.com/PeterNgTr/codeceptjs-testrail) - a plugin to integrate with [Testrail](https://www.gurock.com/testrail)
-
 ## Visual-Testing
 * [codeceptjs-resemblehelper](https://github.com/puneet0191/codeceptjs-resemblehelper) - a helper which helps with visual testing using resemble.js. 
 * [codeceptjs-applitoolshelper](https://www.npmjs.com/package/codeceptjs-applitoolshelper) - a helper which helps interaction with [Applitools](https://applitools.com)
@@ -42,8 +39,10 @@ Please **add your own** by editing this page.
 ## Reporters
 * [codeceptjs-rphelper](https://github.com/reportportal/agent-js-codecept) is a CodeceptJS helper which can publish tests results on ReportPortal after execution.
 * [codeceptjs-xray-helper](https://www.npmjs.com/package/codeceptjs-xray-helper) is a CodeceptJS helper which can publish tests results on [XRAY](https://confluence.xpand-it.com/display/XRAYCLOUD/Import+Execution+Results+-+REST).
+* [codeceptjs-xray-cloud-helper](https://www.npmjs.com/package/codeceptjs-xray-cloud-helper) is a helper that automatically retrieves the result of CodeceptJS tests and sends them to XRAY/JIRA(cloud version) via [XRAY Cloud API](https://docs.getxray.app/display/XRAYCLOUD/Import+Execution+Results+-+REST+v2#ImportExecutionResultsRESTv2-XrayJSONresults).
 * [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)
 
 ## 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.
@@ -55,4 +54,9 @@ Please **add your own** by editing this page.
 ## Other
 
 * [codeceptjs-cmdhelper](https://github.com/thiagodp/codeceptjs-cmdhelper) allows you to run commands in the terminal/console
-* [eslint-plugin-codeceptjs](https://www.npmjs.com/package/eslint-plugin-codeceptjs) Eslint rules for CodeceptJS.
+* [eslint-plugin-codeceptjs](https://www.npmjs.com/package/eslint-plugin-codeceptjs) Eslint rules for CodeceptJS.
+* [codeceptjs-datalayer-helper](https://github.com/kobenguyent/codeceptjs-datalayer-helper) CodeceptJS DataLayer helper helps you to get the datalayer JavaScript array that is used to store information and send this data to the tag manager.
+* [codeceptjs-a11y-helper](https://github.com/kobenguyent/codeceptjs-a11y-helper) accessibility tests integrated with CodeceptJS - Playwright-axe
+* [codeceptjs-lighthouse-helper](https://github.com/kobenguyent/codeceptjs-lighthouse-helper) lighthouse audit integrated with CodeceptJS - Playwright
+* [Snowplow Data analytics](https://www.npmjs.com/package/@viasat/codeceptjs-snowplow-helper) - Test your Snowplow events implementations with CodeceptJS and Snowplow Micro.
+* [codeceptjs-failure-logger](https://github.com/kobenguyent/codeceptjs-failure-logger) - Log failed CodeceptJS tests to file

package/docs/examples.md

@@ -16,6 +16,7 @@ Playground repository where you can run tests in different helpers on a basic si
 
 Tests repository demonstrate usage of
 
+* Playwright helper
 * Puppeteer helper
 * WebDriver helper
 * TestCafe plugin
@@ -28,7 +29,6 @@ Tests repository demonstrate usage of
 CodeceptJS repo contains basic tests (both failing and passing) just to show how it works.
 Our team uses it to test new features and run simple scenarios.
 
-
 ## [CodeceptJS Cucumber E2E Framework](https://github.com/gkushang/codeceptjs-e2e)
 
 This repository contains complete E2E framework for CodeceptJS with Cucumber and SauceLabs Integration
@@ -146,4 +146,10 @@ This is necessary if all integrations with TMS and CI/CD are already configured,
 * HTTP request client with session support and unit tests
 * Exemplary code control
 * Ready to launch in a CI/CD system as is
-* OOP, Test data models and builders, endpoint decorators
+* OOP, Test data models and builders, endpoint decorators
+
+## [Playwright fun with CodeceptJS](https://github.com/PeterNgTr/codeceptjs-playwright-fun)
+* Tests are written in TS
+* CI/CD with Github Actions
+* Page Object Model is applied
+* ReportPortal Integration

package/docs/helpers/Appium.md

@@ -99,6 +99,43 @@ helpers: {
 }
 ```
 
+Example Android App using Appiumv2 on BrowserStack:
+
+```js
+{
+helpers: {
+  Appium: {
+        appiumV2: true,
+        host: "hub-cloud.browserstack.com",
+        port: 4444,
+        user: process.env.BROWSERSTACK_USER,
+        key: process.env.BROWSERSTACK_KEY,
+        app: `bs://c700ce60cf1gjhgjh3ae8ed9770ghjg5a55b8e022f13c5827cg`,
+        browser: '',
+        desiredCapabilities: {
+            'appPackage': data.packageName,
+            'deviceName': process.env.DEVICE || 'Google Pixel 3',
+            'platformName': process.env.PLATFORM || 'android',
+            'platformVersion': process.env.OS_VERSION || '10.0',
+            'automationName': process.env.ENGINE || 'UIAutomator2',
+            'newCommandTimeout': 300000,
+            'androidDeviceReadyTimeout': 300000,
+            'androidInstallTimeout': 90000,
+            'appWaitDuration': 300000,
+            'autoGrantPermissions': true,
+            'gpsEnabled': true,
+            'isHeadless': false,
+            'noReset': false,
+            'noSign': true,
+            'bstack:options' : {
+                "appiumVersion" : "2.0.1",
+            },
+        }
+  }
+}
+}
+```
+
 Additional configuration params can be used from [https://github.com/appium/appium/blob/master/docs/en/writing-running-appium/caps.md][4]
 
 ## Access From Helpers
@@ -941,7 +978,7 @@ I.dontSeeInField({ css: 'form input.email' }, 'user@user.com'); // field by CSS
 #### Parameters
 
 -   `field` **([string][5] \| [object][10])** located by label|name|CSS|XPath|strict locator.
--   `value` **[string][5]** value to check.
+-   `value` **([string][5] \| [object][10])** value to check.
     ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### dontSee
@@ -1171,7 +1208,7 @@ I.seeInField('#searchform input','Search');
 #### Parameters
 
 -   `field` **([string][5] \| [object][10])** located by label|name|CSS|XPath|strict locator.
--   `value` **[string][5]** value to check.
+-   `value` **([string][5] \| [object][10])** value to check.
     ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### see

package/docs/helpers/GraphQL.md

@@ -68,6 +68,27 @@ Prepares request for axios call
 
 Returns **[object][2]** graphQLRequest
 
+### amBearerAuthenticated
+
+Adds a header for Bearer authentication
+
+```js
+// we use secret function to hide token from logs
+I.amBearerAuthenticated(secret('heregoestoken'))
+```
+
+#### Parameters
+
+-   `accessToken` **([string][3] | CodeceptJS.Secret)** Bearer access token
+
+### haveRequestHeaders
+
+Sets request headers for all requests of this test
+
+#### Parameters
+
+-   `headers` **[object][2]** headers list
+
 ### sendMutation
 
 Send query to GraphQL endpoint over http