Merge branch '10.0-release' into tgriesser/feat/UNIFY-1206

* 10.0-release: (92 commits)
  chore: remove dependency-tree dep (#20905)
  chore(launchpad): work on infra for scaffold tests (#20818)
  fix: build mjs in the cli (#20889)
  fix(unify): Cypress version link should point to Cypress doc's changelog (#20869)
  fix: windows build (#20854)
  fix: add index.mjs to the published files of cli (#20884)
  refactor: lift indexHtmlFile up to component, add validation (#20870)
  fix: allow migration of pluginsFile using `env` properties (#20770)
  fix: viewport from CLI on CT (#20849)
  Don't communicate if process isn't connected
  Remove config.get
  Update packages/data-context/src/data/ProjectLifecycleManager.ts
  fix: git data source unit test failure (#20875)
  add comment for autoBindDebug
  fix: Ensuring current browser is synchronized between app and launchpad (#20830)
  Fix missed await on merge conflict resolution
  test(unification): move record keys to contexts (#20860)
  test: move record keys to contexts (#20859)
  PR comments
  Fix tests that visit app without a configured testing type
  ...

Author: tgriesser

.eslintignore

@@ -91,3 +91,5 @@ system-tests/projects/nuxtjs-vue2-unconfigured/**/*
 system-tests/projects/nuxtjs-vue2-configured/**/*
 
 system-tests/projects/react-app-webpack-5-unconfigured/**/*
+
+system-tests/projects/**/*/expected-cypress*/**/*

browser-versions.json

@@ -1,4 +1,4 @@
 {
-  "chrome:beta": "100.0.4896.46",
-  "chrome:stable": "99.0.4844.82"
+  "chrome:beta": "100.0.4896.60",
+  "chrome:stable": "100.0.4896.60"
 }

circle.yml

@@ -29,6 +29,7 @@ mainBuildFilters: &mainBuildFilters
       only:
         - develop
         - 10.0-release
+        - 10.0-use-contexts
 
 # 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
@@ -38,6 +39,7 @@ macWorkflowFilters: &mac-workflow-filters
     or:
     - equal: [ develop, << pipeline.git.branch >> ]
     - equal: [ '10.0-release', << pipeline.git.branch >> ]
+    - equal: [ 10.0-use-contexts, << pipeline.git.branch >> ]
     - matches:
           pattern: "-release$"
           value: << pipeline.git.branch >>
@@ -47,6 +49,7 @@ windowsWorkflowFilters: &windows-workflow-filters
     or:
     - equal: [ develop, << pipeline.git.branch >> ]
     - equal: [ '10.0-release', << pipeline.git.branch >> ]
+    - equal: [ 10.0-use-contexts, << pipeline.git.branch >> ]
     - matches:
           pattern: "-release$"
           value: << pipeline.git.branch >>
@@ -419,9 +422,9 @@ commands:
             echo Current working directory is $PWD
             echo Total containers $CIRCLE_NODE_TOTAL
 
-            if [[ -v PACKAGES_RECORD_KEY ]]; then
+            if [[ -v MAIN_RECORD_KEY ]]; then
               # internal PR
-              CYPRESS_RECORD_KEY=$PACKAGES_RECORD_KEY \
+              CYPRESS_RECORD_KEY=$MAIN_RECORD_KEY \
               yarn cypress:run --record --parallel --group 5x-driver-<<parameters.browser>> --browser <<parameters.browser>>
             else
               # external PR
@@ -1416,7 +1419,7 @@ jobs:
       - run:
           command: |
             CYPRESS_KONFIG_ENV=production \
-            CYPRESS_RECORD_KEY=$PACKAGES_RECORD_KEY \
+            CYPRESS_RECORD_KEY=$MAIN_RECORD_KEY \
             PERCY_PARALLEL_NONCE=$CIRCLE_SHA1 \
             PERCY_ENABLE=${PERCY_TOKEN:-0} \
             PERCY_PARALLEL_TOTAL=-1 \
@@ -1440,7 +1443,7 @@ jobs:
       - run:
           command: |
             CYPRESS_KONFIG_ENV=production \
-            CYPRESS_RECORD_KEY=$PACKAGES_RECORD_KEY \
+            CYPRESS_RECORD_KEY=$MAIN_RECORD_KEY \
             yarn cypress:run --record --parallel --group ui-components
           working_directory: packages/ui-components
       - verify-mocha-results
@@ -1553,7 +1556,6 @@ jobs:
       - run:
           name: Run tests
           # will use PERCY_TOKEN environment variable if available
-          #
           command: |
             CYPRESS_KONFIG_ENV=production \
             PERCY_PARALLEL_NONCE=$CIRCLE_SHA1 \
@@ -1629,26 +1631,26 @@ jobs:
           command: yarn workspace @cypress/eslint-plugin-dev test
 
   npm-cypress-schematic:
-      <<: *defaults
-      resource_class: small
-      steps:
-        - restore_cached_workspace
-        - run:
-            name: Build + Install
-            command: |
-              yarn workspace @cypress/schematic build:all
-            working_directory: npm/cypress-schematic
-        - run:
-            name: Launch
-            command: |
-              yarn launch:test
-            working_directory: npm/cypress-schematic
-        - run:
-            name: Run unit tests
-            command: |
-              yarn test
-            working_directory: npm/cypress-schematic
-        - store-npm-logs
+    <<: *defaults
+    resource_class: small
+    steps:
+      - restore_cached_workspace
+      - run:
+          name: Build + Install
+          command: |
+            yarn workspace @cypress/schematic build:all
+          working_directory: npm/cypress-schematic
+      - run:
+          name: Launch
+          command: |
+            yarn launch:test
+          working_directory: npm/cypress-schematic
+      - run:
+          name: Run unit tests
+          command: |
+            yarn test
+          working_directory: npm/cypress-schematic
+      - store-npm-logs
 
   npm-release:
     <<: *defaults
@@ -1675,7 +1677,7 @@ jobs:
       - run:
           name: Check current branch to persist artifacts
           command: |
-            if [[ "$CIRCLE_BRANCH" != "develop" && "$CIRCLE_BRANCH" != "marktnoonan/backmerge-develop-3-8-22" && "$CIRCLE_BRANCH" != "10.0-release" ]]; then
+            if [[ "$CIRCLE_BRANCH" != "develop" && "$CIRCLE_BRANCH" != "10.0-use-contexts" && "$CIRCLE_BRANCH" != "10.0-release" ]]; then
               echo "Not uploading artifacts or posting install comment for this branch."
               circleci-agent step halt
             fi
@@ -2148,6 +2150,7 @@ linux-workflow: &linux-workflow
           - build
     # unit, integration and e2e tests
     - cli-visual-tests:
+        context: test-runner:percy
         requires:
           - build
     - unit-tests:
@@ -2188,46 +2191,52 @@ linux-workflow: &linux-workflow
         requires:
           - system-tests-node-modules-install
     - driver-integration-tests-chrome:
+        context: test-runner:cypress-record-key
         requires:
           - build
     - driver-integration-tests-chrome-beta:
+        context: test-runner:cypress-record-key
         requires:
           - build
     - driver-integration-tests-firefox:
+        context: test-runner:cypress-record-key
         requires:
           - build
     - driver-integration-tests-electron:
+        context: test-runner:cypress-record-key
         requires:
           - build
     - run-frontend-shared-component-tests-chrome:
-        context: test-runner:launchpad-tests
+        context: [test-runner:launchpad-tests, test-runner:percy]
         percy: true
         requires:
           - build
     - run-launchpad-integration-tests-chrome:
-        context: test-runner:launchpad-tests
+        context: [test-runner:launchpad-tests, test-runner:percy]
         percy: true
         requires:
           - build
     - run-launchpad-component-tests-chrome:
-        context: test-runner:launchpad-tests
+        context: [test-runner:launchpad-tests, test-runner:percy]
         percy: true
         requires:
           - build
     - run-app-integration-tests-chrome:
-        context: test-runner:launchpad-tests
+        context: [test-runner:launchpad-tests, test-runner:percy]
         percy: true
         requires:
           - build
     - run-app-component-tests-chrome:
-        context: test-runner:launchpad-tests
+        context: [test-runner:launchpad-tests, test-runner:percy]
         percy: true
         requires:
           - build
     - reporter-integration-tests:
+        context: [test-runner:cypress-record-key, test-runner:percy]
         requires:
           - build
     - ui-components-integration-tests:
+        context: test-runner:cypress-record-key
         requires:
           - build
     - npm-webpack-dev-server:
@@ -2243,6 +2252,7 @@ linux-workflow: &linux-workflow
         requires:
           - build
     - npm-design-system:
+        context: test-runner:percy
         requires:
           - build
     - npm-vue:

cli/__snapshots__/download_spec.js

@@ -44,3 +44,15 @@ https://download.cypress.io/desktop/0.20.2?platform=OS&arch=ARCH
 exports['desktop url from template'] = `
 https://download.cypress.io/desktop/0.20.2/darwin-x64/cypress.zip
 `
+
+exports['desktop url from template with escaped dollar sign'] = `
+https://download.cypress.io/desktop/0.20.2/darwin-x64/cypress.zip
+`
+
+exports['desktop url from template wrapped in quote'] = `
+https://download.cypress.io/desktop/0.20.2/darwin-x64/cypress.zip
+`
+
+exports['desktop url from template with escaped dollar sign wrapped in quote'] = `
+https://download.cypress.io/desktop/0.20.2/darwin-x64/cypress.zip
+`

cli/lib/tasks/download.js

@@ -64,10 +64,15 @@ const getCA = () => {
 const prepend = (urlPath) => {
   const endpoint = url.resolve(getBaseUrl(), urlPath)
   const platform = os.platform()
-  const pathTemplate = util.getEnv('CYPRESS_DOWNLOAD_PATH_TEMPLATE')
+  const pathTemplate = util.getEnv('CYPRESS_DOWNLOAD_PATH_TEMPLATE', true)
 
   return pathTemplate
-    ? pathTemplate.replace('${endpoint}', endpoint).replace('${platform}', platform).replace('${arch}', arch())
+    ? (
+      pathTemplate
+      .replace(/\\?\$\{endpoint\}/, endpoint)
+      .replace(/\\?\$\{platform\}/, platform)
+      .replace(/\\?\$\{arch\}/, arch())
+    )
     : `${endpoint}?platform=${platform}&arch=${arch()}`
 }
 

cli/package.json

@@ -101,6 +101,7 @@
     "bin",
     "lib",
     "index.js",
+    "index.mjs",
     "types/**/*.d.ts",
     "types/net-stubbing.ts"
   ],

cli/scripts/start-build.js

@@ -24,3 +24,4 @@ includeTypes.forEach((folder) => {
 
 shell.exec('babel lib -d build/lib')
 shell.exec('babel index.js -o build/index.js')
+shell.cp('index.mjs', 'build/index.mjs')

cli/test/lib/tasks/download_spec.js

@@ -72,6 +72,27 @@ describe('lib/tasks/download', function () {
       snapshot('desktop url from template', normalize(url))
     })
 
+    it('returns custom url from template with escaped dollar sign', () => {
+      process.env.CYPRESS_DOWNLOAD_PATH_TEMPLATE = '\\${endpoint}/\\${platform}-\\${arch}/cypress.zip'
+      const url = download.getUrl('0.20.2')
+
+      snapshot('desktop url from template with escaped dollar sign', normalize(url))
+    })
+
+    it('returns custom url from template wrapped in quote', () => {
+      process.env.CYPRESS_DOWNLOAD_PATH_TEMPLATE = '"${endpoint}/${platform}-${arch}/cypress.zip"'
+      const url = download.getUrl('0.20.2')
+
+      snapshot('desktop url from template wrapped in quote', normalize(url))
+    })
+
+    it('returns custom url from template with escaped dollar sign wrapped in quote', () => {
+      process.env.CYPRESS_DOWNLOAD_PATH_TEMPLATE = '"\\${endpoint}/\\${platform}-\\${arch}/cypress.zip"'
+      const url = download.getUrl('0.20.2')
+
+      snapshot('desktop url from template with escaped dollar sign wrapped in quote', normalize(url))
+    })
+
     it('returns input if it is already an https link', () => {
       const url = 'https://somewhere.com'
       const result = download.getUrl(url)

cli/types/cypress.d.ts

@@ -2858,7 +2858,7 @@ declare namespace Cypress {
      * Override default config options for E2E Testing runner.
      * @default {}
      */
-    e2e: CoreConfigOptions
+    e2e: Omit<CoreConfigOptions, 'indexHtmlFile'>
 
     /**
      * An array of objects defining the certificates
@@ -2869,6 +2869,8 @@ declare namespace Cypress {
      * Handle Cypress plugins
      */
     setupNodeEvents: (on: PluginEvents, config: PluginConfigOptions) => Promise<PluginConfigOptions> | PluginConfigOptions
+
+    indexHtmlFile: string
   }
 
   /**
@@ -2971,7 +2973,7 @@ declare namespace Cypress {
   /**
    * Config options that can be assigned on cypress.config.{ts|js} file
    */
-  type UserConfigOptions<ComponentDevServerOpts = any> = Omit<ResolvedConfigOptions<ComponentDevServerOpts>, 'baseUrl' | 'excludeSpecPattern' | 'supportFile' | 'specPattern'>
+  type UserConfigOptions<ComponentDevServerOpts = any> = Omit<ResolvedConfigOptions<ComponentDevServerOpts>, 'baseUrl' | 'excludeSpecPattern' | 'supportFile' | 'specPattern' | 'indexHtmlFile'>
 
   /**
    * Takes ComponentDevServerOpts to track the signature of the devServerConfig for the provided `devServer`,

cli/types/tests/cypress-tests.ts

@@ -37,6 +37,7 @@ namespace CypressConfigTests {
   Cypress.config({ e2e: { baseUrl: null }}) // $ExpectType void
   Cypress.config({ e2e: { baseUrl: '.', }}) // $ExpectType void
   Cypress.config({ component: { baseUrl: '.', devServer: () => ({} as any) } }) // $ExpectError
+  Cypress.config({ e2e: { indexHtmlFile: 'index.html' } }) // $ExpectError
 
   Cypress.config('taskTimeout') // $ExpectType number
   Cypress.config('includeShadowDom') // $ExpectType boolean