stricter lints

analysis_options.yaml

@@ -2,26 +2,49 @@ include: package:lints/recommended.yaml
 
 linter:
   rules:
-    camel_case_types: true
-    avoid_print: true
-    constant_identifier_names: true
-    prefer_final_locals: true
+    # We enable a few additional rules not in the default and recommended sets.
+    # Those in general have low impact on correct code apart from possibly requiring an additional keyword (like async,
+    # await, final) or asking you to move a statement to a different line.  However many of these linter rules make the
+    # code either more uniform or avoid bug prone behaviour. For example not awaiting a future usually is a mistake.
+    # You can always disable a linter warning with a comment like `// ignore: unawaited_futures`. Please add reasoning,
+    # why you disable the rule in such cases. This helps others understand, that you explicitly want a behaviour, that
+    # usually would be considered a mistake.
+
+    # Performance (or potential bugs)
+    # Fixing these warnings makes code easier to optimize for the compiler or prevents leaks.
+    cancel_subscriptions: true
     prefer_final_in_for_each: true
-    sort_pub_dependencies: true
-    always_use_package_imports: true
+    prefer_final_locals: true
+
+    # Warn about possible bugs
+    # Usually code with these warnings indicates a bug.
+    # Please document if your code explicitly wants such a behaviour.
     always_declare_return_types: true
-    prefer_single_quotes: true
-    sort_child_properties_last: true
+    discarded_futures: true
+    no_adjacent_strings_in_list: true
+    test_types_in_equals: true
+    throw_in_finally: true
     unawaited_futures: true
+    unnecessary_statements: true
     unsafe_html: true
-    avoid_function_literals_in_foreach_calls: false
+
+    # Readability & Style
+    # These are opinionated choices, where Dart gives us 2 ways to express the same thing.
+    # This avoids mental overhead by not having to make a choice and making code more uniform to read.
+    always_use_package_imports: true
+    avoid_bool_literals_in_conditional_expressions: true
+    prefer_single_quotes: true
+    sort_child_properties_last: true
+    sort_pub_dependencies: true
+
+    # Be nice to our users and allow them to configure what gets logged.
+    avoid_print: true
+
     non_constant_identifier_names: false # seems to wrongly diagnose static const variables
 
 analyzer:
   errors:
     todo: ignore
   exclude:
     - example/main.dart
-    # needed until crypto packages upgrade
-    - lib/src/database/database.g.dart
   plugins:

lib/encryption/encryption.dart

@@ -100,11 +100,12 @@ class Encryption {
 
   void handleDeviceOneTimeKeysCount(
       Map<String, int>? countJson, List<String>? unusedFallbackKeyTypes) {
-    runInRoot(() => olmManager.handleDeviceOneTimeKeysCount(
+    runInRoot(() async => olmManager.handleDeviceOneTimeKeysCount(
         countJson, unusedFallbackKeyTypes));
   }
 
   void onSync() {
+    // ignore: discarded_futures
     keyVerificationManager.cleanup();
   }
 
@@ -118,30 +119,25 @@ class Encryption {
         .contains(event.type)) {
       // "just" room key request things. We don't need these asap, so we handle
       // them in the background
-      // ignore: unawaited_futures
       runInRoot(() => keyManager.handleToDeviceEvent(event));
     }
     if (event.type == EventTypes.Dummy) {
       // the previous device just had to create a new olm session, due to olm session
       // corruption. We want to try to send it the last message we just sent it, if possible
-      // ignore: unawaited_futures
       runInRoot(() => olmManager.handleToDeviceEvent(event));
     }
     if (event.type.startsWith('m.key.verification.')) {
       // some key verification event. No need to handle it now, we can easily
       // do this in the background
 
-      // ignore: unawaited_futures
       runInRoot(() => keyVerificationManager.handleToDeviceEvent(event));
     }
     if (event.type.startsWith('m.secret.')) {
       // some ssss thing. We can do this in the background
-      // ignore: unawaited_futures
       runInRoot(() => ssss.handleToDeviceEvent(event));
     }
     if (event.sender == client.userID) {
       // maybe we need to re-try SSSS secrets
-      // ignore: unawaited_futures
       runInRoot(() => ssss.periodicallyRequestMissingCache());
     }
   }
@@ -157,14 +153,11 @@ class Encryption {
             update.content['content']['msgtype']
                 .startsWith('m.key.verification.'))) {
       // "just" key verification, no need to do this in sync
-
-      // ignore: unawaited_futures
       runInRoot(() => keyVerificationManager.handleEventUpdate(update));
     }
     if (update.content['sender'] == client.userID &&
         update.content['unsigned']?['transaction_id'] == null) {
       // maybe we need to re-try SSSS secrets
-      // ignore: unawaited_futures
       runInRoot(() => ssss.periodicallyRequestMissingCache());
     }
   }
@@ -239,6 +232,7 @@ class Encryption {
         // the entry should always exist. In the case it doesn't, the following
         // line *could* throw an error. As that is a future, though, and we call
         // it un-awaited here, nothing happens, which is exactly the result we want
+        // ignore: discarded_futures
         client.database?.updateInboundGroupSessionIndexes(
             json.encode(inboundGroupSession.indexes), roomId, sessionId);
       }
