breaking: remove the shouldUploadVideoOnPass configuration

cli/CHANGELOG.md

@@ -8,6 +8,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 [`videoUploadOnPasses`](https://docs.cypress.io/guides/references/configuration#Videos) configuration option has been removed. Please see our [screenshots & videos guide](https://docs.cypress.io/guides/guides/screenshots-and-videos#Delete-videos-for-specs-without-failing-or-retried-tests) on how to accomplish similar functionality. Addresses [#26899](https://github.com/cypress-io/cypress/issues/26899).
 
 - The deprecated configuration option, `nodeVersion` has been removed. Addresses [#27016](https://github.com/cypress-io/cypress/issues/27016).
 

cli/types/cypress-npm-api.d.ts

@@ -266,7 +266,6 @@ declare namespace CypressCommandLine {
       absolute: string
       relativeToCommonRoot: string
     }
-    shouldUploadVideo: boolean
     skippedSpec: boolean
   }
 

cli/types/cypress.d.ts

@@ -3011,11 +3011,6 @@ declare namespace Cypress {
      * @default false
      */
     video: boolean
-    /**
-     * Whether Cypress will upload the video to Cypress Cloud even if all tests are passing. This applies only when recording your runs to Cypress Cloud. Turn this off if you'd like the video uploaded only when there are failing tests.
-     * @default true
-     */
-    videoUploadOnPasses: boolean
     /**
      * Whether Chrome Web Security for same-origin policy and insecure mixed content is enabled. Read more about this here
      * @default true

packages/app/cypress/fixtures/debug-Failing/gql-CloudViewerAndProject_RequiredData.json

@@ -308,11 +308,6 @@
           "from": "default",
           "field": "videosFolder"
         },
-        {
-          "value": true,
-          "from": "default",
-          "field": "videoUploadOnPasses"
-        },
         {
           "value": 500,
           "from": "default",

packages/app/cypress/fixtures/debug-Failing/gql-HeaderBar_HeaderBarQuery.json

@@ -284,11 +284,6 @@
           "from": "default",
           "field": "videosFolder"
         },
-        {
-          "value": true,
-          "from": "default",
-          "field": "videoUploadOnPasses"
-        },
         {
           "value": 500,
           "from": "default",

packages/app/cypress/fixtures/debug-Failing/gql-SpecsPageContainer.json

@@ -669,11 +669,6 @@
           "from": "default",
           "field": "videosFolder"
         },
-        {
-          "value": true,
-          "from": "default",
-          "field": "videoUploadOnPasses"
-        },
         {
           "value": 500,
           "from": "default",

packages/app/cypress/fixtures/debug-Passing/gql-CloudViewerAndProject_RequiredData.json

@@ -308,11 +308,6 @@
           "from": "default",
           "field": "videosFolder"
         },
-        {
-          "value": true,
-          "from": "default",
-          "field": "videoUploadOnPasses"
-        },
         {
           "value": 500,
           "from": "default",

packages/app/cypress/fixtures/debug-Passing/gql-HeaderBar_HeaderBarQuery.json

@@ -284,11 +284,6 @@
           "from": "default",
           "field": "videosFolder"
         },
-        {
-          "value": true,
-          "from": "default",
-          "field": "videoUploadOnPasses"
-        },
         {
           "value": 500,
           "from": "default",

packages/app/cypress/fixtures/debug-Passing/gql-SpecsPageContainer.json

@@ -1670,11 +1670,6 @@
           "from": "default",
           "field": "videosFolder"
         },
-        {
-          "value": true,
-          "from": "default",
-          "field": "videoUploadOnPasses"
-        },
         {
           "value": 500,
           "from": "default",

packages/config/__snapshots__/index.spec.ts.js

@@ -77,7 +77,6 @@ exports['config/src/index .getDefaultValues returns list of public config keys 1
   'video': false,
   'videoCompression': false,
   'videosFolder': 'cypress/videos',
-  'videoUploadOnPasses': true,
   'viewportHeight': 660,
   'viewportWidth': 1000,
   'waitForAnimations': true,
@@ -165,7 +164,6 @@ exports['config/src/index .getDefaultValues returns list of public config keys f
   'video': false,
   'videoCompression': false,
   'videosFolder': 'cypress/videos',
-  'videoUploadOnPasses': true,
   'viewportHeight': 660,
   'viewportWidth': 1000,
   'waitForAnimations': true,
@@ -247,7 +245,6 @@ exports['config/src/index .getPublicConfigKeys returns list of public config key
   'video',
   'videoCompression',
   'videosFolder',
-  'videoUploadOnPasses',
   'viewportHeight',
   'viewportWidth',
   'waitForAnimations',

packages/config/src/options.ts

@@ -429,10 +429,6 @@ const driverConfigOptions: Array<DriverConfigOption> = [
     defaultValue: 'cypress/videos',
     validation: validate.isString,
     isFolder: true,
-  }, {
-    name: 'videoUploadOnPasses',
-    defaultValue: true,
-    validation: validate.isBoolean,
   }, {
     name: 'viewportHeight',
     defaultValue: (options: Record<string, any> = {}) => options.testingType === 'component' ? 500 : 660,

packages/config/test/project/utils.spec.ts

@@ -770,10 +770,6 @@ describe('config/src/project/utils', () => {
       return this.defaults('videoCompression', false)
     })
 
-    it('videoUploadOnPasses=true', function () {
-      return this.defaults('videoUploadOnPasses', true)
-    })
-
     it('trashAssetsBeforeRuns=32', function () {
       return this.defaults('trashAssetsBeforeRuns', true)
     })
@@ -1079,7 +1075,6 @@ describe('config/src/project/utils', () => {
             video: { value: false, from: 'default' },
             videoCompression: { value: false, from: 'default' },
             videosFolder: { value: 'cypress/videos', from: 'default' },
-            videoUploadOnPasses: { value: true, from: 'default' },
             viewportHeight: { value: 660, from: 'default' },
             viewportWidth: { value: 1000, from: 'default' },
             waitForAnimations: { value: true, from: 'default' },
@@ -1197,7 +1192,6 @@ describe('config/src/project/utils', () => {
             video: { value: false, from: 'default' },
             videoCompression: { value: false, from: 'default' },
             videosFolder: { value: 'cypress/videos', from: 'default' },
-            videoUploadOnPasses: { value: true, from: 'default' },
             viewportHeight: { value: 660, from: 'default' },
             viewportWidth: { value: 1000, from: 'default' },
             waitForAnimations: { value: true, from: 'default' },

packages/frontend-shared/cypress/fixtures/config.json

@@ -242,11 +242,6 @@
     "from": "default",
     "field": "videosFolder"
   },
-  {
-    "value": true,
-    "from": "default",
-    "field": "videoUploadOnPasses"
-  },
   {
     "value": 850,
     "from": "config",

packages/server/lib/modes/record.js

@@ -109,7 +109,7 @@ const getSpecRelativePath = (spec) => {
 }
 
 const uploadArtifacts = (options = {}) => {
-  const { protocolManager, video, screenshots, videoUploadUrl, captureUploadUrl, shouldUploadVideo, screenshotUploadUrls, quiet } = options
+  const { protocolManager, video, screenshots, videoUploadUrl, captureUploadUrl, screenshotUploadUrls, quiet } = options
 
   const uploads = []
   const uploadReport = {
@@ -196,7 +196,7 @@ const uploadArtifacts = (options = {}) => {
     )
   }
 
-  if (videoUploadUrl && shouldUploadVideo) {
+  if (videoUploadUrl) {
     send(video, videoUploadUrl, 'video')
   }
 
@@ -796,7 +796,7 @@ const createRunAndRecordSpecs = (options = {}) => {
             return
           }
 
-          const { video, shouldUploadVideo, screenshots } = results
+          const { video, screenshots } = results
           const { videoUploadUrl, captureUploadUrl, screenshotUploadUrls } = resp
 
           return uploadArtifacts({
@@ -807,7 +807,6 @@ const createRunAndRecordSpecs = (options = {}) => {
             videoUploadUrl,
             captureUploadUrl,
             protocolManager,
-            shouldUploadVideo,
             screenshotUploadUrls,
             quiet,
           })

packages/server/lib/modes/run.ts

@@ -332,14 +332,14 @@ const warnVideoCompressionFailed = (err) => {
   errors.warning('VIDEO_COMPRESSION_FAILED', err)
 }
 
-async function compressRecording (options: { quiet: boolean, videoCompression: number | boolean, shouldUploadVideo: boolean, processOptions: Omit<ProcessOptions, 'videoCompression'> }) {
+async function compressRecording (options: { quiet: boolean, videoCompression: number | boolean, processOptions: Omit<ProcessOptions, 'videoCompression'> }) {
   debug('ending the video recording %o', options)
 
   // once this ended promises resolves
   // then begin compressing the file
   // don't compress anything if videoCompress is off
   // or we've been told not to upload the video
-  if (options.videoCompression === false || options.videoCompression === 0 || options.shouldUploadVideo === false) {
+  if (options.videoCompression === false || options.videoCompression === 0) {
     debug('skipping compression')
 
     return
@@ -574,10 +574,10 @@ function waitForSocketConnection (project: Project, id: string) {
   })
 }
 
-async function waitForTestsToFinishRunning (options: { project: Project, screenshots: ScreenshotMetadata[], videoCompression: number | boolean, videoUploadOnPasses: boolean, exit: boolean, spec: SpecWithRelativeRoot, estimated: number, quiet: boolean, config: Cfg, shouldKeepTabOpen: boolean, testingType: TestingType, videoRecording?: VideoRecording }) {
+async function waitForTestsToFinishRunning (options: { project: Project, screenshots: ScreenshotMetadata[], videoCompression: number | boolean, exit: boolean, spec: SpecWithRelativeRoot, estimated: number, quiet: boolean, config: Cfg, shouldKeepTabOpen: boolean, testingType: TestingType, videoRecording?: VideoRecording }) {
   if (globalThis.CY_TEST_MOCK?.waitForTestsToFinishRunning) return Promise.resolve(globalThis.CY_TEST_MOCK.waitForTestsToFinishRunning)
 
-  const { project, screenshots, videoRecording, videoCompression, videoUploadOnPasses, exit, spec, estimated, quiet, config, shouldKeepTabOpen, testingType } = options
+  const { project, screenshots, videoRecording, videoCompression, exit, spec, estimated, quiet, config, shouldKeepTabOpen, testingType } = options
 
   const results = await listenForProjectEnd(project, exit)
 
@@ -617,7 +617,7 @@ async function waitForTestsToFinishRunning (options: { project: Project, screens
 
   results.spec = spec
 
-  const { tests, stats } = results
+  const { tests } = results
   const attempts = _.flatMap(tests, (test) => test.attempts)
 
   let videoCaptureFailed = false
@@ -659,18 +659,6 @@ async function waitForTestsToFinishRunning (options: { project: Project, screens
     results.video = null
   }
 
-  const hasFailingTests = _.get(stats, 'failures') > 0
-  // we should upload the video if we upload on passes (by default)
-  // or if we have any failures and have started the video
-  const shouldUploadVideo = !skippedSpec && videoUploadOnPasses === true || Boolean((/* startedVideoCapture */ videoExists && hasFailingTests))
-
-  results.shouldUploadVideo = shouldUploadVideo
-
-  if (!shouldUploadVideo) {
-    debug(`Spec run had no failures and config.videoUploadOnPasses=false. Skip compressing video. Video path: ${videoName}`)
-    results.videoCompression = false
-  }
-
   if (!quiet && !skippedSpec) {
     printResults.displayResults(results, estimated)
   }
