fix: disable automatic request retries #19161

flotwig · 2021-11-30T21:02:13Z

Closes Failed requests retry 25 times #19043
Makes Failed xhr calls can be matched up with later calls #19039 less likely to occur by reversing order that pre-requests are matched in: 6292de3

User facing changelog

Removed automatic retries for failed HTTP requests through the proxy. This fixes an issue where failed requests could be re-sent too many times in some conditions. This change could increase the number of failed requests that your app sees.
Reduced the occurrence of an issue where logs for fetch and xhr requests could be associated with the wrong request.

Additional details

This disables the proxy layer's automatic retries.
- Rationale: Failed requests retry 25 times #19043 (comment)
Automatic retries are still used for cy.visit's resolve:url and cy.request, since those are not retriable by the browser.
Fully removing automatic retries is a breaking change b/c we expose retryOnNetworkFailure and retryOnStatusCodeFailure as opts on cy.request, cy.visit
Has the potential to

How has the user experience changed?

PR Tasks

Have tests been added/updated?
Has the original issue (or this PR, if no issue exists) been tagged with a release in ZenHub? (user-facing changes only)
[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 · 2021-11-30T21:02:19Z

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 · 2021-11-30T21:17:56Z

Test summary

18709 • 0 • 202 • 0 • 0

Run details


Project	cypress
Status	Passed
Commit	`d618df3`
Started	Dec 8, 2021 3:46 PM
Ended	Dec 8, 2021 3:57 PM
Duration	11:21 💡
OS	Linux Debian - 10.10
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

mjhenkes · 2021-12-08T15:12:17Z

packages/server/lib/request.js

+
+    if (retryIntervals.length === 0) {
+      // normally, this request would not be retried, but we need to retry in order to support TLSv1
+      return onNext(0, 1)


what does onNext(0, 1) do? Is there a way we could make the code more descriptive?

cypress/packages/server/lib/request.js

Lines 284 to 288 in 9e4c13a

const retry = function (delay, attempt) {

retryStream.emit('retry', { attempt, delay })

return setTimeout(tryStartStream, delay)

}

So this runs a single retry instantly.

Is there a way we could make the code more descriptive?

So many ways. 😄 I started refactoring this file and it became a much bigger task, so I decided to keep this PR to the bare minimum changes. For now I pushed a commit to clean up onNext/onElse specifically: d618df3

mjhenkes · 2021-12-08T15:12:43Z

packages/driver/src/cy/commands/request.ts

@@ -28,6 +28,7 @@ const REQUEST_DEFAULTS = {
  timeout: null,
  followRedirect: true,
  failOnStatusCode: true,
+  retryIntervals: [0, 100, 200, 200],


Why are we adding retry intervals here and above?

Previously this would inherit from the defaults in server/lib/request, but now it has to set its own.

Automatic retries are still used for cy.visit's resolve:url and cy.request, since those are not retriable by the browser. Fully removing automatic retries is a breaking change b/c we expose retryOnNetworkFailure and retryOnStatusCodeFailure as opts on cy.request, cy.visit

tbiethman · 2021-12-08T20:33:04Z

packages/server/lib/request.js

@@ -281,7 +286,7 @@ const createRetryingRequestStream = function (opts = {}) {
    const reqStream = r(opts)
    let didReceiveResponse = false

-    const retry = function (delay, attempt) {
+    const retry = function ({ delay, attempt }) {


👍 to destructuring refactor

* develop: chore(deps): update dependency ssri to 6.0.2 [security] (#19351) chore: Fix server unit tests running on mac by using actual tmp dir (#19350) fix: Add more precise types to Cypress.Commands (#19003) fix: Do not screenshot or trigger the failed event when tests are skipped (#19331) fix (#19262) fix: throw when writing to 'read only' properties of `config` (#18896) fix: close chrome when closing electron (#19322) fix: disable automatic request retries (#19161) chore: refactor cy funcs (#19080) chore(deps): update dependency @ffmpeg-installer/ffmpeg to v1.1.0 🌟 (#19300)

…cycle * 10.0-release: build: remove syncRemoteGraphQL from codegen chore: fix incorrect type from merge build: allow work with local dashboard (#19376) chore: Test example recipes against chrome (#19362) test(unify): Settings e2e tests (#19324) chore(deps): update dependency ssri to 6.0.2 [security] (#19351) fix: spec from story generation, add deps for install (#19352) chore: Fix server unit tests running on mac by using actual tmp dir (#19350) fix: Add more precise types to Cypress.Commands (#19003) fix: Do not screenshot or trigger the failed event when tests are skipped (#19331) fix (#19262) fix: throw when writing to 'read only' properties of `config` (#18896) fix: close chrome when closing electron (#19322) fix: disable automatic request retries (#19161) chore: refactor cy funcs (#19080) chore(deps): update dependency @ffmpeg-installer/ffmpeg to v1.1.0 🌟 (#19300)

fix: disable automatic request retries

e8c01d8

flotwig added 9 commits December 7, 2021 10:11

fix TLSv1

ae7bda8

update request_spec

97bad5e

remove now invalid https_passthru_spec

9c019a7

Explicitly set retryIntervals for visit/request

b15d8b7

Update network_error_handling_spec

cf532de

Use same intervals as before

be07807

update request_spec

e5fa008

loosen up network_error_handling_spec

008613f

fix: match pre-requests in reverse order

6292de3

flotwig requested review from mjhenkes and tbiethman December 7, 2021 16:04

flotwig marked this pull request as ready for review December 7, 2021 16:04

fix does not connect to the upstream proxy for the SNI server request

d627123

mjhenkes reviewed Dec 8, 2021

View reviewed changes

flotwig requested a review from mjhenkes December 8, 2021 15:40

flotwig force-pushed the issue-19043-remove-request-retry branch from 5df0b86 to 2901f91 Compare December 8, 2021 15:40

rename onNext and onElse

d618df3

flotwig force-pushed the issue-19043-remove-request-retry branch from 2901f91 to d618df3 Compare December 8, 2021 15:41

mjhenkes approved these changes Dec 8, 2021

View reviewed changes

flotwig mentioned this pull request Dec 8, 2021

Failed xhr calls can be matched up with later calls #19039

Closed

tbiethman reviewed Dec 8, 2021

View reviewed changes

tbiethman approved these changes Dec 8, 2021

View reviewed changes

flotwig merged commit 65cf6e8 into develop Dec 8, 2021

flotwig deleted the issue-19043-remove-request-retry branch December 8, 2021 22:27

cypress-bot bot mentioned this pull request Dec 8, 2021

Failed requests retry 25 times #19043

Closed

ryanthemanuel mentioned this pull request Nov 22, 2022

cypress:server should really retry requests on network failures #24716

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: disable automatic request retries #19161

fix: disable automatic request retries #19161

flotwig commented Nov 30, 2021 •

edited

cypress-bot bot commented Nov 30, 2021

cypress bot commented Nov 30, 2021 •

edited

mjhenkes Dec 8, 2021

flotwig Dec 8, 2021 •

edited

mjhenkes Dec 8, 2021

flotwig Dec 8, 2021

tbiethman Dec 8, 2021

	const retry = function (delay, attempt) {
	retryStream.emit('retry', { attempt, delay })

	return setTimeout(tryStartStream, delay)
	}

fix: disable automatic request retries #19161

fix: disable automatic request retries #19161

Conversation

flotwig commented Nov 30, 2021 • edited

User facing changelog

Additional details

How has the user experience changed?

PR Tasks

cypress-bot bot commented Nov 30, 2021

cypress bot commented Nov 30, 2021 • edited

Test summary

Run details

mjhenkes Dec 8, 2021

Choose a reason for hiding this comment

flotwig Dec 8, 2021 • edited

Choose a reason for hiding this comment

mjhenkes Dec 8, 2021

Choose a reason for hiding this comment

flotwig Dec 8, 2021

Choose a reason for hiding this comment

tbiethman Dec 8, 2021

Choose a reason for hiding this comment

flotwig commented Nov 30, 2021 •

edited

cypress bot commented Nov 30, 2021 •

edited

flotwig Dec 8, 2021 •

edited