Add common prefix

Author: simolus3

packages/sqlite_async/lib/src/common/connection/sync_sqlite_connection.dart

@@ -3,6 +3,7 @@ import 'dart:developer';
 import 'package:sqlite3/common.dart';
 import 'package:sqlite_async/src/common/mutex.dart';
 import 'package:sqlite_async/src/sqlite_connection.dart';
+import 'package:sqlite_async/src/sqlite_options.dart';
 import 'package:sqlite_async/src/sqlite_queries.dart';
 import 'package:sqlite_async/src/update_notification.dart';
 import 'package:sqlite_async/src/utils/profiler.dart';
@@ -19,10 +20,13 @@ class SyncSqliteConnection extends SqliteConnection with SqliteQueries {
 
   /// Whether queries should be added to the `dart:developer` timeline.
   ///
-  /// This is disabled by default.
+  /// This is enabled by default outside of release builds, see
+  /// [SqliteOptions.profileQueries] for details.
   final bool profileQueries;
 
-  SyncSqliteConnection(this.db, Mutex m, {this.profileQueries = false}) {
+  SyncSqliteConnection(this.db, Mutex m, {bool? profileQueries})
+      : profileQueries =
+            profileQueries ?? const SqliteOptions().profileQueries {
     mutex = m.open();
     updates = db.updates.map(
       (event) {
@@ -35,7 +39,7 @@ class SyncSqliteConnection extends SqliteConnection with SqliteQueries {
   Future<T> readLock<T>(Future<T> Function(SqliteReadContext tx) callback,
       {Duration? lockTimeout, String? debugContext}) {
     final task = profileQueries ? TimelineTask() : null;
-    task?.start('mutex_lock');
+    task?.start('${profilerPrefix}mutex_lock');
 
     return mutex.lock(
       () {
@@ -50,7 +54,7 @@ class SyncSqliteConnection extends SqliteConnection with SqliteQueries {
   Future<T> writeLock<T>(Future<T> Function(SqliteWriteContext tx) callback,
       {Duration? lockTimeout, String? debugContext}) {
     final task = profileQueries ? TimelineTask() : null;
-    task?.start('mutex_lock');
+    task?.start('${profilerPrefix}mutex_lock');
 
     return mutex.lock(
       () {
@@ -95,7 +99,8 @@ class SyncReadContext implements SqliteReadContext {
     return task.timeSync(
       'get',
       () => db.select(sql, parameters).first,
-      arguments: timelineArgs(sql, parameters),
+      sql: sql,
+      parameters: parameters,
     );
   }
 
@@ -105,7 +110,8 @@ class SyncReadContext implements SqliteReadContext {
     return task.timeSync(
       'getAll',
       () => db.select(sql, parameters),
-      arguments: timelineArgs(sql, parameters),
+      sql: sql,
+      parameters: parameters,
     );
   }
 
@@ -134,7 +140,8 @@ class SyncWriteContext extends SyncReadContext implements SqliteWriteContext {
     return task.timeSync(
       'execute',
       () => db.select(sql, parameters),
-      arguments: timelineArgs(sql, parameters),
+      sql: sql,
+      parameters: parameters,
     );
   }
 
@@ -146,11 +153,11 @@ class SyncWriteContext extends SyncReadContext implements SqliteWriteContext {
       try {
         for (var parameters in parameterSets) {
           task.timeSync('iteration', () => statement.execute(parameters),
-              arguments: parameterArgs(parameters));
+              parameters: parameters);
         }
       } finally {
         statement.dispose();
       }
-    }, arguments: {'sql': sql});
+    }, sql: sql);
   }
 }

packages/sqlite_async/lib/src/native/database/native_sqlite_connection_impl.dart

@@ -386,8 +386,12 @@ Future<void> _sqliteConnectionIsolateInner(_SqliteConnectionParams params,
         maybeFireUpdates();
         return null;
       case _SqliteIsolateStatement():
-        return task.timeSync('execute_remote', () => runStatement(data),
-            arguments: timelineArgs(data.sql, data.args));
+        return task.timeSync(
+          'execute_remote',
+          () => runStatement(data),
+          sql: data.sql,
+          parameters: data.args,
+        );
       case _SqliteIsolateClosure():
         try {
           return await data.cb(db);

packages/sqlite_async/lib/src/sqlite_connection.dart

@@ -94,10 +94,10 @@ abstract class SqliteConnection extends SqliteWriteContext {
   /// may be used as an escape hatch for the asynchronous wrappers provided by
   /// this package.
   ///
-  /// When [profileQueries] is enabled (it's disabled by default, queries are
-  /// posted to the `dart:developer` timeline).
+  /// When [profileQueries] is enabled (it's enabled by default outside of
+  /// release builds, queries are posted to the `dart:developer` timeline).
   factory SqliteConnection.synchronousWrapper(CommonDatabase raw,
-      {Mutex? mutex, bool profileQueries = false}) {
+      {Mutex? mutex, bool? profileQueries}) {
     return SyncSqliteConnection(raw, mutex ?? Mutex(),
         profileQueries: profileQueries);
   }

packages/sqlite_async/lib/src/utils/profiler.dart

@@ -1,33 +1,64 @@
 import 'dart:developer';
 
-/// Turns the [parameters] for an SQL query into a [Map] that can be serialized
-/// to JSON (as a requirement for using it as a timeline argument).
-Map parameterArgs(List<Object?> parameters) {
-  return {
-    'parameters': [
-      for (final parameter in parameters)
-        if (parameter is List) '<blob>' else parameter
-    ],
-  };
-}
-
-Map timelineArgs(String sql, List<Object?> parameters) {
-  return parameterArgs(parameters)..['sql'] = sql;
-}
-
 extension TimeSync on TimelineTask? {
   T timeSync<T>(String name, TimelineSyncFunction<T> function,
-      {Map? arguments}) {
+      {String? sql, List<Object?>? parameters}) {
     final currentTask = this;
     if (currentTask == null) {
       return function();
     }
 
+    final (resolvedName, args) =
+        profilerNameAndArgs(name, sql: sql, parameters: parameters);
+    currentTask.start(resolvedName, arguments: args);
+
     try {
-      currentTask.start(name, arguments: arguments);
       return function();
     } finally {
       currentTask.finish();
     }
   }
+
+  Future<T> timeAsync<T>(String name, TimelineSyncFunction<Future<T>> function,
+      {String? sql, List<Object?>? parameters}) {
+    final currentTask = this;
+    if (currentTask == null) {
+      return function();
+    }
+
+    final (resolvedName, args) =
+        profilerNameAndArgs(name, sql: sql, parameters: parameters);
+    currentTask.start(resolvedName, arguments: args);
+
+    return Future.sync(function).whenComplete(() {
+      currentTask.finish();
+    });
+  }
+}
+
+(String, Map) profilerNameAndArgs(String name,
+    {String? sql, List<Object?>? parameters}) {
+  // On native platforms, we want static names for tasks because every
+  // unique key here shows up in a separate line in Perfetto: https://github.com/dart-lang/sdk/issues/56274
+  // On the web however, the names are embedded in the timeline slices and
+  // it's convenient to include the SQL there.
+  const isWeb = bool.fromEnvironment('dart.library.js_interop');
+  var resolvedName = '$profilerPrefix$name';
+  if (isWeb && sql != null) {
+    resolvedName = ' $sql';
+  }
+
+  return (
+    resolvedName,
+    {
+      if (sql != null) 'sql': sql,
+      if (parameters != null)
+        'parameters': [
+          for (final parameter in parameters)
+            if (parameter is List) '<blob>' else parameter
+        ],
+    }
+  );
 }
+
+const profilerPrefix = 'sqlite_async:';

packages/sqlite_async/lib/src/web/database.dart

@@ -207,13 +207,15 @@ class _SharedContext implements SqliteReadContext {
   @override
   Future<ResultSet> getAll(String sql,
       [List<Object?> parameters = const []]) async {
-    try {
-      _task?.start('getAll', arguments: timelineArgs(sql, parameters));
-      return await wrapSqliteException(
-          () => _database._database.select(sql, parameters));
-    } finally {
-      _task?.finish();
-    }
+    return _task.timeAsync(
+      'getAll',
+      sql: sql,
+      parameters: parameters,
+      () async {
+        return await wrapSqliteException(
+            () => _database._database.select(sql, parameters));
+      },
+    );
   }
 
   @override
@@ -237,21 +239,23 @@ class _ExclusiveContext extends _SharedContext implements SqliteWriteContext {
   _ExclusiveContext(super.database);
 
   @override
-  Future<ResultSet> execute(String sql,
-      [List<Object?> parameters = const []]) async {
-    return wrapSqliteException(
-        () => _database._database.select(sql, parameters));
+  Future<ResultSet> execute(String sql, [List<Object?> parameters = const []]) {
+    return _task.timeAsync('execute', sql: sql, parameters: parameters, () {
+      return wrapSqliteException(
+          () => _database._database.select(sql, parameters));
+    });
   }
 
   @override
-  Future<void> executeBatch(
-      String sql, List<List<Object?>> parameterSets) async {
-    return wrapSqliteException(() async {
-      for (final set in parameterSets) {
-        // use execute instead of select to avoid transferring rows from the
-        // worker to this context.
-        await _database._database.execute(sql, set);
-      }
+  Future<void> executeBatch(String sql, List<List<Object?>> parameterSets) {
+    return _task.timeAsync('executeBatch', sql: sql, () {
+      return wrapSqliteException(() async {
+        for (final set in parameterSets) {
+          // use execute instead of select to avoid transferring rows from the
+          // worker to this context.
+          await _database._database.execute(sql, set);
+        }
+      });
     });
   }
 }
@@ -312,23 +316,19 @@ class _ExclusiveTransactionContext extends _ExclusiveContext {
   @override
   Future<ResultSet> execute(String sql,
       [List<Object?> parameters = const []]) async {
-    try {
-      _task?.start('execute', arguments: timelineArgs(sql, parameters));
-      return await _executeInternal(sql, parameters);
-    } finally {
-      _task?.finish();
-    }
+    return _task.timeAsync('execute', sql: sql, parameters: parameters, () {
+      return _executeInternal(sql, parameters);
+    });
   }
 
   @override
   Future<void> executeBatch(
       String sql, List<List<Object?>> parameterSets) async {
-    return await wrapSqliteException(() async {
+    return _task.timeAsync('executeBatch', sql: sql, () async {
       for (final set in parameterSets) {
         await _database._database.customRequest(CustomDatabaseMessage(
             CustomDatabaseMessageKind.executeBatchInTransaction, sql, set));
       }
-      return;
     });
   }
 }

packages/sqlite_async/lib/src/web/worker/throttled_common_database.dart

@@ -24,11 +24,10 @@ class ThrottledCommonDatabase extends CommonDatabase {
     required List<Object?> parameters,
   }) {
     if (profileQueries) {
-      return Timeline.timeSync(
-        name,
-        function,
-        arguments: timelineArgs(sql, parameters),
-      );
+      final (resolvedName, args) =
+          profilerNameAndArgs(name, sql: sql, parameters: parameters);
+
+      return Timeline.timeSync(resolvedName, function, arguments: args);
     } else {
       return function();
     }