Merge branch '10.0-release' into lmiller1990/UNIFY-1402

* 10.0-release: (25 commits) fix: stop running spec when switching specs (#21038) fix: remove asset size warnings and enable nuxt e2e tests (#21074) feat: swap the #__cy_root id selector to become data-cy-root for component mounting (#20951) fix: Doc changes around vue2 (#21066) feat: Add vue2 package from npm/vue/v2 branch (#21026) skip failing test fix: add possible frameworks to object API config (#21056) fix snapshot spacing fix system test fix snapshot update snapshots rename spec files rename files update snapshots release 9.5.4 [skip ci] fix(regression): cy.pause() should not be ignored with `cypress run --headed --no-exit` (#20877) fix: add missing Cypress.Commands.addAll() types (#20894) chore: Don't store video and screenshot artifacts for runs (#20979) chore: Update Chrome (beta) to 101.0.4951.26 (#20957) chore: remove parallelism from test-binary-against-repo jobs (#21004) ...
cypress-io · Apr 14, 2022 · c190faf · c190faf
2 parents 10c7f92 + aa98f2e
commit c190faf
Show file tree

Hide file tree

Showing 212 changed files with 4,475 additions and 107,122 deletions.
diff --git a/.eslintignore b/.eslintignore
@@ -41,6 +41,7 @@ cli/types
 # cli/react, cli/vue, and cli/mount-utils are all copied from dist'd builds
 cli/react
 cli/vue
+cli/vue2
 cli/mount-utils
 
 # packages/example is not linted (think about changing this)
@@ -69,6 +70,9 @@ npm/cypress-schematic/src/**/*.js
 /npm/create-cypress-tests/initial-template
 /npm/create-cypress-tests/**/*.template.*
 
+# The global eslint configuration is not set up to parse vue@2 files
+/npm/vue2/**/*.vue
+
 packages/data-context/test/unit/codegen/files
 
 # community templates we test against, no need to lint

diff --git a/.releaserc.base.js b/.releaserc.base.js
@@ -15,5 +15,6 @@ module.exports = {
   ],
   extends: 'semantic-release-monorepo',
   branches: [
+    'master',
   ],
 }
diff --git a/browser-versions.json b/browser-versions.json
@@ -1,4 +1,4 @@
 {
-  "chrome:beta": "101.0.4951.15",
+  "chrome:beta": "101.0.4951.26",
   "chrome:stable": "100.0.4896.75"
 }
diff --git a/circle.yml b/circle.yml
@@ -695,13 +695,6 @@ commands:
                       name: Run tests using command
                       working_directory: /tmp/<<parameters.repo>>/<<parameters.folder>>
                       command: <<parameters.command>>
-
-            - store_artifacts:
-                name: screenshots
-                path: /tmp/<<parameters.repo>>/<<parameters.folder>>/cypress/screenshots
-            - store_artifacts:
-                name: videos
-                path: /tmp/<<parameters.repo>>/<<parameters.folder>>/cypress/videos
       - unless:
           condition: <<parameters.folder>>
           steps:
@@ -719,12 +712,6 @@ commands:
                       name: Run tests using command
                       working_directory: /tmp/<<parameters.repo>>
                       command: <<parameters.command>>
-            - store_artifacts:
-                name: screenshots
-                path: /tmp/<<parameters.repo>>/cypress/screenshots
-            - store_artifacts:
-                name: videos
-                path: /tmp/<<parameters.repo>>/cypress/videos
       - store-npm-logs
 
   test-binary-against-repo:
@@ -844,13 +831,6 @@ commands:
                       name: Run tests using command
                       working_directory: /tmp/<<parameters.repo>>/<<parameters.folder>>
                       command: <<parameters.command>>
-
-            - store_artifacts:
-                name: screenshots
-                path: /tmp/<<parameters.repo>>/<<parameters.folder>>/cypress/screenshots
-            - store_artifacts:
-                name: videos
-                path: /tmp/<<parameters.repo>>/<<parameters.folder>>/cypress/videos
       - unless:
           condition: <<parameters.folder>>
           steps:
@@ -868,12 +848,6 @@ commands:
                       name: Run tests using command
                       working_directory: /tmp/<<parameters.repo>>
                       command: <<parameters.command>>
