Files
minio/cmd/restore-native_test.go
T
Feng Ruohang 45b1e4bc00 fix(restore): stage native restores outside the object lock
The unreleased native-restore fixes after RELEASE.2026-10-26T00-00-00Z
let the lock decide who owns a restore. Since fa42a0982 a single-pool
worker holds the object lock for the whole tier download, and since
7f38bf628 a busy lock means "a restore runs". 7f38bf628 also keeps the
restore's data in a marked multipart upload. Two regressions followed:

- While an old version restored, every GET, HEAD and write of the same
  key waited for the download. On a single pool this is new; with
  several pools the released code already held the lock that long.
- An ordinary upload whose completion failed after staging its metadata
  became InvalidUploadID for every caller, and could not be aborted for
  an hour. The marker that hid restore uploads could not tell them apart
  once a completion had rewritten the upload's xl.meta.

A restore now runs in two phases:

- The worker erasure-codes the tier copy into the tmp volume of the
  version's set, without the object lock, as heal does. A drive that
  fails any part, or misses a part when CheckParts runs before the
  commit, takes no part in the commit.
- A restore lock per version tells whether a restore runs. POST takes it
  before the object lock and hands it to the worker. It is a liveness
  hint: only the checks under the object lock decide what is written.
- The commit takes the object lock briefly, on one pool or several. It
  reads the version again and checks the attempt's ownership, the
  version identity, the tier copy, the part layout and the erasure
  layout. It then publishes with RenameData drive by drive, never
  through erasure renameData's undo, and needs the write quorum. The
  replaced data directory goes only when every published drive reports
  the same one.
- A publication that reached some drives but not the write quorum
  converges under the same lock hold, in bounded retries after it: back
  to the unrestored version on every drive that holds it, or to a
  committed restore when the copy turns out to be on a write quorum.
  Each pass first checks that every drive holds what the version held
  before the commit, the commit wrote, or a convergence wrote, and stops
  on anything else. It deletes no directory.

Multipart goes back to main: erasure-multipart.go and
bucket-object-lock.go are identical to 69fcf50cd. The commit lock, the
marker and the restore exceptions of multipart completion and of the
null-version Object Lock check are gone, and single-pool completion
again takes the upload lock first and the object lock right before it
commits. With several pools, abandoned-data cleanup now takes the pools
lock that writes take, as heal does, so it cannot remove a directory
that a commit moved in place and has not yet referenced. The restore
capability becomes protocol 2, and a queued worker checks it again.

Recovery after a coordinator crash during publication, and storage RPCs
that complete after their caller returned, stay excluded. Main has the
same exposure, and they are tracked separately.

Tests:
- New regression tests cover both problems. They fail on f85d4a5fa,
  and the multipart one also passes on main.
- Fault-injection tests cover a publication below the write quorum,
  including seven of twelve drives on 8+4; lost answers; convergence
  retries and stops; the old data directory; a stale inline marker; a
  recreated tmp volume; a published revision read across its expiry; a
  second POST; a target deleted during the download; a tier 404; and
  pools-locked abandoned cleanup.
- Thirteen tests of the upload marker from 7f38bf628 are dropped, and
  so is TestNativeRestoreConcurrentCompletion from fa42a0982, which
  completed the restore's upload from a client. Four tests are reframed
  for the new semantics, including the lock-domain restore test, which
  now gates the commit.
- Three self-recursive WriteMetadata test doubles are fixed, and the
  helpers of the dropped tests are removed.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Signed-off-by: Feng Ruohang <rh@vonng.com>
2026-11-06 11:30:29 +08:00

936 lines
35 KiB
Go

