databend_client/
client.rs

1// Copyright 2021 Datafuse Labs
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//     http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15use std::collections::BTreeMap;
16use std::sync::atomic::{AtomicBool, AtomicU64, Ordering};
17use std::sync::Arc;
18use std::time::{Duration, Instant};
19
20use crate::auth::{AccessTokenAuth, AccessTokenFileAuth, Auth, BasicAuth};
21use crate::capability::Capability;
22use crate::error_code::{need_refresh_token, ResponseWithErrorCode};
23use crate::global_cookie_store::GlobalCookieStore;
24use crate::login::{
25    LoginRequest, LoginResponseResult, RefreshResponse, RefreshSessionTokenRequest,
26    SessionTokenInfo,
27};
28use crate::presign::{presign_upload_to_stage, PresignMode, PresignedResponse, Reader};
29use crate::response::LoadResponse;
30use crate::stage::StageLocation;
31use crate::{
32    error::{Error, Result},
33    request::{PaginationConfig, QueryRequest, StageAttachmentConfig},
34    response::QueryResponse,
35    session::SessionState,
36    QueryStats,
37};
38use crate::{Page, Pages};
39use log::{debug, error, info, warn};
40use once_cell::sync::Lazy;
41use parking_lot::Mutex;
42use percent_encoding::percent_decode_str;
43use reqwest::cookie::CookieStore;
44use reqwest::header::{HeaderMap, HeaderValue};
45use reqwest::multipart::{Form, Part};
46use reqwest::{Body, Client as HttpClient, Request, RequestBuilder, Response, StatusCode};
47use semver::Version;
48use serde::Deserialize;
49use tokio::time::sleep;
50use tokio_retry::strategy::jitter;
51use tokio_stream::StreamExt;
52use tokio_util::io::ReaderStream;
53use url::Url;
54
55const HEADER_QUERY_ID: &str = "X-DATABEND-QUERY-ID";
56const HEADER_TENANT: &str = "X-DATABEND-TENANT";
57const HEADER_STICKY_NODE: &str = "X-DATABEND-STICKY-NODE";
58const HEADER_WAREHOUSE: &str = "X-DATABEND-WAREHOUSE";
59const HEADER_STAGE_NAME: &str = "X-DATABEND-STAGE-NAME";
60const HEADER_ROUTE_HINT: &str = "X-DATABEND-ROUTE-HINT";
61const TXN_STATE_ACTIVE: &str = "Active";
62const HEADER_SQL: &str = "X-DATABEND-SQL";
63
64static VERSION: Lazy<String> = Lazy::new(|| {
65    let version = option_env!("CARGO_PKG_VERSION").unwrap_or("unknown");
66    version.to_string()
67});
68
69pub struct APIClient {
70    cli: HttpClient,
71    scheme: String,
72    host: String,
73    port: u16,
74
75    endpoint: Url,
76
77    auth: Arc<dyn Auth>,
78
79    tenant: Option<String>,
80    warehouse: Mutex<Option<String>>,
81    session_state: Mutex<SessionState>,
82    route_hint: RouteHintGenerator,
83
84    disable_login: bool,
85    disable_session_token: bool,
86    session_token_info: Option<Arc<Mutex<(SessionTokenInfo, Instant)>>>,
87
88    closed: AtomicBool,
89
90    server_version: Option<Version>,
91
92    wait_time_secs: Option<i64>,
93    max_rows_in_buffer: Option<i64>,
94    max_rows_per_page: Option<i64>,
95
96    connect_timeout: Duration,
97    page_request_timeout: Duration,
98
99    tls_ca_file: Option<String>,
100
101    presign: Mutex<PresignMode>,
102    last_node_id: Mutex<Option<String>>,
103    last_query_id: Mutex<Option<String>>,
104
105    capability: Capability,
106}
107
108impl APIClient {
109    pub async fn new(dsn: &str, name: Option<String>) -> Result<Arc<Self>> {
110        let mut client = Self::from_dsn(dsn).await?;
111        client.build_client(name).await?;
112        if !client.disable_login {
113            client.login().await?;
114        }
115        let client = Arc::new(client);
116        client.check_presign().await?;
117        Ok(client)
118    }
119
120    pub fn capability(&self) -> &Capability {
121        &self.capability
122    }
123
124    fn set_presign_mode(&self, mode: PresignMode) {
125        *self.presign.lock() = mode
126    }
127    fn get_presign_mode(&self) -> PresignMode {
128        *self.presign.lock()
129    }
130
131    async fn from_dsn(dsn: &str) -> Result<Self> {
132        let u = Url::parse(dsn)?;
133        let mut client = Self::default();
134        if let Some(host) = u.host_str() {
135            client.host = host.to_string();
136        }
137
138        if u.username() != "" {
139            let password = u.password().unwrap_or_default();
140            let password = percent_decode_str(password).decode_utf8()?;
141            client.auth = Arc::new(BasicAuth::new(u.username(), password));
142        }
143        let database = match u.path().trim_start_matches('/') {
144            "" => None,
145            s => Some(s.to_string()),
146        };
147        let mut role = None;
148        let mut scheme = "https";
149        let mut session_settings = BTreeMap::new();
150        for (k, v) in u.query_pairs() {
151            match k.as_ref() {
152                "wait_time_secs" => {
153                    client.wait_time_secs = Some(v.parse()?);
154                }
155                "max_rows_in_buffer" => {
156                    client.max_rows_in_buffer = Some(v.parse()?);
157                }
158                "max_rows_per_page" => {
159                    client.max_rows_per_page = Some(v.parse()?);
160                }
161                "connect_timeout" => client.connect_timeout = Duration::from_secs(v.parse()?),
162                "page_request_timeout_secs" => {
163                    client.page_request_timeout = {
164                        let secs: u64 = v.parse()?;
165                        Duration::from_secs(secs)
166                    };
167                }
168                "presign" => {
169                    let presign_mode = match v.as_ref() {
170                        "auto" => PresignMode::Auto,
171                        "detect" => PresignMode::Detect,
172                        "on" => PresignMode::On,
173                        "off" => PresignMode::Off,
174                        _ => {
175                            return Err(Error::BadArgument(format!(
176                            "Invalid value for presign: {v}, should be one of auto/detect/on/off"
177                        )))
178                        }
179                    };
180                    client.set_presign_mode(presign_mode);
181                }
182                "tenant" => {
183                    client.tenant = Some(v.to_string());
184                }
185                "warehouse" => {
186                    client.warehouse = Mutex::new(Some(v.to_string()));
187                }
188                "role" => role = Some(v.to_string()),
189                "sslmode" => match v.as_ref() {
190                    "disable" => scheme = "http",
191                    "require" | "enable" => scheme = "https",
192                    _ => {
193                        return Err(Error::BadArgument(format!(
194                            "Invalid value for sslmode: {v}"
195                        )))
196                    }
197                },
198                "tls_ca_file" => {
199                    client.tls_ca_file = Some(v.to_string());
200                }
201                "access_token" => {
202                    client.auth = Arc::new(AccessTokenAuth::new(v));
203                }
204                "access_token_file" => {
205                    client.auth = Arc::new(AccessTokenFileAuth::new(v));
206                }
207                "login" => {
208                    client.disable_login = match v.as_ref() {
209                        "disable" => true,
210                        "enable" => false,
211                        _ => {
212                            return Err(Error::BadArgument(format!("Invalid value for login: {v}")))
213                        }
214                    }
215                }
216                "session_token" => {
217                    client.disable_session_token = match v.as_ref() {
218                        "disable" => true,
219                        "enable" => false,
220                        _ => {
221                            return Err(Error::BadArgument(format!(
222                                "Invalid value for session_token: {v}"
223                            )))
224                        }
225                    }
226                }
227                _ => {
228                    session_settings.insert(k.to_string(), v.to_string());
229                }
230            }
231        }
232        client.port = match u.port() {
233            Some(p) => p,
234            None => match scheme {
235                "http" => 80,
236                "https" => 443,
237                _ => unreachable!(),
238            },
239        };
240        client.scheme = scheme.to_string();
241
242        client.endpoint = Url::parse(&format!("{}://{}:{}", scheme, client.host, client.port))?;
243        client.session_state = Mutex::new(
244            SessionState::default()
245                .with_settings(Some(session_settings))
246                .with_role(role)
247                .with_database(database),
248        );
249
250        Ok(client)
251    }
252
253    pub fn host(&self) -> &str {
254        self.host.as_str()
255    }
256
257    pub fn port(&self) -> u16 {
258        self.port
259    }
260
261    pub fn scheme(&self) -> &str {
262        self.scheme.as_str()
263    }
264
265    async fn build_client(&mut self, name: Option<String>) -> Result<()> {
266        let ua = match name {
267            Some(n) => n,
268            None => format!("databend-client-rust/{}", VERSION.as_str()),
269        };
270        let cookie_provider = GlobalCookieStore::new();
271        let cookie = HeaderValue::from_str("cookie_enabled=true").unwrap();
272        let mut initial_cookies = [&cookie].into_iter();
273        cookie_provider.set_cookies(&mut initial_cookies, &Url::parse("https://a.com").unwrap());
274        let mut cli_builder = HttpClient::builder()
275            .user_agent(ua)
276            .cookie_provider(Arc::new(cookie_provider))
277            .pool_idle_timeout(Duration::from_secs(1));
278        #[cfg(any(feature = "rustls", feature = "native-tls"))]
279        if self.scheme == "https" {
280            if let Some(ref ca_file) = self.tls_ca_file {
281                let cert_pem = tokio::fs::read(ca_file).await?;
282                let cert = reqwest::Certificate::from_pem(&cert_pem)?;
283                cli_builder = cli_builder.add_root_certificate(cert);
284            }
285        }
286        self.cli = cli_builder.build()?;
287        Ok(())
288    }
289
290    async fn check_presign(self: &Arc<Self>) -> Result<()> {
291        let mode = match self.get_presign_mode() {
292            PresignMode::Auto => {
293                if self.host.ends_with(".databend.com") || self.host.ends_with(".databend.cn") {
294                    PresignMode::On
295                } else {
296                    PresignMode::Off
297                }
298            }
299            PresignMode::Detect => match self.get_presigned_upload_url("@~/.bendsql/check").await {
300                Ok(_) => PresignMode::On,
301                Err(e) => {
302                    warn!("presign mode off with error detected: {e}");
303                    PresignMode::Off
304                }
305            },
306            mode => mode,
307        };
308        self.set_presign_mode(mode);
309        Ok(())
310    }
311
312    pub fn current_warehouse(&self) -> Option<String> {
313        let guard = self.warehouse.lock();
314        guard.clone()
315    }
316
317    pub fn current_catalog(&self) -> Option<String> {
318        let guard = self.session_state.lock();
319        guard.catalog.clone()
320    }
321
322    pub fn current_database(&self) -> Option<String> {
323        let guard = self.session_state.lock();
324        guard.database.clone()
325    }
326
327    pub async fn current_role(&self) -> Option<String> {
328        let guard = self.session_state.lock();
329        guard.role.clone()
330    }
331
332    fn in_active_transaction(&self) -> bool {
333        let guard = self.session_state.lock();
334        guard
335            .txn_state
336            .as_ref()
337            .map(|s| s.eq_ignore_ascii_case(TXN_STATE_ACTIVE))
338            .unwrap_or(false)
339    }
340
341    pub fn username(&self) -> String {
342        self.auth.username()
343    }
344
345    fn gen_query_id(&self) -> String {
346        uuid::Uuid::now_v7().simple().to_string()
347    }
348
349    async fn handle_session(&self, session: &Option<SessionState>) {
350        let session = match session {
351            Some(session) => session,
352            None => return,
353        };
354
355        // save the updated session state from the server side
356        {
357            let mut session_state = self.session_state.lock();
358            *session_state = session.clone();
359        }
360
361        // process warehouse changed via session settings
362        if let Some(settings) = session.settings.as_ref() {
363            if let Some(v) = settings.get("warehouse") {
364                let mut warehouse = self.warehouse.lock();
365                *warehouse = Some(v.clone());
366            }
367        }
368    }
369
370    pub fn set_last_node_id(&self, node_id: String) {
371        *self.last_node_id.lock() = Some(node_id)
372    }
373
374    pub fn set_last_query_id(&self, query_id: Option<String>) {
375        *self.last_query_id.lock() = query_id
376    }
377
378    pub fn last_query_id(&self) -> Option<String> {
379        self.last_query_id.lock().clone()
380    }
381
382    fn last_node_id(&self) -> Option<String> {
383        self.last_node_id.lock().clone()
384    }
385
386    fn handle_warnings(&self, resp: &QueryResponse) {
387        if let Some(warnings) = &resp.warnings {
388            for w in warnings {
389                warn!(target: "server_warnings", "server warning: {w}");
390            }
391        }
392    }
393
394    pub async fn start_query(self: &Arc<Self>, sql: &str, need_progress: bool) -> Result<Pages> {
395        info!("start query: {sql}");
396        let resp = self.start_query_inner(sql, None).await?;
397        let pages = Pages::new(self.clone(), resp, need_progress);
398        Ok(pages)
399    }
400
401    fn wrap_auth_or_session_token(&self, builder: RequestBuilder) -> Result<RequestBuilder> {
402        if let Some(info) = &self.session_token_info {
403            let info = info.lock();
404            Ok(builder.bearer_auth(info.0.session_token.clone()))
405        } else {
406            self.auth.wrap(builder)
407        }
408    }
409
410    async fn start_query_inner(
411        &self,
412        sql: &str,
413        stage_attachment_config: Option<StageAttachmentConfig<'_>>,
414    ) -> Result<QueryResponse> {
415        if !self.in_active_transaction() {
416            self.route_hint.next();
417        }
418        let endpoint = self.endpoint.join("v1/query")?;
419
420        // body
421        let session_state = self.session_state();
422        let need_sticky = session_state.need_sticky.unwrap_or(false);
423        let req = QueryRequest::new(sql)
424            .with_pagination(self.make_pagination())
425            .with_session(Some(session_state))
426            .with_stage_attachment(stage_attachment_config);
427
428        // headers
429        let query_id = self.gen_query_id();
430        let mut headers = self.make_headers(Some(&query_id))?;
431        if need_sticky {
432            if let Some(node_id) = self.last_node_id() {
433                headers.insert(HEADER_STICKY_NODE, node_id.parse()?);
434            }
435        }
436        let mut builder = self.cli.post(endpoint.clone()).json(&req);
437        builder = self.wrap_auth_or_session_token(builder)?;
438        let request = builder.headers(headers.clone()).build()?;
439        let response = self.query_request_helper(request, true, true).await?;
440        if let Some(route_hint) = response.headers().get(HEADER_ROUTE_HINT) {
441            self.route_hint.set(route_hint.to_str().unwrap_or_default());
442        }
443        let body = response.bytes().await?;
444        let result: QueryResponse = json_from_slice(&body)?;
445        self.handle_session(&result.session).await;
446        if let Some(err) = result.error {
447            return Err(Error::QueryFailed(err));
448        }
449
450        self.set_last_query_id(Some(query_id));
451        self.handle_warnings(&result);
452        if let Some(node_id) = &result.node_id {
453            self.set_last_node_id(node_id.clone());
454        }
455        Ok(result)
456    }
457
458    pub async fn query_page(
459        &self,
460        query_id: &str,
461        next_uri: &str,
462        node_id: &Option<String>,
463    ) -> Result<QueryResponse> {
464        info!("query page: {next_uri}");
465        let endpoint = self.endpoint.join(next_uri)?;
466        let headers = self.make_headers(Some(query_id))?;
467        let mut builder = self.cli.get(endpoint.clone());
468        builder = self
469            .wrap_auth_or_session_token(builder)?
470            .headers(headers.clone())
471            .timeout(self.page_request_timeout);
472        if let Some(node_id) = node_id {
473            builder = builder.header(HEADER_STICKY_NODE, node_id)
474        }
475        let request = builder.build()?;
476
477        let response = self.query_request_helper(request, false, true).await?;
478        let body = response.bytes().await?;
479        let resp: QueryResponse = json_from_slice(&body).map_err(|e| {
480            if let Error::Logic(status, ec) = &e {
481                if *status == 404 {
482                    return Error::QueryNotFound(ec.message.clone());
483                }
484            }
485            e
486        })?;
487        self.handle_session(&resp.session).await;
488        match resp.error {
489            Some(err) => Err(Error::QueryFailed(err)),
490            None => Ok(resp),
491        }
492    }
493
494    pub async fn kill_query(&self, query_id: &str) -> Result<()> {
495        let kill_uri = format!("/v1/query/{query_id}/kill");
496        let endpoint = self.endpoint.join(&kill_uri)?;
497        let headers = self.make_headers(Some(query_id))?;
498        info!("kill query: {kill_uri}");
499
500        let mut builder = self.cli.post(endpoint);
501        builder = self.wrap_auth_or_session_token(builder)?;
502        let resp = builder.headers(headers.clone()).send().await?;
503        if resp.status() != 200 {
504            return Err(Error::response_error(resp.status(), &resp.bytes().await?)
505                .with_context("kill query"));
506        }
507        Ok(())
508    }
509
510    pub async fn query_all(self: &Arc<Self>, sql: &str) -> Result<Page> {
511        let mut pages = self.start_query(sql, false).await?;
512        let mut all = Page::default();
513        while let Some(page) = pages.next().await {
514            all.update(page?);
515        }
516        Ok(all)
517    }
518
519    fn session_state(&self) -> SessionState {
520        self.session_state.lock().clone()
521    }
522
523    fn make_pagination(&self) -> Option<PaginationConfig> {
524        if self.wait_time_secs.is_none()
525            && self.max_rows_in_buffer.is_none()
526            && self.max_rows_per_page.is_none()
527        {
528            return None;
529        }
530        let mut pagination = PaginationConfig {
531            wait_time_secs: None,
532            max_rows_in_buffer: None,
533            max_rows_per_page: None,
534        };
535        if let Some(wait_time_secs) = self.wait_time_secs {
536            pagination.wait_time_secs = Some(wait_time_secs);
537        }
538        if let Some(max_rows_in_buffer) = self.max_rows_in_buffer {
539            pagination.max_rows_in_buffer = Some(max_rows_in_buffer);
540        }
541        if let Some(max_rows_per_page) = self.max_rows_per_page {
542            pagination.max_rows_per_page = Some(max_rows_per_page);
543        }
544        Some(pagination)
545    }
546
547    fn make_headers(&self, query_id: Option<&str>) -> Result<HeaderMap> {
548        let mut headers = HeaderMap::new();
549        if let Some(tenant) = &self.tenant {
550            headers.insert(HEADER_TENANT, tenant.parse()?);
551        }
552        let warehouse = self.warehouse.lock().clone();
553        if let Some(warehouse) = warehouse {
554            headers.insert(HEADER_WAREHOUSE, warehouse.parse()?);
555        }
556        let route_hint = self.route_hint.current();
557        headers.insert(HEADER_ROUTE_HINT, route_hint.parse()?);
558        if let Some(query_id) = query_id {
559            headers.insert(HEADER_QUERY_ID, query_id.parse()?);
560        }
561        Ok(headers)
562    }
563
564    pub async fn insert_with_stage(
565        self: &Arc<Self>,
566        sql: &str,
567        stage: &str,
568        file_format_options: BTreeMap<&str, &str>,
569        copy_options: BTreeMap<&str, &str>,
570    ) -> Result<QueryStats> {
571        info!("insert with stage: {sql}, format: {file_format_options:?}, copy: {copy_options:?}");
572        let stage_attachment = Some(StageAttachmentConfig {
573            location: stage,
574            file_format_options: Some(file_format_options),
575            copy_options: Some(copy_options),
576        });
577        let resp = self.start_query_inner(sql, stage_attachment).await?;
578        let mut pages = Pages::new(self.clone(), resp, false);
579        let mut all = Page::default();
580        while let Some(page) = pages.next().await {
581            all.update(page?);
582        }
583        Ok(all.stats)
584    }
585
586    async fn get_presigned_upload_url(self: &Arc<Self>, stage: &str) -> Result<PresignedResponse> {
587        info!("get presigned upload url: {stage}");
588        let sql = format!("PRESIGN UPLOAD {stage}");
589        let resp = self.query_all(&sql).await?;
590        if resp.data.len() != 1 {
591            return Err(Error::Decode(
592                "Empty response from server for presigned request".to_string(),
593            ));
594        }
595        if resp.data[0].len() != 3 {
596            return Err(Error::Decode(
597                "Invalid response from server for presigned request".to_string(),
598            ));
599        }
600        // resp.data[0]: [ "PUT", "{\"host\":\"s3.us-east-2.amazonaws.com\"}", "https://s3.us-east-2.amazonaws.com/query-storage-xxxxx/tnxxxxx/stage/user/xxxx/xxx?" ]
601        let method = resp.data[0][0].clone().unwrap_or_default();
602        if method != "PUT" {
603            return Err(Error::Decode(format!(
604                "Invalid method for presigned upload request: {method}"
605            )));
606        }
607        let headers: BTreeMap<String, String> =
608            serde_json::from_str(resp.data[0][1].clone().unwrap_or("{}".to_string()).as_str())?;
609        let url = resp.data[0][2].clone().unwrap_or_default();
610        Ok(PresignedResponse {
611            method,
612            headers,
613            url,
614        })
615    }
616
617    pub async fn upload_to_stage(
618        self: &Arc<Self>,
619        stage: &str,
620        data: Reader,
621        size: u64,
622    ) -> Result<()> {
623        match self.get_presign_mode() {
624            PresignMode::Off => self.upload_to_stage_with_stream(stage, data, size).await,
625            PresignMode::On => {
626                let presigned = self.get_presigned_upload_url(stage).await?;
627                presign_upload_to_stage(presigned, data, size).await
628            }
629            PresignMode::Auto => {
630                unreachable!("PresignMode::Auto should be handled during client initialization")
631            }
632            PresignMode::Detect => {
633                unreachable!("PresignMode::Detect should be handled during client initialization")
634            }
635        }
636    }
637
638    /// Upload data to stage with stream api, should not be used directly, use `upload_to_stage` instead.
639    async fn upload_to_stage_with_stream(
640        &self,
641        stage: &str,
642        data: Reader,
643        size: u64,
644    ) -> Result<()> {
645        info!("upload to stage with stream: {stage}, size: {size}");
646        if let Some(info) = self.need_pre_refresh_session().await {
647            self.refresh_session_token(info).await?;
648        }
649        let endpoint = self.endpoint.join("v1/upload_to_stage")?;
650        let location = StageLocation::try_from(stage)?;
651        let query_id = self.gen_query_id();
652        let mut headers = self.make_headers(Some(&query_id))?;
653        headers.insert(HEADER_STAGE_NAME, location.name.parse()?);
654        let stream = Body::wrap_stream(ReaderStream::new(data));
655        let part = Part::stream_with_length(stream, size).file_name(location.path);
656        let form = Form::new().part("upload", part);
657        let mut builder = self.cli.put(endpoint.clone());
658        builder = self.wrap_auth_or_session_token(builder)?;
659        let resp = builder.headers(headers).multipart(form).send().await?;
660        let status = resp.status();
661        if status != 200 {
662            return Err(
663                Error::response_error(status, &resp.bytes().await?).with_context("upload_to_stage")
664            );
665        }
666        Ok(())
667    }
668
669    pub async fn streaming_load(
670        &self,
671        sql: &str,
672        data: Reader,
673        file_name: &str,
674    ) -> Result<LoadResponse> {
675        let body = Body::wrap_stream(ReaderStream::new(data));
676        let part = Part::stream(body).file_name(file_name.to_string());
677        let endpoint = self.endpoint.join("v1/streaming_load")?;
678        let mut builder = self.cli.put(endpoint.clone());
679        builder = self.wrap_auth_or_session_token(builder)?;
680        let query_id = self.gen_query_id();
681        let mut headers = self.make_headers(Some(&query_id))?;
682        headers.insert(HEADER_SQL, sql.parse()?);
683        let form = Form::new().part("upload", part);
684        let resp = builder.headers(headers).multipart(form).send().await?;
685        let status = resp.status();
686        if status != 200 {
687            return Err(
688                Error::response_error(status, &resp.bytes().await?).with_context("streaming_load")
689            );
690        }
691        let resp = resp.json::<LoadResponse>().await?;
692        Ok(resp)
693    }
694
695    async fn login(&mut self) -> Result<()> {
696        let endpoint = self.endpoint.join("/v1/session/login")?;
697        let headers = self.make_headers(None)?;
698        let body = LoginRequest::from(&*self.session_state.lock());
699        let mut builder = self.cli.post(endpoint.clone()).json(&body);
700        if self.disable_session_token {
701            builder = builder.query(&[("disable_session_token", true)]);
702        }
703        let builder = self.auth.wrap(builder)?;
704        let request = builder
705            .headers(headers.clone())
706            .timeout(self.connect_timeout)
707            .build()?;
708        let response = self.query_request_helper(request, true, false).await;
709        let response = match response {
710            Ok(r) => r,
711            Err(e) if e.status_code() == Some(StatusCode::NOT_FOUND) => {
712                info!("login return 404, skip login on the old version server");
713                return Ok(());
714            }
715            Err(e) => return Err(e),
716        };
717        let body = response.bytes().await?;
718        let response = json_from_slice(&body)?;
719        match response {
720            LoginResponseResult::Err { error } => return Err(Error::AuthFailure(error)),
721            LoginResponseResult::Ok(info) => {
722                let server_version = info
723                    .version
724                    .parse()
725                    .map_err(|e| Error::Decode(format!("invalid server version: {e}")))?;
726                self.capability = Capability::from_server_version(&server_version);
727                self.server_version = Some(server_version.clone());
728                if let Some(tokens) = info.tokens {
729                    info!("login success with session token version = {server_version}",);
730                    self.session_token_info = Some(Arc::new(Mutex::new((tokens, Instant::now()))))
731                } else {
732                    info!("login success, version = {server_version}");
733                }
734            }
735        }
736        Ok(())
737    }
738
739    fn build_log_out_request(&self) -> Result<Request> {
740        let endpoint = self.endpoint.join("/v1/session/logout")?;
741
742        let session_state = self.session_state();
743        let need_sticky = session_state.need_sticky.unwrap_or(false);
744        let mut headers = self.make_headers(None)?;
745        if need_sticky {
746            if let Some(node_id) = self.last_node_id() {
747                headers.insert(HEADER_STICKY_NODE, node_id.parse()?);
748            }
749        }
750        let builder = self.cli.post(endpoint.clone()).headers(headers.clone());
751
752        let builder = self.wrap_auth_or_session_token(builder)?;
753        let req = builder.build()?;
754        Ok(req)
755    }
756
757    fn need_logout(&self) -> bool {
758        (self.session_token_info.is_some()
759            || self.session_state.lock().need_keep_alive.unwrap_or(false))
760            && self
761                .closed
762                .compare_exchange(false, true, Ordering::Relaxed, Ordering::Relaxed)
763                .is_ok()
764    }
765
766    async fn refresh_session_token(
767        &self,
768        self_login_info: Arc<parking_lot::Mutex<(SessionTokenInfo, Instant)>>,
769    ) -> Result<()> {
770        let (session_token_info, _) = { self_login_info.lock().clone() };
771        let endpoint = self.endpoint.join("/v1/session/refresh")?;
772        let body = RefreshSessionTokenRequest {
773            session_token: session_token_info.session_token.clone(),
774        };
775        let headers = self.make_headers(None)?;
776        let request = self
777            .cli
778            .post(endpoint.clone())
779            .json(&body)
780            .headers(headers.clone())
781            .bearer_auth(session_token_info.refresh_token.clone())
782            .timeout(self.connect_timeout)
783            .build()?;
784
785        // avoid recursively call request_helper
786        for i in 0..3 {
787            let req = request.try_clone().expect("request not cloneable");
788            match self.cli.execute(req).await {
789                Ok(response) => {
790                    let status = response.status();
791                    let body = response.bytes().await?;
792                    if status == StatusCode::OK {
793                        let response = json_from_slice(&body)?;
794                        return match response {
795                            RefreshResponse::Err { error } => Err(Error::AuthFailure(error)),
796                            RefreshResponse::Ok(info) => {
797                                *self_login_info.lock() = (info, Instant::now());
798                                Ok(())
799                            }
800                        };
801                    }
802                    if status != StatusCode::SERVICE_UNAVAILABLE || i >= 2 {
803                        return Err(Error::response_error(status, &body));
804                    }
805                }
806                Err(err) => {
807                    if !(err.is_timeout() || err.is_connect()) || i > 2 {
808                        return Err(Error::Request(err.to_string()));
809                    }
810                }
811            };
812            sleep(jitter(Duration::from_secs(10))).await;
813        }
814        Ok(())
815    }
816
817    async fn need_pre_refresh_session(&self) -> Option<Arc<Mutex<(SessionTokenInfo, Instant)>>> {
818        if let Some(info) = &self.session_token_info {
819            let (start, ttl) = {
820                let guard = info.lock();
821                (guard.1, guard.0.session_token_ttl_in_secs)
822            };
823            if Instant::now() > start + Duration::from_secs(ttl) {
824                return Some(info.clone());
825            }
826        }
827        None
828    }
829
830    /// return Ok if and only if status code is 200.
831    ///
832    /// retry on
833    ///   - network errors
834    ///   - (optional) 503
835    ///
836    /// refresh databend token or reload jwt token if needed.
837    async fn query_request_helper(
838        &self,
839        mut request: Request,
840        retry_if_503: bool,
841        refresh_if_401: bool,
842    ) -> std::result::Result<Response, Error> {
843        let mut refreshed = false;
844        let mut retries = 0;
845        loop {
846            let req = request.try_clone().expect("request not cloneable");
847            let (err, retry): (Error, bool) = match self.cli.execute(req).await {
848                Ok(response) => {
849                    let status = response.status();
850                    if status == StatusCode::OK {
851                        return Ok(response);
852                    }
853                    let body = response.bytes().await?;
854                    if retry_if_503 && status == StatusCode::SERVICE_UNAVAILABLE {
855                        // waiting for server to start
856                        (Error::response_error(status, &body), true)
857                    } else {
858                        let resp = serde_json::from_slice::<ResponseWithErrorCode>(&body);
859                        match resp {
860                            Ok(r) => {
861                                let e = r.error;
862                                if status == StatusCode::UNAUTHORIZED {
863                                    request.headers_mut().remove(reqwest::header::AUTHORIZATION);
864                                    if let Some(session_token_info) = &self.session_token_info {
865                                        info!(
866                                            "will retry {} after refresh token on auth error {}",
867                                            request.url(),
868                                            e
869                                        );
870                                        let retry = if need_refresh_token(e.code)
871                                            && !refreshed
872                                            && refresh_if_401
873                                        {
874                                            self.refresh_session_token(session_token_info.clone())
875                                                .await?;
876                                            refreshed = true;
877                                            true
878                                        } else {
879                                            false
880                                        };
881                                        (Error::AuthFailure(e), retry)
882                                    } else if self.auth.can_reload() {
883                                        info!(
884                                            "will retry {} after reload token on auth error {}",
885                                            request.url(),
886                                            e
887                                        );
888                                        let builder = RequestBuilder::from_parts(
889                                            HttpClient::new(),
890                                            request.try_clone().unwrap(),
891                                        );
892                                        let builder = self.auth.wrap(builder)?;
893                                        request = builder.build()?;
894                                        (Error::AuthFailure(e), true)
895                                    } else {
896                                        (Error::AuthFailure(e), false)
897                                    }
898                                } else {
899                                    (Error::Logic(status, e), false)
900                                }
901                            }
902                            Err(_) => (
903                                Error::Response {
904                                    status,
905                                    msg: String::from_utf8_lossy(&body).to_string(),
906                                },
907                                false,
908                            ),
909                        }
910                    }
911                }
912                Err(err) => (
913                    Error::Request(err.to_string()),
914                    err.is_timeout() || err.is_connect(),
915                ),
916            };
917            if !retry {
918                return Err(err.with_context(&format!("{} {}", request.method(), request.url())));
919            }
920            match &err {
921                Error::AuthFailure(_) => {
922                    if refreshed {
923                        retries = 0;
924                    } else if retries == 2 {
925                        return Err(err.with_context(&format!(
926                            "{} {} after 3 reties",
927                            request.method(),
928                            request.url()
929                        )));
930                    }
931                }
932                _ => {
933                    if retries == 2 {
934                        return Err(err.with_context(&format!(
935                            "{} {} after 3 reties",
936                            request.method(),
937                            request.url()
938                        )));
939                    }
940                    retries += 1;
941                    info!(
942                        "will retry {} the {retries}th times on error {}",
943                        request.url(),
944                        err
945                    );
946                }
947            }
948            sleep(jitter(Duration::from_secs(10))).await;
949        }
950    }
951
952    pub async fn close(&self) {
953        if self.need_logout() {
954            let cli = self.cli.clone();
955            let req = self
956                .build_log_out_request()
957                .expect("failed to build logout request");
958            if let Err(err) = cli.execute(req).await {
959                error!("logout request failed: {err}");
960            } else {
961                debug!("logout success");
962            };
963        }
964    }
965}
966
967impl Drop for APIClient {
968    fn drop(&mut self) {
969        if self.need_logout() {
970            warn!("APIClient::close() was not called");
971        }
972    }
973}
974
975fn json_from_slice<'a, T>(body: &'a [u8]) -> Result<T>
976where
977    T: Deserialize<'a>,
978{
979    serde_json::from_slice::<T>(body).map_err(|e| {
980        Error::Decode(format!(
981            "fail to decode JSON response: {e}, body: {}",
982            String::from_utf8_lossy(body)
983        ))
984    })
985}
986
987impl Default for APIClient {
988    fn default() -> Self {
989        Self {
990            cli: HttpClient::new(),
991            scheme: "http".to_string(),
992            endpoint: Url::parse("http://localhost:8080").unwrap(),
993            host: "localhost".to_string(),
994            port: 8000,
995            tenant: None,
996            warehouse: Mutex::new(None),
997            auth: Arc::new(BasicAuth::new("root", "")) as Arc<dyn Auth>,
998            session_state: Mutex::new(SessionState::default()),
999            wait_time_secs: None,
1000            max_rows_in_buffer: None,
1001            max_rows_per_page: None,
1002            connect_timeout: Duration::from_secs(10),
1003            page_request_timeout: Duration::from_secs(30),
1004            tls_ca_file: None,
1005            presign: Mutex::new(PresignMode::Auto),
1006            route_hint: RouteHintGenerator::new(),
1007            last_node_id: Default::default(),
1008            disable_session_token: true,
1009            disable_login: false,
1010            session_token_info: None,
1011            closed: Default::default(),
1012            last_query_id: Default::default(),
1013            server_version: None,
1014            capability: Default::default(),
1015        }
1016    }
1017}
1018
1019struct RouteHintGenerator {
1020    nonce: AtomicU64,
1021    current: std::sync::Mutex<String>,
1022}
1023
1024impl RouteHintGenerator {
1025    fn new() -> Self {
1026        let gen = Self {
1027            nonce: AtomicU64::new(0),
1028            current: std::sync::Mutex::new("".to_string()),
1029        };
1030        gen.next();
1031        gen
1032    }
1033
1034    fn current(&self) -> String {
1035        let guard = self.current.lock().unwrap();
1036        guard.clone()
1037    }
1038
1039    fn set(&self, hint: &str) {
1040        let mut guard = self.current.lock().unwrap();
1041        *guard = hint.to_string();
1042    }
1043
1044    fn next(&self) -> String {
1045        let nonce = self.nonce.fetch_add(1, Ordering::AcqRel);
1046        let uuid = uuid::Uuid::new_v4();
1047        let current = format!("rh:{uuid}:{nonce:06}");
1048        let mut guard = self.current.lock().unwrap();
1049        guard.clone_from(&current);
1050        current
1051    }
1052}
1053
1054#[cfg(test)]
1055mod test {
1056    use super::*;
1057
1058    #[tokio::test]
1059    async fn parse_dsn() -> Result<()> {
1060        let dsn = "databend://username:password@app.databend.com/test?wait_time_secs=10&max_rows_in_buffer=5000000&max_rows_per_page=10000&warehouse=wh&sslmode=disable";
1061        let client = APIClient::from_dsn(dsn).await?;
1062        assert_eq!(client.host, "app.databend.com");
1063        assert_eq!(client.endpoint, Url::parse("http://app.databend.com:80")?);
1064        assert_eq!(client.wait_time_secs, Some(10));
1065        assert_eq!(client.max_rows_in_buffer, Some(5000000));
1066        assert_eq!(client.max_rows_per_page, Some(10000));
1067        assert_eq!(client.tenant, None);
1068        assert_eq!(
1069            *client.warehouse.try_lock().unwrap(),
1070            Some("wh".to_string())
1071        );
1072        Ok(())
1073    }
1074
1075    #[tokio::test]
1076    async fn parse_encoded_password() -> Result<()> {
1077        let dsn = "databend://username:3a%40SC(nYE1k%3D%7B%7BR@localhost";
1078        let client = APIClient::from_dsn(dsn).await?;
1079        assert_eq!(client.host(), "localhost");
1080        assert_eq!(client.port(), 443);
1081        Ok(())
1082    }
1083
1084    #[tokio::test]
1085    async fn parse_special_chars_password() -> Result<()> {
1086        let dsn = "databend://username:3a@SC(nYE1k={{R@localhost:8000";
1087        let client = APIClient::from_dsn(dsn).await?;
1088        assert_eq!(client.host(), "localhost");
1089        assert_eq!(client.port(), 8000);
1090        Ok(())
1091    }
1092}
databend_client/client.rs

databend_client/
client.rs
