fix(net-stubbing): fix waiting on responses with no-body status codes #9097

flotwig · 2020-11-04T20:26:54Z

User facing changelog

Fixed an issue where HTTP responses that cannot have a body (like HTTP 304 and HTTP 204) could not be awaited using cy.intercept.
Fixed an issue where HTTP redirects could not be awaited using cy.intercept unless dynamically intercepted.

Additional details

tricky because internally, Node.js treats 304s differently from 204s
also tricky because the fix for End proxied responses for 1xx, 204, 304 with no body, fix bug where cy server could be proxied #4358 had to be maintained or else the 5 second timeout continues

How has the user experience changed?

PR Tasks

test from RWA issue has been resolved fix(net-stubbing): fix waiting on responses with no-body status codes #9097 (comment)
Have tests been added/updated?
Has the original issue or this PR been tagged with a release in ZenHub?
[na] Has a PR for user-facing changes been opened in cypress-documentation?
[na] Have API changes been updated in the type definitions?
[na] Have new configuration options been added to the cypress.schema.json?

cypress-bot · 2020-11-04T20:26:56Z

Thanks for taking the time to open a PR!

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.
Become familiar with the Code Review Checklist for guidelines on coding standards and what needs to be done before a PR can be merged.

cypress · 2020-11-04T20:46:15Z

Test summary

4446 • 0 • 49 • 2

Run details


Project	cypress
Status	Passed
Commit	`1657874`
Started	Dec 2, 2020 6:41 PM
Ended	Dec 2, 2020 6:52 PM
Duration	11:02 💡
OS	Linux Debian - 10.5
Browser	Multiple

View run in Cypress Dashboard ➡️

This comment has been generated by cypress-bot as a result of this project's GitHub integration settings. You can manage this integration in this project's settings in the Cypress Dashboard

eilgin · 2020-11-24T08:26:42Z

Hello @flotwig, i've just seen that cypress is now launching 6.0 (congrats!). I'd like to know if this PR is still relevant?

flotwig · 2020-11-24T15:55:45Z

Hello @flotwig, i've just seen that cypress is now launching 6.0 (congrats!). I'd like to know if this PR is still relevant?

@eilgin yep, this is still a work in progress, i hope to get it in the next release

bahmutov · 2020-12-01T20:59:06Z

packages/network/lib/http-utils.ts