// Copyright (c) 2026 Feng Ruohang
//
// This file is part of Silo Object Storage stack
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.
package cmd
import (
"bytes"
"context"
"crypto/md5"
"encoding/base64"
"errors"
"fmt"
"io"
"net/http"
"net/http/httptest"
"net/url"
"path/filepath"
"reflect"
"strings"
"sync"
"sync/atomic"
"testing"
"time"
"github.com/minio/minio/internal/bucket/lifecycle"
"github.com/minio/minio/internal/bucket/versioning"
"github.com/minio/minio/internal/event"
xhttp "github.com/minio/minio/internal/http"
"github.com/minio/minio/internal/pubsub"
"github.com/minio/mux"
)
func nativeRestoreSeed(t *testing.T, r *restoreTest, pool int, null, multipart bool) (ObjectInfo, []byte) {
t.Helper()
ctx := t.Context()
opts := ObjectOptions{Versioned: !null, MTime: UTCNow().Add(-2 * time.Hour), UserDefined: map[string]string{
"content-type": "application/x-restore-test", "x-amz-meta-preserve": "keep-me",
}}
body := bytes.Repeat([]byte("restore-payload"), 100000)
var oi ObjectInfo
var err error
if multipart {
parts := [][]byte{bytes.Repeat([]byte("a"), 5<<20), []byte("last-part")}
body = bytes.Join(parts, nil)
upload, err := r.z.serverPools[pool].NewMultipartUpload(ctx, r.bucket, r.object, opts)
if err != nil {
t.Fatal(err)
}
var complete []CompletePart
for i, data := range parts {
p, err := r.z.serverPools[pool].PutObjectPart(ctx, r.bucket, r.object, upload.UploadID, i+1,
mustGetPutObjReader(t, bytes.NewReader(data), int64(len(data)), "", ""), ObjectOptions{})
if err != nil {
t.Fatal(err)
}
complete = append(complete, CompletePart{PartNumber: i + 1, ETag: p.ETag})
}
oi, err = r.z.serverPools[pool].CompleteMultipartUpload(ctx, r.bucket, r.object, upload.UploadID, complete, opts)
if err == nil && len(oi.Parts) != 2 {
t.Fatalf("fixture has %d parts, want 2", len(oi.Parts))
}
} else {
oi, err = r.z.serverPools[pool].PutObject(ctx, r.bucket, r.object,
mustGetPutObjReader(t, bytes.NewReader(body), int64(len(body)), "", ""), opts)
}
if err != nil {
t.Fatal(err)
}
oi.VersionID = restoreTestVersionKey(oi.VersionID)
topts := r.opts(oi.VersionID)
topts.MTime = oi.ModTime
topts.Transition = TransitionOptions{Tier: "WARM", ETag: oi.ETag}
if err := r.z.serverPools[pool].TransitionObject(ctx, r.bucket, r.object, topts); err != nil {
t.Fatal(err)
}
// Use the production metadata writer to mark the request ongoing.
topts.Transition = TransitionOptions{}
topts.EvalMetadataFn = func(o *ObjectInfo, _ error) (ReplicateDecision, error) {
o.UserDefined[xhttp.AmzRestore] = ongoingRestoreObj().String()
return ReplicateDecision{}, nil
}
if _, err := r.z.PutObjectMetadata(ctx, r.bucket, r.object, topts); err != nil {
t.Fatal(err)
}
return oi, body
}
func nativeRestoreSnapshot(t *testing.T, r *restoreTest) [][]FileInfo {
t.Helper()
result := make([][]FileInfo, len(r.z.serverPools))
for p, pool := range r.z.serverPools {
raw, err := pool.getHashedSet(r.object).getDisks()[0].ReadXL(t.Context(), r.bucket, r.object, false)
if errors.Is(err, errFileNotFound) {
continue
}
if err != nil {
t.Fatal(err)
}
infos, err := getFileInfoVersions(raw.Buf, r.bucket, r.object, false)
if err != nil {
t.Fatal(err)
}
result[p] = append(infos.Versions, infos.FreeVersions...)
}
return result
}
func nativeRestoreOptions(r *restoreTest, id string) ObjectOptions {
opts := r.opts(id)
opts.Transition = TransitionOptions{RestoreRequest: &RestoreObjectRequest{Days: 1}}
return opts
}
type nativeRestoreFailTier struct {
WarmBackend
failure error
}
func (b nativeRestoreFailTier) Get(context.Context, string, remoteVersionID, WarmBackendGetOpts) (io.ReadCloser, error) {
return nil, b.failure
}
func TestNativeRestorePools(t *testing.T) {
for _, pools := range []int{1, 2} {
for _, multipart := range []bool{false, true} {
for _, fail := range []bool{false, true} {
t.Run(fmt.Sprintf("pools=%d/multipart=%v/failure=%v", pools, multipart, fail), func(t *testing.T) {
r := newRestoreSafetyTest(t, pools, versioning.Enabled)
oi, body := nativeRestoreSeed(t, r, 0, false, multipart)
before := nativeRestoreSnapshot(t, r)
tier := globalTierConfigMgr.drivercache["WARM"].(*restoreTestTier)
failure := errors.New("injected remote download failure")
if fail {
globalTierConfigMgr.drivercache["WARM"] = nativeRestoreFailTier{tier, failure}
}
ctx, cancel := context.WithTimeout(t.Context(), 3*time.Second)
defer cancel()
err := r.z.RestoreTransitionedObject(ctx, r.bucket, r.object, nativeRestoreOptions(r, oi.VersionID))
if fail {
if !errors.Is(err, failure) {
t.Fatalf("restore error=%v, want remote failure", err)
}
got, err := r.z.GetObjectInfo(t.Context(), r.bucket, r.object, r.opts(oi.VersionID))
if err != nil || got.UserDefined[xhttp.AmzRestore] != "" {
t.Fatalf("failed restore did not clear ongoing status: %v, %q", err, got.UserDefined[xhttp.AmzRestore])
}
} else {
if err != nil {
t.Fatal(err)
}
reads := tier.gets.Load()
_, got, err := r.read(oi.VersionID)
if err != nil || !bytes.Equal(got, body) {
t.Fatalf("restored contents differ: %v", err)
}
if tier.gets.Load() != reads {
t.Error("restored read still fetched the remote tier")
}
}
after := nativeRestoreSnapshot(t, r)
if len(after[0]) != len(before[0]) || after[0][0].VersionID != before[0][0].VersionID || after[0][0].TransitionedObjName != before[0][0].TransitionedObjName {
t.Fatal("restore changed the version stack or remote object identity")
}
if after[0][0].Metadata["content-type"] != "application/x-restore-test" || after[0][0].Metadata["x-amz-meta-preserve"] != "keep-me" {
t.Error("restore lost original metadata")
}
})
}
}
}
}
func TestNativeRestoreVersionRouting(t *testing.T) {
for _, pool := range []int{0, 1} {
for _, null := range []bool{false, true} {
t.Run(fmt.Sprintf("target-pool=%d/null=%v", pool, null), func(t *testing.T) {
r := newRestoreSafetyTest(t, 2, versioning.Enabled)
oi, body := nativeRestoreSeed(t, r, pool, null, false)
latest := putConsistencyObject(t, r.z, r.bucket, r.object, 1-pool, "latest-stays", ObjectOptions{Versioned: true, MTime: oi.ModTime.Add(time.Hour)})
before := nativeRestoreSnapshot(t, r)
ctx, cancel := context.WithTimeout(t.Context(), 3*time.Second)
defer cancel()
if err := r.z.RestoreTransitionedObject(ctx, r.bucket, r.object, nativeRestoreOptions(r, oi.VersionID)); err != nil {
t.Fatal(err)
}
_, got, err := r.read(oi.VersionID)
if err != nil || !bytes.Equal(got, body) {
t.Fatalf("requested version not restored: %v", err)
}
after := nativeRestoreSnapshot(t, r)
if !reflect.DeepEqual(before[1-pool], after[1-pool]) {
t.Error("restore changed the latest version in another pool")
}
if len(after[pool]) != 1 || after[pool][0].VersionID != before[pool][0].VersionID {
t.Error("restore created a version alias")
}
gotInfo, err := r.z.GetObjectInfo(t.Context(), r.bucket, r.object, ObjectOptions{})
if err != nil || gotInfo.VersionID != latest.VersionID {
t.Errorf("latest changed: %v", err)
}
before = nativeRestoreSnapshot(t, r)
if err := r.z.RestoreTransitionedObject(ctx, r.bucket, r.object, nativeRestoreOptions(r, mustGetUUID())); !isErrVersionNotFound(err) && !isErrObjectNotFound(err) {
t.Errorf("missing version: %v", err)
}
if !reflect.DeepEqual(before, nativeRestoreSnapshot(t, r)) {
t.Error("missing version restore mutated metadata")
}
})
}
}
}
func TestNativeRestoreInitialFailurePreservesMetadata(t *testing.T) {
r := newRestoreSafetyTest(t, 1, versioning.Enabled)
oi := putConsistencyObject(t, r.z, r.bucket, r.object, 0, "original-latest", ObjectOptions{Versioned: true, UserDefined: map[string]string{"content-type": "application/x-original", "x-amz-meta-preserve": "keep"}})
before := nativeRestoreSnapshot(t, r)
for _, missing := range []string{mustGetUUID(), nullVersionID} {
err := r.z.RestoreTransitionedObject(t.Context(), r.bucket, r.object, nativeRestoreOptions(r, missing))
if !isErrVersionNotFound(err) {
t.Errorf("missing restore %s: %v", missing, err)
}
if !reflect.DeepEqual(before, nativeRestoreSnapshot(t, r)) {
t.Error("initial restore failure changed stored metadata or version stack")
}
}
_, body, err := r.read(oi.VersionID)
if err != nil || string(body) != "original-latest" {
t.Errorf("initial restore failure changed content: %v", err)
}
}
func TestNativeRestoreWithoutOuterLock(t *testing.T) {
for _, mode := range []string{"single-part", "multipart", "failure-metadata"} {
t.Run(mode, func(t *testing.T) {
r := newRestoreSafetyTest(t, 1, versioning.Enabled)
oi, _ := nativeRestoreSeed(t, r, 0, false, mode == "multipart")
tier := globalTierConfigMgr.drivercache["WARM"]
failure := errors.New("injected remote failure")
if mode == "failure-metadata" {
globalTierConfigMgr.drivercache["WARM"] = nativeRestoreFailTier{tier, failure}
}
er := r.z.serverPools[0].getHashedSet(r.object)
lock := er.NewNSLock(r.bucket, r.object)
lkctx, err := lock.GetLock(t.Context(), globalOperationTimeout)
if err != nil {
t.Fatal(err)
}
defer lock.Unlock(lkctx)
before := nativeRestoreSnapshot(t, r)
ctx, cancel := context.WithTimeout(t.Context(), 200*time.Millisecond)
defer cancel()
err = er.RestoreTransitionedObject(ctx, r.bucket, r.object, nativeRestoreOptions(r, oi.VersionID))
if err == nil {
t.Error("restore wrote through another caller's lock")
}
if !reflect.DeepEqual(before, nativeRestoreSnapshot(t, r)) {
t.Error("NoLock=false failed to protect the stored version")
}
})
}
}
type nativeRestoreHTTPResult struct {
opts ObjectOptions
err error
}
type nativeRestoreHTTPObserver struct {
ObjectLayer
done chan nativeRestoreHTTPResult
}
func (o nativeRestoreHTTPObserver) RestoreTransitionedObject(ctx context.Context, bucket, object string, opts ObjectOptions) error {
ctx, cancel := context.WithTimeout(ctx, 3*time.Second)
defer cancel()
err := o.ObjectLayer.RestoreTransitionedObject(ctx, bucket, object, opts)
o.done <- nativeRestoreHTTPResult{opts, err}
return err
}
func TestNativeRestorePOSTVersionIdentity(t *testing.T) {
for _, state := range []versioning.State{versioning.Enabled, versioning.Suspended} {
for _, target := range []int{0, 1} {
for _, split := range []bool{false, true} {
for _, multipart := range []bool{false, true} {
t.Run(fmt.Sprintf("%s/target=%d/split=%v/multipart=%v", state, target, split, multipart), func(t *testing.T) {
r := newRestoreSafetyTest(t, 2, state)
initConfigSubsystem(t.Context(), r.z)
oi, body := nativeRestoreSeed(t, r, target, !multipart, multipart)
metaOpts := r.opts(oi.VersionID)
metaOpts.MTime = oi.ModTime
metaOpts.EvalMetadataFn = func(o *ObjectInfo, _ error) (ReplicateDecision, error) {
o.UserDefined[xhttp.AmzRestore] = ""
return ReplicateDecision{}, nil
}
if _, err := r.z.PutObjectMetadata(t.Context(), r.bucket, r.object, metaOpts); err != nil {
t.Fatal(err)
}
if split {
putConsistencyObject(t, r.z, r.bucket, r.object, 1-target, "newer-version", ObjectOptions{Versioned: true, MTime: oi.ModTime.Add(time.Hour)})
}
before := nativeRestoreSnapshot(t, r)
observed := nativeRestoreHTTPObserver{r.z, make(chan nativeRestoreHTTPResult, 1)}
api := objectAPIHandlers{ObjectAPI: func() ObjectLayer { return observed }}
events := make(chan event.Event, 1)
done := make(chan struct{})
defer close(done)
if err := globalHTTPListen.Subscribe(pubsub.MaskFromMaskable(event.ObjectRestoreCompleted), events, done, nil); err != nil {
t.Fatal(err)
}
bodyXML := []byte(`<RestoreRequest xmlns="http://s3.amazonaws.com/doc/2006-03-01/"><Days>1</Days></RestoreRequest>`)
path := "/" + r.bucket + "/" + r.object + "?restore"
if split {
path += "&versionId=" + url.QueryEscape(oi.VersionID)
}
req, err := newTestSignedRequestV4(http.MethodPost, path, int64(len(bodyXML)), bytes.NewReader(bodyXML), globalActiveCred.AccessKey, globalActiveCred.SecretKey, nil)
if err != nil {
t.Fatal(err)
}
if err = req.ParseForm(); err != nil {
t.Fatal(err)
}
req = mux.SetURLVars(req, map[string]string{"bucket": r.bucket, "object": r.object})
rec := httptest.NewRecorder()
api.PostRestoreObjectHandler(rec, req)
if rec.Code != http.StatusOK {
t.Fatalf("POST restore: %d %s", rec.Code, rec.Body.String())
}
select {
case result := <-observed.done:
if result.err != nil {
t.Fatal(result.err)
}
if result.opts.VersionID != oi.VersionID || result.opts.Versioned != (state == versioning.Enabled) || result.opts.VersionSuspended != (state == versioning.Suspended) {
t.Errorf("background options lost version context: %+v", result.opts)
}
case <-time.After(5 * time.Second):
t.Fatal("background restore did not return")
}
select {
case <-events:
case <-time.After(5 * time.Second):
t.Fatal("no restore completion event")
}
after := nativeRestoreSnapshot(t, r)
if len(after[target]) != 1 || after[target][0].VersionID != before[target][0].VersionID || after[target][0].TransitionedObjName != before[target][0].TransitionedObjName {
t.Fatal("POST restore added a version alias")
}
if !reflect.DeepEqual(before[1-target], after[1-target]) {
t.Error("POST changed another pool's version")
}
_, got, err := r.read(oi.VersionID)
if err != nil || !bytes.Equal(got, body) {
t.Fatalf("POST-restored contents differ: %v", err)
}
})
}
}
}
}
}
// A restore request is internal context, not an exception for multipart
// overwrites: a native restore never completes an upload, so no completion,
// whatever restore context it carries, writes an existing version back.
func TestNativeRestoreMultipartOverwriteBoundary(t *testing.T) {
for _, mode := range []string{"matching-restore", "ordinary-complete", "restore-without-attempt", "other-attempt", "not-tiered", "changed-time", "changed-size", "changed-etag"} {
t.Run(mode, func(t *testing.T) {
r := newRestoreSafetyTest(t, 1, versioning.Enabled)
oi, body := nativeRestoreSeed(t, r, 0, false, true)
pool := r.z.serverPools[0]
if mode == "not-tiered" {
er := pool.getHashedSet(r.object)
fi, _, _, err := er.getObjectFileInfo(t.Context(), r.bucket, r.object, r.opts(oi.VersionID), false)
if err != nil {
t.Fatal(err)
}
fi.TransitionStatus = lifecycle.TransitionPending
for _, disk := range er.getDisks() {
if err := disk.WriteMetadata(t.Context(), "", r.bucket, r.object, fi); err != nil {
t.Fatal(err)
}
}
}
current, err := r.z.GetObjectInfo(t.Context(), r.bucket, r.object, r.opts(oi.VersionID))
if err != nil {
t.Fatal(err)
}
opts := putRestoreOpts(&RestoreObjectRequest{Days: 1}, current, r.opts(oi.VersionID))
opts.Transition.RestoreRequest = &RestoreObjectRequest{Days: 1}
opts.PreserveETag = current.ETag
if mode == "ordinary-complete" {
opts.Transition.RestoreRequest = nil
}
if mode == "changed-time" {
opts.MTime = opts.MTime.Add(time.Second)
}
// Hold the ETag constant for the size case, so only size can reject it.
if mode == "changed-size" {
body = append(body, 'x')
}
if mode == "changed-etag" {
opts.PreserveETag = "different-etag"
}
// The attempt claims what its upload claims; only the matching
// mode claims exactly the stored version.
if mode != "ordinary-complete" && mode != "restore-without-attempt" {
opts.Transition.attempt = &restoreAttempt{ID: mustGetUUID(), VersionID: oi.VersionID, ETag: opts.PreserveETag, Size: current.Size, ModTime: opts.MTime}
}
uopts := opts
uopts.MTime = time.Time{}
upload, err := pool.NewMultipartUpload(t.Context(), r.bucket, r.object, uopts)
if err != nil {
t.Fatal(err)
}
var complete []CompletePart
for i, data := range [][]byte{body[:5<<20], body[5<<20:]} {
part, err := pool.PutObjectPart(t.Context(), r.bucket, r.object, upload.UploadID, i+1,
mustGetPutObjReader(t, bytes.NewReader(data), int64(len(data)), "", ""), ObjectOptions{Transition: opts.Transition})
if err != nil {
t.Fatal(err)
}
complete = append(complete, CompletePart{PartNumber: i + 1, ETag: part.ETag})
}
if mode != "changed-size" && getCompleteMultipartMD5(complete) != current.ETag {
t.Fatal("fixture multipart ETag does not match original")
}
if mode == "other-attempt" {
other := *opts.Transition.attempt
other.ID = mustGetUUID()
opts.Transition.attempt = &other
}
before := nativeRestoreSnapshot(t, r)
_, err = pool.CompleteMultipartUpload(t.Context(), r.bucket, r.object, upload.UploadID, complete, opts)
if !errors.Is(err, errAuthentication) {
t.Fatalf("existing version overwrite: %v", err)
}
if !reflect.DeepEqual(before, nativeRestoreSnapshot(t, r)) {
t.Error("rejected completion changed the target")
}
})
}
}
// Hold the download after the restore snapshot has been read. Object Lock
// updates must serialize with both successful rehydration and failure cleanup.
type nativeRestoreBlockedTier struct {
WarmBackend
entered chan struct{}
release chan struct{}
once sync.Once
failure error
afterFirstPart bool
}
func (b *nativeRestoreBlockedTier) Get(ctx context.Context, object string, version remoteVersionID, opts WarmBackendGetOpts) (io.ReadCloser, error) {
if b.afterFirstPart {
r, err := b.WarmBackend.Get(ctx, object, version, opts)
if err != nil {
return nil, err
}
return &nativeRestorePartGateReader{ReadCloser: r, gate: b, ctx: ctx, remaining: 5 << 20}, nil
}
b.once.Do(func() { close(b.entered) })
select {
case <-b.release:
case <-ctx.Done():
return nil, ctx.Err()
}
if b.failure != nil {
return nil, b.failure
}
return b.WarmBackend.Get(ctx, object, version, opts)
}
func nativeRestoreLockRequest(ctx context.Context, t *testing.T, r *restoreTest, id, kind string, body []byte) *httptest.ResponseRecorder {
t.Helper()
sum := md5.Sum(body)
req, err := newTestSignedRequestV4(http.MethodPut, "/"+r.bucket+"/"+r.object+"?"+kind+"&versionId="+url.QueryEscape(id), int64(len(body)), bytes.NewReader(body), globalActiveCred.AccessKey, globalActiveCred.SecretKey, map[string]string{xhttp.ContentMD5: base64.StdEncoding.EncodeToString(sum[:])})
if err != nil {
t.Fatal(err)
}
if err := req.ParseForm(); err != nil {
t.Fatal(err)
}
req = mux.SetURLVars(req.WithContext(ctx), map[string]string{"bucket": r.bucket, "object": r.object})
rec := httptest.NewRecorder()
api := objectAPIHandlers{ObjectAPI: func() ObjectLayer { return r.z }}
if kind == "legal-hold" {
api.PutObjectLegalHoldHandler(rec, req)
} else {
api.PutObjectRetentionHandler(rec, req)
}
return rec
}
// A native restore downloads without the object lock. An Object Lock
// update made meanwhile commits at once, and the restore, whether it
// completes or fails, keeps it.
func TestNativeRestoreKeepsObjectLockUpdate(t *testing.T) {
for _, kind := range []string{"legal-hold", "retention"} {
for _, fail := range []bool{false, true} {
t.Run(fmt.Sprintf("%s/failure=%v", kind, fail), func(t *testing.T) {
r := newRestoreSafetyTest(t, 1, versioning.Enabled)
initConfigSubsystem(t.Context(), r.z)
enableBucketObjectLock(t, r.bucket)
oi, _ := nativeRestoreSeed(t, r, 0, false, true)
initial := []byte(`<LegalHold xmlns="http://s3.amazonaws.com/doc/2006-03-01/"><Status>OFF</Status></LegalHold>`)
updated := []byte(`<LegalHold xmlns="http://s3.amazonaws.com/doc/2006-03-01/"><Status>ON</Status></LegalHold>`)
keys := []string{strings.ToLower(xhttp.AmzObjectLockLegalHold), ReservedMetadataPrefixLower + ObjectLockLegalHoldTimestamp}
if kind == "retention" {
initial = retentionBody("COMPLIANCE", UTCNow().Add(24*time.Hour))
updated = retentionBody("COMPLIANCE", UTCNow().Add(48*time.Hour))
keys = []string{strings.ToLower(xhttp.AmzObjectLockMode), strings.ToLower(xhttp.AmzObjectLockRetainUntilDate), ReservedMetadataPrefixLower + ObjectLockRetentionTimestamp}
}
if rec := nativeRestoreLockRequest(t.Context(), t, r, oi.VersionID, kind, initial); rec.Code != http.StatusOK {
t.Fatalf("initial protection: %d %s", rec.Code, rec.Body.String())
}
before, err := r.z.GetObjectInfo(t.Context(), r.bucket, r.object, r.opts(oi.VersionID))
if err != nil {
t.Fatal(err)
}
blocked := &nativeRestoreBlockedTier{WarmBackend: globalTierConfigMgr.drivercache["WARM"], entered: make(chan struct{}), release: make(chan struct{})}
if fail {
blocked.failure = errors.New("injected download failure after snapshot")
}
globalTierConfigMgr.drivercache["WARM"] = blocked
var release sync.Once
unblock := func() { release.Do(func() { close(blocked.release) }) }
defer unblock()
ctx, cancel := context.WithTimeout(t.Context(), 5*time.Second)
defer cancel()
result := make(chan error, 1)
go func() {
result <- r.z.RestoreTransitionedObject(ctx, r.bucket, r.object, nativeRestoreOptions(r, oi.VersionID))
}()
select {
case <-blocked.entered:
case <-ctx.Done():
t.Fatal("restore never started download")
}
// The download holds no object lock: an Object Lock update
// commits at once, and the restore's commit keeps it.
updateCtx, updateCancel := context.WithTimeout(t.Context(), 5*time.Second)
rec := nativeRestoreLockRequest(updateCtx, t, r, oi.VersionID, kind, updated)
updateCancel()
if rec.Code != http.StatusOK {
t.Fatalf("Object Lock update during the restore download: %d %s", rec.Code, rec.Body.String())
}
readOpts := r.opts(oi.VersionID)
readOpts.NoLock = true
during, err := r.z.GetObjectInfo(t.Context(), r.bucket, r.object, readOpts)
if err != nil {
t.Fatal(err)
}
unblock()
select {
case err := <-result:
if !errors.Is(err, blocked.failure) {
t.Fatalf("restore returned %v, want %v", err, blocked.failure)
}
case <-ctx.Done():
t.Fatal("restore failed to finish")
}
after, err := r.z.GetObjectInfo(t.Context(), r.bucket, r.object, r.opts(oi.VersionID))
if err != nil {
t.Fatal(err)
}
for _, key := range keys {
if during.UserDefined[key] == "" || after.UserDefined[key] != during.UserDefined[key] {
t.Errorf("restore changed protection %s: %q -> %q", key, during.UserDefined[key], after.UserDefined[key])
}
}
changed := keys[0]
if kind == "retention" {
changed = keys[1]
}
if after.UserDefined[changed] == before.UserDefined[changed] {
t.Error("the update made during the download was not kept")
}
if !after.ModTime.Equal(before.ModTime) || after.ETag != before.ETag || after.Size != before.Size {
t.Error("Object Lock update changed content identity")
}
})
}
}
}
// The POST handler marks a version ongoing before its background restore
// takes the object lock, and only that restore clears the marker. A restore
// queued behind another version's download must keep waiting: one that gave up
// after a lock timeout would leave the marker for every later POST to refuse.
// The wait still ends with its context.
func TestNativeRestoreQueuedBehindDownload(t *testing.T) {
for _, pools := range []int{1, 2} {
t.Run(fmt.Sprintf("pools=%d", pools), func(t *testing.T) {
r := newRestoreSafetyTest(t, pools, versioning.Enabled)
first, _ := nativeRestoreSeed(t, r, 0, false, false)
queued, body := nativeRestoreSeed(t, r, pools-1, false, false)
prev := globalRestoreLockTimeout
globalRestoreLockTimeout = newDynamicTimeout(50*time.Millisecond, 50*time.Millisecond)
t.Cleanup(func() { globalRestoreLockTimeout = prev })
tier := globalTierConfigMgr.drivercache["WARM"].(*restoreTestTier)
blocked := &nativeRestoreBlockedTier{WarmBackend: tier, entered: make(chan struct{}), release: make(chan struct{})}
globalTierConfigMgr.drivercache["WARM"] = blocked
var once sync.Once
unblock := func() { once.Do(func() { close(blocked.release) }) }
defer unblock()
ctx, cancel := context.WithTimeout(t.Context(), 10*time.Second)
defer cancel()
firstDone := make(chan error, 1)
go func() {
firstDone <- r.z.RestoreTransitionedObject(ctx, r.bucket, r.object, nativeRestoreOptions(r, first.VersionID))
}()
select {
case <-blocked.entered:
case <-ctx.Done():
t.Fatal("first restore never reached the tier")
}
short, shortCancel := context.WithTimeout(ctx, 200*time.Millisecond)
defer shortCancel()
ended := make(chan error, 1)
go func() {
ended <- r.z.RestoreTransitionedObject(short, r.bucket, r.object, nativeRestoreOptions(r, queued.VersionID))
}()
select {
case err := <-ended:
if err == nil {
t.Fatal("restore finished without the object lock")
}
case <-time.After(5 * time.Second):
t.Fatal("restore kept waiting for the lock after its context ended")
}
queuedDone := make(chan error, 1)
go func() {
queuedDone <- r.z.RestoreTransitionedObject(ctx, r.bucket, r.object, nativeRestoreOptions(r, queued.VersionID))
}()
select {
case err := <-queuedDone:
t.Fatalf("queued restore gave up behind the download: %v", err)
case <-time.After(10 * 50 * time.Millisecond):
}
unblock()
for _, done := range []chan error{firstDone, queuedDone} {
select {
case err := <-done:
if err != nil {
t.Fatalf("restore: %v", err)
}
case <-ctx.Done():
t.Fatal("restore did not finish")
}
}
info, err := r.z.GetObjectInfo(t.Context(), r.bucket, r.object, r.opts(queued.VersionID))
if err != nil || info.RestoreOngoing {
t.Fatalf("queued version still ongoing after restore: %q, %v", info.UserDefined[xhttp.AmzRestore], err)
}
reads := tier.gets.Load()
if _, got, err := r.read(queued.VersionID); err != nil || !bytes.Equal(got, body) {
t.Fatalf("queued restore contents: %v", err)
}
if tier.gets.Load() != reads {
t.Error("queued version was not restored locally")
}
})
}
}
type nativeRestorePartGateReader struct {
io.ReadCloser
gate *nativeRestoreBlockedTier
ctx context.Context
remaining int
}
func (r *nativeRestorePartGateReader) Read(p []byte) (int, error) {
if r.remaining > 0 {
if len(p) > r.remaining {
p = p[:r.remaining]
}
n, err := r.ReadCloser.Read(p)
r.remaining -= n
return n, err
}
r.gate.once.Do(func() { close(r.gate.entered) })
select {
case <-r.gate.release:
case <-r.ctx.Done():
return 0, r.ctx.Err()
}
return r.ReadCloser.Read(p)
}
// Invalid upload paths must retain the backend's normal error precedence,
// rather than reacquiring the object lock as the upload lock.
func TestMultipartCompletionLockAlias(t *testing.T) {
for _, pools := range []int{1, 2} {
for _, id := range []string{"", ".", "./"} {
t.Run(fmt.Sprintf("pools=%d/id=%q", pools, id), func(t *testing.T) {
r := newRestoreSafetyTest(t, pools, versioning.Enabled)
for _, missingBucket := range []bool{false, true} {
bucket := r.bucket
if missingBucket {
bucket = "missing-bucket"
}
ctx, cancel := context.WithTimeout(t.Context(), 200*time.Millisecond)
_, err := r.z.CompleteMultipartUpload(ctx, bucket, r.object, id, nil, ObjectOptions{})
cancel()
switch {
case id != "":
if !errors.As(err, &MalformedUploadID{}) {
t.Errorf("malformed upload: %v", err)
}
case missingBucket:
if !isErrBucketNotFound(err) {
t.Errorf("missing bucket: %v", err)
}
default:
if !errors.As(err, &InvalidUploadID{}) {
t.Errorf("invalid upload: %v", err)
}
}
}
})
}
}
}
type nativeRestoreReadHook struct {
io.ReadCloser
remaining int
mutate func()
}
func (r *nativeRestoreReadHook) Read(p []byte) (int, error) {
n, err := r.ReadCloser.Read(p)
r.remaining -= n
if r.remaining == 0 && r.mutate != nil {
f := r.mutate
r.mutate = nil
f()
}
return n, err
}
type nativeRestoreReadHookTier struct {
WarmBackend
size int
mutate func()
}
func (b nativeRestoreReadHookTier) Get(ctx context.Context, object string, version remoteVersionID, opts WarmBackendGetOpts) (io.ReadCloser, error) {
rd, err := b.WarmBackend.Get(ctx, object, version, opts)
if err != nil {
return nil, err
}
return &nativeRestoreReadHook{rd, b.size, b.mutate}, nil
}
// Remove only the addressed entry from a majority of disks, keeping shards
// and the healthy newer version. Return errors to the synchronous caller.
func nativeRestoreLoseMetadata(ctx context.Context, disks []StorageAPI, bucket, object, id string) error {
for _, disk := range disks[1:] {
raw, err := disk.ReadXL(ctx, bucket, object, true)
if err != nil {
return err
}
var meta xlMetaV2
if err := meta.Load(raw.Buf); err != nil {
return err
}
del := FileInfo{VersionID: id}
del.SetSkipTierFreeVersion()
if _, err := meta.DeleteVersion(del); err != nil {
return err
}
data, err := meta.AppendTo(nil)
if err != nil {
return err
}
if err := disk.WriteAll(ctx, bucket, filepath.Join(object, xlStorageFormatFile), data); err != nil {
return err
}
}
return nil
}
// A target can lose metadata quorum after the restore snapshot. Nested
// completion/retention reads must not turn rehydration into remote GC.
func TestNativeRestoreCompletionReadSafety(t *testing.T) {
for _, null := range []bool{false, true} {
for _, multipart := range []bool{false, true} {
t.Run(fmt.Sprintf("null=%v/multipart=%v", null, multipart), func(t *testing.T) {
r := newRestoreSafetyTest(t, 1, versioning.Enabled)
oi, body := nativeRestoreSeed(t, r, 0, null, multipart)
latest := r.put("newer", false, false)
enableBucketObjectLock(t, r.bucket)
disks := r.z.serverPools[0].getHashedSet(r.object).getDisks()
var mutationErr error
mutated := false
mutate := func() {
mutated = true
mutationErr = nativeRestoreLoseMetadata(t.Context(), disks, r.bucket, r.object, oi.VersionID)
}
tier := globalTierConfigMgr.drivercache["WARM"].(*restoreTestTier)
globalTierConfigMgr.drivercache["WARM"] = nativeRestoreReadHookTier{tier, len(body), mutate}
ctx, cancel := context.WithTimeout(t.Context(), 3*time.Second)
defer cancel()
err := r.z.RestoreTransitionedObject(ctx, r.bucket, r.object, nativeRestoreOptions(r, oi.VersionID))
if ctx.Err() != nil {
t.Fatalf("restore timed out: %v", err)
}
if !mutated || mutationErr != nil {
t.Fatalf("invalid injection: mutated=%v err=%v", mutated, mutationErr)
}
t.Logf("restore after addressed metadata lost: %v", err)
for i, disk := range disks {
raw, e := disk.ReadXL(t.Context(), r.bucket, r.object, true)
if e != nil {
t.Fatal(e)
}
versions, e := getFileInfoVersions(raw.Buf, r.bucket, r.object, false)
if e != nil {
t.Fatal(e)
}
if len(versions.FreeVersions) > 0 {
t.Errorf("disk %d restore manufactured %d remote GC entries", i, len(versions.FreeVersions))
}
}
if err == nil {
reads := tier.gets.Load()
_, got, readErr := r.read(oi.VersionID)
if readErr != nil || !bytes.Equal(got, body) || tier.gets.Load() != reads {
t.Errorf("successful restore did not rehydrate its own content: %v", readErr)
}
}
_, got, readErr := r.read(latest.VersionID)
if readErr != nil || !bytes.Equal(got, r.bodies["newer"]) {
t.Errorf("restore changed the other version: %v", readErr)
}
})
}
}
}
// nativeRestoreStatusHook runs afterRead once POST has read the version and
// before POST records its status on it.
type nativeRestoreStatusHook struct {
ObjectLayer
afterRead func()
readCalled bool
backgroundCalled atomic.Bool
}
func (h *nativeRestoreStatusHook) GetObjectInfo(ctx context.Context, bucket, object string, opts ObjectOptions) (ObjectInfo, error) {
oi, err := h.ObjectLayer.GetObjectInfo(ctx, bucket, object, opts)
if err == nil && !h.readCalled {
h.readCalled = true
h.afterRead()
}
return oi, err
}
func (h *nativeRestoreStatusHook) RestoreTransitionedObject(context.Context, string, string, ObjectOptions) error {
h.backgroundCalled.Store(true)
return errors.New("unexpected background restore after failed status update")
}
func TestNativeRestorePOSTReadSafety(t *testing.T) {
for _, pools := range []int{1, 2} {
for _, stage := range []string{"initial", "status-copy"} {
t.Run(fmt.Sprintf("pools=%d/%s", pools, stage), func(t *testing.T) {
r := newRestoreSafetyTest(t, pools, versioning.Enabled)
initConfigSubsystem(t.Context(), r.z)
oi, _ := nativeRestoreSeed(t, r, 0, false, false)
metaOpts := r.opts(oi.VersionID)
metaOpts.MTime = oi.ModTime
metaOpts.EvalMetadataFn = func(o *ObjectInfo, _ error) (ReplicateDecision, error) {
o.UserDefined[xhttp.AmzRestore] = ""
return ReplicateDecision{}, nil
}
if _, err := r.z.PutObjectMetadata(t.Context(), r.bucket, r.object, metaOpts); err != nil {
t.Fatal(err)
}
r.put("newer", false, false)
disks := r.z.serverPools[0].getHashedSet(r.object).getDisks()
var before [][]byte
mutate := func() {
if err := nativeRestoreLoseMetadata(t.Context(), disks, r.bucket, r.object, oi.VersionID); err != nil {
t.Fatal(err)
}
before = restoreBoundarySnapshot(t, r)
}
hook := &nativeRestoreStatusHook{ObjectLayer: r.z, afterRead: mutate}
if stage == "initial" {
mutate()
}
api := objectAPIHandlers{ObjectAPI: func() ObjectLayer { return hook }}
body := []byte(`<RestoreRequest xmlns="http://s3.amazonaws.com/doc/2006-03-01/"><Days>1</Days></RestoreRequest>`)
req, err := newTestSignedRequestV4(http.MethodPost, "/"+r.bucket+"/"+r.object+"?restore&versionId="+url.QueryEscape(oi.VersionID), int64(len(body)), bytes.NewReader(body), globalActiveCred.AccessKey, globalActiveCred.SecretKey, nil)
if err != nil {
t.Fatal(err)
}
if err := req.ParseForm(); err != nil {
t.Fatal(err)
}
req = mux.SetURLVars(req, map[string]string{"bucket": r.bucket, "object": r.object})
rec := httptest.NewRecorder()
api.PostRestoreObjectHandler(rec, req)
if rec.Code < 400 {
t.Fatalf("POST acknowledged failed read: %d %s", rec.Code, rec.Body.String())
}
if hook.readCalled != (stage == "status-copy") || hook.backgroundCalled.Load() {
t.Fatal("request followed the wrong failure path")
}
if !reflect.DeepEqual(before, restoreBoundarySnapshot(t, r)) {
t.Error("failed POST read changed stored metadata or free versions")
}
})
}
}
}