feature: Save logging to cache directory (#196)

Co-authored-by: PartyDonut <PartyDonut@users.noreply.github.com>
This commit is contained in:
PartyDonut 2025-01-02 11:54:54 +01:00 committed by GitHub
parent ae4707d3a6
commit 1a42be4be0
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
5 changed files with 143 additions and 62 deletions

View file

@ -1,75 +1,32 @@
import 'package:flutter/foundation.dart';
import 'package:flutter/material.dart';
import 'dart:convert';
import 'dart:io';
import 'package:flutter/foundation.dart';
import 'package:collection/collection.dart';
import 'package:flutter_riverpod/flutter_riverpod.dart';
import 'package:logging/logging.dart';
import 'package:path_provider/path_provider.dart';
enum ErrorType {
severe,
warning,
shout,
}
import 'package:fladder/models/error_log_model.dart';
class ErrorViewModel {
final LogRecord rec;
final crashLogProvider = StateNotifierProvider<CrashLogNotifier, List<ErrorLogModel>>((ref) => CrashLogNotifier());
const ErrorViewModel({required this.rec});
ErrorType get type {
if (rec.level == Level.WARNING) {
return ErrorType.warning;
}
if (rec.level == Level.SHOUT) {
return ErrorType.shout;
}
return ErrorType.severe;
}
String get label {
var join = [
type.name.toUpperCase(),
" | ",
rec.message,
].join();
if (join.length > 250) {
return "${join.substring(0, 80)}... \n \nTruncated copy log to see more";
} else {
return join;
}
}
String get content => [
rec.time.toIso8601String(),
"\n",
"\n",
rec.stackTrace,
].whereNotNull().join();
String get clipBoard => [label, content].toString();
Color get color => switch (type) {
ErrorType.severe => Colors.redAccent,
ErrorType.warning => Colors.orange,
ErrorType.shout => Colors.yellowAccent,
};
}
final crashLogProvider = StateNotifierProvider<CrashLogNotifier, List<ErrorViewModel>>((ref) => CrashLogNotifier());
class CrashLogNotifier extends StateNotifier<List<ErrorViewModel>> {
class CrashLogNotifier extends StateNotifier<List<ErrorLogModel>> {
CrashLogNotifier() : super([]) {
init();
}
late final Logger logger;
final maxLength = 100;
final maxLength = 50;
String? logFilePath;
void init() {
void init() async {
logger = Logger.root;
logger.level = Level.ALL;
logger.onRecord.listen(logPrint);
FlutterError.onError = (FlutterErrorDetails details) => logFile(details);
PlatformDispatcher.instance.onError = (error, stack) {
logFile(FlutterErrorDetails(
exception: error,
@ -78,10 +35,40 @@ class CrashLogNotifier extends StateNotifier<List<ErrorViewModel>> {
));
return false;
};
if (!kIsWeb) {
await _initializeLogFile();
await _loadLogsFromFile();
}
}
Future<void> _initializeLogFile() async {
final directory = await getApplicationCacheDirectory();
logFilePath = '${directory.path}/crash_logs.json';
}
Future<void> _loadLogsFromFile() async {
if (logFilePath == null) return;
final file = File(logFilePath!);
if (await file.exists()) {
final content = await file.readAsString();
final List<dynamic> jsonData = jsonDecode(content);
state = jsonData.map((json) => ErrorLogModel.fromJson(json)).toList();
}
}
Future<void> _saveLogsToFile() async {
if (logFilePath == null) return;
final file = File(logFilePath!);
final jsonData = state.map((log) => log.toJson()).toList();
await file.writeAsString(jsonEncode(jsonData));
}
void clearLogs() {
state = [];
if (!kIsWeb) {
_saveLogsToFile();
}
}
void logPrint(LogRecord rec) {
@ -89,16 +76,18 @@ class CrashLogNotifier extends StateNotifier<List<ErrorViewModel>> {
print('${rec.level.name}: ${rec.time}: ${rec.message}');
}
if (rec.level > Level.INFO) {
state = [ErrorViewModel(rec: rec), ...state];
state = [ErrorLogModel.fromLogRecord(rec), ...state];
if (state.length >= maxLength) {
state = state.sublist(0, maxLength);
}
if (!kIsWeb) {
_saveLogsToFile();
}
}
}
void logFile(FlutterErrorDetails details) {
logger.severe('Flutter error: ${details.exception}', details.exception, details.stack);
if (details.stack != null && kDebugMode) {
print('${details.stack}');
}