@@ -711,7 +699,6 @@ async function waitForTestsToFinishRunning (options: { project: Project, screens
       })
 
       await compressRecording({
-        shouldUploadVideo,
         quiet,
         videoCompression,
         processOptions: {
@@ -734,8 +721,7 @@ async function waitForTestsToFinishRunning (options: { project: Project, screens
     printResults.printVideoPath(videoName)
   }
 
-  // if capture or compressing has failed, or the test passed and videoUploadOnPasses=false
-  if (videoCaptureFailed || videoCompressionFailed || !shouldUploadVideo) {
+  if (videoCaptureFailed || videoCompressionFailed) {
     results.video = null
   }
 
@@ -756,7 +742,7 @@ function screenshotMetadata (data, resp) {
   }
 }
 
-async function runSpecs (options: { config: Cfg, browser: Browser, sys: any, headed: boolean, outputPath: string, specs: SpecWithRelativeRoot[], specPattern: string | RegExp | string[], beforeSpecRun?: BeforeSpecRun, afterSpecRun?: AfterSpecRun, runUrl?: string, parallel?: boolean, group?: string, tag?: string, autoCancelAfterFailures?: number | false, testingType: TestingType, quiet: boolean, project: Project, onError: (err: Error) => void, exit: boolean, socketId: string, webSecurity: boolean, projectRoot: string, protocolManager?: ProtocolManager } & Pick<Cfg, 'video' | 'videoCompression' | 'videosFolder' | 'videoUploadOnPasses'>) {
+async function runSpecs (options: { config: Cfg, browser: Browser, sys: any, headed: boolean, outputPath: string, specs: SpecWithRelativeRoot[], specPattern: string | RegExp | string[], beforeSpecRun?: BeforeSpecRun, afterSpecRun?: AfterSpecRun, runUrl?: string, parallel?: boolean, group?: string, tag?: string, autoCancelAfterFailures?: number | false, testingType: TestingType, quiet: boolean, project: Project, onError: (err: Error) => void, exit: boolean, socketId: string, webSecurity: boolean, projectRoot: string, protocolManager?: ProtocolManager } & Pick<Cfg, 'video' | 'videoCompression' | 'videosFolder'>) {
   if (globalThis.CY_TEST_MOCK?.runSpecs) return globalThis.CY_TEST_MOCK.runSpecs
 
   const { config, browser, sys, headed, outputPath, specs, specPattern, beforeSpecRun, afterSpecRun, runUrl, parallel, group, tag, autoCancelAfterFailures, protocolManager } = options
@@ -923,7 +909,7 @@ async function runSpecs (options: { config: Cfg, browser: Browser, sys: any, hea
   return results
 }
 
-async function runSpec (config, spec: SpecWithRelativeRoot, options: { project: Project, browser: Browser, onError: (err: Error) => void, config: Cfg, quiet: boolean, exit: boolean, testingType: TestingType, socketId: string, webSecurity: boolean, projectRoot: string, protocolManager?: ProtocolManager } & Pick<Cfg, 'video' | 'videosFolder' | 'videoCompression' | 'videoUploadOnPasses'>, estimated, isFirstSpec, isLastSpec) {
+async function runSpec (config, spec: SpecWithRelativeRoot, options: { project: Project, browser: Browser, onError: (err: Error) => void, config: Cfg, quiet: boolean, exit: boolean, testingType: TestingType, socketId: string, webSecurity: boolean, projectRoot: string, protocolManager?: ProtocolManager } & Pick<Cfg, 'video' | 'videosFolder' | 'videoCompression'>, estimated, isFirstSpec, isLastSpec) {
   const { project, browser, onError } = options
 
   const { isHeadless } = browser
@@ -974,7 +960,6 @@ async function runSpec (config, spec: SpecWithRelativeRoot, options: { project:
       exit: options.exit,
       testingType: options.testingType,
       videoCompression: options.videoCompression,
-      videoUploadOnPasses: options.videoUploadOnPasses,
       quiet: options.quiet,
       shouldKeepTabOpen: !isLastSpec,
     }),
@@ -1112,7 +1097,6 @@ async function ready (options: { projectRoot: string, record: boolean, key: stri
       videosFolder: config.videosFolder,
       video: config.video,
       videoCompression: config.videoCompression,
-      videoUploadOnPasses: config.videoUploadOnPasses,
       headed: options.headed,
       quiet: options.quiet,
       outputPath: options.outputPath,

packages/server/test/integration/cypress_spec.js

@@ -1241,7 +1241,6 @@ describe('lib/cypress', () => {
           tests: [],
           hooks: [],
           video: 'path/to/video',
-          shouldUploadVideo: true,
           screenshots: [],
           config: {},
           spec: {},

packages/server/test/unit/config_spec.js

@@ -655,20 +655,6 @@ describe('lib/config', () => {
         })
       })
 
-      context('videoUploadOnPasses', () => {
-        it('passes if a boolean', function () {
-          this.setup({ videoUploadOnPasses: false })
-
-          return this.expectValidationPasses()
-        })
-
-        it('fails if not a boolean', function () {
-          this.setup({ videoUploadOnPasses: 99 })
-
-          return this.expectValidationFails('be a boolean')
-        })
-      })
-
       context('videosFolder', () => {
         it('passes if a string', function () {
           this.setup({ videosFolder: '_videos' })

packages/types/src/config.ts

@@ -30,7 +30,7 @@ export interface FullConfig extends Partial<Cypress.RuntimeConfigOptions & Cypre
 // and are required when creating a project.
 export type ReceivedCypressOptions =
   Pick<Cypress.RuntimeConfigOptions, 'hosts' | 'projectName' | 'clientRoute' | 'devServerPublicPathRoute' | 'namespace' | 'report' | 'socketIoCookie' | 'configFile' | 'isTextTerminal' | 'isNewProject' | 'proxyUrl' | 'browsers' | 'browserUrl' | 'socketIoRoute' | 'arch' | 'platform' | 'spec' | 'specs' | 'browser' | 'version' | 'remote'>
-  & Pick<Cypress.ResolvedConfigOptions, 'chromeWebSecurity' | 'supportFolder' | 'experimentalSourceRewriting' | 'fixturesFolder' | 'reporter' | 'reporterOptions' | 'screenshotsFolder' | 'supportFile' | 'baseUrl' | 'viewportHeight' | 'viewportWidth' | 'port' | 'experimentalInteractiveRunEvents' | 'userAgent' | 'downloadsFolder' | 'env' | 'excludeSpecPattern' | 'specPattern' | 'experimentalModifyObstructiveThirdPartyCode' | 'experimentalSkipDomainInjection' | 'video' | 'videoCompression' | 'videosFolder' | 'videoUploadOnPasses' | 'resolvedNodeVersion' | 'resolvedNodePath' | 'trashAssetsBeforeRuns' | 'experimentalWebKitSupport'> // TODO: Figure out how to type this better.
+  & Pick<Cypress.ResolvedConfigOptions, 'chromeWebSecurity' | 'supportFolder' | 'experimentalSourceRewriting' | 'fixturesFolder' | 'reporter' | 'reporterOptions' | 'screenshotsFolder' | 'supportFile' | 'baseUrl' | 'viewportHeight' | 'viewportWidth' | 'port' | 'experimentalInteractiveRunEvents' | 'userAgent' | 'downloadsFolder' | 'env' | 'excludeSpecPattern' | 'specPattern' | 'experimentalModifyObstructiveThirdPartyCode' | 'experimentalSkipDomainInjection' | 'video' | 'videoCompression' | 'videosFolder' | 'resolvedNodeVersion' | 'resolvedNodePath' | 'trashAssetsBeforeRuns' | 'experimentalWebKitSupport'> // TODO: Figure out how to type this better.
 
 export interface SettingsOptions {
   testingType?: 'component' |'e2e'