Use Drift and SQLite for data storage

.gitattributes

@@ -0,0 +1,13 @@
+# Suppress noisy generated files in diffs.
+
+# Dart files generated from the files next to them:
+*.g.dart -diff
+
+# Generated files for testing migrations:
+test/model/schemas/*.dart -diff
+test/model/schemas/*.json -diff
+
+# On the other hand, keep diffs for pubspec.lock.  It contains
+# information independent of any non-generated file in the tree.
+# And thankfully it's much less verbose than, say, a yarn.lock.
+#pubspec.lock -diff

.gitignore

@@ -43,5 +43,5 @@ app.*.map.json
 /android/app/profile
 /android/app/release
 
-# Scaffolding hack
+# Old scaffolding hack
 lib/credential_fixture.dart

README.md

@@ -39,39 +39,6 @@ community.  See [issue #15][].
 [issue #15]: https://github.com/zulip/zulip-flutter/issues/15
 
 
-### Server credentials
-
-In this early prototype, we don't yet have a UI for logging into
-a Zulip server.  Instead, you supply Zulip credentials at build time.
-
-To do this, log into the Zulip web app for the test account
-you want to use, and gather two kinds of information:
-* [Download a `.zuliprc` file][download-zuliprc].
-  This will contain a realm URL, email, and API key.
-* Find the account's user ID.  You can do this by visiting your
-  DMs with yourself, and looking at the URL;
-  it's the number after `pm-with/` or `dm-with/`.
-
-Then create a file `lib/credential_fixture.dart` in this worktree
-with the following form, and fill in the gathered information:
-```dart
-const String realmUrl = '…';
-const String email = '…';
-const String apiKey = '…';
-const int userId = /* … */ -1;
-```
-
-Now build and run the app (see "Flutter help" above), and things
-should work.
-
-Note this means the account's API key gets incorporated into the
-build output.  Consider using a low-value test account, or else
-deleting the build output (`flutter clean`, and then delete the app
-from any mobile devices you ran it on) when done.
-
-[download-zuliprc]: https://zulip.com/api/api-keys
-
-
 ### Tests
 
 You can run all our forms of tests with two commands:

ios/Podfile.lock

@@ -44,6 +44,21 @@ PODS:
   - SDWebImage/Core (5.15.5)
   - share_plus (0.0.1):
     - Flutter
+  - sqlite3 (3.41.0):
+    - sqlite3/common (= 3.41.0)
+  - sqlite3/common (3.41.0)
+  - sqlite3/fts5 (3.41.0):
+    - sqlite3/common
+  - sqlite3/perf-threadsafe (3.41.0):
+    - sqlite3/common
+  - sqlite3/rtree (3.41.0):
+    - sqlite3/common
+  - sqlite3_flutter_libs (0.0.1):
+    - Flutter
+    - sqlite3 (~> 3.41.0)
+    - sqlite3/fts5
+    - sqlite3/perf-threadsafe
+    - sqlite3/rtree
   - SwiftyGif (5.4.4)
 
 DEPENDENCIES:
@@ -52,12 +67,14 @@ DEPENDENCIES:
   - Flutter (from `Flutter`)
   - path_provider_foundation (from `.symlinks/plugins/path_provider_foundation/darwin`)
   - share_plus (from `.symlinks/plugins/share_plus/ios`)
+  - sqlite3_flutter_libs (from `.symlinks/plugins/sqlite3_flutter_libs/ios`)
 
 SPEC REPOS:
   trunk:
     - DKImagePickerController
     - DKPhotoGallery
     - SDWebImage
+    - sqlite3
     - SwiftyGif
 
 EXTERNAL SOURCES:
@@ -71,6 +88,8 @@ EXTERNAL SOURCES:
     :path: ".symlinks/plugins/path_provider_foundation/darwin"
   share_plus:
     :path: ".symlinks/plugins/share_plus/ios"
+  sqlite3_flutter_libs:
+    :path: ".symlinks/plugins/sqlite3_flutter_libs/ios"
 
 SPEC CHECKSUMS:
   device_info_plus: e5c5da33f982a436e103237c0c85f9031142abed
@@ -81,6 +100,8 @@ SPEC CHECKSUMS:
   path_provider_foundation: c68054786f1b4f3343858c1e1d0caaded73f0be9
   SDWebImage: fd7e1a22f00303e058058278639bf6196ee431fe
   share_plus: 056a1e8ac890df3e33cb503afffaf1e9b4fbae68
+  sqlite3: d31b2b69d59bd1b4ab30e5c92eb18fd8e82fa392
+  sqlite3_flutter_libs: 78f93cb854d4680595bc2c63c57209a104b2efb1
   SwiftyGif: 93a1cc87bf3a51916001cf8f3d63835fb64c819f
 
 PODFILE CHECKSUM: 985e5b058f26709dc81f9ae74ea2b2775bdbcefe

lib/api/core.dart

@@ -42,9 +42,9 @@ abstract class ApiConnection {
   Future<String> postFileFromStream(String route, Stream<List<int>> content, int length, { String? filename });
 }
 
-// TODO memoize
-Map<String, String> authHeader(Auth auth) {
-  final authBytes = utf8.encode("${auth.email}:${auth.apiKey}");
+// TODO memoize auth header on LiveApiConnection and PerAccountStore
+Map<String, String> authHeader({required String email, required String apiKey}) {
+  final authBytes = utf8.encode("$email:$apiKey");
   return {
     'Authorization': 'Basic ${base64.encode(authBytes)}',
   };
@@ -65,7 +65,9 @@ class LiveApiConnection extends ApiConnection {
     _isOpen = false;
   }
 
-  Map<String, String> _headers() => authHeader(auth);
+  Map<String, String> _headers() {
+    return authHeader(email: auth.email, apiKey: auth.apiKey);
+  }
 
   @override
   Future<String> get(String route, Map<String, dynamic>? params) async {

lib/model/database.dart

@@ -0,0 +1,97 @@
+import 'dart:io';
+
+import 'package:drift/drift.dart';
+import 'package:drift/native.dart';
+import 'package:path/path.dart' as path;
+import 'package:path_provider/path_provider.dart';
+
+part 'database.g.dart';
+
+class Accounts extends Table {
+  Column<int>    get id => integer().autoIncrement()();
+
+  Column<String> get realmUrl => text().map(const UriConverter())();
+  Column<int>    get userId => integer()();
+
+  Column<String> get email => text()();
+  Column<String> get apiKey => text()();
+
+  Column<String> get zulipVersion => text()();
+  Column<String> get zulipMergeBase => text().nullable()();
+  Column<int>    get zulipFeatureLevel => integer()();
+
+  Column<String> get ackedPushToken => text().nullable()();
+
+  @override
+  List<Set<Column<Object>>> get uniqueKeys => [
+    {realmUrl, userId},
+    {realmUrl, email},
+  ];
+}
+
+class UriConverter extends TypeConverter<Uri, String> {
+  const UriConverter();
+  @override String toSql(Uri value) => value.toString();
+  @override Uri fromSql(String fromDb) => Uri.parse(fromDb);
+}
+
+LazyDatabase _openConnection() {
+  return LazyDatabase(() async {
+    // TODO decide if this path is the right one to use
+    final dbFolder = await getApplicationDocumentsDirectory();
+    final file = File(path.join(dbFolder.path, 'db.sqlite'));
+    return NativeDatabase.createInBackground(file);
+  });
+}
+
+@DriftDatabase(tables: [Accounts])
+class AppDatabase extends _$AppDatabase {
+  AppDatabase(QueryExecutor e) : super(e);
+
+  AppDatabase.live() : this(_openConnection());
+
+  // When updating the schema:
+  //  * Make the change in the table classes, and bump schemaVersion.
+  //  * Export the new schema:
+  //    $ dart run drift_dev schema dump lib/model/database.dart test/model/schemas/
+  //  * Generate test migrations from the schemas:
+  //    $ dart run drift_dev schema generate --data-classes --companions test/model/schemas/ test/model/schemas/
+  //  * Write a migration in `onUpgrade` below.
+  //  * Write tests.
+  // TODO run those `drift_dev schema` commands in CI: https://github.com/zulip/zulip-flutter/issues/60
+  @override
+  int get schemaVersion => 2; // See note.
+
+  @override
+  MigrationStrategy get migration {
+    return MigrationStrategy(
+      onCreate: (Migrator m) async {
+        await m.createAll();
+      },
+      onUpgrade: (Migrator m, int from, int to) async {
+        if (from > to) {
+          // TODO(log): log schema downgrade as an error
+          // This should only ever happen in dev.  As a dev convenience,
+          // drop everything from the database and start over.
+          for (final entity in allSchemaEntities) {
+            // This will miss any entire tables (or indexes, etc.) that
+            // don't exist at this version.  For a dev-only feature, that's OK.
+            await m.drop(entity);
+          }
+          await m.createAll();
+          return;
+        }
+        assert(1 <= from && from <= to && to <= schemaVersion);
+
+        if (from < 2 && 2 <= to) {
+          await m.addColumn(accounts, accounts.ackedPushToken);
+        }
+        // New migrations go here.
+      }
+    );
+  }
+
+  Future<int> createAccount(AccountsCompanion values) {
+    return into(accounts).insert(values);
+  }
+}