1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
use futures::stream::{self, StreamExt};
use mysql_async::{
    prelude::{FromRow, Queryable},
    BinaryProtocol,
};
use mysql_async_support_model::{
    Error, QueryError, QueryResult, QueryTarget, ResultSet, SshTunnelMap,
};
use ssh_jumper::{
    model::{HostAddress, HostSocketParams, JumpHostAuthParams, SshTunnelParams},
    SshJumper,
};

use crate::{FnWithPool, SqlOverSsh, SshTunnelManager};

/// Runs queries for one or more query targets.
#[derive(Clone)]
pub struct QueryRunner {
    /// Runs SQL over an SSH connection.
    pub sql_over_ssh: SqlOverSsh,
    /// Maximum number of SSH connections to run concurrently.
    pub ssh_concurrent_limit: usize,
    /// Maximum number of tunnels per SSH connection.
    pub tunnels_per_ssh_connection: usize,
}

impl QueryRunner {
    /// Maximum number of tunnels per SSH connection.
    pub const SSH_CONCURRENT_LIMIT_DEFAULT: usize = 20;
    /// Maximum number of tunnels per SSH connection.
    pub const TUNNELS_PER_SSH_CONNECTION_DEFAULT: usize = 3;

    /// Returns a new `QueryRunner` with the given connection limits.
    pub fn new(ssh_concurrent_limit: usize, tunnels_per_ssh_connection: usize) -> Self {
        Self {
            sql_over_ssh: SqlOverSsh,
            ssh_concurrent_limit,
            tunnels_per_ssh_connection,
        }
    }

    /// Queries a database over an SSH connection.
    pub async fn query<T>(
        &self,
        jump_host_address: &HostAddress<'_>,
        jump_host_auth_params: &JumpHostAuthParams<'_>,
        query_target: &QueryTarget<'_>,
        sql_text: &str,
    ) -> Result<QueryResult<T>, Error>
    where
        T: FromRow + Send + 'static,
    {
        let db_tunnel = {
            let jump_host_address = jump_host_address.clone();
            let jump_host_auth_params = jump_host_auth_params.clone();
            let target_socket = HostSocketParams {
                address: query_target.db_address.clone(),
                port: 3306,
            };
            let ssh_params =
                SshTunnelParams::new(jump_host_address, jump_host_auth_params, target_socket);
            SshJumper::open_tunnel(&ssh_params).await?
        };

        self.sql_over_ssh
            .exec(
                db_tunnel,
                query_target.db_schema_cred.clone(),
                |pool: mysql_async::Pool| async {
                    let result = Self::query_run(&pool, query_target, sql_text).await;
                    (pool, result)
                },
            )
            .await
    }

