[various] Fixes `unawaited_futures` violations #4067

stuartmorgan · 2023-05-23T19:59:00Z

This option had been disabled to match flutter/flutter, but the reason it was disabled there was "too many false positives", mostly around animation. That doesn't apply to most packages here, and we've had a number of production bugs—especially in plugins, that use async heavily in ways that are intended to be client-awaitable—that this would have caught.

This PR:

Enables the option at the repo level.
Permanently (unless the owners decide to change it) opts out animations and go_router, both of which looked like mostly or entirely false positives.
Temporarily opted out a few plugins that have a lot of violations that should be handled in their own PRs later (camera_android_camerax, most of webview_flutter).
Fixes all remaining violations.

In many cases this PR is behavior-changing, replacing implicitly unawaited futures that did not seem obviously intentional with awaited futures, so non-test code in particular should be reviewed carefully to make sure the changes are correct. All of the changes are manual, not fix-generated.

Part of flutter/flutter#127323

Pre-launch Checklist

chunhtai

LGTM for go_router and go_router_builder

reidbaker · 2023-05-23T20:43:29Z

packages/camera/camera_android_camerax/analysis_options.yaml

+# TODO(stuartmorgan): Remove this file and fix all the unawaited_futures
+# violations. See https://github.com/flutter/flutter/issues/127323
+
+include: ../../../analysis_options.yaml


Unrelated to this pr. I wish we used absolute paths instead of relative paths when the absolute path has more meaning.

I know that effective dart says to prefer relative paths but in this case it matters more that we are using the root analysis_options.yaml than the one 3 folders up.
https://dart.dev/effective-dart/usage#prefer-relative-import-paths

I agree that would be better in this case, but I don't think it's actually possible; there's no package at the root.

I guess we could make a local package with the shared options, and then depend on that in every single pubspec.yaml so we could use a package: URL, but that would be pretty ugly. And the local package reference in the pubspec would have to be... a relative path.

reidbaker · 2023-05-23T20:45:03Z

packages/go_router/analysis_options.yaml

+linter:
+  rules:
+    # Matches flutter/flutter, which disables this rule due to false positives.
+    unawaited_futures: false


Mild preference for ignore for file in the test than opting out the directory.

tarrinneal

pigeon and shared_prefs are fine, assuming ci doesn't hang on pigeon tests

ditman

Not sure why I left some of the calls sneakily unawaited, but CI will tell. 🚀

stuartmorgan · 2023-05-24T00:03:07Z

All existing and new tests are passing.

Looks like this was aspirational. Not too many failures though; I'll take a look tomorrow.

stuartmorgan · 2023-05-24T11:31:41Z

packages/google_identity_services_web/test/js_loader_test.dart

