Merge remote-tracking branch 'origin/main' into patch-3

Author: weiznich

.github/workflows/ci.yml

@@ -4,6 +4,8 @@ on:
   push:
     branches:
       - main
+      - 0.3.x
+      - 0.4.x
       - 0.2.x
 
 name: CI Tests
@@ -41,9 +43,19 @@ jobs:
 
       - name: Set environment variables
         shell: bash
-        if: matrix.rust == 'nightly'
+        if: matrix.backend == 'postgres' && matrix.os == 'windows-2019'
         run: |
-          echo "RUSTFLAGS=--cap-lints=warn" >> $GITHUB_ENV
+          echo "AWS_LC_SYS_NO_ASM=1"
+
+      - name: Set environment variables
+        shell: bash
+        if: matrix.rust != 'nightly'
+        run: |
+          echo "RUSTFLAGS=-D warnings" >> $GITHUB_ENV
+          echo "RUSTDOCFLAGS=-D warnings" >> $GITHUB_ENV
+
+      - uses: ilammy/setup-nasm@v1
+        if: matrix.backend == 'postgres' && matrix.os == 'windows-2019'
 
       - name: Install postgres (Linux)
         if: runner.os == 'Linux' && matrix.backend == 'postgres'
@@ -137,13 +149,13 @@ jobs:
       - name: Install mysql (MacOS M1)
         if: matrix.os == 'macos-14' && matrix.backend == 'mysql'
         run: |
-          brew install mariadb@11.3
-          ls /opt/homebrew/opt/mariadb@11.3
-          /opt/homebrew/opt/mariadb@11.3/bin/mysql_install_db
-          /opt/homebrew/opt/mariadb@11.3/bin/mysql.server start
+          brew install mariadb@11.2
+          ls /opt/homebrew/opt/mariadb@11.2
+          /opt/homebrew/opt/mariadb@11.2/bin/mysql_install_db
+          /opt/homebrew/opt/mariadb@11.2/bin/mysql.server start
           sleep 3
-          /opt/homebrew/opt/mariadb@11.3/bin/mysqladmin -u runner password diesel
-          /opt/homebrew/opt/mariadb@11.3/bin/mysql -e "create database diesel_test; create database diesel_unit_test; grant all on \`diesel_%\`.* to 'runner'@'localhost';" -urunner
+          /opt/homebrew/opt/mariadb@11.2/bin/mysqladmin -u runner password diesel
+          /opt/homebrew/opt/mariadb@11.2/bin/mysql -e "create database diesel_test; create database diesel_unit_test; grant all on \`diesel_%\`.* to 'runner'@'localhost';" -urunner
           echo "DATABASE_URL=mysql://runner:diesel@localhost/diesel_test" >> $GITHUB_ENV
 
       - name: Install postgres (Windows)
@@ -223,7 +235,7 @@ jobs:
           find ~/.cargo/registry -iname "*clippy.toml" -delete
 
       - name: Run clippy
-        run: cargo +stable clippy --all
+        run: cargo +stable clippy --all --all-features
 
       - name: Check formating
         run: cargo +stable fmt --all -- --check

CHANGELOG.md

