Implement proper server-side streaming for `application/grpc-web+proto` content-type
johanbrandhorst opened this issue · 10 comments
As mentioned in the README, the grpcweb mode only supports unary method calls. It should at the very least also support server streaming calls.
The problem there is the binary format - currently the XHR API does not return back partial chunked response if the response body is binary. Hence the current default mode for gRPC-Web is grpcwebtext (or basically application/grpc-web-text). This is somewhat covered in this old issue #87.
@stanley-cheung It's possible to use fetch for server side stream? Yes, some inconsistency, but feature will be works
@pumano my understanding is that relying on fetch will compromise browser support. I think the more interesting angle right now is trying to get something like #87 (comment) merged into the closure XHR library. What do you think @stanley-cheung?
Actually I tried that 'hack' a while ago and it didn't work. Do you have more details about that?
Pinging @jonny-improbable, @MarcusLongmuir, @easyCZ, @mwitkow
I'd be really interested in seeing a fetch implementation, even if it requires some sort of flag to select. Afaik XHR will keep the full response in-memory as long as the request is in progress, therefore for long-lived server streaming methods (such as subscription-style notifications endpoints) grpc-web is untenable.
We're using improbably-eng's grpc-web fetch transport and it works great. Would move over to code from this repository as soon as there's a fetch implementation!
@jared2501 Yes, we are working on this.
Binary streams support hasn't been a priority for us as we use a yet-to-be-published text based encoding format for protobuf. Also cookie domains can't serve binary data due to security issues.
The main use case to support fetch is to run grpc-web from service workers. The buffering issue is definitely a concern too.
OTOH, long-lived server-push will have other issues to deal with, e.g. keep-alive. We plan to publish a spec for this soon.
Any ETA on implementing this please ?
I can see 'accept': 'application/grpc-web-text' reaching the server, but on streaming the browser does not get the "data" callbacks on a message, until the stream ends or the next message arrived.
Envoy proxy is allowing it through as below, protoc used with "mode=grpcwebtext"
allow_headers: keep-alive,user-agent,cache-control,content-type,content-transfer-encoding,custom-header-1,x-accept-content-transfer-encoding,x-accept-response-streaming,x-user-agent,x-grpc-web,grpc-timeout expose_headers: grpc-status,grpc-message
@descalzi you might have envoy misconfigured if it isn't handling translating the grpc-web traffic into grpc.
That said, this specific issue is about supporting the binary format for streaming though - your comment suggests you are using grpc-text, which should definitely be supported.
I see whats going on, even with grpc-text, the xhr call doesnt look at partial data, so it doesnt work for real streaming scenarios, where the connection is open for long.
The data callback is received when the final headers are sent, the streaming stops, or enough data is received that the "buffer?" is full and its then read. But for a single message, say, in a long sleep while loop .. it doesnt callback