    /// Queries multiple query targets with the same query.
    pub async fn query_multi<T>(
        &self,
        jump_host_address: &HostAddress<'_>,
        jump_host_auth_params: &JumpHostAuthParams<'_>,
        query_targets: &[QueryTarget<'_>],
        sql_text: &str,
    ) -> (Vec<QueryResult<T>>, Vec<QueryError>)
    where
        T: FromRow + Send + 'static,
    {
        stream::iter(query_targets.chunks(self.tunnels_per_ssh_connection))
            .map(|query_targets_chunk| async move {
                let ssh_tunnel_map = SshTunnelManager::prepare_tunnels(
                    jump_host_address,
                    jump_host_auth_params,
                    query_targets_chunk,
                )
                .await;

                match ssh_tunnel_map {
                    Ok(ssh_tunnel_map) => {
                        self.query_over_tunnels(
                            jump_host_address,
                            query_targets_chunk,
                            sql_text,
                            ssh_tunnel_map,
                        )
                        .await
                    }
                    Err(e) => {
                        let mut error = Some(e);
                        let errors = query_targets_chunk
                            .iter()
                            .map(|query_target| QueryError {
                                name: query_target.name.clone().into_owned(),
                                error: error.take().unwrap_or(Error::SshConnInit),
                            })
                            .collect::<Vec<QueryError>>();
                        (vec![], errors)
                    }
                }
            })
            .buffered(self.ssh_concurrent_limit)
            .fold(
                (
                    Vec::with_capacity(query_targets.len()),
                    Vec::with_capacity(query_targets.len()),
                ),
                |(mut query_results, mut query_errors),
                 (query_results_chunk, query_errors_chunk)| async move {
                    query_results.extend(query_results_chunk);
                    query_errors.extend(query_errors_chunk);

                    (query_results, query_errors)
                },
            )
            .await
    }

    /// Queries multiple query targets with the same query.
    pub async fn exec_multi<'f, Queries>(
        &'f self,
        jump_host_address: HostAddress<'f>,
        jump_host_auth_params: JumpHostAuthParams<'f>,
        query_targets: &'f [QueryTarget<'f>],
        queries: Queries,
    ) -> (
        Vec<(&'f QueryTarget<'f>, <Queries as FnWithPool<'f>>::Output)>,
        Vec<(&'f QueryTarget<'f>, <Queries as FnWithPool<'f>>::Error)>,
    )
    where
        Queries: FnWithPool<'f> + Copy,
        <Queries as FnWithPool<'f>>::Error: From<Error>,
    {
        let jump_host_address = &jump_host_address;
        let jump_host_auth_params = &jump_host_auth_params;
        stream::iter(query_targets.chunks(self.tunnels_per_ssh_connection))
            .map(|query_targets_chunk| async move {
                let ssh_tunnel_map = SshTunnelManager::prepare_tunnels(
                    jump_host_address,
                    jump_host_auth_params,
                    query_targets_chunk,
                )
                .await;

                match ssh_tunnel_map {
                    Ok(ssh_tunnel_map) => {
                        self
                            .exec_over_tunnels(jump_host_address, query_targets, queries, ssh_tunnel_map)
                            .await
                    }
                    Err(e) => {
                        let mut error = Some(e);
                        let errors = query_targets_chunk
                            .iter()
                            .map(|query_target| {

                                let error = error.take().unwrap_or(Error::SshConnInit);
                                (query_target, <Queries as FnWithPool<'f>>::Error::from(error))
                            })
                            .collect::<Vec<(&QueryTarget<'_>, <Queries as FnWithPool<'f>>::Error)>>();
                        (vec![], errors)
                    }
                }
            })
            .buffered(self.ssh_concurrent_limit)
            .fold(
                (
                    Vec::with_capacity(query_targets.len()),
                    Vec::with_capacity(query_targets.len()),
                ),
                |(mut exec_results, mut exec_errors),
                 (exec_results_chunk, exec_errors_chunk)| async move {
                    exec_results.extend(exec_results_chunk);
                    exec_errors.extend(exec_errors_chunk);

                    (exec_results, exec_errors)
                },
            )
            .await
    }

    async fn query_over_tunnels<T>(
        &self,
        jump_host_address: &HostAddress<'_>,
        query_targets: &[QueryTarget<'_>],
        sql_text: &str,
        ssh_tunnel_map: SshTunnelMap<'_>,
    ) -> (Vec<QueryResult<T>>, Vec<QueryError>)
    where
        T: FromRow + Send + 'static,
    {
        let qt_name_to_tunnel = &ssh_tunnel_map.qt_name_to_tunnel;
        let query_results_and_errors = stream::iter(query_targets.iter())
            .map(|query_target| async move {
                let db_tunnel = *qt_name_to_tunnel
                    .get(query_target.name.as_ref())
                    .ok_or_else(|| {
                        let error = Error::SshTunnelNotFound {
                            jump_host_address: jump_host_address.into_static(),
                            query_target: query_target.clone().into_static(),
                        };
                        QueryError {
                            name: query_target.name.to_string(),
                            error,
                        }
                    })?;
                self.sql_over_ssh
                    .exec(
                        db_tunnel,
                        query_target.db_schema_cred.clone(),
                        |pool: mysql_async::Pool| async {
                            let result = Self::query_run(&pool, query_target, sql_text).await;
                            (pool, result)
                        },
                    )
                    .await
                    .map_err(|error| QueryError {
                        name: query_target.name.to_string(),
                        error,
                    })
            })
            .buffered(self.tunnels_per_ssh_connection)
            .fold(
                (Vec::new(), Vec::new()),
                |(mut query_results, mut query_errors), result| async {
                    match result {
                        Ok(query_result) => query_results.push(query_result),
                        Err(query_error) => query_errors.push(query_error),
                    }
                    (query_results, query_errors)
                },
            )
            .await;

        query_results_and_errors
    }

    async fn query_run<T>(
        pool: &mysql_async::Pool,
        query_target: &QueryTarget<'_>,
        sql_text: &str,
    ) -> Result<QueryResult<T>, Error>
    where
        T: FromRow + Send + 'static,
    {
        match pool.get_conn().await {
            Ok(mut conn) => {
                let statement = conn.prep(sql_text).await.map_err(Error::MySqlPrepare);
                match statement {
                    Ok(statement) => {
                        let result = conn
                            .exec_iter(statement, ())
                            .await
                            .map_err(Error::MySqlExecute);

                        match result {
                            Ok(mut query_result) => {
                                Self::query_result_fetch::<T>(
                                    query_target.name.to_string(),
                                    &mut query_result,
                                )
                                .await
                            }
                            Err(e) => Err(e),
                        }
                    }
                    Err(e) => Err(e),
                }
            }
            Err(e) => Err(Error::MySqlConnectionRetrieve(e)),
        }
    }

    async fn query_result_fetch<T>(
        query_target_name: String,
        query_result: &mut mysql_async::QueryResult<'_, '_, BinaryProtocol>,
    ) -> Result<QueryResult<T>, Error>
    where
        T: FromRow + Send + 'static,
    {
        // A query result may have multiple result sets.
        // Each set may have a different number of columns.
        //
        // `Stream` is not implemented for `QueryResult`, so we use imperative style.
        // See the following issue for reasons:
        // https://github.com/blackbeam/mysql_async/issues/90
        let mut result_sets = Vec::new();
        while !query_result.is_empty() {
            let values = query_result
                .collect::<T>()
                .await
                .map_err(Error::QueryResultSetFetch)?;
            let affected_rows = query_result.affected_rows();
            let warning_count = query_result.warnings();
            let info = query_result.info().into_owned();

            let result_set = ResultSet::<T> {
                affected_rows,
                info,
                warning_count,
                values,
            };
            result_sets.push(result_set);
        }

        Ok(QueryResult {
            name: query_target_name,
            result_sets,
        })
    }

    async fn exec_over_tunnels<'f, Queries>(
        &'f self,
        jump_host_address: &HostAddress<'f>,
        query_targets: &'f [QueryTarget<'f>],
        queries: Queries,
        ssh_tunnel_map: SshTunnelMap<'f>,
    ) -> (
        Vec<(&'f QueryTarget<'f>, <Queries as FnWithPool<'f>>::Output)>,
        Vec<(&'f QueryTarget<'f>, <Queries as FnWithPool<'f>>::Error)>,
    )
    where
        Queries: FnWithPool<'f> + Copy,
        <Queries as FnWithPool<'f>>::Error: From<Error>,
    {
        let qt_name_to_tunnel = &ssh_tunnel_map.qt_name_to_tunnel;
        stream::iter(query_targets.iter())
            .map(|query_target| async move {
                let db_tunnel = *qt_name_to_tunnel
                    .get(query_target.name.as_ref())
                    .ok_or_else(|| Error::SshTunnelNotFound {
                        jump_host_address: jump_host_address.clone().into_static(),
                        query_target: query_target.clone().into_static(),
                    })
                    .map_err(<Queries as FnWithPool<'f>>::Error::from)
                    .map_err(|exec_error| (query_target, exec_error))?;

                self.sql_over_ssh
                    .exec(db_tunnel, query_target.db_schema_cred.clone(), queries)
                    .await
                    .map(|exec_result| (query_target, exec_result))
                    .map_err(|exec_error| (query_target, exec_error))
            })
            .buffered(self.tunnels_per_ssh_connection)
            .fold(
                (Vec::new(), Vec::new()),
                |(mut exec_results, mut exec_errors), result| async {
                    match result {
                        Ok(exec_result) => exec_results.push(exec_result),
                        Err(exec_error) => exec_errors.push(exec_error),
                    }
                    (exec_results, exec_errors)
                },
            )
            .await
    }
}

impl Default for QueryRunner {
    fn default() -> Self {
        Self::new(
            Self::SSH_CONCURRENT_LIMIT_DEFAULT,
            Self::TUNNELS_PER_SSH_CONNECTION_DEFAULT,
        )
    }
}