-            - store_artifacts:
-                name: screenshots
-                path: /tmp/<<parameters.repo>>/cypress/screenshots
-            - store_artifacts:
-                name: videos
-                path: /tmp/<<parameters.repo>>/cypress/videos
       - store-npm-logs
 
   wait-on-circle-jobs:
@@ -956,7 +930,7 @@ commands:
           command: ls -la types
           working_directory: cli/build
       - run:
-          command: ls -la vue mount-utils react
+          command: ls -la vue vue2 mount-utils react
           working_directory: cli/build
       - unless:
           condition:
@@ -1565,8 +1539,6 @@ jobs:
           working_directory: npm/vite-dev-server
       - store_test_results:
           path: npm/vite-dev-server/test_results
-      - store_artifacts:
-          path: npm/vite-dev-server/cypress/videos
       - store-npm-logs
 
   npm-webpack-batteries-included-preprocessor:
@@ -1774,10 +1746,6 @@ jobs:
           name: Run Kitchensink example project
           command: |
             yarn cypress:run --project /tmp/cypress-example-kitchensink
-      - store_artifacts:
-          path: /tmp/cypress-example-kitchensink/cypress/screenshots
-      - store_artifacts:
-          path: /tmp/cypress-example-kitchensink/cypress/videos
       - store-npm-logs
 
   test-kitchensink-against-staging:
@@ -2020,15 +1988,13 @@ jobs:
 
   test-binary-against-recipes-chrome:
     <<: *defaults
-    parallelism: 3
     steps:
       - test-binary-against-repo:
           repo: cypress-example-recipes
           command: npm run test:ci:chrome
 
   test-binary-against-recipes:
     <<: *defaults
-    parallelism: 3
     steps:
       - test-binary-against-repo:
           repo: cypress-example-recipes

diff --git a/cli/.gitignore b/cli/.gitignore
@@ -16,5 +16,6 @@ build
 # ignore packages synced at build-time via
 # the sync-exported-npm-with-cli.js script
 vue
+vue2
 react
-mount-utils
+mount-utils
diff --git a/cli/package.json b/cli/package.json
@@ -106,7 +106,8 @@
     "types/net-stubbing.ts",
     "mount-utils",
     "vue",
-    "react"
+    "react",
+    "vue2"
   ],
   "bin": {
     "cypress": "bin/cypress"
@@ -124,6 +125,10 @@
       "import": "./vue/dist/cypress-vue.esm-bundler.js",
       "require": "./vue/dist/cypress-vue.cjs.js"
     },
