feat: support request cancellation for native HTTP clients (#2434)

New versions of `http`, `cronet_http`, and `cupertino_http` support request cancellation (just like the `HttpClient` from `dart:io`).

Minor change to use `AbortableRequest` and pass the `cancelFuture` to the `abortTrigger` argument.

### Additional context and info (if any)

- [Add request cancellation to cupertino_http](dart-lang/http#1779)
- [[cronet] Support aborting requests](dart-lang/http#1797)
- [feat: support aborting HTTP requests](dart-lang/http#1773)

### Testing with ASP.NET Core API

Test Flutter app (Android and iOS only):

https://github.com/zzyzy/dio_lzz_fork_flutter/blob/main/lib/test_dio_request_cancellation.dart

Test API endpoint:
```csharp
    [HttpGet("request-cancellation")]
    public async Task<IActionResult> TestRequestCancellation(CancellationToken cancellationToken)
    {
        try
        {
            _logger.LogInformation("Request started {RequestID} {Platform}", HttpContext.TraceIdentifier,
                Request.Headers["X-App-Platform"]);
            
            await Task.Delay(TimeSpan.FromMinutes(5), cancellationToken);
            
            _logger.LogInformation("Request end {RequestID} {Platform}", HttpContext.TraceIdentifier,
                Request.Headers["X-App-Platform"]);
        }
        catch (TaskCanceledException)
        {
            _logger.LogInformation("Request canceled {RequestID} {Platform}", HttpContext.TraceIdentifier,
                Request.Headers["X-App-Platform"]);
            // Do nothing            
        }

        return Ok();
    }
```

#### Android

Before:
```
info: Microsoft.Hosting.Lifetime[14]
      Now listening on: http://0.0.0.0:5292
info: Microsoft.Hosting.Lifetime[0]
      Application started. Press Ctrl+C to shut down.
info: Microsoft.Hosting.Lifetime[0]
      Hosting environment: Development
info: Microsoft.Hosting.Lifetime[0]
      Content root path: D:\ws\me\repos\my-code-vault\MyToolkit\TestAspNetCoreWebApi
info: TestAspNetCoreWebApi.Controllers.TestController[0]
      Request started 0HNEMB51JJSG7:00000001 Android
info: TestAspNetCoreWebApi.Controllers.TestController[0]
      Request started 0HNEMB51JJSG8:00000001 Android
info: TestAspNetCoreWebApi.Controllers.TestController[0]
      Request started 0HNEMB51JJSG9:00000001 Android
info: TestAspNetCoreWebApi.Controllers.TestController[0]
      Request started 0HNEMB51JJSGA:00000001 Android
info: TestAspNetCoreWebApi.Controllers.TestController[0]
      Request started 0HNEMB51JJSGB:00000001 Android
info: TestAspNetCoreWebApi.Controllers.TestController[0]
      Request started 0HNEMB51JJSGC:00000001 Android
```

After:
```
info: Microsoft.Hosting.Lifetime[14]
      Now listening on: http://0.0.0.0:5292
info: Microsoft.Hosting.Lifetime[0]
      Application started. Press Ctrl+C to shut down.
info: Microsoft.Hosting.Lifetime[0]
      Hosting environment: Development
info: Microsoft.Hosting.Lifetime[0]
      Content root path: D:\ws\me\repos\my-code-vault\MyToolkit\TestAspNetCoreWebApi
info: TestAspNetCoreWebApi.Controllers.TestController[0]
      Request started 0HNEMAV9NHQ97:00000001 Android
info: TestAspNetCoreWebApi.Controllers.TestController[0]
      Request canceled 0HNEMAV9NHQ97:00000001 Android
info: TestAspNetCoreWebApi.Controllers.TestController[0]
      Request started 0HNEMAV9NHQ98:00000001 Android
info: TestAspNetCoreWebApi.Controllers.TestController[0]
      Request canceled 0HNEMAV9NHQ98:00000001 Android
info: TestAspNetCoreWebApi.Controllers.TestController[0]
      Request started 0HNEMAV9NHQ99:00000001 Android
info: TestAspNetCoreWebApi.Controllers.TestController[0]
      Request canceled 0HNEMAV9NHQ99:00000001 Android
info: TestAspNetCoreWebApi.Controllers.TestController[0]
      Request started 0HNEMAV9NHQ9A:00000001 Android
```

#### IOS

Before:
```
info: Microsoft.Hosting.Lifetime[14]
      Now listening on: http://0.0.0.0:5292
info: Microsoft.Hosting.Lifetime[0]
      Application started. Press Ctrl+C to shut down.
info: Microsoft.Hosting.Lifetime[0]
      Hosting environment: Development
info: Microsoft.Hosting.Lifetime[0]
      Content root path: D:\ws\me\repos\my-code-vault\MyToolkit\TestAspNetCoreWebApi
info: TestAspNetCoreWebApi.Controllers.TestController[0]
      Request started 0HNEMB42PERN4:00000001 IOS
info: TestAspNetCoreWebApi.Controllers.TestController[0]
      Request started 0HNEMB42PERN5:00000001 IOS
info: TestAspNetCoreWebApi.Controllers.TestController[0]
      Request started 0HNEMB42PERN6:00000001 IOS
info: TestAspNetCoreWebApi.Controllers.TestController[0]
      Request started 0HNEMB42PERN7:00000001 IOS
info: TestAspNetCoreWebApi.Controllers.TestController[0]
      Request started 0HNEMB42PERN8:00000001 IOS
info: TestAspNetCoreWebApi.Controllers.TestController[0]
      Request started 0HNEMB42PERN9:00000001 IOS
```

After:
```
info: Microsoft.Hosting.Lifetime[14]
      Now listening on: http://0.0.0.0:5292
info: Microsoft.Hosting.Lifetime[0]
      Application started. Press Ctrl+C to shut down.
info: Microsoft.Hosting.Lifetime[0]
      Hosting environment: Development
info: Microsoft.Hosting.Lifetime[0]
      Content root path: D:\ws\me\repos\my-code-vault\MyToolkit\TestAspNetCoreWebApi
info: TestAspNetCoreWebApi.Controllers.TestController[0]
      Request started 0HNEMB35NC5L0:00000001 IOS
info: TestAspNetCoreWebApi.Controllers.TestController[0]
      Request canceled 0HNEMB35NC5L0:00000001 IOS
info: TestAspNetCoreWebApi.Controllers.TestController[0]
      Request started 0HNEMB35NC5L1:00000001 IOS
info: TestAspNetCoreWebApi.Controllers.TestController[0]
      Request canceled 0HNEMB35NC5L1:00000001 IOS
info: TestAspNetCoreWebApi.Controllers.TestController[0]
      Request started 0HNEMB35NC5L2:00000001 IOS
info: TestAspNetCoreWebApi.Controllers.TestController[0]
      Request canceled 0HNEMB35NC5L2:00000001 IOS
info: TestAspNetCoreWebApi.Controllers.TestController[0]
      Request started 0HNEMB35NC5L3:00000001 IOS
info: TestAspNetCoreWebApi.Controllers.TestController[0]
      Request canceled 0HNEMB35NC5L3:00000001 IOS
info: TestAspNetCoreWebApi.Controllers.TestController[0]
      Request started 0HNEMB35NC5L4:00000001 IOS
info: TestAspNetCoreWebApi.Controllers.TestController[0]
      Request canceled 0HNEMB35NC5L4:00000001 IOS
info: TestAspNetCoreWebApi.Controllers.TestController[0]
      Request started 0HNEMB35NC5L5:00000001 IOS

```

---------

Signed-off-by: Zhen Zhi Lee <[email protected]>
Co-authored-by: zhenzhi.lee <[email protected]>
Co-authored-by: Alex Li <[email protected]>

Author: 3 people

plugins/native_dio_adapter/CHANGELOG.md

@@ -2,7 +2,7 @@
 
 ## Unreleased
 
-*None.*
+- Support request cancellation for native HTTP clients via use of `AbortableRequest` (introduced in http package from version 1.5.0)
 
 ## 1.5.0
 

plugins/native_dio_adapter/lib/src/conversion_layer_adapter.dart

@@ -23,7 +23,11 @@ class ConversionLayerAdapter implements HttpClientAdapter {
     Stream<Uint8List>? requestStream,
     Future<dynamic>? cancelFuture,
   ) async {
-    final request = await _fromOptionsAndStream(options, requestStream);
+    final request = await _fromOptionsAndStream(
+      options,
+      requestStream,
+      cancelFuture,
+    );
     final response = await client.send(request);
     return response.toDioResponseBody(options);
   }
@@ -34,10 +38,12 @@ class ConversionLayerAdapter implements HttpClientAdapter {
   Future<BaseRequest> _fromOptionsAndStream(
     RequestOptions options,
     Stream<Uint8List>? requestStream,
+    Future<dynamic>? cancelFuture,
   ) async {
-    final request = Request(
+    final request = AbortableRequest(
       options.method,
       options.uri,
+      abortTrigger: cancelFuture,
     );
 
     request.headers.addAll(

plugins/native_dio_adapter/pubspec.yaml

@@ -21,14 +21,15 @@ dependencies:
     sdk: flutter
 
   dio: ^5.4.0
-  cupertino_http: '>=1.0.0 <3.0.0'
-  cronet_http: '>=0.4.0 <2.0.0'
-  http: ^1.0.0
+  cupertino_http: ^2.3.0
+  cronet_http: ^1.5.0
+  http: ^1.5.0
 
 dev_dependencies:
   lints: ^2.0.0
   flutter_test:
     sdk: flutter
+  async: # transitive
 
 platforms:
   android:

plugins/native_dio_adapter/test/client_mock.dart

@@ -1,3 +1,4 @@
+import 'package:async/async.dart' show CancelableOperation;
 import 'package:http/http.dart';
 
 class CloseClientMock implements Client {
@@ -30,3 +31,38 @@ class ClientMock implements Client {
     throw UnimplementedError();
   }
 }
+
+class AbortClientMock implements Client {
+  bool isRequestCanceled = false;
+
+  @override
+  Future<StreamedResponse> send(BaseRequest request) async {
+    final cancellable = CancelableOperation.fromFuture(
+      Future<void>.delayed(const Duration(seconds: 5)),
+    );
+
+    if (request is Abortable) {
+      request.abortTrigger?.whenComplete(
+        () {
+          cancellable.cancel();
+          isRequestCanceled = true;
+        },
+      );
+    }
+
+    await cancellable.valueOrCancellation();
+
+    if (cancellable.isCanceled) {
+      throw AbortedError();
+    }
+
+    return StreamedResponse(Stream.fromIterable([]), 200);
+  }
+
+  @override
+  void noSuchMethod(Invocation invocation) {
+    throw UnimplementedError();
+  }
+}
+
+class AbortedError extends Error {}

plugins/native_dio_adapter/test/conversion_layer_adapter_test.dart

@@ -62,4 +62,52 @@ void main() {
 
     expect(await resp.stream.length, 5);
   });
+
+  test('request cancellation', () {
+    final mock = AbortClientMock();
+    final cla = ConversionLayerAdapter(mock);
+    final cancelToken = CancelToken();
+
+    Future<void>.delayed(const Duration(seconds: 1)).then(
+      (value) {
+        cancelToken.cancel();
+      },
+    );
+
+    expectLater(
+      () => cla.fetch(
+        RequestOptions(path: ''),
+        null,
+        cancelToken.whenCancel,
+      ),
+      throwsA(isA<AbortedError>()),
+    );
+  });
+
+  test('request cancellation with Dio', () async {
+    final mock = AbortClientMock();
+    final cla = ConversionLayerAdapter(mock);
+    final dio = Dio();
+    dio.httpClientAdapter = cla;
+
+    final cancelToken = CancelToken();
+
+    Future<void>.delayed(const Duration(seconds: 1)).then(
+      (value) {
+        cancelToken.cancel();
+      },
+    );
+
+    await expectLater(
+      () => dio.get<ResponseBody>('', cancelToken: cancelToken),
+      throwsA(
+        isA<DioException>().having(
+          (e) => e.type,
+          'type',
+          DioExceptionType.cancel,
+        ),
+      ),
+    );
+    expect(mock.isRequestCanceled, true);
+  });
 }