codeceptjs 3.5.4-beta.1 → 3.5.5

package/CHANGELOG.md

@@ -1,3 +1,371 @@
+## 3.5.5
+
+🐛 Bug Fixes
+* fix(browserstack): issue with vendor prefix (#3845) - by @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) - by @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) - by @andonary
+```
+  include: {
+    Je: './steps_file.js'
+  }
+```
+
+*  bypassCSP support for Playwright helper (#3865) - by @sammeel
+```
+  helpers: {
+    Playwright: {
+      bypassCSP: true
+    }
+```
+* fix: missing requests when recording network (#3834) - by @KobeNguyenT
+
+🛩️ Features and Improvements
+* Show environment info in verbose mode (#3858) - by @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) - by @nikzupancic
+* support the puppeteer 21.1.1 (#3856) - by @KobeNguyenT
+* fix: support secret value for some methods (#3837) - by @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) - by @KobeNguyenT
+ * [CodeceptJS-CLI] Improve command to generate types (#3788) - by @KobeNguyenT
+ * Heal plugin fix (#3820) - by @davert
+ * Fix for error in using `all` with `run-workers` (#3805) - by @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) (#3778) - by @philkas
+ * Support `&nbsp` symbol in `I.see` method (#3815) - by @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) - by @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) - by @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) - by @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) - by @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) - by @KobeNguyenT
+
+## 3.5.3
+
+🛩️ Features
+
+* [Playwright] Added commands to check network traffic #3748 - by @ngraf @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 - by @KobeNguyenT
+
+🗑 Deprecated
+
+* Nightmare and Protractor helpers have been deprecated
+
 ## 3.5.2
 
 🐛 Bug Fixes

package/README.md

@@ -305,8 +305,6 @@ Thanks all to those who are and will have contributing to this awesome project!
 <a href="https://github.com/Georgegriff"><img src="https://avatars.githubusercontent.com/u/9056958?v=4" title="Georgegriff" width="80" height="80"></a>
 <a href="https://github.com/mirao"><img src="https://avatars.githubusercontent.com/u/12584138?v=4" title="mirao" width="80" height="80"></a>
 <a href="https://github.com/KMKoushik"><img src="https://avatars.githubusercontent.com/u/24666922?v=4" title="KMKoushik" width="80" height="80"></a>
-<a href="https://github.com/actions-user"><img src="https://avatars.githubusercontent.com/u/65916846?v=4" title="actions-user" width="80" height="80"></a>
-<a href="https://github.com/apps/dependabot"><img src="https://avatars.githubusercontent.com/in/29110?v=4" title="dependabot[bot]" width="80" height="80"></a>
 <a href="https://github.com/nikocanvacom"><img src="https://avatars.githubusercontent.com/u/83254493?v=4" title="nikocanvacom" width="80" height="80"></a>
 <a href="https://github.com/elukoyanov"><img src="https://avatars.githubusercontent.com/u/11647141?v=4" title="elukoyanov" width="80" height="80"></a>
 <a href="https://github.com/gkushang"><img src="https://avatars.githubusercontent.com/u/3663389?v=4" title="gkushang" width="80" height="80"></a>

package/docs/build/Appium.js

@@ -117,6 +117,43 @@ const vendorPrefix = {
  * }
  * ```
  *
+ * 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>
  *
  * ## Access From Helpers
@@ -234,7 +271,9 @@ class Appium extends Webdriver {
     const _convertedCaps = {};
     for (const [key, value] of Object.entries(capabilities)) {
       if (!key.startsWith(vendorPrefix.appium)) {
-        _convertedCaps[`${vendorPrefix.appium}:${key}`] = value;
+        if (key !== 'platformName') {
+          _convertedCaps[`${vendorPrefix.appium}:${key}`] = value;
+        }
       } else {
         _convertedCaps[`${key}`] = value;
       }
@@ -1505,14 +1544,15 @@ class Appium extends Webdriver {
    * ```
    * 
    * @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
-   * @param {string} value value to check.
+   * @param {CodeceptJS.StringOrSecret} value value to check.
    * ⚠️ returns a _promise_ which is synchronized internally by recorder
    * 
    *
    */
   async dontSeeInField(field, value) {
-    if (this.isWeb) return super.dontSeeInField(field, value);
-    return super.dontSeeInField(parseLocator.call(this, field), value);
+    const _value = (typeof value === 'boolean') ? value : value.toString();
+    if (this.isWeb) return super.dontSeeInField(field, _value);
+    return super.dontSeeInField(parseLocator.call(this, field), _value);
   }
 
   /**
@@ -1768,14 +1808,15 @@ class Appium extends Webdriver {
    * I.seeInField('#searchform input','Search');
    * ```
    * @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
-   * @param {string} value value to check.
+   * @param {CodeceptJS.StringOrSecret} value value to check.
    * ⚠️ returns a _promise_ which is synchronized internally by recorder
    * 
    *
    */
   async seeInField(field, value) {
-    if (this.isWeb) return super.seeInField(field, value);
-    return super.seeInField(parseLocator.call(this, field), value);
+    const _value = (typeof value === 'boolean') ? value : value.toString();
+    if (this.isWeb) return super.seeInField(field, _value);
+    return super.seeInField(parseLocator.call(this, field), _value);
   }
 
   /**

package/docs/build/GraphQL.js

@@ -81,6 +81,8 @@ class GraphQL extends Helper {
       'Content-Type': 'application/json',
     });
 
+    request.headers = { ...this.headers, ...request.headers };
+
     if (this.config.onRequest) {
       await this.config.onRequest(request);
     }
@@ -200,5 +202,28 @@ class GraphQL extends Helper {
   _setRequestTimeout(newTimeout) {
     this.options.timeout = newTimeout;
   }
+
+  /**
+   * Sets request headers for all requests of this test
+   *
+   * @param {object} headers headers list
+   */
+  haveRequestHeaders(headers) {
+    this.headers = { ...this.headers, ...headers };
+  }
+
+  /**
+   * Adds a header for Bearer authentication
+   *
+   * ```js
+   * // we use secret function to hide token from logs
+   * I.amBearerAuthenticated(secret('heregoestoken'))
+   * ```
+   *
+   * @param {string | CodeceptJS.Secret} accessToken  Bearer access token
+   */
+  amBearerAuthenticated(accessToken) {
+    this.haveRequestHeaders({ Authorization: `Bearer ${accessToken}` });
+  }
 }
 module.exports = GraphQL;

package/docs/build/Nightmare.js

@@ -882,6 +882,8 @@ class Nightmare extends Helper {
    * 
    * @param {string|function} fn function to be executed in browser context.
    * @param {...any} args to be passed to function.
+   * @returns {Promise<any>} script return value
+   * 
    * ⚠️ returns a _promise_ which is synchronized internally by recorder
    * 
    *
@@ -916,6 +918,8 @@ class Nightmare extends Helper {
    * 
    * @param {string|function} fn function to be executed in browser context.
    * @param {...any} args to be passed to function.
+   * @returns {Promise<any>} script return value
+   * 
    * ⚠️ returns a _promise_ which is synchronized internally by recorder
    * 
    *
@@ -1063,12 +1067,13 @@ class Nightmare extends Helper {
    * I.seeInField('#searchform input','Search');
    * ```
    * @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
-   * @param {string} value value to check.
+   * @param {CodeceptJS.StringOrSecret} value value to check.
    * ⚠️ returns a _promise_ which is synchronized internally by recorder
    * 
    */
   async seeInField(field, value) {
-    return proceedSeeInField.call(this, 'assert', field, value);
+    const _value = (typeof value === 'boolean') ? value : value.toString();
+    return proceedSeeInField.call(this, 'assert', field, _value);
   }
 
   /**
@@ -1081,12 +1086,13 @@ class Nightmare extends Helper {
    * ```
    * 
    * @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
-   * @param {string} value value to check.
+   * @param {CodeceptJS.StringOrSecret} value value to check.
    * ⚠️ returns a _promise_ which is synchronized internally by recorder
    * 
    */
   async dontSeeInField(field, value) {
-    return proceedSeeInField.call(this, 'negate', field, value);
+    const _value = (typeof value === 'boolean') ? value : value.toString();
+    return proceedSeeInField.call(this, 'negate', field, _value);
   }
 
   /**
@@ -1990,8 +1996,11 @@ class Nightmare extends Helper {
       const body = document.body;
       const html = document.documentElement;
       window.scrollTo(0, Math.max(
-        body.scrollHeight, body.offsetHeight,
-        html.clientHeight, html.scrollHeight, html.offsetHeight
+        body.scrollHeight,
+        body.offsetHeight,
+        html.clientHeight,
+        html.scrollHeight,
+        html.offsetHeight
       ));
     });
     /* eslint-enable */