@@ -27,7 +27,7 @@ void main() {
    final dom.DomHtmlElement target = dom.document.createElement('div');

    test('Injects script into desired target', () async {
-      loadWebSdk(target: target);
+      await loadWebSdk(target: target);


This change was incorrect; the test never simulates running the callback, causing the test to hang; I'll make it unawaited with a comment.

stuartmorgan · 2023-05-24T12:14:19Z

packages/google_sign_in/google_sign_in/lib/google_sign_in.dart

+    return (_initialization ??= _doInitialization()).catchError((dynamic _) {
+      // Invalidate initialization if it errors out.
+      _initialization = null;
+    });


Apparently the fact that the error wasn't being caught by the returned future was (or at least has become) intentional behavior, since there was a unit test that this change broke. I doubt very much that having _initialization not be guaranteed to be null when the future completes is intentional though, so I changed it to return the catchError wrapper, but made the wrapper rethrow after nulling _initialization.

…ges#4067)

flutter/packages@fba97fa...995bfc5 2023-05-24 [email protected] Roll Flutter from f86c529 to 216605b (18 revisions) (flutter/packages#4071) 2023-05-24 [email protected] [various] Fixes `unawaited_futures` violations (flutter/packages#4067) 2023-05-24 [email protected] [quick_actions] Fix iOS home screen quick actions documentation hyperlink (flutter/packages#4059) If this roll has caused a breakage, revert this CL and stop the roller using the controls here: https://autoroll.skia.org/r/flutter-packages-flutter-autoroll Please CC [email protected],[email protected] on the revert to ensure that a human is aware of the problem. To file a bug in Flutter: https://github.com/flutter/flutter/issues/new/choose To report a problem with the AutoRoller itself, please file a bug: https://bugs.chromium.org/p/skia/issues/entry?template=Autoroller+Bug Documentation for the AutoRoller is here: https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md

…4171) In #4067 I changed several implicitly unawaited futures to `await`, not noticing that doing so would change the timing on updating fields that were used to compute diffs for future updates. Since the update flow is unawaited at higher levels, this meant that multiple calls to update map objects in rapid succession would compute incorrect diffs due to using the wrong base objects. This fixes that by restoring the old flow using `unawaited`. Adds new tests that introduce synthetic awaits into the fake platform interface object and perform multiple updates in a row that should have different base object sets, which fail without the fix. In order to simplify adding that behavior to the fake, and to pay down technical debt in the unit tests, I replaced the old test fake that is based on method channel interception (which predates the federation of the plugin and is implicitly relying on the method channel implementation from a different package never changing) with a fake platform interface implementation (substantially simplifying the fake). Fixes flutter/flutter#128042

Some packages require package upgrade rather than simple modification (ex: google_maps_flutter) Therefore, the rules below are temporarily ignored. Any necessary modifications can be applied in a later PR. flutter/packages#4060 - unnecessary_null_comparison flutter/packages#4067 - unawaited_futures flutter/packages#5717 - dangling_library_doc_comments - no_literal_bool_comparisons - unnecessary_library_directive - use_colored_box - use_enums - use_string_in_part_of_directives

stuartmorgan added 10 commits May 23, 2023 13:00

Enable by default

b329c0f

Add the new opt-outs

f2095ff

Remove metrics center

907d834

Fix format

87051f6

Fix url_launcher tests

a8c7651

Fix camera tests

8e6981e

Fix script

055260b

Fix violations

d6cb450

Better comment wording

3002f3d

CHANGELOGs and versions

d747104

stuartmorgan requested review from cbracken, cyanglaz, hellohuanlin, gmackall, reidbaker, camsim99, ditman, bparrishMines, yjbanov, tarrinneal, gspencergoog, keyonghan, chunhtai, domesticmouse and goderbauer as code owners May 23, 2023 19:59

github-actions bot added p: animations p: camera p: cross_file p: flutter_image p: flutter_markdown labels May 23, 2023

chunhtai approved these changes May 23, 2023

View reviewed changes

reidbaker approved these changes May 23, 2023

View reviewed changes

tarrinneal approved these changes May 23, 2023

View reviewed changes

ditman approved these changes May 23, 2023

View reviewed changes

domesticmouse approved these changes May 24, 2023

View reviewed changes

stuartmorgan added 6 commits May 24, 2023 07:26

Move new rule into test dir

bed74b3

Fix test hang

1490224

Restore passing errors through google_sign_in init

e92cac8

Merge remote-tracking branch 'upstream/main' into unawaited-async

b0b1895

Update excerpts

8909565

Ignore analysis options changes for version check

86e18bf

stuartmorgan commented May 24, 2023

View reviewed changes

Fix include path

0b8a5ec

stuartmorgan added the autosubmit Merge PR when tree becomes green via auto submit App label May 24, 2023

auto-submit bot merged commit 97e3ba6 into flutter:main May 24, 2023

stuartmorgan deleted the unawaited-async branch May 24, 2023 16:31

engine-flutter-autoroll mentioned this pull request May 25, 2023

Roll Packages from fba97fa4cc86 to 995bfc5f9857 (3 revisions) flutter/flutter#127590

Merged

engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request May 25, 2023

97e3ba6 [various] Fixes unawaited_futures violations (flutter/packa…

4f86ae2

…ges#4067)

stuartmorgan mentioned this pull request Jun 9, 2023

[google_map_flutter] Fix map object regression due to async changes #4171

Merged

11 tasks

This was referenced Jul 7, 2023

[Tool] New tool to download android dependencies #4408

Merged

[camera] tree fix format 2023 05 12 #4450

Closed

[tooling] mark infra steps as infra steps in yaml files #4473

Merged

reidbaker mentioned this pull request Jul 26, 2023

[Tooling] Add google owned cache for dependencies as an option in ci #4567

Merged

11 tasks

reidbaker mentioned this pull request Aug 4, 2023

[All] Expand artifact hub to all plugins #4645

Merged

11 tasks

JSUYA mentioned this pull request Mar 6, 2024

Sync with analysis_options.yaml in flutter/packages flutter-tizen/plugins#675

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[various] Fixes `unawaited_futures` violations #4067

[various] Fixes `unawaited_futures` violations #4067

stuartmorgan commented May 23, 2023 •

edited

Loading

chunhtai left a comment

reidbaker May 23, 2023

stuartmorgan May 23, 2023

reidbaker May 23, 2023

tarrinneal left a comment

ditman left a comment

stuartmorgan commented May 24, 2023

stuartmorgan May 24, 2023

stuartmorgan May 24, 2023

[various] Fixes unawaited_futures violations #4067

[various] Fixes unawaited_futures violations #4067

Conversation

stuartmorgan commented May 23, 2023 • edited Loading

Pre-launch Checklist

chunhtai left a comment

Choose a reason for hiding this comment

reidbaker May 23, 2023

Choose a reason for hiding this comment

stuartmorgan May 23, 2023

Choose a reason for hiding this comment

reidbaker May 23, 2023

Choose a reason for hiding this comment

tarrinneal left a comment

Choose a reason for hiding this comment

ditman left a comment

Choose a reason for hiding this comment

stuartmorgan commented May 24, 2023

stuartmorgan May 24, 2023

Choose a reason for hiding this comment

stuartmorgan May 24, 2023

Choose a reason for hiding this comment

[various] Fixes `unawaited_futures` violations #4067

[various] Fixes `unawaited_futures` violations #4067

stuartmorgan commented May 23, 2023 •

edited

Loading