[tool] Update to Dart 3 (#6030)

stuartmorgan-g · web-flow · commit 7403992f15e6 · 2024-02-06T19:31:48.000Z
Updates the repo tooling to Dart 3, now that the N-2 version has Dart 3, which allows us to use Dart 3 features (e.g., records) going forward.

To allow the update:
- Removes `break` commands from `switch`es (all done automatically with `dart fix --apply`)
- Replaces mocking of `ProcessResult` with just creating an actual `ProcessResult` since it's a `final` data class and thus can't (but also doesn't need to be) mocked.
diff --git a/script/tool/lib/src/common/package_looping_command.dart b/script/tool/lib/src/common/package_looping_command.dart
@@ -123,7 +123,6 @@ abstract class PackageLoopingCommand extends PackageCommand {
     switch (packageLoopingType) {
       case PackageLoopingType.topLevelOnly:
         yield* getTargetPackages(filterExcluded: false);
-        break;
       case PackageLoopingType.includeExamples:
         await for (final PackageEnumerationEntry packageEntry
             in getTargetPackages(filterExcluded: false)) {
@@ -135,10 +134,8 @@ abstract class PackageLoopingCommand extends PackageCommand {
                   package,
                   excluded: packageEntry.excluded)));
         }
-        break;
       case PackageLoopingType.includeAllSubpackages:
         yield* getTargetPackagesAndSubpackages(filterExcluded: false);
-        break;
     }
   }
 
diff --git a/script/tool/lib/src/common/repository_package.dart b/script/tool/lib/src/common/repository_package.dart
@@ -72,22 +72,16 @@ class RepositoryPackage {
     switch (platform) {
       case FlutterPlatform.android:
         directoryName = 'android';
-        break;
       case FlutterPlatform.ios:
         directoryName = 'ios';
-        break;
       case FlutterPlatform.linux:
         directoryName = 'linux';
-        break;
       case FlutterPlatform.macos:
         directoryName = 'macos';
-        break;
       case FlutterPlatform.web:
         directoryName = 'web';
-        break;
       case FlutterPlatform.windows:
         directoryName = 'windows';
-        break;
     }
     return directory.childDirectory(directoryName);
   }
diff --git a/script/tool/lib/src/fetch_deps_command.dart b/script/tool/lib/src/fetch_deps_command.dart
@@ -125,30 +125,23 @@ class FetchDepsCommand extends PackageLoopingCommand {
       switch (platform) {
         case FlutterPlatform.android:
           result = await _fetchAndroidDeps(package);
-          break;
         case FlutterPlatform.ios:
           result = await _fetchDarwinDeps(package, platformIOS);
-          break;
         case FlutterPlatform.macos:
           result = await _fetchDarwinDeps(package, platformMacOS);
-          break;
         case FlutterPlatform.linux:
         case FlutterPlatform.web:
         case FlutterPlatform.windows:
           // No native dependency handling yet.
           result = PackageResult.skip('Nothing to do for $platform.');
-          break;
       }
       switch (result.state) {
         case RunState.succeeded:
           fetchedDeps = true;
-          break;
         case RunState.skipped:
           skips.add(result.details.first);
-          break;
         case RunState.failed:
           errors.addAll(result.details);
-          break;
         case RunState.excluded:
           throw StateError('Unreachable');
       }
diff --git a/script/tool/lib/src/list_command.dart b/script/tool/lib/src/list_command.dart
@@ -42,26 +42,22 @@ class ListCommand extends PackageCommand {
         await for (final PackageEnumerationEntry entry in getTargetPackages()) {
           print(entry.package.path);
         }
-        break;
       case _example:
         final Stream<RepositoryPackage> examples = getTargetPackages()
             .expand<RepositoryPackage>(
                 (PackageEnumerationEntry entry) => entry.package.getExamples());
         await for (final RepositoryPackage package in examples) {
           print(package.path);
         }
-        break;
       case _allPackage:
         await for (final PackageEnumerationEntry entry
             in getTargetPackagesAndSubpackages()) {
           print(entry.package.path);
         }
-        break;
       case _file:
         await for (final File file in getFiles()) {
           print(file.path);
         }
-        break;
     }
   }
 }
