surrealmx 0.19.0

An embedded, in-memory, lock-free, transaction-based, key-value database engine
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
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
// Copyright © SurrealDB Ltd
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

//! Savepoint functionality tests for SurrealMX.
//!
//! Tests `set_savepoint()` and `rollback_to_savepoint()` behavior
//! including nested savepoints and edge cases.

use bytes::Bytes;
use surrealmx::{Database, Error};

#[cfg(target_arch = "wasm32")]
use wasm_bindgen_test::*;

// =============================================================================
// Basic Savepoint Tests
// =============================================================================

#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test)]
#[test]
fn savepoint_basic_rollback() {
	let db = Database::new();

	let mut tx = db.transaction(true);

	// Initial state
	tx.set("key1", "value1").unwrap();
	tx.set("key2", "value2").unwrap();

	// Set savepoint
	tx.set_savepoint().unwrap();

	// Make changes after savepoint
	tx.set("key1", "modified1").unwrap();
	tx.set("key3", "value3").unwrap();

	// Verify changes are visible
	assert_eq!(tx.get("key1").unwrap(), Some(Bytes::from("modified1")));
	assert_eq!(tx.get("key3").unwrap(), Some(Bytes::from("value3")));

	// Rollback to savepoint
	tx.rollback_to_savepoint().unwrap();

	// Verify rollback - key1 should be original, key3 should not exist
	assert_eq!(
		tx.get("key1").unwrap(),
		Some(Bytes::from("value1")),
		"key1 should be restored to original value"
	);
	assert_eq!(tx.get("key2").unwrap(), Some(Bytes::from("value2")), "key2 should be unchanged");
	assert_eq!(tx.get("key3").unwrap(), None, "key3 should not exist after rollback");

	// Commit and verify final state
	tx.commit().unwrap();

	let mut verify_tx = db.transaction(false);
	assert_eq!(verify_tx.get("key1").unwrap(), Some(Bytes::from("value1")));
	assert_eq!(verify_tx.get("key2").unwrap(), Some(Bytes::from("value2")));
	assert_eq!(verify_tx.get("key3").unwrap(), None);
	verify_tx.cancel().unwrap();
}

#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test)]
#[test]
fn savepoint_rollback_restores_deleted_keys() {
	let db = Database::new();

	let mut tx = db.transaction(true);

	// Create initial keys
	tx.set("keep", "keeper").unwrap();
	tx.set("delete_me", "will_be_deleted").unwrap();

	// Set savepoint
	tx.set_savepoint().unwrap();

	// Delete a key
	tx.del("delete_me").unwrap();

	// Verify it's deleted
	assert_eq!(tx.get("delete_me").unwrap(), None, "Key should be deleted");

	// Rollback
	tx.rollback_to_savepoint().unwrap();

	// Key should be restored
	assert_eq!(
		tx.get("delete_me").unwrap(),
		Some(Bytes::from("will_be_deleted")),
		"Deleted key should be restored after rollback"
	);

	tx.commit().unwrap();

	// Verify persistence
	let mut verify = db.transaction(false);
	assert_eq!(verify.get("delete_me").unwrap(), Some(Bytes::from("will_be_deleted")));
	verify.cancel().unwrap();
}

// =============================================================================
// Nested Savepoint Tests
// =============================================================================

#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test)]
#[test]
fn savepoint_nested_multiple_levels() {
	let db = Database::new();

	let mut tx = db.transaction(true);

	// Level 0: Initial state
	tx.set("level", "0").unwrap();

	// Level 1 savepoint
	tx.set_savepoint().unwrap();
	tx.set("level", "1").unwrap();
	tx.set("added_at_1", "value1").unwrap();

	// Level 2 savepoint
	tx.set_savepoint().unwrap();
	tx.set("level", "2").unwrap();
	tx.set("added_at_2", "value2").unwrap();

	// Level 3 savepoint
	tx.set_savepoint().unwrap();
	tx.set("level", "3").unwrap();
	tx.set("added_at_3", "value3").unwrap();

	// Verify we're at level 3
	assert_eq!(tx.get("level").unwrap(), Some(Bytes::from("3")));
	assert!(tx.get("added_at_3").unwrap().is_some());

	// Rollback to level 2
	tx.rollback_to_savepoint().unwrap();
	assert_eq!(tx.get("level").unwrap(), Some(Bytes::from("2")));
	assert!(tx.get("added_at_3").unwrap().is_none());
	assert!(tx.get("added_at_2").unwrap().is_some());

	// Rollback to level 1
	tx.rollback_to_savepoint().unwrap();
	assert_eq!(tx.get("level").unwrap(), Some(Bytes::from("1")));
	assert!(tx.get("added_at_2").unwrap().is_none());
	assert!(tx.get("added_at_1").unwrap().is_some());

	// Rollback to level 0
	tx.rollback_to_savepoint().unwrap();
	assert_eq!(tx.get("level").unwrap(), Some(Bytes::from("0")));
	assert!(tx.get("added_at_1").unwrap().is_none());

	tx.commit().unwrap();

	// Verify final state
	let mut verify = db.transaction(false);
	assert_eq!(verify.get("level").unwrap(), Some(Bytes::from("0")));
	verify.cancel().unwrap();
}

