diff --git a/docs/DATAMODEL.md b/docs/DATAMODEL.md index c02be9c..c4f6094 100644 --- a/docs/DATAMODEL.md +++ b/docs/DATAMODEL.md @@ -315,8 +315,8 @@ The restore process doesn't use the local database. Instead: and no local snapshot record, once every object in it is older than `prune_grace_period` 3. **Delete Partial Uploads** - - Delete each `.partial` object a killed upload left under `metadata/` or - `blobs/`, once it is older than `prune_grace_period` + - Delete each `.partial` object under `metadata/` or `blobs/` left by a + killed upload, once it is older than `prune_grace_period` ### 6. Incomplete Snapshot Cleanup diff --git a/internal/storage/storer.go b/internal/storage/storer.go index 34d10cb..06c8165 100644 --- a/internal/storage/storer.go +++ b/internal/storage/storer.go @@ -77,9 +77,9 @@ type Storer interface { // If an error occurs during listing, the final item will have Err set. ListStream(ctx context.Context, prefix string) <-chan ObjectInfo - // ListPartialUploads returns each object under prefix that an upload - // cut off part-way left under a temporary name ending in `.partial`, - // with its key, size and modification time. The file and rclone + // ListPartialUploads returns each object under prefix whose name ends + // in `.partial`, as a killed upload leaves it, with its key, size and + // modification time. The file and rclone // backends' List and ListStream skip such an object; Delete removes // it. ListPartialUploads(ctx context.Context, prefix string) ([]ObjectInfo, error) diff --git a/internal/vaultik/info.go b/internal/vaultik/info.go index 53721b4..5e19152 100644 --- a/internal/vaultik/info.go +++ b/internal/vaultik/info.go @@ -216,8 +216,8 @@ type RemoteInfoResult struct { OrphanedBlobCount *int `json:"orphaned_blob_count"` OrphanedBlobSize *int64 `json:"orphaned_blob_size"` - // `.partial` objects under metadata/ and blobs/ that uploads cut off - // part-way left. The blob figures above leave them out. + // `.partial` objects under metadata/ and blobs/ left by killed + // uploads. The blob figures above leave them out. PartialUploadCount int `json:"partial_upload_count"` PartialUploadSize int64 `json:"partial_upload_size"` diff --git a/internal/vaultik/prune.go b/internal/vaultik/prune.go index 4d9b3c3..c359cf0 100644 --- a/internal/vaultik/prune.go +++ b/internal/vaultik/prune.go @@ -159,8 +159,8 @@ func (v *Vaultik) deleteEverythingUnder(prefix string) ([]string, error) { } // listEverythingUnder returns the key of every object under prefix, -// including the `.partial` objects uploads cut off part-way left, which -// the file and rclone backends' List skips. +// including the `.partial` objects left by killed uploads, which the file +// and rclone backends' List skips. func (v *Vaultik) listEverythingUnder(prefix string) ([]string, error) { keys, err := v.Storage.List(v.ctx, prefix) if err != nil { @@ -181,7 +181,7 @@ func (v *Vaultik) listEverythingUnder(prefix string) ([]string, error) { } // listPartialUploads returns the `.partial` objects under metadata/ and -// blobs/ that uploads cut off part-way left. +// blobs/ left by killed uploads. func (v *Vaultik) listPartialUploads() ([]storage.ObjectInfo, error) { var partialUploads []storage.ObjectInfo @@ -215,10 +215,10 @@ type PruneBlobsResult struct { // not delete. MetadataDirsDeleted int `json:"metadata_dirs_deleted"` MetadataDirsFailed int `json:"metadata_dirs_failed,omitempty"` - // PartialUploadsDeleted counts the `.partial` objects uploads cut off - // part-way left that prune deleted, and PartialUploadsFailed those it - // could not delete. PartialUploadsTooNew counts those kept for being - // newer than the prune grace period, or of unknown age. + // PartialUploadsDeleted counts the `.partial` objects prune deleted, + // and PartialUploadsFailed those it could not delete. + // PartialUploadsTooNew counts those kept for being newer than the + // prune grace period, or of unknown age. PartialUploadsDeleted int `json:"partial_uploads_deleted"` PartialUploadsFailed int `json:"partial_uploads_failed,omitempty"` PartialUploadsTooNew int `json:"partial_uploads_too_new"` @@ -226,8 +226,8 @@ type PruneBlobsResult struct { // Prune removes orphaned data from the local index database AND, from the // backup destination store, unreferenced blobs, the directories under -// metadata/ with no manifest and the `.partial` objects uploads cut off -// part-way left. This is the single user-facing prune entry +// metadata/ with no manifest and the `.partial` objects left by killed +// uploads. This is the single user-facing prune entry // point — the split between local and remote cleanup is an // implementation detail. Calling code should prefer this method over // PruneDatabase or PruneBlobs individually unless it specifically wants @@ -257,7 +257,7 @@ func (v *Vaultik) Prune(opts *PruneOptions) error { // PruneBlobs removes unreferenced blobs from storage, each directory // under metadata/ that a backup left with no manifest, and each -// `.partial` object an upload cut off part-way left. +// `.partial` object left by a killed upload. func (v *Vaultik) PruneBlobs(opts *PruneOptions) error { log.Info("Starting prune operation") diff --git a/internal/vaultik/prune_partial_upload_test.go b/internal/vaultik/prune_partial_upload_test.go index c70d173..80f6e33 100644 --- a/internal/vaultik/prune_partial_upload_test.go +++ b/internal/vaultik/prune_partial_upload_test.go @@ -24,7 +24,7 @@ import ( const partialUploadGracePeriod = time.Hour // newPartialUploadStore returns a vaultik on a file:// destination -// holding the `.partial` files killed uploads leave: one under blobs/ +// holding `.partial` files left by killed uploads: one under blobs/ // and one under metadata/ older than the prune grace period, and one // under blobs/ newer than that. It also returns the buffer the vaultik // writes its output to, the paths of the old files and the path of the @@ -73,8 +73,8 @@ func newPartialUploadStore( } // TestPruneDeletesPartialUploadsOlderThanGracePeriod checks that prune -// deletes a `.partial` file a killed upload left under blobs/ or -// metadata/ once it is older than the grace period, keeps a newer one, +// deletes a `.partial` file under blobs/ or metadata/ left by a killed +// upload once it is older than the grace period, keeps a newer one, // and counts both in the --json document. func TestPruneDeletesPartialUploadsOlderThanGracePeriod(t *testing.T) { log.Initialize(log.Config{})