tank_postgres/
connection.rs

1use crate::{
2    PostgresDriver, PostgresPrepared, PostgresTransaction, ValueWrap,
3    util::{
4        postgres_type_to_value, stream_postgres_row_to_tank_row,
5        stream_postgres_simple_query_message_to_tank_query_result, value_to_postgres_type,
6    },
7};
8use async_stream::try_stream;
9use openssl::ssl::{SslConnector, SslFiletype, SslMethod, SslVerifyMode};
10use postgres_openssl::MakeTlsConnector;
11use postgres_types::ToSql;
12use std::{
13    borrow::Cow,
14    env, mem,
15    path::PathBuf,
16    pin::{Pin, pin},
17    str::FromStr,
18};
19use tank_core::{
20    AsQuery, Connection, Driver, DynQuery, Entity, Error, ErrorContext, Executor, Query,
21    QueryResult, RawQuery, Result, RowsAffected, Transaction,
22    future::Either,
23    stream::{Stream, StreamExt, TryStreamExt},
24    truncate_long,
25};
26use tokio::{spawn, task::JoinHandle};
27use tokio_postgres::{NoTls, binary_copy::BinaryCopyInWriter};
28
29/// PostgreSQL connection.
30#[derive(Debug)]
31pub struct PostgresConnection {
32    pub(crate) client: tokio_postgres::Client,
33    pub(crate) handle: JoinHandle<()>,
34    pub(crate) _transaction: bool,
35}
36
37impl Executor for PostgresConnection {
38    type Driver = PostgresDriver;
39
40    async fn do_prepare(&mut self, sql: String) -> Result<Query<Self::Driver>> {
41        let sql = sql.as_str().trim_end().trim_end_matches(';');
42        Ok(
43            PostgresPrepared::new(self.client.prepare(&sql).await.map_err(|e| {
44                let error = Error::new(e).context(format!(
45                    "While preparing the query:\n{}",
46                    truncate_long!(sql)
47                ));
48                log::error!("{:#}", error);
49                error
50            })?)
51            .into(),
52        )
53    }
54
55    fn run<'s>(
56        &'s mut self,
57        query: impl AsQuery<Self::Driver> + 's,
58    ) -> impl Stream<Item = Result<QueryResult>> + Send {
59        let mut query = query.as_query();
60        let context = format!("While running the query:\n{}", query.as_mut());
61        let mut owned = mem::take(query.as_mut());
62        match owned {
63            Query::Raw(raw) => Either::Left(try_stream! {
64                let sql = &raw.0;
65                {
66                    let stream = stream_postgres_simple_query_message_to_tank_query_result(
67                        async move || self.client.simple_query_raw(sql).await.map_err(Into::into),
68                    );
69                    let mut stream = pin!(stream);
70                    while let Some(value) = stream.next().await.transpose()? {
71                        yield value;
72                    }
73                }
74                *query.as_mut() = Query::Raw(raw);
75            }),
76            Query::Prepared(..) => Either::Right(try_stream! {
77                let mut transaction = self.begin().await?;
78                {
79                    let mut stream = pin!(transaction.run(&mut owned));
80                    while let Some(value) = stream.next().await.transpose()? {
81                        yield value;
82                    }
83                }
84                transaction.commit().await?;
85                *query.as_mut() = mem::take(&mut owned);
86            }),
87        }
88        .map_err(move |e: Error| {
89            let error = e.context(context.clone());
90            log::error!("{:#}", error);
91            error
92        })
93    }
94
95    fn fetch<'s>(
96        &'s mut self,
97        query: impl AsQuery<Self::Driver> + 's,
98    ) -> impl Stream<Item = Result<tank_core::RowLabeled>> + Send {
99        let mut query = query.as_query();
100        let context = format!("While fetching the query:\n{}", query.as_mut());
101        let owned = mem::take(query.as_mut());
102        stream_postgres_row_to_tank_row(async move || {
103            let row_stream = match owned {
104                Query::Raw(RawQuery(sql)) => {
105                    let stream = self
106                        .client
107                        .query_raw(&sql, Vec::<ValueWrap>::new())
108                        .await
109                        .map_err(|e| Error::new(e).context(context.clone()))?;
110                    *query.as_mut() = Query::raw(sql);
111                    stream
112                }
113                Query::Prepared(mut prepared) => {
114                    let mut params = prepared.take_params();
115                    let types = prepared.statement.params();
116
117                    for (i, param) in params.iter_mut().enumerate() {
118                        *param = ValueWrap(Cow::Owned(
119                            mem::take(param)
120                                .take_value()
121                                .try_as(&postgres_type_to_value(&types[i]))?,
122                        ));
123                    }
124                    let stream = self
125                        .client
126                        .query_raw(&prepared.statement, params)
127                        .await
128                        .map_err(|e| Error::new(e).context(context.clone()))?;
129                    *query.as_mut() = Query::Prepared(prepared);
130                    stream
131                }
132            };
133            Ok(row_stream).map_err(|e| {
134                log::error!("{:#}", e);
135                e
136            })
137        })
138    }
139
140    async fn append<'a, E, It>(&mut self, entities: It) -> Result<RowsAffected>
141    where
142        E: Entity + 'a,
143        It: IntoIterator<Item = &'a E> + Send,
144        <It as IntoIterator>::IntoIter: Send,
145    {
146        let context = || format!("While appending to the table `{}`", E::table().full_name());
147        let mut result = RowsAffected {
148            rows_affected: Some(0),
149            last_affected_id: None,
150        };
151        let writer = self.driver().sql_writer();
152        let mut query = DynQuery::default();
153        writer.write_copy::<E>(&mut query);
154        let sink = self
155            .client
156            .copy_in(&query.as_str() as &str)
157            .await
158            .with_context(context)?;
159        let types: Vec<_> = E::columns()
160            .into_iter()
161            .map(|c| value_to_postgres_type(&c.value))
162            .collect();
163        let writer = BinaryCopyInWriter::new(sink, &types);
164        let mut writer = pin!(writer);
165        let columns_len = E::columns().len();
166        let mut values = Vec::<ValueWrap>::with_capacity(columns_len);
167        let mut refs = Vec::<&(dyn ToSql + Sync)>::with_capacity(columns_len);
168        for entity in entities.into_iter() {
169            values.extend(
170                entity
171                    .row_full()
172                    .into_iter()
173                    .map(|v| ValueWrap(Cow::Owned(v))),
174            );
175            refs.extend(
176                values
177                    .iter()
178                    .map(|v| unsafe { &*(v as &(dyn ToSql + Sync) as *const _) }),
179            );
180            Pin::as_mut(&mut writer)
181                .write(&refs)
182                .await
183                .with_context(context)?;
184            refs.clear();
185            values.clear();
186            *result.rows_affected.as_mut().unwrap() += 1;
187        }
188        writer.finish().await.with_context(context)?;
189        Ok(result)
190    }
191}
192
193impl Connection for PostgresConnection {
194    async fn connect(url: Cow<'static, str>) -> Result<PostgresConnection> {
195        let context = format!("While trying to connect to `{}`", truncate_long!(url));
196        let mut url = Self::sanitize_url(url)?;
197        let mut take_url_param = |key: &str, env_var: &str, remove: bool| {
198            let value = url
199                .query_pairs()
200                .find_map(|(k, v)| if k == key { Some(v) } else { None })
201                .map(|v| v.to_string());
202            if remove && let Some(..) = value {
203                let mut result = url.clone();
204                result.set_query(None);
205                result
206                    .query_pairs_mut()
207                    .extend_pairs(url.query_pairs().filter(|(k, _)| k != key));
208                url = result;
209            };
210            value.or_else(|| env::var(env_var).ok().map(Into::into))
211        };
212        let sslmode = take_url_param("sslmode", "PGSSLMODE", false).unwrap_or("disable".into());
213        let (client, handle) = if sslmode == "disable" {
214            let (client, connection) = tokio_postgres::connect(url.as_str(), NoTls).await?;
215            let handle = spawn(async move {
216                if let Err(error) = connection.await
217                    && !error.is_closed()
218                {
219                    log::error!("Postgres connection error: {:#?}", error);
220                }
221            });
222            (client, handle)
223        } else {
224            let mut builder = SslConnector::builder(SslMethod::tls())?;
225            let path = PathBuf::from_str(
226                take_url_param("sslrootcert", "PGSSLROOTCERT", true)
227                    .as_deref()
228                    .unwrap_or("~/.postgresql/root.crt"),
229            )
230            .with_context(|| context.clone())?;
231            if path.exists() {
232                builder.set_ca_file(path)?;
233            }
234            let path = PathBuf::from_str(
235                take_url_param("sslcert", "PGSSLCERT", true)
236                    .as_deref()
237                    .unwrap_or("~/.postgresql/postgresql.crt"),
238            )
239            .with_context(|| context.clone())?;
240            if path.exists() {
241                builder.set_certificate_chain_file(path)?;
242            }
243            let path = PathBuf::from_str(
244                take_url_param("sslkey", "PGSSLKEY", true)
245                    .as_deref()
246                    .unwrap_or("~/.postgresql/postgresql.key"),
247            )
248            .with_context(|| context.clone())?;
249            if path.exists() {
250                builder.set_private_key_file(path, SslFiletype::PEM)?;
251            }
252            builder.set_verify(SslVerifyMode::PEER);
253            let connector = MakeTlsConnector::new(builder.build());
254            let (client, connection) = tokio_postgres::connect(url.as_str(), connector).await?;
255            let handle = spawn(async move {
256                if let Err(error) = connection.await
257                    && !error.is_closed()
258                {
259                    log::error!("Postgres connection error: {:#?}", error);
260                }
261            });
262            (client, handle)
263        };
264        Ok(Self {
265            client,
266            handle,
267            _transaction: false,
268        })
269    }
270
271    fn begin(&mut self) -> impl Future<Output = Result<PostgresTransaction<'_>>> {
272        PostgresTransaction::new(self)
273    }
274
275    async fn disconnect(self) -> Result<()> {
276        drop(self.client);
277        if let Err(e) = self.handle.await {
278            let error = Error::new(e).context("While disconnecting from Postgres");
279            log::error!("{:#}", error);
280            return Err(error);
281        }
282        Ok(())
283    }
284}
tank_postgres/connection.rs

tank_postgres/
connection.rs
