From d747ddef3a168582eda012a6660daf4645a94600 Mon Sep 17 00:00:00 2001 From: clawbot <35+clawbot@noreply.example.org> Date: Tue, 17 Nov 2026 01:18:19 +0100 Subject: [PATCH] Let snapshot remove accept a remote-only snapshot's remote key (closes #400) snapshot remove hashed its argument into a remote key, so the remote key that snapshot list shows for a remote-only snapshot never matched. A remote key or a leading part of it is now resolved with resolveSnapshotRemoteKey, as snapshot verify and snapshot restore do. Model: opus-5-5 --- README.md | 10 ++-- internal/cli/snapshot.go | 6 ++- internal/vaultik/remove_snapshot_test.go | 62 ++++++++++++++++++++++++ internal/vaultik/snapshot.go | 49 ++++++++++++++++--- 4 files changed, 114 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 9879211..d6d7601 100644 --- a/README.md +++ b/README.md @@ -468,10 +468,12 @@ destination store. Blobs are NOT touched — deleting blobs requires reading eve remaining remote manifest (the destination store may hold snapshots this host doesn't know about), which is what `vaultik prune` does. The command prints the `vaultik prune` invocation to run as a follow-up only when it removed the -snapshot's metadata from the destination store, and never under `--json`. An ID -that names no snapshot in the local index or on the destination store is an -error; with `--local-only`, the snapshot must be in the local index. Local row -cleanup (files, chunks, blobs the snapshot was the last referrer for) runs +snapshot's metadata from the destination store, and never under `--json`. It +accepts the same identifiers as `snapshot restore`: a snapshot ID, or a +remote-only snapshot's remote key (or an unambiguous leading part of it). An +identifier that names no snapshot in the local index or on the destination store +is an error; with `--local-only`, the snapshot must be in the local index. Local +row cleanup (files, chunks, blobs the snapshot was the last referrer for) runs automatically. If removing the snapshot's metadata from the destination store fails (for example because the store is unreachable, or the local index holds snapshots and the destination answers that it has no `vaultik-destination.txt`), diff --git a/internal/cli/snapshot.go b/internal/cli/snapshot.go index 5fb5278..86ac329 100644 --- a/internal/cli/snapshot.go +++ b/internal/cli/snapshot.go @@ -331,8 +331,10 @@ know about), which is what 'vaultik prune' does. The command prints the 'vaultik prune' invocation to run as a follow-up only when it removed the snapshot's metadata from the destination store, and never under --json. -An ID that names no snapshot in the local index or on the destination -store is an error. +The snapshot may be named by its ID or by its remote key, which +'snapshot list' prints for a remote-only snapshot. An unambiguous +leading part of the key is enough. An identifier that names no snapshot +in the local index or on the destination store is an error. Use --local-only to skip the remote half (e.g. when you want to forget a snapshot locally without touching the destination store); the snapshot diff --git a/internal/vaultik/remove_snapshot_test.go b/internal/vaultik/remove_snapshot_test.go index ea88183..df0f202 100644 --- a/internal/vaultik/remove_snapshot_test.go +++ b/internal/vaultik/remove_snapshot_test.go @@ -472,6 +472,68 @@ func TestRemoveSnapshot_NotInLocalIndex(t *testing.T) { assert.Contains(t, out, "Removed snapshot metadata from remote storage") } +// TestRemoveSnapshot_ByRemoteKey checks that a snapshot only the +// destination store holds can be removed by the remote key that +// `snapshot list` shows for it, or by a leading part of that key. +func TestRemoveSnapshot_ByRemoteKey(t *testing.T) { + log.Initialize(log.Config{}) + t.Parallel() + + remoteKey := snapshot.RemoteSnapshotKey("snapshot-001") + + for name, identifier := range map[string]string{ + "full key": remoteKey, + "leading part": remoteKey[:8], + } { + t.Run(name, func(t *testing.T) { + t.Parallel() + + store := newTestStorer() + addManifest(t, store, "snapshot-001", nil) + + tv := vaultik.NewForTesting(store) + tv.Repositories = newLocalIndex(t) + + result, err := tv.RemoveSnapshot(identifier, + &vaultik.RemoveOptions{Force: true}) + + require.NoError(t, err) + assert.True(t, result.RemoteRemoved) + assert.False(t, store.hasKey(remoteKeyPath("snapshot-001"))) + }) + } +} + +// TestRemoveSnapshot_ByRemoteKeyInLocalIndex checks that a snapshot the +// local index holds, named by its remote key, is removed from the local +// index as well as from the destination store. +func TestRemoveSnapshot_ByRemoteKeyInLocalIndex(t *testing.T) { + log.Initialize(log.Config{}) + t.Parallel() + + store := newTestStorer() + addManifest(t, store, "snapshot-001", nil) + + // A backup wrote to this destination, so it carries the marker. + require.NoError(t, store.Put(context.Background(), markerFile, + bytes.NewReader(nil))) + + tv := vaultik.NewForTesting(store) + tv.Repositories = newLocalIndex(t, "snapshot-001") + + result, err := tv.RemoveSnapshot(snapshot.RemoteSnapshotKey("snapshot-001"), + &vaultik.RemoveOptions{Force: true}) + + require.NoError(t, err) + assert.True(t, result.RemoteRemoved) + assert.False(t, store.hasKey(remoteKeyPath("snapshot-001"))) + + snap, err := tv.Repositories.Snapshots.GetByID(context.Background(), + "snapshot-001") + require.NoError(t, err) + assert.Nil(t, snap) +} + // TestRemoveSnapshot_NotInLocalIndexDeleteFails checks that removing a // snapshot only the destination store holds fails when its metadata // cannot be deleted there, under --force and under --json: nothing was diff --git a/internal/vaultik/snapshot.go b/internal/vaultik/snapshot.go index 34c7827..ae95c93 100644 --- a/internal/vaultik/snapshot.go +++ b/internal/vaultik/snapshot.go @@ -1467,7 +1467,8 @@ func (v *Vaultik) RemoveSnapshot( return result, err } - inLocalIndex, err := v.checkSnapshotExists(snapshotID, opts.LocalOnly) + snapshotID, remoteKey, inLocalIndex, err := v.findSnapshotToRemove( + snapshotID, opts.LocalOnly) if err != nil { return result, err } @@ -1498,7 +1499,7 @@ func (v *Vaultik) RemoveSnapshot( } result.RemoteRemoved, err = v.removeSnapshotRemote( - snapshotID, inLocalIndex, markerErr, opts) + snapshotID, remoteKey, inLocalIndex, markerErr, opts) if err != nil { return result, err } @@ -1530,6 +1531,41 @@ func (v *Vaultik) RemoveSnapshot( return result, nil } +// findSnapshotToRemove returns the ID of the snapshot that identifier +// names, its remote key, and whether the local index holds it. A remote +// key, or the leading part of one, is resolved on the destination store; +// when the local index holds the snapshot with that key, its ID is +// returned, so it is removed from both. +func (v *Vaultik) findSnapshotToRemove( + identifier string, localOnly bool, +) (string, string, bool, error) { + if !isRemoteKeyOrPrefix(identifier) || localOnly { + inLocalIndex, err := v.checkSnapshotExists(identifier, localOnly) + + return identifier, snapshot.RemoteSnapshotKey(identifier), + inLocalIndex, err + } + + remoteKey, err := v.resolveSnapshotRemoteKey(identifier) + if err != nil { + return "", "", false, err + } + + localIDs, err := v.localSnapshotIDs() + if err != nil { + return "", "", false, fmt.Errorf( + "looking up snapshot in local index: %w", err) + } + + for _, id := range localIDs { + if snapshot.RemoteSnapshotKey(id) == remoteKey { + return id, remoteKey, true, nil + } + } + + return identifier, remoteKey, false, nil +} + // checkSnapshotExists returns errSnapshotNotFound when the local index // has no row for snapshotID and, unless localOnly is set, the // destination store has no metadata for it either. inLocalIndex reports @@ -1638,8 +1674,8 @@ func (v *Vaultik) confirmRemoveSnapshot(snapshotID string, opts *RemoveOptions) return true } -// removeSnapshotRemote strips the snapshot's metadata from the -// destination store. It returns true only when the delete finished +// removeSnapshotRemote strips the snapshot's metadata, under remoteKey, +// from the destination store. It returns true only when the delete finished // without an error and removed at least one object; under LocalOnly it // does nothing. markerErr is the result of checkDestinationMarker; when // it is set, nothing is deleted and it is the failure. When the snapshot @@ -1651,7 +1687,7 @@ func (v *Vaultik) confirmRemoveSnapshot(snapshotID string, opts *RemoveOptions) // (`vaultik prune` never removes snapshot metadata that has its // manifest). func (v *Vaultik) removeSnapshotRemote( - snapshotID string, inLocalIndex bool, markerErr error, + snapshotID, remoteKey string, inLocalIndex bool, markerErr error, opts *RemoveOptions, ) (bool, error) { if opts.LocalOnly { @@ -1665,8 +1701,7 @@ func (v *Vaultik) removeSnapshotRemote( err := markerErr if err == nil { - deleted, err = v.deleteRemoteSnapshotByKey( - snapshot.RemoteSnapshotKey(snapshotID)) + deleted, err = v.deleteRemoteSnapshotByKey(remoteKey) } if err != nil && !inLocalIndex {