Test file generated using make-migrations doesn't compile

[joseph-neeraj]

Followed the steps in the documentation to use the make-migrations script for database migration.
When running the generated test file using flutter test, noticed that it doesn't compile. What am I doing wrong ?
The issue is that the generated test class tries to pass in an argument for instantiating my database, but it's constructor doesn't take any arguments.

This is the error:

test/drift/my_database/migration_test.dart:30:40: Error: Too many positional arguments: 0 allowed, but 1
found.
Try removing the extra positional arguments.
            final db = DriftAppDatabase(schema.newConnection());
                                       ^
lib/db/drift/drift_db.dart:82:3: Context: Found this candidate, but the arguments don't match.
  DriftAppDatabase() : super(_openConnection());
  ^^^^^^^^^^^^^^^^
test/drift/my_database/migration_test.dart:63:27: Error: The argument type 'DriftAppDatabase Function()'
can't be assigned to the parameter type 'GeneratedDatabase Function(QueryExecutor)'.
 - 'DriftAppDatabase' is from 'package:pockets/db/drift/drift_db.dart' ('lib/db/drift/drift_db.dart').
 - 'GeneratedDatabase' is from 'package:drift/src/runtime/api/runtime_api.dart'
 ('../../.pub-cache/hosted/pub.dev/drift-2.23.1/lib/src/runtime/api/runtime_api.dart').
 - 'QueryExecutor' is from 'package:drift/src/runtime/executor/executor.dart'
 ('../../.pub-cache/hosted/pub.dev/drift-2.23.1/lib/src/runtime/executor/executor.dart').
      openTestedDatabase: DriftAppDatabase.new,

These are the relevant parts of my database class (basically a copy paste of the example here: https://drift.simonbinder.eu/setup/#database-class)

class DriftAppDatabase extends _$DriftAppDatabase {
  DriftAppDatabase() : super(_openConnection());

  @override
  int get schemaVersion => 2;
  @override
  MigrationStrategy get migration {
    return MigrationStrategy(onUpgrade: stepByStep(from1To2: (m, schema) async {
     // migration code
      
    }));
  }

  static LazyDatabase _openConnection() {
    return LazyDatabase(() async {
      final dbFolder = await getApplicationDocumentsDirectory();
      final file = File(p.join(dbFolder.path, 'my_db.sqlite'));

      if (Platform.isAndroid) {
        await applyWorkaroundToOpenSqlite3OnOldAndroidVersions();
      }

      final cachebase = (await getTemporaryDirectory()).path;
      sqlite3.tempDirectory = cachebase;

      return NativeDatabase.createInBackground(file);
    });
  }
}

[simolus3]

The tests expect that your database is set up like this to allow passing a custom connection:

class DriftAppDatabase extends _$DriftAppDatabase {
  DriftAppDatabase([QueryExecutor? e]) : super(e ?? _openConnection());

I think we should add a check in the command that warns about this if the database has no arguments in its default constructor (and also fix the snippets on the documentation site to align with the format expected by the tests).

[joseph-neeraj]

Fantastic !! That fixed the constructor error . But making the change gave me another error:
Invalid argument(s): Failed to load dynamic library 'libsqlite3.so': libsqlite3.so: cannot open shared object file: No such file or directory dart:ffi

Was able to fix it by installing libsqlite3 . Something to keep in mind though.

I'll try to create PR to mention the QueryExecutor in the docs.

Thanks :)

[goerlitz]

I had the same issue. When I copied the code from https://drift.simonbinder.eu/setup/#database-class long time ago it was
AppDatabase() : super(_openConnection());
Looks like the page has been updated now with the correct code.