Testing Multiple Domains with Cypress


Photo by Alp Duran on Unsplash


As you probably might have heard already, Cypress has released version 9.6.0 which finally allows testing for multiple domains! This is probably one of the most requested features from the community (support visiting multiple super domains in one test) and looking at this issue raised in their Github repo in 2017, it was pretty exciting to see that this is now supported in their latest release. Really well done to the Cypress team for getting this out! 🥳


In this quick blog post, I'll look at how to use the new command `cy.origin()` and show you how you can test multiple domains with this experimental command.


Use cases for multiple domains

Cypress has documented some common workarounds on how users can test scenarios encompassing multiple domains but if we want to automate the scenarios from how our users will use it, it's still a good idea to automate it from the UI. Be mindful though that driving everything from the UI has its own challenges so it's still a great idea to utilise the workarounds and leveraging API calls if possible.


Common use cases for testing multiple domains include:

  • Visiting more than one super domain as part of your test

  • Interacting with components that are from a cross-origin iframe

  • Payment workflow journey using third party applications

  • Login authentication using third parties


Getting Started

To get started, you need to update the Cypress version that you are using to version 9.6.0. Once you have done that, you need to enable `experimentalSessionAndOrigin` in your cypress.json file.


Setting experimentalSessionAndOrigin property to true
Enable experimental session and origin feature

Introducing cy.origin()

Let's look into a scenario where you need to visit another super domain as part of your test.



Before cy.origin() was introduced, this was a hard limitation and you are faced with this dreaded cross-origin error if you are trying to visit two super domains in a single test.

Stack trace error when visiting different domains
cross-origin error when visiting different super domains

With the experimental cy.origin() command, you can now get rid of this error. Let's have a look at how we can achieve this with the code snippet below.


The cy.origin accepts two arguments by default. The first argument is the URL specifying the secondary origin in which the callback is to be executed. Note that this is just setting the origin of the new domain and not visiting the new domain as of yet. The second argument is the callback to be executed which contains additional actions that I want to do in the new origin.


There is also an optional and third argument that you can pass which can be used for passing in additional configurations to your origin callback. For example, in the code snippet below, I am passing the SITE_HEADER variable instead and also explicitly passing this to my callback function. The reasoning for this has been documented here - Using dynamic data in a secondary origin.



When I run my test, I should see that it's now passing and I'm now able to successfully visit multiple super domains 🥳


Cypress Test Runner with multiple domain test
Multiple domain workflow in Cypress

Note that adding additional commands outside the cy.origin() code block will execute actions against the original origin (the original domain).


Feedback

Since this is an experimental feature, the Cypress team needs your feedback if there are any issues that you are facing while trying out cy.origin(). There's already some issues logged with Microsoft and Google authentication so if you have any feature requests, log it as part of this Github issue.


Resources

For further reading and resources, check out the following links:

1,269 views1 comment