breaking: no longer inject document.domain by default

.circleci/workflows.yml

@@ -32,6 +32,7 @@ mainBuildFilters: &mainBuildFilters
         - 'update-v8-snapshot-cache-on-develop'
         - 'chore/update_vue_test_utils'
         - 'publish-binary'
+        - 'cacie/29590/document-domain-subdomains'
 
 # usually we don't build Mac app - it takes a long time
 # but sometimes we want to really confirm we are doing the right thing
@@ -573,6 +574,11 @@ commands:
         description: chrome channel to install
         type: string
         default: ''
+      inject-document-domain:
+        description: run subset of tests with injectDocumentDomain config enabled
+        type: boolean
+        default: false
+
     steps:
       - restore_cached_workspace
       - when:
@@ -594,11 +600,20 @@ commands:
             echo Current working directory is $PWD
             echo Total containers $CIRCLE_NODE_TOTAL
 
+
+            if << parameters.inject-document-domain >> ; then
+              YARN_CMD="cypress:run:inject-document-domain"
+              PARALLEL=""
+            else
+              YARN_CMD="cypress:run"
+              PARALLEL="--parallel --group 5x-driver-<<parameters.browser>>"
+            fi
+
             if [[ -v MAIN_RECORD_KEY ]]; then
               # internal PR
               CYPRESS_RECORD_KEY=$MAIN_RECORD_KEY \
               CYPRESS_INTERNAL_ENABLE_TELEMETRY="true" \
-              yarn cypress:run --record --parallel --group 5x-driver-<<parameters.browser>> --browser <<parameters.browser>> --runner-ui
+              yarn $YARN_CMD --record $PARALLEL --browser <<parameters.browser>> --runner-ui
             else
               # external PR
               TESTFILES=$(circleci tests glob "cypress/e2e/**/*.cy.*" | circleci tests split --total=$CIRCLE_NODE_TOTAL)
@@ -607,7 +622,7 @@ commands:
               if [[ -z "$TESTFILES" ]]; then
                 echo "Empty list of test files"
               fi
-              yarn cypress:run --browser <<parameters.browser>> --spec $TESTFILES --runner-ui
+              yarn $YARN_CMD --browser <<parameters.browser>> --spec $TESTFILES --runner-ui
             fi
           working_directory: packages/driver
       - verify-mocha-results
@@ -2002,6 +2017,16 @@ jobs:
       - run-driver-integration-tests:
           browser: chrome
           install-chrome-channel: stable
+
+  driver-integration-tests-chrome-inject-document-domain:
+    <<: *defaults
+    parallelism: 5
+    resource_class: medium+
+    steps:
+      - run-driver-integration-tests:
+          browser: chrome
+          install-chrome-channel: stable
+          inject-document-domain: true
 
   driver-integration-tests-chrome-beta:
     <<: *defaults
@@ -2012,6 +2037,16 @@ jobs:
           browser: chrome:beta
           install-chrome-channel: beta
 
+  driver-integration-tests-chrome-beta-inject-document-domain:
+    <<: *defaults
+    resource_class: medium+
+    parallelism: 5
+    steps:
+      - run-driver-integration-tests:
+          browser: chrome:beta
+          install-chrome-channel: beta
+          inject-document-domain: true
+
   driver-integration-tests-firefox:
     <<: *defaults
     resource_class: medium+
@@ -2034,6 +2069,8 @@ jobs:
     steps:
       - run-driver-integration-tests:
           browser: webkit
+          # inject document domain must be true for webkit, as cy.origin is not supported
+          inject-document-domain: true
 
   run-reporter-component-tests-chrome:
     <<: *defaults
@@ -2816,7 +2853,8 @@ linux-x64-workflow: &linux-x64-workflow
           - run-vite-dev-server-integration-tests
           - driver-integration-tests-firefox
           - driver-integration-tests-chrome
-          - driver-integration-tests-chrome-beta
+          - driver-integration-tests-chrome-inject-document-domain
+          - driver-integration-tests-chrome-beta-inject-document-domain
           - driver-integration-tests-electron
           - driver-integration-tests-webkit
           - driver-integration-memory-tests
@@ -2873,10 +2911,18 @@ linux-x64-workflow: &linux-x64-workflow
         context: test-runner:cypress-record-key
         requires:
           - build
