Flake with location object

[bahmutov]

Cypress v7.3.0

Reproducible example in https://github.com/bahmutov/cypress-ethereal-email-example/tree/location-flake

The test redirects from localhost to localhost /confirm through Sendgrid URL. Sometimes it works, sometimes it does not (even though the page does load fine)

When it fails it shows

Almost like it has temporary blip with the location object and does not retry getting it again

[bahmutov]

Found that when failing, it has an empty string

const getLocation = () => {
    const location = cy.getRemoteLocation()
    console.log('location "%s" %s', location.toString(), JSON.stringify(location))

     return _.isString(key)
        // use existential here because we only want to throw
        // on null or undefined values (and not empty strings)
          ? location[key] ?? $errUtils.throwErrByPath('location.invalid_key', { args: { key, location } })
          : location
}

[bahmutov]

Adding guard like this seems to solve the problem and let the test retry

const location = cy.getRemoteLocation()
     console.log('location "%s" %s', location.toString(), JSON.stringify(location))
     if (location === '') {
        return null
     }
}

[bahmutov]

Intersting to see how we go from the local domain to 3rd party domain (probably causing "" location) and then back to the local domain with full location object

[cypress-bot]

The code for this is done in cypress-io/cypress#16772, but has yet to be released.
We'll update this issue and reference the changelog when it's released.

[cypress-bot]

Released in 7.5.0.

This comment thread has been locked. If you are still experiencing this issue after upgrading to
Cypress v7.5.0, please open a new issue.