#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test)]
#[test]
fn savepoint_partial_nested_rollback() {
	let db = Database::new();

	let mut tx = db.transaction(true);

	tx.set("base", "base_value").unwrap();

	// First savepoint
	tx.set_savepoint().unwrap();
	tx.set("sp1_key", "sp1_value").unwrap();

	// Second savepoint
	tx.set_savepoint().unwrap();
	tx.set("sp2_key", "sp2_value").unwrap();

	// Third savepoint
	tx.set_savepoint().unwrap();
	tx.set("sp3_key", "sp3_value").unwrap();

	// Rollback only the third savepoint
	tx.rollback_to_savepoint().unwrap();

	// sp3_key should be gone, others should remain
	assert!(tx.get("sp3_key").unwrap().is_none());
	assert!(tx.get("sp2_key").unwrap().is_some());
	assert!(tx.get("sp1_key").unwrap().is_some());
	assert!(tx.get("base").unwrap().is_some());

	// Commit with sp1 and sp2 changes
	tx.commit().unwrap();

	let mut verify = db.transaction(false);
	assert_eq!(verify.get("base").unwrap(), Some(Bytes::from("base_value")));
	assert_eq!(verify.get("sp1_key").unwrap(), Some(Bytes::from("sp1_value")));
	assert_eq!(verify.get("sp2_key").unwrap(), Some(Bytes::from("sp2_value")));
	assert!(verify.get("sp3_key").unwrap().is_none());
	verify.cancel().unwrap();
}

// =============================================================================
// Savepoint Edge Cases
// =============================================================================

#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test)]
#[test]
fn savepoint_rollback_without_savepoint_errors() {
	let db = Database::new();

	let mut tx = db.transaction(true);
	tx.set("key", "value").unwrap();

	// Try to rollback without setting a savepoint
	let result = tx.rollback_to_savepoint();
	assert!(matches!(result, Err(Error::NoSavepoint)), "Should error when no savepoint exists");

	// Transaction should still be usable
	tx.set("key2", "value2").unwrap();
	tx.commit().unwrap();
}

#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test)]
#[test]
fn savepoint_on_read_transaction() {
	let db = Database::new();

	// Create some data first
	let mut setup_tx = db.transaction(true);
	setup_tx.set("key", "value").unwrap();
	setup_tx.commit().unwrap();

	// Try savepoint on read-only transaction
	let mut read_tx = db.transaction(false);

	// Note: set_savepoint might succeed on read-only tx (depends on implementation)
	// but rollback should work without issues
	if read_tx.set_savepoint().is_ok() {
		// Read some data
		let _ = read_tx.get("key").unwrap();
		// Rollback should be fine (no changes anyway)
		let _ = read_tx.rollback_to_savepoint();
	}

	read_tx.cancel().unwrap();
}

#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test)]
#[test]
fn savepoint_modify_after_rollback_then_commit() {
	let db = Database::new();

	let mut tx = db.transaction(true);

	tx.set("original", "value").unwrap();

	tx.set_savepoint().unwrap();
	tx.set("temp", "will_be_rolled_back").unwrap();
	tx.rollback_to_savepoint().unwrap();

	// Make new modifications after rollback
	tx.set("new_key", "new_value").unwrap();
	tx.set("original", "modified").unwrap();

	tx.commit().unwrap();

	let mut verify = db.transaction(false);
	assert_eq!(verify.get("original").unwrap(), Some(Bytes::from("modified")));
	assert_eq!(verify.get("new_key").unwrap(), Some(Bytes::from("new_value")));
	assert!(verify.get("temp").unwrap().is_none());
	verify.cancel().unwrap();
}

#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test)]
#[test]
fn savepoint_set_same_key_multiple_times() {
	let db = Database::new();

	let mut tx = db.transaction(true);

	tx.set("counter", "0").unwrap();
	tx.set_savepoint().unwrap();

	// Update same key multiple times
	tx.set("counter", "1").unwrap();
	tx.set("counter", "2").unwrap();
	tx.set("counter", "3").unwrap();

	assert_eq!(tx.get("counter").unwrap(), Some(Bytes::from("3")));

	tx.rollback_to_savepoint().unwrap();

	// Should go back to "0", not any intermediate value
	assert_eq!(tx.get("counter").unwrap(), Some(Bytes::from("0")));

	tx.commit().unwrap();
}

