Handle logs and new logs page (#130)

- Logs from rover devices are now shown in the logs page
 - important logs are shown in the footer
 - critical logs stay in the footer until manually cleared
 - clicking the footer goes to the logs page
 - logs page has autoscroll, device and level filter, help page
 - can even reset any device from the logs page
 - introduced ReactiveWidget
 - 📎
 - Bumped version

Author: Levi-Lesches

assets/clippy.webp

@@ -33,10 +33,16 @@ class RoverControlDashboard extends StatelessWidget {
 				home: SplashPage(),
 				debugShowCheckedModeBanner: false,
 				theme: ThemeData(
+          useMaterial3: false,
 					colorScheme: const ColorScheme.light(
 						primary: binghamtonGreen,
 						secondary: binghamtonGreen,
 					),
+          appBarTheme: const AppBarTheme(
+            backgroundColor: binghamtonGreen,
+            // titleTextStyle: TextStyle(color: Colors.white),
+            foregroundColor: Colors.white,
+          ),
 				),
 				darkTheme: ThemeData.from(
 					colorScheme: const ColorScheme.dark(

lib/app.dart

@@ -28,3 +28,4 @@ export "src/data/science.dart";
 export "src/data/settings.dart";
 export "src/data/socket.dart";
 export "src/data/taskbar_message.dart";
+export "src/data/utils.dart";

lib/data.dart

@@ -27,7 +27,7 @@ void main() async {
 			if (error is SocketException && networkErrors.contains(error.osError!.errorCode)) {
 				models.home.setMessage(severity: Severity.critical, text: "Network error, restart by clicking the network icon");
 			} else {
-        models.home.setMessage(severity: Severity.critical, text: "Error occurred in the dashboard. See the logs");
+        models.home.setMessage(severity: Severity.critical, text: "Dashboard error. See the logs");
         await services.files.logError(error, stack);
 				Error.throwWithStackTrace(error, stack);
 			}

lib/main.dart

@@ -10,6 +10,7 @@
 library models;
 
 import "src/models/model.dart";
+import "src/models/data/logs.dart";
 import "src/models/data/home.dart";
 import "src/models/data/messages.dart";
 import "src/models/data/serial.dart";
@@ -23,6 +24,7 @@ export "src/models/model.dart";
 
 // Data models
 export "src/models/data/home.dart";
+export "src/models/data/logs.dart";
 export "src/models/data/messages.dart";
 export "src/models/data/serial.dart";
 export "src/models/data/settings.dart";
@@ -38,6 +40,7 @@ export "src/models/rover/rover.dart";
 
 // View models
 export "src/models/view/autonomy.dart";
+export "src/models/view/logs.dart";
 export "src/models/view/mars.dart";
 export "src/models/view/science.dart";
 export "src/models/view/timer.dart";
@@ -89,12 +92,16 @@ class Models extends Model {
 
 	/// The messages model.
 	final messages = MessagesModel();
+  
+  /// The logs model.
+  final logs = LogsModel();
 
 	@override
 	Future<void> init() async {
 		// initialize all models here
 		await settings.init();
 		await home.init();
+    await logs.init();
 		await video.init();
 		await rover.init();
 		await serial.init();

lib/models.dart

@@ -9,6 +9,7 @@ library pages;
 export "src/pages/autonomy.dart";
 export "src/pages/home.dart";
 export "src/pages/science.dart";
+export "src/pages/logs.dart";
 export "src/pages/settings.dart";
 export "src/pages/splash.dart";
 
@@ -31,6 +32,9 @@ class Routes {
 	/// The name of the MARS page.
 	static const String mars = "MARS";
 
+  /// The name of the logs page.
+  static const String logs = "Logs";
+
 	/// The name of the blank page.
 	static const String blank = "blank";
 }

lib/pages.dart

@@ -1,5 +1,6 @@
 import "dart:math";
 
+import "package:protobuf/protobuf.dart";
 import "package:rover_dashboard/data.dart";
 
 export "package:protobuf/protobuf.dart" show GeneratedMessageGenericExtensions;
@@ -40,6 +41,16 @@ String getDataName(Device device) => switch (device) {
 	_ => "Unknown",
 };
 
+/// Utilities for a list of Protobuf enums.
+extension UndefinedFilter<T extends ProtobufEnum> on List<T> {
+  /// Filters out `_UNDEFINED` values from the list.
+  List<T> get filtered => [
+    for (final value in this) 
+      if (value.value != 0)
+        value, 
+  ];
+}
+
 /// Utilities for [Timestamp]s.
 extension TimestampUtils on Timestamp {
 	/// The [Timestamp] version of [DateTime.now].
@@ -65,6 +76,7 @@ extension RoverStatusHumanName on RoverStatus {
 			case RoverStatus.MANUAL: return "Manual";
 			case RoverStatus.AUTONOMOUS: return "Autonomous";
 			case RoverStatus.POWER_OFF: return "Off";
+      case RoverStatus.RESTART: return "Restart";
 		}
 		// Do not use default or else you'll lose exhaustiveness checking.
 		throw ArgumentError("Unrecognized rover status: $this");
@@ -131,7 +143,7 @@ extension DeviceUtils on Device {
 	/// Gets a user-friendly name for a [Device].
 	String get humanName {
 		switch(this) {
-			case Device.DEVICE_UNDEFINED: return "";
+			case Device.DEVICE_UNDEFINED: return "Unknown device";
 			case Device.DASHBOARD: return "Dashboard";
 			case Device.SUBSYSTEMS: return "Subsystems";
 			case Device.VIDEO: return "Video";
@@ -252,3 +264,43 @@ extension MotorDirectionUtils on MotorDirection {
 		throw ArgumentError("Unrecognized MotorDirection: $this");
 	}
 }
+
+/// More human-friendly fields for [BurtLogLevel]s.
+extension LogLevelUtils on BurtLogLevel {
+  /// The human-readable name of this level.
+  String get humanName => switch(this) {
+    BurtLogLevel.critical => "Critical",
+    BurtLogLevel.error => "Error",
+    BurtLogLevel.warning => "Warning",
+    BurtLogLevel.info => "Info",
+    BurtLogLevel.debug => "Debug",
+    BurtLogLevel.trace => "Trace",
+    _ => "Unknown",
+  };
+
+  /// The label to represent this log.
+  String get label => switch(this) {
+    BurtLogLevel.critical => "[C]",
+    BurtLogLevel.error => "[E]",
+    BurtLogLevel.warning => "[W]",
+    BurtLogLevel.info => "[I]",
+    BurtLogLevel.debug => "[D]",
+    BurtLogLevel.trace => "[T]",
+    _ => "?",
+  };
+}
+
+/// Fomats [BurtLog] messages in plain-text. For the UI, use widgets.
+extension LogFormat on BurtLog {
+  /// Fomats [BurtLog] messages in plain-text. For the UI, use widgets.
+  String format() {
+    final result = StringBuffer()
+      ..write(level.label)
+      ..write(" ")
+      ..write(title);
+    if (body.isNotEmpty) {
+      result..write("\n  ")..write(body);
+    }
+    return result.toString();
+  }
+}

lib/src/data/protobuf.dart

@@ -202,19 +202,24 @@ class AutonomySettings {
 class EasterEggsSettings {
   /// Whether to do a SEGA-like intro during boot.
   final bool segaIntro;
+  /// Whether clippy should appear by log messages.
+  final bool enableClippy;
 
   /// A const constructor.
   const EasterEggsSettings({
     required this.segaIntro,
+    required this.enableClippy,
   });
 
   /// Parses easter eggs settings from JSON.
   EasterEggsSettings.fromJson(Json? json) : 
-    segaIntro = json?["segaIntro"] ?? true;
+    segaIntro = json?["segaIntro"] ?? true,
+    enableClippy = json?["enableClippy"] ?? true;
 
   /// Serializes these settings to JSON.
   Json toJson() => {
     "segaIntro": segaIntro,
+    "enableClippy": enableClippy,
   };
 }
 

lib/src/data/settings.dart

@@ -0,0 +1,15 @@
+/// Helpful extensions on maps.
+extension MapRecords<K, V> on Map<K, V> {
+  /// A list of key-value records in this map. Allows easier iteration than [entries].
+  Iterable<(K, V)> get records sync* {
+    for (final entry in entries) {
+      yield (entry.key, entry.value);
+    }
+  }
+}
+
+/// Helpful extensions on [DateTime]s.
+extension DateTimeTimestamp on DateTime{
+  /// Formats this [DateTime] as a simple timestamp.
+  String get timeStamp => "$year-$month-$day-$hour-$minute"; 
+}

lib/src/data/utils.dart

@@ -10,6 +10,9 @@ class HomeModel extends Model {
 	/// The message currently displaying on the taskbar.
 	TaskbarMessage? message;
 
+  /// Whether the current message is an error.
+  bool _hasError = false;
+
 	/// The timer responsible for clearing the [message].
 	Timer? _messageTimer;
 
@@ -21,16 +24,35 @@ class HomeModel extends Model {
 
 	@override
 	Future<void> init() async { 
+    models.settings.addListener(notifyListeners);
 		final info = await PackageInfo.fromPlatform();
 		version = "${info.version}+${info.buildNumber}";
 		if (services.error != null) setMessage(severity: Severity.critical, text: services.error!);
 	}
 
 	/// Sets a new message that will disappear in 3 seconds.
-	void setMessage({required Severity severity, required String text}) {
+	void setMessage({required Severity severity, required String text, bool permanent = false}) {
+    if (_hasError) return;  // Don't replace error messages
 		_messageTimer?.cancel();  // the new message might be cleared if the old one were about to
 		message = TaskbarMessage(severity: severity, text: text);
 		notifyListeners();
-		_messageTimer = Timer(const Duration(seconds: 3), () { message = null; notifyListeners(); });
+    if (permanent) _hasError = true;
+    _messageTimer = Timer(const Duration(seconds: 3), clear);
 	} 
+
+  /// Clears the current message. Errors won't be cleared unless [clearErrors] is set.
+  void clear({bool clearErrors = false}) {
+    if (_hasError && !clearErrors) return;
+    _hasError = false;
+    message = null;
+    notifyListeners();
+  }
+
+  @override
+  void dispose() {
+    _messageTimer?.cancel();
+    mission.cancel();
+    models.settings.removeListener(notifyListeners);
+    super.dispose();
+  }
 }