Merge pull request #1708 from matthiasn/feat/matrix_user_per_device

test: use Matrix user per device

Author: matthiasn

.gitignore

@@ -78,3 +78,5 @@ whisper.cpp/whisper.cpp-*/
 
 # FVM Version Cache
 .fvm/
+
+integration_test/dendrite/config/jetstream/

integration_test/README.md

@@ -0,0 +1,32 @@
+# Integration test for Matrix sync
+
+Clone [dendrite](https://github.com/matrix-org/dendrite) into a sibling directory,
+e.g. `~/github/dendrite`. Build it, we need the executable in order to create users for the test.
+
+Run dendrite in a separate shell:
+
+```shell
+    $ cd integration_test/dendrite/
+    $ docker-compose up
+```
+
+Run the test script:
+
+````shell
+    $ ./integration_test/run_matrix_tests.sh
+````
+
+The test script will create two users and then run a Flutter integration test that instantiates two
+separate clients with these users, and then initiates device verification, which should complete
+successfully. Also see [PR #1695](https://github.com/matthiasn/lotti/pull/1695) for more details.
+
+
+## Testing with simulated bad network
+
+Install [comcast](https://github.com/tylertreat/Comcast), e.g.:
+
+````shell
+    $ GOBIN=~/bin/ go install github.com/tylertreat/comcast@latest
+````
+
+ To be continued.

integration_test/dendrite/config/matrix_key.pem

@@ -0,0 +1,5 @@
+-----BEGIN MATRIX PRIVATE KEY-----
+Key-ID: ed25519:m9ZDvn
+
+m9ZDvnTcTK9BEbTapMxYnnduvC85/MF7JGCM81jTAII=
+-----END MATRIX PRIVATE KEY-----

integration_test/dendrite/config/server.crt

@@ -0,0 +1,28 @@
+-----BEGIN CERTIFICATE-----
+MIIEvzCCAqegAwIBAgIQaFJAs058LlLB6G7cdoKFSDANBgkqhkiG9w0BAQsFADAA
+MB4XDTI0MDMyMjIxMDA0NloXDTM0MDMyMDIxMDA0NlowADCCAiIwDQYJKoZIhvcN
+AQEBBQADggIPADCCAgoCggIBANP+Vgi84ht36Y7YpiSL2DHr8fVPg2ZhLGU7z7Yj
+wcxudaRKzZyV3XGbtQkUQANdPzLYQGHa4ZxV7LACM6YuHBatw65Gpq1YSp06TzQT
+GGt6M52nGL0sgf/xHMOGFsIrn7Ol2h4VLkVLvHsEtSJZKFVcEq6l3Y4q52c1PUBK
+4BmdZJqh86qmupZ/z8ICl5vU8mfPIQ8i7HkX3hZ4aYoyQM5Fw/Myf+GVNsnYmGW9
+W+OucOv012tudWa99zUiRQ8wVONSvHuu2l+folTUiDr5VhZaquIczPl5NeH73+dK
+1JBaLzKemqsVfg2KjkkLMA6TXWEfgxb4fKq7c5LYS7bDkNRKsQPUr8bTaere0UEk
+NTwwuJpOUOSxzRi1YWGdBEHuE03iXsHh0B83CFDADIIR2qOcy/Q4Ib/a4DOU++Hd
+5ZKFoaFQwDh6rttw+h91DODWxLppPOLQoVK+EzQiVejpTl8Pa2FQ3hkJ/DBQmwgK
+3ClZQTxoMc/K68kPvUXGcxEBsJKfHr3SIT6t/3tl43T9j+vYXgxgdEJ4H3AzrAsv
+jXaG0HkElIh7OFjIanGeVthjhFVHgGs4YoprCsym+EFbcsjjOT9yjKpmtillwSwe
+BU614D9HHGOEMpUruEd1UH4EOEvk94P57zDlUAr6fjl1qJH31uWtKPSsPJoDoiR+
+m0+FAgMBAAGjNTAzMA4GA1UdDwEB/wQEAwIFoDATBgNVHSUEDDAKBggrBgEFBQcD
+ATAMBgNVHRMBAf8EAjAAMA0GCSqGSIb3DQEBCwUAA4ICAQCZnsSQWP3pAziFtrUP
+LXuhysdzp/ciJbc2GrVD89VjSuxgivrb4hEGXBbf2ZzSLy6nVWToDltrtJhxGb0v
+1Oof3KOS6abQpvKJZs06L3BbzMWr0+oAeHvDvwFdW0QDswOr06/WwCOkYcRALB35
+YBfTaiLdvg/i2F2jEiEMAynGic5gRj2mFXcvQF3epwIph0haUm8Xqb5WQvi8s2mq
+vLQc2HnYZfKYlIMVNu3uaT3BL3k/G9nlWMOqy1wm7zPKCRaA22a2djz53lNT3tG8
+Jk82x1pAucQQbLTn+vzHbcDqDaBPd1B4ABV/u3SkKiX7sGdt4ZSAuOZKa3xKK4kG
+V0opWApQpYiF0aKvd1JurVzbth9s6aaHW/qleNa6UHGjCc6T0nQys5HF559dyra6
+hbFXPP0iiXhQXtH5123S1Ed2uzM7jecUuvMP2yQ4ZlxJOmu/62Eoy+u3XElid+L+
+339IBhBaSvpyQgCzwxRaIMKh+p5iws9D9b/mkiNr8wgWl9NYhFm7BQkEy+5LXjlK
+t6BLKGi+g57HHaO6OmopKP7EX3t5FYWbZ57IZCV9JCv9oDIfNucqw/2Sp4NIORpV
+8Zskxf62v5l5wTMGwnVSAJfeOwhOE2gaOsqCNcjaxxC7Kl82IwG66WPBgS1vS7OL
+2aERJZQxVIvxEO9KMr3Qjv3GQw==
+-----END CERTIFICATE-----

integration_test/dendrite/config/server.key

@@ -0,0 +1,51 @@
+-----BEGIN RSA PRIVATE KEY-----
+MIIJKAIBAAKCAgEA0/5WCLziG3fpjtimJIvYMevx9U+DZmEsZTvPtiPBzG51pErN
+nJXdcZu1CRRAA10/MthAYdrhnFXssAIzpi4cFq3DrkamrVhKnTpPNBMYa3oznacY
+vSyB//Ecw4YWwiufs6XaHhUuRUu8ewS1IlkoVVwSrqXdjirnZzU9QErgGZ1kmqHz
+qqa6ln/PwgKXm9TyZ88hDyLseRfeFnhpijJAzkXD8zJ/4ZU2ydiYZb1b465w6/TX
+a251Zr33NSJFDzBU41K8e67aX5+iVNSIOvlWFlqq4hzM+Xk14fvf50rUkFovMp6a
+qxV+DYqOSQswDpNdYR+DFvh8qrtzkthLtsOQ1EqxA9SvxtNp6t7RQSQ1PDC4mk5Q
+5LHNGLVhYZ0EQe4TTeJeweHQHzcIUMAMghHao5zL9Dghv9rgM5T74d3lkoWhoVDA
+OHqu23D6H3UM4NbEumk84tChUr4TNCJV6OlOXw9rYVDeGQn8MFCbCArcKVlBPGgx
+z8rryQ+9RcZzEQGwkp8evdIhPq3/e2XjdP2P69heDGB0QngfcDOsCy+NdobQeQSU
+iHs4WMhqcZ5W2GOEVUeAazhiimsKzKb4QVtyyOM5P3KMqma2KWXBLB4FTrXgP0cc
+Y4QylSu4R3VQfgQ4S+T3g/nvMOVQCvp+OXWokffW5a0o9Kw8mgOiJH6bT4UCAwEA
+AQKCAgB5sknFXlkWl7HWNPy7giQsFFykDG9MOIB55OoKj2BTcR3LoL2EJGwpKc+1
+VJCi3cbH82iSREq7qn/jUoA/57xsMHhi9V/9pu++bpjFNikQmehDmocTIhfGy61N
+eQ5bjRtyz8T0/AfB9AZRQJSTEUecKOz4oXMch/irQN7Wp6UaT0ZPlqUA1BHND7Y+
+k6pg5M/7U+aQf+XsZg0yLRG5KbwWLeqdE+Jhp3z6RoLF9PxpKdzdN4Lqw1BWGLtv
+Hysx2vcAQKC/B9OIjWVs+UzzPetzjb0HbK0mkbSi9CrG5ig8bekmT/JOQFpKf73K
+pMeDtokmliZ061T11gI0zEI6uu3KRVSa0LA4O+9CkFSwTfhsm3g07CH1o+AXIVWf
+LxPFZg0eTV3hMq4hndFSSbo0glLBho5BYbkFWCF5Je5Wtp1FfSHjMaTdedjglMC/
+YkyGy9qk3SKiBrDvJen4Mvj2UIRElB7b0PB9k55nfIalAblNJaFc4PRiM6XVQQCG
+8UWQ1nRT3yym5p9g9BCEBnC1qEoiHDbqst0Z16GA8CeWPLen494QGn6xcxfJCBTM
+XfEF2FmA3GWVCr4HNz1fTY+m3j9NPSRUqoiMhvi0tCgO5UcUbFMHvWdhfTWt2nLT
+HqZYGmBg/BzvfPi2wp5/ZYRvNcyFyokkJlcHny/asNSvVgk6CQKCAQEA6qslnBXx
+ULOSiYjBhTmMTMqq0K25r868yK0MslUhOSNwTFDUxvCK5BM0Lhh5bbJFKqr/qktL
+vRkNjXch3Cj9WZdW2DcgAvTnMvOO03ZTgYvVhjSpOTy3ajg5uzQrv8dmT7VXKMJo
+VXg7Qxavam143E29IlWVXyF5wmgMRp9kz4FsA11stuI+0qIbyxRfX4SdlQ5TVFvI
+smknBuAvLiocsku+NuFyh2vCjRpy8gdS9q0eOj3RRp4Rq0tmGaaEMX05W70YQYWd
+Td26AYyv26zqJtzG8M8uId8OqweHL/1LsXB2B6XIqWGeMW5KovJFVpnGvf9KVOPL
+ltRmK2BGmay1SwKCAQEA50OHmrAekB7i7joVC0P1+kwUjz3SqK3eRq6xq9uxtmc6
+bIE0ZiZNu/VljGJAfT2kEw6twod8j0kXvnD/t8j+U5QpfFUBjwzGoJLKsaW7eodK
+flsRqsCM9tftzt2hY8Glf+bsgQAdYubtq5zOCwssjjezycAsDLeXV77N1uTmpZTA
++rcw8IZ9nzrcOt+o3E6Zi77Vp6z8jOYQOTDLjMzNqPvBNada6TB2fwvBhcYgJpvY
+FqW7ybVvF3DACfHORWvQMkuR72H+R7Frj7i7JrEcv2k8+LDckT4LBt8C3Q5X3ahj
+o+4vJFlzwpyk+VwLdZKIRpnmD+Of5yBOg4uPBl2cbwKCAQA4gc/DnxEFssf1cEXR
+M8NR9nddWofdCrYwyGLHSnJ+lMcEyW4DHYcEVo95DhGnVYcMODLqKclqFm9KAkbY
+AdLH0QZreBKwQ5KslTNuPg7roeVftKyPCMzNug5EwtJKEtTTGsKLIQ0Ij7QNepfw
+072HpvyFGQCn8KKmKnHSS611vh9pTATSoPYpuDljFFvG32MmslVkedmBBIsOP8t8
+nU1drZl3E6CFdXBak+Tb3OGgXp1pvtr22zc7/SLvyEYKuLGoIoeFt4viZSLWHq92
+AVQ82WraL7lXFKQukNh/uMmSR5dUThpclxIFqx4z0IzbxpmxxJh8ioHKpwiXJ064
+0HqzAoIBAQCDzzh10RXKXOBImXAvGJAVFdHOBpWPsHF05dK8Oh5i8RkaiNW9tu0t
+SOOVDNbmywA+IGqm6iPzYtyWnb8SGAvkxRiUFbsqtkRrdt7yO5zMbFnoBK3gHZj6
+g/21nxqCSfezG4IG0HLvUOF7o4bIQpklgdgGEHLK2MT4rPaTGangDBWlkE3jeTQW
+Uiz9nUaYMnBPdvg9dloHUIVEo2wQlxZMzxjDJNyq9gVDygaF4XOnrcGOvu12POPR
+f2DlCh3f8WAbmnjV8ItGf3fn1YlNtzrEWg33TI6adbtBMlBmf+tSmcwYvgO+ewGA
+lVluCqk5XMgxPTwkKD+WMxKs5Rkirq4fAoIBAClYNLw7AQVH4QLJVey+KmtPyFiK
+Rd8C3I0P/TvqvJ/odOntaQ1Gz7K7ejlpyK0tSK2H2288kXiQvG3Do5ViC7geNWLn
+khj3hzVjKUbPWjBOWMrsQaBVr16hEZHbXFPy03oCm/YYvQbulgiAzH2zhq0gRYWN
+4TVDF/ySKdttNRuZ5ED1DmBhIK8MRQhIsJzAfBJAISG6b5mqHCO2nyVzD86kRClY
+OvXt/Cq1FkGKGlMuE2/8rszr0XIygUOoyiU36/sZjzTqIeENo9026p1MeSCdVAXJ
+4kyLZzL+sHdpTdFqF56NwshGvP6FFfiEQQneAd3we8Gq8NgvHtQZAqwrSis=
+-----END RSA PRIVATE KEY-----

integration_test/matrix_service_test.dart

@@ -21,26 +21,41 @@ void main() {
   group('MatrixService Tests', () {
     final mockLoggingDb = MockLoggingDb();
     final secureStorageMock = MockSecureStorage();
-    const testUserEnv = 'TEST_USER';
+    const testUserEnv1 = 'TEST_USER1';
+    const testUserEnv2 = 'TEST_USER2';
     const testServerEnv = 'TEST_SERVER';
     const testPasswordEnv = 'TEST_PASSWORD';
     const testSlowNetworkEnv = 'SLOW_NETWORK';
 
-    if (!const bool.hasEnvironment(testUserEnv)) {
-      debugPrint('TEST_USER not defined!!! Run via run_matrix_tests.sh');
+    if (!const bool.hasEnvironment(testUserEnv1)) {
+      debugPrint('TEST_USER1 not defined!!! Run via run_matrix_tests.sh');
       exit(1);
     }
-    const testUserName = String.fromEnvironment(testUserEnv);
+
+    if (!const bool.hasEnvironment(testUserEnv2)) {
+      debugPrint('TEST_USER2 not defined!!! Run via run_matrix_tests.sh');
+      exit(1);
+    }
+
+    const testUserName1 = String.fromEnvironment(testUserEnv1);
+    const testUserName2 = String.fromEnvironment(testUserEnv1);
+
     const testHomeServer = bool.hasEnvironment(testServerEnv)
         ? String.fromEnvironment(testServerEnv)
         : 'http://localhost:8008';
     const testPassword = bool.hasEnvironment(testPasswordEnv)
         ? String.fromEnvironment(testPasswordEnv)
         : '?Secret123@!';
 
-    const config = MatrixConfig(
+    const config1 = MatrixConfig(
       homeServer: testHomeServer,
-      user: testUserName,
+      user: testUserName1,
+      password: testPassword,
+    );
+
+    const config2 = MatrixConfig(
+      homeServer: testHomeServer,
+      user: testUserName2,
       password: testPassword,
     );
 
@@ -67,7 +82,7 @@ void main() {
       () async {
         debugPrint('\n--- AliceDevice goes live');
         final aliceDevice = MatrixService(
-          matrixConfig: config,
+          matrixConfig: config1,
           hiveDbName: 'AliceDevice',
           deviceDisplayName: 'AliceDevice',
         );
@@ -89,7 +104,7 @@ void main() {
 
         debugPrint('\n--- BobDevice goes live');
         final bobDevice = MatrixService(
-          matrixConfig: config,
+          matrixConfig: config2,
           hiveDbName: 'BobDevice',
           deviceDisplayName: 'BobDevice',
         );
@@ -101,14 +116,18 @@ void main() {
         final joinRes2 = await bobDevice.joinRoom(roomId);
         debugPrint('BobDevice - room joined: $joinRes2');
 
+        await Future<void>.delayed(
+          const Duration(seconds: 1 * delayFactor),
+        );
+
         await waitUntil(() => aliceDevice.getUnverified().length == 1);
         await waitUntil(() => bobDevice.getUnverified().length == 1);
 
         final unverifiedAlice = aliceDevice.getUnverified();
         final unverifiedBob = bobDevice.getUnverified();
 
-        debugPrint('AliceDevice - unverified: $unverifiedAlice');
-        debugPrint('BobDevice - unverified: $unverifiedBob');
+        debugPrint('\nAliceDevice - unverified: $unverifiedAlice');
+        debugPrint('\nBobDevice - unverified: $unverifiedBob');
 
         expect(unverifiedAlice.length, 1);
         expect(unverifiedBob.length, 1);

integration_test/run_matrix_tests.sh

@@ -1,14 +1,19 @@
 #!/bin/bash
 
 # Create user name
-uuid=$(uuidgen)
-TEST_USER="$(tr '[:upper:]' '[:lower:]' <<< "$uuid")"
+uuid1=$(uuidgen)
+uuid2=$(uuidgen)
+TEST_USER1="$(tr '[:upper:]' '[:lower:]' <<< "$uuid1")"
+TEST_USER2="$(tr '[:upper:]' '[:lower:]' <<< "$uuid2")"
 
 # Go to dendrite docker directory that contains config and keys
 cd ../dendrite/build/docker/config || exit
 
 # Create user using the create-account binary in dendrite build
-../../../bin/create-account -config dendrite.yaml -username "$TEST_USER" -admin -password "?Secret123@!"
+../../../bin/create-account -config dendrite.yaml -username "$TEST_USER1" -admin -password "?Secret123@!"
+../../../bin/create-account -config dendrite.yaml -username "$TEST_USER2" -admin -password "?Secret123@!"
 cd - > /dev/null || exit
 
-fvm flutter test integration_test/matrix_service_test.dart --dart-define=TEST_USER="@$TEST_USER:localhost"
+fvm flutter test integration_test/matrix_service_test.dart \
+    --dart-define=TEST_USER1="@$TEST_USER1:localhost" \
+    --dart-define=TEST_USER2="@$TEST_USER2:localhost"

lib/sync/matrix/matrix_service.dart

@@ -86,7 +86,7 @@ class MatrixService {
     String? hiveDbName,
   }) {
     return Client(
-      'lotti',
+      deviceDisplayName ?? 'lotti',
       verificationMethods: {
         KeyVerificationMethod.emoji,
         KeyVerificationMethod.reciprocate,

pubspec.yaml

@@ -1,7 +1,7 @@
 name: lotti
 description: Achieve your goals and keep your data private with Lotti.
 publish_to: 'none'
-version: 0.9.444+2431
+version: 0.9.445+2432
 
 msix_config:
   display_name: LottiApp