Merge branch 'develop' into ffi

# Conflicts:
#	moor/lib/src/runtime/executor/helpers/engines.dart
#	moor/lib/src/web/web_db.dart
This commit is contained in:
Simon Binder 2019-07-22 13:06:24 +02:00
commit e36fe84480
No known key found for this signature in database
GPG Key ID: 7891917E4147B8C0
4 changed files with 102 additions and 256 deletions

View File

@ -70,8 +70,8 @@ class Entry extends DataClass implements Insertable<Entry> {
}
@override
int get hashCode => $mrjf(
$mrjc($mrjc($mrjc(0, id.hashCode), content.hashCode), done.hashCode));
int get hashCode =>
$mrjf($mrjc(id.hashCode, $mrjc(content.hashCode, done.hashCode)));
@override
bool operator ==(other) =>
identical(this, other) ||

View File

@ -10,8 +10,8 @@ dependencies:
dev_dependencies:
moor_generator:
build_runner: ^1.1.2
build_web_compilers: ^1.0.0
build_runner: ^1.6.0
build_web_compilers: ^2.1.0
dependency_overrides:
moor:

View File

@ -9,9 +9,8 @@ import 'dart:async';
import 'dart:html';
import 'package:meta/meta.dart';
import 'package:meta/dart2js.dart';
import 'package:synchronized/synchronized.dart';
import 'backends.dart';
import 'moor.dart';
import 'src/web/binary_string_conversion.dart';
import 'src/web/sql_js.dart';

View File

