BREAKING CHANGE: set video to false by default (system tests need upd…

…ating).
cypress-io · Jun 13, 2023 · ead8ed1 · ead8ed1
1 parent ea9c185
commit ead8ed1
Show file tree

Hide file tree

Showing 120 changed files with 262 additions and 1,548 deletions.
diff --git a/.circleci/workflows.yml b/.circleci/workflows.yml
@@ -2069,7 +2069,6 @@ jobs:
             CYPRESS_PROJECT_ID=$TEST_KITCHENSINK_PROJECT_ID \
             CYPRESS_RECORD_KEY=$TEST_KITCHENSINK_RECORD_KEY \
             CYPRESS_INTERNAL_ENV=staging \
-            CYPRESS_video=false \
             yarn cypress:run --project /tmp/cypress-example-kitchensink --record
       - store-npm-logs
 

diff --git a/cli/CHANGELOG.md b/cli/CHANGELOG.md
@@ -1,11 +1,12 @@
 <!-- See the ../guides/writing-the-cypress-changelog.md for details on writing the changelog. -->
 ## 13.0.0
 
-_Released 03/1/2023 (PENDING)_
+_Released 8/1/2023 (PENDING)_
 
 **Breaking Changes:**
 
 - 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 will now default to `false`. Addresses [#26157](https://github.com/cypress-io/cypress/issues/26157).
 
 ## 12.14.1
 

diff --git a/cli/types/cypress.d.ts b/cli/types/cypress.d.ts
@@ -3013,7 +3013,7 @@ declare namespace Cypress {
     videoCompression: number | boolean
     /**
      * Whether Cypress will record a video of the test run when running headlessly.
-     * @default true
+     * @default false
      */
     video: boolean
     /**

diff --git a/npm/grep/cypress.config.js b/npm/grep/cypress.config.js
@@ -11,5 +11,4 @@ module.exports = defineConfig({
     specPattern: '**/spec.js',
   },
   fixturesFolder: false,
-  video: false,
 })
