feat(testing): Cypress 12 Support (#14058)

packages/cypress/migrations.json

@@ -35,6 +35,12 @@
       "version": "15.1.0-beta.0",
       "description": "Update to Cypress v11. This migration will only update if the workspace is already on v10. https://www.cypress.io/blog/2022/11/04/upcoming-changes-to-component-testing/",
       "factory": "./src/migrations/update-15-1-0/cypress-11"
+    },
+    "update-to-cypress-12": {
+      "cli": "nx",
+      "version": "15.5.0-beta.0",
+      "description": "Update to Cypress v12. Cypress 12 contains a handful of breaking changes that might causes tests to start failing that nx cannot directly fix. Read more Cypress 12 changes: https://docs.cypress.io/guides/references/migration-guide#Migrating-to-Cypress-12-0.This migration will only run if you are already using Cypress v11.",
+      "factory": "./src/migrations/update-15-5-0/update-to-cypress-12"
     }
   },
   "packageJsonUpdates": {}

packages/cypress/package.json

@@ -43,7 +43,7 @@
     "semver": "7.3.4"
   },
   "peerDependencies": {
-    "cypress": ">= 3 < 12"
+    "cypress": ">= 3 < 13"
   },
   "peerDependenciesMeta": {
     "cypress": {

packages/cypress/src/generators/migrate-to-cypress-11/migrate-to-cypress-11.ts

@@ -120,7 +120,7 @@ https://nx.dev/cypress/v10-migration-guide
   );
 
   updateJson(tree, 'package.json', (json) => {
-    json.devDependencies['cypress'] = cypressVersion;
+    json.devDependencies['cypress'] = '^11.2.0';
     return json;
   });
 

packages/cypress/src/migrations/update-15-5-0/__snapshots__/update-to-cypress-12.spec.ts.snap

@@ -0,0 +1,87 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`Cypress 12 Migration should migrate to cy 12 1`] = `
+"describe('something', () => {
+  it('should do the thing', () => {
+    // TODO(@nrwl/cypress): this command has been removed, use cy.session instead. https://docs.cypress.io/guides/references/migration-guide#Command-Cypress-API-Changes
+Cypress.Cookies.defaults()
+    // TODO(@nrwl/cypress): this command has been removed, use cy.session instead. https://docs.cypress.io/guides/references/migration-guide#Command-Cypress-API-Changes
+Cypress.Cookies.preserveOnce('seesion_id', 'remember-token');
+    Cypress.blah.abc() 
+    // TODO(@nrwl/cypress): this command has been removed, use cy.intercept instead. https://docs.cypress.io/guides/references/migration-guide#cy-server-cy-route-and-Cypress-Server-defaults
+Cypress.Server.defaults({
+     delay: 500,
+     method: 'GET',
+   })
+   // TODO(@nrwl/cypress): this command has been removed, use cy.intercept instead. https://docs.cypress.io/guides/references/migration-guide#cy-server-cy-route-and-Cypress-Server-defaults
+cy.server()
+   // TODO(@nrwl/cypress): this command has been removed, use cy.intercept instead. https://docs.cypress.io/guides/references/migration-guide#cy-server-cy-route-and-Cypress-Server-defaults
+cy.route(/api/, () => {
+      return {
+        'test': 'We’ll',
+      }
+    }).as('getApi')
+ 
+    cy.visit('/index.html')
+    cy.window().then((win) => {
+      const xhr = new win.XMLHttpRequest
+      xhr.open('GET', '/api/v1/foo/bar?a=42')
+      xhr.send()
+    })
+
+    cy.wait('@getApi')
+   .its('url').should('include', 'api/v1')
+    /**
+* TODO(@nrwl/cypress): Nesting Cypress commands in a should assertion now throws.
+* You should use .then() to chain commands instead.
+* More Info: https://docs.cypress.io/guides/references/migration-guide#-should
+**/
+cy.should(($s) => {
+      cy.get('@table').find('tr').should('have.length', 3)
+})
+  })
+})"
+`;
+
+exports[`Cypress 12 Migration should migrate to cy 12 2`] = `
+"describe('something', () => {
+  it('should do the thing', () => {
+    // TODO(@nrwl/cypress): this command has been removed, use cy.session instead. https://docs.cypress.io/guides/references/migration-guide#Command-Cypress-API-Changes
+Cypress.Cookies.defaults()
+    // TODO(@nrwl/cypress): this command has been removed, use cy.session instead. https://docs.cypress.io/guides/references/migration-guide#Command-Cypress-API-Changes
+Cypress.Cookies.preserveOnce('seesion_id', 'remember-token');
+    Cypress.blah.abc() 
+    // TODO(@nrwl/cypress): this command has been removed, use cy.intercept instead. https://docs.cypress.io/guides/references/migration-guide#cy-server-cy-route-and-Cypress-Server-defaults
+Cypress.Server.defaults({
+     delay: 500,
+     method: 'GET',
+   })
+   // TODO(@nrwl/cypress): this command has been removed, use cy.intercept instead. https://docs.cypress.io/guides/references/migration-guide#cy-server-cy-route-and-Cypress-Server-defaults
+cy.server()
+   // TODO(@nrwl/cypress): this command has been removed, use cy.intercept instead. https://docs.cypress.io/guides/references/migration-guide#cy-server-cy-route-and-Cypress-Server-defaults
+cy.route(/api/, () => {
+      return {
+        'test': 'We’ll',
+      }
+    }).as('getApi')
+ 
+    cy.visit('/index.html')
+    cy.window().then((win) => {
+      const xhr = new win.XMLHttpRequest
+      xhr.open('GET', '/api/v1/foo/bar?a=42')
+      xhr.send()
+    })
+
+    cy.wait('@getApi')
+   .its('url').should('include', 'api/v1')
+    /**
+* TODO(@nrwl/cypress): Nesting Cypress commands in a should assertion now throws.
+* You should use .then() to chain commands instead.
+* More Info: https://docs.cypress.io/guides/references/migration-guide#-should
+**/
+cy.should(($s) => {
+      cy.get('@table').find('tr').should('have.length', 3)
+})
+  })
+})"
+`;

packages/cypress/src/migrations/update-15-5-0/helpers.ts

@@ -0,0 +1,38 @@
+import type { Node } from 'typescript';
+
+export function isAlreadyCommented(node: Node) {
+  return node.getFullText().includes('TODO(@nrwl/cypress)');
+}
+
+export const BANNED_COMMANDS = [
+  'as',
+  'children',
+  'closest',
+  'contains',
+  'debug',
+  'document',
+  'eq',
+  'filter',
+  'find',
+  'first',
+  'focused',
+  'get',
+  'hash',
+  'its',
+  'last',
+  'location',
+  'next',
+  'nextAll',
+  'not',
+  'parent',
+  'parents',
+  'parentsUntil',
+  'prev',
+  'prevUntil',
+  'root',
+  'shadow',
+  'siblings',
+  'title',
+  'url',
+  'window',
+];