Clean up avoid_type_to_string suppressions

mvincentong · mvincentong · commit 29c127ebc0e6 · 2026-06-02T01:51:58.000+08:00
diff --git a/dev/bots/prepare_package/common.dart b/dev/bots/prepare_package/common.dart
@@ -22,7 +22,7 @@ enum Branch { beta, stable, master, main }
 
 /// Exception class for when a process fails to run, so we can catch
 /// it and provide something more readable than a stack trace.
-class PreparePackageException implements Exception {
+final class PreparePackageException implements Exception {
   PreparePackageException(this.message, [this.result]);
 
   final String message;
@@ -31,8 +31,7 @@ class PreparePackageException implements Exception {
 
   @override
   String toString() {
-    // ignore: avoid_type_to_string
-    var output = runtimeType.toString();
+    var output = '$PreparePackageException';
     output += ': $message';
     final String stderr = result?.stderr as String? ?? '';
     if (stderr.isNotEmpty) {
diff --git a/dev/bots/test/prepare_package_test.dart b/dev/bots/test/prepare_package_test.dart
@@ -21,6 +21,19 @@ import 'common.dart';
 
 void main() {
   const testRef = 'deadbeefdeadbeefdeadbeefdeadbeefdeadbeef';
+
+  test('PreparePackageException string includes class name and stderr', () {
+    final exception = PreparePackageException(
+      'failed to prepare package',
+      ProcessResult(0, 1, '', 'stderr details'),
+    );
+
+    expect(
+      exception.toString(),
+      'PreparePackageException: failed to prepare package:\nstderr details',
+    );
+  });
+
   test('Throws on missing executable', () async {
     // Uses a *real* process manager, since we want to know what happens if
     // it can't find an executable.
diff --git a/dev/bots/test/unpublish_package_test.dart b/dev/bots/test/unpublish_package_test.dart
@@ -0,0 +1,22 @@
+// Copyright 2014 The Flutter Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+import 'dart:io' show ProcessResult;
+
+import '../unpublish_package.dart';
+import 'common.dart';
+
+void main() {
+  test('UnpublishException string includes class name and stderr', () {
+    final exception = UnpublishException(
+      'failed to unpublish package',
+      ProcessResult(0, 1, '', 'stderr details'),
+    );
+
+    expect(
+      exception.toString(),
+      'UnpublishException: failed to unpublish package:\nstderr details',
+    );
+  });
+}
diff --git a/dev/bots/unpublish_package.dart b/dev/bots/unpublish_package.dart
@@ -30,7 +30,7 @@ const String baseUrl = 'https://storage.googleapis.com/flutter_infra_release';
 
 /// Exception class for when a process fails to run, so we can catch
 /// it and provide something more readable than a stack trace.
-class UnpublishException implements Exception {
+final class UnpublishException implements Exception {
   UnpublishException(this.message, [this.result]);
 
   final String message;
@@ -39,8 +39,7 @@ class UnpublishException implements Exception {
 
   @override
   String toString() {
-    // ignore: avoid_type_to_string
-    var output = runtimeType.toString();
+    var output = '$UnpublishException';
     output += ': $message';
     final String stderr = result?.stderr as String? ?? '';
     if (stderr.isNotEmpty) {
diff --git a/packages/flutter_tools/lib/runner.dart b/packages/flutter_tools/lib/runner.dart
@@ -243,6 +243,8 @@ Future<int> _handleToolErrorImpl(
       return exitWithHooks(1, shutdownHooks: shutdownHooks);
     }
 
+    // Flutter tool crash analytics benefits from the concrete Dart error type.
+    // The tool is not obfuscated, and collapsing unknown types to Object loses useful signal.
     // ignore: avoid_type_to_string
     globals.analytics.send(Event.exception(exception: error.runtimeType.toString()));
 
diff --git a/packages/flutter_tools/lib/src/reporting/github_template.dart b/packages/flutter_tools/lib/src/reporting/github_template.dart
@@ -68,8 +68,10 @@ class GitHubTemplateCreator {
       // Force comma separator to standardize.
       return 'String: <${NumberFormat(null, 'en_US').format(error.length)} characters>';
     }
-    // Exception, other.
-    return error.runtimeType.toString(); // ignore: avoid_type_to_string
+    // Tool crash issue templates benefit from the concrete Dart error type.
+    // The tool is not obfuscated, and collapsing unknown types loses useful signal.
+    // ignore: avoid_type_to_string
+    return error.runtimeType.toString();
   }
 
   /// GitHub URL to present to the user containing encoded suggested template.
diff --git a/packages/flutter_tools/test/general.shard/github_template_test.dart b/packages/flutter_tools/test/general.shard/github_template_test.dart
@@ -167,6 +167,10 @@ void main() {
           '_Exception',
         );
       });
+
+      testWithoutContext('custom Exception', () {
+        expect(GitHubTemplateCreator.sanitizedCrashException(FakeException()), 'FakeException');
+      });
     });
 
     group('new issue template URL', () {
@@ -302,3 +306,8 @@ class FakeError extends Error {
   @override
   String toString() => 'PII to ignore';
 }
+
+class FakeException implements Exception {
+  @override
+  String toString() => 'PII to ignore';
+}

Original file line number	Diff line number	Diff line change
`@@ -243,6 +243,8 @@ Future<int> _handleToolErrorImpl(`
`243`	`243`	`return exitWithHooks(1, shutdownHooks: shutdownHooks);`
`244`	`244`	`}`
`245`	`245`
	`246`	`+ // Flutter tool crash analytics benefits from the concrete Dart error type.`
	`247`	`+ // The tool is not obfuscated, and collapsing unknown types to Object loses useful signal.`
`246`	`248`	`// ignore: avoid_type_to_string`
`247`	`249`	`globals.analytics.send(Event.exception(exception: error.runtimeType.toString()));`
`248`	`250`
Original file line number	Diff line number	Diff line change
`@@ -68,8 +68,10 @@ class GitHubTemplateCreator {`
`68`	`68`	`// Force comma separator to standardize.`
`69`	`69`	`return 'String: <${NumberFormat(null, 'en_US').format(error.length)} characters>';`
`70`	`70`	`}`
`71`		`- // Exception, other.`
`72`		`- return error.runtimeType.toString(); // ignore: avoid_type_to_string`
	`71`	`+ // Tool crash issue templates benefit from the concrete Dart error type.`
	`72`	`+ // The tool is not obfuscated, and collapsing unknown types loses useful signal.`
	`73`	`+ // ignore: avoid_type_to_string`
	`74`	`+ return error.runtimeType.toString();`
`73`	`75`	`}`
`74`	`76`
`75`	`77`	`/// GitHub URL to present to the user containing encoded suggested template.`