Merge pull request #1720 from matthiasn/feat/matrix_setup_modal

feat: add Matrix setup modal

.gitignore

@@ -81,3 +81,4 @@ whisper.cpp/whisper.cpp-*/
 
 integration_test/docker/config/jetstream/
 integration_test/docker/config/logs/
+integration_test/docker/config/media_store/

integration_test/build/.last_build_id

@@ -0,0 +1 @@
+e581f07cdf2a87cf03a4c057574d76e4

lib/beamer/locations/settings_location.dart

@@ -23,7 +23,6 @@ import 'package:lotti/pages/settings/measurables/measurables_page.dart';
 import 'package:lotti/pages/settings/outbox/outbox_monitor.dart';
 import 'package:lotti/pages/settings/settings_page.dart';
 import 'package:lotti/pages/settings/speech/speech_settings_page.dart';
-import 'package:lotti/pages/settings/sync/matrix_settings_page.dart';
 import 'package:lotti/pages/settings/sync/sync_assistant_page.dart';
 import 'package:lotti/pages/settings/tags/create_tag_page.dart';
 import 'package:lotti/pages/settings/tags/tag_edit_page.dart';
@@ -252,12 +251,6 @@ class SettingsLocation extends BeamLocation<BeamState> {
           child: SyncAssistantPage(),
         ),
 
-      if (pathContains('advanced/matrix_settings'))
-        const BeamPage(
-          key: ValueKey('settings-matrix_settings'),
-          child: MatrixSettingsPage(),
-        ),
-
       if (pathContains('advanced/outbox_monitor'))
         const BeamPage(
           key: ValueKey('settings-outbox_monitor'),

lib/classes/config.dart

@@ -23,7 +23,6 @@ class MatrixConfig with _$MatrixConfig {
     required String homeServer,
     required String user,
     required String password,
-    String? roomId,
   }) = _MatrixConfig;
 
   factory MatrixConfig.fromJson(Map<String, dynamic> json) =>

lib/classes/config.freezed.dart

@@ -238,7 +238,6 @@ mixin _$MatrixConfig {
   String get homeServer => throw _privateConstructorUsedError;
   String get user => throw _privateConstructorUsedError;
   String get password => throw _privateConstructorUsedError;
-  String? get roomId => throw _privateConstructorUsedError;
 
   Map<String, dynamic> toJson() => throw _privateConstructorUsedError;
   @JsonKey(ignore: true)
@@ -252,7 +251,7 @@ abstract class $MatrixConfigCopyWith<$Res> {
           MatrixConfig value, $Res Function(MatrixConfig) then) =
       _$MatrixConfigCopyWithImpl<$Res, MatrixConfig>;
   @useResult
-  $Res call({String homeServer, String user, String password, String? roomId});
+  $Res call({String homeServer, String user, String password});
 }
 
 /// @nodoc
@@ -271,7 +270,6 @@ class _$MatrixConfigCopyWithImpl<$Res, $Val extends MatrixConfig>
     Object? homeServer = null,
     Object? user = null,
     Object? password = null,
-    Object? roomId = freezed,
   }) {
     return _then(_value.copyWith(
       homeServer: null == homeServer
@@ -286,10 +284,6 @@ class _$MatrixConfigCopyWithImpl<$Res, $Val extends MatrixConfig>
           ? _value.password
           : password // ignore: cast_nullable_to_non_nullable
               as String,
-      roomId: freezed == roomId
-          ? _value.roomId
-          : roomId // ignore: cast_nullable_to_non_nullable
-              as String?,
     ) as $Val);
   }
 }
@@ -302,7 +296,7 @@ abstract class _$$MatrixConfigImplCopyWith<$Res>
       __$$MatrixConfigImplCopyWithImpl<$Res>;
   @override
   @useResult
-  $Res call({String homeServer, String user, String password, String? roomId});
+  $Res call({String homeServer, String user, String password});
 }
 
 /// @nodoc
@@ -319,7 +313,6 @@ class __$$MatrixConfigImplCopyWithImpl<$Res>
     Object? homeServer = null,
     Object? user = null,
     Object? password = null,
-    Object? roomId = freezed,
   }) {
     return _then(_$MatrixConfigImpl(
       homeServer: null == homeServer
@@ -334,10 +327,6 @@ class __$$MatrixConfigImplCopyWithImpl<$Res>
           ? _value.password
           : password // ignore: cast_nullable_to_non_nullable
               as String,
-      roomId: freezed == roomId
-          ? _value.roomId
-          : roomId // ignore: cast_nullable_to_non_nullable
-              as String?,
     ));
   }
 }
