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, SqlWriter, 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}
35
36impl Executor for PostgresConnection {
37    type Driver = PostgresDriver;
38
39    async fn do_prepare(&mut self, sql: String) -> Result<Query<PostgresDriver>> {
40        let sql = sql.as_str().trim_end().trim_end_matches(';');
41        Ok(
42            PostgresPrepared::new(self.client.prepare(&sql).await.map_err(|e| {
43                let error = Error::new(e).context(format!(
44                    "While preparing the query:\n{}",
45                    truncate_long!(sql)
46                ));
47                log::error!("{:#}", error);
48                error
49            })?)
50            .into(),
51        )
52    }
53
54    fn run<'s>(
55        &'s mut self,
56        query: impl AsQuery<PostgresDriver> + 's,
57    ) -> impl Stream<Item = Result<QueryResult>> + Send {
58        let mut query = query.as_query();
59        let context = format!("While running the query:\n{}", query.as_mut());
60        let mut owned = mem::take(query.as_mut());
61        match owned {
62            Query::Raw(raw) => Either::Left(try_stream! {
63                let sql = &raw.0;
64                {
65                    let stream = stream_postgres_simple_query_message_to_tank_query_result(
66                        async move || self.client.simple_query_raw(sql).await.map_err(Into::into),
67                    );
68                    let mut stream = pin!(stream);
69                    while let Some(value) = stream.next().await.transpose()? {
70                        yield value;
71                    }
72                }
73                *query.as_mut() = Query::Raw(raw);
74            }),
75            Query::Prepared(..) => Either::Right(try_stream! {
76                let mut transaction = self.begin().await?;
77                {
78                    let mut stream = pin!(transaction.run(&mut owned));
79                    while let Some(value) = stream.next().await.transpose()? {
80                        yield value;
81                    }
82                }
83                transaction.commit().await?;
84                *query.as_mut() = mem::take(&mut owned);
85            }),
86        }
87        .map_err(move |e: Error| {
88            let error = e.context(context.clone());
89            log::error!("{:#}", error);
90            error
91        })
92    }
93
94    fn fetch<'s>(
95        &'s mut self,
96        query: impl AsQuery<PostgresDriver> + 's,
97    ) -> impl Stream<Item = Result<tank_core::Row>> + Send {
98        let mut query = query.as_query();
99        let context = format!("While fetching the query:\n{}", query.as_mut());
100        let owned = mem::take(query.as_mut());
101        stream_postgres_row_to_tank_row(async move || {
102            let row_stream = match owned {
103                Query::Raw(RawQuery(sql)) => {
104                    let stream = self
105                        .client
106                        .query_raw(&sql, Vec::<ValueWrap>::new())
107                        .await
108                        .map_err(|e| Error::new(e).context(context.clone()))?;
109                    *query.as_mut() = Query::raw(sql);
110                    stream
111                }
112                Query::Prepared(mut prepared) => {
113                    let mut params = prepared.take_params();
114                    let types = prepared.statement.params();
115
116                    for (i, param) in params.iter_mut().enumerate() {
117                        *param = ValueWrap(Cow::Owned(
118                            mem::take(param)
119                                .0
120                                .into_owned()
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 writer = self.driver().sql_writer();
147        let context = || {
148            format!(
149                "While appending to the table `{}`",
150                E::table().full_name(writer.separator())
151            )
152        };
153        let mut query = DynQuery::default();
154        writer.write_copy::<E>(&mut query);
155        let sink = match self
156            .client
157            .copy_in(&query.as_str() as &str)
158            .await
159            .with_context(context)
160        {
161            Ok(v) => v,
162            Err(e) => {
163                log::error!("{e:#}");
164                return Err(e);
165            }
166        };
167        let types: Vec<_> = E::columns()
168            .into_iter()
169            .map(|c| value_to_postgres_type(&c.value))
170            .collect();
171        let writer = BinaryCopyInWriter::new(sink, &types);
172        let mut writer = pin!(writer);
173        let columns_len = E::columns().len();
174        let mut values = Vec::<ValueWrap>::with_capacity(columns_len);
175        let mut refs = Vec::<&(dyn ToSql + Sync)>::with_capacity(columns_len);
176        for entity in entities.into_iter() {
177            values.extend(
178                entity
179                    .row_values()
180                    .into_iter()
181                    .map(|v| ValueWrap(Cow::Owned(v))),
182            );
183            refs.extend(
184                values
185                    .iter()
186                    .map(|v| unsafe { &*(v as &(dyn ToSql + Sync) as *const _) }),
187            );
188            match Pin::as_mut(&mut writer)
189                .write(&refs)
190                .await
191                .with_context(context)
192            {
193                Ok(_) => {}
194                Err(e) => {
195                    log::error!("{e:#}");
196                    return Err(e);
197                }
198            };
199            refs.clear();
200            values.clear();
201        }
202        match writer.finish().await.with_context(context) {
203            Ok(v) => Ok(RowsAffected {
204                rows_affected: Some(v),
205                last_affected_id: None,
206            }),
207            Err(e) => {
208                log::error!("{e:#}");
209                return Err(e);
210            }
211        }
212    }
213}
214
215impl Connection for PostgresConnection {
216    async fn connect(driver: &PostgresDriver, url: Cow<'static, str>) -> Result<Self> {
217        let context = "While trying to connect to Postgres";
218        let mut url = Self::sanitize_url(driver, url)?;
219        let mut take_url_param = |key: &str, env_var: &str, remove: bool| {
220            let value = url
221                .query_pairs()
222                .find_map(|(k, v)| if k == key { Some(v) } else { None })
223                .map(|v| v.to_string());
224            if remove && let Some(..) = value {
225                let mut result = url.clone();
226                result.set_query(None);
227                result
228                    .query_pairs_mut()
229                    .extend_pairs(url.query_pairs().filter(|(k, _)| k != key));
230                url = result;
231            };
232            value.or_else(|| env::var(env_var).ok().map(Into::into))
233        };
234        let sslmode = take_url_param("sslmode", "PGSSLMODE", false).unwrap_or("disable".into());
235        let (client, handle) = if sslmode == "disable" {
236            let (client, connection) = tokio_postgres::connect(url.as_str(), NoTls).await?;
237            let handle = spawn(async move {
238                if let Err(error) = connection.await
239                    && !error.is_closed()
240                {
241                    log::error!("Postgres connection error: {:#?}", error);
242                }
243            });
244            (client, handle)
245        } else {
246            let mut builder = SslConnector::builder(SslMethod::tls())?;
247            let path = PathBuf::from_str(
248                take_url_param("sslrootcert", "PGSSLROOTCERT", true)
249                    .as_deref()
250                    .unwrap_or("~/.postgresql/root.crt"),
251            )
252            .context(context)?;
253            if path.exists() {
254                builder.set_ca_file(path)?;
255            }
256            let path = PathBuf::from_str(
257                take_url_param("sslcert", "PGSSLCERT", true)
258                    .as_deref()
259                    .unwrap_or("~/.postgresql/postgresql.crt"),
260            )
261            .context(context)?;
262            if path.exists() {
263                builder.set_certificate_chain_file(path)?;
264            }
265            let path = PathBuf::from_str(
266                take_url_param("sslkey", "PGSSLKEY", true)
267                    .as_deref()
268                    .unwrap_or("~/.postgresql/postgresql.key"),
269            )
270            .context(context)?;
271            if path.exists() {
272                builder.set_private_key_file(path, SslFiletype::PEM)?;
273            }
274            builder.set_verify(SslVerifyMode::PEER);
275            let connector = MakeTlsConnector::new(builder.build());
276            let (client, connection) = tokio_postgres::connect(url.as_str(), connector).await?;
277            let handle = spawn(async move {
278                if let Err(error) = connection.await
279                    && !error.is_closed()
280                {
281                    log::error!("Postgres connection error: {:#?}", error);
282                }
283            });
284            (client, handle)
285        };
286        Ok(Self { client, handle })
287    }
288
289    fn begin(&mut self) -> impl Future<Output = Result<PostgresTransaction<'_>>> + Send {
290        PostgresTransaction::new(self)
291    }
292
293    async fn disconnect(self) -> Result<()> {
294        drop(self.client);
295        if let Err(e) = self.handle.await {
296            let error = Error::new(e).context("While disconnecting from Postgres");
297            log::error!("{:#}", error);
298            return Err(error);
299        }
300        Ok(())
301    }
302}
tank_postgres/connection.rs

tank_postgres/
connection.rs