@@ -252,7 +246,7 @@ class Encryption {
                       ?.session_id() ??
                   '') ==
               content.sessionId) {
-        runInRoot(() =>
+        runInRoot(() async =>
             keyManager.clearOrUseOutboundGroupSession(roomId, wipe: true));
       }
       if (canRequestSession) {

lib/encryption/key_manager.dart

@@ -244,7 +244,8 @@ class KeyManager {
         !client.isUnknownSession) {
       // do e2ee recovery
       _requestedSessionIds.add(requestIdent);
-      runInRoot(() => request(
+
+      runInRoot(() async => request(
             room,
             sessionId,
             senderKey,
@@ -775,8 +776,8 @@ class KeyManager {
   Future<void>? _uploadingFuture;
 
   void startAutoUploadKeys() {
-    _uploadKeysOnSync = encryption.client.onSync.stream
-        .listen((_) => uploadInboundGroupSessions(skipIfInProgress: true));
+    _uploadKeysOnSync = encryption.client.onSync.stream.listen(
+        (_) async => uploadInboundGroupSessions(skipIfInProgress: true));
   }
 
   /// This task should be performed after sync processing but should not block
@@ -1064,6 +1065,7 @@ class KeyManager {
   StreamSubscription<SyncUpdate>? _uploadKeysOnSync;
 
   void dispose() {
+    // ignore: discarded_futures
     _uploadKeysOnSync?.cancel();
     for (final sess in _outboundGroupSessions.values) {
       sess.dispose();

lib/encryption/olm_manager.dart

@@ -396,20 +396,24 @@ class OlmManager {
     final device = client.userDeviceKeys[event.sender]?.deviceKeys.values
         .firstWhereOrNull((d) => d.curve25519Key == senderKey);
     final existingSessions = olmSessions[senderKey];
-    Future<void> updateSessionUsage([OlmSession? session]) =>
-        runInRoot(() async {
-          if (session != null) {
-            session.lastReceived = DateTime.now();
-            await storeOlmSession(session);
-          }
-          if (device != null) {
-            device.lastActive = DateTime.now();
-            await encryption.olmDatabase?.setLastActiveUserDeviceKey(
-                device.lastActive.millisecondsSinceEpoch,
-                device.userId,
-                device.deviceId!);
-          }
-        });
+    Future<void> updateSessionUsage([OlmSession? session]) async {
+      try {
+        if (session != null) {
+          session.lastReceived = DateTime.now();
+          await storeOlmSession(session);
+        }
+        if (device != null) {
+          device.lastActive = DateTime.now();
+          await encryption.olmDatabase?.setLastActiveUserDeviceKey(
+              device.lastActive.millisecondsSinceEpoch,
+              device.userId,
+              device.deviceId!);
+        }
+      } catch (e, s) {
+        Logs().e('Error while updating olm session timestamp', e, s);
+      }
+    }
+
     if (existingSessions != null) {
       for (final session in existingSessions) {
         if (session.session == null) {
@@ -446,14 +450,16 @@ class OlmManager {
         newSession.create_inbound_from(_olmAccount!, senderKey, body);
         _olmAccount!.remove_one_time_keys(newSession);
         await encryption.olmDatabase?.updateClientKeys(pickledOlmAccount!);
+
         plaintext = newSession.decrypt(type, body);
-        await runInRoot(() => storeOlmSession(OlmSession(
-              key: client.userID!,
-              identityKey: senderKey,
-              sessionId: newSession.session_id(),
-              session: newSession,
-              lastReceived: DateTime.now(),
-            )));
+
+        await storeOlmSession(OlmSession(
+          key: client.userID!,
+          identityKey: senderKey,
+          sessionId: newSession.session_id(),
+          session: newSession,
+          lastReceived: DateTime.now(),
+        ));
         await updateSessionUsage();
       } catch (e) {
         newSession.free();
@@ -570,8 +576,6 @@ class OlmManager {
       return _decryptToDeviceEvent(event);
     } catch (_) {
       // okay, the thing errored while decrypting. It is safe to assume that the olm session is corrupt and we should generate a new one
-
-      // ignore: unawaited_futures
       runInRoot(() => restoreOlmSession(event.senderId, senderKey));
 
       rethrow;
@@ -658,14 +662,18 @@ class OlmManager {
     final encryptResult = sess.first.session!.encrypt(json.encode(fullPayload));
     await storeOlmSession(sess.first);
     if (encryption.olmDatabase != null) {
-      await runInRoot(
-          () async => encryption.olmDatabase?.setLastSentMessageUserDeviceKey(
-              json.encode({
-                'type': type,
-                'content': payload,
-              }),
-              device.userId,
-              device.deviceId!));
+      try {
+        await encryption.olmDatabase?.setLastSentMessageUserDeviceKey(
+            json.encode({
+              'type': type,
+              'content': payload,
+            }),
+            device.userId,
+            device.deviceId!);
+      } catch (e, s) {
+        // we can ignore this error, since it would just make us use a different olm session possibly
+        Logs().w('Error while updating olm usage timestamp', e, s);
+      }
     }
     final encryptedBody = <String, dynamic>{
       'algorithm': AlgorithmTypes.olmV1Curve25519AesSha2,

lib/encryption/ssss.dart

@@ -31,7 +31,6 @@ import 'package:matrix/encryption/utils/ssss_cache.dart';
 import 'package:matrix/matrix.dart';
 import 'package:matrix/src/utils/cached_stream_controller.dart';
 import 'package:matrix/src/utils/crypto/crypto.dart' as uc;
-import 'package:matrix/src/utils/run_in_root.dart';
 
 const cacheTypes = <String>{
   EventTypes.CrossSigningSelfSigning,
@@ -722,7 +721,11 @@ class OpenSSSS {
       throw InvalidPassphraseException('Inalid key');
     }
     if (postUnlock) {
-      await runInRoot(() => _postUnlock());
+      try {
+        await _postUnlock();
+      } catch (e, s) {
+        Logs().e('Error during post unlock', e, s);
+      }
     }
   }
 

lib/encryption/utils/base64_unpadded.dart

@@ -3,7 +3,7 @@ import 'dart:typed_data';
 
 /// decodes base64
 ///
-/// Dart's native [base64.decode] requires a padded base64 input String.
+/// Dart's native [base64.decode()] requires a padded base64 input String.
 /// This function allows unpadded base64 too.
 ///
 /// See: https://github.com/dart-lang/sdk/issues/39510

lib/encryption/utils/key_verification.dart

@@ -267,11 +267,8 @@ class KeyVerification {
     }
 
     /// `qrCanWork` -  qr cannot work if we are verifying another master key but our own is unverified
-    final qrCanWork = (userId != client.userID)
-        ? ((client.userDeviceKeys[client.userID]?.masterKey?.verified ?? false)
-            ? true
-            : false)
-        : true;
+    final qrCanWork = (userId == client.userID) ||
+        ((client.userDeviceKeys[client.userID]?.masterKey?.verified ?? false));
 
     if (client.verificationMethods.contains(KeyVerificationMethod.qrShow) &&
         qrCanWork) {

lib/src/client.dart

@@ -1636,7 +1636,7 @@ class Client extends MatrixApi {
   set backgroundSync(bool enabled) {
     _backgroundSync = enabled;
     if (_backgroundSync) {
-      _sync();
+      runInRoot(() async => _sync());
     }
   }
 
@@ -2232,7 +2232,7 @@ class Client extends MatrixApi {
           requestHistoryOnLimitedTimeline) {
         Logs().v(
             'Limited timeline for ${rooms[roomIndex].id} request history now');
-        unawaited(runInRoot(rooms[roomIndex].requestHistory));
+        runInRoot(rooms[roomIndex].requestHistory);
       }
     }
     return room;

lib/src/database/hive_collections_database.dart

@@ -612,7 +612,7 @@ class HiveCollectionsDatabase extends DatabaseApi {
               // post-load the heroes
               final heroes = room.summary.mHeroes;
               if (heroes != null) {
-                heroes.forEach((hero) => membersToPostload.add(hero));
+                membersToPostload.addAll(heroes);
               }
             }
             // Load members
@@ -771,9 +771,9 @@ class HiveCollectionsDatabase extends DatabaseApi {
         .toList();
     final states = await _roomMembersBox.getAll(keys);
     states.removeWhere((state) => state == null);
-    states.forEach(
-      (state) => users.add(Event.fromJson(copyMap(state!), room).asUser),
-    );
+    for (final state in states) {
+      users.add(Event.fromJson(copyMap(state!), room).asUser);
+    }
 
     return users;
   }

lib/src/event.dart

@@ -128,6 +128,7 @@ class Event extends MatrixEvent {
         final json = toJson();
         json['unsigned'] ??= <String, dynamic>{};
         json['unsigned'][messageSendingStatusKey] = EventStatus.error.intValue;
+        // ignore: discarded_futures
         room.client.handleSync(
           SyncUpdate(
             nextBatch: '',
@@ -154,6 +155,7 @@ class Event extends MatrixEvent {
           MessageTypes.File,
         }.contains(messageType) &&
         !room.sendingFilePlaceholders.containsKey(eventId)) {
+      // ignore: discarded_futures
       remove();
     }
   }

lib/src/room.dart

@@ -1620,6 +1620,7 @@ class Room {
       return user.asUser;
     } else {
       if (mxID.isValidMatrixId) {
+        // ignore: discarded_futures
         requestUser(
           mxID,
           ignoreErrors: true,
@@ -2280,15 +2281,15 @@ class Room {
     }
 
     final Map<String, int> servers = {};
-    users.forEach((user) {
+    for (final user in users) {
       if (user.id.domain != null) {
         if (servers.containsKey(user.id.domain!)) {
           servers[user.id.domain!] = servers[user.id.domain!]! + 1;
         } else {
           servers[user.id.domain!] = 1;
         }
       }
-    });
+    }
     final sortedServers = Map.fromEntries(servers.entries.toList()
       ..sort((e1, e2) => e1.value.compareTo(e2.value)));
     for (var i = 0; i <= 2; i++) {