hiqlite 0.14.0

Hiqlite - highly-available, embeddable, raft-based SQLite + cache
Documentation 
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

use crate::app_state::{AppState, RaftType};
use crate::client::DbClient;
use crate::config::RateLimitConfig;
use crate::http_client::build_http_client;
use crate::{Client, Error, tls};
use std::sync::Arc;
use std::sync::atomic::{AtomicU32, AtomicUsize};
use tokio::sync::{RwLock, watch};

#[cfg(feature = "listen_notify")]
use crate::client::listen_notify::remote::RemoteListener;

#[cfg(feature = "sqlite")]
use crate::client::stream::ClientStreamReq;

const RATE_LIMIT_AWAIT_SIZE: usize = 64;

impl Client {
    /// Create a local client that skips network connections if not necessary
    #[allow(clippy::too_many_arguments)]
    pub(crate) async fn new_local(
        state: Arc<AppState>,
        tls_config: Option<Arc<rustls::ClientConfig>>,
        #[cfg(feature = "cache")] tls_no_verify: bool,
        #[cfg(feature = "sqlite")] tx_client_db: flume::Sender<ClientStreamReq>,
        #[cfg(feature = "sqlite")] rx_client_db: flume::Receiver<ClientStreamReq>,
        tx_shutdown: watch::Sender<bool>,
        #[cfg(feature = "cache")] rate_limit_cache: Option<RateLimitConfig>,
        #[cfg(feature = "sqlite")] rate_limit_db: Option<RateLimitConfig>,
    ) -> Self {
        let leader_id = state.id;
        let leader_addr = state.addr_api.clone();

        let secret = state.secret_api.as_bytes().to_vec();

        #[cfg(feature = "cache")]
        let leader_cache = Arc::new(RwLock::new((leader_id, leader_addr.clone())));
        #[cfg(feature = "sqlite")]
        let leader_db = Arc::new(RwLock::new((leader_id, leader_addr)));

        #[cfg(feature = "cache")]
        let (tx_client_cache, rx_client_cache) = flume::bounded(1);

        #[allow(unused_variables)]
        let (rate_limit_cache_await, rx_cache_await) =
            crossbeam::channel::bounded(RATE_LIMIT_AWAIT_SIZE);
        #[allow(unused_variables)]
        let (rate_limit_db_await, rx_db_await) = crossbeam::channel::bounded(RATE_LIMIT_AWAIT_SIZE);

        let db_client = DbClient {
            state: Some(state),
            #[cfg(feature = "cache")]
            leader_cache,
            #[cfg(feature = "sqlite")]
            leader_db,
            // TODO do we even still need this for a local client? -> all raft messages should use internal API ?
            nodes: Vec::default(),
            client: None,
            #[cfg(feature = "cache")]
            tx_client_cache,
            #[cfg(feature = "sqlite")]
            tx_client_db,
            tls_config,
            #[cfg(feature = "cache")]
            tls_no_verify,
            api_secret: None,
            request_id: AtomicUsize::new(0),
            tx_shutdown: Some(tx_shutdown),
            #[cfg(feature = "listen_notify_local")]
            app_start: chrono::Utc::now().timestamp_micros(),
            #[cfg(feature = "listen_notify_local")]
            rx_notify: None,
            #[cfg(feature = "cache")]
            rate_limit_cache: rate_limit_cache.as_ref().map(|c| AtomicU32::new(c.rps)),
            #[cfg(feature = "cache")]
            rate_limit_cache_await,
            #[cfg(feature = "sqlite")]
            rate_limit_db: rate_limit_db.as_ref().map(|c| AtomicU32::new(c.rps)),
            #[cfg(feature = "sqlite")]
            rate_limit_db_await,
        };

        let slf = Self {
            inner: Arc::new(db_client),
        };

        slf.find_set_active_leader().await;

        #[cfg(feature = "cache")]
        slf.open_stream(
            secret.clone(),
            slf.inner.leader_cache.clone(),
            rx_client_cache,
            RaftType::Cache,
        );
        #[cfg(feature = "sqlite")]
        slf.open_stream(
            secret,
            slf.inner.leader_db.clone(),
            rx_client_db,
            RaftType::Sqlite,
        );

        #[cfg(all(feature = "cache", feature = "sqlite"))]
        slf.spawn_rate_limit_ticker(rate_limit_cache, rate_limit_db, rx_cache_await, rx_db_await);
        #[cfg(all(feature = "cache", not(feature = "sqlite")))]
        slf.spawn_rate_limit_ticker(rate_limit_cache, None, rx_cache_await, rx_db_await);
        #[cfg(all(not(feature = "cache"), feature = "sqlite"))]
        slf.spawn_rate_limit_ticker(None, rate_limit_db, rx_cache_await, rx_db_await);

        slf
    }

