Skip to content

feat: support request cancellation for native HTTP clients #2434

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 10 commits into from
Aug 11, 2025
Merged

feat: support request cancellation for native HTTP clients #2434

merged 10 commits into from
Aug 11, 2025

Conversation

@zzyzy
Copy link
Contributor

@zzyzy zzyzy commented Aug 8, 2025 •
edited
Loading

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

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

New Pull Request Checklist

  • I have read the Documentation
  • I have searched for a similar pull request in the project and found none
  • I have updated this branch with the latest main branch to avoid conflicts (via merge from master or rebase)
  • I have added the required tests to prove the fix/feature I'm adding
  • I have updated the documentation (if necessary)
  • I have run the tests without failures
  • I have updated the CHANGELOG.md in the corresponding package

Additional context and info (if any)

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:

    [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

@zzyzy zzyzy requested a review from a team as a code owner August 8, 2025 08:59
AlexV525
AlexV525 requested changes Aug 8, 2025
View reviewed changes
zzyzy and others added 3 commits August 8, 2025 17:45
@zzyzy @AlexV525
Update plugins/native_dio_adapter/lib/src/conversion_layer_adapter.dart
25971f7 
Co-authored-by: Alex Li <github@alexv525.com>
Signed-off-by: Zhen Zhi Lee <zzyzy@users.noreply.github.com>
@zzyzy @AlexV525
Update plugins/native_dio_adapter/pubspec.yaml
d44eb37 
Co-authored-by: Alex Li <github@alexv525.com>
Signed-off-by: Zhen Zhi Lee <zzyzy@users.noreply.github.com>
add tests
d27f88f
AlexV525
AlexV525 reviewed Aug 8, 2025
View reviewed changes
Copy link
Member

@AlexV525 AlexV525 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for adding tests

zzyzy and others added 4 commits August 8, 2025 23:55
@zzyzy @AlexV525
Update plugins/native_dio_adapter/test/conversion_layer_adapter_test.…
674eed9 
…dart

Co-authored-by: Alex Li <github@alexv525.com>
Signed-off-by: Zhen Zhi Lee <zzyzy@users.noreply.github.com>
@zzyzy @AlexV525
Update plugins/native_dio_adapter/pubspec.yaml
00aba58 
Co-authored-by: Alex Li <github@alexv525.com>
Signed-off-by: Zhen Zhi Lee <zzyzy@users.noreply.github.com>
refactor
24f79cc
make sure underlying Client is canceled too
a1f81bf
@zzyzy zzyzy requested a review from AlexV525 August 8, 2025 16:06
AlexV525
AlexV525 approved these changes Aug 9, 2025
View reviewed changes
Copy link
Member

@AlexV525 AlexV525 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM with only one nit picking

plugins/native_dio_adapter/test/client_mock.dart Outdated
@@ -1,3 +1,4 @@
import 'package:async/async.dart';
Copy link
Member

@AlexV525 AlexV525 Aug 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could we only show classes we are using here?

Copy link
Contributor Author

@zzyzy zzyzy Aug 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

@github-actions
Copy link
Contributor

github-actions bot commented Aug 11, 2025

Code Coverage Report: Only Changed Files listed

Package Base Coverage New Coverage Difference
Overall Coverage 🟢 85.57% 🟢 85.57% ⚪ 0%

Minimum allowed coverage is 0%, this run produced 85.57%

@AlexV525 AlexV525 merged commit f5a38ae into cfug:main Aug 11, 2025
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@AlexV525 AlexV525 AlexV525 approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@zzyzy @AlexV525