feat(mobile) Add in app logging to show app's log information (#1014)

mobile/lib/shared/services/immich_logger.service.dart

@@ -0,0 +1,87 @@
+import 'dart:io';
+
+import 'package:flutter/widgets.dart';
+import 'package:hive/hive.dart';
+import 'package:immich_mobile/constants/hive_box.dart';
+import 'package:immich_mobile/shared/models/immich_logger_message.model.dart';
+import 'package:logging/logging.dart';
+import 'package:path_provider/path_provider.dart';
+import 'package:share_plus/share_plus.dart';
+
+/// [ImmichLogger] is a custom logger that is built on top of the [logging] package.
+/// The logs are written to a Hive box and onto console, using `debugPrint` method.
+///
+/// The logs are deleted when exceeding the `maxLogEntries` (default 200) property
+/// in the class.
+///
+/// Logs can be shared by calling the `shareLogs` method, which will open a share dialog
+/// and generate a csv file.
+class ImmichLogger {
+  final maxLogEntries = 200;
+  final Box<ImmichLoggerMessage> _box = Hive.box(immichLoggerBox);
+
+  List<ImmichLoggerMessage> get messages =>
+      _box.values.toList().reversed.toList();
+
+  ImmichLogger() {
+    _removeOverflowMessages();
+  }
+
+  init() {
+    Logger.root.level = Level.INFO;
+    Logger.root.onRecord.listen(_writeLogToHiveBox);
+  }
+
+  _removeOverflowMessages() {
+    if (_box.length > maxLogEntries) {
+      var numberOfEntryToBeDeleted = _box.length - maxLogEntries;
+      for (var i = 0; i < numberOfEntryToBeDeleted; i++) {
+        _box.deleteAt(0);
+      }
+    }
+  }
+
+  _writeLogToHiveBox(LogRecord record) {
+    final Box<ImmichLoggerMessage> box = Hive.box(immichLoggerBox);
+    var formattedMessage = record.message;
+
+    debugPrint('[${record.level.name}] [${record.time}] ${record.message}');
+    box.add(
+      ImmichLoggerMessage(
+        message: formattedMessage,
+        level: record.level.name,
+        createdAt: record.time,
+        context1: record.loggerName,
+        context2: record.stackTrace
+            ?.toString(), // Something more useful here? (e.g. stacktrace - I cannot get it to format nicely though)
+      ),
+    );
+  }
+
+  void clearLogs() {
+    _box.clear();
+  }
+
+  shareLogs() async {
+    var tempDir = await getTemporaryDirectory();
+    var filePath = '${tempDir.path}/${DateTime.now().toIso8601String()}.csv';
+    var logFile = await File(filePath).create();
+    // Write header
+    logFile.writeAsStringSync("created_at,context_1,context_2,message,type\n");
+
+    // Write messages
+    for (var message in messages) {
+      logFile.writeAsStringSync(
+        "${message.createdAt},${message.context1 ?? ""},${message.context2 ?? ""},${message.message},${message.level.toString()}\n",
+        mode: FileMode.append,
+      );
+    }
+
+    // Share file
+    Share.shareFiles(
+      [filePath],
+      subject: "Immich logs ${DateTime.now().toIso8601String()}",
+      sharePositionOrigin: Rect.zero,
+    );
+  }
+}