    /// Manually create a remote client.
    ///
    /// Provide any nodes as address. As long as all nodes can be reached,
    /// leader changes will happen automatically.
    ///
    /// You never need to create the client yourself if your application embeds Hiqlite, as it will
    /// return a `Client` from `hiqlite::start_node()` or `hiqlite::start_node_with_cache()`.
    ///
    /// **Note:**
    /// If your client will be unable to reach all nodes, you can run the Hiqlite Server in proxy
    /// mode like mentioned in the [README](https://github.com/sebadob/hiqlite/blob/main/README.md).
    /// In this case, only provide the proxy's IP in the `nodes: Vec<String>`.
    #[allow(clippy::too_many_arguments)]
    pub async fn remote(
        nodes: Vec<String>,
        tls: bool,
        tls_no_verify: bool,
        api_secret: String,
        with_proxy: bool,
        #[cfg(feature = "cache")] rate_limit_cache: Option<RateLimitConfig>,
        #[cfg(feature = "sqlite")] rate_limit_db: Option<RateLimitConfig>,
    ) -> Result<Self, Error> {
        if nodes.is_empty() {
            return Err(Error::Config(
                "You must provide at least 1 node to connect to".into(),
            ));
        }

        let tls_config = if tls {
            Some(tls::build_tls_config(tls_no_verify))
        } else {
            None
        };

        // we just use this as a placeholder to be able to initialize the remote note
        let node_id = 0;
        let node_addr = nodes[0].clone();

        #[cfg(feature = "cache")]
        let leader_cache = Arc::new(RwLock::new((node_id, node_addr.clone())));
        #[cfg(feature = "sqlite")]
        let leader_db = Arc::new(RwLock::new((node_id, node_addr)));

        #[cfg(feature = "sqlite")]
        let (tx_client_db, rx_client_db) = flume::bounded(1);
        #[cfg(feature = "cache")]
        let (tx_client_cache, rx_client_cache) = flume::bounded(1);

        #[cfg(feature = "listen_notify")]
        let rx_notify = Some(RemoteListener::spawn(
            leader_cache.clone(),
            tls,
            api_secret.clone(),
        ));

        #[cfg(all(feature = "listen_notify_local", not(feature = "listen_notify")))]
        let rx_notify = None;

        #[allow(unused_variables)]
        let (rate_limit_cache_await, rx_cache_await) =
            crossbeam::channel::bounded(RATE_LIMIT_AWAIT_SIZE);
        #[allow(unused_variables)]
        let (rate_limit_db_await, rx_db_await) = crossbeam::channel::bounded(RATE_LIMIT_AWAIT_SIZE);

        let api_secret_bytes = api_secret.as_bytes().to_vec();

        let db_client = DbClient {
            state: None,
            #[cfg(feature = "sqlite")]
            leader_db,
            #[cfg(feature = "cache")]
            leader_cache,
            nodes,
            client: Some(build_http_client(tls_no_verify)),
            #[cfg(feature = "cache")]
            tx_client_cache,
            #[cfg(feature = "sqlite")]
            tx_client_db,
            tls_config,
            #[cfg(feature = "cache")]
            tls_no_verify,
            api_secret: Some(api_secret),
            request_id: AtomicUsize::new(0),
            tx_shutdown: None,
            #[cfg(feature = "listen_notify_local")]
            app_start: chrono::Utc::now().timestamp_micros(),
            #[cfg(feature = "listen_notify_local")]
            rx_notify,
            #[cfg(feature = "cache")]
            rate_limit_cache: rate_limit_cache.as_ref().map(|c| AtomicU32::new(c.rps)),
            #[cfg(feature = "cache")]
            rate_limit_cache_await,
            #[cfg(feature = "sqlite")]
            rate_limit_db: rate_limit_db.as_ref().map(|c| AtomicU32::new(c.rps)),
            #[cfg(feature = "sqlite")]
            rate_limit_db_await,
        };

        let slf = Self {
            inner: Arc::new(db_client),
        };

        // It should be enough to check for DB proxy here. When running, the forward to leader
        // errors should never be forwarded through the proxy.
        if !with_proxy {
            slf.find_set_active_leader().await;
        }

        #[cfg(feature = "cache")]
        slf.open_stream(
            api_secret_bytes.clone(),
            slf.inner.leader_cache.clone(),
            rx_client_cache,
            RaftType::Cache,
        );
        #[cfg(feature = "sqlite")]
        slf.open_stream(
            api_secret_bytes,
            slf.inner.leader_db.clone(),
            rx_client_db,
            RaftType::Sqlite,
        );

        #[cfg(all(feature = "cache", feature = "sqlite"))]
        slf.spawn_rate_limit_ticker(rate_limit_cache, rate_limit_db, rx_cache_await, rx_db_await);
        #[cfg(all(feature = "cache", not(feature = "sqlite")))]
        slf.spawn_rate_limit_ticker(rate_limit_cache, None, rx_cache_await, rx_db_await);
        #[cfg(all(not(feature = "cache"), feature = "sqlite"))]
        slf.spawn_rate_limit_ticker(None, rate_limit_db, rx_cache_await, rx_db_await);

        Ok(slf)
    }
}