breaking: set videoCompression to false by default (#27009)

Update system-tests/projects/ts-proj-5/cypress.config.ts Update system-tests/projects/vite-simple/cypress.config.js Update system-tests/projects/react-vite-ts-configured/cypress.config.ts Update system-tests/projects/svelte-vite/cypress.config.js Update system-tests/projects/ts-proj-4-5/cypress.config.ts Update system-tests/projects/webpack-dev-server-ts/cypress.config.ts Update system-tests/projects/vue3-vite-ts-configured/cypress.config.ts Update system-tests/projects/vue3-vite-ts-custom-index-html/cypress.config.ts Update cli/CHANGELOG.md Update cli/CHANGELOG.md Co-authored-by: Emily Rohrbough <[email protected]>
cypress-io · Jun 20, 2023 · 9e698ce · 9e698ce · cypress-bot · Jun 20, 2023
1 parent 9580dc2
commit 9e698ce
Show file tree

Hide file tree

Showing 65 changed files with 19 additions and 92 deletions.
diff --git a/cli/CHANGELOG.md b/cli/CHANGELOG.md
@@ -7,6 +7,7 @@ _Released 08/1/2023 (PENDING)_
 
 - The [`cy.readFile()`](/api/commands/readfile) command is now retry-able as a [query command](https://on.cypress.io/retry-ability). This should not affect any tests using it; the functionality is unchanged. However, it can no longer be overwritten using [`Cypress.Commands.overwrite()`](/api/cypress-api/custom-commands#Overwrite-Existing-Commands). Addressed in [#25595](https://github.com/cypress-io/cypress/pull/25595).
 - The [`video`](https://docs.cypress.io/guides/references/configuration#Videos) configuration option now defaults to `false`. Addresses [#26157](https://github.com/cypress-io/cypress/issues/26157).
+- The [`videoCompression`](https://docs.cypress.io/guides/references/configuration#Videos) configuration option now defaults to `false`. Addresses [#26160](https://github.com/cypress-io/cypress/issues/26160).
 
 - The deprecated configuration option, `nodeVersion` has been removed. Addresses [#27016](https://github.com/cypress-io/cypress/issues/27016).
 

diff --git a/packages/app/cypress.config.ts b/packages/app/cypress.config.ts
@@ -7,7 +7,6 @@ export default defineConfig({
     runMode: 2,
     openMode: 0,
   },
-  videoCompression: false, // turn off video compression for CI
   reporter: '../../node_modules/cypress-multi-reporters/index.js',
   reporterOptions: {
     configFile: '../../mocha-reporter-config.json',

diff --git a/packages/app/cypress/fixtures/debug-Failing/gql-CloudViewerAndProject_RequiredData.json b/packages/app/cypress/fixtures/debug-Failing/gql-CloudViewerAndProject_RequiredData.json
@@ -299,7 +299,7 @@
           "field": "video"
         },
         {
-          "value": 32,
+          "value": false,
           "from": "default",
           "field": "videoCompression"
         },

diff --git a/packages/app/cypress/fixtures/debug-Failing/gql-HeaderBar_HeaderBarQuery.json b/packages/app/cypress/fixtures/debug-Failing/gql-HeaderBar_HeaderBarQuery.json
@@ -275,7 +275,7 @@
           "field": "video"
         },
         {
-          "value": 32,
+          "value": false,
           "from": "default",
           "field": "videoCompression"
         },

diff --git a/packages/app/cypress/fixtures/debug-Failing/gql-SpecsPageContainer.json b/packages/app/cypress/fixtures/debug-Failing/gql-SpecsPageContainer.json
@@ -660,7 +660,7 @@
           "field": "video"
         },
         {
-          "value": 32,
+          "value": false,
           "from": "default",
           "field": "videoCompression"
         },

diff --git a/packages/app/cypress/fixtures/debug-Passing/gql-CloudViewerAndProject_RequiredData.json b/packages/app/cypress/fixtures/debug-Passing/gql-CloudViewerAndProject_RequiredData.json
@@ -299,7 +299,7 @@
           "field": "video"
         },
         {
-          "value": 32,
+          "value": false,
           "from": "default",
           "field": "videoCompression"
         },

diff --git a/packages/app/cypress/fixtures/debug-Passing/gql-HeaderBar_HeaderBarQuery.json b/packages/app/cypress/fixtures/debug-Passing/gql-HeaderBar_HeaderBarQuery.json
@@ -275,7 +275,7 @@
           "field": "video"
         },
         {
-          "value": 32,
+          "value": false,
           "from": "default",
           "field": "videoCompression"
         },

diff --git a/packages/app/cypress/fixtures/debug-Passing/gql-SpecsPageContainer.json b/packages/app/cypress/fixtures/debug-Passing/gql-SpecsPageContainer.json
@@ -1661,7 +1661,7 @@
           "field": "video"
         },
         {
-          "value": 32,
+          "value": false,
           "from": "default",
           "field": "videoCompression"
         },

diff --git a/packages/config/__snapshots__/index.spec.ts.js b/packages/config/__snapshots__/index.spec.ts.js
@@ -75,7 +75,7 @@ exports['config/src/index .getDefaultValues returns list of public config keys 1
   'trashAssetsBeforeRuns': true,
   'userAgent': null,
   'video': false,
-  'videoCompression': 32,
+  'videoCompression': false,
   'videosFolder': 'cypress/videos',
   'videoUploadOnPasses': true,
   'viewportHeight': 660,
@@ -163,7 +163,7 @@ exports['config/src/index .getDefaultValues returns list of public config keys f
   'trashAssetsBeforeRuns': true,
   'userAgent': null,
   'video': false,
-  'videoCompression': 32,
+  'videoCompression': false,
   'videosFolder': 'cypress/videos',
   'videoUploadOnPasses': true,
   'viewportHeight': 660,

diff --git a/packages/config/src/options.ts b/packages/config/src/options.ts
@@ -422,7 +422,7 @@ const driverConfigOptions: Array<DriverConfigOption> = [
     validation: validate.isBoolean,
   }, {
     name: 'videoCompression',
-    defaultValue: 32,
+    defaultValue: false,
     validation: validate.isValidCrfOrBoolean,
   }, {
     name: 'videosFolder',

diff --git a/packages/config/test/project/utils.spec.ts b/packages/config/test/project/utils.spec.ts
@@ -766,8 +766,8 @@ describe('config/src/project/utils', () => {
       return this.defaults('video', false)
     })
 
-    it('videoCompression=32', function () {
-      return this.defaults('videoCompression', 32)
+    it('videoCompression=false', function () {
+      return this.defaults('videoCompression', false)
     })
 
     it('videoUploadOnPasses=true', function () {
@@ -1077,7 +1077,7 @@ describe('config/src/project/utils', () => {
             trashAssetsBeforeRuns: { value: true, from: 'default' },
             userAgent: { value: null, from: 'default' },
             video: { value: false, from: 'default' },
-            videoCompression: { value: 32, from: 'default' },
+            videoCompression: { value: false, from: 'default' },
             videosFolder: { value: 'cypress/videos', from: 'default' },
             videoUploadOnPasses: { value: true, from: 'default' },
             viewportHeight: { value: 660, from: 'default' },
@@ -1195,7 +1195,7 @@ describe('config/src/project/utils', () => {
             trashAssetsBeforeRuns: { value: true, from: 'default' },
             userAgent: { value: null, from: 'default' },
             video: { value: false, from: 'default' },
-            videoCompression: { value: 32, from: 'default' },
+            videoCompression: { value: false, from: 'default' },
             videosFolder: { value: 'cypress/videos', from: 'default' },
             videoUploadOnPasses: { value: true, from: 'default' },
             viewportHeight: { value: 660, from: 'default' },

diff --git a/packages/driver/cypress.config.ts b/packages/driver/cypress.config.ts
@@ -18,7 +18,6 @@ export default defineConfig({
   reporterOptions: {
     configFile: '../../mocha-reporter-config.json',
   },
-  videoCompression: false, // turn off video compression for CI
   e2e: {
     experimentalOriginDependencies: true,
     experimentalModifyObstructiveThirdPartyCode: true,

diff --git a/packages/frontend-shared/cypress.config.ts b/packages/frontend-shared/cypress.config.ts
@@ -12,7 +12,6 @@ export default defineConfig({
   reporterOptions: {
     configFile: '../../mocha-reporter-config.json',
   },
-  videoCompression: false, // turn off video compression for CI
   component: {
     experimentalSingleTabRunMode: true,
     devServer: {

diff --git a/packages/frontend-shared/cypress/fixtures/config.json b/packages/frontend-shared/cypress/fixtures/config.json
@@ -233,7 +233,7 @@
     "field": "video"
   },
   {
-    "value": 32,
+    "value": false,
     "from": "default",
     "field": "videoCompression"
   },

diff --git a/packages/launchpad/cypress.config.ts b/packages/launchpad/cypress.config.ts
@@ -14,7 +14,6 @@ export default defineConfig({
   reporterOptions: {
     configFile: '../../mocha-reporter-config.json',
   },
-  videoCompression: false, // turn off video compression for CI
   component: {
     experimentalSingleTabRunMode: true,
     supportFile: 'cypress/component/support/index.ts',

diff --git a/packages/reporter/cypress.config.ts b/packages/reporter/cypress.config.ts
@@ -14,8 +14,6 @@ export default defineConfig({
     openMode: 0,
   },
 
-  videoCompression: false, // turn off video compression for CI
-
   e2e: {
     experimentalStudio: true,
     baseUrl: 'http://localhost:5006',

diff --git a/packages/server/test/integration/cypress_spec.js b/packages/server/test/integration/cypress_spec.js
@@ -922,15 +922,15 @@ describe('lib/cypress', () => {
       })
 
       it('can override default values', function () {
-        return cypress.start([`--run-project=${this.todosPath}`, '--config=requestTimeout=1234,videoCompression=false'])
+        return cypress.start([`--run-project=${this.todosPath}`, '--config=requestTimeout=1234,videoCompression=true'])
         .then(() => {
           const { cfg } = openProject.getProject()
 
-          expect(cfg.videoCompression).to.be.false
+          expect(cfg.videoCompression).to.be.true
           expect(cfg.requestTimeout).to.eq(1234)
 
           expect(cfg.resolved.videoCompression).to.deep.eq({
-            value: false,
+            value: true,
             from: 'cli',
           })
 
@@ -945,7 +945,7 @@ describe('lib/cypress', () => {
 
       it('can override values in plugins', function () {
         return cypress.start([
-          `--run-project=${this.pluginConfig}`, '--config=requestTimeout=1234,videoCompression=false',
+          `--run-project=${this.pluginConfig}`, '--config=requestTimeout=1234,videoCompression=true',
           '--env=foo=foo,bar=bar',
         ])
         .then(() => {

diff --git a/system-tests/lib/system-tests.ts b/system-tests/lib/system-tests.ts
@@ -803,15 +803,6 @@ const systemTests = {
     debug('systemTests.exec options %o', options)
     options = this.options(ctx, options)
 
-    // Force the default to have compression off
-    if (!options.config) {
-      options.config = {
-        videoCompression: false,
-      }
-    } else if (!options.config.videoCompression) {
-      options.config.videoCompression = false
-    }
-
     debug('processed options %o', options)
     const args = options.args || this.args(options)
 

diff --git a/system-tests/project-fixtures/angular/cypress.config.ts b/system-tests/project-fixtures/angular/cypress.config.ts
@@ -3,7 +3,6 @@ import { defineConfig } from 'cypress'
 export default defineConfig({
   component: {
     experimentalSingleTabRunMode: true,
-    videoCompression: false, // turn off video compression for CI
     devServer: {
       framework: 'angular',
       bundler: 'webpack',

diff --git a/system-tests/project-fixtures/cra/cypress.config.ts b/system-tests/project-fixtures/cra/cypress.config.ts
@@ -3,7 +3,6 @@ import { defineConfig } from 'cypress'
 export default defineConfig({
   component: {
     experimentalSingleTabRunMode: true,
-    videoCompression: false, // turn off video compression for CI
     devServer: {
       framework: 'create-react-app',
       bundler: 'webpack',

diff --git a/system-tests/project-fixtures/nuxtjs2/cypress.config.ts b/system-tests/project-fixtures/nuxtjs2/cypress.config.ts
@@ -3,7 +3,6 @@ import { defineConfig } from 'cypress'
 export default defineConfig({
   component: {
     experimentalSingleTabRunMode: true,
-    videoCompression: false, // turn off video compression for CI
     devServer: {
       framework: 'nuxt',
       bundler: 'webpack',

diff --git a/system-tests/project-fixtures/react/cypress-vite.config.ts b/system-tests/project-fixtures/react/cypress-vite.config.ts
@@ -10,7 +10,6 @@ declare global {
 }
 
 export default defineConfig({
-  videoCompression: false, // turn off video compression for CI
   component: {
     devServer: {
       framework: 'react',

diff --git a/system-tests/project-fixtures/react/cypress-webpack-dev-server-async-config.config.ts b/system-tests/project-fixtures/react/cypress-webpack-dev-server-async-config.config.ts
@@ -3,7 +3,6 @@ import * as path from 'path'
 import * as fs from 'fs'
 
 export default defineConfig({
-  videoCompression: false, // turn off video compression for CI
   component: {
     devServer: {
       framework: 'react',

diff --git a/system-tests/project-fixtures/react/cypress-webpack.config.ts b/system-tests/project-fixtures/react/cypress-webpack.config.ts
@@ -13,7 +13,6 @@ declare global {
 }
 
 export default defineConfig({
-  videoCompression: false, // turn off video compression for CI
   component: {
     devServer: {
       framework: 'react',

diff --git a/system-tests/project-fixtures/vue-cli/cypress.config.ts b/system-tests/project-fixtures/vue-cli/cypress.config.ts
@@ -1,7 +1,6 @@
 import { defineConfig } from 'cypress'
 
 export default defineConfig({
-  videoCompression: false, // turn off video compression for CI
   component: {
     experimentalSingleTabRunMode: true,
     devServer: {

diff --git a/system-tests/project-fixtures/vue/cypress.config.js b/system-tests/project-fixtures/vue/cypress.config.js
@@ -1,7 +1,6 @@
 import { defineConfig } from 'cypress'
 
 export default defineConfig({
-  videoCompression: false, // turn off video compression for CI
   component: {
     experimentalSingleTabRunMode: true,
     devServer: {

diff --git a/system-tests/projects/angular-cli-configured/cypress.config.ts b/system-tests/projects/angular-cli-configured/cypress.config.ts
@@ -1,7 +1,6 @@
 import { defineConfig } from 'cypress'
 
 export default defineConfig({
-  videoCompression: false, // turn off video compression for CI
   component: {
     experimentalSingleTabRunMode: true,
     devServer: {

diff --git a/system-tests/projects/angular-custom-config/cypress.config.ts b/system-tests/projects/angular-custom-config/cypress.config.ts
@@ -2,7 +2,6 @@ import { defineConfig } from 'cypress'
 const { projects } = require('./angular.json')
 
 export default defineConfig({
-  videoCompression: false, // turn off video compression for CI
   component: {
     experimentalSingleTabRunMode: true,
     devServer: {

diff --git a/system-tests/projects/angular-custom-root/cypress.config.ts b/system-tests/projects/angular-custom-root/cypress.config.ts
@@ -1,7 +1,6 @@
 import { defineConfig } from 'cypress'
 
 export default defineConfig({
-  videoCompression: false, // turn off video compression for CI
   component: {
     experimentalSingleTabRunMode: true,
     devServer: {

diff --git a/system-tests/projects/config-cjs-and-esm/config-node-next/cypress.config.ts b/system-tests/projects/config-cjs-and-esm/config-node-next/cypress.config.ts
@@ -1,7 +1,6 @@
 import { defineConfig } from 'cypress'
 
 export default defineConfig({
-  videoCompression: false, // turn off video compression for CI
   e2e: {
     supportFile: false,
   },

diff --git a/system-tests/projects/config-cjs-and-esm/config-with-js-module/cypress.config.js b/system-tests/projects/config-cjs-and-esm/config-with-js-module/cypress.config.js
@@ -1,6 +1,5 @@
 import { defineConfig } from 'cypress'
 
 export default defineConfig({
-  videoCompression: false, // turn off video compression for CI
   e2e: { supportFile: false },
 })
diff --git a/system-tests/projects/config-cjs-and-esm/config-with-mjs-tsconfig-es5/cypress.config.mjs b/system-tests/projects/config-cjs-and-esm/config-with-mjs-tsconfig-es5/cypress.config.mjs
@@ -1,7 +1,6 @@
 import { defineConfig } from 'cypress'
 
 export default defineConfig({
-  videoCompression: false, // turn off video compression for CI
   e2e: {
     supportFile: false,
   },

diff --git a/system-tests/projects/config-cjs-and-esm/config-with-mjs/cypress.config.mjs b/system-tests/projects/config-cjs-and-esm/config-with-mjs/cypress.config.mjs
@@ -1,6 +1,5 @@
 import { defineConfig } from 'cypress'
 
 export default defineConfig({
-  videoCompression: false, // turn off video compression for CI
   e2e: { supportFile: false },
 })
diff --git a/system-tests/projects/config-cjs-and-esm/config-with-ts-module-and-esbuild/cypress.config.ts b/system-tests/projects/config-cjs-and-esm/config-with-ts-module-and-esbuild/cypress.config.ts
@@ -1,6 +1,5 @@
 import { defineConfig } from 'cypress'
 
 export default defineConfig({
-  videoCompression: false, // turn off video compression for CI
   e2e: { supportFile: false },
 })
diff --git a/system-tests/projects/config-cjs-and-esm/config-with-ts-module-component/cypress.config.ts b/system-tests/projects/config-cjs-and-esm/config-with-ts-module-component/cypress.config.ts
@@ -2,7 +2,6 @@ import { defineConfig } from 'cypress'
 import { devServer } from '@cypress/vite-dev-server'
 
 export default defineConfig({
-  videoCompression: false, // turn off video compression for CI
   component: {
     experimentalSingleTabRunMode: true,
     specPattern: 'src/**/*.ts',

diff --git a/system-tests/projects/config-cjs-and-esm/config-with-ts-module-component/vite.config.ts b/system-tests/projects/config-cjs-and-esm/config-with-ts-module-component/vite.config.ts
@@ -1,7 +1,6 @@
 import { defineConfig } from 'vite'
 
 export default defineConfig({
-  videoCompression: false, // turn off video compression for CI
   server: {
     fs: {
       // this is needed to run on CI since we

diff --git a/system-tests/projects/config-cjs-and-esm/config-with-ts-module/cypress.config.ts b/system-tests/projects/config-cjs-and-esm/config-with-ts-module/cypress.config.ts
@@ -1,7 +1,6 @@
 import { defineConfig } from 'cypress'
 
 export default defineConfig({
-  videoCompression: false, // turn off video compression for CI
   e2e: {
     supportFile: false,
     setupNodeEvents: async (_, config) => {

diff --git a/system-tests/projects/config-cjs-and-esm/config-with-ts-tsconfig-es5/cypress.config.ts b/system-tests/projects/config-cjs-and-esm/config-with-ts-tsconfig-es5/cypress.config.ts
@@ -1,7 +1,6 @@
 import { defineConfig } from 'cypress'
 
 export default defineConfig({
-  videoCompression: false, // turn off video compression for CI
   e2e: {
     supportFile: false,
   },

diff --git a/system-tests/projects/e2e/cypress-with-project-id-uploading-assets.config.js b/system-tests/projects/e2e/cypress-with-project-id-uploading-assets.config.js
@@ -1,7 +1,6 @@
 module.exports = {
   'projectId': 'pid123',
   'videoUploadOnPasses': true,
-  videoCompression: false,
   'e2e': {
     setupNodeEvents (on, config) {
       const plugin = require('./cypress/plugins')

diff --git a/system-tests/projects/issue-25951-next-app/cypress.config.ts b/system-tests/projects/issue-25951-next-app/cypress.config.ts
@@ -1,7 +1,6 @@
 import { defineConfig } from 'cypress'
 
 export default defineConfig({
-  videoCompression: false, // turn off video compression for CI
   component: {
     fixturesFolder: false,
     supportFile: false,

diff --git a/system-tests/projects/missing-vite-config/cypress.config.ts b/system-tests/projects/missing-vite-config/cypress.config.ts
@@ -1,7 +1,6 @@
 import { defineConfig } from 'cypress'
 
 export default defineConfig({
-  videoCompression: false, // turn off video compression for CI
   component: {
     experimentalSingleTabRunMode: true,
     supportFile: false,