idb 0.6.5

A futures based crate for interacting with IndexedDB on browsers using webassembly
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

use idb::{DatabaseEvent, Factory, ObjectStoreParams, TransactionMode, TransactionResult};
use wasm_bindgen_test::wasm_bindgen_test;

#[wasm_bindgen_test]
async fn test_transaction_commit() {
    let factory = Factory::new().unwrap();
    factory.delete("test").unwrap().await.unwrap();

    let mut open_request = factory.open("test", Some(1)).unwrap();
    open_request.on_upgrade_needed(|event| {
        let database = event.database().unwrap();

        database
            .create_object_store("store1", ObjectStoreParams::new())
            .unwrap();
    });

    let database = open_request.await.unwrap();

    let transaction = database
        .transaction(&["store1"], TransactionMode::ReadWrite)
        .unwrap();

    let store = transaction.object_store("store1").unwrap();
    let id = store
        .add(
            &serde_wasm_bindgen::to_value("hello").unwrap(),
            Some(&serde_wasm_bindgen::to_value("world").unwrap()),
        )
        .unwrap()
        .await;

    assert!(id.is_ok(), "id should be ok: {}", id.unwrap_err());
    let id = id.unwrap();
    assert_eq!(serde_wasm_bindgen::to_value("world").unwrap(), id);

    let commit = transaction.commit().unwrap().await;
    assert!(
        commit.is_ok(),
        "commit should be ok: {}",
        commit.unwrap_err()
    );
    let commit = commit.unwrap();
    assert!(matches!(commit, TransactionResult::Committed));

    let read_transaction = database
        .transaction(&["store1"], TransactionMode::ReadOnly)
        .unwrap();
    let read_store = read_transaction.object_store("store1").unwrap();

    let count = read_store.count(None).unwrap().await;
    assert!(count.is_ok(), "count should be ok: {}", count.unwrap_err());
    let count = count.unwrap();

    assert_eq!(count, 1);

    let value = read_store
        .get(serde_wasm_bindgen::to_value("world").unwrap())
        .unwrap()
        .await;
    assert!(value.is_ok(), "value should be ok: {}", value.unwrap_err());
    let value = value.unwrap().unwrap();

    assert_eq!(value, serde_wasm_bindgen::to_value("hello").unwrap());

    database.close();
    factory.delete("test").unwrap().await.unwrap();
}

#[wasm_bindgen_test]
async fn test_transaction_abort() {
    let factory = Factory::new().unwrap();
    factory.delete("test").unwrap().await.unwrap();

    let mut open_request = factory.open("test", Some(1)).unwrap();
    open_request.on_upgrade_needed(|event| {
        let database = event.database().unwrap();

        database
            .create_object_store("store1", ObjectStoreParams::new())
            .unwrap();
    });

    let database = open_request.await.unwrap();

    let transaction = database
        .transaction(&["store1"], TransactionMode::ReadWrite)
        .unwrap();

    let store = transaction.object_store("store1").unwrap();
    let id = store
        .add(
            &serde_wasm_bindgen::to_value("hello").unwrap(),
            Some(&serde_wasm_bindgen::to_value("world").unwrap()),
        )
        .unwrap()
        .await;

    assert!(id.is_ok(), "id should be ok: {}", id.unwrap_err());
    let id = id.unwrap();
    assert_eq!(serde_wasm_bindgen::to_value("world").unwrap(), id);

    let abort = transaction.abort().unwrap().await;
    assert!(abort.is_ok(), "abort should be ok: {}", abort.unwrap_err());
    let abort = abort.unwrap();
    assert!(matches!(abort, TransactionResult::Aborted));

    let read_transaction = database
        .transaction(&["store1"], TransactionMode::ReadOnly)
        .unwrap();
    let read_store = read_transaction.object_store("store1").unwrap();

    let count = read_store.count(None).unwrap().await;
    assert!(count.is_ok(), "count should be ok: {}", count.unwrap_err());
    let count = count.unwrap();

    assert_eq!(count, 0);

    database.close();
    factory.delete("test").unwrap().await.unwrap();
}

