languages/dart-sdk
languages/dart-sdk
1
0
Fork 0
mirror of https://github.com/dart-lang/sdk synced 2024-10-04 16:54:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

Revert "[dart:io] Add Abort() on HttpClientRequest"

Browse source 
This reverts commit 4b96f20a79.

Reason for revert: Windows bots are broken. Because --socket-short-read is specified, the server doesn't receive full header at once.

https://dart-ci.appspot.com/log/vm-kernel-win-debug-x64/dartk-win-debug-x64/8907/standalone_2/io/http_client_connect_test/3

Original change's description:
> [dart:io] Add Abort() on HttpClientRequest
> 
> The breaking change request for this cl: https://github.com/dart-lang/sdk/issues/41904
> 
> Bug: https://github.com/dart-lang/sdk/issues/22265
> Change-Id: I36db64b4db307b78cd188a2f1701ec733f2e73db
> Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/147339
> Commit-Queue: Zichang Guo <zichangguo@google.com>
> Reviewed-by: Lasse R.H. Nielsen <lrn@google.com>

TBR=lrn@google.com,zichangguo@google.com

Change-Id: I48f7a2ee3bb75e0e0ba0bd24ed53fcac372e016d
No-Presubmit: true
No-Tree-Checks: true
No-Try: true
Bug: https://github.com/dart-lang/sdk/issues/22265
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/155548
Reviewed-by: Zichang Guo <zichangguo@google.com>
Commit-Queue: Zichang Guo <zichangguo@google.com>
This commit is contained in:
Zichang Guo 2020-07-23 02:31:10 +00:00 committed by commit-bot@chromium.org
parent 17d7296a42
commit 40fd1c456e
5 changed files with 6 additions and 329 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
CHANGELOG.md
View file

@ -1,12 +1,3 @@
## 2.10.0
### Core libraries
#### `dart:io`
* Adds `Abort` method to class `HttpClientRequest`, which allows users
to cancel outgoing HTTP requests and stop following IO operations.
## 2.9.0
### Language

28
sdk/lib/_http/http.dart
View file