+    "./vue2": {
+      "import": "./vue2/dist/cypress-vue2.esm-bundler.js",
+      "require": "./vue2/dist/cypress-vue2.cjs.js"
+    },
     "./package.json": {
       "import": "./package.json",
       "require": "./package.json"

diff --git a/cli/scripts/post-build.js b/cli/scripts/post-build.js
@@ -10,6 +10,7 @@ const npmModulesToCopy = [
   'mount-utils',
   'react',
   'vue',
+  'vue2',
 ]
 
 npmModulesToCopy.forEach((folder) => {

diff --git a/cli/scripts/post-install.js b/cli/scripts/post-install.js
@@ -23,7 +23,7 @@ shell.set('-e') // any error is fatal
 fs.ensureDirSync(join(__dirname, '..', 'types'))
 
 includeTypes.forEach((folder) => {
-  const source = resolvePkg(`@types/${folder}`, { cwd: join(__dirname, '..', '..') })
+  const source = resolvePkg(`@types/${folder}`, { cwd: __dirname })
 
   fs.copySync(source, join(__dirname, '..', 'types', folder))
 })

diff --git a/cli/types/cypress.d.ts b/cli/types/cypress.d.ts
@@ -24,9 +24,15 @@ declare namespace Cypress {
   interface CommandFn<T extends keyof ChainableMethods> {
     (this: Mocha.Context, ...args: Parameters<ChainableMethods[T]>): ReturnType<ChainableMethods[T]> | void
   }
+  interface CommandFns {
+    [name: string]: (this: Mocha.Context, ...args: any) => any
+  }
   interface CommandFnWithSubject<T extends keyof ChainableMethods, S> {
     (this: Mocha.Context, prevSubject: S, ...args: Parameters<ChainableMethods[T]>): ReturnType<ChainableMethods[T]> | void
   }
+  interface CommandFnsWithSubject<S> {
+    [name: string]: (this: Mocha.Context, prevSubject: S, ...args: any) => any
+  }
   interface CommandOriginalFn<T extends keyof ChainableMethods> extends CallableFunction {
     (...args: Parameters<ChainableMethods[T]>): ReturnType<ChainableMethods[T]>
   }
@@ -467,6 +473,14 @@ declare namespace Cypress {
       add<T extends keyof Chainable, S extends PrevSubject>(
           name: T, options: CommandOptions & { prevSubject: S[] }, fn: CommandFnWithSubject<T, PrevSubjectMap<void>[S]>,
       ): void
+      addAll<T extends keyof Chainable>(fns: CommandFns): void
+      addAll<T extends keyof Chainable>(options: CommandOptions & {prevSubject: false}, fns: CommandFns): void
+      addAll<T extends keyof Chainable, S extends PrevSubject>(
+          options: CommandOptions & { prevSubject: true | S | ['optional'] }, fns: CommandFnsWithSubject<PrevSubjectMap[S]>,
+      ): void
+      addAll<T extends keyof Chainable, S extends PrevSubject>(
+          options: CommandOptions & { prevSubject: S[] }, fns: CommandFnsWithSubject<PrevSubjectMap<void>[S]>,
+      ): void
       overwrite<T extends keyof Chainable>(name: T, fn: CommandFnWithOriginalFn<T>): void
       overwrite<T extends keyof Chainable, S extends PrevSubject>(name: T, fn: CommandFnWithOriginalFnAndSubject<T, PrevSubjectMap[S]>): void
     }
@@ -2987,11 +3001,11 @@ declare namespace Cypress {
 
   type DevServerConfigObject = {
     bundler: 'webpack'
-    framework: 'react'
+    framework: 'react' | 'vue' | 'vue-cli' | 'nuxt' | 'create-react-app'
     webpackConfig?: PickConfigOpt<'webpackConfig'>
   } | {
     bundler: 'vite'
-    framework: 'react'
+    framework: 'react' | 'vue'
     viteConfig?: Omit<Exclude<PickConfigOpt<'viteConfig'>, undefined>, 'base' | 'root'>
   }
 

diff --git a/cli/types/tests/cypress-tests.ts b/cli/types/tests/cypress-tests.ts
@@ -149,6 +149,118 @@ namespace CypressCommandsTests {
     arg
     return cy.wrap(new Promise<number>((resolve) => { resolve(5) }))
   })
+
+  Cypress.Commands.addAll({
+    newCommand(arg) {
+      // $ExpectType any
+      arg
+      this // $ExpectType Context
+      return
+    },
+    newCommand2(arg, arg2) {
+      // $ExpectType any
+      arg
+      // $ExpectType any
+      arg2
+    },
+    newCommand3: (arg) => {
+      // $ExpectType any
+      arg
+      return
+    },
+    newCommand4: (arg) => {
+      // $ExpectType any
+      arg
+    },
+  })
+  Cypress.Commands.addAll({ prevSubject: true }, {
+    newCommand: (subject, arg) => {
+      subject // $ExpectType unknown
+      arg // $ExpectType any
+      return
+    },
+  })
+  Cypress.Commands.addAll({ prevSubject: false }, {
+    newCommand: (arg) => {
+      arg // $ExpectType any
+      return
+    },
+  })
+  Cypress.Commands.addAll({ prevSubject: 'optional' }, {
+    newCommand: (subject, arg) => {
+      subject // $ExpectType unknown
+      arg // $ExpectType any
+      return
+    },
+    newCommand2: (subject, arg) => {
+      subject // $ExpectType unknown
+      arg // $ExpectType any
+    },
+  })
+  Cypress.Commands.addAll({ prevSubject: ['optional'] }, {
+    newCommand: (subject, arg) => {
+      subject // $ExpectType unknown
+      arg // $ExpectType any
+    },
+  })
+  Cypress.Commands.addAll({ prevSubject: 'document' }, {
+    newCommand: (subject, arg) => {
+      subject // $ExpectType Document
+      arg // $ExpectType any
+    },
+  })
+  Cypress.Commands.addAll({ prevSubject: 'window' }, {
+    newCommand: (subject, arg) => {
+      subject // $ExpectType Window
+      arg // $ExpectType any
+    },
+  })
+  Cypress.Commands.addAll({ prevSubject: 'element' }, {
+    newCommand: (subject, arg) => {
+      subject // $ExpectType JQuery<HTMLElement>
+      arg // $ExpectType any
+    }
+  })
+  Cypress.Commands.addAll({ prevSubject: ['element'] }, {
+    newCommand: (subject, arg) => {
+      subject // $ExpectType JQuery<HTMLElement>
+      arg // $ExpectType any
+    }
+  })
+  Cypress.Commands.addAll({ prevSubject: ['element', 'document', 'window'] }, {
+    newCommand: (subject, arg) => {
+      if (subject instanceof Window) {
+        subject // $ExpectType Window
+      } else if (subject instanceof Document) {
+        subject // $ExpectType Document
+      } else {
+        subject // $ExpectType JQuery<HTMLElement>
+      }
+      arg // $ExpectType any
+    }
+  })
+  Cypress.Commands.addAll({ prevSubject: ['window', 'document', 'optional', 'element'] }, {
+    newCommand: (subject, arg) => {
+      if (subject instanceof Window) {
+        subject // $ExpectType Window
+      } else if (subject instanceof Document) {
+        subject // $ExpectType Document
+      } else if (subject) {
+        subject // $ExpectType JQuery<HTMLElement>
+      } else {
+        subject // $ExpectType void
+      }
+      arg // $ExpectType any
+    }
+  })
+  Cypress.Commands.addAll({
+    newCommand: (arg) => {
+      // $ExpectType any
+      arg
+      return cy.wrap(new Promise<number>((resolve) => { resolve(5) }))
+    }
+  })
+
   Cypress.Commands.overwrite('newCommand', (originalFn, arg) => {
     arg // $ExpectType string
     originalFn // $ExpectedType Chainable['newCommand']

diff --git a/npm/angular/cypress/support/component-index.html b/npm/angular/cypress/support/component-index.html
@@ -7,6 +7,6 @@
     <title>Components App</title>
   </head>
   <body>
-    <div id="__cy_root"></div>
+    <div data-cy-root></div>
   </body>
-</html>
+</html>
diff --git a/npm/create-cypress-tests/src/component-testing/init-component-testing.test.ts b/npm/create-cypress-tests/src/component-testing/init-component-testing.test.ts
@@ -226,7 +226,7 @@ describe('init component tests script', () => {
     }) as any)
 
     await initComponentTesting({ config: {}, cypressConfigPath, useYarn: true })
-    expect(execStub).to.be.calledWith('yarn add @cypress/vue@3 --dev')
+    expect(execStub).to.be.calledWith('yarn add @cypress/vue --dev')
   })
 
   it('suggest the right instruction based on user template choice', async () => {

diff --git a/npm/create-cypress-tests/src/component-testing/installFrameworkAdapter.ts b/npm/create-cypress-tests/src/component-testing/installFrameworkAdapter.ts
@@ -48,10 +48,16 @@ type InstallAdapterOptions = {
   useYarn: boolean
 }
 
+const frameworkDependencies = {
+  react: '@cypress/react',
+  'vue@2': '@cypress/vue2',
+  'vue@3': '@cypress/vue',
+}
+
 export async function installFrameworkAdapter (cwd: string, options: InstallAdapterOptions) {
   const framework = await guessOrAskForFramework(cwd)
 
-  await installDependency(`@cypress/${framework}`, options)
+  await installDependency(frameworkDependencies[framework], options)
 
   return framework
 }
diff --git a/npm/design-system/cypress/support/component-index.html b/npm/design-system/cypress/support/component-index.html
@@ -7,6 +7,6 @@
     <title>Components App</title>
   </head>
   <body>
-    <div id="__cy_root"></div>
+    <div data-cy-root></div>
   </body>
 </html>