#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test)]
#[test]
fn savepoint_empty_savepoint_rollback() {
	let db = Database::new();

	let mut tx = db.transaction(true);

	tx.set("before", "value").unwrap();

	// Set savepoint but make no changes
	tx.set_savepoint().unwrap();

	// Rollback empty savepoint
	tx.rollback_to_savepoint().unwrap();

	// Original data should still be there
	assert_eq!(tx.get("before").unwrap(), Some(Bytes::from("value")));

	tx.commit().unwrap();

	let mut verify = db.transaction(false);
	assert_eq!(verify.get("before").unwrap(), Some(Bytes::from("value")));
	verify.cancel().unwrap();
}

#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test)]
#[test]
fn savepoint_with_scan_operations() {
	let db = Database::new();

	let mut tx = db.transaction(true);

	// Create initial range
	tx.set("a", "1").unwrap();
	tx.set("b", "2").unwrap();
	tx.set("c", "3").unwrap();

	tx.set_savepoint().unwrap();

	// Add more keys and modify existing
	tx.set("b", "modified").unwrap();
	tx.set("d", "4").unwrap();
	tx.set("e", "5").unwrap();

	// Verify scan sees all changes
	let scan_result = tx.scan("a".."z", None, None).unwrap();
	assert_eq!(scan_result.len(), 5);

	tx.rollback_to_savepoint().unwrap();

	// Scan should now see original state
	let scan_result = tx.scan("a".."z", None, None).unwrap();
	assert_eq!(scan_result.len(), 3);
	assert_eq!(scan_result[1].1.as_ref(), b"2"); // b should be original value

	tx.commit().unwrap();
}

#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test)]
#[test]
fn savepoint_delete_then_recreate_key() {
	let db = Database::new();

	let mut tx = db.transaction(true);

	tx.set("key", "original").unwrap();
	tx.set_savepoint().unwrap();

	// Delete and recreate
	tx.del("key").unwrap();
	tx.set("key", "recreated").unwrap();

	assert_eq!(tx.get("key").unwrap(), Some(Bytes::from("recreated")));

	tx.rollback_to_savepoint().unwrap();

	// Should be back to original
	assert_eq!(tx.get("key").unwrap(), Some(Bytes::from("original")));

	tx.commit().unwrap();
}

#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test)]
#[test]
fn savepoint_stress_many_savepoints() {
	let db = Database::new();

	let mut tx = db.transaction(true);

	let num_savepoints = 100;

	// Create many nested savepoints
	for i in 0..num_savepoints {
		tx.set_savepoint().unwrap();
		tx.set(format!("key_{}", i), format!("value_{}", i)).unwrap();
	}

	// Verify all keys exist
	for i in 0..num_savepoints {
		assert!(tx.get(format!("key_{}", i)).unwrap().is_some());
	}

	// Rollback half of them
	for _ in 0..(num_savepoints / 2) {
		tx.rollback_to_savepoint().unwrap();
	}

	// First half should still exist
	for i in 0..(num_savepoints / 2) {
		assert!(tx.get(format!("key_{}", i)).unwrap().is_some(), "key_{} should exist", i);
	}

	// Second half should not exist
	for i in (num_savepoints / 2)..num_savepoints {
		assert!(tx.get(format!("key_{}", i)).unwrap().is_none(), "key_{} should not exist", i);
	}

	tx.commit().unwrap();
}

#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test)]
#[test]
fn savepoint_preserves_existing_data() {
	let db = Database::new();

	// Create initial data
	let mut setup = db.transaction(true);
	setup.set("existing1", "value1").unwrap();
	setup.set("existing2", "value2").unwrap();
	setup.commit().unwrap();

	// New transaction with savepoint
	let mut tx = db.transaction(true);

	// Read existing data
	assert_eq!(tx.get("existing1").unwrap(), Some(Bytes::from("value1")));

	tx.set_savepoint().unwrap();

	// Modify existing and add new
	tx.set("existing1", "modified").unwrap();
	tx.set("new_key", "new_value").unwrap();

	tx.rollback_to_savepoint().unwrap();

	// Existing data should still be visible (from database)
	assert_eq!(tx.get("existing1").unwrap(), Some(Bytes::from("value1")));
	assert_eq!(tx.get("existing2").unwrap(), Some(Bytes::from("value2")));
	assert!(tx.get("new_key").unwrap().is_none());

	tx.commit().unwrap();
}

#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test)]
#[test]
fn savepoint_with_conditional_operations() {
	let db = Database::new();

	let mut tx = db.transaction(true);

	tx.set("key", "initial").unwrap();
	tx.set_savepoint().unwrap();

	// Use conditional put - should fail because key exists
	let result = tx.put("key", "should_fail");
	assert!(result.is_err());

	// Key should still have initial value
	assert_eq!(tx.get("key").unwrap(), Some(Bytes::from("initial")));

	// Modify with set
	tx.set("key", "modified").unwrap();

	tx.rollback_to_savepoint().unwrap();

	// Should be back to initial
	assert_eq!(tx.get("key").unwrap(), Some(Bytes::from("initial")));

	tx.commit().unwrap();
}