@ -2015,34 +2015,6 @@ abstract class HttpClientRequest implements IOSink {
///
/// Returns `null` if the socket is not available.
HttpConnectionInfo? get connectionInfo;
/// Aborts the client connection.
///
/// If the connection has not yet completed, the request is aborted and the
/// [done] future (also returned by [close]) is completed with the provided
/// [exception] and [stackTrace].
/// If [exception] is omitted, it defaults to an [HttpException], and if
/// [stackTrace] is omitted, it defaults to [StackTrace.empty].
///
/// If the [done] future has already completed, aborting has no effect.
///
/// Using the [IOSink] methods (e.g., [write] and [add]) has no effect after
/// the request has been aborted
///
/// ```dart
/// HttpClientRequst request = ...
/// request.write();
/// Timer(Duration(seconds: 1), () {
/// request.abort();
/// });
/// request.close().then((response) {
/// // If response comes back before abort, this callback will be called.
/// }, onError: (e) {
/// // If abort() called before response is available, onError will fire.
/// });
/// ```
@Since("2.9")
void abort([Object? exception, StackTrace? stackTrace]);
}
/**

48
sdk/lib/_http/http_impl.dart
View file

@ -1078,8 +1078,6 @@ class _HttpClientRequest extends _HttpOutboundMessage<HttpClientResponse>
List<RedirectInfo> _responseRedirects = [];
bool _aborted = false;
_HttpClientRequest(_HttpOutgoing outgoing, Uri uri, this.method, this._proxy,
this._httpClient, this._httpClientConnection, this._timeline)
: uri = uri,
@ -1143,10 +1141,7 @@ class _HttpClientRequest extends _HttpOutboundMessage<HttpClientResponse>
.then((list) => list[0]);
Future<HttpClientResponse> close() {
if (!_aborted) {
// It will send out the request.
super.close();
}
super.close();
return done;
}
@ -1166,9 +1161,6 @@ class _HttpClientRequest extends _HttpOutboundMessage<HttpClientResponse>
_httpClientConnection.connectionInfo;
void _onIncoming(_HttpIncoming incoming) {
if (_aborted) {
return;
}
var response = new _HttpClientResponse(incoming, this, _httpClient);
Future<HttpClientResponse> future;
if (followRedirects && response.isRedirect) {
@ -1191,21 +1183,12 @@ class _HttpClientRequest extends _HttpOutboundMessage<HttpClientResponse>
} else {
future = new Future<HttpClientResponse>.value(response);
}
future.then((v) {
if (!_responseCompleter.isCompleted) {
_responseCompleter.complete(v);
}
}, onError: (e, s) {
if (!_responseCompleter.isCompleted) {
_responseCompleter.completeError(e, s);
}
});
future.then((v) => _responseCompleter.complete(v),
onError: _responseCompleter.completeError);
}
void _onError(error, StackTrace stackTrace) {
if (!_responseCompleter.isCompleted) {
_responseCompleter.completeError(error, stackTrace);
}
_responseCompleter.completeError(error, stackTrace);
}
// Generate the request URI based on the method and proxy.
@ -1238,21 +1221,7 @@ class _HttpClientRequest extends _HttpOutboundMessage<HttpClientResponse>
}
}
void add(List<int> data) {
if (data.length == 0 || _aborted) return;
super.add(data);
}
void write(Object? obj) {
if (_aborted) return;
super.write(obj);
}
void _writeHeader() {
if (_aborted) {
_outgoing.setHeader(Uint8List(0), 0);
return;
}
BytesBuilder buffer = new _CopyingBytesBuilder(_OUTGOING_BUFFER_SIZE);
// Write the request method.
@ -1285,15 +1254,6 @@ class _HttpClientRequest extends _HttpOutboundMessage<HttpClientResponse>
Uint8List headerBytes = buffer.takeBytes();
_outgoing.setHeader(headerBytes, headerBytes.length);
}
void abort([Object? exception, StackTrace? stackTrace]) {
_aborted = true;
if (!_responseCompleter.isCompleted) {
exception ??= HttpException("Request has been aborted");
_responseCompleter.completeError(exception, stackTrace);
_httpClientConnection.destroy();
}
}
}
// Used by _HttpOutgoing as a target of a chunked converter for gzip

125
tests/standalone/io/http_client_connect_test.dart
View file

@ -308,126 +308,7 @@ Future<void> testMaxConnectionsWithFailure() async {
}
}
Future<void> testHttpAbort() async {
// Test that abort() is called after request is sent.
asyncStart();
final completer = Completer<void>();
final server = await HttpServer.bind("127.0.0.1", 0);
server.listen((request) {
completer.complete();
request.response.close();
});
final request = await HttpClient().get("127.0.0.1", server.port, "/");
request.headers.add(HttpHeaders.contentLengthHeader, "8");
request.write('somedata');
completer.future.then((_) {
request.abort();
asyncStart();
Future.delayed(Duration(milliseconds: 500), () {
server.close();
asyncEnd();
});
});
request.close().then((response) {
Expect.fail('abort() prevents a response being returned');
}, onError: (e) {
Expect.type<HttpException>(e);
Expect.isTrue(e.toString().contains('abort'));
asyncEnd();
});
}
Future<void> testHttpAbortBeforeWrite() async {
// Test that abort() is called before write(). No message should be sent from
// HttpClientRequest.
asyncStart();
final completer = Completer<Socket>();
final server = await ServerSocket.bind("127.0.0.1", 0);
server.listen((s) async {
s.listen((data) {
Expect.fail('No message should be received');
});
await Future.delayed(Duration(milliseconds: 500));
completer.complete(s);
});
final request = await HttpClient().get("127.0.0.1", server.port, "/");
request.headers.add(HttpHeaders.contentLengthHeader, "8");
// This HttpException will go to onError callback.
request.abort(HttpException('Error'));
asyncStart();
request.write('somedata');
completer.future.then((socket) {
socket.destroy();
server.close();
asyncEnd();
});
request.close().then((response) {
Expect.fail('abort() prevents a response being returned');
}, onError: (e) {
Expect.type<HttpException>(e);
asyncEnd();
});
}
Future<void> testHttpAbortBeforeClose() async {
// Test that abort() is called after write(). Some messages added prior to
// abort() are sent.
final completer = new Completer<void>();
asyncStart();
final server = await ServerSocket.bind("127.0.0.1", 0);
server.listen((s) {
s.listen((data) {
Expect.isTrue(utf8.decode(data).contains("content-length: 8"));
completer.complete();
s.destroy();
server.close();
asyncEnd();
});
});
final request = await HttpClient().get("127.0.0.1", server.port, "/");
// Add an additional header field for server to verify.
request.headers.add(HttpHeaders.contentLengthHeader, "8");
request.write('somedata');
await completer.future;
final string = 'abort message';
asyncStart();
request.abort(string);
request.close().then((response) {
Expect.fail('abort() prevents a response being returned');
}, onError: (e) {
Expect.type<String>(e);
Expect.equals(string, e);
asyncEnd();
});
}
Future<void> testHttpAbortAfterClose() async {
// Test that abort() is called after response is received. It should not
// affect HttpClientResponse.
asyncStart();
final value = 'someRandomData';
final server = await HttpServer.bind("127.0.0.1", 0);
server.listen((request) {
request.response.write(value);
request.response.close();
});
final request = await HttpClient().get("127.0.0.1", server.port, "/");
request.close().then((response) {
request.abort();
response.listen((data) {
Expect.equals(utf8.decode(data), value);
}, onDone: () {
asyncEnd();
server.close();
});
});
}
void main() async {
void main() {
testGetEmptyRequest();
testGetDataRequest();
testGetInvalidHost();
@ -443,8 +324,4 @@ void main() async {
testMaxConnectionsPerHost(5, 10);
testMaxConnectionsPerHost(10, 50);
testMaxConnectionsWithFailure();
await testHttpAbort();
await testHttpAbortBeforeWrite();
await testHttpAbortBeforeClose();
await testHttpAbortAfterClose();
}

125
tests/standalone_2/io/http_client_connect_test.dart
View file

@ -306,126 +306,7 @@ Future<void> testMaxConnectionsWithFailure() async {
}
}
Future<void> testHttpAbort() async {
// Test that abort() is called after request is sent.
asyncStart();
final completer = Completer<void>();
final server = await HttpServer.bind("127.0.0.1", 0);
server.listen((request) {
completer.complete();
request.response.close();
});
final request = await HttpClient().get("127.0.0.1", server.port, "/");
request.headers.add(HttpHeaders.contentLengthHeader, "8");
request.write('somedata');
completer.future.then((_) {
request.abort();
asyncStart();
Future.delayed(Duration(milliseconds: 500), () {
server.close();
asyncEnd();
});
});
request.close().then((response) {
Expect.fail('abort() prevents a response being returned');
}, onError: (e) {
Expect.type<HttpException>(e);
Expect.isTrue(e.toString().contains('abort'));
asyncEnd();
});
}
Future<void> testHttpAbortBeforeWrite() async {
// Test that abort() is called before write(). No message should be sent from
// HttpClientRequest.
asyncStart();
final completer = Completer<Socket>();
final server = await ServerSocket.bind("127.0.0.1", 0);
server.listen((s) async {
s.listen((data) {
Expect.fail('No message should be received');
});
await Future.delayed(Duration(milliseconds: 500));
completer.complete(s);
});
final request = await HttpClient().get("127.0.0.1", server.port, "/");
request.headers.add(HttpHeaders.contentLengthHeader, "8");
// This HttpException will go to onError callback.
request.abort(HttpException('Error'));
asyncStart();
request.write('somedata');
completer.future.then((socket) {
socket.destroy();
server.close();
asyncEnd();
});
request.close().then((response) {
Expect.fail('abort() prevents a response being returned');
}, onError: (e) {
Expect.type<HttpException>(e);
asyncEnd();
});
}
Future<void> testHttpAbortBeforeClose() async {
// Test that abort() is called after write(). Some messages added prior to
// abort() are sent.
final completer = new Completer<void>();
asyncStart();
final server = await ServerSocket.bind("127.0.0.1", 0);
server.listen((s) {
s.listen((data) {
Expect.isTrue(utf8.decode(data).contains("content-length: 8"));
completer.complete();
s.destroy();
server.close();
asyncEnd();
});
});
final request = await HttpClient().get("127.0.0.1", server.port, "/");
// Add an additional header field for server to verify.
request.headers.add(HttpHeaders.contentLengthHeader, "8");
request.write('somedata');
await completer.future;
final string = 'abort message';
asyncStart();
request.abort(string);
request.close().then((response) {
Expect.fail('abort() prevents a response being returned');
}, onError: (e) {
Expect.type<String>(e);
Expect.equals(string, e);
asyncEnd();
});
}
Future<void> testHttpAbortAfterClose() async {
// Test that abort() is called after response is received. It should not
// affect HttpClientResponse.
asyncStart();
final value = 'someRandomData';
final server = await HttpServer.bind("127.0.0.1", 0);
server.listen((request) {
request.response.write(value);
request.response.close();
});
final request = await HttpClient().get("127.0.0.1", server.port, "/");
request.close().then((response) {
request.abort();
response.listen((data) {
Expect.equals(utf8.decode(data), value);
}, onDone: () {
asyncEnd();
server.close();
});
});
}
void main() async {
void main() {
testGetEmptyRequest();
testGetDataRequest();
testGetInvalidHost();
@ -441,8 +322,4 @@ void main() async {
testMaxConnectionsPerHost(5, 10);
testMaxConnectionsPerHost(10, 50);
testMaxConnectionsWithFailure();
await testHttpAbort();
await testHttpAbortBeforeWrite();
await testHttpAbortBeforeClose();
await testHttpAbortAfterClose();
}