@@ -346,10 +335,7 @@ class __$$MatrixConfigImplCopyWithImpl<$Res>
 @JsonSerializable()
 class _$MatrixConfigImpl implements _MatrixConfig {
   const _$MatrixConfigImpl(
-      {required this.homeServer,
-      required this.user,
-      required this.password,
-      this.roomId});
+      {required this.homeServer, required this.user, required this.password});
 
   factory _$MatrixConfigImpl.fromJson(Map<String, dynamic> json) =>
       _$$MatrixConfigImplFromJson(json);
@@ -360,12 +346,10 @@ class _$MatrixConfigImpl implements _MatrixConfig {
   final String user;
   @override
   final String password;
-  @override
-  final String? roomId;
 
   @override
   String toString() {
-    return 'MatrixConfig(homeServer: $homeServer, user: $user, password: $password, roomId: $roomId)';
+    return 'MatrixConfig(homeServer: $homeServer, user: $user, password: $password)';
   }
 
   @override
@@ -377,14 +361,12 @@ class _$MatrixConfigImpl implements _MatrixConfig {
                 other.homeServer == homeServer) &&
             (identical(other.user, user) || other.user == user) &&
             (identical(other.password, password) ||
-                other.password == password) &&
-            (identical(other.roomId, roomId) || other.roomId == roomId));
+                other.password == password));
   }
 
   @JsonKey(ignore: true)
   @override
-  int get hashCode =>
-      Object.hash(runtimeType, homeServer, user, password, roomId);
+  int get hashCode => Object.hash(runtimeType, homeServer, user, password);
 
   @JsonKey(ignore: true)
   @override
@@ -404,8 +386,7 @@ abstract class _MatrixConfig implements MatrixConfig {
   const factory _MatrixConfig(
       {required final String homeServer,
       required final String user,
-      required final String password,
-      final String? roomId}) = _$MatrixConfigImpl;
+      required final String password}) = _$MatrixConfigImpl;
 
   factory _MatrixConfig.fromJson(Map<String, dynamic> json) =
       _$MatrixConfigImpl.fromJson;
