Merge pull request #329 from meilisearch/fix-examples-package

Fix examples package

Author: Kerollmops

convert-to-heed3.sh

@@ -14,12 +14,16 @@ set -e
 # the heed folder...
 if [[ "$OSTYPE" == "cygwin" || "$OSTYPE" == "msys" ]]; then
     cp heed3\\Cargo.toml heed\\Cargo.toml
+    rm -rf heed\\examples
+    cp -R heed3\\examples heed\\examples
 else
     cp heed3/Cargo.toml heed/Cargo.toml
+    rm -rf heed/examples
+    cp -R heed3/examples heed/examples
 fi
 
 # ...and replaces the `heed::` string by the `heed3::` one.
-for file in $(find heed/src -type f -name "*.rs") examples/prev-snapshot.rs; do
+for file in $(find heed/src -type f -name "*.rs"); do
     if [[ "$OSTYPE" == "darwin"* ]]; then
         sed -i '' 's/heed::/heed3::/g' "$file"
     else
@@ -31,6 +35,13 @@ done
 git config --local user.email "ci@github.com"
 git config --local user.name "The CI"
 
+# Adds the new examples to the changes
+if [[ "$OSTYPE" == "cygwin" || "$OSTYPE" == "msys" ]]; then
+    git add heed\\examples
+else
+    git add heed/examples
+fi
+
 # But only commit if there is something to commit
 git diff -q --exit-code || git commit -am 'remove-me: heed3 changes generated by the convert-to-heed3.sh script'
 

heed/Cargo.toml

@@ -9,15 +9,6 @@ keywords = ["lmdb", "database", "storage", "typed"]
 categories = ["database", "data-structures"]
 readme = "../README.md"
 edition = "2021"
-include = [
-    "../examples/all-types.rs",
-    "../examples/clear-database.rs",
-    "../examples/cursor-append.rs",
-    "../examples/custom-comparator.rs",
-    "../examples/multi-env.rs",
-    "../examples/nested.rs",
-    "../examples/rmp-serde.rs",
-]
 
 [dependencies]
 bitflags = { version = "2.9.0", features = ["serde"] }
@@ -113,41 +104,30 @@ longer-keys = ["lmdb-master-sys/longer-keys"]
 # <https://github.com/LMDB/lmdb/blob/f20e41de09d97e4461946b7e26ec831d0c24fac7/libraries/liblmdb/mdb.c#L205-L218>
 use-valgrind = ["lmdb-master-sys/use-valgrind"]
 
-# Examples are located outside the standard heed/examples directory to prevent
-# conflicts between heed3 and heed examples when working on both crates.
 [[example]]
 name = "all-types"
-path = "../examples/all-types.rs"
 
 [[example]]
 name = "clear-database"
-path = "../examples/clear-database.rs"
 
 [[example]]
 name = "cursor-append"
-path = "../examples/cursor-append.rs"
 
 [[example]]
 name = "custom-comparator"
-path = "../examples/custom-comparator.rs"
 
 [[example]]
 name = "custom-dupsort-comparator"
-path = "../examples/custom-dupsort-comparator.rs"
 
 [[example]]
 name = "multi-env"
-path = "../examples/multi-env.rs"
 
 [[example]]
 name = "nested"
-path = "../examples/nested.rs"
 
 [[example]]
 name = "prev-snapshot"
-path = "../examples/prev-snapshot.rs"
 
 [[example]]
 name = "rmp-serde"
-path = "../examples/rmp-serde.rs"
 required-features = ["serde-rmp"]

examples/all-types.rs renamed to heed/examples/all-types.rs

@@ -9,7 +9,6 @@ keywords = ["lmdb", "database", "storage", "typed", "encryption"]
 categories = ["database", "data-structures"]
 readme = "../README.md"
 edition = "2021"
-include = ["../examples/heed3-encrypted.rs", "../examples/heed3-all-types.rs"]
 
 [dependencies]
 aead = { version = "0.5.2", default-features = false }
@@ -113,12 +112,9 @@ use-valgrind = ["lmdb-master3-sys/use-valgrind"]
 # conflicts between heed3 and heed examples when working on both crates.
 [[example]]
 name = "prev-snapshot"
-path = "../examples/prev-snapshot.rs"
 
 [[example]]
 name = "heed3-encrypted"
-path = "../examples/heed3-encrypted.rs"
 
 [[example]]
 name = "heed3-all-types"
-path = "../examples/heed3-all-types.rs"

examples/clear-database.rs renamed to heed/examples/clear-database.rs

@@ -0,0 +1,85 @@
+use std::error::Error;
+
+use heed3::types::*;
+use heed3::{Database, EnvFlags, EnvOpenOptions};
+
+// In this test we are checking that we can move to a previous environement snapshot.
+fn main() -> Result<(), Box<dyn Error>> {
+    let env_path = tempfile::tempdir()?;
+
+    let env = unsafe {
+        EnvOpenOptions::new()
+            .map_size(10 * 1024 * 1024) // 10MB
+            .max_dbs(3)
+            .open(&env_path)?
+    };
+
+    let mut wtxn = env.write_txn()?;
+    let db: Database<Str, Str> = env.create_database(&mut wtxn, None)?;
+
+    // We fill the db database with entries.
+    db.put(&mut wtxn, "I am here", "to test things")?;
+    db.put(&mut wtxn, "I am here too", "for the same purpose")?;
+
+    wtxn.commit()?;
+
+    env.prepare_for_closing().wait();
+
+    // We can get the env state from before the last commit
+    // and therefore see an empty env.
+    let env = unsafe {
+        EnvOpenOptions::new()
+            .map_size(10 * 1024 * 1024) // 10MB
+            .max_dbs(3)
+            .flags(EnvFlags::PREV_SNAPSHOT)
+            .open(&env_path)?
+    };
+
+    let mut wtxn = env.write_txn()?;
+    let db: Database<Str, Str> = env.create_database(&mut wtxn, None)?;
+
+    assert!(db.is_empty(&wtxn)?);
+
+    wtxn.abort();
+    env.prepare_for_closing().wait();
+
+    // However, if we don't commit we can still get
+    // back the latest version of the env.
+    let env = unsafe {
+        EnvOpenOptions::new()
+            .map_size(10 * 1024 * 1024) // 10MB
+            .max_dbs(3)
+            .open(&env_path)?
+    };
+
+    let mut wtxn = env.write_txn()?;
+    let db: Database<Str, Str> = env.create_database(&mut wtxn, None)?;
+
+    assert_eq!(db.get(&wtxn, "I am here")?, Some("to test things"));
+    assert_eq!(db.get(&wtxn, "I am here too")?, Some("for the same purpose"));
+
+    // And write new stuff in the env.
+    db.put(&mut wtxn, "I will fade away", "I am so sad")?;
+
+    wtxn.commit()?;
+    env.prepare_for_closing().wait();
+
+    // Once again we can get back the previous version
+    // of the env and see some entries disappear.
+    let env = unsafe {
+        EnvOpenOptions::new()
+            .map_size(10 * 1024 * 1024) // 10MB
+            .max_dbs(3)
+            .flags(EnvFlags::PREV_SNAPSHOT)
+            .open(&env_path)?
+    };
+
+    let rtxn = env.read_txn()?;
+    let db: Database<Str, Str> = env.open_database(&rtxn, None)?.unwrap();
+
+    assert_eq!(db.get(&rtxn, "I am here")?, Some("to test things"));
+    assert_eq!(db.get(&rtxn, "I am here too")?, Some("for the same purpose"));
+    assert_eq!(db.get(&rtxn, "I will fade away")?, None);
+
+    Ok(())
+}