@@ -7,8 +7,11 @@ for Rust libraries in [RFC #1105](https://github.com/rust-lang/rfcs/blob/master/
 ## [Unreleased]
 
 * Added type `diesel_async::pooled_connection::mobc::PooledConnection`
-* MySQL/MariaDB now use `CLIENT_FOUND_ROWS` capability to allow consistent behavior with PostgreSQL regarding return value of UPDATe commands.
+* MySQL/MariaDB now use `CLIENT_FOUND_ROWS` capability to allow consistent behaviour with PostgreSQL regarding return value of UPDATe commands.
 * The minimal supported rust version is now 1.78.0
+* Add a `SyncConnectionWrapper` type that turns a sync connection into an async one. This enables SQLite support for diesel-async
+* Add support for `diesel::connection::Instrumentation` to support logging and other instrumentation for any of the provided connection impls.
+* Bump minimal supported mysql_async version to 0.34
 
 ## [0.4.1] - 2023-09-01
 

Cargo.toml

@@ -27,17 +27,13 @@ futures-util = { version = "0.3.17", default-features = false, features = [
 ] }
 tokio-postgres = { version = "0.7.10", optional = true }
 tokio = { version = "1.26", optional = true }
-mysql_async = { version = ">=0.30.0,<0.34", optional = true, default-features = false, features = [
-        "minimal",
-        "derive",
-] }
-mysql_common = { version = ">=0.29.0,<0.32.0", optional = true, default-features = false, features = [
-        "frunk",
-        "derive",
+mysql_async = { version = "0.34", optional = true, default-features = false, features = [
+        "minimal-rust",
 ] }
+mysql_common = { version = "0.32", optional = true, default-features = false }
 
 bb8 = { version = "0.8", optional = true }
-deadpool = { version = "0.11", optional = true, default-features = false, features = [
+deadpool = { version = "0.12", optional = true, default-features = false, features = [
         "managed",
 ] }
 mobc = { version = ">=0.7,<0.10", optional = true }
@@ -49,9 +45,10 @@ cfg-if = "1"
 chrono = "0.4"
 diesel = { version = "2.2.0", default-features = false, features = ["chrono"] }
 diesel_migrations = "2.2.0"
+assert_matches = "1.0.1"
 
 [features]
-default = []
+default = ["sync-connection-wrapper"]
 mysql = [
         "diesel/mysql_backend",
         "mysql_async",
@@ -83,8 +80,8 @@ features = [
         "r2d2",
 ]
 no-default-features = true
-rustc-args = ["--cfg", "doc_cfg"]
-rustdoc-args = ["--cfg", "doc_cfg"]
+rustc-args = ["--cfg", "docsrs"]
+rustdoc-args = ["--cfg", "docsrs"]
 
 [workspace]
 members = [
@@ -93,4 +90,3 @@ members = [
         "examples/postgres/run-pending-migrations-with-rustls",
         "examples/sync-wrapper",
 ]
-

README.md

@@ -168,6 +168,11 @@ let mut conn = pool.get().await?;
 let res = users::table.select(User::as_select()).load::(&mut conn).await?;
 ```
 
+## Diesel-Async with Secure Database
+
+In the event of using this crate with a `sslmode=require` flag, it will be necessary to build a TLS cert.
+There is an example provided for doing this using the `rustls` crate in the `postgres` examples folder.
+
 ## Crate Feature Flags
 
 Diesel-async offers several configurable features:

examples/postgres/pooled-with-rustls/Cargo.toml

@@ -6,11 +6,11 @@ edition = "2021"
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
-diesel = { version = "2.1.0", default-features = false, features = ["postgres"] }
+diesel = { version = "2.2.0", default-features = false, features = ["postgres"] }
 diesel-async = { version = "0.4.0", path = "../../../", features = ["bb8", "postgres"] }
 futures-util = "0.3.21"
-rustls = "0.20.8"
-rustls-native-certs = "0.6.2"
+rustls = "0.23.8"
+rustls-native-certs = "0.7.1"
 tokio = { version = "1.2.0", default-features = false, features = ["macros", "rt-multi-thread"] }
 tokio-postgres = "0.7.7"
-tokio-postgres-rustls = "0.9.0"
+tokio-postgres-rustls = "0.12.0"

examples/postgres/pooled-with-rustls/src/main.rs

@@ -43,7 +43,6 @@ fn establish_connection(config: &str) -> BoxFuture<ConnectionResult<AsyncPgConne
     let fut = async {
         // We first set up the way we want rustls to work.
         let rustls_config = rustls::ClientConfig::builder()
-            .with_safe_defaults()
             .with_root_certificates(root_certs())
             .with_no_client_auth();
         let tls = tokio_postgres_rustls::MakeRustlsConnect::new(rustls_config);
@@ -63,7 +62,6 @@ fn establish_connection(config: &str) -> BoxFuture<ConnectionResult<AsyncPgConne
 fn root_certs() -> rustls::RootCertStore {
     let mut roots = rustls::RootCertStore::empty();
     let certs = rustls_native_certs::load_native_certs().expect("Certs not loadable!");
-    let certs: Vec<_> = certs.into_iter().map(|cert| cert.0).collect();
-    roots.add_parsable_certificates(&certs);
+    roots.add_parsable_certificates(certs);
     roots
 }

examples/postgres/run-pending-migrations-with-rustls/Cargo.toml

@@ -6,12 +6,12 @@ edition = "2021"
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
-diesel = { version = "2.1.0", default-features = false, features = ["postgres"] }
+diesel = { version = "2.2.0", default-features = false, features = ["postgres"] }
 diesel-async = { version = "0.4.0", path = "../../../", features = ["bb8", "postgres", "async-connection-wrapper"] }
-diesel_migrations = "2.1.0"
+diesel_migrations = "2.2.0"
 futures-util = "0.3.21"
-rustls = "0.20.8"
-rustls-native-certs = "0.6.2"
+rustls = "0.23.10"
+rustls-native-certs = "0.7.1"
 tokio = { version = "1.2.0", default-features = false, features = ["macros", "rt-multi-thread"] }
 tokio-postgres = "0.7.7"
-tokio-postgres-rustls = "0.9.0"
+tokio-postgres-rustls = "0.12.0"

examples/postgres/run-pending-migrations-with-rustls/src/main.rs

@@ -29,7 +29,6 @@ fn establish_connection(config: &str) -> BoxFuture<ConnectionResult<AsyncPgConne
     let fut = async {
         // We first set up the way we want rustls to work.
         let rustls_config = rustls::ClientConfig::builder()
-            .with_safe_defaults()
             .with_root_certificates(root_certs())
             .with_no_client_auth();
         let tls = tokio_postgres_rustls::MakeRustlsConnect::new(rustls_config);
@@ -49,7 +48,6 @@ fn establish_connection(config: &str) -> BoxFuture<ConnectionResult<AsyncPgConne
 fn root_certs() -> rustls::RootCertStore {
     let mut roots = rustls::RootCertStore::empty();
     let certs = rustls_native_certs::load_native_certs().expect("Certs not loadable!");
-    let certs: Vec<_> = certs.into_iter().map(|cert| cert.0).collect();
-    roots.add_parsable_certificates(&certs);
+    roots.add_parsable_certificates(certs);
     roots
 }

examples/sync-wrapper/Cargo.toml

@@ -6,7 +6,7 @@ edition = "2021"
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
-diesel = { version = "2.1.0", default-features = false }
+diesel = { version = "2.1.0", default-features = false, features = ["returning_clauses_for_sqlite_3_35"] }
 diesel-async = { version = "0.4.0", path = "../../", features = ["sync-connection-wrapper", "async-connection-wrapper"] }
 diesel_migrations = "2.1.0"
 futures-util = "0.3.21"

examples/sync-wrapper/src/main.rs

@@ -2,7 +2,7 @@ use diesel::prelude::*;
 use diesel::sqlite::{Sqlite, SqliteConnection};
 use diesel_async::async_connection_wrapper::AsyncConnectionWrapper;
 use diesel_async::sync_connection_wrapper::SyncConnectionWrapper;
-use diesel_async::{AsyncConnection, RunQueryDsl, SimpleAsyncConnection};
+use diesel_async::{AsyncConnection, RunQueryDsl};
 use diesel_migrations::{embed_migrations, EmbeddedMigrations, MigrationHarness};
 
 // ordinary diesel model setup
@@ -15,7 +15,7 @@ table! {
 }
 
 #[allow(dead_code)]
-#[derive(Debug, Queryable, Selectable)]
+#[derive(Debug, Queryable, QueryableByName, Selectable)]
 #[diesel(table_name = users)]
 struct User {
     id: i32,
@@ -47,6 +47,27 @@ where
     .map_err(|e| Box::new(e) as Box<dyn std::error::Error>)
 }
 
+async fn transaction(
+    async_conn: &mut SyncConnectionWrapper<InnerConnection>,
+    old_name: &str,
+    new_name: &str,
+) -> Result<Vec<User>, diesel::result::Error> {
+    async_conn
+        .transaction::<Vec<User>, diesel::result::Error, _>(|c| {
+            Box::pin(async {
+                if old_name.is_empty() {
+                    Ok(Vec::new())
+                } else {
+                    diesel::update(users::table.filter(users::name.eq(old_name)))
+                        .set(users::name.eq(new_name))
+                        .load(c)
+                        .await
+                }
+            })
+        })
+        .await
+}
+
 #[tokio::main]
 async fn main() -> Result<(), Box<dyn std::error::Error>> {
     let db_url = std::env::var("DATABASE_URL").expect("Env var `DATABASE_URL` not set");
@@ -57,10 +78,13 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
 
     let mut sync_wrapper: SyncConnectionWrapper<InnerConnection> = establish(&db_url).await?;
 
-    sync_wrapper.batch_execute("DELETE FROM users").await?;
+    diesel::delete(users::table)
+        .execute(&mut sync_wrapper)
+        .await?;
 
-    sync_wrapper
-        .batch_execute("INSERT INTO users(id, name) VALUES (3, 'toto')")
+    diesel::insert_into(users::table)
+        .values((users::id.eq(3), users::name.eq("toto")))
+        .execute(&mut sync_wrapper)
         .await?;
 
     let data: Vec<User> = users::table
@@ -86,5 +110,28 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
         .await?;
     println!("{data:?}");
 
+    // a quick test to check if we correctly handle transactions
+    let mut conn_a: SyncConnectionWrapper<InnerConnection> = establish(&db_url).await?;
+    let mut conn_b: SyncConnectionWrapper<InnerConnection> = establish(&db_url).await?;
+
+    let handle_1 = tokio::spawn(async move {
+        loop {
+            let changed = transaction(&mut conn_a, "iLuke", "JustLuke").await;
+            println!("Changed {changed:?}");
+            std::thread::sleep(std::time::Duration::from_secs(1));
+        }
+    });
+
+    let handle_2 = tokio::spawn(async move {
+        loop {
+            let changed = transaction(&mut conn_b, "JustLuke", "iLuke").await;
+            println!("Changed {changed:?}");
+            std::thread::sleep(std::time::Duration::from_secs(1));
+        }
+    });
+
+    let _ = handle_2.await;
+    let _ = handle_1.await;
+
     Ok(())
 }

src/async_connection_wrapper.rs

@@ -107,7 +107,6 @@ mod implementation {
     pub struct AsyncConnectionWrapper<C, B> {
         inner: C,
         runtime: B,
-        instrumentation: Option<Box<dyn Instrumentation>>,
     }
 
     impl<C, B> From<C> for AsyncConnectionWrapper<C, B>
@@ -119,7 +118,6 @@ mod implementation {
             Self {
                 inner,
                 runtime: B::get_runtime(),
-                instrumentation: None,
             }
         }
     }
@@ -150,11 +148,7 @@ mod implementation {
             let runtime = B::get_runtime();
             let f = C::establish(database_url);
             let inner = runtime.block_on(f)?;
-            Ok(Self {
-                inner,
-                runtime,
-                instrumentation: None,
-            })
+            Ok(Self { inner, runtime })
         }
 
         fn execute_returning_count<T>(&mut self, source: &T) -> diesel::QueryResult<usize>
@@ -165,18 +159,18 @@ mod implementation {
             self.runtime.block_on(f)
         }
 
-    fn transaction_state(
-        &mut self,
+        fn transaction_state(
+            &mut self,
         ) -> &mut <Self::TransactionManager as diesel::connection::TransactionManager<Self>>::TransactionStateData{
             self.inner.transaction_state()
         }
 
         fn instrumentation(&mut self) -> &mut dyn Instrumentation {
-            &mut self.instrumentation
+            self.inner.instrumentation()
         }
 
         fn set_instrumentation(&mut self, instrumentation: impl Instrumentation) {
-            self.instrumentation = Some(Box::new(instrumentation));
+            self.inner.set_instrumentation(instrumentation);
         }
     }
 

src/lib.rs

@@ -1,4 +1,4 @@
-#![cfg_attr(doc_cfg, feature(doc_cfg, doc_auto_cfg))]
+#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
 //! Diesel-async provides async variants of diesel related query functionality
 //!
 //! diesel-async is an extension to diesel itself. It is designed to be used together
@@ -69,6 +69,7 @@
 #![warn(missing_docs)]
 
 use diesel::backend::Backend;
+use diesel::connection::Instrumentation;
 use diesel::query_builder::{AsQuery, QueryFragment, QueryId};
 use diesel::result::Error;
 use diesel::row::Row;
@@ -347,4 +348,10 @@ pub trait AsyncConnection: SimpleAsyncConnection + Sized + Send {
     fn _silence_lint_on_execute_future(_: Self::ExecuteFuture<'_, '_>) {}
     #[doc(hidden)]
     fn _silence_lint_on_load_future(_: Self::LoadFuture<'_, '_>) {}
+
+    #[doc(hidden)]
+    fn instrumentation(&mut self) -> &mut dyn Instrumentation;
+
+    /// Set a specific [`Instrumentation`] implementation for this connection
+    fn set_instrumentation(&mut self, instrumentation: impl Instrumentation);
 }