moved to migration strategy, moved daos to top lib

build.yaml

@@ -0,0 +1,9 @@
+targets:
+  $default:
+    builders:
+      drift_dev:
+        options:
+          schema_dir: lib/database/drift_schemas/
+          databases:
+            # Required: A name for the database and it's path
+            sendtrain: lib/database/database.dart

lib/database/database.dart

@@ -1,7 +1,7 @@
 import 'package:drift/drift.dart';
 import 'package:drift_flutter/drift_flutter.dart';
-import 'package:sendtrain/database/daos/activities_dao.dart';
-import 'package:sendtrain/database/daos/sessions_dao.dart';
+import 'package:sendtrain/daos/activities_dao.dart';
+import 'package:sendtrain/daos/sessions_dao.dart';
 import 'package:sendtrain/database/seed.dart';
 
 part 'database.g.dart';
@@ -124,7 +124,7 @@ class AppDatabase extends _$AppDatabase {
   AppDatabase() : super(_openConnection());
 
   @override
-  int get schemaVersion => 1;
+  int get schemaVersion => 2;
 
   @override
   MigrationStrategy get migration {

lib/database/database.steps.dart

@@ -0,0 +1,337 @@
+// dart format width=80
+import 'package:drift/internal/versioned_schema.dart' as i0;
+import 'package:drift/drift.dart' as i1;
+import 'package:drift/drift.dart'; // ignore_for_file: type=lint,unused_import
+
+// GENERATED BY drift_dev, DO NOT MODIFY.
+final class Schema2 extends i0.VersionedSchema {
+  Schema2({required super.database}) : super(version: 2);
+  @override
+  late final List<i1.DatabaseSchemaEntity> entities = [
+    sessions,
+    activities,
+    sessionActivities,
+    actions,
+    activityActions,
+    mediaItems,
+    objectMediaItems,
+  ];
+  late final Shape0 sessions = Shape0(
+      source: i0.VersionedTable(
+        entityName: 'sessions',
+        withoutRowId: false,
+        isStrict: false,
+        tableConstraints: [],
+        columns: [
+          _column_0,
+          _column_1,
+          _column_2,
+          _column_3,
+          _column_4,
+          _column_5,
+        ],
+        attachedDatabase: database,
+      ),
+      alias: null);
+  late final Shape1 activities = Shape1(
+      source: i0.VersionedTable(
+        entityName: 'activities',
+        withoutRowId: false,
+        isStrict: false,
+        tableConstraints: [],
+        columns: [
+          _column_0,
+          _column_1,
+          _column_6,
+          _column_2,
+          _column_7,
+          _column_5,
+        ],
+        attachedDatabase: database,
+      ),
+      alias: null);
+  late final Shape2 sessionActivities = Shape2(
+      source: i0.VersionedTable(
+        entityName: 'session_activities',
+        withoutRowId: false,
+        isStrict: false,
+        tableConstraints: [],
+        columns: [
+          _column_0,
+          _column_8,
+          _column_9,
+          _column_10,
+          _column_11,
+          _column_5,
+        ],
+        attachedDatabase: database,
+      ),
+      alias: null);
+  late final Shape3 actions = Shape3(
+      source: i0.VersionedTable(
+        entityName: 'actions',
+        withoutRowId: false,
+        isStrict: false,
+        tableConstraints: [],
+        columns: [
+          _column_0,
+          _column_1,
+          _column_2,
+          _column_12,
+          _column_5,
+        ],
+        attachedDatabase: database,
+      ),
+      alias: null);
+  late final Shape4 activityActions = Shape4(
+      source: i0.VersionedTable(
+        entityName: 'activity_actions',
+        withoutRowId: false,
+        isStrict: false,
+        tableConstraints: [],
+        columns: [
+          _column_0,
+          _column_9,
+          _column_13,
+          _column_5,
+        ],
+        attachedDatabase: database,
+      ),
+      alias: null);
+  late final Shape5 mediaItems = Shape5(
+      source: i0.VersionedTable(
+        entityName: 'media_items',
+        withoutRowId: false,
+        isStrict: false,
+        tableConstraints: [],
+        columns: [
+          _column_0,
+          _column_1,
+          _column_2,
+          _column_14,
+          _column_6,
+          _column_5,
+        ],
+        attachedDatabase: database,
+      ),
+      alias: null);
+  late final Shape6 objectMediaItems = Shape6(
+      source: i0.VersionedTable(
+        entityName: 'object_media_items',
+        withoutRowId: false,
+        isStrict: false,
+        tableConstraints: [],
+        columns: [
+          _column_0,
+          _column_15,
+          _column_16,
+          _column_17,
+          _column_5,
+        ],
+        attachedDatabase: database,
+      ),
+      alias: null);
+}
+
+class Shape0 extends i0.VersionedTable {
+  Shape0({required super.source, required super.alias}) : super.aliased();
+  i1.GeneratedColumn<int> get id =>
+      columnsByName['id']! as i1.GeneratedColumn<int>;
+  i1.GeneratedColumn<String> get title =>
+      columnsByName['title']! as i1.GeneratedColumn<String>;
+  i1.GeneratedColumn<String> get content =>
+      columnsByName['body']! as i1.GeneratedColumn<String>;
+  i1.GeneratedColumn<String> get status =>
+      columnsByName['status']! as i1.GeneratedColumn<String>;
+  i1.GeneratedColumn<DateTime> get date =>
+      columnsByName['date']! as i1.GeneratedColumn<DateTime>;
+  i1.GeneratedColumn<DateTime> get createdAt =>
+      columnsByName['created_at']! as i1.GeneratedColumn<DateTime>;
+}
+
+i1.GeneratedColumn<int> _column_0(String aliasedName) =>
+    i1.GeneratedColumn<int>('id', aliasedName, false,
+        hasAutoIncrement: true,
+        type: i1.DriftSqlType.int,
+        defaultConstraints:
+            i1.GeneratedColumn.constraintIsAlways('PRIMARY KEY AUTOINCREMENT'));
+i1.GeneratedColumn<String> _column_1(String aliasedName) =>
+    i1.GeneratedColumn<String>('title', aliasedName, false,
+        additionalChecks: i1.GeneratedColumn.checkTextLength(
+            minTextLength: 3, maxTextLength: 32),
+        type: i1.DriftSqlType.string);
+i1.GeneratedColumn<String> _column_2(String aliasedName) =>
+    i1.GeneratedColumn<String>('body', aliasedName, false,
+        type: i1.DriftSqlType.string);
+i1.GeneratedColumn<String> _column_3(String aliasedName) =>
+    i1.GeneratedColumn<String>('status', aliasedName, false,
+        type: i1.DriftSqlType.string);
+i1.GeneratedColumn<DateTime> _column_4(String aliasedName) =>
+    i1.GeneratedColumn<DateTime>('date', aliasedName, true,
+        type: i1.DriftSqlType.dateTime);
+i1.GeneratedColumn<DateTime> _column_5(String aliasedName) =>
+    i1.GeneratedColumn<DateTime>('created_at', aliasedName, false,
+        type: i1.DriftSqlType.dateTime, defaultValue: Variable(DateTime.now()));
+
+class Shape1 extends i0.VersionedTable {
+  Shape1({required super.source, required super.alias}) : super.aliased();
+  i1.GeneratedColumn<int> get id =>
+      columnsByName['id']! as i1.GeneratedColumn<int>;
+  i1.GeneratedColumn<String> get title =>
+      columnsByName['title']! as i1.GeneratedColumn<String>;
+  i1.GeneratedColumn<String> get type =>
+      columnsByName['type']! as i1.GeneratedColumn<String>;
+  i1.GeneratedColumn<String> get description =>
+      columnsByName['body']! as i1.GeneratedColumn<String>;
+  i1.GeneratedColumn<String> get category =>
+      columnsByName['category']! as i1.GeneratedColumn<String>;
+  i1.GeneratedColumn<DateTime> get createdAt =>
+      columnsByName['created_at']! as i1.GeneratedColumn<DateTime>;
+}
+
+i1.GeneratedColumn<String> _column_6(String aliasedName) =>
+    i1.GeneratedColumn<String>('type', aliasedName, false,
+        type: i1.DriftSqlType.string);
+i1.GeneratedColumn<String> _column_7(String aliasedName) =>
+    i1.GeneratedColumn<String>('category', aliasedName, false,
+        type: i1.DriftSqlType.string);
+
+class Shape2 extends i0.VersionedTable {
+  Shape2({required super.source, required super.alias}) : super.aliased();
+  i1.GeneratedColumn<int> get id =>
+      columnsByName['id']! as i1.GeneratedColumn<int>;
+  i1.GeneratedColumn<int> get sessionId =>
+      columnsByName['session_id']! as i1.GeneratedColumn<int>;
+  i1.GeneratedColumn<int> get activityId =>
+      columnsByName['activity_id']! as i1.GeneratedColumn<int>;
+  i1.GeneratedColumn<String> get results =>
+      columnsByName['results']! as i1.GeneratedColumn<String>;
+  i1.GeneratedColumn<String> get achievements =>
+      columnsByName['achievements']! as i1.GeneratedColumn<String>;
+  i1.GeneratedColumn<DateTime> get createdAt =>
+      columnsByName['created_at']! as i1.GeneratedColumn<DateTime>;
+}
+
+i1.GeneratedColumn<int> _column_8(String aliasedName) =>
+    i1.GeneratedColumn<int>('session_id', aliasedName, false,
+        type: i1.DriftSqlType.int,
+        defaultConstraints:
+            i1.GeneratedColumn.constraintIsAlways('REFERENCES sessions (id)'));
+i1.GeneratedColumn<int> _column_9(String aliasedName) =>
+    i1.GeneratedColumn<int>('activity_id', aliasedName, false,
+        type: i1.DriftSqlType.int,
+        defaultConstraints: i1.GeneratedColumn.constraintIsAlways(
+            'REFERENCES activities (id)'));
+i1.GeneratedColumn<String> _column_10(String aliasedName) =>
+    i1.GeneratedColumn<String>('results', aliasedName, true,
+        type: i1.DriftSqlType.string);
+i1.GeneratedColumn<String> _column_11(String aliasedName) =>
+    i1.GeneratedColumn<String>('achievements', aliasedName, true,
+        type: i1.DriftSqlType.string);
+
+class Shape3 extends i0.VersionedTable {
+  Shape3({required super.source, required super.alias}) : super.aliased();
+  i1.GeneratedColumn<int> get id =>
+      columnsByName['id']! as i1.GeneratedColumn<int>;
+  i1.GeneratedColumn<String> get title =>
+      columnsByName['title']! as i1.GeneratedColumn<String>;
+  i1.GeneratedColumn<String> get description =>
+      columnsByName['body']! as i1.GeneratedColumn<String>;
+  i1.GeneratedColumn<String> get set =>
+      columnsByName['set']! as i1.GeneratedColumn<String>;
+  i1.GeneratedColumn<DateTime> get createdAt =>
+      columnsByName['created_at']! as i1.GeneratedColumn<DateTime>;
+}
+
+i1.GeneratedColumn<String> _column_12(String aliasedName) =>
+    i1.GeneratedColumn<String>('set', aliasedName, false,
+        type: i1.DriftSqlType.string);
+
+class Shape4 extends i0.VersionedTable {
+  Shape4({required super.source, required super.alias}) : super.aliased();
+  i1.GeneratedColumn<int> get id =>
+      columnsByName['id']! as i1.GeneratedColumn<int>;
+  i1.GeneratedColumn<int> get activityId =>
+      columnsByName['activity_id']! as i1.GeneratedColumn<int>;
+  i1.GeneratedColumn<int> get actionId =>
+      columnsByName['action_id']! as i1.GeneratedColumn<int>;
+  i1.GeneratedColumn<DateTime> get createdAt =>
+      columnsByName['created_at']! as i1.GeneratedColumn<DateTime>;
+}
+
+i1.GeneratedColumn<int> _column_13(String aliasedName) =>
+    i1.GeneratedColumn<int>('action_id', aliasedName, false,
+        type: i1.DriftSqlType.int,
+        defaultConstraints:
+            i1.GeneratedColumn.constraintIsAlways('REFERENCES actions (id)'));
+
+class Shape5 extends i0.VersionedTable {
+  Shape5({required super.source, required super.alias}) : super.aliased();
+  i1.GeneratedColumn<int> get id =>
+      columnsByName['id']! as i1.GeneratedColumn<int>;
+  i1.GeneratedColumn<String> get title =>
+      columnsByName['title']! as i1.GeneratedColumn<String>;
+  i1.GeneratedColumn<String> get description =>
+      columnsByName['body']! as i1.GeneratedColumn<String>;
+  i1.GeneratedColumn<String> get reference =>
+      columnsByName['reference']! as i1.GeneratedColumn<String>;
+  i1.GeneratedColumn<String> get type =>
+      columnsByName['type']! as i1.GeneratedColumn<String>;
+  i1.GeneratedColumn<DateTime> get createdAt =>
+      columnsByName['created_at']! as i1.GeneratedColumn<DateTime>;
+}
+
+i1.GeneratedColumn<String> _column_14(String aliasedName) =>
+    i1.GeneratedColumn<String>('reference', aliasedName, false,
+        additionalChecks: i1.GeneratedColumn.checkTextLength(
+            minTextLength: 3, maxTextLength: 256),
+        type: i1.DriftSqlType.string);
+
+class Shape6 extends i0.VersionedTable {
+  Shape6({required super.source, required super.alias}) : super.aliased();
+  i1.GeneratedColumn<int> get id =>
+      columnsByName['id']! as i1.GeneratedColumn<int>;
+  i1.GeneratedColumn<int> get objectId =>
+      columnsByName['object_id']! as i1.GeneratedColumn<int>;
+  i1.GeneratedColumn<String> get objectType =>
+      columnsByName['object_type']! as i1.GeneratedColumn<String>;
+  i1.GeneratedColumn<int> get mediaId =>
+      columnsByName['media_id']! as i1.GeneratedColumn<int>;
+  i1.GeneratedColumn<DateTime> get createdAt =>
+      columnsByName['created_at']! as i1.GeneratedColumn<DateTime>;
+}
+
+i1.GeneratedColumn<int> _column_15(String aliasedName) =>
+    i1.GeneratedColumn<int>('object_id', aliasedName, false,
+        type: i1.DriftSqlType.int);
+i1.GeneratedColumn<String> _column_16(String aliasedName) =>
+    i1.GeneratedColumn<String>('object_type', aliasedName, false,
+        type: i1.DriftSqlType.string);
+i1.GeneratedColumn<int> _column_17(String aliasedName) =>
+    i1.GeneratedColumn<int>('media_id', aliasedName, false,
+        type: i1.DriftSqlType.int,
+        defaultConstraints: i1.GeneratedColumn.constraintIsAlways(
+            'REFERENCES media_items (id)'));
+i0.MigrationStepWithVersion migrationSteps({
+  required Future<void> Function(i1.Migrator m, Schema2 schema) from1To2,
+}) {
+  return (currentVersion, database) async {
+    switch (currentVersion) {
+      case 1:
+        final schema = Schema2(database: database);
+        final migrator = i1.Migrator(database, schema);
+        await from1To2(migrator, schema);
+        return 2;
+      default:
+        throw ArgumentError.value('Unknown migration from $currentVersion');
+    }
+  };
+}
+
+i1.OnUpgrade stepByStep({
+  required Future<void> Function(i1.Migrator m, Schema2 schema) from1To2,
+}) =>
+    i0.VersionedSchema.stepByStepHelper(
+        step: migrationSteps(
+      from1To2: from1To2,
+    ));

lib/screens/sessions_screen.dart

@@ -1,6 +1,6 @@
 import 'package:flutter/material.dart';
 import 'package:provider/provider.dart';
-import 'package:sendtrain/database/daos/sessions_dao.dart';
+import 'package:sendtrain/daos/sessions_dao.dart';
 import 'package:sendtrain/database/database.dart';
 import '../widgets/session_card.dart';
 
@@ -12,7 +12,7 @@ class SessionsScreen extends StatelessWidget {
     return FutureBuilder<List<Session>>(
         future: SessionsDao(Provider.of<AppDatabase>(context)).all(),
         builder: (context, snapshot) {
-          if (snapshot.hasData) {
+          if (snapshot.hasData && snapshot.data!.isNotEmpty) {
             final sessions = snapshot.data!;
             final pending = sessions.where((session) =>
                 session.status == SessionStatus.completed ||

lib/widgets/session_view.dart

@@ -3,7 +3,7 @@ import 'package:flutter_expandable_fab/flutter_expandable_fab.dart';
 import 'package:intl/intl.dart';
 import 'package:intl/date_symbol_data_local.dart';
 import 'package:provider/provider.dart';
-import 'package:sendtrain/database/daos/activities_dao.dart';
+import 'package:sendtrain/daos/activities_dao.dart';
 
 import 'package:sendtrain/database/database.dart';
 import 'package:sendtrain/models/session_model.dart';

lib/widgets/session_view_achievements.dart

@@ -1,6 +1,6 @@
 import 'package:flutter/material.dart';
 import 'package:provider/provider.dart';
-import 'package:sendtrain/database/daos/session_activities_dao.dart';
+import 'package:sendtrain/daos/session_activities_dao.dart';
 import 'package:sendtrain/database/database.dart';
 
 class SessionViewAchievements extends StatelessWidget {

lib/widgets/session_view_media.dart

@@ -1,6 +1,6 @@
 import 'package:flutter/material.dart';
 import 'package:provider/provider.dart';
-import 'package:sendtrain/database/daos/media_items_dao.dart';
+import 'package:sendtrain/daos/media_items_dao.dart';
 import 'package:sendtrain/database/database.dart';
 import 'package:sendtrain/widgets/media_card.dart';
 

pubspec.yaml

@@ -61,6 +61,7 @@ dev_dependencies:
   build_runner: ^2.4.13
   json_serializable: ^6.9.0
   drift_dev: ^2.22.1
+  test: ^1.25.7
 
 # For information on the generic Dart part of this file, see the
 # following page: https://dart.dev/tools/pub/pubspec

test/drift/sendtrain/generated/schema.dart

@@ -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];
+}

test/drift/sendtrain/migration_test.dart

@@ -0,0 +1,104 @@
+// dart format width=80
+// ignore_for_file: unused_local_variable, unused_import
+import 'package:drift/drift.dart';
+import 'package:drift_dev/api/migrations_native.dart';
+import 'package:sendtrain/database/database.dart';
+import 'package:test/test.dart';
+import 'generated/schema.dart';
+
+import 'generated/schema_v1.dart' as v1;
+import 'generated/schema_v2.dart' as v2;
+
+void main() {
+  driftRuntimeOptions.dontWarnAboutMultipleDatabases = true;
+  late SchemaVerifier verifier;
+
+  setUpAll(() {
+    verifier = SchemaVerifier(GeneratedHelper());
+  });
+
+  group('simple database migrations', () {
+    // These simple tests verify all possible schema updates with a simple (no
+    // data) migration. This is a quick way to ensure that written database
+    // migrations properly alter the schema.
+    final versions = GeneratedHelper.versions;
+    for (final (i, fromVersion) in versions.indexed) {
+      group('from $fromVersion', () {
+        for (final toVersion in versions.skip(i + 1)) {
+          test('to $toVersion', () async {
+            final schema = await verifier.schemaAt(fromVersion);
+            final db = AppDatabase(schema.newConnection());
+            await verifier.migrateAndValidate(db, toVersion);
+            await db.close();
+          });
+        }
+      });
+    }
+  });
+
+  // The following template shows how to write tests ensuring your migrations
+  // preserve existing data.
+  // Testing this can be useful for migrations that change existing columns
+  // (e.g. by alterating their type or constraints). Migrations that only add
+  // tables or columns typically don't need these advanced tests. For more
+  // information, see https://drift.simonbinder.eu/migrations/tests/#verifying-data-integrity
+  // TODO: This generated template shows how these tests could be written. Adopt
+  // it to your own needs when testing migrations with data integrity.
+  test("migration from v1 to v2 does not corrupt data", () async {
+    // Add data to insert into the old database, and the expected rows after the
+    // migration.
+    // TODO: Fill these lists
+    final oldSessionsData = <v1.SessionsData>[];
+    final expectedNewSessionsData = <v2.SessionsData>[];
+
+    final oldActivitiesData = <v1.ActivitiesData>[];
+    final expectedNewActivitiesData = <v2.ActivitiesData>[];
+
+    final oldSessionActivitiesData = <v1.SessionActivitiesData>[];
+    final expectedNewSessionActivitiesData = <v2.SessionActivitiesData>[];
+
+    final oldActionsData = <v1.ActionsData>[];
+    final expectedNewActionsData = <v2.ActionsData>[];
+
+    final oldActivityActionsData = <v1.ActivityActionsData>[];
+    final expectedNewActivityActionsData = <v2.ActivityActionsData>[];
+
+    final oldMediaItemsData = <v1.MediaItemsData>[];
+    final expectedNewMediaItemsData = <v2.MediaItemsData>[];
+
+    final oldObjectMediaItemsData = <v1.ObjectMediaItemsData>[];
+    final expectedNewObjectMediaItemsData = <v2.ObjectMediaItemsData>[];
+
+    await verifier.testWithDataIntegrity(
+      oldVersion: 1,
+      newVersion: 2,
+      createOld: v1.DatabaseAtV1.new,
+      createNew: v2.DatabaseAtV2.new,
+      openTestedDatabase: AppDatabase.new,
+      createItems: (batch, oldDb) {
+        batch.insertAll(oldDb.sessions, oldSessionsData);
+        batch.insertAll(oldDb.activities, oldActivitiesData);
+        batch.insertAll(oldDb.sessionActivities, oldSessionActivitiesData);
+        batch.insertAll(oldDb.actions, oldActionsData);
+        batch.insertAll(oldDb.activityActions, oldActivityActionsData);
+        batch.insertAll(oldDb.mediaItems, oldMediaItemsData);
+        batch.insertAll(oldDb.objectMediaItems, oldObjectMediaItemsData);
+      },
+      validateItems: (newDb) async {
+        expect(
+            expectedNewSessionsData, await newDb.select(newDb.sessions).get());
+        expect(expectedNewActivitiesData,
+            await newDb.select(newDb.activities).get());
+        expect(expectedNewSessionActivitiesData,
+            await newDb.select(newDb.sessionActivities).get());
+        expect(expectedNewActionsData, await newDb.select(newDb.actions).get());
+        expect(expectedNewActivityActionsData,
+            await newDb.select(newDb.activityActions).get());
+        expect(expectedNewMediaItemsData,
+            await newDb.select(newDb.mediaItems).get());
+        expect(expectedNewObjectMediaItemsData,
+            await newDb.select(newDb.objectMediaItems).get());
+      },
+    );
+  });
+}