-
Notifications
You must be signed in to change notification settings - Fork 44
Expand file tree
/
Copy pathlib.rs
More file actions
1325 lines (1228 loc) · 45 KB
/
lib.rs
File metadata and controls
1325 lines (1228 loc) · 45 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
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
//! # libsql-js
//!
//! A wrapper around the libSQL library for use in Node, Bun, and Deno.
//!
//! ## Design
//!
//! This JavaScript API is designed to be a drop-in replacement for `better-sqlite3`
//! with an opt-in async variant of the API.
//!
//! The API has two main classes: `Database` and `Statement`. The `Database` class
//! is a wrapper around libSQL `Database` and `Connection` structs whereas the
//! `Statement` class is a wrapper around libSQL `Statement` struct.
//!
//! As the `libsql` crate is async, the core of `libsql-js` is also implemented as such.
//! To support the synchronous semantics of `better-sqlite3`, the native API exposes
//! functions that are synchronous and block the event loop using Tokio's runtime. However,
//! the `promise` API module returns promises using `napi-rs` `Env::execute_tokio_future`.
#![deny(clippy::all)]
#![allow(non_snake_case)]
#![allow(deprecated)]
mod auth;
use napi::{
bindgen_prelude::{Array, FromNapiValue, ToNapiValue},
Env, JsUnknown, Result, ValueType,
};
use napi_derive::napi;
use once_cell::sync::OnceCell;
use std::{
str::FromStr,
sync::{
atomic::{AtomicBool, Ordering},
Arc,
},
time::Duration,
};
use tokio::runtime::Runtime;
use tracing_subscriber::{filter::LevelFilter, EnvFilter};
struct Error(libsql::Error);
impl From<Error> for napi::Error {
fn from(error: Error) -> Self {
use libsql::Error as E;
match &error.0 {
E::SqliteFailure(raw_code, msg) => {
let code = map_sqlite_code(*raw_code);
if *raw_code == libsql::ffi::SQLITE_AUTH {
let err_json = serde_json::json!({
"message": "Authorization denied by JS authorizer",
"libsqlError": true,
"code": code,
"rawCode": *raw_code
});
napi::Error::from_reason(err_json.to_string())
} else {
throw_sqlite_error(msg.clone(), code, *raw_code)
}
}
other => {
let err_json = serde_json::json!({
"message": other.to_string(),
"libsqlError": true,
"code": "SQLITE_ERROR",
"rawCode": 1
});
napi::Error::from_reason(err_json.to_string())
}
}
}
}
fn map_sqlite_code(code: i32) -> String {
match code {
libsql::ffi::SQLITE_OK => "SQLITE_OK".to_owned(),
libsql::ffi::SQLITE_ERROR => "SQLITE_ERROR".to_owned(),
libsql::ffi::SQLITE_INTERNAL => "SQLITE_INTERNAL".to_owned(),
libsql::ffi::SQLITE_PERM => "SQLITE_PERM".to_owned(),
libsql::ffi::SQLITE_ABORT => "SQLITE_ABORT".to_owned(),
libsql::ffi::SQLITE_BUSY => "SQLITE_BUSY".to_owned(),
libsql::ffi::SQLITE_LOCKED => "SQLITE_LOCKED".to_owned(),
libsql::ffi::SQLITE_NOMEM => "SQLITE_NOMEM".to_owned(),
libsql::ffi::SQLITE_READONLY => "SQLITE_READONLY".to_owned(),
libsql::ffi::SQLITE_INTERRUPT => "SQLITE_INTERRUPT".to_owned(),
libsql::ffi::SQLITE_IOERR => "SQLITE_IOERR".to_owned(),
libsql::ffi::SQLITE_CORRUPT => "SQLITE_CORRUPT".to_owned(),
libsql::ffi::SQLITE_NOTFOUND => "SQLITE_NOTFOUND".to_owned(),
libsql::ffi::SQLITE_FULL => "SQLITE_FULL".to_owned(),
libsql::ffi::SQLITE_CANTOPEN => "SQLITE_CANTOPEN".to_owned(),
libsql::ffi::SQLITE_PROTOCOL => "SQLITE_PROTOCOL".to_owned(),
libsql::ffi::SQLITE_EMPTY => "SQLITE_EMPTY".to_owned(),
libsql::ffi::SQLITE_SCHEMA => "SQLITE_SCHEMA".to_owned(),
libsql::ffi::SQLITE_TOOBIG => "SQLITE_TOOBIG".to_owned(),
libsql::ffi::SQLITE_CONSTRAINT => "SQLITE_CONSTRAINT".to_owned(),
libsql::ffi::SQLITE_MISMATCH => "SQLITE_MISMATCH".to_owned(),
libsql::ffi::SQLITE_MISUSE => "SQLITE_MISUSE".to_owned(),
libsql::ffi::SQLITE_NOLFS => "SQLITE_NOLFS".to_owned(),
libsql::ffi::SQLITE_AUTH => "SQLITE_AUTH".to_owned(),
libsql::ffi::SQLITE_FORMAT => "SQLITE_FORMAT".to_owned(),
libsql::ffi::SQLITE_RANGE => "SQLITE_RANGE".to_owned(),
libsql::ffi::SQLITE_NOTADB => "SQLITE_NOTADB".to_owned(),
libsql::ffi::SQLITE_NOTICE => "SQLITE_NOTICE".to_owned(),
libsql::ffi::SQLITE_WARNING => "SQLITE_WARNING".to_owned(),
libsql::ffi::SQLITE_ROW => "SQLITE_ROW".to_owned(),
libsql::ffi::SQLITE_DONE => "SQLITE_DONE".to_owned(),
libsql::ffi::SQLITE_IOERR_READ => "SQLITE_IOERR_READ".to_owned(),
libsql::ffi::SQLITE_IOERR_SHORT_READ => "SQLITE_IOERR_SHORT_READ".to_owned(),
libsql::ffi::SQLITE_IOERR_WRITE => "SQLITE_IOERR_WRITE".to_owned(),
libsql::ffi::SQLITE_IOERR_FSYNC => "SQLITE_IOERR_FSYNC".to_owned(),
libsql::ffi::SQLITE_IOERR_DIR_FSYNC => "SQLITE_IOERR_DIR_FSYNC".to_owned(),
libsql::ffi::SQLITE_IOERR_TRUNCATE => "SQLITE_IOERR_TRUNCATE".to_owned(),
libsql::ffi::SQLITE_IOERR_FSTAT => "SQLITE_IOERR_FSTAT".to_owned(),
libsql::ffi::SQLITE_IOERR_UNLOCK => "SQLITE_IOERR_UNLOCK".to_owned(),
libsql::ffi::SQLITE_IOERR_RDLOCK => "SQLITE_IOERR_RDLOCK".to_owned(),
libsql::ffi::SQLITE_IOERR_DELETE => "SQLITE_IOERR_DELETE".to_owned(),
libsql::ffi::SQLITE_IOERR_BLOCKED => "SQLITE_IOERR_BLOCKED".to_owned(),
libsql::ffi::SQLITE_IOERR_NOMEM => "SQLITE_IOERR_NOMEM".to_owned(),
libsql::ffi::SQLITE_IOERR_ACCESS => "SQLITE_IOERR_ACCESS".to_owned(),
libsql::ffi::SQLITE_IOERR_CHECKRESERVEDLOCK => "SQLITE_IOERR_CHECKRESERVEDLOCK".to_owned(),
libsql::ffi::SQLITE_IOERR_LOCK => "SQLITE_IOERR_LOCK".to_owned(),
libsql::ffi::SQLITE_IOERR_CLOSE => "SQLITE_IOERR_CLOSE".to_owned(),
libsql::ffi::SQLITE_IOERR_DIR_CLOSE => "SQLITE_IOERR_DIR_CLOSE".to_owned(),
libsql::ffi::SQLITE_IOERR_SHMOPEN => "SQLITE_IOERR_SHMOPEN".to_owned(),
libsql::ffi::SQLITE_IOERR_SHMSIZE => "SQLITE_IOERR_SHMSIZE".to_owned(),
libsql::ffi::SQLITE_IOERR_SHMLOCK => "SQLITE_IOERR_SHMLOCK".to_owned(),
libsql::ffi::SQLITE_IOERR_SHMMAP => "SQLITE_IOERR_SHMMAP".to_owned(),
libsql::ffi::SQLITE_IOERR_SEEK => "SQLITE_IOERR_SEEK".to_owned(),
libsql::ffi::SQLITE_IOERR_DELETE_NOENT => "SQLITE_IOERR_DELETE_NOENT".to_owned(),
libsql::ffi::SQLITE_IOERR_MMAP => "SQLITE_IOERR_MMAP".to_owned(),
libsql::ffi::SQLITE_IOERR_GETTEMPPATH => "SQLITE_IOERR_GETTEMPPATH".to_owned(),
libsql::ffi::SQLITE_IOERR_CONVPATH => "SQLITE_IOERR_CONVPATH".to_owned(),
libsql::ffi::SQLITE_IOERR_VNODE => "SQLITE_IOERR_VNODE".to_owned(),
libsql::ffi::SQLITE_IOERR_AUTH => "SQLITE_IOERR_AUTH".to_owned(),
libsql::ffi::SQLITE_LOCKED_SHAREDCACHE => "SQLITE_LOCKED_SHAREDCACHE".to_owned(),
libsql::ffi::SQLITE_BUSY_RECOVERY => "SQLITE_BUSY_RECOVERY".to_owned(),
libsql::ffi::SQLITE_BUSY_SNAPSHOT => "SQLITE_BUSY_SNAPSHOT".to_owned(),
libsql::ffi::SQLITE_CANTOPEN_NOTEMPDIR => "SQLITE_CANTOPEN_NOTEMPDIR".to_owned(),
libsql::ffi::SQLITE_CANTOPEN_ISDIR => "SQLITE_CANTOPEN_ISDIR".to_owned(),
libsql::ffi::SQLITE_CANTOPEN_FULLPATH => "SQLITE_CANTOPEN_FULLPATH".to_owned(),
libsql::ffi::SQLITE_CANTOPEN_CONVPATH => "SQLITE_CANTOPEN_CONVPATH".to_owned(),
libsql::ffi::SQLITE_CORRUPT_VTAB => "SQLITE_CORRUPT_VTAB".to_owned(),
libsql::ffi::SQLITE_READONLY_RECOVERY => "SQLITE_READONLY_RECOVERY".to_owned(),
libsql::ffi::SQLITE_READONLY_CANTLOCK => "SQLITE_READONLY_CANTLOCK".to_owned(),
libsql::ffi::SQLITE_READONLY_ROLLBACK => "SQLITE_READONLY_ROLLBACK".to_owned(),
libsql::ffi::SQLITE_READONLY_DBMOVED => "SQLITE_READONLY_DBMOVED".to_owned(),
libsql::ffi::SQLITE_ABORT_ROLLBACK => "SQLITE_ABORT_ROLLBACK".to_owned(),
libsql::ffi::SQLITE_CONSTRAINT_CHECK => "SQLITE_CONSTRAINT_CHECK".to_owned(),
libsql::ffi::SQLITE_CONSTRAINT_COMMITHOOK => "SQLITE_CONSTRAINT_COMMITHOOK".to_owned(),
libsql::ffi::SQLITE_CONSTRAINT_FOREIGNKEY => "SQLITE_CONSTRAINT_FOREIGNKEY".to_owned(),
libsql::ffi::SQLITE_CONSTRAINT_FUNCTION => "SQLITE_CONSTRAINT_FUNCTION".to_owned(),
libsql::ffi::SQLITE_CONSTRAINT_NOTNULL => "SQLITE_CONSTRAINT_NOTNULL".to_owned(),
libsql::ffi::SQLITE_CONSTRAINT_PRIMARYKEY => "SQLITE_CONSTRAINT_PRIMARYKEY".to_owned(),
libsql::ffi::SQLITE_CONSTRAINT_TRIGGER => "SQLITE_CONSTRAINT_TRIGGER".to_owned(),
libsql::ffi::SQLITE_CONSTRAINT_UNIQUE => "SQLITE_CONSTRAINT_UNIQUE".to_owned(),
libsql::ffi::SQLITE_CONSTRAINT_VTAB => "SQLITE_CONSTRAINT_VTAB".to_owned(),
libsql::ffi::SQLITE_CONSTRAINT_ROWID => "SQLITE_CONSTRAINT_ROWID".to_owned(),
libsql::ffi::SQLITE_NOTICE_RECOVER_WAL => "SQLITE_NOTICE_RECOVER_WAL".to_owned(),
libsql::ffi::SQLITE_NOTICE_RECOVER_ROLLBACK => "SQLITE_NOTICE_RECOVER_ROLLBACK".to_owned(),
libsql::ffi::SQLITE_WARNING_AUTOINDEX => "SQLITE_WARNING_AUTOINDEX".to_owned(),
libsql::ffi::SQLITE_AUTH_USER => "SQLITE_AUTH_USER".to_owned(),
libsql::ffi::SQLITE_OK_LOAD_PERMANENTLY => "SQLITE_OK_LOAD_PERMANENTLY".to_owned(),
_ => format!("UNKNOWN_SQLITE_ERROR_{}", code),
}
}
pub fn throw_sqlite_error(message: String, code: String, raw_code: i32) -> napi::Error {
let err_json = serde_json::json!({
"message": message,
"libsqlError": true,
"code": code,
"rawCode": raw_code
});
napi::Error::from_reason(err_json.to_string())
}
impl From<libsql::Error> for Error {
fn from(error: libsql::Error) -> Self {
Error(error)
}
}
/// SQLite connection options.
#[napi(object)]
pub struct Options {
// Timeout in seconds.
pub timeout: Option<f64>,
// Authentication token for remote databases.
pub authToken: Option<String>,
// URL for remote database sync.
pub syncUrl: Option<String>,
// Read your writes.
pub readYourWrites: Option<bool>,
// Sync interval in seconds.
pub syncPeriod: Option<f64>,
// Encryption cipher for local enryption at rest.
pub encryptionCipher: Option<String>,
// Encryption key for local encryption at rest.
pub encryptionKey: Option<String>,
// Encryption key for remote encryption at rest.
pub remoteEncryptionKey: Option<String>,
}
/// Access mode.
///
/// The `better-sqlite3` API allows the caller to configure the format of
/// query results. This struct encapsulates the different access mode configs.
struct AccessMode {
pub(crate) raw: AtomicBool,
pub(crate) pluck: AtomicBool,
pub(crate) safe_ints: AtomicBool,
pub(crate) timing: AtomicBool,
}
/// SQLite database connection.
#[napi]
pub struct Database {
// The libSQL database instance.
db: Option<libsql::Database>,
// The libSQL connection instance.
conn: Option<Arc<libsql::Connection>>,
// Whether to use safe integers by default.
default_safe_integers: AtomicBool,
// Whether to use memory-only mode.
memory: bool,
}
impl Drop for Database {
fn drop(&mut self) {
self.conn = None;
self.db = None;
}
}
#[napi]
pub async fn connect(path: String, opts: Option<Options>) -> Result<Database> {
let remote = is_remote_path(&path);
let db = if remote {
let auth_token = opts
.as_ref()
.and_then(|o| o.authToken.as_ref())
.cloned()
.unwrap_or_default();
let mut builder = libsql::Builder::new_remote(path.clone(), auth_token);
if let Some(encryption_key) = opts
.as_ref()
.and_then(|o| o.remoteEncryptionKey.as_ref())
.cloned()
{
let encryption_context = libsql::EncryptionContext {
key: libsql::EncryptionKey::Base64Encoded(encryption_key),
};
builder = builder.remote_encryption(encryption_context);
}
builder.build().await.map_err(Error::from)?
} else if let Some(options) = &opts {
if let Some(sync_url) = &options.syncUrl {
let auth_token = options.authToken.as_ref().cloned().unwrap_or_default();
let encryption_cipher: String = opts
.as_ref()
.and_then(|o| o.encryptionCipher.as_ref())
.cloned()
.unwrap_or("aes256cbc".to_string());
let cipher = libsql::Cipher::from_str(&encryption_cipher).map_err(|_| {
throw_sqlite_error(
"Invalid encryption cipher".to_string(),
"SQLITE_INVALID_ENCRYPTION_CIPHER".to_string(),
0,
)
})?;
let encryption_key = opts
.as_ref()
.and_then(|o| o.encryptionKey.as_ref())
.cloned()
.unwrap_or("".to_string());
let mut builder =
libsql::Builder::new_remote_replica(path.clone(), sync_url.clone(), auth_token);
let read_your_writes = options.readYourWrites.unwrap_or(true);
builder = builder.read_your_writes(read_your_writes);
if encryption_key.len() > 0 {
let encryption_config =
libsql::EncryptionConfig::new(cipher, encryption_key.into());
builder = builder.encryption_config(encryption_config);
}
if let Some(remote_encryption_key) = &options.remoteEncryptionKey {
let encryption_context = libsql::EncryptionContext {
key: libsql::EncryptionKey::Base64Encoded(remote_encryption_key.to_string()),
};
builder = builder.remote_encryption(encryption_context);
}
if let Some(period) = options.syncPeriod {
if period > 0.0 {
builder = builder.sync_interval(std::time::Duration::from_secs_f64(period));
}
}
builder.build().await.map_err(Error::from)?
} else {
let builder = libsql::Builder::new_local(&path);
builder.build().await.map_err(Error::from)?
}
} else {
let builder = libsql::Builder::new_local(&path);
builder.build().await.map_err(Error::from)?
};
let conn = db.connect().map_err(Error::from)?;
let default_safe_integers = AtomicBool::new(false);
let memory = path == ":memory:";
let timeout = match opts {
Some(ref opts) => opts.timeout.unwrap_or(0.0),
None => 0.0,
};
if timeout > 0.0 {
conn.busy_timeout(Duration::from_millis(timeout as u64))
.map_err(Error::from)?
}
Ok(Database {
db: Some(db),
conn: Some(Arc::new(conn)),
default_safe_integers,
memory,
})
}
#[napi]
impl Database {
/// Creates a new database instance.
///
/// # Arguments
///
/// * `path` - The path to the database file.
/// * `opts` - The database options.
#[napi(constructor)]
pub fn new(path: String, opts: Option<Options>) -> Result<Self> {
ensure_logger();
let rt = runtime()?;
rt.block_on(connect(path, opts))
}
/// Returns whether the database is in memory-only mode.
#[napi(getter)]
pub fn memory(&self) -> bool {
self.memory
}
/// Returns whether the database is in a transaction.
#[napi]
pub fn in_transaction(&self) -> Result<bool> {
let conn = match &self.conn {
Some(conn) => conn.clone(),
None => return Ok(false),
};
Ok(!conn.is_autocommit())
}
/// Prepares a statement for execution.
///
/// # Arguments
///
/// * `sql` - The SQL statement to prepare.
///
/// # Returns
///
/// A `Statement` instance.
#[napi]
pub async fn prepare(&self, sql: String) -> Result<Statement> {
let conn = match &self.conn {
Some(conn) => conn.clone(),
None => {
return Err(throw_sqlite_error(
"The database connection is not open".to_string(),
"SQLITE_NOTOPEN".to_string(),
0,
));
}
};
let stmt = { conn.prepare(&sql).await.map_err(Error::from)? };
let mode = AccessMode {
safe_ints: self.default_safe_integers.load(Ordering::SeqCst).into(),
raw: false.into(),
pluck: false.into(),
timing: false.into(),
};
Ok(Statement::new(conn, stmt, mode))
}
/// Sets the authorizer for the database.
///
/// # Arguments
///
/// * `env` - The environment.
/// * `rules_obj` - The rules object.
///
/// The `rules_obj` is a JavaScript object with the following properties:
///
/// * `Authorization.ALLOW` - Allow access to the table.
/// * `Authorization.DENY` - Deny access to the table.
///
/// Example:
///
/// ```javascript
/// db.authorizer({
/// "users": Authorization.ALLOW
/// });
/// ```
#[napi]
pub fn authorizer(&self, env: Env, rules_obj: napi::JsObject) -> Result<()> {
let conn = match &self.conn {
Some(c) => c.clone(),
None => {
return Err(throw_database_closed_error(&env).into());
}
};
let mut builder = crate::auth::AuthorizerBuilder::new();
let prop_names = rules_obj.get_property_names()?;
let len = prop_names.get_array_length()?;
for idx in 0..len {
let key_js: napi::JsString = prop_names.get_element::<napi::JsString>(idx)?;
let key = key_js.into_utf8()?.into_owned()?;
let value_js: napi::JsNumber = rules_obj.get_named_property(&key)?;
let value = value_js.get_int32()?;
match value {
0 => {
// Authorization.ALLOW
builder.allow(&key);
}
1 => {
// Authorization.DENY
builder.deny(&key);
}
_ => {
let msg = format!(
"Invalid authorization rule value '{}' for table '{}'. Expected 0 (ALLOW) or 1 (DENY).",
value, key
);
return Err(napi::Error::from_reason(msg));
}
}
}
let authorizer = builder.build();
let auth_arc = std::sync::Arc::new(authorizer);
let closure = {
let auth_arc = auth_arc.clone();
move |ctx: &libsql::AuthContext| auth_arc.authorize(ctx)
};
conn.authorizer(Some(std::sync::Arc::new(closure)))
.map_err(Error::from)?;
Ok(())
}
/// Loads an extension into the database.
///
/// # Arguments
///
/// * `path` - The path to the extension file.
/// * `entry_point` - The entry point of the extension.
///
#[napi]
pub fn loadExtension(&self, path: String, entry_point: Option<String>) -> Result<()> {
let rt = runtime()?;
let conn = match &self.conn {
Some(conn) => conn.clone(),
None => {
return Err(throw_sqlite_error(
"The database connection is not open".to_string(),
"SQLITE_NOTOPEN".to_string(),
0,
));
}
};
rt.block_on(async move {
conn.load_extension_enable().map_err(Error::from)?;
if let Err(err) = conn.load_extension(&path, entry_point.as_deref()) {
let _ = conn.load_extension_disable();
return Err(Error::from(err));
}
conn.load_extension_disable().map_err(Error::from)?;
Ok(())
})
.map_err(|e| napi::Error::from(e))
}
/// Returns the maximum write replication index.
///
/// # Returns
///
/// The maximum write replication index.
#[napi]
pub fn max_write_replication_index(&self) -> Result<f64> {
let db = match &self.db {
Some(db) => db,
None => return Ok(0.0),
};
let result = db.max_write_replication_index();
Ok(result.unwrap_or(0) as f64)
}
/// Executes a SQL statement.
///
/// # Arguments
///
/// * `env` - The environment.
/// * `sql` - The SQL statement to execute.
#[napi]
pub async fn exec(&self, sql: String) -> Result<()> {
let conn = match &self.conn {
Some(conn) => conn.clone(),
None => {
return Err(throw_sqlite_error(
"The database connection is not open".to_string(),
"SQLITE_NOTOPEN".to_string(),
0,
));
}
};
conn.execute_batch(&sql).await.map_err(Error::from)?;
Ok(())
}
/// Syncs the database.
///
/// # Returns
///
/// A `SyncResult` instance.
#[napi]
pub async fn sync(&self) -> Result<SyncResult> {
let db = match &self.db {
Some(db) => db,
None => {
return Err(throw_sqlite_error(
"The database connection is not open".to_string(),
"SQLITE_NOTOPEN".to_string(),
0,
));
}
};
let result = db.sync().await.map_err(Error::from)?;
Ok(SyncResult {
frames_synced: result.frames_synced() as f64,
replication_index: result.frame_no().unwrap_or(0) as f64,
})
}
/// Interrupts any ongoing database operations.
///
/// # Arguments
///
/// * `env` - The environment.
#[napi]
pub fn interrupt(&self, env: Env) -> Result<()> {
let conn = match &self.conn {
Some(conn) => conn.clone(),
None => return Err(throw_database_closed_error(&env).into()),
};
conn.interrupt().map_err(Error::from)?;
Ok(())
}
/// Closes the database connection.
#[napi]
pub fn close(&mut self) -> Result<()> {
self.conn = None;
self.db = None;
Ok(())
}
/// Sets the default safe integers mode.
///
/// # Arguments
///
/// * `toggle` - Whether to use safe integers by default.
#[napi]
pub fn defaultSafeIntegers(&self, toggle: Option<bool>) -> Result<()> {
self.default_safe_integers
.store(toggle.unwrap_or(true), Ordering::SeqCst);
Ok(())
}
}
/// Result of a database sync operation.
#[napi(object)]
pub struct SyncResult {
/// The number of frames synced.
pub frames_synced: f64,
/// The replication index.
pub replication_index: f64,
}
/// Prepares a statement in blocking mode.
#[napi]
pub fn database_prepare_sync(db: &Database, sql: String) -> Result<Statement> {
let rt = runtime()?;
rt.block_on(async move { db.prepare(sql).await })
}
/// Syncs the database in blocking mode.
#[napi]
pub fn database_sync_sync(db: &Database) -> Result<SyncResult> {
let rt = runtime()?;
rt.block_on(async move { db.sync().await })
}
/// Executes SQL in blocking mode.
#[napi]
pub fn database_exec_sync(db: &Database, sql: String) -> Result<()> {
let rt = runtime()?;
rt.block_on(async move { db.exec(sql).await })
}
fn is_remote_path(path: &str) -> bool {
path.starts_with("libsql://") || path.starts_with("http://") || path.starts_with("https://")
}
fn throw_database_closed_error(env: &Env) -> napi::Error {
let msg = "The database connection is not open";
let err = napi::Error::new(napi::Status::InvalidArg, msg.to_string());
env.throw_type_error(msg, None).unwrap();
err
}
/// SQLite statement object.
#[napi]
pub struct Statement {
// The libSQL connection instance.
conn: Arc<libsql::Connection>,
// The libSQL statement instance.
stmt: Arc<libsql::Statement>,
// The column names.
column_names: Vec<std::ffi::CString>,
// The access mode.
mode: AccessMode,
}
#[napi]
impl Statement {
/// Creates a new statement instance.
///
/// # Arguments
///
/// * `conn` - The connection instance.
/// * `stmt` - The libSQL statement instance.
/// * `mode` - The access mode.
pub(crate) fn new(
conn: Arc<libsql::Connection>,
stmt: libsql::Statement,
mode: AccessMode,
) -> Self {
let column_names: Vec<std::ffi::CString> = stmt
.columns()
.iter()
.map(|c| std::ffi::CString::new(c.name().to_string()).unwrap())
.collect();
let stmt = Arc::new(stmt);
Self {
conn,
stmt,
column_names,
mode,
}
}
/// Executes a SQL statement.
///
/// # Arguments
///
/// * `params` - The parameters to bind to the statement.
#[napi]
pub fn run(&self, env: Env, params: Option<napi::JsUnknown>) -> Result<napi::JsObject> {
self.stmt.reset();
let params = map_params(&self.stmt, params)?;
let total_changes_before = self.conn.total_changes();
let start = std::time::Instant::now();
let stmt = self.stmt.clone();
let conn = self.conn.clone();
let future = async move {
stmt.run(params).await.map_err(Error::from)?;
let changes = if conn.total_changes() == total_changes_before {
0
} else {
conn.changes()
};
let last_insert_row_id = conn.last_insert_rowid();
let duration = start.elapsed().as_secs_f64();
Ok(RunResult {
changes: changes as f64,
duration,
lastInsertRowid: last_insert_row_id,
})
};
env.execute_tokio_future(future, move |&mut _env, result| Ok(result))
}
/// Executes a SQL statement and returns the first row.
///
/// # Arguments
///
/// * `env` - The environment.
/// * `params` - The parameters to bind to the statement.
#[napi]
pub fn get(&self, env: Env, params: Option<napi::JsUnknown>) -> Result<napi::JsObject> {
let safe_ints = self.mode.safe_ints.load(Ordering::SeqCst);
let raw = self.mode.raw.load(Ordering::SeqCst);
let pluck = self.mode.pluck.load(Ordering::SeqCst);
let timed = self.mode.timing.load(Ordering::SeqCst);
let params = map_params(&self.stmt, params)?;
let stmt = self.stmt.clone();
let column_names = self.column_names.clone();
let start = if timed {
Some(std::time::Instant::now())
} else {
None
};
let stmt_fut = stmt.clone();
let future = async move {
let mut rows = stmt_fut.query(params).await.map_err(Error::from)?;
let row = rows.next().await.map_err(Error::from)?;
let duration: Option<f64> = start.map(|start| start.elapsed().as_secs_f64());
Ok((row, duration))
};
env.execute_tokio_future(future, move |&mut env, (row, duration)| {
let result =
Self::get_internal(&env, &row, &column_names, safe_ints, raw, pluck, duration);
stmt.reset();
Ok(result)
})
}
fn get_internal(
env: &Env,
row: &Option<libsql::Row>,
column_names: &[std::ffi::CString],
safe_ints: bool,
raw: bool,
pluck: bool,
duration: Option<f64>,
) -> Result<napi::JsUnknown> {
match row {
Some(row) => {
if raw {
let js_array = map_row_raw(&env, &column_names, &row, safe_ints, pluck)?;
Ok(js_array.into_unknown())
} else {
let mut js_object =
map_row_object(&env, &column_names, &row, safe_ints, pluck)?
.coerce_to_object()?;
if let Some(duration) = duration {
let mut metadata = env.create_object()?;
let js_duration = env.create_double(duration)?;
metadata.set_named_property("duration", js_duration)?;
js_object.set_named_property("_metadata", metadata)?;
}
Ok(js_object.into_unknown())
}
}
None => {
let undefined = env.get_undefined()?;
Ok(undefined.into_unknown())
}
}
}
/// Create an iterator over the rows of a statement.
///
/// # Arguments
///
/// * `env` - The environment.
/// * `params` - The parameters to bind to the statement.
#[napi]
pub fn iterate(&self, env: Env, params: Option<napi::JsUnknown>) -> Result<napi::JsObject> {
let safe_ints = self.mode.safe_ints.load(Ordering::SeqCst);
let raw = self.mode.raw.load(Ordering::SeqCst);
let pluck = self.mode.pluck.load(Ordering::SeqCst);
let stmt = self.stmt.clone();
stmt.reset();
let params = map_params(&stmt, params).unwrap();
let stmt = self.stmt.clone();
let future = async move {
let rows = stmt.query(params).await.map_err(Error::from)?;
Ok::<_, napi::Error>(rows)
};
let column_names = self.column_names.clone();
env.execute_tokio_future(future, move |&mut _env, result| {
Ok(RowsIterator::new(
Arc::new(tokio::sync::Mutex::new(result)),
column_names,
safe_ints,
raw,
pluck,
))
})
}
#[napi]
pub fn raw(&self, raw: Option<bool>) -> Result<&Self> {
let returns_data = !self.stmt.columns().is_empty();
if !returns_data {
return Err(napi::Error::from_reason(
"The raw() method is only for statements that return data",
));
}
self.mode.raw.store(raw.unwrap_or(true), Ordering::SeqCst);
Ok(self)
}
#[napi]
pub fn pluck(&self, pluck: Option<bool>) -> Result<&Self> {
self.mode
.pluck
.store(pluck.unwrap_or(true), Ordering::SeqCst);
Ok(self)
}
#[napi]
pub fn timing(&self, timing: Option<bool>) -> Result<&Self> {
self.mode
.timing
.store(timing.unwrap_or(true), Ordering::SeqCst);
Ok(self)
}
#[napi]
pub fn columns(&self, env: Env) -> Result<Array> {
let columns = self.stmt.columns();
let mut js_array = env.create_array(columns.len() as u32)?;
for (i, col) in columns.iter().enumerate() {
let mut js_obj = env.create_object()?;
js_obj.set_named_property("name", env.create_string(col.name())?)?;
// origin_name -> column
if let Some(origin_name) = col.origin_name() {
js_obj.set_named_property("column", env.create_string(origin_name)?)?;
} else {
js_obj.set_named_property("column", env.get_null()?)?;
}
// table_name -> table
if let Some(table_name) = col.table_name() {
js_obj.set_named_property("table", env.create_string(table_name)?)?;
} else {
js_obj.set_named_property("table", env.get_null()?)?;
}
// database_name -> database
if let Some(database_name) = col.database_name() {
js_obj.set_named_property("database", env.create_string(database_name)?)?;
} else {
js_obj.set_named_property("database", env.get_null()?)?;
}
// decl_type -> type
if let Some(decl_type) = col.decl_type() {
js_obj.set_named_property("type", env.create_string(decl_type)?)?;
} else {
js_obj.set_named_property("type", env.get_null()?)?;
}
js_array.set(i as u32, js_obj)?;
}
Ok(js_array)
}
#[napi]
pub fn safeIntegers(&self, toggle: Option<bool>) -> Result<&Self> {
self.mode
.safe_ints
.store(toggle.unwrap_or(true), Ordering::SeqCst);
Ok(self)
}
#[napi]
pub fn interrupt(&self) -> Result<()> {
self.stmt.interrupt().map_err(Error::from)?;
Ok(())
}
}
/// Gets first row from statement in blocking mode.
#[napi]
pub fn statement_get_sync(
stmt: &Statement,
env: Env,
params: Option<napi::JsUnknown>,
) -> Result<napi::JsUnknown> {
let safe_ints = stmt.mode.safe_ints.load(Ordering::SeqCst);
let raw = stmt.mode.raw.load(Ordering::SeqCst);
let pluck = stmt.mode.pluck.load(Ordering::SeqCst);
let timed = stmt.mode.timing.load(Ordering::SeqCst);
let start = if timed {
Some(std::time::Instant::now())
} else {
None
};
let rt = runtime()?;
rt.block_on(async move {
let params = map_params(&stmt.stmt, params)?;
let mut rows = stmt.stmt.query(params).await.map_err(Error::from)?;
let row = rows.next().await.map_err(Error::from)?;
let duration: Option<f64> = start.map(|start| start.elapsed().as_secs_f64());
let result = Statement::get_internal(
&env,
&row,
&stmt.column_names,
safe_ints,
raw,
pluck,
duration,
);
stmt.stmt.reset();
result
})
}
/// Runs a statement in blocking mode.
#[napi]
pub fn statement_run_sync(stmt: &Statement, params: Option<napi::JsUnknown>) -> Result<RunResult> {
stmt.stmt.reset();
let rt = runtime()?;
rt.block_on(async move {
let params = map_params(&stmt.stmt, params)?;
let total_changes_before = stmt.conn.total_changes();
let start = std::time::Instant::now();
stmt.stmt.run(params).await.map_err(Error::from)?;
let changes = if stmt.conn.total_changes() == total_changes_before {
0
} else {
stmt.conn.changes()
};
let last_insert_row_id = stmt.conn.last_insert_rowid();
let duration = start.elapsed().as_secs_f64();
Ok(RunResult {
changes: changes as f64,
duration,
lastInsertRowid: last_insert_row_id,
})
})
}
#[napi]
pub fn statement_iterate_sync(
stmt: &Statement,
_env: Env,
params: Option<napi::JsUnknown>,
) -> Result<RowsIterator> {
let rt = runtime()?;
let safe_ints = stmt.mode.safe_ints.load(Ordering::SeqCst);
let raw = stmt.mode.raw.load(Ordering::SeqCst);
let pluck = stmt.mode.pluck.load(Ordering::SeqCst);
let stmt = stmt.stmt.clone();
let (rows, column_names) = rt.block_on(async move {
stmt.reset();
let params = map_params(&stmt, params)?;
let rows = stmt.query(params).await.map_err(Error::from)?;
let mut column_names = Vec::new();
for i in 0..rows.column_count() {
column_names
.push(std::ffi::CString::new(rows.column_name(i).unwrap().to_string()).unwrap());
}
Ok::<_, napi::Error>((rows, column_names))
})?;
Ok(RowsIterator::new(
Arc::new(tokio::sync::Mutex::new(rows)),
column_names,
safe_ints,
raw,
pluck,
))
}
/// SQLite `run()` result object
#[napi(object)]
pub struct RunResult {
pub changes: f64,
pub duration: f64,
pub lastInsertRowid: i64,
}
fn map_params(
stmt: &libsql::Statement,
params: Option<napi::JsUnknown>,
) -> Result<libsql::params::Params> {
if let Some(params) = params {
match params.get_type()? {
ValueType::Object => {
let object = params.coerce_to_object()?;
if object.is_array()? {
map_params_array(object)
} else {
map_params_object(stmt, object)
}