#[wasm_bindgen_test]
async fn test_transaction_error() {
    let factory = Factory::new().unwrap();
    factory.delete("test").unwrap().await.unwrap();

    let mut open_request = factory.open("test", Some(1)).unwrap();
    open_request.on_upgrade_needed(|event| {
        let database = event.database().unwrap();

        database
            .create_object_store("store1", ObjectStoreParams::new())
            .unwrap();
    });

    let mut database = open_request.await.unwrap();
    database.on_version_change(|event| {
        event.database().unwrap().close();
    });

    let transaction = database
        .transaction(&["store1"], TransactionMode::ReadWrite)
        .unwrap();

    let store = transaction.object_store("store1").unwrap();
    store
        .add(
            &serde_wasm_bindgen::to_value("hello").unwrap(),
            Some(&serde_wasm_bindgen::to_value("world").unwrap()),
        )
        .unwrap()
        .await
        .unwrap();

    let mut open_request = factory.open("test", Some(2)).unwrap();
    open_request.on_upgrade_needed(|event| {
        let database = event.database().unwrap();

        database
            .create_object_store("store2", ObjectStoreParams::new())
            .unwrap();
    });

    let database = open_request.await.unwrap();

    let error = transaction.commit();
    assert!(error.is_err(), "commit should fail"); // Note that the value may still get committed to the store depending on indexedDB implementation on the browser

    database.close();
    factory.delete("test").unwrap().await.unwrap();
}

#[wasm_bindgen_test]
async fn test_transaction_read_write_in_loop() {
    let factory = Factory::new().unwrap();
    factory.delete("test").unwrap().await.unwrap();

    let mut open_request = factory.open("test", Some(1)).unwrap();
    open_request.on_upgrade_needed(|event| {
        let database = event.database().unwrap();

        database
            .create_object_store("store1", ObjectStoreParams::new())
            .unwrap();
    });

    let database = open_request.await.unwrap();

    // 1. Insert 10 values in database

    let transaction = database
        .transaction(&["store1"], TransactionMode::ReadWrite)
        .unwrap();

    let store = transaction.object_store("store1").unwrap();

    for i in 0..10 {
        let id = store
            .add(
                &serde_wasm_bindgen::to_value("hello").unwrap(),
                Some(&serde_wasm_bindgen::to_value(&i.to_string()).unwrap()),
            )
            .unwrap()
            .await;

        assert!(id.is_ok(), "id should be ok: {}", id.unwrap_err());
        let id = id.unwrap();
        assert_eq!(serde_wasm_bindgen::to_value(&i.to_string()).unwrap(), id);
    }

    let commit = transaction.commit().unwrap().await;
    assert!(
        commit.is_ok(),
        "commit should be ok: {}",
        commit.unwrap_err()
    );

    // 2. Change all the values in database

    let transaction = database
        .transaction(&["store1"], TransactionMode::ReadWrite)
        .unwrap();

    let store = transaction.object_store("store1").unwrap();

    for i in 0..10 {
        let value = store
            .get(serde_wasm_bindgen::to_value(&i.to_string()).unwrap())
            .unwrap()
            .await;

        assert!(value.is_ok(), "value should be ok: {}", value.unwrap_err());
        let value = value.unwrap();

        assert!(value.is_some(), "value should be some");
        let value = value.unwrap();
        assert_eq!(value, serde_wasm_bindgen::to_value("hello").unwrap());

        let id = store
            .put(
                &serde_wasm_bindgen::to_value("hello").unwrap(),
                Some(&serde_wasm_bindgen::to_value(&i.to_string()).unwrap()),
            )
            .unwrap()
            .await;

        assert!(id.is_ok(), "id should be ok: {}", id.unwrap_err());
        let id = id.unwrap();
        assert_eq!(serde_wasm_bindgen::to_value(&i.to_string()).unwrap(), id);
    }

    transaction.commit().unwrap().await.unwrap();

    database.close();
    factory.delete("test").unwrap().await.unwrap();
}

#[wasm_bindgen_test]
async fn test_transaction_fail_event_loop_control() {
    let factory = Factory::new().unwrap();
    factory.delete("test").unwrap().await.unwrap();

    let mut open_request = factory.open("test", Some(1)).unwrap();
    open_request.on_upgrade_needed(|event| {
        let database = event.database().unwrap();

        database
            .create_object_store("store1", ObjectStoreParams::new())
            .unwrap();
    });

    let database = open_request.await.unwrap();

    // 1. Insert values in database

    let transaction = database
        .transaction(&["store1"], TransactionMode::ReadWrite)
        .unwrap();

    let store = transaction.object_store("store1").unwrap();

    let id1 = store
        .add(
            &serde_wasm_bindgen::to_value("hello").unwrap(),
            Some(&serde_wasm_bindgen::to_value(&0.to_string()).unwrap()),
        )
        .unwrap()
        .await;

    assert!(id1.is_ok(), "id1 should be ok: {}", id1.unwrap_err());

    gloo::timers::future::TimeoutFuture::new(50).await; // Gives the control back to event loop so that indexed db tries to auto-commit the transaction

    let id2 = store.add(
        &serde_wasm_bindgen::to_value("hello").unwrap(),
        Some(&serde_wasm_bindgen::to_value(&1.to_string()).unwrap()),
    );

    assert!(id2.is_err(), "id2 should be err: {:?}", id2);

    database.close();
    factory.delete("test").unwrap().await.unwrap();
}