@ -1,36 +1,98 @@
part of 'package:moor/moor_web.dart';
class _DbState {
final String name;
final bool logStatements;
final Lock lock = Lock();
SqlJsDatabase db;
_DbState(this.name, this.logStatements);
/// Experimental moor backend for the web. To use this platform, you need to
/// include the latest version of `sql.js` in your html.
class WebDatabase extends DelegatedDatabase {
WebDatabase(String name, {bool logStatements = false})
: super(_WebDelegate(name), logStatements: logStatements);
}
abstract class _DatabaseUser extends QueryExecutor {
final _DbState _state;
String get name => _state.name;
bool get logStatements => _state.logStatements;
SqlJsDatabase get _db => _state.db;
bool get _bypassLock => false;
class _WebDelegate extends DatabaseDelegate {
final String name;
SqlJsDatabase _db;
String get _persistenceKey => 'moor_db_str_$name';
String get _versionKey => 'moor_db_version_$name';
_DatabaseUser(this._state);
_WebDelegate(this.name);
Future<T> _synchronized<T>(FutureOr<T> computation()) async {
final lock = _state.lock;
if (_bypassLock) {
return await computation();
@override
final TransactionDelegate transactionDelegate = const NoTransactionDelegate();
@override
DbVersionDelegate get versionDelegate => _WebVersionDelegate(name);
@override
Future<bool> get isOpen => Future.value(_db != null);
@override
Future<void> open([GeneratedDatabase db]) async {
final dbVersion = db.schemaVersion;
assert(dbVersion >= 1, 'Database schema version needs to be at least 1');
final module = await initSqlJs();
final restored = _restoreDb();
_db = module.createDatabase(restored);
}
@override
Future<void> runBatched(List<BatchedStatement> statements) {
for (var stmt in statements) {
final prepared = _db.prepare(stmt.sql);
for (var args in stmt.variables) {
prepared.executeWith(args);
}
}
return _handlePotentialUpdate();
}
@override
Future<void> runCustom(String statement, List args) {
_db.runWithArgs(statement, args);
return Future.value();
}
@override
Future<int> runInsert(String statement, List args) async {
_db.runWithArgs(statement, args);
final insertId = _db.lastInsertId();
await _handlePotentialUpdate();
return insertId;
}
@override
Future<QueryResult> runSelect(String statement, List args) {
// todo at least for stream queries we should cache prepared statements.
final stmt = _db.prepare(statement)..executeWith(args);
List<String> columnNames;
final rows = <List<dynamic>>[];
while (stmt.step()) {
columnNames ??= stmt.columnNames();
rows.add(stmt.currentRow());
}
return await lock.synchronized(computation);
columnNames ??= []; // assume no column names when there were no rows
stmt.free();
return Future.value(QueryResult(columnNames, rows));
}
@override
Future<int> runUpdate(String statement, List args) {
_db.runWithArgs(statement, args);
return _handlePotentialUpdate();
}
/// Saves the database if the last statement changed rows. As a side-effect,
/// saving the database resets the `last_insert_id` counter in sqlite.
Future<int> _handlePotentialUpdate() {
final modified = _db.lastModifiedRows();
if (modified > 0) {
_storeDb();
}
return Future.value(modified);
}
Uint8List _restoreDb() {
@ -46,242 +108,27 @@ abstract class _DatabaseUser extends QueryExecutor {
final binStr = bin2str.encode(data);
window.localStorage[_persistenceKey] = binStr;
}
@tryInline
void _log(String sql, List<dynamic> variables) {
if (logStatements) {
print('[moor_web]: Running $sql with bound args: $variables');
}
}
/// Executes [sql] with the bound [variables], and ignores the result.
Future _runSimple(String sql, List<dynamic> variables) {
return _synchronized(() {
_log(sql, variables);
_db.runWithArgs(sql, variables);
});
}
Future<void> _runWithoutArgs(String query) {
return _synchronized(() {
_db.run(query);
});
}
@override
Future<void> runCustom(String statement) {
return _runWithoutArgs(statement);
}
@override
Future<int> runDelete(String statement, List args) {
_runSimple(statement, args);
return _handlePotentialUpdate();
}
@override
Future<int> runUpdate(String statement, List args) {
_runSimple(statement, args);
return _handlePotentialUpdate();
}
@override
Future<void> runBatched(List<BatchedStatement> statements) async {
await _synchronized(() {
for (var stmt in statements) {
final prepared = _db.prepare(stmt.sql);
for (var args in stmt.variables) {
prepared.executeWith(args);
}
}
});
await _handlePotentialUpdate();
}
/// Saves the database if the last statement changed rows. As a side-effect,
/// saving the database resets the `last_insert_id` counter in sqlite.
Future<int> _handlePotentialUpdate() {
final modified = _db.lastModifiedRows();
if (modified > 0) {
_storeDb();
}
return Future.value(modified);
}
@override
Future<int> runInsert(String statement, List args) async {
await _runSimple(statement, args);
final insertId = _db.lastInsertId();
await _handlePotentialUpdate();
return insertId;
}
@override
Future<List<Map<String, dynamic>>> runSelect(String statement, List args) {
_log(statement, args);
return _synchronized(() async {
// todo at least for stream queries we should cache prepared statements.
final stmt = _db.prepare(statement)..executeWith(args);
List<String> columnNames;
final rows = <Map<String, dynamic>>[];
while (stmt.step()) {
columnNames ??= stmt.columnNames();
final row = stmt.currentRow();
rows.add({for (var i = 0; i < row.length; i++) columnNames[i]: row[i]});
}
stmt.free();
return rows;
});
}
}
/// Experimental moor backend for the web. To use this platform, you need to
/// include the latest version of `sql.js` in your html.
class WebDatabase extends _DatabaseUser {
Completer<bool> _openingCompleter;
class _WebVersionDelegate extends DynamicVersionDelegate {
String get _versionKey => 'moor_db_version_$name';
final String name;
WebDatabase(String name, {bool logStatements = false})
: super(_DbState(name, logStatements));
_WebVersionDelegate(this.name);
@override
TransactionExecutor beginTransaction() {
final transactionReady = Completer<bool>();
final executor = _TransactionExecutor(_state, transactionReady.future);
Future<int> get schemaVersion async {
if (!window.localStorage.containsKey(_versionKey)) {
return null;
}
final versionStr = window.localStorage[_versionKey];
_synchronized(() async {
// we have the lock -> start the transaction
transactionReady.complete(true);
// wait until the transaction is done, then release the lock
await executor.completed;
if (executor._needsSave) {
_storeDb();
}
});
return executor;
return int.tryParse(versionStr);
}
@override
Future<bool> ensureOpen() async {
// sync mechanism to make sure _openInternal is only called once
if (_db != null) {
return true;
} else if (_openingCompleter != null) {
return _openingCompleter.future;
} else {
_openingCompleter = Completer();
await _openInternal();
_openingCompleter.complete(true);
return true;
}
}
Future<void> _openInternal() async {
// We don't get information about the database version from sql.js, so we
// store the database version using local storage.
int oldVersion;
final dbVersion = databaseInfo.schemaVersion;
assert(dbVersion >= 1, 'Database schema version needs to be at least 1');
var upgradeNeeded = false;
if (window.localStorage.containsKey(_versionKey)) {
final versionStr = window.localStorage[_versionKey];
oldVersion = int.parse(versionStr);
if (oldVersion < 1) oldVersion = null;
}
if (oldVersion == null || oldVersion < dbVersion) {
upgradeNeeded = true;
window.localStorage[_versionKey] = dbVersion.toString();
}
final module = await initSqlJs();
final restored = _restoreDb();
_state.db = module.createDatabase(restored);
if (upgradeNeeded) {
if (oldVersion == null) {
await databaseInfo.handleDatabaseCreation(executor: _runWithoutArgs);
} else {
await databaseInfo.handleDatabaseVersionChange(
executor: _runWithoutArgs, from: oldVersion, to: dbVersion);
}
}
await _synchronized(() {
return databaseInfo.beforeOpenCallback(_BeforeOpenExecutor(_state),
OpeningDetails(oldVersion, databaseInfo.schemaVersion));
});
if (upgradeNeeded) {
// assume that a schema version was written in an upgrade => save db
_storeDb();
}
}
}
class _BeforeOpenExecutor extends _DatabaseUser {
_BeforeOpenExecutor(_DbState state) : super(state);
@override
final bool _bypassLock = true;
@override
TransactionExecutor beginTransaction() {
throw Error();
}
@override
Future<bool> ensureOpen() => Future.value(true);
}
class _TransactionExecutor extends _DatabaseUser
implements TransactionExecutor {
_TransactionExecutor(_DbState state, this._openingFuture) : super(state);
@override
final bool _bypassLock = true;
final Future<bool> _openingFuture;
bool _sentBeginTransaction = false;
final Completer<void> _completer = Completer();
Future<void> get completed => _completer.future;
bool _needsSave = false;
@override
void _storeDb() {
// no-op inside a transaction. Store the database when we it's done!
_needsSave = true;
}
@override
Future<bool> ensureOpen() async {
await _openingFuture;
if (!_sentBeginTransaction) {
_db.run('BEGIN TRANSACTION');
_sentBeginTransaction = true;
}
return Future.value(true);
}
@override
Future<void> send() {
_db.run('COMMIT TRANSACTION;');
_completer.complete();
Future<void> setSchemaVersion(int version) {
window.localStorage[_versionKey] = version.toString();
return Future.value();
}
@override
TransactionExecutor beginTransaction() {
throw Error();
}
}