Bug 227030 – REGRESSION (r275496): WebSocket Message too long when message is larger than 1mb

• Component: Page Loading
• Status: RESOLVED FIXED

[Licat]

Created attachment 431441 [details]
Steps to reproduce

Overview: Starting in iOS 15 Beta, whenever a WebSocket receives a message of size 1,048,549 bytes or more, even if from multiple frames, it will terminate the connection with error 1009 (Message too big).
This wasn't the case in any previous builds.

Steps to reproduce:
- Create a WebSocket echo server using any language (A good sample can be found at https://www.npmjs.com/package/ws#simple-server)
- Using the remote debugger console, create a WebSocket and send a short message, observe that the message is sent back.
- Send a message of size 1,048,549 or larger, observe that the message is sent, and the connection is immediately terminated with "The operation couldn't be completed (kNWErrorDomainPOSIX error 40 - Message too long)"
- Observe from the server that the client disconnected with error 1009 (Message too long).

I find that 1mb is quite a low limit, if that's intended to limit memory consumption. For any use cases involving sending significant amount of data, this would need to be worked around by concatenating multiple messages, which will end up consuming a lot more memory anyway.

[Licat]

Correction from last post: The message size should be 1,048,577 or larger, corresponding to 1024*1024+1, as opposed to 1,048,549

[Radar WebKit Bug Importer]

<rdar://problem/79370994>

[Alex Christensen]

I'm able to send and receive messages larger than 1MB.  This might need more investigation.  Licat, are you able to provide a self-contained example website where we can see the issue?

[Licat]

I've hosted a temp site on aws at:

http://18.237.249.65:8888/

The script on the site sends a blob of 1048577 "x" characters, and the server echos it back.

I've actually gotten reports from others that this only happens on some devices. One of my contacts said that the bug only occurred on their iOS 15 device but not iPadOS 15 device, while another ran into this issue on an iPad.

[Chris Dumez]

On my phone with iOS 15, I get “error: undefined”. I guess that means I reproduced?

[Chris Dumez]

(In reply to Chris Dumez from comment #5)
> On my phone with iOS 15, I get “error: undefined”. I guess that means I
> reproduced?

I got the same error on an iPad Pro.

[Licat]

A correct run should print the following:

CONNECTED
SENT: 1048577 bytes
RESPONSE: 1048577 bytes
DISCONNECTED

It would probably help to check Safari's remote inspector and have a look at the WebSocket frames. The behavior should be a similar to the attached screenshot.

[Chris Dumez]

Could be an IPC issue.

[Steve Dunham]

A few more details - I wrote a websocket echo server in Go (gorilla/websocket) to help Licat diagnose this. The client was an iPad Pro with iOS 15.0 (19A5261w). The attached jpeg reflects my testing.

In my initial test, I had the server relay the message as-is. If it was larger than 1048576 bytes, the server received the message, sent the response, and got an EPIPE.  Via the remote dev tools, MobileSafari reported the following and closed the connection:

[Error] WebSocket connection to 'ws://arbol.local:8080/echo' failed: The operation couldn’t be completed. (kNWErrorDomainPOSIX error 40 - Message too long)

I then adjusted the server code to fragment the message into maximum 512kb fragments. After sending the last fragment of a 1048577 byte message, the server received a 1009 error and MobileSafari didn't register any response or error (looking at the network pane in the remote dev tools). At that point, MobileSafari thought the connection was still open (readyState = 1) and let me send messages without error, even after I killed the server.

The same testing on dev console in Safari Technology Preview on Big Sur worked flawlessly. (The messages were received by the server, sent back to the browser, and logged.)

[Steve Dunham]

Created attachment 431516 [details]
Echo server with no fragmentation

Attached is the echo server, without fragmentation, that I used in testing.  It can be started with "go run ." within the directory and will listen on port 8080.

The test was the sequence of manual javascript commands shown in the jpeg attached to this issue.

[Steve Dunham]

Created attachment 431517 [details]
Echo server with fragmentation

This is the echo server, with fragmentation, that I used in testing.  It can be started with "go run ." within the directory and will listen on port 8080.

[Chris Dumez]

Easily reproducible for me with http://18.237.249.65:8888/, even on macOS. I am bisecting to find the regression point.

[youenn fablet]

Can you disable Nsurlsession web socket experimental feature and try reproing?

[Chris Dumez]

(In reply to youenn fablet from comment #13)
> Can you disable Nsurlsession web socket experimental feature and try
> reproing?

Regression range:
https://trac.webkit.org/log/webkit/trunk?mode=follow_copy&rev=275500&stop_rev=275491

most likely a regression from trac.webkit.org/r275496.

[Chris Dumez]

Confirmed regression from https://trac.webkit.org/changeset/275496.

[Alex Christensen]

Thanks for providing that server.  The test server I was using was using deflate, so I was "receiving" over 1MB messages fine but only a few bytes were actually going over the network because it compressed so well.  Your server doesn't use deflate, so it hits this failure mode.

I've investigated this issue and found a fix with a test.

[Alex Christensen]

Created attachment 431740 [details]
Patch

[Alex Christensen]

Created attachment 431744 [details]
Patch

[Chris Dumez]

Comment on attachment 431744 [details]
Patch

View in context: https://bugs.webkit.org/attachment.cgi?id=431744&action=review

> Tools/ChangeLog:17
> [phone]  Alex Christensen  <[e-mail]>

double changelog.

[Alex Christensen]

Created attachment 431746 [details]
Patch

[Alex Christensen]

Created attachment 431747 [details]
Patch

[Alex Christensen]

Created attachment 431778 [details]
Patch

[youenn fablet]

Comment on attachment 431778 [details]
Patch

View in context: https://bugs.webkit.org/attachment.cgi?id=431778&action=review

> Source/WebKit/ChangeLog:14
> +        The test used to fail using our NSURLSession-based WebSocket implementation but now passes everywhere.

LayoutTests/imported/w3c/web-platform-tests/websockets/handlers/send-backpressure_wsh.py is triggering the bug for me.

[EWS]

Committed r279069 (238989@main): <https://commits.webkit.org/238989@main>

All reviewed patches have been landed. Closing bug and clearing flags on attachment 431778 [details].