Ian Hickson | 449f4a6 | 2019-11-27 15:04:02 -0800 | [diff] [blame] | 1 | // Copyright 2014 The Flutter Authors. All rights reserved. |
Todd Volkert | 454db9d | 2017-11-09 21:45:31 -0800 | [diff] [blame] | 2 | // Use of this source code is governed by a BSD-style license that can be |
| 3 | // found in the LICENSE file. |
| 4 | |
| 5 | import 'dart:async'; |
| 6 | |
| 7 | import 'package:args/command_runner.dart'; |
Devon Carew | 1c6078c | 2018-05-24 13:42:46 -0700 | [diff] [blame] | 8 | import 'package:intl/intl.dart' as intl; |
| 9 | import 'package:intl/intl_standalone.dart' as intl_standalone; |
Todd Volkert | 454db9d | 2017-11-09 21:45:31 -0800 | [diff] [blame] | 10 | import 'package:meta/meta.dart'; |
Todd Volkert | 454db9d | 2017-11-09 21:45:31 -0800 | [diff] [blame] | 11 | |
Todd Volkert | 454db9d | 2017-11-09 21:45:31 -0800 | [diff] [blame] | 12 | import 'src/base/common.dart'; |
Todd Volkert | 454db9d | 2017-11-09 21:45:31 -0800 | [diff] [blame] | 13 | import 'src/base/context.dart'; |
| 14 | import 'src/base/file_system.dart'; |
| 15 | import 'src/base/io.dart'; |
| 16 | import 'src/base/logger.dart'; |
Todd Volkert | 454db9d | 2017-11-09 21:45:31 -0800 | [diff] [blame] | 17 | import 'src/base/process.dart'; |
Jonah Williams | f7b8d62 | 2020-01-08 12:35:12 -0800 | [diff] [blame] | 18 | import 'src/base/terminal.dart'; |
Todd Volkert | 454db9d | 2017-11-09 21:45:31 -0800 | [diff] [blame] | 19 | import 'src/base/utils.dart'; |
Todd Volkert | 8d11f5c | 2018-03-28 10:58:28 -0700 | [diff] [blame] | 20 | import 'src/context_runner.dart'; |
Todd Volkert | 454db9d | 2017-11-09 21:45:31 -0800 | [diff] [blame] | 21 | import 'src/doctor.dart'; |
| 22 | import 'src/globals.dart'; |
Jenn Magder | 7d8f820 | 2019-11-26 14:06:31 -0800 | [diff] [blame] | 23 | import 'src/reporting/github_template.dart'; |
Zachary Anderson | ef146f6 | 2019-07-29 07:24:02 -0700 | [diff] [blame] | 24 | import 'src/reporting/reporting.dart'; |
Todd Volkert | 454db9d | 2017-11-09 21:45:31 -0800 | [diff] [blame] | 25 | import 'src/runner/flutter_command.dart'; |
| 26 | import 'src/runner/flutter_command_runner.dart'; |
Todd Volkert | 454db9d | 2017-11-09 21:45:31 -0800 | [diff] [blame] | 27 | import 'src/version.dart'; |
| 28 | |
| 29 | /// Runs the Flutter tool with support for the specified list of [commands]. |
| 30 | Future<int> run( |
| 31 | List<String> args, |
| 32 | List<FlutterCommand> commands, { |
Alexandre Ardhuin | 09276be | 2018-06-05 08:50:40 +0200 | [diff] [blame] | 33 | bool muteCommandLogging = false, |
| 34 | bool verbose = false, |
| 35 | bool verboseHelp = false, |
Todd Volkert | 454db9d | 2017-11-09 21:45:31 -0800 | [diff] [blame] | 36 | bool reportCrashes, |
| 37 | String flutterVersion, |
Jonah Williams | 81c7af3 | 2018-11-06 14:36:35 -0800 | [diff] [blame] | 38 | Map<Type, Generator> overrides, |
Todd Volkert | 8d11f5c | 2018-03-28 10:58:28 -0700 | [diff] [blame] | 39 | }) { |
Todd Volkert | 454db9d | 2017-11-09 21:45:31 -0800 | [diff] [blame] | 40 | reportCrashes ??= !isRunningOnBot; |
| 41 | |
jcollins-g | 26102c9 | 2018-02-01 10:27:55 -0800 | [diff] [blame] | 42 | if (muteCommandLogging) { |
| 43 | // Remove the verbose option; for help and doctor, users don't need to see |
| 44 | // verbose logs. |
Alexandre Ardhuin | d927c93 | 2018-09-12 08:29:29 +0200 | [diff] [blame] | 45 | args = List<String>.from(args); |
Todd Volkert | 454db9d | 2017-11-09 21:45:31 -0800 | [diff] [blame] | 46 | args.removeWhere((String option) => option == '-v' || option == '--verbose'); |
| 47 | } |
| 48 | |
Alexandre Ardhuin | d927c93 | 2018-09-12 08:29:29 +0200 | [diff] [blame] | 49 | final FlutterCommandRunner runner = FlutterCommandRunner(verboseHelp: verboseHelp); |
Todd Volkert | 454db9d | 2017-11-09 21:45:31 -0800 | [diff] [blame] | 50 | commands.forEach(runner.addCommand); |
| 51 | |
Todd Volkert | 8d11f5c | 2018-03-28 10:58:28 -0700 | [diff] [blame] | 52 | return runInContext<int>(() async { |
Todd Volkert | 454db9d | 2017-11-09 21:45:31 -0800 | [diff] [blame] | 53 | // Initialize the system locale. |
Devon Carew | 1c6078c | 2018-05-24 13:42:46 -0700 | [diff] [blame] | 54 | final String systemLocale = await intl_standalone.findSystemLocale(); |
| 55 | intl.Intl.defaultLocale = intl.Intl.verifiedLocale( |
| 56 | systemLocale, intl.NumberFormat.localeExists, |
Alexandre Ardhuin | 387f885 | 2019-03-01 08:17:55 +0100 | [diff] [blame] | 57 | onFailure: (String _) => 'en_US', |
Devon Carew | 1c6078c | 2018-05-24 13:42:46 -0700 | [diff] [blame] | 58 | ); |
Todd Volkert | 454db9d | 2017-11-09 21:45:31 -0800 | [diff] [blame] | 59 | |
Alexander Aprelev | d917978 | 2019-06-10 09:52:22 -0700 | [diff] [blame] | 60 | String getVersion() => flutterVersion ?? FlutterVersion.instance.getVersionString(redactUnknownBranches: true); |
Zachary Anderson | c7596da | 2019-07-31 13:51:19 -0700 | [diff] [blame] | 61 | Object firstError; |
| 62 | StackTrace firstStackTrace; |
Alexander Aprelev | d917978 | 2019-06-10 09:52:22 -0700 | [diff] [blame] | 63 | return await runZoned<Future<int>>(() async { |
| 64 | try { |
| 65 | await runner.run(args); |
| 66 | return await _exit(0); |
| 67 | } catch (error, stackTrace) { |
Zachary Anderson | c7596da | 2019-07-31 13:51:19 -0700 | [diff] [blame] | 68 | firstError = error; |
| 69 | firstStackTrace = stackTrace; |
Alexander Aprelev | d917978 | 2019-06-10 09:52:22 -0700 | [diff] [blame] | 70 | return await _handleToolError( |
| 71 | error, stackTrace, verbose, args, reportCrashes, getVersion); |
| 72 | } |
| 73 | }, onError: (Object error, StackTrace stackTrace) async { |
Zachary Anderson | c7596da | 2019-07-31 13:51:19 -0700 | [diff] [blame] | 74 | // If sending a crash report throws an error into the zone, we don't want |
| 75 | // to re-try sending the crash report with *that* error. Rather, we want |
| 76 | // to send the original error that triggered the crash report. |
| 77 | final Object e = firstError ?? error; |
| 78 | final StackTrace s = firstStackTrace ?? stackTrace; |
| 79 | await _handleToolError(e, s, verbose, args, reportCrashes, getVersion); |
Alexander Aprelev | d917978 | 2019-06-10 09:52:22 -0700 | [diff] [blame] | 80 | }); |
Jonah Williams | 81c7af3 | 2018-11-06 14:36:35 -0800 | [diff] [blame] | 81 | }, overrides: overrides); |
Todd Volkert | 454db9d | 2017-11-09 21:45:31 -0800 | [diff] [blame] | 82 | } |
| 83 | |
Todd Volkert | 454db9d | 2017-11-09 21:45:31 -0800 | [diff] [blame] | 84 | Future<int> _handleToolError( |
Alexandre Ardhuin | 5169ab5 | 2019-02-21 09:27:07 +0100 | [diff] [blame] | 85 | dynamic error, |
| 86 | StackTrace stackTrace, |
| 87 | bool verbose, |
| 88 | List<String> args, |
| 89 | bool reportCrashes, |
| 90 | String getFlutterVersion(), |
| 91 | ) async { |
Todd Volkert | 454db9d | 2017-11-09 21:45:31 -0800 | [diff] [blame] | 92 | if (error is UsageException) { |
Greg Spencer | 7caa659 | 2018-09-19 15:22:43 -0700 | [diff] [blame] | 93 | printError('${error.message}\n'); |
| 94 | printError("Run 'flutter -h' (or 'flutter <command> -h') for available flutter commands and options."); |
Todd Volkert | 454db9d | 2017-11-09 21:45:31 -0800 | [diff] [blame] | 95 | // Argument error exit code. |
| 96 | return _exit(64); |
| 97 | } else if (error is ToolExit) { |
Zachary Anderson | e2340c6 | 2019-09-13 14:51:35 -0700 | [diff] [blame] | 98 | if (error.message != null) { |
Greg Spencer | 7caa659 | 2018-09-19 15:22:43 -0700 | [diff] [blame] | 99 | printError(error.message); |
Zachary Anderson | e2340c6 | 2019-09-13 14:51:35 -0700 | [diff] [blame] | 100 | } |
| 101 | if (verbose) { |
Greg Spencer | 7caa659 | 2018-09-19 15:22:43 -0700 | [diff] [blame] | 102 | printError('\n$stackTrace\n'); |
Zachary Anderson | e2340c6 | 2019-09-13 14:51:35 -0700 | [diff] [blame] | 103 | } |
Todd Volkert | 454db9d | 2017-11-09 21:45:31 -0800 | [diff] [blame] | 104 | return _exit(error.exitCode ?? 1); |
| 105 | } else if (error is ProcessExit) { |
| 106 | // We've caught an exit code. |
| 107 | if (error.immediate) { |
| 108 | exit(error.exitCode); |
| 109 | return error.exitCode; |
| 110 | } else { |
| 111 | return _exit(error.exitCode); |
| 112 | } |
| 113 | } else { |
| 114 | // We've crashed; emit a log report. |
Todd Volkert | 2c898f6 | 2018-03-29 05:55:32 -0700 | [diff] [blame] | 115 | stderr.writeln(); |
Todd Volkert | 454db9d | 2017-11-09 21:45:31 -0800 | [diff] [blame] | 116 | |
| 117 | if (!reportCrashes) { |
| 118 | // Print the stack trace on the bots - don't write a crash report. |
Todd Volkert | 2c898f6 | 2018-03-29 05:55:32 -0700 | [diff] [blame] | 119 | stderr.writeln('$error'); |
| 120 | stderr.writeln(stackTrace.toString()); |
Todd Volkert | 454db9d | 2017-11-09 21:45:31 -0800 | [diff] [blame] | 121 | return _exit(1); |
Zachary Anderson | 36e8b93 | 2019-08-21 13:07:52 -0700 | [diff] [blame] | 122 | } |
| 123 | |
| 124 | // Report to both [Usage] and [CrashReportSender]. |
| 125 | flutterUsage.sendException(error); |
| 126 | await CrashReportSender.instance.sendReport( |
| 127 | error: error, |
| 128 | stackTrace: stackTrace, |
| 129 | getFlutterVersion: getFlutterVersion, |
| 130 | command: args.join(' '), |
| 131 | ); |
| 132 | |
Jenn Magder | 7d8f820 | 2019-11-26 14:06:31 -0800 | [diff] [blame] | 133 | final String errorString = error.toString(); |
| 134 | printError('Oops; flutter has exited unexpectedly: "$errorString".'); |
Zachary Anderson | 36e8b93 | 2019-08-21 13:07:52 -0700 | [diff] [blame] | 135 | |
| 136 | try { |
Jenn Magder | 7d8f820 | 2019-11-26 14:06:31 -0800 | [diff] [blame] | 137 | await _informUserOfCrash(args, error, stackTrace, errorString); |
| 138 | |
Zachary Anderson | 36e8b93 | 2019-08-21 13:07:52 -0700 | [diff] [blame] | 139 | return _exit(1); |
| 140 | } catch (error) { |
| 141 | stderr.writeln( |
| 142 | 'Unable to generate crash report due to secondary error: $error\n' |
| 143 | 'please let us know at https://github.com/flutter/flutter/issues.', |
| 144 | ); |
| 145 | // Any exception throw here (including one thrown by `_exit()`) will |
| 146 | // get caught by our zone's `onError` handler. In order to avoid an |
| 147 | // infinite error loop, we throw an error that is recognized above |
| 148 | // and will trigger an immediate exit. |
| 149 | throw ProcessExit(1, immediate: true); |
Todd Volkert | 454db9d | 2017-11-09 21:45:31 -0800 | [diff] [blame] | 150 | } |
| 151 | } |
| 152 | } |
| 153 | |
Jenn Magder | 7d8f820 | 2019-11-26 14:06:31 -0800 | [diff] [blame] | 154 | Future<void> _informUserOfCrash(List<String> args, dynamic error, StackTrace stackTrace, String errorString) async { |
| 155 | final String doctorText = await _doctorText(); |
| 156 | final File file = await _createLocalCrashReport(args, error, stackTrace, doctorText); |
| 157 | |
| 158 | printError('A crash report has been written to ${file.path}.'); |
| 159 | printStatus('This crash may already be reported. Check GitHub for similar crashes.', emphasis: true); |
| 160 | |
| 161 | final GitHubTemplateCreator gitHubTemplateCreator = context.get<GitHubTemplateCreator>() ?? GitHubTemplateCreator(); |
| 162 | final String similarIssuesURL = await gitHubTemplateCreator.toolCrashSimilarIssuesGitHubURL(errorString); |
| 163 | printStatus('$similarIssuesURL\n', wrap: false); |
| 164 | printStatus('To report your crash to the Flutter team, first read the guide to filing a bug.', emphasis: true); |
| 165 | printStatus('https://flutter.dev/docs/resources/bug-reports\n', wrap: false); |
| 166 | printStatus('Create a new GitHub issue by pasting this link into your browser and completing the issue template. Thank you!', emphasis: true); |
| 167 | |
| 168 | final String command = _crashCommand(args); |
| 169 | final String gitHubTemplateURL = await gitHubTemplateCreator.toolCrashIssueTemplateGitHubURL( |
| 170 | command, |
| 171 | errorString, |
| 172 | _crashException(error), |
| 173 | stackTrace, |
| 174 | doctorText |
| 175 | ); |
| 176 | printStatus('$gitHubTemplateURL\n', wrap: false); |
| 177 | } |
| 178 | |
| 179 | String _crashCommand(List<String> args) => 'flutter ${args.join(' ')}'; |
| 180 | |
| 181 | String _crashException(dynamic error) => '${error.runtimeType}: $error'; |
| 182 | |
Todd Volkert | 454db9d | 2017-11-09 21:45:31 -0800 | [diff] [blame] | 183 | /// File system used by the crash reporting logic. |
| 184 | /// |
| 185 | /// We do not want to use the file system stored in the context because it may |
| 186 | /// be recording. Additionally, in the case of a crash we do not trust the |
| 187 | /// integrity of the [AppContext]. |
| 188 | @visibleForTesting |
| 189 | FileSystem crashFileSystem = const LocalFileSystem(); |
| 190 | |
| 191 | /// Saves the crash report to a local file. |
Jenn Magder | 7d8f820 | 2019-11-26 14:06:31 -0800 | [diff] [blame] | 192 | Future<File> _createLocalCrashReport(List<String> args, dynamic error, StackTrace stackTrace, String doctorText) async { |
Todd Volkert | 454db9d | 2017-11-09 21:45:31 -0800 | [diff] [blame] | 193 | File crashFile = getUniqueFile(crashFileSystem.currentDirectory, 'flutter', 'log'); |
| 194 | |
Alexandre Ardhuin | d927c93 | 2018-09-12 08:29:29 +0200 | [diff] [blame] | 195 | final StringBuffer buffer = StringBuffer(); |
Todd Volkert | 454db9d | 2017-11-09 21:45:31 -0800 | [diff] [blame] | 196 | |
| 197 | buffer.writeln('Flutter crash report; please file at https://github.com/flutter/flutter/issues.\n'); |
| 198 | |
| 199 | buffer.writeln('## command\n'); |
Jenn Magder | 7d8f820 | 2019-11-26 14:06:31 -0800 | [diff] [blame] | 200 | buffer.writeln('${_crashCommand(args)}\n'); |
Todd Volkert | 454db9d | 2017-11-09 21:45:31 -0800 | [diff] [blame] | 201 | |
| 202 | buffer.writeln('## exception\n'); |
Jenn Magder | 7d8f820 | 2019-11-26 14:06:31 -0800 | [diff] [blame] | 203 | buffer.writeln('${_crashException(error)}\n'); |
Todd Volkert | 454db9d | 2017-11-09 21:45:31 -0800 | [diff] [blame] | 204 | buffer.writeln('```\n$stackTrace```\n'); |
| 205 | |
| 206 | buffer.writeln('## flutter doctor\n'); |
Jenn Magder | 7d8f820 | 2019-11-26 14:06:31 -0800 | [diff] [blame] | 207 | buffer.writeln('```\n$doctorText```'); |
Todd Volkert | 454db9d | 2017-11-09 21:45:31 -0800 | [diff] [blame] | 208 | |
| 209 | try { |
Zachary Anderson | 398ac1f | 2019-08-20 13:15:08 -0700 | [diff] [blame] | 210 | crashFile.writeAsStringSync(buffer.toString()); |
Todd Volkert | 454db9d | 2017-11-09 21:45:31 -0800 | [diff] [blame] | 211 | } on FileSystemException catch (_) { |
| 212 | // Fallback to the system temporary directory. |
| 213 | crashFile = getUniqueFile(crashFileSystem.systemTempDirectory, 'flutter', 'log'); |
| 214 | try { |
Zachary Anderson | 398ac1f | 2019-08-20 13:15:08 -0700 | [diff] [blame] | 215 | crashFile.writeAsStringSync(buffer.toString()); |
Todd Volkert | 454db9d | 2017-11-09 21:45:31 -0800 | [diff] [blame] | 216 | } on FileSystemException catch (e) { |
| 217 | printError('Could not write crash report to disk: $e'); |
| 218 | printError(buffer.toString()); |
| 219 | } |
| 220 | } |
| 221 | |
| 222 | return crashFile; |
| 223 | } |
| 224 | |
| 225 | Future<String> _doctorText() async { |
| 226 | try { |
Jonah Williams | f7b8d62 | 2020-01-08 12:35:12 -0800 | [diff] [blame] | 227 | final BufferLogger logger = BufferLogger( |
| 228 | terminal: terminal, |
| 229 | outputPreferences: outputPreferences, |
| 230 | ); |
Todd Volkert | 454db9d | 2017-11-09 21:45:31 -0800 | [diff] [blame] | 231 | |
Todd Volkert | f8058d7 | 2018-03-28 15:17:29 -0700 | [diff] [blame] | 232 | await context.run<bool>( |
Jenn Magder | 7d8f820 | 2019-11-26 14:06:31 -0800 | [diff] [blame] | 233 | body: () => doctor.diagnose(verbose: true, showColor: false), |
Todd Volkert | 8d11f5c | 2018-03-28 10:58:28 -0700 | [diff] [blame] | 234 | overrides: <Type, Generator>{ |
| 235 | Logger: () => logger, |
| 236 | }, |
| 237 | ); |
Todd Volkert | 454db9d | 2017-11-09 21:45:31 -0800 | [diff] [blame] | 238 | |
| 239 | return logger.statusText; |
| 240 | } catch (error, trace) { |
| 241 | return 'encountered exception: $error\n\n${trace.toString().trim()}\n'; |
| 242 | } |
| 243 | } |
| 244 | |
| 245 | Future<int> _exit(int code) async { |
Zachary Anderson | 372fe29 | 2019-11-05 10:43:52 -0800 | [diff] [blame] | 246 | // Prints the welcome message if needed. |
| 247 | flutterUsage.printWelcome(); |
Todd Volkert | 454db9d | 2017-11-09 21:45:31 -0800 | [diff] [blame] | 248 | |
| 249 | // Send any last analytics calls that are in progress without overly delaying |
| 250 | // the tool's exit (we wait a maximum of 250ms). |
| 251 | if (flutterUsage.enabled) { |
Alexandre Ardhuin | d927c93 | 2018-09-12 08:29:29 +0200 | [diff] [blame] | 252 | final Stopwatch stopwatch = Stopwatch()..start(); |
Todd Volkert | 454db9d | 2017-11-09 21:45:31 -0800 | [diff] [blame] | 253 | await flutterUsage.ensureAnalyticsSent(); |
| 254 | printTrace('ensureAnalyticsSent: ${stopwatch.elapsedMilliseconds}ms'); |
| 255 | } |
| 256 | |
| 257 | // Run shutdown hooks before flushing logs |
Zachary Anderson | 07161e8 | 2020-01-08 15:20:32 -0800 | [diff] [blame^] | 258 | await shutdownHooks.runShutdownHooks(); |
Todd Volkert | 454db9d | 2017-11-09 21:45:31 -0800 | [diff] [blame] | 259 | |
Alexandre Ardhuin | 2d3ff10 | 2018-10-05 07:54:56 +0200 | [diff] [blame] | 260 | final Completer<void> completer = Completer<void>(); |
Todd Volkert | 454db9d | 2017-11-09 21:45:31 -0800 | [diff] [blame] | 261 | |
| 262 | // Give the task / timer queue one cycle through before we hard exit. |
| 263 | Timer.run(() { |
| 264 | try { |
| 265 | printTrace('exiting with code $code'); |
| 266 | exit(code); |
| 267 | completer.complete(); |
| 268 | } catch (error, stackTrace) { |
| 269 | completer.completeError(error, stackTrace); |
| 270 | } |
| 271 | }); |
| 272 | |
| 273 | await completer.future; |
| 274 | return code; |
| 275 | } |