codeceptjs - npm Package Versions

3.3.4

• Added support for masking fields in objects via secret function:

I.sendPostRequest('/auth', secret({ name: 'jon', password: '123456' }, 'password'));

• Added a guide about using of secret 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

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

// response.data == [
//   { user: { name: 'jon', email: 'jon@doe.com' } },
//   { user: { name: 'matt', email: 'matt@doe.com' } },
//]

I.seeResponseContainsKeys(['user']);
I.seeResponseContainsJson({ user: { email: 'jon@doe.com' } });
I.seeResponseContainsJson({ user: { email: 'matt@doe.com' } });
I.dontSeeResponseContainsJson({ user: 2 });

3.3.3

• Fixed DataCloneError: () => could not be cloned when running data tests in run-workers
• 🇺🇦 Added #StandWithUkraine notice to CLI

3.3.2

• [REST] Fixed override of headers/token in haveRequestHeaders() and amBearerAuthenticated(). See #3304 by @mirao
• Reverted typings change introduced in #3245. More details on this

3.3.1

🛩️ Features:

• Add option to avoid duplicate gherkin step definitions (#3257) - @raywiis
• Added step.* for run-workers #3272. Thanks to @abhimanyupandian
• Fixed loading tests for codecept run using glob patterns. By @jayudey-wf

npx codeceptjs run test-dir/*"

• [Playwright] Possible breaking change. By default timeout is changed to 5000ms. The value set in 3.3.0 was too low. Please set timeout explicitly to not depend on release values.
• [Playwright] Added for color scheme option by @PeterNgTr

 helpers: {
  Playwright : {
    url: "http://localhost",
    colorScheme: "dark",
  }
 }

🐛 Bugfixes:

• [Playwright] Fixed Cannot read property 'video' of undefined
• Fixed haveRequestHeaders() and amBearerAuthenticated() of REST helper (#3260) - @mirao
• Fixed: allure attachment fails if screenshot failed #3298 by @ruudvanderweijde
• Fixed #3105 using autoLogin() plugin with TypeScript. Fix #3290 by @PeterNgTr
• [Playwright] Added extra params for click and dragAndDrop to type definitions by @mirao

📖 Documentation

• Improving the typings in many places
• Improving the return type of helpers for TS users (#3245) - @nlespiaucq

3.3.0

🛩️ Features:

• API Testing introduced
  • Introduced JSONResponse helper which connects to REST, GraphQL or Playwright helper
  • [REST] Added amBearerAuthenticated method
  • [REST] Added haveRequestHeaders method
  • Added dependency on joi and chai
• [Playwright] Added timeout option to set timeout for all Playwright actions. If an action fails, Playwright keeps retrying it for a time set by timeout.
• [Playwright] Possible breaking change. By default timeout is set to 1000ms. Previous default was set by Playwright internally to 30s. This was causing contradiction to CodeceptJS retries, so triggered up to 3 retries for 30s of time. This timeout option was lowered so retryFailedStep plugin would not cause long delays.
• [Playwright] Updated restart config option to include 3 restart strategies:
  • 'context' or false - restarts browser context but keeps running browser. Recommended by Playwright team to keep tests isolated.
  • 'browser' or true - closes browser and opens it again between tests.
  • 'session' or 'keep' - keeps browser context and session, but cleans up cookies and localStorage between tests. The fastest option when running tests in windowed mode. Works with keepCookies and keepBrowserState options. This behavior was default prior CodeceptJS 3.1
• [Playwright] Extended methods to provide more options from engine. These methods were updated so additional options can be be passed as the last argument:
  • click
  • dragAndDrop
  • checkOption
  • uncheckOption

// use Playwright click options as 3rd argument
I.click('canvas', '.model', { position: { x: 20, y: 40 } })
// check option also has options
I.checkOption('Agree', '.signup', { position: { x: 5, y: 5 } })

• eachElement plugin introduced. It allows you to iterate over elements and perform some action on them using direct engines API

await eachElement('click all links in .list', '.list a', (el) => {
  await el.click();
})

• [Playwright] Added support to playwright-core package if playwright is not installed. See #3190, fixes #2663.
• [Playwright] Added makeApiRequest action to perform API requests. Requires Playwright >= 1.18
• Added support to codecept.config.js for name consistency across other JS tools. See motivation at #3195 by @JiLiZART
• [ApiDataFactory] Added options arg to have method. See #3197 by @JJlokidoki
• Improved pt-br translations to include keywords: 'Funcionalidade', 'Cenário', 'Antes', 'Depois', 'AntesDaSuite', 'DepoisDaSuite'. See #3206 by @danilolutz
• [allure plugin] Introduced addStep method to add comments and attachments. See #3104 by @EgorBodnar

🐛 Bugfixes:

• Fixed #3212: using Regex flags for Cucumber steps. See #3214 by @anils92

📖 Documentation

• Added Testomat.io reporter
• Added api testing guides
• Added internal api guides
• [Appium] Fixed documentation for performSwipe
• [Playwright] update docs for usePlaywrightTo method by @dbudzins