Response body sometimes not displayed in console props for xhr request

[mschile]

Current behavior

The response body is not always displayed in the console props for xhr requests. There appears to be a race condition between the xhr request finishing and the proxy sending the response:received event.

Proxy sends the response:received event:

cypress/packages/proxy/lib/http/request-middleware.ts

Lines 51 to 57 in aa6f3b8

	this.res.on('close', () => {
	this.socket.toDriver('request:event', 'response:received', {
	requestId,
	headers: this.res.getHeaders(),
	status: this.res.statusCode,
	})
	})

Call made to update the console props after receiving the event:

cypress/packages/driver/src/cypress/proxy-logging.ts

Line 336 in aa6f3b8

proxyRequest.updateConsoleProps()

Console props are updated with the xhr values. However, if the xhr isn't fully complete (i.e. readystate === DONE), then these values are not valid.

cypress/packages/driver/src/cypress/proxy-logging.ts

Lines 226 to 231 in aa6f3b8

	if (this.xhr) {
	if (!consoleProps['Response Headers']) consoleProps['Response Headers'] = this.xhr.responseHeaders
	if (!consoleProps['Response Status Code']) consoleProps['Response Status Code'] = this.xhr.xhr.status
	consoleProps['Response Body'] = this.xhr.xhr.response

This is causing flake in the following test:

Correct console props:

Incorrect console props:

Desired behavior

Console props always contains the xhr response body.

Test code to reproduce

Run the following test multiple times until it fails:

cypress/packages/driver/cypress/integration/cypress/proxy-logging_spec.ts

Line 153 in aa6f3b8

it('xhr log has response body/status code when xhr response is logged second', (done) => {

Cypress Version

develop

Other

No response

[cypress-bot]

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

[cypress-bot]

Released in 9.6.1.

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