+    - driver-integration-tests-chrome-inject-document-domain:
+        context: test-runner:cypress-record-key
+        requires:
+          - build
     - driver-integration-tests-chrome-beta:
         context: test-runner:cypress-record-key
         requires:
           - build
+    - driver-integration-tests-chrome-beta-inject-document-domain:
+        context: test-runner:cypress-record-key
+        requires:
+          - build
     - driver-integration-tests-firefox:
         context: test-runner:cypress-record-key
         requires:
@@ -3000,6 +3046,8 @@ linux-x64-workflow: &linux-x64-workflow
           - driver-integration-tests-firefox
           - driver-integration-tests-chrome
           - driver-integration-tests-chrome-beta
+          - driver-integration-tests-chrome-inject-document-domain
+          - driver-integration-tests-chrome-beta-inject-document-domain
           - driver-integration-tests-electron
           - driver-integration-tests-webkit
           - driver-integration-memory-tests
@@ -3234,10 +3282,18 @@ linux-x64-contributor-workflow: &linux-x64-contributor-workflow
         context: test-runner:cypress-record-key
         requires:
           - contributor-pr
+    - driver-integration-tests-chrome-inject-document-domain:
+        context: test-runner:cypress-record-key
+        requires:
+          - contributor-pr
     - driver-integration-tests-chrome-beta:
         context: test-runner:cypress-record-key
         requires:
           - contributor-pr
+    - driver-integration-tests-chrome-beta-inject-document-domain:
+        context: test-runner:cypress-record-key
+        requires:
+          - contributor-pr
     - driver-integration-tests-firefox:
         context: test-runner:cypress-record-key
         requires:

cli/types/cypress.d.ts

