Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
update tests
  • Loading branch information
buenaflor committed Sep 7, 2023
commit ef1e08cf5f6a5ff5e18690a735114be8c29319cb
11 changes: 3 additions & 8 deletions sqflite/lib/src/sentry_batch.dart
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import 'package:sqflite_common/src/sql_builder.dart';

import '../sentry_sqflite.dart';
import 'sentry_database.dart';
import 'utils/sentry_database_span_attributes.dart';

/// A [Batch] wrapper that adds Sentry support.
///
Expand Down Expand Up @@ -51,10 +52,7 @@ class SentryBatch implements Batch {

// ignore: invalid_use_of_internal_member
span?.origin = SentryTraceOrigins.autoDbSqfliteBatch;
span?.setData(SentryDatabase.dbSystemKey, 'sqlite');
if (SentryDatabase.currentDbName != null) {
span?.setData(SentryDatabase.dbNameKey, SentryDatabase.currentDbName);
}
setDatabaseAttributeData(span);

try {
final result = await _batch.apply(
Expand Down Expand Up @@ -92,10 +90,7 @@ class SentryBatch implements Batch {
);
// ignore: invalid_use_of_internal_member
span?.origin = SentryTraceOrigins.autoDbSqfliteBatch;
span?.setData(SentryDatabase.dbSystemKey, 'sqlite');
if (SentryDatabase.currentDbName != null) {
span?.setData(SentryDatabase.dbNameKey, SentryDatabase.currentDbName);
}
setDatabaseAttributeData(span);

try {
final result = await _batch.commit(
Expand Down
29 changes: 21 additions & 8 deletions sqflite/lib/src/sentry_database.dart
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
import 'package:meta/meta.dart';
import 'package:sentry/sentry.dart';
import 'package:sqflite/sqflite.dart';
import 'package:path/path.dart' as p;

import '../sentry_sqflite.dart';
import 'sentry_database_executor.dart';
import 'sentry_sqflite_transaction.dart';
import 'version.dart';
import 'utils/sentry_database_span_attributes.dart';

/// A [Database] wrapper that adds Sentry support.
///
Expand Down Expand Up @@ -38,10 +38,14 @@ class SentryDatabase extends SentryDatabaseExecutor implements Database {
static const dbSystemKey = 'db.system';
@internal
// ignore: public_member_api_docs
static const dbSystem = 'sqlite';
@internal
// ignore: public_member_api_docs
static const dbNameKey = 'db.name';
@internal
// ignore: public_member_api_docs
static String? currentDbName;
static String? dbName;


/// ```dart
/// import 'package:sqflite/sqflite.dart';
Expand All @@ -59,7 +63,19 @@ class SentryDatabase extends SentryDatabaseExecutor implements Database {
final options = _hub.options;
options.sdk.addIntegration('SentrySqfliteTracing');
options.sdk.addPackage(packageName, sdkVersion);
currentDbName = p.basenameWithoutExtension(_database.path);
dbName = _basenameWithoutExtension(_database.path);
}

/// Gets the part of path after the last separator, and without any trailing file extension.
String _basenameWithoutExtension(String filePath) {
int lastIndex = filePath.lastIndexOf('/');
int dotIndex = filePath.lastIndexOf('.');

if (dotIndex == -1 || (lastIndex != -1 && dotIndex < lastIndex)) {
return filePath;
}

return filePath.substring(lastIndex + 1, dotIndex);
}

// TODO: check if perf is enabled
Expand All @@ -75,7 +91,7 @@ class SentryDatabase extends SentryDatabaseExecutor implements Database {
// ignore: invalid_use_of_internal_member
span?.origin = SentryTraceOrigins.autoDbSqfliteDatabase;

currentDbName = null;
dbName = null;

try {
await _database.close();
Expand Down Expand Up @@ -127,10 +143,7 @@ class SentryDatabase extends SentryDatabaseExecutor implements Database {
);
// ignore: invalid_use_of_internal_member
span?.origin = SentryTraceOrigins.autoDbSqfliteDatabase;
span?.setData(dbSystemKey, 'sqlite');
if (currentDbName != null) {
span?.setData(dbNameKey, currentDbName);
}
setDatabaseAttributeData(span);

Future<T> newAction(Transaction txn) async {
final executor =
Expand Down
58 changes: 13 additions & 45 deletions sqflite/lib/src/sentry_database_executor.dart
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import 'package:sqflite_common/src/sql_builder.dart';

import 'sentry_batch.dart';
import 'sentry_database.dart';
import 'utils/sentry_database_span_attributes.dart';

@internal
// ignore: public_member_api_docs
Expand Down Expand Up @@ -41,10 +42,7 @@ class SentryDatabaseExecutor implements DatabaseExecutor {
);
// ignore: invalid_use_of_internal_member
span?.origin = SentryTraceOrigins.autoDbSqfliteDatabaseExecutor;
span?.setData(SentryDatabase.dbSystemKey, 'sqlite');
if (SentryDatabase.currentDbName != null) {
span?.setData(SentryDatabase.dbNameKey, SentryDatabase.currentDbName);
}
setDatabaseAttributeData(span);

try {
final result =
Expand Down Expand Up @@ -72,13 +70,10 @@ class SentryDatabaseExecutor implements DatabaseExecutor {
SentryDatabase.dbSqlExecuteOp,
description: sql,
);
span?.setData(SentryDatabase.dbSystemKey, 'sqlite');
span?.setData(SentryDatabase.dbSystemKey, SentryDatabase.dbSystem);
// ignore: invalid_use_of_internal_member
span?.origin = SentryTraceOrigins.autoDbSqfliteDatabaseExecutor;
span?.setData(SentryDatabase.dbSystemKey, 'sqlite');
if (SentryDatabase.currentDbName != null) {
span?.setData(SentryDatabase.dbNameKey, SentryDatabase.currentDbName);
}
setDatabaseAttributeData(span);

try {
await _executor.execute(sql, arguments);
Expand Down Expand Up @@ -116,10 +111,7 @@ class SentryDatabaseExecutor implements DatabaseExecutor {
);
// ignore: invalid_use_of_internal_member
span?.origin = SentryTraceOrigins.autoDbSqfliteDatabaseExecutor;
span?.setData(SentryDatabase.dbSystemKey, 'sqlite');
if (SentryDatabase.currentDbName != null) {
span?.setData(SentryDatabase.dbNameKey, SentryDatabase.currentDbName);
}
setDatabaseAttributeData(span);

try {
final result = await _executor.insert(
Expand Down Expand Up @@ -176,10 +168,7 @@ class SentryDatabaseExecutor implements DatabaseExecutor {
);
// ignore: invalid_use_of_internal_member
span?.origin = SentryTraceOrigins.autoDbSqfliteDatabaseExecutor;
span?.setData(SentryDatabase.dbSystemKey, 'sqlite');
if (SentryDatabase.currentDbName != null) {
span?.setData(SentryDatabase.dbNameKey, SentryDatabase.currentDbName);
}
setDatabaseAttributeData(span);

try {
final result = await _executor.query(
Expand Down Expand Up @@ -243,10 +232,7 @@ class SentryDatabaseExecutor implements DatabaseExecutor {
);
// ignore: invalid_use_of_internal_member
span?.origin = SentryTraceOrigins.autoDbSqfliteDatabaseExecutor;
span?.setData(SentryDatabase.dbSystemKey, 'sqlite');
if (SentryDatabase.currentDbName != null) {
span?.setData(SentryDatabase.dbNameKey, SentryDatabase.currentDbName);
}
setDatabaseAttributeData(span);

try {
final result = await _executor.queryCursor(
Expand Down Expand Up @@ -287,10 +273,7 @@ class SentryDatabaseExecutor implements DatabaseExecutor {
);
// ignore: invalid_use_of_internal_member
span?.origin = SentryTraceOrigins.autoDbSqfliteDatabaseExecutor;
span?.setData(SentryDatabase.dbSystemKey, 'sqlite');
if (SentryDatabase.currentDbName != null) {
span?.setData(SentryDatabase.dbNameKey, SentryDatabase.currentDbName);
}
setDatabaseAttributeData(span);

try {
final result = await _executor.rawDelete(sql, arguments);
Expand Down Expand Up @@ -319,10 +302,7 @@ class SentryDatabaseExecutor implements DatabaseExecutor {
);
// ignore: invalid_use_of_internal_member
span?.origin = SentryTraceOrigins.autoDbSqfliteDatabaseExecutor;
span?.setData(SentryDatabase.dbSystemKey, 'sqlite');
if (SentryDatabase.currentDbName != null) {
span?.setData(SentryDatabase.dbNameKey, SentryDatabase.currentDbName);
}
setDatabaseAttributeData(span);

try {
final result = await _executor.rawInsert(sql, arguments);
Expand Down Expand Up @@ -354,10 +334,7 @@ class SentryDatabaseExecutor implements DatabaseExecutor {
);
// ignore: invalid_use_of_internal_member
span?.origin = SentryTraceOrigins.autoDbSqfliteDatabaseExecutor;
span?.setData(SentryDatabase.dbSystemKey, 'sqlite');
if (SentryDatabase.currentDbName != null) {
span?.setData(SentryDatabase.dbNameKey, SentryDatabase.currentDbName);
}
setDatabaseAttributeData(span);

try {
final result = await _executor.rawQuery(sql, arguments);
Expand Down Expand Up @@ -390,10 +367,7 @@ class SentryDatabaseExecutor implements DatabaseExecutor {
);
// ignore: invalid_use_of_internal_member
span?.origin = SentryTraceOrigins.autoDbSqfliteDatabaseExecutor;
span?.setData(SentryDatabase.dbSystemKey, 'sqlite');
if (SentryDatabase.currentDbName != null) {
span?.setData(SentryDatabase.dbNameKey, SentryDatabase.currentDbName);
}
setDatabaseAttributeData(span);

try {
final result = await _executor.rawQueryCursor(
Expand Down Expand Up @@ -426,10 +400,7 @@ class SentryDatabaseExecutor implements DatabaseExecutor {
);
// ignore: invalid_use_of_internal_member
span?.origin = SentryTraceOrigins.autoDbSqfliteDatabaseExecutor;
span?.setData(SentryDatabase.dbSystemKey, 'sqlite');
if (SentryDatabase.currentDbName != null) {
span?.setData(SentryDatabase.dbNameKey, SentryDatabase.currentDbName);
}
setDatabaseAttributeData(span);

try {
final result = await _executor.rawUpdate(sql, arguments);
Expand Down Expand Up @@ -471,10 +442,7 @@ class SentryDatabaseExecutor implements DatabaseExecutor {
);
// ignore: invalid_use_of_internal_member
span?.origin = SentryTraceOrigins.autoDbSqfliteDatabaseExecutor;
span?.setData(SentryDatabase.dbSystemKey, 'sqlite');
if (SentryDatabase.currentDbName != null) {
span?.setData(SentryDatabase.dbNameKey, SentryDatabase.currentDbName);
}
setDatabaseAttributeData(span);

try {
final result = await _executor.update(
Expand Down
12 changes: 12 additions & 0 deletions sqflite/lib/src/utils/sentry_database_span_attributes.dart
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
import 'package:sentry/sentry.dart';

import '../../sentry_sqflite.dart';

/// Sets the database attributes on the [span].
/// It contains the database system and the database name.
void setDatabaseAttributeData(ISentrySpan? span) {
span?.setData(SentryDatabase.dbSystemKey, SentryDatabase.dbSystem);
if (SentryDatabase.dbName != null) {
span?.setData(SentryDatabase.dbNameKey, SentryDatabase.dbName);
}
}
1 change: 0 additions & 1 deletion sqflite/pubspec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ dependencies:
sqflite: ^2.0.0
sqflite_common: ^2.0.0
meta: ^1.3.0
path: ^1.8.3

dev_dependencies:
lints: ^2.0.0
Expand Down
12 changes: 6 additions & 6 deletions sqflite/test/sentry_batch_test.dart
Original file line number Diff line number Diff line change
Expand Up @@ -294,8 +294,8 @@ SELECT * FROM Product''';
await batch.apply();

final span = fixture.tracer.children.last;
expect(span.data[SentryDatabase.dbSystemKey], 'sqlite');
expect(span.data[SentryDatabase.dbNameKey], SentryDatabase.currentDbName);
expect(span.data[SentryDatabase.dbSystemKey], SentryDatabase.dbSystem);
expect(span.data[SentryDatabase.dbNameKey], SentryDatabase.dbName);

await db.close();
});
Expand All @@ -310,23 +310,23 @@ SELECT * FROM Product''';
await batch.commit();

final span = fixture.tracer.children.last;
expect(span.data[SentryDatabase.dbSystemKey], 'sqlite');
expect(span.data[SentryDatabase.dbNameKey], SentryDatabase.currentDbName);
expect(span.data[SentryDatabase.dbSystemKey], SentryDatabase.dbSystem);
expect(span.data[SentryDatabase.dbNameKey], SentryDatabase.dbName);

await db.close();
});

test('dbName attribute is null if currentDbName is null', () async {
final db = await fixture.getDatabase();
final batch = db.batch();
SentryDatabase.currentDbName = null;
SentryDatabase.dbName = null;

batch.insert('Product', <String, Object?>{'title': 'Product 1'});

await batch.commit();

final span = fixture.tracer.children.last;
expect(span.data[SentryDatabase.dbSystemKey], 'sqlite');
expect(span.data[SentryDatabase.dbSystemKey], SentryDatabase.dbSystem);
expect(span.data[SentryDatabase.dbNameKey], isNull);

await db.close();
Expand Down
Loading