fix: cy.request allows nested objects as qs

[S-Tornqvist]

• Closes Array and Objects in "qs" params incorrectly parsed in cy.request() after updated to the latest Cypress version #27745

Additional details

cy.request() now correctly parses nested objects and arrays for the query string (qs), which is the intended behavior. The behavior was lost in 12.0.0 (see #27745). As the qs functionality is shared between cy.visit() and cy.request(), the behavior of cy.visit() also changes.

Note that the behavior only changes when using nested objects for the query string. Previously these would be parsed as "[object Object]", so no useful behavior is lost.

Steps to test

Example usage:

cy.request({
    url: "http://localhost:3000",
    qs: { foo: { bar: "baz" } }
});

How has the user experience changed?

na

PR Tasks

• Have tests been added/updated?
• [na] Has a PR for user-facing changes been opened in cypress-documentation?
• [na] Have API changes been updated in the type definitions?

[CLAassistant]

All committers have signed the CLA.

[cypress-app-bot]

• Create a Draft Pull Request if your PR is not ready for review. Mark the PR as Ready for Review when you're ready for a Cypress team member to review the PR.

[jennifer-shehane]

@S-Tornqvist Does this introduce a breaking change? I'd like tests around the change in visit behavior. Let us know when this is ready for review.

[S-Tornqvist]

@S-Tornqvist Does this introduce a breaking change? I'd like tests around the change in visit behavior. Let us know when this is ready for review.

Hi @jennifer-shehane,

I'm pretty new here so I was gonna finalize the draft and then ask some questions regarding the dependencies, changelog etc. I'm struggling a bit with the semantic pr check, but I'm getting there :) No breaking changes introduced, so I'll set the version to 13.3.1. Thanks for the heads up.

[S-Tornqvist]

@jennifer-shehane the pr is now ready for review. Tests for nested querystrings has been added to cy.request and cy.visit. Only the behavior for nested querystrings should be affected, and as these were previously serialized as "[object Object]" no useful behavior should be lost. Previous qs tests proves that non-nested behavior is unchanged

[S-Tornqvist]

@jennifer-shehane @AtofStryker @nagash77 could you review the pr?

[S-Tornqvist]

Is there anything I can do more or did wrong here? @jennifer-shehane

[AtofStryker]

@S-Tornqvist sorry for the delay in response here as I have been out of office for a few months. From a glance, the code looks fine and don't think it should introduce a breaking change as it is just serializing the nested object. I am going to pull from develop and get this PR running again!

[S-Tornqvist]

@S-Tornqvist sorry for the delay in response here as I have been out of office for a few months. From a glance, the code looks fine and don't think it should introduce a breaking change as it is just serializing the nested object. I am going to pull from develop and get this PR running again!

Thanks! I pulled develop and resolved the changelog conflict

[AtofStryker]

@S-Tornqvist looks like there is still a conflict?

[emilyrohrbough]

@jennifer-shehane @AtofStryker Changing the query parsing dependency would indeed be a breaking change. It would change the results of the parsed query people are expecting as a response. The cy.visit(), cy.intercept() and cy.request() query logic are not aligned, see: #19407.

[AtofStryker]

@jennifer-shehane @AtofStryker Changing the query parsing dependency would indeed be a breaking change. It would change the results of the parsed query people are expecting as a response. The cy.visit(), cy.intercept() and cy.request() query logic are not aligned, see: #19407.

Yeah this unfortunately seems to be the case 🙁 . I relooked and tracked my comment back to #20302 and missed the breaking change label. Sounds like we might need a broader strategy to align parsed queries through cy.visit(), cy.intercept() and cy.request() and verify complex query structures are serialized correctly and release in a major version?

[cypress-app-bot]

This PR has not had any activity in 180 days. If no activity is detected in the next 14 days, this PR will be closed.

[cypress-app-bot]

This PR has been closed due to inactivity