@@ -70,8 +70,7 @@ declare namespace Cypress {
     strategy: 'file' | 'http'
     origin: string
     fileServer: string | null
-    props: Record<string, any>
-    visiting: string
+    props: Record<string, any> | null
   }
 
   interface Backend {
@@ -3113,6 +3112,12 @@ declare namespace Cypress {
      * @default null
      */
     experimentalSkipDomainInjection: string[] | null
+    /**
+     * Enables setting document.domain to the superdomain on code injection. This option is
+     * disabled by default. Enabling this option allows for navigating between subdomains in
+     * the same test without the use of cy.origin().
+     */
+    injectDocumentDomain: boolean
     /**
      * Enables AST-based JS/HTML rewriting. This may fix issues caused by the existing regex-based JS/HTML replacement algorithm.
      * @default false

npm/cypress-schematic/src/ct.spec.ts

@@ -1,22 +1,10 @@
-import { describe, it } from 'vitest'
+import { describe, it, beforeEach, afterEach } from 'vitest'
 import Fixtures, { ProjectFixtureDir } from '@tooling/system-tests'
 import * as FixturesScaffold from '@tooling/system-tests/lib/dep-installer'
 import execa from 'execa'
 import path from 'path'
 import * as fs from 'fs-extra'
 
-const scaffoldAngularProject = async (project: string) => {
-  const projectPath = Fixtures.projectPath(project)
-
-  Fixtures.removeProject(project)
-  await Fixtures.scaffoldProject(project)
-  await FixturesScaffold.scaffoldProjectNodeModules({ project })
-  await fs.remove(path.join(projectPath, 'cypress.config.ts'))
-  await fs.remove(path.join(projectPath, 'cypress'))
-
-  return projectPath
-}
-
 const runCommandInProject = (command: string, projectPath: string) => {
   const [ex, ...args] = command.split(' ')
 
@@ -38,25 +26,38 @@ const cypressSchematicPackagePath = path.join(__dirname, '..')
 
 const ANGULAR_PROJECTS: ProjectFixtureDir[] = ['angular-18', 'angular-19']
 
-describe('ng add @cypress/schematic / e2e and ct', { timeout: 1000 * 60 * 5 }, function () {
-  for (const project of ANGULAR_PROJECTS) {
-    it('should install ct files with option and no component specs', async () => {
-      const projectPath = await scaffoldAngularProject(project)
+const timeout = 1000 * 60 * 5
 
-      await runCommandInProject(`yarn add @cypress/schematic@file:${cypressSchematicPackagePath}`, projectPath)
-      await runCommandInProject('yarn ng add @cypress/schematic --e2e --component', projectPath)
-      await copyAngularMount(projectPath)
-      await runCommandInProject('yarn ng run angular:ct --watch false --spec src/app/app.component.cy.ts', projectPath)
-    })
-
-    it('should generate component alongside component spec', async () => {
-      const projectPath = await scaffoldAngularProject(project)
-
-      await runCommandInProject(`yarn add @cypress/schematic@file:${cypressSchematicPackagePath}`, projectPath)
-      await runCommandInProject('yarn ng add @cypress/schematic --e2e --component', projectPath)
-      await copyAngularMount(projectPath)
-      await runCommandInProject('yarn ng generate c foo', projectPath)
-      await runCommandInProject('yarn ng run angular:ct --watch false --spec src/app/foo/foo.component.cy.ts', projectPath)
+describe('ng add @cypress/schematic / e2e and ct', function () {
+  for (const project of ANGULAR_PROJECTS) {
+    describe(project, () => {
+      const projectPath: string = Fixtures.projectPath(project)
+
+      beforeEach(async () => {
+        await Fixtures.scaffoldProject(project)
+        await FixturesScaffold.scaffoldProjectNodeModules({ project })
+        await fs.remove(path.join(projectPath, 'cypress.config.ts'))
+        await fs.remove(path.join(projectPath, 'cypress'))
+
+        await runCommandInProject(`yarn add @cypress/schematic@file:${cypressSchematicPackagePath}`, projectPath)
+      }, timeout)
+
+      afterEach(() => {
+        Fixtures.removeProject(project)
+      }, timeout)
+
+      it('should install ct files with option and no component specs', async () => {
+        await runCommandInProject('yarn ng add @cypress/schematic --e2e --component', projectPath)
+        await copyAngularMount(projectPath)
+        await runCommandInProject('yarn ng run angular:ct --watch false --spec src/app/app.component.cy.ts', projectPath)
+      }, timeout)
+
+      it('should generate component alongside component spec', async () => {
+        await runCommandInProject('yarn ng add @cypress/schematic --e2e --component', projectPath)
+        await copyAngularMount(projectPath)
+        await runCommandInProject('yarn ng generate c foo', projectPath)
+        await runCommandInProject('yarn ng run angular:ct --watch false --spec src/app/foo/foo.component.cy.ts', projectPath)
+      }, timeout)
     })
   }
 })

npm/vite-dev-server/src/plugins/cypress.ts

@@ -99,13 +99,7 @@ export const Cypress = (
     },
     configureServer: async (server: ViteDevServer) => {
       server.middlewares.use(`${base}index.html`, async (req, res) => {
-        let transformedIndexHtml = await server.transformIndexHtml(base, '')
-        const viteImport = `<script type="module" src="${options.cypressConfig.devServerPublicPathRoute}/@vite/client"></script>`
-
-        // If we're doing cy-in-cy, we need to be able to access the Cypress instance from the parent frame.
-        if (process.env.CYPRESS_INTERNAL_VITE_OPEN_MODE_TESTING) {
-          transformedIndexHtml = transformedIndexHtml.replace(viteImport, `<script>document.domain = 'localhost';</script>${viteImport}`)
-        }
+        const transformedIndexHtml = await server.transformIndexHtml(base, '')
 
         return res.end(transformedIndexHtml)
       })

package.json

@@ -278,5 +278,6 @@
     "devtools-protocol": "0.0.1346313",
     "sharp": "0.29.3",
     "vue-template-compiler": "2.6.12"
-  }
+  },
+  "packageManager": "[email protected]+sha512.ff4579ab459bb25aa7c0ff75b62acebe576f6084b36aa842971cf250a5d8c6cd3bc9420b22ce63c7f93a0857bc6ef29291db39c3e7a23aab5adfd5a4dd6c5d71"
 }

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

@@ -40,6 +40,7 @@ exports['config/src/index .getDefaultValues returns list of public config keys 1
   'experimentalRunAllSpecs': false,
   'experimentalMemoryManagement': false,
   'experimentalModifyObstructiveThirdPartyCode': false,
+  'injectDocumentDomain': false,
   'experimentalSkipDomainInjection': null,
   'experimentalOriginDependencies': false,
   'experimentalSourceRewriting': false,
@@ -131,6 +132,7 @@ exports['config/src/index .getDefaultValues returns list of public config keys f
   'experimentalRunAllSpecs': false,
   'experimentalMemoryManagement': false,
   'experimentalModifyObstructiveThirdPartyCode': false,
+  'injectDocumentDomain': false,
   'experimentalSkipDomainInjection': null,
   'experimentalOriginDependencies': false,
   'experimentalSourceRewriting': false,
@@ -218,6 +220,7 @@ exports['config/src/index .getPublicConfigKeys returns list of public config key
   'experimentalRunAllSpecs',
   'experimentalMemoryManagement',
   'experimentalModifyObstructiveThirdPartyCode',
+  'injectDocumentDomain',
   'experimentalSkipDomainInjection',
   'experimentalOriginDependencies',
   'experimentalSourceRewriting',

packages/config/src/options.ts

@@ -230,6 +230,12 @@ const driverConfigOptions: Array<DriverConfigOption> = [
     isExperimental: true,
     requireRestartOnChange: 'server',
   }, {
+    name: 'injectDocumentDomain',
+    defaultValue: false,
+    validation: validate.isBoolean,
+    requireRestartOnChange: 'server',
+  },
+  {
     name: 'experimentalSkipDomainInjection',
     defaultValue: null,
     validation: validate.isNullOrArrayOfStrings,
@@ -768,6 +774,16 @@ export const testingTypeBreakingOptions: { e2e: Array<BreakingOption>, component
       errorKey: 'JIT_COMPONENT_TESTING',
       isWarning: false,
     },
+    {
+      name: 'experimentalSkipDomainInjection',
+      errorKey: 'EXPERIMENTAL_SKIP_DOMAIN_INJECTION',
+      isWarning: false,
+    },
+    {
+      name: 'injectDocumentDomain',
+      errorKey: 'INJECT_DOCUMENT_DOMAIN_DEPRECATION',
+      isWarning: true,
+    },
   ],
   component: [
     {
@@ -800,5 +816,10 @@ export const testingTypeBreakingOptions: { e2e: Array<BreakingOption>, component
       errorKey: 'EXPERIMENTAL_USE_DEFAULT_DOCUMENT_DOMAIN_E2E_ONLY',
       isWarning: false,
     },
+    {
+      name: 'injectDocumentDomain',
+      errorKey: 'INJECT_DOCUMENT_DOMAIN_E2E_ONLY',
+      isWarning: false,
+    },
   ],
 }

packages/config/test/index.spec.ts

@@ -247,9 +247,12 @@ describe('config/src/index', () => {
 
   describe('.validateNeedToRestartOnChange', () => {
     it('returns the need to restart if given key has changed', () => {
-      const result = configUtil.validateNeedToRestartOnChange({ blockHosts: [] }, { blockHosts: ['https://example.com'] })
+      expect(configUtil.validateNeedToRestartOnChange({ blockHosts: [] }, { blockHosts: ['https://example.com'] })).to.eql({
+        server: true,
+        browser: false,
+      })
 
-      expect(result).to.eql({
+      expect(configUtil.validateNeedToRestartOnChange({ injectDocumentDomain: true }, {})).to.eql({
         server: true,
         browser: false,
       })

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

@@ -1085,6 +1085,7 @@ describe('config/src/project/utils', () => {
             fixturesFolder: { value: 'cypress/fixtures', from: 'default' },
             hosts: { value: null, from: 'default' },
             includeShadowDom: { value: false, from: 'default' },
+            injectDocumentDomain: { value: false, from: 'default' },
             justInTimeCompile: { value: true, from: 'default' },
             isInteractive: { value: true, from: 'default' },
             keystrokeDelay: { value: 0, from: 'default' },
@@ -1204,6 +1205,7 @@ describe('config/src/project/utils', () => {
             fixturesFolder: { value: 'cypress/fixtures', from: 'default' },
             hosts: { value: null, from: 'default' },
             includeShadowDom: { value: false, from: 'default' },
+            injectDocumentDomain: { value: false, from: 'default' },
             justInTimeCompile: { value: true, from: 'default' },
             isInteractive: { value: true, from: 'default' },
             keystrokeDelay: { value: 0, from: 'default' },