+const NO_BODY_STATUS_CODES = [204, 304]
+
+export function responseMustHaveEmptyBody (req: IncomingMessage, res: IncomingMessage) {
+  return _.some([_.includes(NO_BODY_STATUS_CODES, res.statusCode), _.invoke(req.method, 'toLowerCase') === 'head'])


wow, some people write such interesting code just to avoid ||

job security

packages/network/lib/http-utils.ts

kevinold · 2020-12-01T21:56:01Z

@flotwig It appears that 302 POST's might also be grouped into this. See this failure when attempting to cy.intercept for /logout in the RWA.

cypress-io/cypress-realworld-app@1b54220

Test to reproduce the issue: https://github.com/cypress-io/cypress-realworld-app/pull/676/files#diff-8781249f032a90ab825382873828906eed104c18c2a93d20e9de10b4872b0df6R143

bahmutov

Works, verified against 304 in cypress-io/cypress-example-recipes#598

flotwig · 2020-12-02T16:58:46Z

@flotwig It appears that 302 POST's might also be grouped into this. See this failure when attempting to cy.intercept for /logout in the RWA.

nice, i was able to reproduce this with a simple cy.intercept('/redirect'), and it led me to fixing the underlying logic issue that was causing #8999 along with your issue with redirects. So this PR should also fix waiting on redirects.

Funnily enough, if you intercept the redirect, it does work as-is:

cypress/packages/driver/cypress/integration/commands/net_stubbing_spec.ts

Lines 1274 to 1290 in c0e14ea

    
           it('intercepts redirects as expected', function () { 
        
             const href = `/fixtures/generic.html?t=${Date.now()}` 
        
             const url = `/redirect?href=${encodeURIComponent(href)}` 
        
             cy.intercept('/redirect', (req) => { 
        
               req.reply((res) => { 
        
                 expect(res.statusCode).to.eq(301) 
        
                 expect(res.headers.location).to.eq(href) 
        
                 res.send() 
        
               }) 
        
             }) 
        
             .as('redirect') 
        
             .intercept('/fixtures/generic.html').as('dest') 
        
             .then(() => fetch(url)) 
        
             .wait('@redirect') 
        
             .wait('@dest') 
        
           })

bahmutov

nice

…cypress#9097

…to come in 6.1.0

* wip - convert cy.route to cy.http; remove cy.server; adjust to use JSON.parse() * fix delete bankaccounts route * fix empty list test using cy.http * wip - experiments * uncomment wait * reproduction and notes around cy.http issue with public transactions stub * set run mode to not retry * remove only * rename cy.http to cy.intercept * remove JSON.parse per cypress-io/cypress-example-kitchensink#458 * update to get user id if not 401 response * add glob-match to usersSearch for cy.intercept * wip - iterate * install nocache * configure routes not to cache (temporarily) * note about failing cy.intercept for POST /logout * adjust cy.intercepts; notes on open Cypress issues * update matching for stubbed public transactions * restore to substring match for mocked response * uninstall and remove nocache for routes since resolved in cypress-io/cypress#9097 * adjust to use response.statusCode for fix in cypress-io/cypress#9097 to come in 6.1.0 * update syntax and expectation * delete if-none-match request header to prevent cached results for cy.wait * update to use regex for cy.intercept url matchers; delete if-none-match request header to prevent cached results for cy.wait * update /notifications to delete if-none-match request header to prevent cached results for cy.wait * cleanup and remove if-none-match for all feed routes, but continues to return 304 * refactor to delete if-none-match for all routes in a global beforeEach * restore limit to 10 * update route matching to be exact * update to get url from response object * update to use response.statusCode * update transaction view spec to use response.statusCode * update intercepts to use minimatch * cleanup * cleanup * example of res.send fixture not returning fixture * add delay middleware for all mobile viewport tests * cleanup * cleanup * update mobile cy.intercept to throttle all routes * fix syntax error * update from throttle -> setThrottle * update matching for global intercepts * update path matching * update matching for global intercepts * update intercept matching * temporary disable throttling for mobile * fix patch matching * update matching for cy.intercept * wait for public transactions Co-authored-by: Amir Rustamzadeh <amir@cypress.io>

flotwig changed the title ~~fix(route2): fix waiting on responses that send no body~~ fix(route2): fix waiting on responses with no-body status codes Nov 4, 2020

flotwig mentioned this pull request Nov 5, 2020

fix: Add missing "waited" state to the driver #9096

Closed

5 tasks

flotwig force-pushed the issue-8999 branch from 764283a to ccc2982 Compare December 1, 2020 20:16

flotwig marked this pull request as ready for review December 1, 2020 20:38

flotwig requested a review from bahmutov December 1, 2020 20:47

bahmutov reviewed Dec 1, 2020

View reviewed changes

flotwig commented Dec 1, 2020

View reviewed changes

packages/network/lib/http-utils.ts Outdated Show resolved Hide resolved

bahmutov self-requested a review December 2, 2020 02:25

bahmutov previously approved these changes Dec 2, 2020

View reviewed changes

kevinold mentioned this pull request Dec 2, 2020

Migrate from cy.route to cy.intercept for 7.x release cypress-io/cypress-realworld-app#676

Merged

6 tasks

fix the underlying issue for all response types

c0e14ea

flotwig dismissed bahmutov’s stale review via c0e14ea December 2, 2020 16:58

flotwig force-pushed the issue-8999 branch from 97668f2 to c0e14ea Compare December 2, 2020 16:58

flotwig changed the title ~~fix(route2): fix waiting on responses with no-body status codes~~ fix(net-stubbing): fix waiting on responses with no-body status codes Dec 2, 2020

flotwig requested a review from bahmutov December 2, 2020 17:33

clean up

3b3b07e

bahmutov previously approved these changes Dec 2, 2020

View reviewed changes

can't use optional chaining

1657874

flotwig dismissed bahmutov’s stale review via 1657874 December 2, 2020 17:47

flotwig merged commit 810a9b4 into develop Dec 2, 2020

This was referenced Dec 2, 2020

Route returning 204 (No content) can't be waited for with route2 #8999

Closed

cy.route2 times out waiting for image load #8934

Closed

kevinold pushed a commit to cypress-io/cypress-realworld-app that referenced this pull request Dec 3, 2020

uninstall and remove nocache for routes since resolved in cypress-io/…

fae229f

…cypress#9097

kevinold pushed a commit to cypress-io/cypress-realworld-app that referenced this pull request Dec 3, 2020

adjust to use response.statusCode for fix in cypress-io/cypress#9097 …

da1d2d4

…to come in 6.1.0

flotwig deleted the issue-8999 branch January 24, 2022 18:14

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(net-stubbing): fix waiting on responses with no-body status codes #9097

fix(net-stubbing): fix waiting on responses with no-body status codes #9097

flotwig commented Nov 4, 2020 •

edited

Loading

cypress-bot bot commented Nov 4, 2020

cypress bot commented Nov 4, 2020 •

edited

Loading

eilgin commented Nov 24, 2020

flotwig commented Nov 24, 2020

bahmutov Dec 1, 2020

flotwig Dec 1, 2020

kevinold commented Dec 1, 2020

bahmutov left a comment

flotwig commented Dec 2, 2020 •

edited

Loading

bahmutov left a comment

fix(net-stubbing): fix waiting on responses with no-body status codes #9097

fix(net-stubbing): fix waiting on responses with no-body status codes #9097

Conversation

flotwig commented Nov 4, 2020 • edited Loading

User facing changelog

Additional details

How has the user experience changed?

PR Tasks

cypress-bot bot commented Nov 4, 2020

cypress bot commented Nov 4, 2020 • edited Loading

Test summary

Run details

eilgin commented Nov 24, 2020

flotwig commented Nov 24, 2020

bahmutov Dec 1, 2020

Choose a reason for hiding this comment

flotwig Dec 1, 2020

Choose a reason for hiding this comment

kevinold commented Dec 1, 2020

bahmutov left a comment

Choose a reason for hiding this comment

flotwig commented Dec 2, 2020 • edited Loading

bahmutov left a comment

Choose a reason for hiding this comment

flotwig commented Nov 4, 2020 •

edited

Loading

cypress bot commented Nov 4, 2020 •

edited

Loading

flotwig commented Dec 2, 2020 •

edited

Loading