diff --git a/script/tool/lib/src/native_test_command.dart b/script/tool/lib/src/native_test_command.dart
@@ -481,7 +481,6 @@ this command.
       switch (exitCode) {
         case xcodebuildNoTestExitCode:
           _printNoExampleTestsMessage(example, platform);
-          break;
         case 0:
           printSuccess('Successfully ran $platform xctest for $exampleName');
           // If this is the first test, assume success until something fails.
@@ -491,7 +490,6 @@ this command.
           if (exampleHasUnitTests) {
             ranUnitTests = true;
           }
-          break;
         default:
           // Any failure means a failure overall.
           overallResult = RunState.failed;
diff --git a/script/tool/lib/src/update_dependency_command.dart b/script/tool/lib/src/update_dependency_command.dart
@@ -113,7 +113,6 @@ class UpdateDependencyCommand extends PackageLoopingCommand {
         switch (response.result) {
           case PubVersionFinderResult.success:
             _targetVersion = response.versions.first.toString();
-            break;
           case PubVersionFinderResult.fail:
             printError('''
 Error fetching $_targetPubPackage version from pub: ${response.httpResponse.statusCode}:
diff --git a/script/tool/lib/src/update_excerpts_command.dart b/script/tool/lib/src/update_excerpts_command.dart
@@ -138,20 +138,15 @@ class UpdateExcerptsCommand extends PackageLoopingCommand {
                 switch (extension) {
                   case '':
                     language = 'txt';
-                    break;
                   case '.kt':
                     language = 'kotlin';
-                    break;
                   case '.cc':
                   case '.cpp':
                     language = 'c++';
-                    break;
                   case '.m':
                     language = 'objectivec';
-                    break;
                   case '.gradle':
                     language = 'groovy';
-                    break;
                   default:
                     language = extension.substring(1);
                     break;
@@ -173,7 +168,6 @@ class UpdateExcerptsCommand extends PackageLoopingCommand {
             }
           }
           output.writeln(line);
-          break;
         case _ExcerptParseMode.pragma:
           if (!line.startsWith('```')) {
             errors.add(
@@ -195,7 +189,6 @@ class UpdateExcerptsCommand extends PackageLoopingCommand {
             mode = _ExcerptParseMode.injecting;
           }
           output.writeln(line);
-          break;
         case _ExcerptParseMode.injecting:
           if (line == '```') {
             if (existingBlock.toString() != excerpt) {
@@ -210,7 +203,6 @@ class UpdateExcerptsCommand extends PackageLoopingCommand {
           } else {
             existingBlock.writeln(line);
           }
-          break;
       }
     }
     if (detectedChange) {
@@ -250,23 +242,18 @@ class UpdateExcerptsCommand extends PackageLoopingCommand {
       case 'objectivec':
       case 'swift':
         prefix = '// ';
-        break;
       case 'css':
         prefix = '/* ';
         suffix = ' */';
-        break;
       case 'html':
       case 'xml':
         prefix = '<!--';
         suffix = '-->';
         padding = ' ';
-        break;
       case 'yaml':
         prefix = '# ';
-        break;
       case 'sh':
         prefix = '# ';
-        break;
     }
     final String startRegionMarker = '$prefix#docregion $section$suffix';
     final String endRegionMarker = '$prefix#enddocregion $section$suffix';
diff --git a/script/tool/lib/src/update_release_info_command.dart b/script/tool/lib/src/update_release_info_command.dart
@@ -100,10 +100,8 @@ class UpdateReleaseInfoCommand extends PackageLoopingCommand {
     switch (getStringArg(_versionTypeFlag)) {
       case _versionMinor:
         _versionChange = _VersionIncrementType.minor;
-        break;
       case _versionBugfix:
         _versionChange = _VersionIncrementType.bugfix;
-        break;
       case _versionMinimal:
         final GitVersionFinder gitVersionFinder = await retrieveVersionFinder();
         // If the line below fails with "Not a valid object name FETCH_HEAD"
@@ -113,10 +111,8 @@ class UpdateReleaseInfoCommand extends PackageLoopingCommand {
         _changedFiles = await gitVersionFinder.getChangedFiles();
         // Anothing other than a fixed change is null.
         _versionChange = null;
-        break;
       case _versionNext:
         _versionChange = null;
-        break;
       default:
         throw UnimplementedError('Unimplemented version change type');
     }
@@ -169,10 +165,8 @@ class UpdateReleaseInfoCommand extends PackageLoopingCommand {
     switch (updateOutcome) {
       case _ChangelogUpdateOutcome.addedSection:
         print('${indentation}Added a $nextVersionString section.');
-        break;
       case _ChangelogUpdateOutcome.updatedSection:
         print('${indentation}Updated NEXT section.');
-        break;
       case _ChangelogUpdateOutcome.failed:
         return PackageResult.fail(<String>['Could not update CHANGELOG.md.']);
     }
@@ -217,7 +211,6 @@ class UpdateReleaseInfoCommand extends PackageLoopingCommand {
             ].forEach(newChangelog.writeln);
             state = _ChangelogUpdateState.finishedUpdating;
           }
-          break;
         case _ChangelogUpdateState.findingFirstListItem:
           final RegExpMatch? match = listItemPattern.firstMatch(line);
           if (match != null) {
@@ -239,11 +232,9 @@ class UpdateReleaseInfoCommand extends PackageLoopingCommand {
             printError('  Existing NEXT section has unrecognized format.');
             return _ChangelogUpdateOutcome.failed;
           }
-          break;
         case _ChangelogUpdateState.finishedUpdating:
           // Once changes are done, add the rest of the lines as-is.
           newChangelog.writeln(line);
-          break;
       }
     }
 
diff --git a/script/tool/lib/src/version_check_command.dart b/script/tool/lib/src/version_check_command.dart
@@ -210,20 +210,16 @@ class VersionCheckCommand extends PackageLoopingCommand {
     switch (versionState) {
       case _CurrentVersionState.unchanged:
         versionChanged = false;
-        break;
       case _CurrentVersionState.validIncrease:
       case _CurrentVersionState.validRevert:
       case _CurrentVersionState.newPackage:
         versionChanged = true;
-        break;
       case _CurrentVersionState.invalidChange:
         versionChanged = true;
         errors.add('Disallowed version change.');
-        break;
       case _CurrentVersionState.unknown:
         versionChanged = false;
         errors.add('Unable to determine previous version.');
-        break;
     }
 
     if (!(await _validateChangelogVersion(package,
diff --git a/script/tool/pubspec.yaml b/script/tool/pubspec.yaml
@@ -28,7 +28,7 @@ dependencies:
 dev_dependencies:
   build_runner: ^2.0.3
   matcher: ^0.12.10
-  mockito: '>=5.3.2 <=5.4.0'
+  mockito: '>=5.3.2 <=5.5.0'
 
 environment:
-  sdk: '>=2.18.0 <4.0.0'
+  sdk: '>=3.0.0 <4.0.0'
diff --git a/script/tool/test/common/git_version_finder_test.dart b/script/tool/test/common/git_version_finder_test.dart
@@ -25,15 +25,14 @@ void main() {
       final List<String> arguments =
           invocation.positionalArguments[0]! as List<String>;
       gitDirCommands.add(arguments);
-      final MockProcessResult mockProcessResult = MockProcessResult();
+      String? gitStdOut;
       if (arguments[0] == 'diff') {
-        when<String?>(mockProcessResult.stdout as String?)
-            .thenReturn(gitDiffResponse);
+        gitStdOut = gitDiffResponse;
       } else if (arguments[0] == 'merge-base') {
-        when<String?>(mockProcessResult.stdout as String?)
-            .thenReturn(mergeBaseResponse);
+        gitStdOut = mergeBaseResponse;
       }
-      return Future<ProcessResult>.value(mockProcessResult);
+      return Future<ProcessResult>.value(
+          ProcessResult(0, 0, gitStdOut ?? '', ''));
     });
   });
 
@@ -128,5 +127,3 @@ file2/file2.cc
     verify(gitDir.runCommand(<String>['diff', '--name-only', customBaseSha]));
   });
 }
-
-class MockProcessResult extends Mock implements ProcessResult {}
diff --git a/script/tool/test/common/package_command_test.mocks.dart b/script/tool/test/common/package_command_test.mocks.dart
diff --git a/script/tool/test/common/package_looping_command_test.dart b/script/tool/test/common/package_looping_command_test.dart
diff --git a/script/tool/test/fetch_deps_command_test.dart b/script/tool/test/fetch_deps_command_test.dart
diff --git a/script/tool/test/util.dart b/script/tool/test/util.dart

Original file line number	Diff line number	Diff line change
`@@ -123,7 +123,6 @@ abstract class PackageLoopingCommand extends PackageCommand {`
`123`	`123`	`switch (packageLoopingType) {`
`124`	`124`	`case PackageLoopingType.topLevelOnly:`
`125`	`125`	`yield* getTargetPackages(filterExcluded: false);`
`126`		`- break;`
`127`	`126`	`case PackageLoopingType.includeExamples:`
`128`	`127`	`await for (final PackageEnumerationEntry packageEntry`
`129`	`128`	`in getTargetPackages(filterExcluded: false)) {`
`@@ -135,10 +134,8 @@ abstract class PackageLoopingCommand extends PackageCommand {`
`135`	`134`	`package,`
`136`	`135`	`excluded: packageEntry.excluded)));`
`137`	`136`	`}`
`138`		`- break;`
`139`	`137`	`case PackageLoopingType.includeAllSubpackages:`
`140`	`138`	`yield* getTargetPackagesAndSubpackages(filterExcluded: false);`
`141`		`- break;`
`142`	`139`	`}`
`143`	`140`	`}`
`144`	`141`
Original file line number	Diff line number	Diff line change
`@@ -42,26 +42,22 @@ class ListCommand extends PackageCommand {`
`42`	`42`	`await for (final PackageEnumerationEntry entry in getTargetPackages()) {`
`43`	`43`	`print(entry.package.path);`
`44`	`44`	`}`
`45`		`- break;`
`46`	`45`	`case _example:`
`47`	`46`	`final Stream<RepositoryPackage> examples = getTargetPackages()`
`48`	`47`	`.expand<RepositoryPackage>(`
`49`	`48`	`(PackageEnumerationEntry entry) => entry.package.getExamples());`
`50`	`49`	`await for (final RepositoryPackage package in examples) {`
`51`	`50`	`print(package.path);`
`52`	`51`	`}`
`53`		`- break;`
`54`	`52`	`case _allPackage:`
`55`	`53`	`await for (final PackageEnumerationEntry entry`
`56`	`54`	`in getTargetPackagesAndSubpackages()) {`
`57`	`55`	`print(entry.package.path);`
`58`	`56`	`}`
`59`		`- break;`
`60`	`57`	`case _file:`
`61`	`58`	`await for (final File file in getFiles()) {`
`62`	`59`	`print(file.path);`
`63`	`60`	`}`
`64`		`- break;`
`65`	`61`	`}`
`66`	`62`	`}`
`67`	`63`	`}`