@commercetools-frontend/cypress 24.7.1 → 24.8.0

package/add-commands/dist/commercetools-frontend-cypress-add-commands.cjs.prod.js

@@ -15,9 +15,7 @@ var _URL = require('@babel/runtime-corejs3/core-js-stable/url');
 var semver = require('semver');
 var constants$1 = require('../../dist/constants-2f1475a6.cjs.prod.js');
 var _slicedToArray = require('@babel/runtime-corejs3/helpers/slicedToArray');
-var _mapInstanceProperty = require('@babel/runtime-corejs3/core-js-stable/instance/map');
 var _Array$from = require('@babel/runtime-corejs3/core-js-stable/array/from');
-var _entriesInstanceProperty = require('@babel/runtime-corejs3/core-js-stable/instance/entries');
 var _reduceRightInstanceProperty = require('@babel/runtime-corejs3/core-js-stable/instance/reduce-right');
 
 function _interopDefault (e) { return e && e.__esModule ? e : { 'default': e }; }
@@ -33,9 +31,7 @@ var _Object$defineProperty__default = /*#__PURE__*/_interopDefault(_Object$defin
 var _findInstanceProperty__default = /*#__PURE__*/_interopDefault(_findInstanceProperty);
 var _URL__default = /*#__PURE__*/_interopDefault(_URL);
 var semver__default = /*#__PURE__*/_interopDefault(semver);
-var _mapInstanceProperty__default = /*#__PURE__*/_interopDefault(_mapInstanceProperty);
 var _Array$from__default = /*#__PURE__*/_interopDefault(_Array$from);
-var _entriesInstanceProperty__default = /*#__PURE__*/_interopDefault(_entriesInstanceProperty);
 var _reduceRightInstanceProperty__default = /*#__PURE__*/_interopDefault(_reduceRightInstanceProperty);
 
 function ownKeys$1(e, r) { var t = _Object$keys__default["default"](e); if (_Object$getOwnPropertySymbols__default["default"]) { var o = _Object$getOwnPropertySymbols__default["default"](e); r && (o = _filterInstanceProperty__default["default"](o).call(o, function (r) { return _Object$getOwnPropertyDescriptor__default["default"](e, r).enumerable; })), t.push.apply(t, o); } return t; }
@@ -48,12 +44,7 @@ function _objectSpread$1(e) { for (var r = 1; r < arguments.length; r++) { var _
 // Alias for backwards compatibility
 
 const defaultTimeouts = {
-  waitForEmailInput: 4000,
-  waitForPasswordInput: 8000,
-  waitForElement: 15000,
-  waitForUrl: 15000,
-  waitForRedirect: 3000,
-  waitForIdentityRedirect: 8000
+  waitForRedirectToLogin: 1000
 };
 function isFeatureSupported(expectedVersion) {
   return semver__default["default"].gte(Cypress.version, expectedVersion);
@@ -83,9 +74,9 @@ function loginByForm(commandOptions) {
   {
     log: false
   }).then(appConfig => {
-    let url = `/${projectKey}/${commandOptions.entryPointUriPath}`;
+    let initialUriPath = `/${projectKey}/${commandOptions.entryPointUriPath}`;
     if (commandOptions.entryPointUriPath === 'account') {
-      url = `/${commandOptions.entryPointUriPath}`;
+      initialUriPath = `/${commandOptions.entryPointUriPath}`;
     }
 
     // Log loaded application config for debugging purposes.
@@ -104,7 +95,7 @@ function loginByForm(commandOptions) {
      * The function is used by Cypress `session` command to store the
      * browser state after executing the authentication flow.
      */
-    function authCallback() {
+    function sessionAuthCallback() {
       // Get the feature flags from the Merchant Center API so we can
       // check whether Identity is enabled
       cy.request({
@@ -112,7 +103,7 @@ function loginByForm(commandOptions) {
         url: `${appConfig.mcApiUrl}/graphql`,
         body: {
           operationName: 'AllFeatures',
-          query: `query AllFeatures { allFeatures { name value reason } }`
+          query: `query AllFeatures { allFeatures { name value } }`
         },
         headers: {
           'content-type': 'application/json',
@@ -130,11 +121,6 @@ function loginByForm(commandOptions) {
         });
         const identityUrl = Cypress.env('IDENTITY_URL') || 'https://identity.commercetools.com';
 
-        // Visit the application URL, which triggers then the login flow.
-        cy.visit(url, {
-          onBeforeLoad: commandOptions.onBeforeLoad
-        });
-
         /**
          * There are different scenarios and variations on the flow depending
          * on the environment (localhost, production) and if Identity is enabled.
@@ -172,79 +158,60 @@ function loginByForm(commandOptions) {
          */
 
         if (isLocalhost) {
+          // Visit the special endpoint /api/health to ensure that the primary origin is set to localhost.
+          cy.visit('/api/health');
+          // Visit the application URL, which triggers then the login flow.
+          cy.visit(initialUriPath, {
+            onBeforeLoad: commandOptions.onBeforeLoad
+          });
+          // Cypress gets confused when switching between origins, likely because
+          // the redirect to Identity/MC doesn't happen immediately.
+          // If we don't wait, Cypress fails as it tries to interact with `cy.origin`
+          // but the test is still in the initial origin URL.
+          // This is a bit unexpected and to be considered a workaround.
+          // eslint-disable-next-line cypress/no-unnecessary-waiting
+          cy.wait(commandOptions.timeouts?.waitForRedirectToLogin ?? defaultTimeouts.waitForRedirectToLogin);
           if (isGlobalIdentityEnabled) {
-            // Cypress gets confused when switching between origins, likely because
-            // the redirect to Identity doesn't happen immediately.
-            // If we don't wait, Cypress fails as it tries to interact with `cy.origin`
-            // but the test is still in the initial origin URL.
-            // This is a bit unexpected and to be considered a workaround.
-            // eslint-disable-next-line cypress/no-unnecessary-waiting
-            cy.wait(1000);
-
             // Use cy.origin to handle the identity domain
             cy.origin(identityUrl, {
               args: {
                 userCredentials,
-                identityUrl,
-                timeouts: commandOptions.timeouts,
-                defaultTimeouts
+                identityUrl
               }
             }, _ref => {
               let userCredentials = _ref.userCredentials,
-                identityUrl = _ref.identityUrl,
-                timeouts = _ref.timeouts,
-                defaultTimeouts = _ref.defaultTimeouts;
+                identityUrl = _ref.identityUrl;
               cy.url().should('include', `${identityUrl}/login`);
               // Fill in the email and click Next
-              cy.get('input[name="identifier"]', {
-                timeout: timeouts?.waitForEmailInput ?? defaultTimeouts.waitForEmailInput
-              }).type(userCredentials.email);
+              cy.get('input[name="identifier"]').type(userCredentials.email);
               cy.get('button').contains('Next').click();
 
               // Wait for the password form to appear
-              cy.get('input[name="password"]', {
-                timeout: timeouts?.waitForPasswordInput ?? defaultTimeouts.waitForPasswordInput
-              }).should('be.visible');
+              cy.get('input[name="password"]').should('be.visible');
               // Fill in the password and submit
               cy.get('input[name="password"]').type(userCredentials.password, {
-                log: false
+                log: false,
+                force: true
+              });
+              cy.get('button').contains('Submit').click({
+                force: true
               });
-              cy.get('button').contains('Submit').click();
             });
-
-            // Wait for the flow to redirect back to the application.
-            // eslint-disable-next-line cypress/no-unnecessary-waiting
-            cy.wait(commandOptions.timeouts?.waitForRedirect ?? defaultTimeouts.waitForRedirect);
-            cy.get('[role="main"]', {
-              timeout: commandOptions.timeouts?.waitForElement ?? defaultTimeouts.waitForElement
-            }).should('exist');
-            cy.url({
-              timeout: commandOptions.timeouts?.waitForUrl ?? defaultTimeouts.waitForUrl
-            }).should('include', url);
           } else {
             const mcUrl = appConfig.mcApiUrl.replace('mc-api', 'mc');
-            // See similar comment above regarding the usage of `cy.wait`.
-            // eslint-disable-next-line cypress/no-unnecessary-waiting
-            cy.wait(1000);
             cy.origin(mcUrl, {
               args: {
                 userCredentials,
-                mcUrl,
-                timeouts: commandOptions.timeouts,
-                defaultTimeouts
+                mcUrl
               }
             }, _ref2 => {
               let userCredentials = _ref2.userCredentials,
-                mcUrl = _ref2.mcUrl,
-                timeouts = _ref2.timeouts,
-                defaultTimeouts = _ref2.defaultTimeouts;
+                mcUrl = _ref2.mcUrl;
               cy.url().should('include', `${mcUrl}/login`);
 
               // Same as `fillLegacyLoginFormWithRetry`.
               // eslint-disable-next-line cypress/unsafe-to-chain-command
-              cy.get('input[name=email]', {
-                timeout: timeouts?.waitForEmailInput ?? defaultTimeouts.waitForEmailInput
-              })
+              cy.get('input[name=email]')
               // We use `force` as the MC login UI (production) in tests renders the
               // cookie banner overlapping the input fields.
               // To allow Cypress to interact with the input fields, we use `force`.
@@ -254,9 +221,7 @@ function loginByForm(commandOptions) {
                 force: true
               });
               // eslint-disable-next-line cypress/unsafe-to-chain-command
-              cy.get('input[name=password]', {
-                timeout: timeouts?.waitForPasswordInput ?? defaultTimeouts.waitForPasswordInput
-              })
+              cy.get('input[name=password]')
               // We use `force` as the MC login UI (production) in tests renders the
               // cookie banner overlapping the input fields.
               // To allow Cypress to interact with the input fields, we use `force`.
@@ -270,70 +235,56 @@ function loginByForm(commandOptions) {
                 force: true
               });
             });
-            // eslint-disable-next-line cypress/no-unnecessary-waiting
-            cy.wait(1000);
-
-            // Wait for the flow to redirect back to the application.
-            cy.get('[role="main"]').should('exist');
-            cy.url().should('include', url);
           }
+          // Wait for the flow to redirect back to the application.
+          cy.get('[role="main"]').should('exist');
+          cy.url().should('include', initialUriPath);
         } else {
+          // Ensure the primary origin is set to MC.
+          cy.visit(new _URL__default["default"]('/health', Cypress.config('baseUrl')).toString());
           if (isGlobalIdentityEnabled) {
-            // Wait for redirect to Identity to complete
-            // eslint-disable-next-line cypress/no-unnecessary-waiting
-            cy.wait(commandOptions.timeouts?.waitForIdentityRedirect ?? defaultTimeouts.waitForIdentityRedirect);
-            cy.url({
-              timeout: commandOptions.timeouts?.waitForUrl ?? defaultTimeouts.waitForUrl
-            }).should('include', `${identityUrl}/login`);
-            // Fill in the email and click Next
-            cy.get('input[name="identifier"]', {
-              timeout: commandOptions.timeouts?.waitForEmailInput ?? defaultTimeouts.waitForEmailInput
-            }).type(userCredentials.email);
-            cy.get('button').contains('Next').click();
-
-            // Wait for the password form to appear
-            cy.get('input[name="password"]', {
-              timeout: commandOptions.timeouts?.waitForPasswordInput ?? defaultTimeouts.waitForPasswordInput
-            }).should('be.visible');
-            // Fill in the password and submit
-            cy.get('input[name="password"]').type(userCredentials.password, {
-              log: false
-            });
-            cy.get('button').contains('Submit').click({
-              force: true
-            });
-
-            // Wait for redirect to start
-            // eslint-disable-next-line cypress/no-unnecessary-waiting
-            cy.wait(commandOptions.timeouts?.waitForRedirect ?? defaultTimeouts.waitForRedirect);
+            const identityArgs = {
+              email: userCredentials.email,
+              password: userCredentials.password,
+              returnTo: new _URL__default["default"](initialUriPath, Cypress.config('baseUrl')).toString()
+            };
+
+            // Perform the login flow through Identity.
+            cy.origin('https://identity.commercetools.com', {
+              args: identityArgs
+            }, args => {
+              cy.visit({
+                url: `/login`,
+                qs: {
+                  returnTo: args.returnTo
+                }
+              });
+              // Fill in the email and click Next
+              cy.get('input[name="identifier"]').type(args.email);
+              cy.get('button').contains('Next').click();
 
-            // Wait for the flow to redirect back to the application.
-            cy.origin(Cypress.config('baseUrl'), {
-              args: {
-                url,
-                timeouts: commandOptions.timeouts,
-                defaultTimeouts
-              }
-            }, _ref3 => {
-              let url = _ref3.url,
-                timeouts = _ref3.timeouts,
-                defaultTimeouts = _ref3.defaultTimeouts;
-              // Wait for application to fully load
-              cy.get('[role="main"]', {
-                timeout: timeouts?.waitForElement ?? defaultTimeouts.waitForElement
-              }).should('exist');
-              cy.url({
-                timeout: timeouts?.waitForUrl ?? defaultTimeouts.waitForUrl
-              }).should('include', url);
+              // Wait for the password form to appear
+              cy.get('input[name="password"]').should('be.visible');
+              // Fill in the password and submit
+              cy.get('input[name="password"]').type(args.password, {
+                log: false,
+                force: true
+              });
+              cy.get('button').contains('Submit').click({
+                force: true
+              });
             });
           } else {
             // Legacy login flow.
-            fillLegacyLoginFormWithRetry(userCredentials, commandOptions.timeouts);
-
-            // Wait for the flow to redirect back to the application.
-            cy.get('[role="main"]').should('exist');
-            cy.url().should('include', url);
+            // Visit the application URL, which triggers then the login flow.
+            cy.visit(initialUriPath, {
+              onBeforeLoad: commandOptions.onBeforeLoad
+            });
+            fillLegacyLoginFormWithRetry(userCredentials);
           }
+          // Wait for the flow to redirect back to the application.
+          cy.get('[role="main"]').should('exist');
+          cy.url().should('include', initialUriPath);
         }
       });
     }
@@ -341,18 +292,26 @@ function loginByForm(commandOptions) {
     // For backwards compatibility.
     if (isFeatureSupported('12.0.0') || Cypress.config('experimentalSessionAndOrigin')) {
       // https://www.cypress.io/blog/2021/08/04/authenticate-faster-in-tests-cy-session-command/
-      cy.session(sessionKey, authCallback, isFeatureSupported('10.9.0') ? {
+      cy.session(sessionKey, sessionAuthCallback, isFeatureSupported('10.9.0') ? {
         cacheAcrossSpecs: typeof commandOptions.disableCacheAcrossSpecs === 'boolean' ? !commandOptions.disableCacheAcrossSpecs : true
+        // TODO: enable it once Identity is enabled by default.
+        // validate() {
+        //   if (isLocalhost) {
+        //     return;
+        //   }
+        //   // Verify that the session is valid (session cookie is included in the request).
+        //   cy.request(new URL('/whoami', appConfig.mcApiUrl).toString())
+        //     .its('status')
+        //     .should('eq', 200);
+        // },
       } : undefined);
     } else {
       cy.log(`We recommend to use "cy.session" to reduce the time to log in between tests. Make sure to have at least Cypress v12 or enable it via "experimentalSessionAndOrigin" for older Cypress versions.`);
-      authCallback();
+      sessionAuthCallback();
     }
     if (commandOptions.initialRoute) {
       cy.visit(`${Cypress.config('baseUrl')}${commandOptions.initialRoute}`);
-      cy.url({
-        timeout: commandOptions.timeouts?.waitForUrl ?? defaultTimeouts.waitForUrl
-      }).should('include', commandOptions.initialRoute);
+      cy.url().should('include', commandOptions.initialRoute);
     }
   });
 }
@@ -360,7 +319,7 @@ function loginByForm(commandOptions) {
 /* Utilities */
 
 const legacyMaxLoginAttempts = Cypress.config('maxLoginAttempts') ?? 3;
-function fillLegacyLoginFormWithRetry(userCredentials, timeouts) {
+function fillLegacyLoginFormWithRetry(userCredentials) {
   // Intercept the login request so we can retry it if we receive a TOO_MANY_REQUESTS status code
   cy.intercept('POST', '**/tokens').as('loginRequest');
   function getRandomDelayInSeconds() {
@@ -375,17 +334,13 @@ function fillLegacyLoginFormWithRetry(userCredentials, timeouts) {
     cy.log(`Attempts left: ${attemptsLeft}`);
 
     // eslint-disable-next-line cypress/unsafe-to-chain-command
-    cy.get('input[name=email]', {
-      timeout: timeouts?.waitForEmailInput ?? defaultTimeouts.waitForEmailInput
-    }).clear({
+    cy.get('input[name=email]').clear({
       force: true
     }).type(userCredentials.email, {
       force: true
     });
     // eslint-disable-next-line cypress/unsafe-to-chain-command
-    cy.get('input[name=password]', {
-      timeout: timeouts?.waitForPasswordInput ?? defaultTimeouts.waitForPasswordInput
-    }).clear({
+    cy.get('input[name=password]').clear({
       force: true
     }).type(userCredentials.password, {
       log: false,
@@ -485,7 +440,7 @@ function scrollIntoView(htmlElement) {
 // for cross origin domains .frameElement returns null so query using parentWindow
 // but when running using --disable-web-security it will return the frame element
 function getFrameElement(currentWindow) {
-  var _context, _context2;
+  var _context;
   if (currentWindow.frameElement) {
     // accessible for same-origin iframes
     // or when running with --disable-web-security
@@ -494,11 +449,7 @@ function getFrameElement(currentWindow) {
 
   // fallback to querying using the parent window, mainly to grab the AUT iframe
   const iframeElements = currentWindow.parent.document.querySelectorAll('iframe');
-  return _findInstanceProperty__default["default"](_context = _mapInstanceProperty__default["default"](_context2 = _Array$from__default["default"](_entriesInstanceProperty__default["default"](iframeElements).call(iframeElements))).call(_context2, _ref => {
-    let _ref2 = _slicedToArray(_ref, 2),
-      element = _ref2[1];
-    return element;
-  })).call(_context, element => element.contentWindow === currentWindow);
+  return _findInstanceProperty__default["default"](_context = _Array$from__default["default"](iframeElements)).call(_context, element => element.contentWindow === currentWindow);
 }
 function getIframesPositionShift(element) {
   let currentWindow = element.ownerDocument.defaultView;
@@ -520,10 +471,10 @@ function getIframesPositionShift(element) {
     }
     currentWindow = currentWindow.parent;
   }
-  return _reduceRightInstanceProperty__default["default"](iframes).call(iframes, (_ref3, frame) => {
-    let frameX = _ref3.frameX,
-      frameY = _ref3.frameY,
-      frameScale = _ref3.frameScale;
+  return _reduceRightInstanceProperty__default["default"](iframes).call(iframes, (_ref, frame) => {
+    let frameX = _ref.frameX,
+      frameY = _ref.frameY,
+      frameScale = _ref.frameScale;
     const _frame$getBoundingCli = frame.getBoundingClientRect(),
       x = _frame$getBoundingCli.x,
       y = _frame$getBoundingCli.y,