@toptal/davinci-qa 9.0.1 → 10.0.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Change Log
 
+## 10.0.0
+
+### Major Changes
+
+- [#1355](https://github.com/toptal/davinci/pull/1355) [`a59617c3`](https://github.com/toptal/davinci/commit/a59617c33ad153b1aaff797dd3492dc3d3678ca0) Thanks [@TomasSlama](https://github.com/TomasSlama)! - Update Cypress to v10. Follow [migration guide](https://docs.cypress.io/guides/references/migration-guide)
+
 ## 9.0.1
 
 ### Patch Changes

package/README.md

@@ -29,7 +29,7 @@ Example of execution unit tests in two separate threads:
 ```
 GROUP_INDEX=0 GROUP_TOTAL=2 davinci qa unit --ci
 GROUP_INDEX=1 GROUP_TOTAL=2 davinci qa unit --ci
-````
+```
 
 To specify a Sequencer, need to specify two environment variables:
 
@@ -55,25 +55,17 @@ Options:
 
 #### Extending Cypress config
 
-By default [cypress.config.json](https://github.com/toptal/davinci/blob/0f1f1485433573baeca66cf0c379259ca21b3f2f/packages/qa/src/configs/cypress.config.json#L1) is used.
-
-To extend default config, create `/cypress.json` file in the root of the project and use `extends`:
-```json
-{
-  "extends": "@toptal/davinci-qa/src/configs/cypress.config.json",
-  ...other custom configs
-}
-````
+By default [cypress.config.js](https://github.com/toptal/davinci/blob/0f1f1485433573baeca66cf0c379259ca21b3f2f/packages/qa/src/configs/cypress.config.js#L1) is used.
 
-In `/cypress/plugins/index.js` file add:
+To extend default config, create `/cypress.config.js` file in the root of the project and spread the default config into yours:
 ```js
-const plugins = require('@toptal/davinci-qa/src/configs/cypress/plugins')
-...
-module.exports = (on, config) => {
-  plugins(on, config)
-  ...
-  // rest of plugins
-}
+const davinciConfig = require('@toptal/davinci-qa/src/configs/cypress.config.js')
+
+export default defineConfig({
+  ...davinciConfig,
+  e2e: { ...davinciConfig.e2e, ...custom },
+  component: { ...davinciConfig.component, ...custom },
+})
 ```
 
 ### Alias

package/dist-package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toptal/davinci-qa",
-  "version": "9.0.1",
+  "version": "10.0.0",
   "description": "QA package to test your application",
   "publishConfig": {
     "access": "public"
@@ -33,15 +33,14 @@
     "@babel/preset-env": "^7.18.0",
     "@babel/preset-react": "^7.17.12",
     "@babel/preset-typescript": "^7.17.12",
-    "@bahmutov/cypress-extends": "^1.1.0",
-    "@cypress/code-coverage": "^3.9.12",
-    "@cypress/webpack-preprocessor": "^5.11.0",
     "@testing-library/jest-dom": "^5.16.4",
     "@testing-library/react": "^12.1.2",
     "@toptal/davinci-cli-shared": "1.5.2",
     "@types/jest": "^27.5.1",
     "babel-jest": "^28.1.0",
-    "cypress": "^9.7.0",
+    "@cypress/code-coverage": "^3.10.0",
+    "@cypress/webpack-preprocessor": "^5.12.0",
+    "cypress": "^10.0.3",
     "enhanced-resolve": "^5.9.2",
     "fs-extra": "^10.0.0",
     "glob": "^8.0.3",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toptal/davinci-qa",
-  "version": "9.0.1",
+  "version": "10.0.0",
   "description": "QA package to test your application",
   "publishConfig": {
     "access": "public"
@@ -33,15 +33,14 @@
     "@babel/preset-env": "^7.18.0",
     "@babel/preset-react": "^7.17.12",
     "@babel/preset-typescript": "^7.17.12",
-    "@bahmutov/cypress-extends": "^1.1.0",
-    "@cypress/code-coverage": "^3.9.12",
-    "@cypress/webpack-preprocessor": "^5.11.0",
     "@testing-library/jest-dom": "^5.16.4",
     "@testing-library/react": "^12.1.2",
     "@toptal/davinci-cli-shared": "1.5.2",
     "@types/jest": "^27.5.1",
     "babel-jest": "^28.1.0",
-    "cypress": "^9.7.0",
+    "@cypress/code-coverage": "^3.10.0",
+    "@cypress/webpack-preprocessor": "^5.12.0",
+    "cypress": "^10.0.3",
     "enhanced-resolve": "^5.9.2",
     "fs-extra": "^10.0.0",
     "glob": "^8.0.3",

package/src/commands/integration-tests.js

@@ -13,7 +13,7 @@ const integrationTestCommand = ({
 
   const configPath = files.getPackageFilePath(
     '@toptal/davinci-qa',
-    'src/configs/cypress.config.json'
+    'src/configs/cypress.config.js'
   )
   const cypressReporterPath = files.getPackageFilePath(
     '@toptal/davinci-qa',

package/src/commands/integration-tests.test.js

@@ -20,7 +20,7 @@ describe('integrationTestCommand', () => {
   it('runs cypress with default options', () => {
     convertToCLIParametersMock.mockReturnValueOnce([])
     getPackageFilePathMock.mockReturnValueOnce(
-      'packages/qa/src/configs/cypress.config.json'
+      'packages/qa/src/configs/cypress.config.js'
     )
 
     action({ options: {} })
@@ -29,13 +29,13 @@ describe('integrationTestCommand', () => {
       'cypress',
       'run',
       '--config-file',
-      'packages/qa/src/configs/cypress.config.json',
+      'packages/qa/src/configs/cypress.config.js',
     ])
 
     expect(convertToCLIParametersMock).toHaveBeenCalledWith({})
     expect(getPackageFilePathMock).toHaveBeenCalledWith(
       '@toptal/davinci-qa',
-      'src/configs/cypress.config.json'
+      'src/configs/cypress.config.js'
     )
   })
 
@@ -44,7 +44,7 @@ describe('integrationTestCommand', () => {
 
     convertToCLIParametersMock.mockReturnValueOnce(['--spec', spec])
     getPackageFilePathMock.mockReturnValueOnce(
-      'packages/qa/src/configs/cypress.config.json'
+      'packages/qa/src/configs/cypress.config.js'
     )
 
     action({ options: { spec } })
@@ -53,7 +53,7 @@ describe('integrationTestCommand', () => {
       'cypress',
       'run',
       '--config-file',
-      'packages/qa/src/configs/cypress.config.json',
+      'packages/qa/src/configs/cypress.config.js',
       '--spec',
       spec,
     ])
@@ -63,7 +63,7 @@ describe('integrationTestCommand', () => {
     })
     expect(getPackageFilePathMock).toHaveBeenCalledWith(
       '@toptal/davinci-qa',
-      'src/configs/cypress.config.json'
+      'src/configs/cypress.config.js'
     )
   })
 })

package/src/configs/cypress.config.js

@@ -0,0 +1,39 @@
+const { defineConfig } = require('cypress')
+
+const {
+  webpackPreprocessor,
+} = require('./cypress/plugins/webpack-preprocessor')
+const parallelization = require('./cypress/plugins/parallelization')
+
+module.exports = defineConfig({
+  defaultCommandTimeout: 6000,
+  fixturesFolder: './cypress/fixtures',
+  chromeWebSecurity: false,
+  screenshotsFolder: './cypress/screenshots',
+  video: false,
+
+  component: {
+    viewportWidth: 1280,
+    viewportHeight: 1024,
+    slowTestThreshold: 250,
+    specPattern: 'src/**/*.cy.{js,jsx,ts,tsx}',
+    supportFile: 'cypress/support/component.{js,ts}',
+  },
+
+  e2e: {
+    setupNodeEvents(on, config) {
+      // generate code coverage
+      require('@cypress/code-coverage/task')(on, config)
+
+      // split spec files in CI
+      parallelization(config)
+
+      // instrument code for code coverage
+      on('file:preprocessor', webpackPreprocessor)
+    },
+    baseUrl: 'http://0.0.0.0:3000',
+    slowTestThreshold: 10000,
+    specPattern: 'cypress/integration/**/*.spec.{js,jsx,ts,tsx}',
+    supportFile: 'cypress/support/e2e.{js,ts}',
+  },
+})

package/src/configs/cypress/plugins/__snapshots__/extends.test.js.snap

@@ -1,28 +0,0 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
-
-exports[`cypress extends tests when "extends" key exists in the source config file merges extended config into source config 1`] = `
-"{
-  configFile: '@toptal/davinci-qa/src/configs/cypress/plugins/config-with-extends.test.json',
-  fixturesFolder: './cypress/fixtures',
-  integrationFolder: '.',
-  screenshotsFolder: './cypress/screenshots',
-  testFiles: [
-    'cypress/**/spec.{js,ts}',
-    'cypress/**/*.spec.{js,ts}',
-  ],
-  ignoreTestFiles: '**/node_modules/**/*',
-  pluginsFile: './cypress/plugins/index.js',
-  baseUrl: 'http://0.0.0.0:3000',
-  chromeWebSecurity: false,
-  defaultCommandTimeout: 1000,
-  video: false,
-  extends: '@toptal/davinci-qa/src/configs/cypress.config.json',
-}"
-`;
-
-exports[`cypress extends tests when no "extends" exist in the source config file returns source config file without any change 1`] = `
-"{
-  configFile: '@toptal/davinci-qa/src/configs/cypress/plugins/config-without-extends.test.json',
-  defaultCommandTimeout: 1000,
-}"
-`;

package/src/configs/cypress/plugins/config-with-extends.test.json

@@ -1,4 +0,0 @@
-{
-  "extends": "@toptal/davinci-qa/src/configs/cypress.config.json",
-  "defaultCommandTimeout": 1000
-}

package/src/configs/cypress/plugins/config-without-extends.test.json

@@ -1,3 +0,0 @@
-{
-  "defaultCommandTimeout": 1000
-}

package/src/configs/cypress/plugins/extends.test.js

@@ -1,43 +0,0 @@
-const json5 = require('json5')
-
-const plugins = require('./index')
-
-jest.mock('@cypress/code-coverage/task', () => jest.fn())
-jest.mock('./parallelization', () => jest.fn())
-
-const configWithExtendsPath =
-  '@toptal/davinci-qa/src/configs/cypress/plugins/config-with-extends.test.json'
-const configWithoutExtendsPath =
-  '@toptal/davinci-qa/src/configs/cypress/plugins/config-without-extends.test.json'
-
-describe('cypress extends tests', () => {
-  const onFunction = jest.fn()
-
-  describe('when no "extends" exist in the source config file', () => {
-    it('returns source config file without any change', () => {
-      const config = {
-        configFile: configWithoutExtendsPath,
-      }
-
-      plugins(onFunction, config)
-
-      const serializedConfig = json5.stringify(config, null, 2)
-
-      expect(serializedConfig).toMatchSnapshot()
-    })
-  })
-
-  describe('when "extends" key exists in the source config file', () => {
-    it('merges extended config into source config', () => {
-      const config = {
-        configFile: configWithExtendsPath,
-      }
-
-      plugins(onFunction, config)
-
-      const serializedConfig = json5.stringify(config, null, 2)
-
-      expect(serializedConfig).toMatchSnapshot()
-    })
-  })
-})

package/src/configs/cypress/plugins/index.js

@@ -1,22 +0,0 @@
-const { webpackPreprocessor } = require('./webpack-preprocessor')
-
-module.exports = (on, config) => {
-  // generate code coverage
-  require('@cypress/code-coverage/task')(on, config)
-
-  // instrument code for code coverage
-  on('file:preprocessor', webpackPreprocessor)
-
-  // split spec files in CI
-  require('./parallelization')(config)
-
-  // enable 'extends' support for cypress config files
-  const overriddenConfig = require('@bahmutov/cypress-extends')(
-    config.configFile
-  )
-
-  // mutate 'config' file directly to hide it from other projects
-  Object.assign(config, overriddenConfig)
-
-  return config
-}

package/src/configs/cypress.config.json

@@ -1,12 +0,0 @@
-{
-  "fixturesFolder": "./cypress/fixtures",
-  "integrationFolder": ".",
-  "screenshotsFolder": "./cypress/screenshots",
-  "testFiles": ["cypress/**/spec.{js,ts}", "cypress/**/*.spec.{js,ts}"],
-  "ignoreTestFiles": "**/node_modules/**/*",
-  "pluginsFile": "./cypress/plugins/index.js",
-  "baseUrl": "http://0.0.0.0:3000",
-  "chromeWebSecurity": false,
-  "defaultCommandTimeout": 6000,
-  "video": false
-}