Skip to content

Commit d8fb258

Browse files
WaterWhispererWaterWhisperer
committed
Avoid recording SQL arguments via tracing::instrument 
1 parent 0677ee5 commit d8fb258

18 files changed

Lines changed: 90 additions & 89 deletions

‎sea-orm-sync/src/database/db_connection.rs‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ impl ConnectionTrait for DatabaseConnection {
140140
self.get_database_backend()
141141
}
142142

143-
#[instrument(level = "trace")]
143+
#[instrument(level = "trace", skip(stmt))]
144144
#[allow(unused_variables)]
145145
fn execute_raw(&self, stmt: Statement) -> Result<ExecResult, DbErr> {
146146
super::tracing_spans::with_db_span!(
@@ -168,7 +168,7 @@ impl ConnectionTrait for DatabaseConnection {
168168
)
169169
}
170170

171-
#[instrument(level = "trace")]
171+
#[instrument(level = "trace", skip(sql))]
172172
#[allow(unused_variables)]
173173
fn execute_unprepared(&self, sql: &str) -> Result<ExecResult, DbErr> {
174174
super::tracing_spans::with_db_span!(
@@ -212,7 +212,7 @@ impl ConnectionTrait for DatabaseConnection {
212212
)
213213
}
214214

215-
#[instrument(level = "trace")]
215+
#[instrument(level = "trace", skip(stmt))]
216216
#[allow(unused_variables)]
217217
fn query_one_raw(&self, stmt: Statement) -> Result<Option<QueryResult>, DbErr> {
218218
super::tracing_spans::with_db_span!(
@@ -242,7 +242,7 @@ impl ConnectionTrait for DatabaseConnection {
242242
)
243243
}
244244

245-
#[instrument(level = "trace")]
245+
#[instrument(level = "trace", skip(stmt))]
246246
#[allow(unused_variables)]
247247
fn query_all_raw(&self, stmt: Statement) -> Result<Vec<QueryResult>, DbErr> {
248248
super::tracing_spans::with_db_span!(
@@ -291,7 +291,7 @@ impl StreamTrait for DatabaseConnection {
291291
self.get_database_backend()
292292
}
293293

294-
#[instrument(level = "trace")]
294+
#[instrument(level = "trace", skip(stmt))]
295295
#[allow(unused_variables)]
296296
fn stream_raw<'a>(&'a self, stmt: Statement) -> Result<Self::Stream<'a>, DbErr> {
297297
({

‎sea-orm-sync/src/database/mock.rs‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ impl MockDatabase {
115115
}
116116

117117
impl MockDatabaseTrait for MockDatabase {
118-
#[instrument(level = "trace")]
118+
#[instrument(level = "trace", skip(statement))]
119119
fn execute(&mut self, counter: usize, statement: Statement) -> Result<ExecResult, DbErr> {
120120
if let Some(transaction) = &mut self.transaction {
121121
transaction.push(statement);
@@ -137,7 +137,7 @@ impl MockDatabaseTrait for MockDatabase {
137137
}
138138
}
139139

140-
#[instrument(level = "trace")]
140+
#[instrument(level = "trace", skip(statement))]
141141
fn query(&mut self, counter: usize, statement: Statement) -> Result<Vec<QueryResult>, DbErr> {
142142
if let Some(transaction) = &mut self.transaction {
143143
transaction.push(statement);
@@ -432,6 +432,7 @@ mod tests {
432432
DbBackend, DbErr, IntoMockRow, MockDatabase, Statement, Transaction, TransactionError,
433433
TransactionTrait, entity::*, error::*, tests_cfg::*,
434434
};
435+
use futures_util::TryStreamExt;
435436
use pretty_assertions::assert_eq;
436437

437438
#[derive(Debug, PartialEq, Eq)]

‎sea-orm-sync/src/database/transaction.rs‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -315,7 +315,7 @@ impl ConnectionTrait for DatabaseTransaction {
315315
self.backend
316316
}
317317

318-
#[instrument(level = "trace")]
318+
#[instrument(level = "trace", skip(stmt))]
319319
#[allow(unused_variables)]
320320
fn execute_raw(&self, stmt: Statement) -> Result<ExecResult, DbErr> {
321321
debug_print!("{}", stmt);
@@ -372,7 +372,7 @@ impl ConnectionTrait for DatabaseTransaction {
372372
)
373373
}
374374

375-
#[instrument(level = "trace")]
375+
#[instrument(level = "trace", skip(sql))]
376376
#[allow(unused_variables)]
377377
fn execute_unprepared(&self, sql: &str) -> Result<ExecResult, DbErr> {
378378
debug_print!("{}", sql);
@@ -431,7 +431,7 @@ impl ConnectionTrait for DatabaseTransaction {
431431
)
432432
}
433433

434-
#[instrument(level = "trace")]
434+
#[instrument(level = "trace", skip(stmt))]
435435
#[allow(unused_variables)]
436436
fn query_one_raw(&self, stmt: Statement) -> Result<Option<QueryResult>, DbErr> {
437437
debug_print!("{}", stmt);
@@ -491,7 +491,7 @@ impl ConnectionTrait for DatabaseTransaction {
491491
)
492492
}
493493

494-
#[instrument(level = "trace")]
494+
#[instrument(level = "trace", skip(stmt))]
495495
#[allow(unused_variables)]
496496
fn query_all_raw(&self, stmt: Statement) -> Result<Vec<QueryResult>, DbErr> {
497497
debug_print!("{}", stmt);
@@ -562,7 +562,7 @@ impl StreamTrait for DatabaseTransaction {
562562
self.backend
563563
}
564564

565-
#[instrument(level = "trace")]
565+
#[instrument(level = "trace", skip(stmt))]
566566
fn stream_raw<'a>(&'a self, stmt: Statement) -> Result<Self::Stream<'a>, DbErr> {
567567
({
568568
#[cfg(not(feature = "sync"))]

‎sea-orm-sync/src/driver/mock.rs‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ impl MockDatabaseConnection {
143143
}
144144

145145
/// Execute the SQL statement in the [MockDatabase]
146-
#[instrument(level = "trace")]
146+
#[instrument(level = "trace", skip(statement))]
147147
pub fn execute(&self, statement: Statement) -> Result<ExecResult, DbErr> {
148148
debug_print!("{}", statement);
149149
let counter = self.execute_counter.fetch_add(1, Ordering::SeqCst);
@@ -154,7 +154,7 @@ impl MockDatabaseConnection {
154154
}
155155

156156
/// Return one [QueryResult] if the query was successful
157-
#[instrument(level = "trace")]
157+
#[instrument(level = "trace", skip(statement))]
158158
pub fn query_one(&self, statement: Statement) -> Result<Option<QueryResult>, DbErr> {
159159
debug_print!("{}", statement);
160160
let counter = self.query_counter.fetch_add(1, Ordering::SeqCst);
@@ -167,7 +167,7 @@ impl MockDatabaseConnection {
167167
}
168168

169169
/// Return all [QueryResult]s if the query was successful
170-
#[instrument(level = "trace")]
170+
#[instrument(level = "trace", skip(statement))]
171171
pub fn query_all(&self, statement: Statement) -> Result<Vec<QueryResult>, DbErr> {
172172
debug_print!("{}", statement);
173173
let counter = self.query_counter.fetch_add(1, Ordering::SeqCst);
@@ -178,7 +178,7 @@ impl MockDatabaseConnection {
178178
}
179179

180180
/// Return [QueryResult]s from a multi-query operation
181-
#[instrument(level = "trace")]
181+
#[instrument(level = "trace", skip(statement))]
182182
pub fn fetch(&self, statement: &Statement) -> PinBoxStream {
183183
#[cfg(not(feature = "sync"))]
184184
{

‎sea-orm-sync/src/driver/proxy.rs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -55,14 +55,14 @@ impl ProxyDatabaseConnection {
5555
}
5656

5757
/// Execute the SQL statement in the [ProxyDatabase]
58-
#[instrument(level = "trace")]
58+
#[instrument(level = "trace", skip(statement))]
5959
pub fn execute(&self, statement: Statement) -> Result<ExecResult, DbErr> {
6060
debug_print!("{}", statement);
6161
Ok(self.proxy.execute(statement)?.into())
6262
}
6363

6464
/// Return one [QueryResult] if the query was successful
65-
#[instrument(level = "trace")]
65+
#[instrument(level = "trace", skip(statement))]
6666
pub fn query_one(&self, statement: Statement) -> Result<Option<QueryResult>, DbErr> {
6767
debug_print!("{}", statement);
6868
let result = self.proxy.query(statement)?;
@@ -77,7 +77,7 @@ impl ProxyDatabaseConnection {
7777
}
7878

7979
/// Return all [QueryResult]s if the query was successful
80-
#[instrument(level = "trace")]
80+
#[instrument(level = "trace", skip(statement))]
8181
pub fn query_all(&self, statement: Statement) -> Result<Vec<QueryResult>, DbErr> {
8282
debug_print!("{}", statement);
8383
let result = self.proxy.query(statement)?;

‎sea-orm-sync/src/driver/rusqlite.rs‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -313,7 +313,7 @@ impl RusqliteSharedConnection {
313313
}
314314

315315
/// Execute a [Statement] on a SQLite backend
316-
#[instrument(level = "trace")]
316+
#[instrument(level = "trace", skip(stmt))]
317317
pub fn execute(&self, stmt: Statement) -> Result<ExecResult, DbErr> {
318318
debug!("{}", stmt);
319319

@@ -333,7 +333,7 @@ impl RusqliteSharedConnection {
333333
}
334334

335335
/// Execute an unprepared SQL statement on a SQLite backend
336-
#[instrument(level = "trace")]
336+
#[instrument(level = "trace", skip(sql))]
337337
pub fn execute_unprepared(&self, sql: &str) -> Result<ExecResult, DbErr> {
338338
debug!("{}", sql);
339339

@@ -350,7 +350,7 @@ impl RusqliteSharedConnection {
350350
}
351351

352352
/// Get one result from a SQL query. Returns [Option::None] if no match was found
353-
#[instrument(level = "trace")]
353+
#[instrument(level = "trace", skip(stmt))]
354354
pub fn query_one(&self, stmt: Statement) -> Result<Option<QueryResult>, DbErr> {
355355
debug!("{}", stmt);
356356

@@ -375,7 +375,7 @@ impl RusqliteSharedConnection {
375375
}
376376

377377
/// Get the results of a query returning them as a Vec<[QueryResult]>
378-
#[instrument(level = "trace")]
378+
#[instrument(level = "trace", skip(stmt))]
379379
pub fn query_all(&self, stmt: Statement) -> Result<Vec<QueryResult>, DbErr> {
380380
debug!("{}", stmt);
381381

@@ -400,7 +400,7 @@ impl RusqliteSharedConnection {
400400
}
401401

402402
/// Stream the results of executing a SQL query
403-
#[instrument(level = "trace")]
403+
#[instrument(level = "trace", skip(stmt))]
404404
pub fn stream(&self, stmt: Statement) -> Result<QueryStream, DbErr> {
405405
debug!("{}", stmt);
406406

@@ -481,7 +481,7 @@ impl RusqliteSharedConnection {
481481
}
482482

483483
impl RusqliteInnerConnection {
484-
#[instrument(level = "trace", skip(metric_callback))]
484+
#[instrument(level = "trace", skip(metric_callback, stmt))]
485485
pub fn execute(
486486
&self,
487487
stmt: Statement,
@@ -503,7 +503,7 @@ impl RusqliteInnerConnection {
503503
})
504504
}
505505

506-
#[instrument(level = "trace")]
506+
#[instrument(level = "trace", skip(sql))]
507507
pub(crate) fn execute_unprepared(&self, sql: &str) -> Result<ExecResult, DbErr> {
508508
debug!("{}", sql);
509509

@@ -518,7 +518,7 @@ impl RusqliteInnerConnection {
518518
}
519519
}
520520

521-
#[instrument(level = "trace", skip(metric_callback))]
521+
#[instrument(level = "trace", skip(metric_callback, stmt))]
522522
pub fn query_one(
523523
&self,
524524
stmt: Statement,
@@ -545,7 +545,7 @@ impl RusqliteInnerConnection {
545545
})
546546
}
547547

548-
#[instrument(level = "trace", skip(metric_callback))]
548+
#[instrument(level = "trace", skip(metric_callback, stmt))]
549549
pub fn query_all(
550550
&self,
551551
stmt: Statement,
@@ -572,7 +572,7 @@ impl RusqliteInnerConnection {
572572
})
573573
}
574574

575-
#[instrument(level = "trace")]
575+
#[instrument(level = "trace", skip(stmt))]
576576
pub(crate) fn stream(&self, stmt: &Statement) -> Result<Vec<QueryResult>, DbErr> {
577577
debug!("{}", stmt);
578578

‎sea-orm-sync/src/driver/sqlx_mysql.rs‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ impl SqlxMySqlConnector {
129129

130130
impl SqlxMySqlPoolConnection {
131131
/// Execute a [Statement] on a MySQL backend
132-
#[instrument(level = "trace")]
132+
#[instrument(level = "trace", skip(stmt))]
133133
pub fn execute(&self, stmt: Statement) -> Result<ExecResult, DbErr> {
134134
debug_print!("{}", stmt);
135135

@@ -144,7 +144,7 @@ impl SqlxMySqlPoolConnection {
144144
}
145145

146146
/// Execute an unprepared SQL statement on a MySQL backend
147-
#[instrument(level = "trace")]
147+
#[instrument(level = "trace", skip(sql))]
148148
pub fn execute_unprepared(&self, sql: &str) -> Result<ExecResult, DbErr> {
149149
debug_print!("{}", sql);
150150

@@ -156,7 +156,7 @@ impl SqlxMySqlPoolConnection {
156156
}
157157

158158
/// Get one result from a SQL query. Returns [Option::None] if no match was found
159-
#[instrument(level = "trace")]
159+
#[instrument(level = "trace", skip(stmt))]
160160
pub fn query_one(&self, stmt: Statement) -> Result<Option<QueryResult>, DbErr> {
161161
debug_print!("{}", stmt);
162162

@@ -174,7 +174,7 @@ impl SqlxMySqlPoolConnection {
174174
}
175175

176176
/// Get the results of a query returning them as a Vec<[QueryResult]>
177-
#[instrument(level = "trace")]
177+
#[instrument(level = "trace", skip(stmt))]
178178
pub fn query_all(&self, stmt: Statement) -> Result<Vec<QueryResult>, DbErr> {
179179
debug_print!("{}", stmt);
180180

@@ -189,7 +189,7 @@ impl SqlxMySqlPoolConnection {
189189
}
190190

191191
/// Stream the results of executing a SQL query
192-
#[instrument(level = "trace")]
192+
#[instrument(level = "trace", skip(stmt))]
193193
pub fn stream(&self, stmt: Statement) -> Result<QueryStream, DbErr> {
194194
debug_print!("{}", stmt);
195195

‎sea-orm-sync/src/driver/sqlx_postgres.rs‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@ impl SqlxPostgresConnector {
163163

164164
impl SqlxPostgresPoolConnection {
165165
/// Execute a [Statement] on a PostgreSQL backend
166-
#[instrument(level = "trace")]
166+
#[instrument(level = "trace", skip(stmt))]
167167
pub fn execute(&self, stmt: Statement) -> Result<ExecResult, DbErr> {
168168
debug_print!("{}", stmt);
169169

@@ -178,7 +178,7 @@ impl SqlxPostgresPoolConnection {
178178
}
179179

180180
/// Execute an unprepared SQL statement on a PostgreSQL backend
181-
#[instrument(level = "trace")]
181+
#[instrument(level = "trace", skip(sql))]
182182
pub fn execute_unprepared(&self, sql: &str) -> Result<ExecResult, DbErr> {
183183
debug_print!("{}", sql);
184184

@@ -190,7 +190,7 @@ impl SqlxPostgresPoolConnection {
190190
}
191191

192192
/// Get one result from a SQL query. Returns [Option::None] if no match was found
193-
#[instrument(level = "trace")]
193+
#[instrument(level = "trace", skip(stmt))]
194194
pub fn query_one(&self, stmt: Statement) -> Result<Option<QueryResult>, DbErr> {
195195
debug_print!("{}", stmt);
196196

@@ -208,7 +208,7 @@ impl SqlxPostgresPoolConnection {
208208
}
209209

210210
/// Get the results of a query returning them as a Vec<[QueryResult]>
211-
#[instrument(level = "trace")]
211+
#[instrument(level = "trace", skip(stmt))]
212212
pub fn query_all(&self, stmt: Statement) -> Result<Vec<QueryResult>, DbErr> {
213213
debug_print!("{}", stmt);
214214

@@ -223,7 +223,7 @@ impl SqlxPostgresPoolConnection {
223223
}
224224

225225
/// Stream the results of executing a SQL query
226-
#[instrument(level = "trace")]
226+
#[instrument(level = "trace", skip(stmt))]
227227
pub fn stream(&self, stmt: Statement) -> Result<QueryStream, DbErr> {
228228
debug_print!("{}", stmt);
229229

0 commit comments

Comments
 (0)