-
Notifications
You must be signed in to change notification settings - Fork 23
Expand file tree
/
Copy pathpostgres_store.rs
More file actions
939 lines (840 loc) · 30.9 KB
/
postgres_store.rs
File metadata and controls
939 lines (840 loc) · 30.9 KB
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
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
use crate::migrations::*;
use api::error::VssError;
use api::kv_store::{KvStore, GLOBAL_VERSION_KEY, INITIAL_RECORD_VERSION};
use api::types::{
DeleteObjectRequest, DeleteObjectResponse, GetObjectRequest, GetObjectResponse, KeyValue,
ListKeyVersionsRequest, ListKeyVersionsResponse, PutObjectRequest, PutObjectResponse,
};
use async_trait::async_trait;
use bytes::Bytes;
use chrono::Utc;
use native_tls::TlsConnector;
use postgres_native_tls::MakeTlsConnector;
use std::cmp::min;
use std::io::{self, Error, ErrorKind};
use tokio::sync::Mutex;
use tokio_postgres::tls::{MakeTlsConnect, TlsConnect};
use tokio_postgres::{error, Client, NoTls, Socket, Transaction};
use log::{debug, info, warn};
pub use native_tls::Certificate;
pub(crate) struct VssDbRecord {
pub(crate) user_token: String,
pub(crate) store_id: String,
pub(crate) key: String,
pub(crate) value: Vec<u8>,
pub(crate) version: i64,
pub(crate) created_at: chrono::DateTime<Utc>,
pub(crate) last_updated_at: chrono::DateTime<Utc>,
}
const KEY_COLUMN: &str = "key";
const VALUE_COLUMN: &str = "value";
const VERSION_COLUMN: &str = "version";
const CREATED_AT_COLUMN: &str = "created_at";
/// Page token is encoded as 20-char zero-padded epoch microseconds followed by the key.
fn encode_page_token(created_at: &chrono::DateTime<Utc>, key: &str) -> String {
format!("{:020}{}", created_at.timestamp_micros(), key)
}
fn decode_page_token(token: &str) -> Result<(chrono::DateTime<Utc>, String), VssError> {
if token.len() < 20 {
return Err(VssError::InvalidRequestError("Invalid page token".to_string()));
}
let micros: i64 = token[..20]
.parse()
.map_err(|_| VssError::InvalidRequestError("Invalid page token".to_string()))?;
let created_at = chrono::DateTime::from_timestamp_micros(micros)
.ok_or_else(|| VssError::InvalidRequestError("Invalid page token".to_string()))?;
let key = token[20..].to_string();
Ok((created_at, key))
}
/// The maximum number of key versions that can be returned in a single page.
///
/// This constant helps control memory and bandwidth usage for list operations,
/// preventing overly large payloads. If the number of results exceeds this limit,
/// the response will be paginated.
pub const LIST_KEY_VERSIONS_MAX_PAGE_SIZE: i32 = 100;
/// The maximum number of items allowed in a single `PutObjectRequest`.
///
/// Setting an upper bound on the number of items helps ensure that
/// each request stays within acceptable memory and performance limits.
/// Exceeding this value will result in request rejection through [`VssError::InvalidRequestError`].
pub const MAX_PUT_REQUEST_ITEM_COUNT: usize = 1000;
const POOL_SIZE: usize = 10;
struct SmallPool<T> {
connections: [Mutex<Client>; POOL_SIZE],
endpoint: String,
db_name: String,
tls: T,
}
impl<T> SmallPool<T>
where
T: MakeTlsConnect<Socket> + Clone + Send + Sync + 'static,
T::Stream: Send + Sync,
T::TlsConnect: Send,
<<T as MakeTlsConnect<Socket>>::TlsConnect as TlsConnect<Socket>>::Future: Send,
{
async fn new(postgres_endpoint: &str, vss_db: &str, tls: T) -> Result<Self, Error> {
let connections = [
Mutex::new(make_db_connection(postgres_endpoint, vss_db, tls.clone()).await?),
Mutex::new(make_db_connection(postgres_endpoint, vss_db, tls.clone()).await?),
Mutex::new(make_db_connection(postgres_endpoint, vss_db, tls.clone()).await?),
Mutex::new(make_db_connection(postgres_endpoint, vss_db, tls.clone()).await?),
Mutex::new(make_db_connection(postgres_endpoint, vss_db, tls.clone()).await?),
Mutex::new(make_db_connection(postgres_endpoint, vss_db, tls.clone()).await?),
Mutex::new(make_db_connection(postgres_endpoint, vss_db, tls.clone()).await?),
Mutex::new(make_db_connection(postgres_endpoint, vss_db, tls.clone()).await?),
Mutex::new(make_db_connection(postgres_endpoint, vss_db, tls.clone()).await?),
Mutex::new(make_db_connection(postgres_endpoint, vss_db, tls.clone()).await?),
];
let pool = SmallPool {
connections,
endpoint: String::from(postgres_endpoint),
db_name: String::from(vss_db),
tls,
};
Ok(pool)
}
async fn get(&self) -> Result<tokio::sync::MutexGuard<'_, Client>, Error> {
let mut conn = tokio::select! {
conn_0 = self.connections[0].lock() => conn_0,
conn_1 = self.connections[1].lock() => conn_1,
conn_2 = self.connections[2].lock() => conn_2,
conn_3 = self.connections[3].lock() => conn_3,
conn_4 = self.connections[4].lock() => conn_4,
conn_5 = self.connections[5].lock() => conn_5,
conn_6 = self.connections[6].lock() => conn_6,
conn_7 = self.connections[7].lock() => conn_7,
conn_8 = self.connections[8].lock() => conn_8,
conn_9 = self.connections[9].lock() => conn_9,
};
self.ensure_connected(&mut conn).await?;
Ok(conn)
}
async fn ensure_connected(&self, client: &mut Client) -> Result<(), Error> {
if client.is_closed() || client.check_connection().await.is_err() {
debug!("Rotating connection to the postgres database");
let new_client =
make_db_connection(&self.endpoint, &self.db_name, self.tls.clone()).await?;
*client = new_client;
}
Ok(())
}
}
/// A [PostgreSQL](https://www.postgresql.org/) based backend implementation for VSS.
pub struct PostgresBackend<T>
where
T: MakeTlsConnect<Socket> + Clone + Send + Sync + 'static,
<T as MakeTlsConnect<Socket>>::Stream: Send + Sync,
<T as MakeTlsConnect<Socket>>::TlsConnect: Send,
<<T as MakeTlsConnect<Socket>>::TlsConnect as TlsConnect<Socket>>::Future: Send,
{
pool: SmallPool<T>,
}
/// A postgres backend with plaintext connections to the database
pub type PostgresPlaintextBackend = PostgresBackend<NoTls>;
/// A postgres backend with TLS connections to the database
pub type PostgresTlsBackend = PostgresBackend<MakeTlsConnector>;
async fn make_db_connection<T>(
postgres_endpoint: &str, db_name: &str, tls: T,
) -> Result<Client, Error>
where
T: MakeTlsConnect<Socket> + Clone + Send + Sync + 'static,
T::Stream: Send + Sync,
T::TlsConnect: Send,
<<T as MakeTlsConnect<Socket>>::TlsConnect as TlsConnect<Socket>>::Future: Send,
{
let dsn = format!("{}/{}", postgres_endpoint, db_name);
let (client, connection) = tokio_postgres::connect(&dsn, tls)
.await
.map_err(|e| Error::new(ErrorKind::Other, format!("Connection error: {}", e)))?;
// Connection must be driven on a separate task, and will resolve when the client is dropped
tokio::spawn(async move {
if let Err(e) = connection.await {
warn!("Connection error: {}", e);
}
});
Ok(client)
}
async fn create_database<T>(
postgres_endpoint: &str, default_db: &str, db_name: &str, tls: T,
) -> Result<(), Error>
where
T: MakeTlsConnect<Socket> + Clone + Send + Sync + 'static,
T::Stream: Send + Sync,
T::TlsConnect: Send,
<<T as MakeTlsConnect<Socket>>::TlsConnect as TlsConnect<Socket>>::Future: Send,
{
let client = make_db_connection(postgres_endpoint, default_db, tls).await?;
let num_rows = client.execute(CHECK_DB_STMT, &[&db_name]).await.map_err(|e| {
Error::new(
ErrorKind::Other,
format!("Failed to check presence of database {}: {}", db_name, e),
)
})?;
if num_rows == 0 {
let stmt = format!("{} {};", INIT_DB_CMD, db_name);
client.execute(&stmt, &[]).await.map_err(|e| {
Error::new(ErrorKind::Other, format!("Failed to create database {}: {}", db_name, e))
})?;
info!("Created database {}", db_name);
}
Ok(())
}
#[cfg(test)]
async fn drop_database<T>(
postgres_endpoint: &str, default_db: &str, db_name: &str, tls: T,
) -> Result<(), Error>
where
T: MakeTlsConnect<Socket> + Clone + Send + Sync + 'static,
T::Stream: Send + Sync,
T::TlsConnect: Send,
<<T as MakeTlsConnect<Socket>>::TlsConnect as TlsConnect<Socket>>::Future: Send,
{
let client = make_db_connection(postgres_endpoint, default_db, tls).await?;
let drop_database_statement = format!("{} {};", DROP_DB_CMD, db_name);
let num_rows = client.execute(&drop_database_statement, &[]).await.map_err(|e| {
Error::new(ErrorKind::Other, format!("Failed to drop database {}: {}", db_name, e))
})?;
assert_eq!(num_rows, 0);
Ok(())
}
impl PostgresPlaintextBackend {
/// Constructs a [`PostgresPlaintextBackend`] using `postgres_endpoint` for PostgreSQL connection information.
pub async fn new(
postgres_endpoint: &str, default_db: &str, vss_db: &str,
) -> Result<Self, Error> {
PostgresBackend::new_internal(postgres_endpoint, default_db, vss_db, NoTls).await
}
}
impl PostgresTlsBackend {
/// Constructs a [`PostgresTlsBackend`] using `postgres_endpoint` for PostgreSQL connection information.
pub async fn new(
postgres_endpoint: &str, default_db: &str, vss_db: &str, crt_pem: Option<&str>,
) -> Result<Self, Error> {
let mut builder = TlsConnector::builder();
if let Some(pem) = crt_pem {
let crt = Certificate::from_pem(pem.as_bytes()).map_err(|e| {
Error::new(
ErrorKind::Other,
format!("Failed to parse the PEM formatted certificate: {}", e),
)
})?;
builder.add_root_certificate(crt);
}
let connector = builder.build().map_err(|e| {
Error::new(ErrorKind::Other, format!("Error building tls connector: {}", e))
})?;
PostgresBackend::new_internal(
postgres_endpoint,
default_db,
vss_db,
MakeTlsConnector::new(connector),
)
.await
}
}
impl<T> PostgresBackend<T>
where
T: MakeTlsConnect<Socket> + Clone + Send + Sync + 'static,
T::Stream: Send + Sync,
T::TlsConnect: Send,
<<T as MakeTlsConnect<Socket>>::TlsConnect as TlsConnect<Socket>>::Future: Send,
{
async fn new_internal(
postgres_endpoint: &str, default_db: &str, vss_db: &str, tls: T,
) -> Result<Self, Error> {
create_database(postgres_endpoint, default_db, vss_db, tls.clone()).await?;
let pool = SmallPool::new(postgres_endpoint, vss_db, tls).await?;
let postgres_backend = PostgresBackend { pool };
#[cfg(not(test))]
postgres_backend.migrate_vss_database(MIGRATIONS).await?;
Ok(postgres_backend)
}
async fn migrate_vss_database(&self, migrations: &[&str]) -> Result<(usize, usize), Error> {
let mut conn = self.pool.get().await?;
// Get the next migration to be applied.
let migration_start = match conn.query_one(GET_VERSION_STMT, &[]).await {
Ok(row) => {
let i: i32 = row.get(DB_VERSION_COLUMN);
usize::try_from(i).expect("The column should always contain unsigned integers")
},
Err(e) => {
// If the table is not defined, start at migration 0
if let Some(&error::SqlState::UNDEFINED_TABLE) = e.code() {
0
} else {
return Err(Error::new(
ErrorKind::Other,
format!("Failed to query the version of the database schema: {}", e),
));
}
},
};
let tx = conn
.transaction()
.await
.map_err(|e| Error::new(ErrorKind::Other, format!("Transaction start error: {}", e)))?;
if migration_start == migrations.len() {
// No migrations needed, we are done
return Ok((migration_start, migrations.len()));
} else if migration_start > migrations.len() {
panic!("We do not allow downgrades");
}
info!("Applying migration(s) {} through {}", migration_start, migrations.len() - 1);
for (idx, &stmt) in (&migrations[migration_start..]).iter().enumerate() {
let _num_rows = tx.execute(stmt, &[]).await.map_err(|e| {
Error::new(
ErrorKind::Other,
format!(
"Database migration no {} with stmt {} failed: {}",
migration_start + idx,
stmt,
e
),
)
})?;
}
let num_rows = tx
.execute(
LOG_MIGRATION_STMT,
&[&i32::try_from(migration_start).expect("Read from an i32 further above")],
)
.await
.map_err(|e| {
Error::new(ErrorKind::Other, format!("Failed to log database migration: {}", e))
})?;
assert_eq!(num_rows, 1, "LOG_MIGRATION_STMT should only add one row at a time");
let next_migration_start =
i32::try_from(migrations.len()).expect("Length is definitely smaller than i32::MAX");
let num_rows =
tx.execute(UPDATE_VERSION_STMT, &[&next_migration_start]).await.map_err(|e| {
Error::new(
ErrorKind::Other,
format!("Failed to update the version of the schema: {}", e),
)
})?;
assert_eq!(
num_rows, 1,
"UPDATE_VERSION_STMT should only update the unique row in the version table"
);
tx.commit().await.map_err(|e| {
Error::new(ErrorKind::Other, format!("Transaction commit error: {}", e))
})?;
Ok((migration_start, migrations.len()))
}
#[cfg(test)]
async fn get_schema_version(&self) -> usize {
let conn = self.pool.get().await.unwrap();
let row = conn.query_one(GET_VERSION_STMT, &[]).await.unwrap();
usize::try_from(row.get::<&str, i32>(DB_VERSION_COLUMN)).unwrap()
}
#[cfg(test)]
async fn get_upgrades_list(&self) -> Vec<usize> {
let conn = self.pool.get().await.unwrap();
let rows = conn.query(GET_MIGRATION_LOG_STMT, &[]).await.unwrap();
rows.iter()
.map(|row| usize::try_from(row.get::<&str, i32>(MIGRATION_LOG_COLUMN)).unwrap())
.collect()
}
fn build_vss_record(&self, user_token: String, store_id: String, kv: KeyValue) -> VssDbRecord {
let now = Utc::now();
VssDbRecord {
user_token,
store_id,
key: kv.key,
value: kv.value.to_vec(),
version: kv.version,
created_at: now,
last_updated_at: now,
}
}
async fn execute_non_conditional_upsert(
&self, transaction: &Transaction<'_>, vss_record: &VssDbRecord,
) -> io::Result<u64> {
let stmt = format!("INSERT INTO vss_db (user_token, store_id, key, value, version, created_at, last_updated_at)
VALUES ($1, $2, $3, $4, {}, $5, $6)
ON CONFLICT (user_token, store_id, key) DO UPDATE
SET value = EXCLUDED.value, version = {}, last_updated_at = EXCLUDED.last_updated_at", INITIAL_RECORD_VERSION, INITIAL_RECORD_VERSION);
let num_rows = transaction
.execute(
&stmt,
&[
&vss_record.user_token,
&vss_record.store_id,
&vss_record.key,
&vss_record.value,
&vss_record.created_at,
&vss_record.last_updated_at,
],
)
.await
.map_err(|e| {
Error::new(ErrorKind::Other, format!("Database operation failed. {}", e))
})?;
Ok(num_rows)
}
async fn execute_conditional_insert(
&self, transaction: &Transaction<'_>, vss_record: &VssDbRecord,
) -> io::Result<u64> {
let stmt = format!("INSERT INTO vss_db (user_token, store_id, key, value, version, created_at, last_updated_at)
VALUES ($1, $2, $3, $4, {}, $5, $6)
ON CONFLICT DO NOTHING", INITIAL_RECORD_VERSION);
let num_rows = transaction
.execute(
&stmt,
&[
&vss_record.user_token,
&vss_record.store_id,
&vss_record.key,
&vss_record.value,
&vss_record.created_at,
&vss_record.last_updated_at,
],
)
.await
.map_err(|e| {
Error::new(ErrorKind::Other, format!("Database operation failed. {}", e))
})?;
Ok(num_rows)
}
async fn execute_conditional_update(
&self, transaction: &Transaction<'_>, vss_record: &VssDbRecord,
) -> io::Result<u64> {
let stmt = "UPDATE vss_db SET value = $1, version = $2, last_updated_at = $3
WHERE user_token = $4 AND store_id = $5 AND key = $6 AND version = $7";
let num_rows = transaction
.execute(
stmt,
&[
&vss_record.value,
&vss_record.version.saturating_add(1),
&vss_record.last_updated_at,
&vss_record.user_token,
&vss_record.store_id,
&vss_record.key,
&vss_record.version,
],
)
.await
.map_err(|e| {
Error::new(ErrorKind::Other, format!("Database operation failed. {}", e))
})?;
Ok(num_rows)
}
async fn execute_put_object_query(
&self, transaction: &Transaction<'_>, vss_record: &VssDbRecord,
) -> io::Result<u64> {
if vss_record.version == -1 {
self.execute_non_conditional_upsert(transaction, vss_record).await
} else if vss_record.version == 0 {
self.execute_conditional_insert(transaction, vss_record).await
} else {
self.execute_conditional_update(transaction, vss_record).await
}
}
async fn execute_non_conditional_delete(
&self, transaction: &Transaction<'_>, vss_record: &VssDbRecord,
) -> io::Result<u64> {
let stmt = "DELETE FROM vss_db WHERE user_token = $1 AND store_id = $2 AND key = $3";
let num_rows = transaction
.execute(stmt, &[&vss_record.user_token, &vss_record.store_id, &vss_record.key])
.await
.map_err(|e| {
Error::new(ErrorKind::Other, format!("Database operation failed. {}", e))
})?;
Ok(num_rows)
}
async fn execute_conditional_delete(
&self, transaction: &Transaction<'_>, vss_record: &VssDbRecord,
) -> io::Result<u64> {
let stmt = "DELETE FROM vss_db WHERE user_token = $1 AND store_id = $2 AND key = $3 AND version = $4";
let num_rows = transaction
.execute(
stmt,
&[
&vss_record.user_token,
&vss_record.store_id,
&vss_record.key,
&vss_record.version,
],
)
.await
.map_err(|e| {
Error::new(ErrorKind::Other, format!("Database operation failed. {}", e))
})?;
Ok(num_rows)
}
async fn execute_delete_object_query(
&self, transaction: &Transaction<'_>, vss_record: &VssDbRecord,
) -> io::Result<u64> {
if vss_record.version == -1 {
self.execute_non_conditional_delete(transaction, vss_record).await
} else {
self.execute_conditional_delete(transaction, vss_record).await
}
}
}
#[async_trait]
impl<T> KvStore for PostgresBackend<T>
where
T: MakeTlsConnect<Socket> + Clone + Send + Sync + 'static,
T::Stream: Send + Sync,
T::TlsConnect: Send,
<T::TlsConnect as TlsConnect<Socket>>::Future: Send,
{
async fn get(
&self, user_token: String, request: GetObjectRequest,
) -> Result<GetObjectResponse, VssError> {
let conn = self.pool.get().await?;
let stmt = "SELECT key, value, version FROM vss_db WHERE user_token = $1 AND store_id = $2 AND key = $3";
let row = conn
.query_opt(stmt, &[&user_token, &request.store_id, &request.key])
.await
.map_err(|e| Error::new(ErrorKind::Other, format!("Query error: {}", e)))?;
let key_value = if let Some(row) = row {
KeyValue {
key: row.get(KEY_COLUMN),
value: Bytes::from(row.get::<_, Vec<u8>>(VALUE_COLUMN)),
version: row.get(VERSION_COLUMN),
}
} else if request.key == GLOBAL_VERSION_KEY {
KeyValue { key: GLOBAL_VERSION_KEY.to_string(), value: Bytes::new(), version: 0 }
} else {
return Err(VssError::NoSuchKeyError("Requested key not found.".to_string()));
};
Ok(GetObjectResponse { value: Some(key_value) })
}
async fn put(
&self, user_token: String, request: PutObjectRequest,
) -> Result<PutObjectResponse, VssError> {
let store_id = request.store_id;
if request.transaction_items.len() + request.delete_items.len() > MAX_PUT_REQUEST_ITEM_COUNT
{
return Err(VssError::InvalidRequestError(format!(
"Number of write items per request should be less than equal to {}",
MAX_PUT_REQUEST_ITEM_COUNT
)));
}
let mut vss_put_records: Vec<VssDbRecord> = request
.transaction_items
.into_iter()
.map(|kv| self.build_vss_record(user_token.to_string(), store_id.to_string(), kv))
.collect();
let vss_delete_records: Vec<VssDbRecord> = request
.delete_items
.into_iter()
.map(|kv| self.build_vss_record(user_token.to_string(), store_id.to_string(), kv))
.collect();
if let Some(global_version) = request.global_version {
let global_version_record = self.build_vss_record(
user_token,
store_id,
KeyValue {
key: GLOBAL_VERSION_KEY.to_string(),
value: Bytes::new(),
version: global_version,
},
);
vss_put_records.push(global_version_record);
}
let mut conn = self.pool.get().await?;
let transaction = conn
.transaction()
.await
.map_err(|e| Error::new(ErrorKind::Other, format!("Transaction start error: {}", e)))?;
let mut batch_results = Vec::new();
for vss_record in &vss_put_records {
let num_rows = self.execute_put_object_query(&transaction, vss_record).await?;
batch_results.push(num_rows);
}
for vss_record in &vss_delete_records {
let num_rows = self.execute_delete_object_query(&transaction, vss_record).await?;
batch_results.push(num_rows);
}
for num_rows in batch_results {
if num_rows == 0 {
transaction.rollback().await.map_err(|e| {
Error::new(ErrorKind::Other, format!("Transaction rollback error: {}", e))
})?;
return Err(VssError::ConflictError(
"Transaction could not be completed due to a possible conflict".to_string(),
));
}
}
transaction.commit().await.map_err(|e| {
Error::new(ErrorKind::Other, format!("Transaction commit error: {}", e))
})?;
Ok(PutObjectResponse {})
}
async fn delete(
&self, user_token: String, request: DeleteObjectRequest,
) -> Result<DeleteObjectResponse, VssError> {
let store_id = request.store_id;
let key_value = request.key_value.ok_or_else(|| {
VssError::InvalidRequestError("key_value missing in DeleteObjectRequest".to_string())
})?;
let vss_record = self.build_vss_record(user_token, store_id, key_value);
let mut conn = self.pool.get().await?;
let transaction = conn
.transaction()
.await
.map_err(|e| Error::new(ErrorKind::Other, format!("Transaction start error: {}", e)))?;
let num_rows = self.execute_delete_object_query(&transaction, &vss_record).await?;
if num_rows == 0 {
transaction.rollback().await.map_err(|e| {
Error::new(ErrorKind::Other, format!("Transaction rollback error: {}", e))
})?;
return Ok(DeleteObjectResponse {});
}
transaction.commit().await.map_err(|e| {
Error::new(ErrorKind::Other, format!("Transaction commit error: {}", e))
})?;
Ok(DeleteObjectResponse {})
}
async fn list_key_versions(
&self, user_token: String, request: ListKeyVersionsRequest,
) -> Result<ListKeyVersionsResponse, VssError> {
let store_id = &request.store_id;
let key_prefix = &request.key_prefix;
let page_token = &request.page_token;
let page_size = request.page_size.unwrap_or(i32::MAX);
// Only fetch global_version for first page.
// Fetch global_version before fetching any key_versions to ensure that,
// all current key_versions were stored at global_version or later.
let mut global_version = None;
if page_token.is_none() {
let get_global_version_request = GetObjectRequest {
store_id: store_id.to_string(),
key: GLOBAL_VERSION_KEY.to_string(),
};
let get_response = self.get(user_token.clone(), get_global_version_request).await?;
// unwrap safety: get request always return a value when global_version is queried.
global_version = Some(get_response.value.unwrap().version);
}
let limit = min(page_size, LIST_KEY_VERSIONS_MAX_PAGE_SIZE) as i64;
let conn = self.pool.get().await?;
let key_like = format!("{}%", key_prefix.as_deref().unwrap_or_default());
let rows = if let Some(ref token) = page_token {
let (page_created_at, page_key) = decode_page_token(token)?;
let stmt = "SELECT key, version, created_at FROM vss_db WHERE user_token = $1 AND store_id = $2 AND (created_at, key) > ($3, $4) AND key LIKE $5 ORDER BY created_at, key LIMIT $6";
let params: Vec<&(dyn tokio_postgres::types::ToSql + Sync)> =
vec![&user_token, &store_id, &page_created_at, &page_key, &key_like, &limit];
conn.query(stmt, ¶ms)
.await
.map_err(|e| Error::new(ErrorKind::Other, format!("Query error: {}", e)))?
} else {
let stmt = "SELECT key, version, created_at FROM vss_db WHERE user_token = $1 AND store_id = $2 AND key LIKE $3 ORDER BY created_at, key LIMIT $4";
let params: Vec<&(dyn tokio_postgres::types::ToSql + Sync)> =
vec![&user_token, &store_id, &key_like, &limit];
conn.query(stmt, ¶ms)
.await
.map_err(|e| Error::new(ErrorKind::Other, format!("Query error: {}", e)))?
};
let key_versions: Vec<_> = rows
.iter()
.filter(|&row| row.get::<&str, &str>(KEY_COLUMN) != GLOBAL_VERSION_KEY)
.map(|row| KeyValue {
key: row.get(KEY_COLUMN),
value: Bytes::new(),
version: row.get(VERSION_COLUMN),
})
.collect();
let mut next_page_token = Some("".to_string());
if let Some(last_kv) = key_versions.last() {
let last_created_at =
rows[rows.len() - 1].get::<&str, chrono::DateTime<Utc>>(CREATED_AT_COLUMN);
next_page_token = Some(encode_page_token(&last_created_at, &last_kv.key));
}
Ok(ListKeyVersionsResponse { key_versions, next_page_token, global_version })
}
}
#[cfg(test)]
mod tests {
use super::{decode_page_token, drop_database, encode_page_token, DUMMY_MIGRATION, MIGRATIONS};
use crate::postgres_store::PostgresPlaintextBackend;
use api::define_kv_store_tests;
use api::kv_store::KvStore;
use api::types::{DeleteObjectRequest, GetObjectRequest, KeyValue, PutObjectRequest};
use chrono::{TimeZone, Utc as ChronoUtc};
use bytes::Bytes;
use tokio::sync::OnceCell;
use tokio_postgres::NoTls;
const POSTGRES_ENDPOINT: &str = "postgresql://postgres:postgres@localhost:5432";
const DEFAULT_DB: &str = "postgres";
const MIGRATIONS_START: usize = 0;
const MIGRATIONS_END: usize = MIGRATIONS.len();
static START: OnceCell<()> = OnceCell::const_new();
define_kv_store_tests!(PostgresKvStoreTest, PostgresPlaintextBackend, {
let vss_db = "postgres_kv_store_tests";
START
.get_or_init(|| async {
let _ = drop_database(POSTGRES_ENDPOINT, DEFAULT_DB, vss_db, NoTls).await;
let store = PostgresPlaintextBackend::new(POSTGRES_ENDPOINT, DEFAULT_DB, vss_db)
.await
.unwrap();
let (start, end) = store.migrate_vss_database(MIGRATIONS).await.unwrap();
assert_eq!(start, MIGRATIONS_START);
assert_eq!(end, MIGRATIONS_END);
})
.await;
let store =
PostgresPlaintextBackend::new(POSTGRES_ENDPOINT, DEFAULT_DB, vss_db).await.unwrap();
let (start, end) = store.migrate_vss_database(MIGRATIONS).await.unwrap();
assert_eq!(start, MIGRATIONS_END);
assert_eq!(end, MIGRATIONS_END);
assert_eq!(store.get_upgrades_list().await, [MIGRATIONS_START]);
assert_eq!(store.get_schema_version().await, MIGRATIONS_END);
store
});
#[tokio::test]
#[should_panic(expected = "We do not allow downgrades")]
async fn panic_on_downgrade() {
let vss_db = "panic_on_downgrade_test";
let _ = drop_database(POSTGRES_ENDPOINT, DEFAULT_DB, vss_db, NoTls).await;
{
let mut migrations = MIGRATIONS.to_vec();
migrations.push(DUMMY_MIGRATION);
let store =
PostgresPlaintextBackend::new(POSTGRES_ENDPOINT, DEFAULT_DB, vss_db).await.unwrap();
let (start, end) = store.migrate_vss_database(&migrations).await.unwrap();
assert_eq!(start, MIGRATIONS_START);
assert_eq!(end, MIGRATIONS_END + 1);
};
{
let store =
PostgresPlaintextBackend::new(POSTGRES_ENDPOINT, DEFAULT_DB, vss_db).await.unwrap();
let _ = store.migrate_vss_database(MIGRATIONS).await.unwrap();
};
}
#[tokio::test]
async fn new_migrations_increments_upgrades() {
let vss_db = "new_migrations_increments_upgrades_test";
let _ = drop_database(POSTGRES_ENDPOINT, DEFAULT_DB, vss_db, NoTls).await;
{
let store =
PostgresPlaintextBackend::new(POSTGRES_ENDPOINT, DEFAULT_DB, vss_db).await.unwrap();
let (start, end) = store.migrate_vss_database(MIGRATIONS).await.unwrap();
assert_eq!(start, MIGRATIONS_START);
assert_eq!(end, MIGRATIONS_END);
assert_eq!(store.get_upgrades_list().await, [MIGRATIONS_START]);
assert_eq!(store.get_schema_version().await, MIGRATIONS_END);
};
{
let store =
PostgresPlaintextBackend::new(POSTGRES_ENDPOINT, DEFAULT_DB, vss_db).await.unwrap();
let (start, end) = store.migrate_vss_database(MIGRATIONS).await.unwrap();
assert_eq!(start, MIGRATIONS_END);
assert_eq!(end, MIGRATIONS_END);
assert_eq!(store.get_upgrades_list().await, [MIGRATIONS_START]);
assert_eq!(store.get_schema_version().await, MIGRATIONS_END);
};
let mut migrations = MIGRATIONS.to_vec();
migrations.push(DUMMY_MIGRATION);
{
let store =
PostgresPlaintextBackend::new(POSTGRES_ENDPOINT, DEFAULT_DB, vss_db).await.unwrap();
let (start, end) = store.migrate_vss_database(&migrations).await.unwrap();
assert_eq!(start, MIGRATIONS_END);
assert_eq!(end, MIGRATIONS_END + 1);
assert_eq!(store.get_upgrades_list().await, [MIGRATIONS_START, MIGRATIONS_END]);
assert_eq!(store.get_schema_version().await, MIGRATIONS_END + 1);
};
migrations.push(DUMMY_MIGRATION);
migrations.push(DUMMY_MIGRATION);
{
let store =
PostgresPlaintextBackend::new(POSTGRES_ENDPOINT, DEFAULT_DB, vss_db).await.unwrap();
let (start, end) = store.migrate_vss_database(&migrations).await.unwrap();
assert_eq!(start, MIGRATIONS_END + 1);
assert_eq!(end, MIGRATIONS_END + 3);
assert_eq!(
store.get_upgrades_list().await,
[MIGRATIONS_START, MIGRATIONS_END, MIGRATIONS_END + 1]
);
assert_eq!(store.get_schema_version().await, MIGRATIONS_END + 3);
};
{
let store =
PostgresPlaintextBackend::new(POSTGRES_ENDPOINT, DEFAULT_DB, vss_db).await.unwrap();
let list = store.get_upgrades_list().await;
assert_eq!(list, [MIGRATIONS_START, MIGRATIONS_END, MIGRATIONS_END + 1]);
let version = store.get_schema_version().await;
assert_eq!(version, MIGRATIONS_END + 3);
}
drop_database(POSTGRES_ENDPOINT, DEFAULT_DB, vss_db, NoTls).await.unwrap();
}
#[tokio::test]
async fn supports_objects_up_to_non_large_object_threshold() {
let vss_db = "supports_objects_up_to_non_large_object_threshold";
let _ = drop_database(POSTGRES_ENDPOINT, DEFAULT_DB, vss_db, NoTls).await;
const MAXIMUM_SUPPORTED_VALUE_SIZE: usize = 1024 * 1024 * 1024;
const PROTOCOL_OVERHEAD_MARGIN: usize = 150;
// Construct entry that's for a field that's the maximum size of a non-"large_object" object
let large_value = vec![0u8; MAXIMUM_SUPPORTED_VALUE_SIZE - PROTOCOL_OVERHEAD_MARGIN];
let kv = KeyValue { key: "k1".into(), version: 0, value: Bytes::from(large_value.clone()) };
{
let store =
PostgresPlaintextBackend::new(POSTGRES_ENDPOINT, DEFAULT_DB, vss_db).await.unwrap();
let (start, end) = store.migrate_vss_database(MIGRATIONS).await.unwrap();
assert_eq!(start, MIGRATIONS_START);
assert_eq!(end, MIGRATIONS_END);
assert_eq!(store.get_upgrades_list().await, [MIGRATIONS_START]);
assert_eq!(store.get_schema_version().await, MIGRATIONS_END);
// Round trip with non-large_object of threshold size
store
.put(
"token".to_string(),
PutObjectRequest {
store_id: "store_id".to_string(),
global_version: None,
transaction_items: vec![kv],
delete_items: vec![],
},
)
.await
.unwrap();
let resp_kv = store
.get(
"token".to_string(),
GetObjectRequest { store_id: "store_id".to_string(), key: "k1".to_string() },
)
.await
.unwrap()
.value
.unwrap();
assert_eq!(
resp_kv.value.len(),
MAXIMUM_SUPPORTED_VALUE_SIZE - PROTOCOL_OVERHEAD_MARGIN
);
assert_eq!(resp_kv.value, large_value);
store
.delete(
"token".to_string(),
DeleteObjectRequest {
store_id: "store_id".to_string(),
key_value: Some(resp_kv),
},
)
.await
.unwrap();
};
drop_database(POSTGRES_ENDPOINT, DEFAULT_DB, vss_db, NoTls).await.unwrap();
}
#[test]
fn page_token_roundtrips() {
let created_at = ChronoUtc.with_ymd_and_hms(2026, 3, 15, 12, 30, 45).unwrap();
let key = "some/test/key";
let token = encode_page_token(&created_at, key);
let (decoded_time, decoded_key) = decode_page_token(&token).unwrap();
assert_eq!(decoded_time, created_at);
assert_eq!(decoded_key, key);
}
#[test]
fn page_token_rejects_short_input() {
assert!(decode_page_token("tooshort").is_err());
assert!(decode_page_token("").is_err());
}
#[test]
fn page_token_rejects_non_numeric_prefix() {
assert!(decode_page_token("abcdefghijklmnopqrstkey").is_err());
}
}