grpc
/
grpc-dart
mirror of https://github.com/grpc/grpc-dart.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add XHR raw response to the GrpcError for a better debugging (#423) 

Co-authored-by: Vyacheslav Egorov <vegorov@google.com>
This commit is contained in:
Ji Li 2021-01-28 03:33:41 -08:00 committed by GitHub
parent 0eb331f157
commit 2584a5e536
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 96 additions and 55 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

69
lib/src/client/transport/xhr_transport.dart
View File

@ -67,14 +67,8 @@ class XhrTransportStream implements GrpcTransportStream {
_onHeadersReceived();
break;
case HttpRequest.DONE:
if (_request.status != 200) {
_onError(
GrpcError.unavailable(
'XhrConnection status ${_request.status}'),
StackTrace.current);
} else {
_close();
}
_onRequestDone();
_close();
break;
}
});
@ -113,36 +107,45 @@ class XhrTransportStream implements GrpcTransportStream {
return _validContentTypePrefix.any(contentType.startsWith);
}
_onHeadersReceived() {
final contentType = _request.getResponseHeader(_contentTypeKey);
if (_request.status != 200) {
_onError(GrpcError.unavailable('XhrConnection status ${_request.status}'),
StackTrace.current);
return;
}
if (contentType == null) {
_onError(GrpcError.unavailable('XhrConnection missing Content-Type'),
StackTrace.current);
return;
}
if (!_checkContentType(contentType)) {
_onError(
GrpcError.unavailable('XhrConnection bad Content-Type $contentType'),
StackTrace.current);
return;
}
if (_request.response == null) {
_onError(GrpcError.unavailable('XhrConnection request null response'),
StackTrace.current);
return;
}
void _onHeadersReceived() {
// Force a metadata message with headers.
final headers = GrpcMetadata(_request.responseHeaders);
_incomingMessages.add(headers);
}
_close() {
void _onRequestDone() {
final contentType = _request.getResponseHeader(_contentTypeKey);
if (_request.status != 200) {
_onError(
GrpcError.unavailable('XhrConnection status ${_request.status}', null,
_request.responseText),
StackTrace.current);
return;
}
if (contentType == null) {
_onError(
GrpcError.unavailable('XhrConnection missing Content-Type', null,
_request.responseText),
StackTrace.current);
return;
}
if (!_checkContentType(contentType)) {
_onError(
GrpcError.unavailable('XhrConnection bad Content-Type $contentType',
null, _request.responseText),
StackTrace.current);
return;
}
if (_request.response == null) {
_onError(
GrpcError.unavailable('XhrConnection request null response', null,
_request.responseText),
StackTrace.current);
return;
}
}
void _close() {
_incomingProcessor.close();
_outgoingMessages.close();
_onDone(this);

39
lib/src/shared/status.dart
View File

@ -127,18 +127,19 @@ class GrpcError implements Exception {
final String codeName;
final String message;
final List<GeneratedMessage> details;
final Object rawResponse;
/// Custom error code.
GrpcError.custom(this.code, [this.message, this.details])
GrpcError.custom(this.code, [this.message, this.details, this.rawResponse])
: codeName = _getStatusCodeValue(code);
/// The operation completed successfully.
GrpcError.ok([this.message, this.details])
GrpcError.ok([this.message, this.details, this.rawResponse])
: code = StatusCode.ok,
codeName = _getStatusCodeValue(StatusCode.ok);
/// The operation was cancelled (typically by the caller).
GrpcError.cancelled([this.message, this.details])
GrpcError.cancelled([this.message, this.details, this.rawResponse])
: code = StatusCode.cancelled,
codeName = _getStatusCodeValue(StatusCode.cancelled);
@ -146,7 +147,7 @@ class GrpcError implements Exception {
/// Status value received from another address space belongs to an error-space
/// that is not known in this address space. Also errors raised by APIs that
/// do not return enough error information may be converted to this error.
GrpcError.unknown([this.message, this.details])
GrpcError.unknown([this.message, this.details, this.rawResponse])
: code = StatusCode.unknown,
codeName = _getStatusCodeValue(StatusCode.unknown);
@ -154,7 +155,7 @@ class GrpcError implements Exception {
/// [failedPrecondition]. [invalidArgument] indicates arguments that are
/// problematic regardless of the state of the system (e.g., a malformed file
/// name).
GrpcError.invalidArgument([this.message, this.details])
GrpcError.invalidArgument([this.message, this.details, this.rawResponse])
: code = StatusCode.invalidArgument,
codeName = _getStatusCodeValue(StatusCode.invalidArgument);
@ -163,18 +164,18 @@ class GrpcError implements Exception {
/// operation has completed successfully. For example, a successful response
/// from a server could have been delayed long enough for the deadline to
/// expire.
GrpcError.deadlineExceeded([this.message, this.details])
GrpcError.deadlineExceeded([this.message, this.details, this.rawResponse])
: code = StatusCode.deadlineExceeded,
codeName = _getStatusCodeValue(StatusCode.deadlineExceeded);
/// Some requested entity (e.g., file or directory) was not found.
GrpcError.notFound([this.message, this.details])
GrpcError.notFound([this.message, this.details, this.rawResponse])
: code = StatusCode.notFound,
codeName = _getStatusCodeValue(StatusCode.notFound);
/// Some entity that we attempted to create (e.g., file or directory) already
/// exists.
GrpcError.alreadyExists([this.message, this.details])
GrpcError.alreadyExists([this.message, this.details, this.rawResponse])
: code = StatusCode.alreadyExists,
codeName = _getStatusCodeValue(StatusCode.alreadyExists);
@ -183,13 +184,13 @@ class GrpcError implements Exception {
/// some resource (use [resourceExhausted] instead for those errors).
/// [permissionDenied] must not be used if the caller cannot be identified
/// (use [unauthenticated] instead for those errors).
GrpcError.permissionDenied([this.message, this.details])
GrpcError.permissionDenied([this.message, this.details, this.rawResponse])
: code = StatusCode.permissionDenied,
codeName = _getStatusCodeValue(StatusCode.permissionDenied);
/// Some resource has been exhausted, perhaps a per-user quota, or perhaps the
/// entire file system is out of space.
GrpcError.resourceExhausted([this.message, this.details])
GrpcError.resourceExhausted([this.message, this.details, this.rawResponse])
: code = StatusCode.resourceExhausted,
codeName = _getStatusCodeValue(StatusCode.resourceExhausted);
@ -207,7 +208,7 @@ class GrpcError implements Exception {
/// because the directory is non-empty, [failedPrecondition] should be
/// returned since the client should not retry unless they have first
/// fixed up the directory by deleting files from it.
GrpcError.failedPrecondition([this.message, this.details])
GrpcError.failedPrecondition([this.message, this.details, this.rawResponse])
: code = StatusCode.failedPrecondition,
codeName = _getStatusCodeValue(StatusCode.failedPrecondition);
@ -216,7 +217,7 @@ class GrpcError implements Exception {
///
/// See litmus test above for deciding between [failedPrecondition],
/// [aborted], and [unavailable].
GrpcError.aborted([this.message, this.details])
GrpcError.aborted([this.message, this.details, this.rawResponse])
: code = StatusCode.aborted,
codeName = _getStatusCodeValue(StatusCode.aborted);
@ -233,19 +234,19 @@ class GrpcError implements Exception {
/// [outOfRange]. We recommend using [outOfRange] (the more specific error)
/// when it applies so that callers who are iterating through a space can
/// easily look for an [outOfRange] error to detect when they are done.
GrpcError.outOfRange([this.message, this.details])
GrpcError.outOfRange([this.message, this.details, this.rawResponse])
: code = StatusCode.outOfRange,
codeName = _getStatusCodeValue(StatusCode.outOfRange);
/// Operation is not implemented or not supported/enabled in this service.
GrpcError.unimplemented([this.message, this.details])
GrpcError.unimplemented([this.message, this.details, this.rawResponse])
: code = StatusCode.unimplemented,
codeName = _getStatusCodeValue(StatusCode.unimplemented);
/// Internal errors. Means some invariants expected by underlying system has
/// been broken. If you see one of these errors, something is very broken.
// TODO(sigurdm): This should probably not be an [Exception].
GrpcError.internal([this.message, this.details])
GrpcError.internal([this.message, this.details, this.rawResponse])
: code = StatusCode.internal,
codeName = _getStatusCodeValue(StatusCode.internal);
@ -254,18 +255,18 @@ class GrpcError implements Exception {
///
/// See litmus test above for deciding between [failedPrecondition],
/// [aborted], and [unavailable].
GrpcError.unavailable([this.message, this.details])
GrpcError.unavailable([this.message, this.details, this.rawResponse])
: code = StatusCode.unavailable,
codeName = _getStatusCodeValue(StatusCode.unavailable);
/// Unrecoverable data loss or corruption.
GrpcError.dataLoss([this.message, this.details])
GrpcError.dataLoss([this.message, this.details, this.rawResponse])
: code = StatusCode.dataLoss,
codeName = _getStatusCodeValue(StatusCode.dataLoss);
/// The request does not have valid authentication credentials for the
/// operation.
GrpcError.unauthenticated([this.message, this.details])
GrpcError.unauthenticated([this.message, this.details, this.rawResponse])
: code = StatusCode.unauthenticated,
codeName = _getStatusCodeValue(StatusCode.unauthenticated);
@ -280,7 +281,7 @@ class GrpcError implements Exception {
@override
String toString() =>
'gRPC Error (code: $code, codeName: $codeName, message: $message, details: $details)';
'gRPC Error (code: $code, codeName: $codeName, message: $message, details: $details, rawResponse: $rawResponse)';
}
/// Given a status code, return the name

43
test/client_tests/client_xhr_transport_test.dart
View File

@ -21,11 +21,13 @@ import 'dart:html';
import 'package:grpc/src/client/call.dart';
import 'package:grpc/src/client/transport/xhr_transport.dart';
import 'package:grpc/src/shared/message.dart';
import 'package:grpc/src/shared/status.dart';
import 'package:mockito/mockito.dart';
import 'package:test/test.dart';
class MockHttpRequest extends Mock implements HttpRequest {
MockHttpRequest({int code}) : status = code ?? 200;
// ignore: close_sinks
StreamController<Event> readyStateChangeController =
StreamController<Event>();
@ -43,17 +45,20 @@ class MockHttpRequest extends Mock implements HttpRequest {
Stream<ProgressEvent> get onError => StreamController<ProgressEvent>().stream;
@override
int status = 200;
final int status;
}
class MockXhrClientConnection extends XhrClientConnection {
MockXhrClientConnection() : super(Uri.parse('test:8080'));
MockXhrClientConnection({int code})
: _statusCode = code ?? 200,
super(Uri.parse('test:8080'));
MockHttpRequest latestRequest;
final int _statusCode;
@override
createHttpRequest() {
final request = MockHttpRequest();
final request = MockHttpRequest(code: _statusCode);
latestRequest = request;
return request;
}
@ -306,6 +311,38 @@ void main() {
connection.latestRequest.progressController.add(null);
});
test('GrpcError with error details in response', () async {
final metadata = <String, String>{
'parameter_1': 'value_1',
'parameter_2': 'value_2'
};
final connection = MockXhrClientConnection(code: 400);
final errorStream = StreamController<GrpcError>();
connection.makeRequest('test_path', Duration(seconds: 10), metadata,
(e, _) => errorStream.add(e));
const errorDetails = "error details";
int count = 0;
errorStream.stream.listen((error) {
expect(
error,
TypeMatcher<GrpcError>()
.having((e) => e.rawResponse, 'rawResponse', errorDetails));
count++;
if (count == 2) {
errorStream.close();
}
});
when(connection.latestRequest.getResponseHeader('Content-Type'))
.thenReturn('application/grpc+proto');
when(connection.latestRequest.responseHeaders).thenReturn(metadata);
when(connection.latestRequest.readyState).thenReturn(HttpRequest.DONE);
when(connection.latestRequest.responseText).thenReturn(errorDetails);
connection.latestRequest.readyStateChangeController.add(null);
});
test('Stream recieves multiple messages', () async {
final metadata = <String, String>{
'parameter_1': 'value_1',