Switching to diesel-async broke use of the connection parameter `?unix_socket=`

[kyz]

Commit 192d64c switched to using diesel-async.

The code establishing MySQL connections switched from MysqlConnection::establish to AsyncMysqlConnection::establish

MysqlConnection::establish supports connection strings in the form mysql://[user[:password]@]host/database_name[?unix_socket=socket-path&ssl_mode=SSL_MODE*&ssl_ca=/etc/ssl/certs/ca-certificates.crt&ssl_cert=/etc/ssl/certs/client-cert.crt&ssl_key=/etc/ssl/certs/client-key.crt]

AsyncMysqlConnection::establish only supports connection strings in the form mysql://[user[:password]@]host/database_name

My connection string looks like syncstorage.database_url = "mysql://syncstorage:PASSWORD@localhost/syncstorage_rs?unix_socket=/run/mysqld/mysqld.sock" -- I use the unix_socket connection because it's more reliable and faster than using TCP connections

syncserver immediately fails with an error:

thread 'main' panicked at syncserver/src/main.rs:63:55:
called `Result::unwrap()` on an `Err` value: ApiError { kind: Db(DbError { kind: Mysql(SqlError { kind: DieselConnection(InvalidConnectionUrl("Unknown connection URL parameter `unix_socket'")), status: 500, backtrace:    0: <syncserver_db_common::error::SqlError as core::convert::From<syncserver_db_common::error::SqlErrorKind>>::from
             at /home/pkgbuild/syncserver/syncstorage-rs/syncserver-db-common/src/error.rs:34:24
   1: <T as core::convert::Into<U>>::into
             at /rustc/1159e78c4747b02ef996e55082b704c09b970588/library/core/src/convert/mod.rs:784:9
   2: <syncserver_db_common::error::SqlError as core::convert::From<diesel::result::ConnectionError>>::from
             at /home/pkgbuild/syncserver/syncstorage-rs/syncserver-common/src/lib.rs:50:33
   3: <syncstorage_mysql::error::DbError as core::convert::From<diesel::result::ConnectionError>>::from::{{closure}}
             at /home/pkgbuild/syncserver/syncstorage-rs/syncstorage-mysql/src/error.rs:160:79
   4: <syncstorage_mysql::error::DbError as core::convert::From<diesel::result::ConnectionError>>::from
             at /home/pkgbuild/syncserver/syncstorage-rs/syncserver-common/src/lib.rs:50:17
   5: <core::result::Result<T,F> as core::ops::try_trait::FromResidual<core::result::Result<core::convert::Infallible,E>>>::from_residual
             at /rustc/1159e78c4747b02ef996e55082b704c09b970588/library/core/src/result.rs:2087:27
   6: syncstorage_mysql::pool::run_embedded_migrations
             at /home/pkgbuild/syncserver/syncstorage-rs/syncstorage-mysql/src/pool.rs:46:16
   7: <syncstorage_mysql::pool::MysqlDbPool as syncstorage_db_common::DbPool>::init::{{closure}}::{{closure}}
             at /home/pkgbuild/syncserver/syncstorage-rs/syncstorage-mysql/src/pool.rs:163:32

My only workaround is to remove ?unix_socket=/run/mysqld/mysqld.sock from my connection strings. syncserver works fine then, albeit with slower DB performance.

┆Issue is synchronized with this Jira Task

[felfert]

Reading the docs of the mysql_async crate at https://docs.rs/mysql_async/latest/mysql_async/struct.Opts.html#method.socket shows they DO support it, but the keyword is socket instead of unix_socket

Tried just that and it works.
WHY they chose to use a different keyword compared to the sync variant is beyond my understanding :-)

Cheers
-Fritz

[kyz]

Thanks! I can confirm that works around the breakage.

From 192d64c onwards, one has to use ?socket=/run/mysqld/mysqld.sock instead of ?unix_socket=/run/mysqld/mysqld.sock for local MySQL DB connection strings

[kyz]

A comparison of the URL parameters supported for anyone migrating:

diesel	diesel-async
unix_socket=/path/to/mysqld.sock	socket=/path/to/mysqld.sock
ssl_mode=DISABLED	not possible
ssl_mode=PREFERRED (default)	verify_ca=false&verify_identity=false
ssl_mode=REQUIRED	require_ssl=true&verify_ca=false&verify_identity=false
ssl_mode=VERIFY_CA	require_ssl=true&verify_identity=false
ssl_mode=VERIFY_IDENTITY	require_ssl=true
ssl_ca=/path/to/ca-certificates.crt	"there is no way to give an idenity or root certs via query URL"
ssl_cert=/path/to/client-cert.crt	"there is no way to give an idenity or root certs via query URL"
ssl_key=/path/to//client-cert.key	"there is no way to give an idenity or root certs via query URL"

[clouserw]

Thanks for filing this issue. If I'm reading it correctly there is no engineering work to do for syncserver-rs so I'm going to close this. Please let me know if I'm mis-reading it.