diff --git a/npm/react/cypress.config.js b/npm/react/cypress.config.js
@@ -1,7 +1,6 @@
 module.exports = {
   'viewportWidth': 400,
   'viewportHeight': 400,
-  'video': false,
   'projectId': 'z9dxah',
   'env': {
     'reactDevtools': true,

diff --git a/npm/vue/cypress.config.ts b/npm/vue/cypress.config.ts
@@ -3,7 +3,6 @@ import { defineConfig } from 'cypress'
 export default defineConfig({
   'viewportWidth': 500,
   'viewportHeight': 500,
-  'video': false,
   'responseTimeout': 2500,
   'projectId': '134ej7',
   'experimentalFetchPolyfill': true,

diff --git a/npm/webpack-preprocessor/test/e2e/helpers.js b/npm/webpack-preprocessor/test/e2e/helpers.js
@@ -91,9 +91,6 @@ exports.runTest = async (options = {}) => {
     spec: opts.spec,
     browser: opts.browser,
     exit: opts.exit,
-    config: {
-      video: false,
-    },
     dev: true,
   })
   .finally(() => {

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

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

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

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

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

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

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

diff --git a/packages/config/src/options.ts b/packages/config/src/options.ts
@@ -423,7 +423,7 @@ const driverConfigOptions: Array<DriverConfigOption> = [
     requireRestartOnChange: 'browser',
   }, {
     name: 'video',
-    defaultValue: true,
+    defaultValue: false,
     validation: validate.isBoolean,
   }, {
     name: 'videoCompression',

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

diff --git a/packages/data-context/src/sources/migration/legacyOptions.ts b/packages/data-context/src/sources/migration/legacyOptions.ts
@@ -241,7 +241,7 @@ const resolvedOptions: Array<ResolvedConfigOption> = [
     canUpdateDuringTestTime: false,
   }, {
     name: 'video',
-    defaultValue: true,
+    defaultValue: false,
     canUpdateDuringTestTime: false,
   }, {
     name: 'videoCompression',

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

diff --git a/packages/server/lib/modes/run.ts b/packages/server/lib/modes/run.ts
@@ -657,7 +657,7 @@ async function waitForTestsToFinishRunning (options: { project: Project, screens
 
   if (!shouldUploadVideo) {
     debug(`Spec run had no failures and config.videoUploadOnPasses=false. Skip compressing video. Video path: ${videoName}`)
-    results.video = null
+    results.videoCompression = false
   }
 
   if (!quiet && !skippedSpec) {
@@ -723,7 +723,8 @@ async function waitForTestsToFinishRunning (options: { project: Project, screens
     printResults.printVideoPath(videoName)
   }
 
-  if (videoCaptureFailed || videoCompressionFailed) {
+  // if capture or compressing has failed, or the test passed and videoUploadOnPasses=false
+  if (videoCaptureFailed || videoCompressionFailed || !shouldUploadVideo) {
     results.video = null
   }
 

diff --git a/packages/server/test/integration/cypress_spec.js b/packages/server/test/integration/cypress_spec.js
@@ -1042,7 +1042,7 @@ describe('lib/cypress', () => {
 
             expect(chromeBrowser._navigateUsingCRI).to.have.been.calledOnce
             expect(chromeBrowser._setAutomation).to.have.been.calledOnce
-            expect(chromeBrowser._recordVideo).to.have.been.calledOnce
+            expect(chromeBrowser._recordVideo).not.to.have.been.called
 
             expect(BrowserCriClient.create).to.have.been.calledOnce
             expect(browserCriClient.attachToTargetUrl).to.have.been.calledOnce

diff --git a/system-tests/__snapshots__/async_timeouts_spec.js b/system-tests/__snapshots__/async_timeouts_spec.js
@@ -47,7 +47,7 @@ exports['e2e async timeouts / failing1'] = `
   │ Pending:      0                                                                                │
   │ Skipped:      0                                                                                │
   │ Screenshots:  2                                                                                │
-  │ Video:        true                                                                             │
+  │ Video:        false                                                                            │
   │ Duration:     X seconds                                                                        │
   │ Spec Ran:     async_timeouts.cy.js                                                             │
   └────────────────────────────────────────────────────────────────────────────────────────────────┘
@@ -61,11 +61,6 @@ exports['e2e async timeouts / failing1'] = `
       cypress command (failed).png                                                                  
 
 
-  (Video)
-
-  -  Video output: /XXX/XXX/XXX/cypress/videos/async_timeouts.cy.js.mp4
-
-
 ====================================================================================================
 
   (Run Finished)

diff --git a/system-tests/__snapshots__/base_url_spec.js b/system-tests/__snapshots__/base_url_spec.js
@@ -33,17 +33,12 @@ exports['e2e baseUrl / https / passes'] = `
   │ Pending:      0                                                                                │
   │ Skipped:      0                                                                                │
   │ Screenshots:  0                                                                                │
-  │ Video:        true                                                                             │
+  │ Video:        false                                                                            │
   │ Duration:     X seconds                                                                        │
   │ Spec Ran:     base_url.cy.js                                                                   │
   └────────────────────────────────────────────────────────────────────────────────────────────────┘
 
 
-  (Video)
-
-  -  Video output: /XXX/XXX/XXX/cypress/videos/base_url.cy.js.mp4
-
-
 ====================================================================================================
 
   (Run Finished)
@@ -93,17 +88,12 @@ exports['e2e baseUrl / http / passes'] = `
   │ Pending:      0                                                                                │
   │ Skipped:      0                                                                                │
   │ Screenshots:  0                                                                                │
-  │ Video:        true                                                                             │
+  │ Video:        false                                                                            │
   │ Duration:     X seconds                                                                        │
   │ Spec Ran:     base_url.cy.js                                                                   │
   └────────────────────────────────────────────────────────────────────────────────────────────────┘
 
 
-  (Video)
-
-  -  Video output: /XXX/XXX/XXX/cypress/videos/base_url.cy.js.mp4
-
-
 ====================================================================================================
 
   (Run Finished)