cypress-io · mabela416 · Sep 8, 2023 · Sep 11, 2023 · Sep 11, 2023 · Sep 12, 2023
diff --git a/packages/errors/__snapshot-html__/CLOUD_BURN_IN_MISMATCH.html b/packages/errors/__snapshot-html__/CLOUD_BURN_IN_MISMATCH.html
diff --git a/packages/errors/src/errors.ts b/packages/errors/src/errors.ts
@@ -383,6 +383,13 @@ export const AllCypressErrors = {
 
         https://on.cypress.io/auto-cancellation-mismatch`
   },
+  CLOUD_BURN_IN_MISMATCH: (arg1: {runUrl: string, burnInConfig: string, configFileBaseName: string}) => {
+    return errTemplate`\
+        You passed in a ${fmt.highlightSecondary(`experimentalBurnIn`)} configuration, but this run originally started with a different configuration for ${fmt.highlightSecondary(`experimentalBurnIn`)}.
+        This ${fmt.highlightSecondary(`experimentalBurnIn`)} config came from your ${fmt.path(arg1.configFileBaseName)} file or an environment variable.
+        The existing run is: ${fmt.url(arg1.runUrl)}
+        The experimentalBurnIn configuration you tried to pass was: ${fmt.stringify(arg1.burnInConfig)}`
+  },
   DEPRECATED_BEFORE_BROWSER_LAUNCH_ARGS: () => {
     return errTemplate`\
       Deprecation Warning: The ${fmt.highlight(`before:browser:launch`)} plugin event changed its signature in ${fmt.cypressVersion(`4.0.0`)}

diff --git a/packages/errors/test/unit/visualSnapshotErrors_spec.ts b/packages/errors/test/unit/visualSnapshotErrors_spec.ts
@@ -563,6 +563,18 @@ describe('visual error templates', () => {
         }],
       }
     },
+    CLOUD_BURN_IN_MISMATCH: () => {
+      return {
+        default: [{
+          runUrl: 'https://cloud.cypress.io/project/abcd/runs/1',
+          burnInConfig: `{
+            default: 1,
+            flaky:2
+          }`,
+          configFileBaseName: 'cypress.config.json',
+        }],
+      }
+    },
     DEPRECATED_BEFORE_BROWSER_LAUNCH_ARGS: () => {
       return {
         default: [],

diff --git a/packages/graphql/schemas/schema.graphql b/packages/graphql/schemas/schema.graphql
@@ -1136,6 +1136,7 @@ enum ErrorTypeEnum {
   CLOUD_API_RESPONSE_FAILED_RETRYING
   CLOUD_AUTO_CANCEL_MISMATCH
   CLOUD_AUTO_CANCEL_NOT_AVAILABLE_IN_PLAN
+  CLOUD_BURN_IN_MISMATCH
   CLOUD_CANCEL_SKIPPED_SPEC
   CLOUD_CANNOT_CREATE_RUN_OR_INSTANCE
   CLOUD_CANNOT_PROCEED_IN_PARALLEL

diff --git a/packages/server/lib/cloud/api.ts b/packages/server/lib/cloud/api.ts
@@ -363,6 +363,7 @@ module.exports = {
             'specPattern',
             'tags',
             'testingType',
+            'burnInConfig',
           ]),
           runnerCapabilities,
         }

diff --git a/packages/server/lib/modes/record.js b/packages/server/lib/modes/record.js
@@ -528,7 +528,7 @@ const createRun = Promise.method((options = {}) => {
     ciBuildId: null,
   })
 
-  let { projectRoot, projectId, recordKey, platform, git, specPattern, specs, parallel, ciBuildId, group, tags, testingType, autoCancelAfterFailures, project } = options
+  let { projectRoot, projectId, recordKey, platform, git, specPattern, specs, parallel, ciBuildId, group, tags, testingType, autoCancelAfterFailures, project, burnInConfig } = options
 
   if (recordKey == null) {
     recordKey = env.get('CYPRESS_RECORD_KEY')
@@ -586,6 +586,7 @@ const createRun = Promise.method((options = {}) => {
     commit,
     autoCancelAfterFailures,
     project,
+    burnInConfig,
   })
   .tap((response) => {
     if (!(response && response.warnings && response.warnings.length)) {
@@ -776,6 +777,12 @@ const createRun = Promise.method((options = {}) => {
               ciBuildId,
               autoCancelAfterFailures,
             })
+          case 'BURN_IN_MISMATCH':
+            return errors.throwErr('CLOUD_BURN_IN_MISMATCH', {
+              runUrl,
+              burnInConfig,
+              configFileBaseName: path.basename(options.configFile),
+            })
           default:
             return errors.throwErr('CLOUD_UNKNOWN_INVALID_REQUEST', {
               response: err,
@@ -895,6 +902,7 @@ const createRunAndRecordSpecs = (options = {}) => {
       configFile: config ? config.configFile : null,
       autoCancelAfterFailures,
       project,
+      burnInConfig: config?.experimentalBurnIn,
     })
     .then((resp) => {
       if (!resp) {

diff --git a/packages/server/test/unit/modes/record_spec.js b/packages/server/test/unit/modes/record_spec.js
@@ -286,6 +286,12 @@ describe('lib/modes/record', () => {
         const testingType = 'e2e'
         const autoCancelAfterFailures = 4
         const project = {}
+        const config = {
+          experimentalBurnIn: {
+            default: 1,
+            flaky: 2,
+          },
+        }
 
         return recordMode.createRunAndRecordSpecs({
           key,
@@ -303,6 +309,7 @@ describe('lib/modes/record', () => {
           testingType,
           autoCancelAfterFailures,
           project,
+          config,
         })
         .then(() => {
           expect(commitInfo.commitInfo).to.be.calledWith(projectRoot)
@@ -342,6 +349,7 @@ describe('lib/modes/record', () => {
             tags: ['nightly', 'develop'],
             autoCancelAfterFailures: 4,
             project,
+            burnInConfig: config.experimentalBurnIn,
           })
         })
       })

diff --git a/system-tests/__snapshots__/record_spec.js b/system-tests/__snapshots__/record_spec.js
@@ -2365,6 +2365,7 @@ Request Sent:
     ""
   ],
   "testingType": "e2e",
+  "burnInConfig": false,
   "runnerCapabilities": {
     "dynamicSpecsInSerialMode": true,
     "skipSpecAction": true,
@@ -3632,3 +3633,11 @@ exports['e2e record capture-protocol enabled protocol runtime errors error in pr
 
 
 `
+
+exports['e2e record api interaction errors create run 422 - burn-in config mismatch errors when first run burn-in config is different from non-first run 1'] = `
+You passed in a experimentalBurnIn configuration, but this run originally started with a different configuration for experimentalBurnIn.
+This experimentalBurnIn config came from your cypress-with-project-id.config.js file or an environment variable.
+The existing run is: https://cloud.cypress.io/runs/12345
+The experimentalBurnIn configuration you tried to pass was: false
+
+`
diff --git a/system-tests/test/record_spec.js b/system-tests/test/record_spec.js
@@ -1070,6 +1070,39 @@ describe('e2e record', () => {
       })
     })
 
+    describe('create run 422 - burn-in config mismatch', () => {
+      setupStubbedServer(createRoutes({
+        postRun: {
+          res (req, res) {
+            return res.status(422).json({
+              code: 'BURN_IN_MISMATCH',
+              payload: {
+                runUrl: 'https://cloud.cypress.io/runs/12345',
+              },
+            })
+          },
+        },
+      }))
+
+      it('errors when first run burn-in config is different from non-first run', function () {
+        return systemTests.exec(this, {
+          key: 'f858a2bc-b469-4e48-be67-0876339ee7e1',
+          configFile: 'cypress-with-project-id.config.js',
+          spec: 'record_pass*',
+          record: true,
+          snapshot: true,
+          expectedExitCode: 1,
+        })
+        .then(() => {
+          const urls = getRequestUrls()
+
+          expect(urls).to.deep.eq([
+            'POST /runs',
+          ])
+        })
+      })
+    })
+
     describe('create run 412', () => {
       setupStubbedServer(createRoutes({
         postRun: {