@@ -417,8 +398,6 @@ abstract class _MatrixConfig implements MatrixConfig {
   @override
   String get password;
   @override
-  String? get roomId;
-  @override
   @JsonKey(ignore: true)
   _$$MatrixConfigImplCopyWith<_$MatrixConfigImpl> get copyWith =>
       throw _privateConstructorUsedError;

lib/database/settings_db.dart

@@ -34,6 +34,13 @@ class SettingsDb extends _$SettingsDb {
     return into(settings).insertOnConflictUpdate(settingsItem);
   }
 
+  Future<void> removeSettingsItem(String configKey) async {
+    final existing = await watchSettingsItemByKey(configKey).first;
+    if (existing.isNotEmpty) {
+      await delete(settings).delete(existing.first);
+    }
+  }
+
   Stream<List<SettingsItem>> watchSettingsItemByKey(String configKey) {
     return settingsItemByKey(configKey).watch();
   }

lib/get_it.dart

@@ -75,7 +75,7 @@ Future<void> registerSingletons() async {
     ..registerSingleton<Maintenance>(Maintenance())
     ..registerSingleton<NavService>(NavService());
 
-  unawaited(getIt<MatrixService>().loginAndListen());
+  unawaited(getIt<MatrixService>().init());
 
   await initConfigFlags(getIt<JournalDb>(), inMemoryDatabase: false);
 }

lib/l10n/app_en.arb

@@ -202,6 +202,15 @@
   "settingsMatrixSaveLabel": "Save",
   "settingsMatrixStartVerificationLabel": "Start Verification",
   "settingsMatrixTitle": "Matrix Sync Settings",
+  "settingsMatrixHomeserverConfigTitle": "Matrix Homeserver Setup",
+  "settingsMatrixRoomConfigTitle": "Matrix Sync Room Setup",
+  "settingsMatrixStatsTitle": "Matrix Stats",
+  "settingsMatrixCancel": "Cancel",
+  "settingsMatrixDone": "Done",
+  "settingsMatrixNextPage": "Next Page",
+  "settingsMatrixQrTextPage": "Scan this QR code to invite device to a sync room.",
+  "settingsMatrixPreviousPage": "Previous Page",
+  "settingsMatrixUnverifiedDevicesPage": "Unverified Devices",
   "settingsMatrixUserLabel": "User",
   "settingsMatrixVerificationCancelledLabel": "Cancelled on other device...",
   "settingsMatrixVerificationSuccessConfirm": "Got it",

lib/pages/settings/advanced_settings_page.dart

@@ -2,6 +2,7 @@ import 'package:flutter/material.dart';
 import 'package:flutter_gen/gen_l10n/app_localizations.dart';
 import 'package:lotti/pages/settings/outbox/outbox_badge.dart';
 import 'package:lotti/pages/settings/sliver_box_adapter_page.dart';
+import 'package:lotti/sync/ui/matrix_settings_modal.dart';
 import 'package:lotti/widgets/settings/settings_card.dart';
 import 'package:lotti/widgets/settings/settings_icon.dart';
 import 'package:material_design_icons_flutter/material_design_icons_flutter.dart';
@@ -27,10 +28,7 @@ class AdvancedSettingsPage extends StatelessWidget {
               title: localizations.settingsSyncCfgTitle,
               path: '/settings/advanced/sync_settings',
             ),
-            SettingsNavCard(
-              title: localizations.settingsMatrixTitle,
-              path: '/settings/advanced/matrix_settings',
-            ),
+            const MatrixSettingsCard(),
             SettingsNavCard(
               trailing: OutboxBadgeIcon(
                 icon: SettingsIcon(MdiIcons.mailboxOutline),

lib/sync/matrix/client.dart

@@ -25,6 +25,8 @@ Client createMatrixClient({
     databaseBuilder: (_) async {
       final docDir = getIt<Directory>();
       final path = '${docDir.path}/matrix/';
+      // TODO(matthiasn): use MatrixSdkDatabase instead
+      // ignore: deprecated_member_use
       final db = HiveCollectionsDatabase(hiveDbName ?? 'lotti_sync', path);
       await db.open();
       return db;
@@ -54,8 +56,9 @@ Future<String> createMatrixDeviceName() async {
   return '$deviceName $dateHhMm ${uuid.v1().substring(0, 4)}';
 }
 
-Future<void> matrixLogin({
+Future<void> matrixConnect({
   required MatrixService service,
+  required bool shouldAttemptLogin,
 }) async {
   final loggingDb = getIt<LoggingDb>();
 
@@ -87,7 +90,7 @@ Future<void> matrixLogin({
       waitUntilLoadCompletedLoaded: false,
     );
 
-    if (!service.isLoggedIn()) {
+    if (!service.isLoggedIn() && shouldAttemptLogin) {
       final initialDeviceDisplayName =
           service.deviceDisplayName ?? await createMatrixDeviceName();
 
@@ -106,7 +109,7 @@ Future<void> matrixLogin({
       );
     }
 
-    final roomId = matrixConfig.roomId;
+    final roomId = await service.getRoom();
 
     if (roomId != null) {
       await service.joinRoom(roomId);

lib/sync/matrix/consts.dart

@@ -1,4 +1,5 @@
 const configNotFound = 'Could not find Matrix Config';
 const syncMessageType = 'com.lotti.sync.message';
 const String matrixConfigKey = 'MATRIX_CONFIG';
+const String matrixRoomKey = 'MATRIX_ROOM';
 const String lastReadMatrixEventId = 'LAST_READ_MATRIX_EVENT_ID';

lib/sync/matrix/matrix_service.dart

@@ -78,18 +78,45 @@ class MatrixService {
   final incomingKeyVerificationController =
       StreamController<KeyVerification>.broadcast();
 
-  Future<void> loginAndListen() async {
+  Future<void> init() async {
     await loadConfig();
-    await login();
+    await connect();
+    if (_client.onLoginStateChanged.value == LoginState.loggedIn) {
+      await listen();
+    }
+  }
+
+  Future<void> listen() async {
     await startKeyVerificationListener();
     await listenToTimeline();
   }
 
+  Future<void> loginAndListen() async {
+    await loadConfig();
+    await login();
+    await listen();
+  }
+
   Client get client => _client;
-  Future<void> login() => matrixLogin(service: this);
+
+  Future<void> login() => matrixConnect(
+        service: this,
+        shouldAttemptLogin: true,
+      );
+
+  Future<void> connect() => matrixConnect(
+        service: this,
+        shouldAttemptLogin: false,
+      );
+
   Future<String?> joinRoom(String roomId) =>
       joinMatrixRoom(roomId: roomId, service: this);
 
+  Future<void> saveRoom(String roomId) => saveMatrixRoom(
+        roomId: roomId,
+        client: client,
+      );
+
   bool isLoggedIn() {
     // TODO(unassigned): find non-deprecated solution
     // ignore: deprecated_member_use
@@ -104,10 +131,14 @@ class MatrixService {
     List<String>? invite,
   }) =>
       createMatrixRoom(
-        client: _client,
+        service: this,
         invite: invite,
       );
 
+  Future<String?> getRoom() => getMatrixRoom(client: _client);
+
+  Future<void> leaveRoom() => leaveMatrixRoom(client: _client);
+
   Future<void> inviteToSyncRoom({
     required String userId,
   }) =>