fix(cloud_auth): Migration of Cloud Auth tables (#383)

When wrapping over the Cloud Auth database, ensure that migrations are run at the correct times.

Improves the interface of `createMigration` to better support these wrapper databases and add a test database for ensuring that mutual database upgrades are supported.

Author: dnys1

services/celest_cloud_auth/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.3.2+2
+
+- fix: Migration of Cloud Auth tables
+
 ## 0.3.2+1
 
 - fix: Session duration on Web

services/celest_cloud_auth/build.yaml

@@ -8,9 +8,11 @@ targets:
         enabled: true
         generate_for:
           - lib/src/database/**
+          - test/database/wrapper/**
         options: &options
           databases:
             auth_database: lib/src/database/auth_database.dart
+            test_database: test/database/wrapper/wrapper_database.dart
           schema_dir: drift_schema/
           test_dir: test/database/
 
@@ -32,4 +34,5 @@ targets:
         enabled: true
         generate_for:
           - lib/src/database/**
+          - test/database/wrapper/**
         options: *options

services/celest_cloud_auth/drift_schema/test_database/drift_schema_v1.json

@@ -53,20 +53,37 @@ mixin CloudAuthDatabaseMixin on GeneratedDatabase {
   MigrationStrategy createMigration({
     OnCreate? onCreate,
     OnUpgrade? onUpgrade,
-    OnBeforeOpen? onBeforeOpen,
+    OnBeforeOpen? beforeOpen,
+    ResolvedProject? project,
+    Iterable<String> additionalCedarTypes = const {},
+    Map<EntityUid, Entity> additionalCedarEntities = const {},
+    PolicySet? additionalCedarPolicies,
   }) {
     final defaultStrategy = MigrationStrategy();
     onCreate ??= defaultStrategy.onCreate;
     onUpgrade ??= defaultStrategy.onUpgrade;
     return MigrationStrategy(
       onCreate: onCreate,
-      onUpgrade: (m, from, to) async {
-        await onUpgrade!(m, from, to);
-        await cloudAuth.onUpgrade(m);
-      },
+      onUpgrade: onUpgrade,
       beforeOpen: (details) async {
-        await onBeforeOpen?.call(details);
-        await cloudAuth.onBeforeOpen(details);
+        // First ensure that the cloud auth tables are up-to-date.
+        //
+        // This must be run here since the cloud auth tables may be updated
+        // out-of-sync with the wrapper database, meaning onUpgrade may miss
+        // updates related to the cloud auth tables.
+        await cloudAuth.onUpgrade(Migrator(this));
+
+        // Then seed the database with core types, entities, and relationships.
+        await cloudAuth.onBeforeOpen(
+          details,
+          project: project,
+          additionalCedarTypes: additionalCedarTypes,
+          additionalCedarEntities: additionalCedarEntities,
+          additionalCedarPolicies: additionalCedarPolicies,
+        );
+
+        // Then call beforeOpen, which may reference cloud auth tables.
+        await beforeOpen?.call(details);
       },
     );
   }
@@ -336,12 +353,26 @@ class CloudAuthDatabaseAccessors extends DatabaseAccessor<GeneratedDatabase>
     @internal int? to,
   }) async {
     try {
-      from ??= await cloudAuthMetaDrift.getSchemaVersion().getSingle();
+      from ??= await cloudAuthMetaDrift.getSchemaVersion().getSingleOrNull();
     } on Object catch (e, st) {
       _logger.finest('Error getting latest schema version', e, st);
+      if (from == null) {
+        // We're mising the meta tables for some reason.
+        //
+        // This should never happen.
+        throw StateError('Invalid schema detected');
+      }
+    }
+
+    // If the table is empty, then the database was just created and thus
+    // the schema version is current.
+    if (from == null) {
+      await cloudAuthMetaDrift.setSchemaVersion(
+        schemaVersion: schemaVersion,
+      );
+      from = schemaVersion;
     }
 
-    from ??= 1;
     to ??= schemaVersion;
     if (from < to) {
       _logger.fine('Migrating from version $from to version $to');
@@ -359,10 +390,17 @@ class CloudAuthDatabaseAccessors extends DatabaseAccessor<GeneratedDatabase>
   Future<void> onBeforeOpen(
     OpeningDetails details, {
     ResolvedProject? project,
+    Iterable<String> additionalCedarTypes = const {},
+    Map<EntityUid, Entity> additionalCedarEntities = const {},
+    PolicySet? additionalCedarPolicies,
   }) async {
     await _withoutForeignKeys(() async {
       if (details.wasCreated) {
-        await seed();
+        await seed(
+          additionalCedarTypes: additionalCedarTypes,
+          additionalCedarEntities: additionalCedarEntities,
+          additionalCedarPolicies: additionalCedarPolicies,
+        );
       }
       await upsertProject(project: project);
     });

services/celest_cloud_auth/drift_schema/test_database/drift_schema_v2.json

@@ -0,0 +1,23 @@
+// dart format width=80
+// GENERATED CODE, DO NOT EDIT BY HAND.
+// ignore_for_file: type=lint
+import 'package:drift/drift.dart';
+import 'package:drift/internal/migrations.dart';
+import 'schema_v1.dart' as v1;
+import 'schema_v2.dart' as v2;
+
+class GeneratedHelper implements SchemaInstantiationHelper {
+  @override
+  GeneratedDatabase databaseForVersion(QueryExecutor db, int version) {
+    switch (version) {
+      case 1:
+        return v1.DatabaseAtV1(db);
+      case 2:
+        return v2.DatabaseAtV2(db);
+      default:
+        throw MissingSchemaException(version, versions);
+    }
+  }
+
+  static const versions = const [1, 2];
+}