mirror of https://github.com/flutter/samples.git
Fix crashlytics in game_template (#1998)
Filip Hracek
1 year ago
committed by
GitHub
parent
b0f2a6a86d
commit
612cf191d0
@ -1,103 +0,0 @@
|
||||
// Copyright 2022, the Flutter project authors. Please see the AUTHORS file
|
||||
// for details. 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 'dart:isolate';
|
||||
|
||||
import 'package:firebase_crashlytics/firebase_crashlytics.dart';
|
||||
import 'package:flutter/foundation.dart';
|
||||
import 'package:flutter/widgets.dart';
|
||||
import 'package:logging/logging.dart';
|
||||
|
||||
/// Runs [mainFunction] in a guarded [Zone].
|
||||
///
|
||||
/// If a non-null [FirebaseCrashlytics] instance is provided through
|
||||
/// [crashlytics], then all errors will be reported through it.
|
||||
///
|
||||
/// These errors will also include latest logs from anywhere in the app
|
||||
/// that use `package:logging`.
|
||||
Future<void> guardWithCrashlytics(
|
||||
void Function() mainFunction, {
|
||||
required FirebaseCrashlytics? crashlytics,
|
||||
}) async {
|
||||
// Running the initialization code and [mainFunction] inside a guarded
|
||||
// zone, so that all errors (even those occurring in callbacks) are
|
||||
// caught and can be sent to Crashlytics.
|
||||
await runZonedGuarded<Future<void>>(() async {
|
||||
if (kDebugMode) {
|
||||
// Log more when in debug mode.
|
||||
Logger.root.level = Level.FINE;
|
||||
}
|
||||
// Subscribe to log messages.
|
||||
Logger.root.onRecord.listen((record) {
|
||||
final message = '${record.level.name}: ${record.time}: '
|
||||
'${record.loggerName}: '
|
||||
'${record.message}';
|
||||
|
||||
debugPrint(message);
|
||||
// Add the message to the rotating Crashlytics log.
|
||||
crashlytics?.log(message);
|
||||
|
||||
if (record.level >= Level.SEVERE) {
|
||||
crashlytics?.recordError(message, filterStackTrace(StackTrace.current),
|
||||
fatal: true);
|
||||
}
|
||||
});
|
||||
|
||||
// Pass all uncaught errors from the framework to Crashlytics.
|
||||
if (crashlytics != null) {
|
||||
WidgetsFlutterBinding.ensureInitialized();
|
||||
FlutterError.onError = crashlytics.recordFlutterFatalError;
|
||||
}
|
||||
|
||||
if (!kIsWeb) {
|
||||
// To catch errors outside of the Flutter context, we attach an error
|
||||
// listener to the current isolate.
|
||||
Isolate.current.addErrorListener(RawReceivePort((dynamic pair) async {
|
||||
final errorAndStacktrace = pair as List<dynamic>;
|
||||
await crashlytics?.recordError(
|
||||
errorAndStacktrace.first, errorAndStacktrace.last as StackTrace?,
|
||||
fatal: true);
|
||||
}).sendPort);
|
||||
}
|
||||
|
||||
// Run the actual code.
|
||||
mainFunction();
|
||||
}, (error, stack) {
|
||||
// This sees all errors that occur in the runZonedGuarded zone.
|
||||
debugPrint('ERROR: $error\n\n'
|
||||
'STACK:$stack');
|
||||
crashlytics?.recordError(error, stack, fatal: true);
|
||||
});
|
||||
}
|
||||
|
||||
/// Takes a [stackTrace] and creates a new one, but without the lines that
|
||||
/// have to do with this file and logging. This way, Crashlytics won't group
|
||||
/// all messages that come from this file into one big heap just because
|
||||
/// the head of the StackTrace is identical.
|
||||
///
|
||||
/// See this:
|
||||
/// https://stackoverflow.com/questions/47654410/how-to-effectively-group-non-fatal-exceptions-in-crashlytics-fabrics.
|
||||
@visibleForTesting
|
||||
StackTrace filterStackTrace(StackTrace stackTrace) {
|
||||
try {
|
||||
final lines = stackTrace.toString().split('\n');
|
||||
final buf = StringBuffer();
|
||||
for (final line in lines) {
|
||||
if (line.contains('crashlytics.dart') ||
|
||||
line.contains('_BroadcastStreamController.java') ||
|
||||
line.contains('logger.dart')) {
|
||||
continue;
|
||||
}
|
||||
buf.writeln(line);
|
||||
}
|
||||
return StackTrace.fromString(buf.toString());
|
||||
} catch (e) {
|
||||
debugPrint('Problem while filtering stack trace: $e');
|
||||
}
|
||||
|
||||
// If there was an error while filtering,
|
||||
// return the original, unfiltered stack track.
|
||||
return stackTrace;
|
||||
}
|
||||
@ -1,39 +0,0 @@
|
||||
// Copyright 2022, the Flutter project authors. Please see the AUTHORS file
|
||||
// for details. All rights reserved. Use of this source code is governed by a
|
||||
// BSD-style license that can be found in the LICENSE file.
|
||||
|
||||
import 'package:game_template/src/crashlytics/crashlytics.dart';
|
||||
import 'package:test/test.dart';
|
||||
|
||||
void main() {
|
||||
group('filterStackTrace', () {
|
||||
test('keeps current stacktrace intact', () {
|
||||
final original = StackTrace.current;
|
||||
final filtered = filterStackTrace(original).toString().trim();
|
||||
|
||||
expect(filtered, equals(original.toString().trim()));
|
||||
});
|
||||
|
||||
test('parses an empty stacktrace', () {
|
||||
const original = StackTrace.empty;
|
||||
final filtered = filterStackTrace(original).toString().trim();
|
||||
|
||||
expect(filtered, equals(original.toString().trim()));
|
||||
});
|
||||
|
||||
test('removes the head of an example stacktrace', () {
|
||||
final original = StackTrace.fromString(
|
||||
''' at guardWithCrashlytics.<fn>.<fn>(crashlytics.dart:32)
|
||||
at _BroadcastStreamController.add(_BroadcastStreamController.java)
|
||||
at Logger._publish(logger.dart:276)
|
||||
at Logger.log(logger.dart:200)
|
||||
at Logger.severe(logger.dart:258)
|
||||
at GamesServicesController.initialize(games_services.dart:23)''');
|
||||
final filtered = filterStackTrace(original).toString().trim();
|
||||
|
||||
expect(filtered, isNot(original.toString().trim()));
|
||||
expect(filtered, isNot(contains('at guardWithCrashlytics')));
|
||||
expect(filtered, contains('at GamesServicesController'));
|
||||
});
|
||||
});
|
||||
}
|
||||
Loading…
Reference in new issue