fix: Treat Video compression 0 as false. (#26503)

* chore: disable video compression * system test updates * moar system test fixes * a couple of telemetry tweaks * more intelligent defaults, don't touch firefox. * trying this * probably finally fix firefox system tests * unformat plz * ugh, also add a test * plz stop formatting that file * re-enable firefox tests * Change log * don't save videos to artifacts * this will be fixed in another pr * quoth the raven, quotes matter don't mess them up
cypress-io · Apr 17, 2023 · 3d0a2b4 · 3d0a2b4 · cypress-bot · Apr 17, 2023
1 parent 2a8d078
commit 3d0a2b4
Show file tree

Hide file tree

Showing 124 changed files with 159 additions and 1,802 deletions.
diff --git a/.circleci/workflows.yml b/.circleci/workflows.yml
@@ -605,8 +605,6 @@ commands:
             fi
       - store_test_results:
           path: /tmp/cypress
-      - store_artifacts:
-          path: ./packages/<<parameters.package>>/cypress/videos
       - store-npm-logs
 
   run-system-tests:

diff --git a/cli/CHANGELOG.md b/cli/CHANGELOG.md
@@ -3,6 +3,10 @@
 
 _Released 04/25/2023 (PENDING)_
 
+**Bugfixes:**
+
+- Fixed an issue where setting `videoCompression` to `0` would cause the video output to be broken. `0` is now treated as false. Addresses [#5191](https://github.com/cypress-io/cypress/issues/5191) and [#24595](https://github.com/cypress-io/cypress/issues/24595).
+
 ## 12.10.0
 
 _Released 04/17/2023_

diff --git a/packages/driver/cypress.config.ts b/packages/driver/cypress.config.ts
@@ -18,6 +18,7 @@ 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
@@ -11,8 +11,8 @@ export default defineConfig({
   reporter: '../../node_modules/cypress-multi-reporters/index.js',
   reporterOptions: {
     configFile: '../../mocha-reporter-config.json',
-    videoCompression: false, // turn off video compression for CI
   },
+  videoCompression: false, // turn off video compression for CI
   component: {
     experimentalSingleTabRunMode: true,
     devServer: {

diff --git a/packages/launchpad/cypress.config.ts b/packages/launchpad/cypress.config.ts
@@ -13,8 +13,8 @@ export default defineConfig({
   reporter: '../../node_modules/cypress-multi-reporters/index.js',
   reporterOptions: {
     configFile: '../../mocha-reporter-config.json',
-    videoCompression: false, // turn off video compression for CI
   },
+  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,6 +14,8 @@ 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/lib/cypress.js b/packages/server/lib/cypress.js
@@ -32,7 +32,10 @@ const exit = async (code = 0) => {
     })
   }
 
-  telemetry.getSpan('cypress')?.end()
+  const span = telemetry.getSpan('cypress')
+
+  span?.setAttribute('exitCode', code)
+  span?.end()
 
   await telemetry.shutdown().catch((err) => {
     debug('telemetry shutdown errored with: ', err)

diff --git a/packages/server/lib/modes/run.ts b/packages/server/lib/modes/run.ts
@@ -312,7 +312,7 @@ async function startVideoRecording (options: { previous?: VideoRecording, projec
 
 const warnVideoRecordingFailed = (err) => {
   // log that post processing was attempted
-  // but failed and dont let this change the run exit code
+  // but failed and don't let this change the run exit code
   errors.warning('VIDEO_POST_PROCESSING_FAILED', err)
 }
 
@@ -321,9 +321,9 @@ async function postProcessRecording (options: { quiet: boolean, videoCompression
 
   // once this ended promises resolves
   // then begin processing the file
-  // dont process anything if videoCompress is off
+  // don't process anything if videoCompress is off
   // or we've been told not to upload the video
-  if (options.videoCompression === false || options.shouldUploadVideo === false) {
+  if (options.videoCompression === false || options.videoCompression === 0 || options.shouldUploadVideo === false) {
     return
   }
 
@@ -676,7 +676,7 @@ async function waitForTestsToFinishRunning (options: { project: Project, screens
 
       span?.setAttributes({
         videoName,
-        videoCompression,
+        videoCompressionString: videoCompression.toString(),
         compressedVideoName: videoRecording.api.compressedVideoName,
       })
 

diff --git a/system-tests/__snapshots__/async_timeouts_spec.js b/system-tests/__snapshots__/async_timeouts_spec.js
@@ -61,14 +61,6 @@ exports['e2e async timeouts / failing1'] = `
       cypress command (failed).png                                                                  
 
 
-  (Video)
-
-  -  Started processing:  Compressing to 32 CRF                                                     
-  -  Finished processing: X second(s)                                                
-
-  -  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
@@ -39,14 +39,6 @@ exports['e2e baseUrl / https / passes'] = `
   └────────────────────────────────────────────────────────────────────────────────────────────────┘
 
 
-  (Video)
-
-  -  Started processing:  Compressing to 32 CRF                                                     
-  -  Finished processing: X second(s)                                                
-
-  -  Video output: /XXX/XXX/XXX/cypress/videos/base_url.cy.js.mp4
-
-
 ====================================================================================================
 
   (Run Finished)
@@ -102,14 +94,6 @@ exports['e2e baseUrl / http / passes'] = `
   └────────────────────────────────────────────────────────────────────────────────────────────────┘
 
 
-  (Video)
-
-  -  Started processing:  Compressing to 32 CRF                                                     
-  -  Finished processing: X second(s)                                                
-
-  -  Video output: /XXX/XXX/XXX/cypress/videos/base_url.cy.js.mp4
-
-
 ====================================================================================================
 
   (Run Finished)

diff --git a/system-tests/__snapshots__/browser_crash_handling_spec.js b/system-tests/__snapshots__/browser_crash_handling_spec.js
@@ -54,14 +54,6 @@ https://on.cypress.io/renderer-process-crashed
   └────────────────────────────────────────────────────────────────────────────────────────────────┘
 
 
-  (Video)
-
-  -  Started processing:  Compressing to 32 CRF                                                     
-  -  Finished processing: X second(s)                                                
-
-  -  Video output: /XXX/XXX/XXX/cypress/videos/chrome_tab_crash.cy.js.mp4
-
-
 ────────────────────────────────────────────────────────────────────────────────────────────────────
                                                                                                     
   Running:  simple.cy.js                                                                    (2 of 2)
@@ -87,14 +79,6 @@ https://on.cypress.io/renderer-process-crashed
   └────────────────────────────────────────────────────────────────────────────────────────────────┘
 
 
-  (Video)
-
-  -  Started processing:  Compressing to 32 CRF                                                     
-  -  Finished processing: X second(s)                                                
-
-  -  Video output: /XXX/XXX/XXX/cypress/videos/simple.cy.js.mp4
-
-
 ====================================================================================================
 
   (Run Finished)
@@ -167,14 +151,6 @@ https://on.cypress.io/renderer-process-crashed
   └────────────────────────────────────────────────────────────────────────────────────────────────┘
 
 
-  (Video)
-
-  -  Started processing:  Compressing to 32 CRF                                                     
-  -  Finished processing: X second(s)                                                
-
-  -  Video output: /XXX/XXX/XXX/cypress/videos/chrome_tab_crash.cy.js.mp4
-
-
 ────────────────────────────────────────────────────────────────────────────────────────────────────
                                                                                                     
   Running:  simple.cy.js                                                                    (2 of 2)
@@ -200,14 +176,6 @@ https://on.cypress.io/renderer-process-crashed
   └────────────────────────────────────────────────────────────────────────────────────────────────┘
 
 
-  (Video)
-
-  -  Started processing:  Compressing to 32 CRF                                                     
-  -  Finished processing: X second(s)                                                
-
-  -  Video output: /XXX/XXX/XXX/cypress/videos/simple.cy.js.mp4
-
-
 ====================================================================================================
 
   (Run Finished)
@@ -271,14 +239,6 @@ This can happen for many different reasons:
   └────────────────────────────────────────────────────────────────────────────────────────────────┘
 
 
-  (Video)
-
-  -  Started processing:  Compressing to 32 CRF                                                     
-  -  Finished processing: X second(s)                                                
-
-  -  Video output: /XXX/XXX/XXX/cypress/videos/chrome_process_crash.cy.js.mp4
-
-
 ────────────────────────────────────────────────────────────────────────────────────────────────────
                                                                                                     
   Running:  simple.cy.js                                                                    (2 of 2)
@@ -304,14 +264,6 @@ This can happen for many different reasons:
   └────────────────────────────────────────────────────────────────────────────────────────────────┘
 
 
-  (Video)
-
-  -  Started processing:  Compressing to 32 CRF                                                     
-  -  Finished processing: X second(s)                                                
-
-  -  Video output: /XXX/XXX/XXX/cypress/videos/simple.cy.js.mp4
-
-
 ====================================================================================================
 
   (Run Finished)

diff --git a/system-tests/__snapshots__/busted_support_file_spec.js b/system-tests/__snapshots__/busted_support_file_spec.js
@@ -62,14 +62,6 @@ Fix the error in your code and re-run your tests.
   └────────────────────────────────────────────────────────────────────────────────────────────────┘
 
 
-  (Video)
-
-  -  Started processing:  Compressing to 32 CRF                                                     
-  -  Finished processing: X second(s)                                                
-
-  -  Video output: /XXX/XXX/XXX/cypress/videos/app.cy.js.mp4
-
-
 ====================================================================================================
 
   (Run Finished)

diff --git a/system-tests/__snapshots__/cache_spec.js b/system-tests/__snapshots__/cache_spec.js
@@ -42,14 +42,6 @@ exports['e2e cache passes 1'] = `
   └────────────────────────────────────────────────────────────────────────────────────────────────┘
 
 
-  (Video)
-
-  -  Started processing:  Compressing to 32 CRF                                                     
-  -  Finished processing: X second(s)                                                
-
-  -  Video output: /XXX/XXX/XXX/cypress/videos/cache.cy.js.mp4
-
-
 ====================================================================================================
 
   (Run Finished)

diff --git a/system-tests/__snapshots__/caught_uncaught_hook_errors_spec.js b/system-tests/__snapshots__/caught_uncaught_hook_errors_spec.js
@@ -88,14 +88,6 @@ Because this error occurred during a \`before all\` hook we are skipping the rem
      before all hook (failed).png                                                                   
 
 
-  (Video)
-
-  -  Started processing:  Compressing to 32 CRF                                                     
-  -  Finished processing: X second(s)                                                
-
-  -  Video output: /XXX/XXX/XXX/cypress/videos/hook_caught_error_failing.cy.js.mp4
-
-
 ====================================================================================================
 
   (Run Finished)
@@ -181,14 +173,6 @@ Because this error occurred during a \`before each\` hook we are skipping the re
       before each hook (failed).png                                                                 
 
 
-  (Video)
-
-  -  Started processing:  Compressing to 32 CRF                                                     
-  -  Finished processing: X second(s)                                                
-
-  -  Video output: /XXX/XXX/XXX/cypress/videos/hook_uncaught_error_failing.cy.js.mp4
-
-
 ====================================================================================================
 
   (Run Finished)
@@ -265,14 +249,6 @@ Because this error occurred during a \`before each\` hook we are skipping all of
      efore each hook (failed).png                                                                   
 
 
-  (Video)
-
-  -  Started processing:  Compressing to 32 CRF                                                     
-  -  Finished processing: X second(s)                                                
-
-  -  Video output: /XXX/XXX/XXX/cypress/videos/hook_uncaught_root_error_failing.cy.js.mp4
-
-
 ====================================================================================================
 
   (Run Finished)
@@ -359,14 +335,6 @@ Because this error occurred during a \`before each\` hook we are skipping the re
      before each hook (failed).png                                                                  
 
 
-  (Video)
-
-  -  Started processing:  Compressing to 32 CRF                                                     
-  -  Finished processing: X second(s)                                                
-
-  -  Video output: /XXX/XXX/XXX/cypress/videos/hook_uncaught_error_events_failing.cy.js.mp4
-
-
 ====================================================================================================
 
   (Run Finished)

diff --git a/system-tests/__snapshots__/commands_outside_of_test_spec.js b/system-tests/__snapshots__/commands_outside_of_test_spec.js
@@ -35,14 +35,6 @@ exports['e2e commands outside of test / passes on passing assertions'] = `
   └────────────────────────────────────────────────────────────────────────────────────────────────┘
 
 
-  (Video)
-
-  -  Started processing:  Compressing to 32 CRF                                                     
-  -  Finished processing: X second(s)                                                
-
-  -  Video output: /XXX/XXX/XXX/cypress/videos/assertions_passing_outside_of_test.cy.js.mp4
-
-
 ====================================================================================================
 
   (Run Finished)
@@ -118,14 +110,6 @@ We dynamically generated a new test to display this failure.
      aught error was detected outside of a test (failed).png                                        
 
 
-  (Video)
-
-  -  Started processing:  Compressing to 32 CRF                                                     
-  -  Finished processing: X second(s)                                                
-
-  -  Video output: /XXX/XXX/XXX/cypress/videos/assertions_failing_outside_of_test.cy.js.mp4
-
-
 ====================================================================================================
 
   (Run Finished)
@@ -209,14 +193,6 @@ https://on.cypress.io/cannot-execute-commands-outside-test
      r was detected outside of a test (failed).png                                                  
 
 
-  (Video)
-
-  -  Started processing:  Compressing to 32 CRF                                                     
-  -  Finished processing: X second(s)                                                
-
-  -  Video output: /XXX/XXX/XXX/cypress/videos/commands_outside_of_test.cy.js.mp4
-
-
 ====================================================================================================
 
   (Run Finished)