feat(core): repository APIs to identify snapshots using latest~N (#426)

Author: nardoor

crates/backend/src/rclone.rs

@@ -178,7 +178,8 @@ impl RcloneBackend {
         let user = Alphanumeric.sample_string(&mut rng(), 12);
         let password = Alphanumeric.sample_string(&mut rng(), 12);
 
-        let mut rclone_command = rclone_command.map_or(DEFAULT_COMMAND.to_string(), Clone::clone);
+        let mut rclone_command =
+            rclone_command.map_or_else(|| DEFAULT_COMMAND.to_string(), Clone::clone);
         rclone_command.push(' ');
         rclone_command.push_str(url.as_ref());
         let rclone_command: CommandInput = rclone_command.parse().map_err(

crates/core/src/commands/forget.rs

@@ -81,7 +81,7 @@ pub(crate) fn get_forget_snapshots<P: ProgressBars, S: Open>(
     repo: &Repository<P, S>,
     keep: &KeepOptions,
     group_by: SnapshotGroupCriterion,
-    filter: impl FnMut(&SnapshotFile) -> bool,
+    filter: impl FnMut(&SnapshotFile) -> bool + Send + Sync,
 ) -> RusticResult<ForgetGroups> {
     let now = Local::now();
 

crates/core/src/commands/snapshots.rs

@@ -1,4 +1,6 @@
-//! `smapshot` subcommand
+//! `snapshot` subcommand
+
+use itertools::Itertools;
 
 use crate::{
     Progress,
@@ -22,6 +24,7 @@ use crate::{
 ///
 /// * `repo` - The repository to get the snapshots from.
 /// * `ids` - The ids of the snapshots to get.
+///   * each `id` can use an actual (short) id "01a2b3c4" or "latest" or "latest~N"
 /// * `group_by` - The criterion to group the snapshots by.
 /// * `filter` - The filter to apply to the snapshots.
 ///
@@ -32,30 +35,23 @@ pub(crate) fn get_snapshot_group<P: ProgressBars, S: Open>(
     repo: &Repository<P, S>,
     ids: &[String],
     group_by: SnapshotGroupCriterion,
-    filter: impl FnMut(&SnapshotFile) -> bool,
+    filter: impl FnMut(&SnapshotFile) -> bool + Send + Sync,
 ) -> RusticResult<Vec<(SnapshotGroup, Vec<SnapshotFile>)>> {
     let pb = &repo.pb;
     let dbe = repo.dbe();
     let p = pb.progress_counter("getting snapshots...");
-    let groups = match ids {
-        [] => SnapshotFile::group_from_backend(dbe, filter, group_by, &p)?,
-        [id] if id == "latest" => SnapshotFile::group_from_backend(dbe, filter, group_by, &p)?
+    let groups = if ids.is_empty() {
+        SnapshotFile::group_from_backend(dbe, filter, group_by, &p)?
+    } else {
+        let snaps = SnapshotFile::from_strs(dbe, ids, filter, &p)?;
+        let mut result = Vec::new();
+        for (group, snaps) in &snaps
             .into_iter()
-            .map(|(group, mut snaps)| {
-                snaps.sort_unstable();
-                let last_idx = snaps.len() - 1;
-                snaps.swap(0, last_idx);
-                snaps.truncate(1);
-                (group, snaps)
-            })
-            .collect::<Vec<_>>(),
-        _ => {
-            let item = (
-                SnapshotGroup::default(),
-                SnapshotFile::from_ids(dbe, ids, &p)?,
-            );
-            vec![item]
+            .chunk_by(|sn| SnapshotGroup::from_snapshot(sn, group_by))
+        {
+            result.push((group, snaps.collect()));
         }
+        result
     };
     p.finish();
 

crates/core/src/error.rs

@@ -173,7 +173,7 @@ pub struct RusticError {
     context: EcoVec<(EcoString, EcoString)>,
 
     /// Chain to the cause of the error.
-    source: Option<Box<(dyn std::error::Error + Send + Sync)>>,
+    source: Option<Box<dyn std::error::Error + Send + Sync>>,
 
     /// Severity of the error.
     severity: Option<Severity>,
@@ -346,7 +346,7 @@ impl RusticError {
     pub fn with_source(
         kind: ErrorKind,
         guidance: impl Into<EcoString>,
-        source: impl Into<Box<(dyn std::error::Error + Send + Sync)>>,
+        source: impl Into<Box<dyn std::error::Error + Send + Sync>>,
     ) -> Box<Self> {
         Self::new(kind, guidance).attach_source(source)
     }
@@ -445,7 +445,7 @@ impl RusticError {
     /// Attach a chain to the cause of the error.
     pub fn attach_source(
         self,
-        value: impl Into<Box<(dyn std::error::Error + Send + Sync)>>,
+        value: impl Into<Box<dyn std::error::Error + Send + Sync>>,
     ) -> Box<Self> {
         Box::new(Self {
             source: Some(value.into()),

crates/core/src/lib.rs

@@ -153,7 +153,7 @@ pub use crate::{
         PathList, SnapshotGroup, SnapshotGroupCriterion, SnapshotOptions, StringList,
     },
     repository::{
-        FullIndex, IndexedFull, IndexedIds, IndexedStatus, IndexedTree, Open, OpenStatus,
+        FullIndex, IdIndex, IndexedFull, IndexedIds, IndexedStatus, IndexedTree, Open, OpenStatus,
         Repository, RepositoryOptions,
         command_input::{CommandInput, CommandInputErrorKind},
     },

crates/core/src/repofile/configfile.rs

@@ -53,7 +53,7 @@ pub struct ConfigFile {
     /// Repository version. Currently 1 and 2 are supported
     pub version: u32,
 
-    /// The [`Id`] identifying the repsitory
+    /// The [`Id`] identifying the repository
     pub id: RepositoryId,
 
     /// The chunker polynomial used to chunk data

crates/core/src/repository.rs

@@ -938,7 +938,7 @@ impl<P: ProgressBars, S: Open> Repository<P, S> {
         &self,
         ids: &[String],
         group_by: SnapshotGroupCriterion,
-        filter: impl FnMut(&SnapshotFile) -> bool,
+        filter: impl FnMut(&SnapshotFile) -> bool + Send + Sync,
     ) -> RusticResult<Vec<(SnapshotGroup, Vec<SnapshotFile>)>> {
         commands::snapshots::get_snapshot_group(self, ids, group_by, filter)
     }
@@ -959,7 +959,7 @@ impl<P: ProgressBars, S: Open> Repository<P, S> {
     /// # Returns
     ///
     /// If `id` is (part of) an `Id`, return this snapshot.
-    /// If `id` is "latest", return the latest snapshot respecting the giving filter.
+    /// If `id` is "latest" or "latest~N", return the latest (or Nth latest) snapshot respecting the giving filter.
     pub fn get_snapshot_from_str(
         &self,
         id: &str,
@@ -971,6 +971,35 @@ impl<P: ProgressBars, S: Open> Repository<P, S> {
         Ok(snap)
     }
 
+    /// Get a single snapshot
+    ///
+    /// # Arguments
+    ///
+    /// * `ids` - The ids of the snapshot to get
+    ///   * each `id` can use an actual (short) id "01a2b3c4" or "latest" or "latest~N"
+    /// * `filter` - The filter to use
+    ///
+    /// # Errors
+    ///
+    /// * If the string is not a valid hexadecimal string
+    /// * If no id could be found.
+    /// * If the id is not unique.
+    ///
+    /// # Returns
+    ///
+    /// If `id` is (part of) an `Id`, return this snapshot.
+    /// If `id` is "latest" or "latest~N", return the latest (or Nth latest) snapshot respecting the giving filter.
+    pub fn get_snapshots_from_strs<T: AsRef<str>>(
+        &self,
+        ids: &[T],
+        filter: impl FnMut(&SnapshotFile) -> bool + Send + Sync,
+    ) -> RusticResult<Vec<SnapshotFile>> {
+        let p = self.pb.progress_counter("getting snapshots...");
+        let snaps = SnapshotFile::from_strs(self.dbe(), ids, filter, &p)?;
+        p.finish();
+        Ok(snaps)
+    }
+
     /// Get the given snapshots.
     ///
     /// # Arguments
@@ -1104,7 +1133,7 @@ impl<P: ProgressBars, S: Open> Repository<P, S> {
         &self,
         keep: &KeepOptions,
         group_by: SnapshotGroupCriterion,
-        filter: impl FnMut(&SnapshotFile) -> bool,
+        filter: impl FnMut(&SnapshotFile) -> bool + Send + Sync,
     ) -> RusticResult<ForgetGroups> {
         commands::forget::get_forget_snapshots(self, keep, group_by, filter)
     }

crates/core/tests/integration.rs

@@ -32,6 +32,7 @@ mod integration {
     mod ls;
     mod prune;
     mod restore;
+    mod snapshots;
     mod vfs;
     use super::*;
 }
@@ -100,11 +101,10 @@ fn insta_snapshotfile_redaction() -> Settings {
 
     settings.add_redaction(".**.tree", "[tree_id]");
     settings.add_dynamic_redaction(".**.program_version", |val, _| {
-        val.resolve_inner()
-            .as_str()
-            .map_or("[program_version]".to_string(), |v| {
-                v.replace(env!("CARGO_PKG_VERSION"), "[rustic_core_version]")
-            })
+        val.resolve_inner().as_str().map_or_else(
+            || "[program_version]".to_string(),
+            |v| v.replace(env!("CARGO_PKG_VERSION"), "[rustic_core_version]"),
+        )
     });
     settings.add_redaction(".**.time", "[time]");
     settings.add_dynamic_redaction(".**.parent", handle_option);