blob: 31f3bb1c8484b8ea87715f180ea5cb827323c475 [file] [log] [blame]
// Copyright 2017 The Chromium 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:async';
import 'package:http/http.dart' as http;
import 'package:meta/meta.dart';
import 'package:stack_trace/stack_trace.dart';
import 'base/io.dart';
import 'base/os.dart';
import 'base/platform.dart';
import 'globals.dart';
import 'usage.dart';
/// Tells crash backend that the error is from the Flutter CLI.
const String _kProductId = 'Flutter_Tools';
/// Tells crash backend that this is a Dart error as opposed to, say, Java.
const String _kDartTypeId = 'DartError';
/// Crash backend host.
const String _kCrashServerHost = '';
/// Path to the crash servlet.
const String _kCrashEndpointPath = '/cr/report';
/// The field corresponding to the multipart/form-data file attachment where
/// crash backend expects to find the Dart stack trace.
const String _kStackTraceFileField = 'DartError';
/// The name of the file attached as [_kStackTraceFileField].
/// The precise value is not important. It is ignored by the crash back end, but
/// it must be supplied in the request.
const String _kStackTraceFilename = 'stacktrace_file';
/// Sends crash reports to Google.
/// There are two ways to override the behavior of this class:
/// * Define a `FLUTTER_CRASH_SERVER_BASE_URL` environment variable that points
/// to a custom crash reporting server. This is useful if your development
/// environment is behind a firewall and unable to send crash reports to
/// Google, or when you wish to use your own server for collecting crash
/// reports from Flutter Tools.
/// * In tests call [initializeWith] and provide a mock implementation of
/// [http.Client].
class CrashReportSender {
static CrashReportSender _instance;
static CrashReportSender get instance => _instance ?? CrashReportSender._(http.Client());
/// Overrides the default [http.Client] with [client] for testing purposes.
static void initializeWith(http.Client client) {
_instance = CrashReportSender._(client);
final http.Client _client;
final Usage _usage = Usage.instance;
Uri get _baseUrl {
final String overrideUrl = platform.environment['FLUTTER_CRASH_SERVER_BASE_URL'];
if (overrideUrl != null) {
return Uri.parse(overrideUrl);
return Uri(
scheme: 'https',
host: _kCrashServerHost,
port: 443,
path: _kCrashEndpointPath,
/// Sends one crash report.
/// The report is populated from data in [error] and [stackTrace].
Future<void> sendReport({
@required dynamic error,
@required StackTrace stackTrace,
@required String getFlutterVersion(),
}) async {
try {
final String flutterVersion = getFlutterVersion();
// We don't need to report exceptions happening on user branches
if (_usage.suppressAnalytics || RegExp(r'^\[user-branch\]\/').hasMatch(flutterVersion)) {
printStatus('Sending crash report to Google.');
final Uri uri = _baseUrl.replace(
queryParameters: <String, String>{
'product': _kProductId,
'version': flutterVersion,
final http.MultipartRequest req = http.MultipartRequest('POST', uri);
req.fields['uuid'] = _usage.clientId;
req.fields['product'] = _kProductId;
req.fields['version'] = flutterVersion;
req.fields['osName'] = platform.operatingSystem;
req.fields['osVersion'] =; // this actually includes version
req.fields['type'] = _kDartTypeId;
req.fields['error_runtime_type'] = '${error.runtimeType}';
req.fields['error_message'] = '$error';
final String stackTraceWithRelativePaths = Chain.parse(stackTrace.toString()).terse.toString();
filename: _kStackTraceFilename,
final http.StreamedResponse resp = await _client.send(req);
if (resp.statusCode == 200) {
final String reportId = await http.ByteStream(
printStatus('Crash report sent (report ID: $reportId)');
} else {
printError('Failed to send crash report. Server responded with HTTP status code ${resp.statusCode}');
} catch (sendError, sendStackTrace) {
if (sendError is SocketException) {
printError('Failed to send crash report due to a network error: $sendError');
} else {
// If the sender itself crashes, just print. We did our best.
printError('Crash report sender itself crashed: $sendError\n$sendStackTrace');