From 74897b2cc9e73e6b41340b31508e1d2d295d5263 Mon Sep 17 00:00:00 2001 From: minoic Date: Mon, 16 Dec 2024 09:15:03 -0800 Subject: [PATCH 1/8] update: Migrate off legacy JS/HTML apis --- lib/grpc_or_grpcweb.dart | 4 +- lib/src/client/transport/xhr_transport.dart | 77 +++++++++++---------- pubspec.yaml | 1 + 3 files changed, 43 insertions(+), 39 deletions(-) diff --git a/lib/grpc_or_grpcweb.dart b/lib/grpc_or_grpcweb.dart index b23bed5d..dffbde2e 100644 --- a/lib/grpc_or_grpcweb.dart +++ b/lib/grpc_or_grpcweb.dart @@ -13,8 +13,8 @@ // See the License for the specific language governing permissions and // limitations under the License. -import 'src/client/grpc_or_grpcweb_channel_grpc.dart' - if (dart.library.html) 'src/client/grpc_or_grpcweb_channel_web.dart'; +import 'src/client/grpc_or_grpcweb_channel_web.dart' + if (dart.library.io) 'src/client/grpc_or_grpcweb_channel_grpc.dart'; import 'src/client/http2_channel.dart'; import 'src/client/options.dart'; diff --git a/lib/src/client/transport/xhr_transport.dart b/lib/src/client/transport/xhr_transport.dart index 16b0dca5..d3293e8e 100644 --- a/lib/src/client/transport/xhr_transport.dart +++ b/lib/src/client/transport/xhr_transport.dart @@ -14,10 +14,11 @@ // limitations under the License. import 'dart:async'; -import 'dart:html'; +import 'dart:js_interop'; import 'dart:typed_data'; import 'package:meta/meta.dart'; +import 'package:web/web.dart'; import '../../client/call.dart'; import '../../shared/message.dart'; @@ -30,7 +31,7 @@ import 'web_streams.dart'; const _contentTypeKey = 'Content-Type'; class XhrTransportStream implements GrpcTransportStream { - final HttpRequest _request; + final XMLHttpRequest _request; final ErrorHandler _onError; final Function(XhrTransportStream stream) _onDone; bool _headersReceived = false; @@ -45,23 +46,22 @@ class XhrTransportStream implements GrpcTransportStream { @override StreamSink> get outgoingMessages => _outgoingMessages.sink; - XhrTransportStream(this._request, - {required ErrorHandler onError, required onDone}) + XhrTransportStream(this._request, {required ErrorHandler onError, required onDone}) : _onError = onError, _onDone = onDone { _outgoingMessages.stream .map(frame) - .listen((data) => _request.send(data), cancelOnError: true); + .listen((data) => _request.send(Int8List.fromList(data).toJS), cancelOnError: true, onError: _onError); - _request.onReadyStateChange.listen((data) { + _request.onReadyStateChange.listen((_) { if (_incomingProcessor.isClosed) { return; } switch (_request.readyState) { - case HttpRequest.HEADERS_RECEIVED: + case 2: _onHeadersReceived(); break; - case HttpRequest.DONE: + case 4: _onRequestDone(); _close(); break; @@ -72,8 +72,7 @@ class XhrTransportStream implements GrpcTransportStream { if (_incomingProcessor.isClosed) { return; } - _onError(GrpcError.unavailable('XhrConnection connection-error'), - StackTrace.current); + _onError(GrpcError.unavailable('XhrConnection connection-error'), StackTrace.current); terminate(); }); @@ -81,27 +80,21 @@ class XhrTransportStream implements GrpcTransportStream { if (_incomingProcessor.isClosed) { return; } - // Use response over responseText as most browsers don't support - // using responseText during an onProgress event. - final responseString = _request.response as String; - final bytes = Uint8List.fromList( - responseString.substring(_requestBytesRead).codeUnits) - .buffer; - _requestBytesRead = responseString.length; + final responseText = _request.responseText; + final bytes = Uint8List.fromList(responseText.substring(_requestBytesRead).codeUnits).buffer; + _requestBytesRead = responseText.length; _incomingProcessor.add(bytes); }); _incomingProcessor.stream .transform(GrpcWebDecoder()) .transform(grpcDecompressor()) - .listen(_incomingMessages.add, - onError: _onError, onDone: _incomingMessages.close); + .listen(_incomingMessages.add, onError: _onError, onDone: _incomingMessages.close); } bool _validateResponseState() { try { - validateHttpStatusAndContentType( - _request.status, _request.responseHeaders, + validateHttpStatusAndContentType(_request.status, _parseHeaders(_request.getAllResponseHeaders()), rawResponse: _request.responseText); return true; } catch (e, st) { @@ -115,17 +108,15 @@ class XhrTransportStream implements GrpcTransportStream { if (!_validateResponseState()) { return; } - _incomingMessages.add(GrpcMetadata(_request.responseHeaders)); + _incomingMessages.add(GrpcMetadata(_parseHeaders(_request.getAllResponseHeaders()))); } void _onRequestDone() { if (!_headersReceived && !_validateResponseState()) { return; } - if (_request.response == null) { - _onError( - GrpcError.unavailable('XhrConnection request null response', null, - _request.responseText), + if (_request.status != 200) { + _onError(GrpcError.unavailable('Request failed with status: ${_request.status}', null, _request.responseText), StackTrace.current); return; } @@ -137,6 +128,20 @@ class XhrTransportStream implements GrpcTransportStream { _onDone(this); } + Map _parseHeaders(String rawHeaders) { + final headers = {}; + final lines = rawHeaders.split('\r\n'); + for (var line in lines) { + final index = line.indexOf(': '); + if (index != -1) { + final key = line.substring(0, index); + final value = line.substring(index + 2); + headers[key] = value; + } + } + return headers; + } + @override Future terminate() async { _close(); @@ -153,24 +158,24 @@ class XhrClientConnection implements ClientConnection { @override String get authority => uri.authority; + @override String get scheme => uri.scheme; - void _initializeRequest(HttpRequest request, Map metadata) { - for (final header in metadata.keys) { - request.setRequestHeader(header, metadata[header]!); - } + void _initializeRequest(XMLHttpRequest request, Map metadata) { + metadata.forEach((key, value) { + request.setRequestHeader(key, value); + }); // Overriding the mimetype allows us to stream and parse the data request.overrideMimeType('text/plain; charset=x-user-defined'); request.responseType = 'text'; } @visibleForTesting - HttpRequest createHttpRequest() => HttpRequest(); + XMLHttpRequest createHttpRequest() => XMLHttpRequest(); @override - GrpcTransportStream makeRequest(String path, Duration? timeout, - Map metadata, ErrorHandler onError, + GrpcTransportStream makeRequest(String path, Duration? timeout, Map metadata, ErrorHandler onError, {CallOptions? callOptions}) { // gRPC-web headers. if (_getContentTypeHeader(metadata) == null) { @@ -180,8 +185,7 @@ class XhrClientConnection implements ClientConnection { } var requestUri = uri.resolve(path); - if (callOptions is WebCallOptions && - callOptions.bypassCorsPreflight == true) { + if (callOptions is WebCallOptions && callOptions.bypassCorsPreflight == true) { requestUri = cors.moveHttpHeadersToQueryParam(metadata, requestUri); } @@ -193,8 +197,7 @@ class XhrClientConnection implements ClientConnection { // Must set headers after calling open(). _initializeRequest(request, metadata); - final transportStream = - XhrTransportStream(request, onError: onError, onDone: _removeStream); + final transportStream = XhrTransportStream(request, onError: onError, onDone: _removeStream); _requests.add(transportStream); return transportStream; } diff --git a/pubspec.yaml b/pubspec.yaml index 8c393dba..cde369f2 100644 --- a/pubspec.yaml +++ b/pubspec.yaml @@ -17,6 +17,7 @@ dependencies: http2: ^2.2.0 protobuf: '>=2.0.0 <4.0.0' clock: ^1.1.1 + web: ^1.0.0 dev_dependencies: build_runner: ^2.0.0 From d49f9f7414872fae994e8cc490579ad41e72d9bd Mon Sep 17 00:00:00 2001 From: minoic Date: Mon, 16 Dec 2024 09:15:03 -0800 Subject: [PATCH 2/8] update: use dart.library.js_interop in place of dart.library.html --- CHANGELOG.md | 1 + lib/grpc_or_grpcweb.dart | 4 ++-- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 684f1d6a..368ef92e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,7 @@ * When the keep alive manager runs into a timeout, it will finish the transport instead of closing the connection, as defined in the gRPC spec. * Upgrade to `package:lints` version 5.0.0 and Dart SDK version 3.5.0. +* Update xhr transport to migrate off legacy JS/HTML apis. ## 4.0.1 diff --git a/lib/grpc_or_grpcweb.dart b/lib/grpc_or_grpcweb.dart index dffbde2e..049ceabf 100644 --- a/lib/grpc_or_grpcweb.dart +++ b/lib/grpc_or_grpcweb.dart @@ -13,8 +13,8 @@ // See the License for the specific language governing permissions and // limitations under the License. -import 'src/client/grpc_or_grpcweb_channel_web.dart' - if (dart.library.io) 'src/client/grpc_or_grpcweb_channel_grpc.dart'; +import 'src/client/grpc_or_grpcweb_channel_grpc.dart' + if (dart.library.js_interop) 'src/client/grpc_or_grpcweb_channel_web.dart'; import 'src/client/http2_channel.dart'; import 'src/client/options.dart'; From 8313a4dc79590de0453e0178de1611b9210cbaf7 Mon Sep 17 00:00:00 2001 From: minoic Date: Mon, 16 Dec 2024 09:15:03 -0800 Subject: [PATCH 3/8] update: dart format xhr_transport.dart and update dart sdk to v3.4.0 in workflows --- lib/src/client/transport/xhr_transport.dart | 44 ++++++++++++++------- 1 file changed, 30 insertions(+), 14 deletions(-) diff --git a/lib/src/client/transport/xhr_transport.dart b/lib/src/client/transport/xhr_transport.dart index d3293e8e..69cb78a8 100644 --- a/lib/src/client/transport/xhr_transport.dart +++ b/lib/src/client/transport/xhr_transport.dart @@ -46,12 +46,14 @@ class XhrTransportStream implements GrpcTransportStream { @override StreamSink> get outgoingMessages => _outgoingMessages.sink; - XhrTransportStream(this._request, {required ErrorHandler onError, required onDone}) + XhrTransportStream(this._request, + {required ErrorHandler onError, required onDone}) : _onError = onError, _onDone = onDone { - _outgoingMessages.stream - .map(frame) - .listen((data) => _request.send(Int8List.fromList(data).toJS), cancelOnError: true, onError: _onError); + _outgoingMessages.stream.map(frame).listen( + (data) => _request.send(Int8List.fromList(data).toJS), + cancelOnError: true, + onError: _onError); _request.onReadyStateChange.listen((_) { if (_incomingProcessor.isClosed) { @@ -72,7 +74,8 @@ class XhrTransportStream implements GrpcTransportStream { if (_incomingProcessor.isClosed) { return; } - _onError(GrpcError.unavailable('XhrConnection connection-error'), StackTrace.current); + _onError(GrpcError.unavailable('XhrConnection connection-error'), + StackTrace.current); terminate(); }); @@ -81,7 +84,9 @@ class XhrTransportStream implements GrpcTransportStream { return; } final responseText = _request.responseText; - final bytes = Uint8List.fromList(responseText.substring(_requestBytesRead).codeUnits).buffer; + final bytes = Uint8List.fromList( + responseText.substring(_requestBytesRead).codeUnits) + .buffer; _requestBytesRead = responseText.length; _incomingProcessor.add(bytes); }); @@ -89,12 +94,14 @@ class XhrTransportStream implements GrpcTransportStream { _incomingProcessor.stream .transform(GrpcWebDecoder()) .transform(grpcDecompressor()) - .listen(_incomingMessages.add, onError: _onError, onDone: _incomingMessages.close); + .listen(_incomingMessages.add, + onError: _onError, onDone: _incomingMessages.close); } bool _validateResponseState() { try { - validateHttpStatusAndContentType(_request.status, _parseHeaders(_request.getAllResponseHeaders()), + validateHttpStatusAndContentType( + _request.status, _parseHeaders(_request.getAllResponseHeaders()), rawResponse: _request.responseText); return true; } catch (e, st) { @@ -108,7 +115,8 @@ class XhrTransportStream implements GrpcTransportStream { if (!_validateResponseState()) { return; } - _incomingMessages.add(GrpcMetadata(_parseHeaders(_request.getAllResponseHeaders()))); + _incomingMessages + .add(GrpcMetadata(_parseHeaders(_request.getAllResponseHeaders()))); } void _onRequestDone() { @@ -116,7 +124,11 @@ class XhrTransportStream implements GrpcTransportStream { return; } if (_request.status != 200) { - _onError(GrpcError.unavailable('Request failed with status: ${_request.status}', null, _request.responseText), + _onError( + GrpcError.unavailable( + 'Request failed with status: ${_request.status}', + null, + _request.responseText), StackTrace.current); return; } @@ -162,7 +174,8 @@ class XhrClientConnection implements ClientConnection { @override String get scheme => uri.scheme; - void _initializeRequest(XMLHttpRequest request, Map metadata) { + void _initializeRequest( + XMLHttpRequest request, Map metadata) { metadata.forEach((key, value) { request.setRequestHeader(key, value); }); @@ -175,7 +188,8 @@ class XhrClientConnection implements ClientConnection { XMLHttpRequest createHttpRequest() => XMLHttpRequest(); @override - GrpcTransportStream makeRequest(String path, Duration? timeout, Map metadata, ErrorHandler onError, + GrpcTransportStream makeRequest(String path, Duration? timeout, + Map metadata, ErrorHandler onError, {CallOptions? callOptions}) { // gRPC-web headers. if (_getContentTypeHeader(metadata) == null) { @@ -185,7 +199,8 @@ class XhrClientConnection implements ClientConnection { } var requestUri = uri.resolve(path); - if (callOptions is WebCallOptions && callOptions.bypassCorsPreflight == true) { + if (callOptions is WebCallOptions && + callOptions.bypassCorsPreflight == true) { requestUri = cors.moveHttpHeadersToQueryParam(metadata, requestUri); } @@ -197,7 +212,8 @@ class XhrClientConnection implements ClientConnection { // Must set headers after calling open(). _initializeRequest(request, metadata); - final transportStream = XhrTransportStream(request, onError: onError, onDone: _removeStream); + final transportStream = + XhrTransportStream(request, onError: onError, onDone: _removeStream); _requests.add(transportStream); return transportStream; } From 609d725e340df61187eea33d6f93a0a4c1c3bf96 Mon Sep 17 00:00:00 2001 From: minoic Date: Mon, 16 Dec 2024 09:15:03 -0800 Subject: [PATCH 4/8] update: use if instead of switch case in xhr_transport.dart --- lib/src/client/transport/xhr_transport.dart | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-) diff --git a/lib/src/client/transport/xhr_transport.dart b/lib/src/client/transport/xhr_transport.dart index 69cb78a8..1de0eb78 100644 --- a/lib/src/client/transport/xhr_transport.dart +++ b/lib/src/client/transport/xhr_transport.dart @@ -59,14 +59,12 @@ class XhrTransportStream implements GrpcTransportStream { if (_incomingProcessor.isClosed) { return; } - switch (_request.readyState) { - case 2: - _onHeadersReceived(); - break; - case 4: - _onRequestDone(); - _close(); - break; + // TODO: dart-lang/web#285 use 'if' for now + if (_request.readyState == XMLHttpRequest.HEADERS_RECEIVED) { + _onHeadersReceived(); + } else if (_request.readyState == XMLHttpRequest.DONE) { + _onRequestDone(); + _close(); } }); From 20bd1737c4cf9c20e78cb1222f0c9b984dcab11a Mon Sep 17 00:00:00 2001 From: minoic Date: Mon, 16 Dec 2024 09:15:03 -0800 Subject: [PATCH 5/8] update: upgrade web package to v1.1.0 --- lib/src/client/transport/xhr_transport.dart | 33 +++++++-------------- pubspec.yaml | 2 +- 2 files changed, 11 insertions(+), 24 deletions(-) diff --git a/lib/src/client/transport/xhr_transport.dart b/lib/src/client/transport/xhr_transport.dart index 1de0eb78..e41a7f39 100644 --- a/lib/src/client/transport/xhr_transport.dart +++ b/lib/src/client/transport/xhr_transport.dart @@ -59,12 +59,14 @@ class XhrTransportStream implements GrpcTransportStream { if (_incomingProcessor.isClosed) { return; } - // TODO: dart-lang/web#285 use 'if' for now - if (_request.readyState == XMLHttpRequest.HEADERS_RECEIVED) { - _onHeadersReceived(); - } else if (_request.readyState == XMLHttpRequest.DONE) { - _onRequestDone(); - _close(); + switch (_request.readyState) { + case XMLHttpRequest.HEADERS_RECEIVED: + _onHeadersReceived(); + break; + case XMLHttpRequest.DONE: + _onRequestDone(); + _close(); + break; } }); @@ -99,7 +101,7 @@ class XhrTransportStream implements GrpcTransportStream { bool _validateResponseState() { try { validateHttpStatusAndContentType( - _request.status, _parseHeaders(_request.getAllResponseHeaders()), + _request.status, _request.responseHeaders, rawResponse: _request.responseText); return true; } catch (e, st) { @@ -113,8 +115,7 @@ class XhrTransportStream implements GrpcTransportStream { if (!_validateResponseState()) { return; } - _incomingMessages - .add(GrpcMetadata(_parseHeaders(_request.getAllResponseHeaders()))); + _incomingMessages.add(GrpcMetadata(_request.responseHeaders)); } void _onRequestDone() { @@ -138,20 +139,6 @@ class XhrTransportStream implements GrpcTransportStream { _onDone(this); } - Map _parseHeaders(String rawHeaders) { - final headers = {}; - final lines = rawHeaders.split('\r\n'); - for (var line in lines) { - final index = line.indexOf(': '); - if (index != -1) { - final key = line.substring(0, index); - final value = line.substring(index + 2); - headers[key] = value; - } - } - return headers; - } - @override Future terminate() async { _close(); diff --git a/pubspec.yaml b/pubspec.yaml index cde369f2..02b3047a 100644 --- a/pubspec.yaml +++ b/pubspec.yaml @@ -17,7 +17,7 @@ dependencies: http2: ^2.2.0 protobuf: '>=2.0.0 <4.0.0' clock: ^1.1.1 - web: ^1.0.0 + web: ^1.1.0 dev_dependencies: build_runner: ^2.0.0 From 00a012a55fb8613c8c0e4e58ee9ab498cffb6a6d Mon Sep 17 00:00:00 2001 From: Aran Donohue Date: Mon, 16 Dec 2024 09:15:03 -0800 Subject: [PATCH 6/8] refactor: use Uint8List for sending data over XHR rather than Int8List --- lib/src/client/transport/xhr_transport.dart | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/src/client/transport/xhr_transport.dart b/lib/src/client/transport/xhr_transport.dart index e41a7f39..390e4943 100644 --- a/lib/src/client/transport/xhr_transport.dart +++ b/lib/src/client/transport/xhr_transport.dart @@ -51,7 +51,7 @@ class XhrTransportStream implements GrpcTransportStream { : _onError = onError, _onDone = onDone { _outgoingMessages.stream.map(frame).listen( - (data) => _request.send(Int8List.fromList(data).toJS), + (data) => _request.send(Uint8List.fromList(data).toJS), cancelOnError: true, onError: _onError); From 93909b76685e160512cc0ece92f7776844ea7aaa Mon Sep 17 00:00:00 2001 From: Aran Donohue Date: Mon, 16 Dec 2024 09:15:03 -0800 Subject: [PATCH 7/8] refactor: eta-reduction of call to request.setRequestHeader --- lib/src/client/transport/xhr_transport.dart | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/lib/src/client/transport/xhr_transport.dart b/lib/src/client/transport/xhr_transport.dart index 390e4943..5e0c2291 100644 --- a/lib/src/client/transport/xhr_transport.dart +++ b/lib/src/client/transport/xhr_transport.dart @@ -161,9 +161,7 @@ class XhrClientConnection implements ClientConnection { void _initializeRequest( XMLHttpRequest request, Map metadata) { - metadata.forEach((key, value) { - request.setRequestHeader(key, value); - }); + metadata.forEach(request.setRequestHeader); // Overriding the mimetype allows us to stream and parse the data request.overrideMimeType('text/plain; charset=x-user-defined'); request.responseType = 'text'; From 2b2b151fd49af15378b0df18315740f55b698a38 Mon Sep 17 00:00:00 2001 From: Aran Donohue Date: Mon, 16 Dec 2024 09:16:55 -0800 Subject: [PATCH 8/8] Convert grpc-web example to package:web --- example/grpc-web/lib/app.dart | 27 ++++++++++++++++++--------- example/grpc-web/pubspec.yaml | 1 + example/grpc-web/web/main.dart | 9 ++++----- 3 files changed, 23 insertions(+), 14 deletions(-) diff --git a/example/grpc-web/lib/app.dart b/example/grpc-web/lib/app.dart index fce83c51..8c0d9829 100644 --- a/example/grpc-web/lib/app.dart +++ b/example/grpc-web/lib/app.dart @@ -14,8 +14,7 @@ // limitations under the License. import 'dart:async'; -import 'dart:html'; - +import 'package:web/web.dart'; import 'src/generated/echo.pbgrpc.dart'; class EchoApp { @@ -56,13 +55,23 @@ class EchoApp { } void _addMessage(String message, String cssClass) { - final classes = cssClass.split(' '); - querySelector('#first')!.after(DivElement() - ..classes.add('row') - ..append(Element.tag('h2') - ..append(SpanElement() - ..classes.add('label') - ..classes.addAll(classes) + document.querySelector('#first')!.after(HTMLDivElement() + ..classList.add('row') + ..append(HTMLHeadingElement.h2() + ..append(HTMLSpanElement() + ..classList.add('label') + ..classList.addAll(cssClass) ..text = message))); } } + +// The documentation of DOMTokenList.add implies it can handle multiple classes, +// but in Chrome at least it does not. +extension AddAll on DOMTokenList { + void addAll(String cssClass) { + final classes = cssClass.split(' '); + for (final c in classes) { + add(c); + } + } +} diff --git a/example/grpc-web/pubspec.yaml b/example/grpc-web/pubspec.yaml index e215c131..11ffa8e5 100644 --- a/example/grpc-web/pubspec.yaml +++ b/example/grpc-web/pubspec.yaml @@ -9,6 +9,7 @@ dependencies: grpc: path: ../../ protobuf: ^3.0.0 + web: ^1.1.0 dev_dependencies: build_runner: ^2.0.0 diff --git a/example/grpc-web/web/main.dart b/example/grpc-web/web/main.dart index 24da3b6c..997a4bd3 100644 --- a/example/grpc-web/web/main.dart +++ b/example/grpc-web/web/main.dart @@ -12,21 +12,20 @@ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. -import 'dart:html'; - import 'package:grpc/grpc_web.dart'; import 'package:grpc_web/app.dart'; import 'package:grpc_web/src/generated/echo.pbgrpc.dart'; +import 'package:web/web.dart'; void main() { final channel = GrpcWebClientChannel.xhr(Uri.parse('http://localhost:8080')); final service = EchoServiceClient(channel); final app = EchoApp(service); - final button = querySelector('#send') as ButtonElement; + final button = document.querySelector('#send') as HTMLButtonElement; button.onClick.listen((e) async { - final msg = querySelector('#msg') as TextInputElement; - final value = msg.value!.trim(); + final msg = document.querySelector('#msg') as HTMLInputElement; + final value = msg.value.trim(); msg.value = ''; if (value.isEmpty) return;