Отправляем ошибки из Flutter в Crash Reporters правильно

Hola, Amigos! На связи Павел Гершевич, Mobile Team Lead в Amiga, а также соавтор книги “Основы Flutter”. В данной статье рассмотрим, почему быстро настроенные Crash Reporter’ы на Flutter могут показывать ошибки неправильно и что с этим можно сделать.
Немного теории
Что такое Crash Reporter
Crash reporter - система, которая помогает нам разбираться с багами, когда они происходят не только при локальном запуске у нас на устройствах, но и при тестировании и даже после релиза.
Все такие системы похожи между собой, они показывают что за ошибка произошла, ее stack trace и устройства, на которых она воспроизводится. Чаще всего таких данных хватает для исправления. Но иногда указывается еще и тип - вылет, ANR (app not responding) или просто ошибка.
Давайте разберемся с основными системами, которые используются для этого на Flutter:
Firebase Crashlytics. Существует достаточно давно, рекомендуется Google, которой и разрабатывается после покупки компании Fabric.
Sentry. Система под все, в которой можно отслеживать баги не только из мобильного приложения, но и с сайтов и backend. Существует как облачный сервис, но чаще всего встречается как self-hosted решение.
AppMetrica. Сервис аналитики от Яндекса тоже умеет отслеживать внутри себя ошибки, но это не его основная работа.
Также можно было бы назвать сервис от Huawei для устройств с Huawei Mobile Services или Tracer от VK, у которого пока нет официального пакета для Flutter.
Самое главное - отлов и ранжирование ошибок. У многих эти функции есть автоматические, но они не всегда работает хорошо. Либо ловит не все, либо теряет данные, либо длинный текст в Row запишет как вылет.
В этой статье не будет о том, как выбрать Crash Reporter под себя. Поэтому далее в статье мы подсвечиваем не какой-то один, а смотрим настройки под все сразу.
Как Flutter кидает исключения и где их ловить
Для того, чтобы передача работала надежно, нужно сделать так, чтобы все ошибки мы могли получить при помощи кода и они не дублировались.
Как сделать, чтобы ошибка не пропала после ее обработки
Для начала, то, что мы уже обработали лучше всего передавать дальше. Это делается при помощи ключевого словаrethrow.
Такую ошибку Flutter не передаст дальше и она не появится в Crash Reporter:
try {
...
return User();
} catch (_) {
return null;
}В этом случае лучше всего подходит отлов ошибки позже, например, в state management. Давайте рассмотрим на примере BLoC:
// repository
Future<User> getUser() async {
...
return User();
}// BLoC
try {
... // Здесь изменяем на нужное состояние
} catch (_) {
emit(...); // Добавляем состояние ошибки
rethrow;
}Такой код доставит нашу ошибку прямо к местам отправки в Crash Reporter’ы, о которых мы и поговорим далее.
Места, где можно получить информацию об ошибках
Во-первых, ошибки, которые отправляет сам Flutter попадают в FlutterError.onError. Отсюда их можно забрать и отправить куда нам нужно. Обычно это какие-то ошибки из виджетов.
Например, мы попытаемся прочитать нулевую переменную со значением null и использованием восклицательного знака. То есть, сознательно приведем ее к ненулевому типу. Либо мы не добавили Expanded или Flexible для длинного текста внутри Row.
Во-вторых, абсолютно все ошибки, которые не отловил FlutterError.onError, попадут в PlatformDispatcher.instance.onError. Сюда идут и ошибки из state management, и с платформы.
Zone, помощник для отлова
Зона (Zone) - контекст выполнения, который сохраняется при асинхронной работе. У нее больше применений, чем просто отлов ошибок. Для нашей темы подходит именно запуск кода внутри определенной зоны через runZonedGuarded.
import 'dart:async';
void main() {
runZonedGuarded(
() {
Timer.run(() {
throw StateError('Не удалось загрузить профиль');
});
},
(error, stackTrace) {
print('Зона поймала ошибку: $error');
// Здесь можно передать error и stackTrace в Crash Reporter.
},
);
}А что за пределами основного изолята Flutter?
Такой вопрос возникает, когда ознакамливаешься со всеми методами, так как они работают только для основного изолята Flutter. Поэтому у нас есть несколько мест, которые нужно учесть.
Во-первых, нативные сбои внутри платформ. Их два типа - после вызова из MethodChannel или EventChannel и то, что падает за пределами вызова из Flutter. Первое выкидывает PlatformException, который попадает в ошибки основного изолята. Второе автоматически записывается при помощи SDK самих сервисов.
Во-вторых, отдельные изоляты. Тут тоже два типа - быстрая работа и долгоживущий воркер. Для первого, как и в случае с нативными задачами, мы можем отловить ошибку в основном изоляте.
А вот со вторым все сложнее. Если ошибку создания изолята мы можем легко отловить, но ошибки внутри него — нет. В таком случае нам нужно либо создавать дополнительный объект Crash Reporter внутри воркера, либо передавать ошибку в результате и обрабатывать ее после завершения.
import 'dart:isolate';
void worker(String task) {
throw StateError('Не удалось выполнить задачу $task');
}
Future<void> main() async {
final errors = ReceivePort();
try {
await Isolate.spawn(
worker,
'parse-json',
onError: errors.sendPort,
errorsAreFatal: true,
);
final message = await errors.first as List<dynamic>;
final error = message[0] as String;
final stackText = message[1] as String?;
final stackTrace =
stackText == null ? null : StackTrace.fromString(stackText);
// Здесь можно передать error и stackTrace в Crash Reporter.
print(error);
print(stackTrace);
} finally {
errors.close();
}
}Подписка устанавливается до запуска воркера, поэтому мы получим даже исключение из его первой строки. errorsAreFatal: true завершает воркер после необработанной ошибки, а основной изолят успевает принять и записать отчёт. В порт приходит строковое представление StateError, поэтому в основном изоляте error имеет тип String.
Настраиваем отправку в один или несколько Crash Reporter’ов
Мы уже ознакомились с работой crash reporter и местами, откуда мы будем ловить ошибки. Поэтому, давайте напишем обвязку для отправки.
Сначала нам нужен метод отправки, который будет отправлять сразу во все нужные нам места:
Future<void> logError(Object error, StackTrace st, bool isFatal) async {
await Future.wait([
Sentry.captureException(error, stacktrace: st),
AppMetrica.reportError(
errorDescription:
AppMetricaErrorDescription.fromObjectAndStackTrace(error, st),
),
FirebaseCrashlytics.instance.recordError(error, st, fatal: isFatal),
]);
}Обязательно делаем ошибку как Object, чтобы уже сами сервисы отделяли Exception от Error. А вот значение isFatal определяете вы при разработке. Оно зависит от того, насколько критична та или иная ошибка именно для вашего приложения.
Для FlutterError.onError можно тоже добавить такой метод:
Future<void> logFlutterError(
FlutterErrorDetails errorDetails,
bool isFatal
) async {
await Future.wait([
Sentry.captureException(
errorDetails.exception,
stacktrace: errorDetails.stack
),
AppMetrica.reportError(
errorDescription:
AppMetricaErrorDescription.fromFlutterErrorDetails(errorDetails),
),
isFatal
? FirebaseCrashlytics.instance.recordFlutterFatalError(errorDetails)
: FirebaseCrashlytics.instance.recordFlutterError(errorDetails),
]);
}Осталось только собрать и подключить все вместе в main.dart:
void main() {
runZonedGuarded(() {
WidgetsFlutterBinding.ensureInitialized();
... // Тут нужно проинициализировать Firebase, Sentry, AppMetrica
FlutterError.onError = (FlutterErrorDetails errorDetails) {
final isFatal = ... // Определяем isFatal
logFlutterError(errorDetails, isFatal);
};
PlatformDispatcher.instance.onError = (Object e, StackTrace st) {
final isFatal = … // Определяем isFatal
logError(e, st, isFatal);
return false; // Возвращаем false, чтобы получить ошибку в консоль
};
... // Остальная настройка, запуск приложения
}, (e, st) {
final isFatal = ... // Определяем isFatal
logError(e, st, isFatal);
}
);
}Вроде бы кажется, что все. Но мы в Amiga делаем еще одну настройку - отделяем ошибки 4xx и 5xx с backend, так как мы хотим видеть только исключения, которые выбрасывает именно мобильное приложение.
Заключение
В данной статье мы рассмотрели как правильно отправлять ошибки из Flutter в различные Crash Reporter, а также вывели несколько правил, которые в этом помогают:
Всегда делать
rethrow, даже если ошибка уже обработана;На старте проекта определяем, какие ошибки не должны лететь в crash reporter, а какие должны подсвечиваться как фатальные;
Если используется несколько crash reporter, то выносим отправку в отдельные методы;
Используем и
runZonedGuarded, иFlutterError.onError, иPlatformDispatcher.instance.onError.
KioskNews shows a cleaned-up reading view extracted from the publisher’s page — the original always lives on their site, not ours.