commit a6762dd24c208f78a956049f22b155be4c25a77e
author Sam Rawlins <srawlins@google.com> Fri May 10 14:16:41 2024 +0000
committer Commit Queue <dart-scoped@luci-project-accounts.iam.gserviceaccount.com> Fri May 10 14:16:41 2024 +0000
tree 90dc4b74fe01bde4b0c6c87dde24d12e66ca676f
parent f7cc159e38dca0ba44c5b11222bea8fcf5098fa1

Report unsafe BuildContext access in Future.then and more

Fixes https://github.com/dart-lang/linter/issues/4923

In this change we now protect code inside callback arguments to
functions like `Future.then`. For example:

```dart
Future<int>.delayed(Duration(seconds: 1), (_) {
  return 42;
}).then((int value) {
 Navigator.of(context).pop();
});
```

In code like this, each reference to BuildContext must be guarded by
a mounted check.

There are a number of "protected functions" that the rule now checks:

Constructors:
* Future.new: 1st positional parameter
* Future.delayed: 2nd positional parameter
* Future.microtask: 1st positional parameter
* Stream.eventTransformed: 2nd positional parameter
* Stream.multi: 1st positional parameter
* Stream.periodic: 2nd positional parameter

* StreamController.new: 'onListen', 'onPause', 'onResume', and
  'onCancel' named parameters
* StreamController.broadcast: 'onListen' and 'onCancel' named
  parameters

Instance Methods:
* Future.catchError: first positional parameter, and 'test' named
  parameter
* Future.onError: 1st positional parameter, and 'test' named parameter
* Future.then: 1st positional parameter, and 'onError' named
  parameter
* Future.timeout: 'onTimeout' named parameter
* Future.whenComplete: 1st positional parameter
* Stream.any: 1st positional parameter
* Stream.asBroadcastStream: 'onListen' and 'onCancel' named parameters
* Stream.asyncExpand: 1st positional parameter
* Stream.asyncMap: 1st positional parameter
* Stream.distinct: 1st positional parameter
* Stream.expand: 1st positional parameter
* Stream.firstWhere: first positional parameter, and 'orElse' named
  parameter
* Stream.fold: second positional parameter
* Stream.forEach: 1st positional parameter
* Stream.handleError: 1st positional parameter, and 'test' named
  parameter
* Stream.lastWhere: 1st positional parameter, and 'orElse' named
  parameter
* Stream.listen: 1st positional parameter, and 'onError' and 'onDone'
  named parameters
* Stream.map: 1st positional parameter
* Stream.reduce: 1st positional parameter
* Stream.singleWhere: 1st positional parameter, and 'orElse' named
  parameter
* Stream.skipWhile: 1st positional parameter
* Stream.takeWhile: 1st positional parameter
* Stream.timeout: 'onTimeout' named parameter
* Stream.where: 1st positional parameter
* Stream.onData: 1st positional parameter
* Stream.onDone: 1st positional parameter
* Stream.onError: 1st positional parameter

Static Methods:
* Future.doWhile: 1st positional parameter
* Future.forEach: 2nd positional parameter
* Future.wait: 'cleanUp' named parameter



Change-Id: I703d5cfbee5e8af1f703f40046832d66b9b59bc2
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/365541
Reviewed-by: Phil Quitslund <pquitslund@google.com>
Commit-Queue: Samuel Rawlins <srawlins@google.com>