From 561ce035b5b7d577ddb5bb30657bc1f8b399e109 Mon Sep 17 00:00:00 2001 From: Jordan Liggitt Date: Thu, 5 Aug 2021 17:21:40 -0400 Subject: [PATCH] Avoid spurious calls to update/delete validation --- .../registry/generic/registry/store_test.go | 2 ++ .../apiserver/pkg/storage/etcd3/store.go | 30 ++++++++++++++++ .../apiserver/pkg/storage/etcd3/store_test.go | 36 ++++++++++++++++++- 3 files changed, 67 insertions(+), 1 deletion(-) diff --git a/staging/src/k8s.io/apiserver/pkg/registry/generic/registry/store_test.go b/staging/src/k8s.io/apiserver/pkg/registry/generic/registry/store_test.go index 74d57b1859c..f946a389485 100644 --- a/staging/src/k8s.io/apiserver/pkg/registry/generic/registry/store_test.go +++ b/staging/src/k8s.io/apiserver/pkg/registry/generic/registry/store_test.go @@ -1158,6 +1158,8 @@ func TestStoreUpdateHooksInnerRetry(t *testing.T) { registry.Decorator = tc.decorator ttlFailDone = false registry.TTLFunc = tc.ttl + // force storage to use a cached object with a non-matching resourceVersion to guarantee a live lookup + retry + created.(*example.Pod).ResourceVersion += "0" registry.Storage.Storage = &staleGuaranteedUpdateStorage{Interface: registry.Storage.Storage, cachedObj: created} _, _, err = registry.Update(testContext, pod.Name, rest.DefaultUpdatedObjectInfo(pod), rest.ValidateAllObjectFunc, rest.ValidateAllObjectUpdateFunc, false, &metav1.UpdateOptions{}) if err != nil && !tc.expectError { diff --git a/staging/src/k8s.io/apiserver/pkg/storage/etcd3/store.go b/staging/src/k8s.io/apiserver/pkg/storage/etcd3/store.go index 5f36b7108d7..7f558a58866 100644 --- a/staging/src/k8s.io/apiserver/pkg/storage/etcd3/store.go +++ b/staging/src/k8s.io/apiserver/pkg/storage/etcd3/store.go @@ -230,12 +230,22 @@ func (s *store) conditionalDelete( } // It's possible we're working with stale data. + // Remember the revision of the potentially stale data and the resulting update error + cachedRev := origState.rev + cachedUpdateErr := err + // Actually fetch origState, err = getCurrentState() if err != nil { return err } origStateIsCurrent = true + + // it turns out our cached data was not stale, return the error + if cachedRev == origState.rev { + return cachedUpdateErr + } + // Retry continue } @@ -246,12 +256,22 @@ func (s *store) conditionalDelete( } // It's possible we're working with stale data. + // Remember the revision of the potentially stale data and the resulting update error + cachedRev := origState.rev + cachedUpdateErr := err + // Actually fetch origState, err = getCurrentState() if err != nil { return err } origStateIsCurrent = true + + // it turns out our cached data was not stale, return the error + if cachedRev == origState.rev { + return cachedUpdateErr + } + // Retry continue } @@ -345,12 +365,22 @@ func (s *store) GuaranteedUpdate( } // It's possible we were working with stale data + // Remember the revision of the potentially stale data and the resulting update error + cachedRev := origState.rev + cachedUpdateErr := err + // Actually fetch origState, err = getCurrentState() if err != nil { return err } origStateIsCurrent = true + + // it turns out our cached data was not stale, return the error + if cachedRev == origState.rev { + return cachedUpdateErr + } + // Retry continue } diff --git a/staging/src/k8s.io/apiserver/pkg/storage/etcd3/store_test.go b/staging/src/k8s.io/apiserver/pkg/storage/etcd3/store_test.go index 041dc1708d0..5af5f4b9358 100644 --- a/staging/src/k8s.io/apiserver/pkg/storage/etcd3/store_test.go +++ b/staging/src/k8s.io/apiserver/pkg/storage/etcd3/store_test.go @@ -453,15 +453,20 @@ func TestValidateDeletionWithSuggestion(t *testing.T) { key, originalPod := testPropogateStore(ctx, t, store, &example.Pod{ObjectMeta: metav1.ObjectMeta{Name: "name"}}) - // Check that validaing fresh object fails. + // Check that validaing fresh object fails is called once and fails. + validationCalls := 0 validationError := fmt.Errorf("validation error") validateNothing := func(_ context.Context, _ runtime.Object) error { + validationCalls++ return validationError } out := &example.Pod{} if err := store.Delete(ctx, key, out, nil, validateNothing, originalPod); err != validationError { t.Errorf("Unexpected failure during deletion: %v", err) } + if validationCalls != 1 { + t.Errorf("validate function should have been called once, called %d", validationCalls) + } // First update, so originalPod is outdated. updatedPod := &example.Pod{} @@ -961,6 +966,35 @@ func TestGuaranteedUpdateWithSuggestionAndConflict(t *testing.T) { if updatedPod2.Name != "foo-3" { t.Errorf("unexpected pod name: %q", updatedPod2.Name) } + + // Third, update using a current version as the suggestion. + // Return an error and make sure that SimpleUpdate is NOT called a second time, + // since the live lookup shows the suggestion was already up to date. + attempts := 0 + updatedPod3 := &example.Pod{} + err = store.GuaranteedUpdate(ctx, key, updatedPod3, false, nil, + storage.SimpleUpdate(func(obj runtime.Object) (runtime.Object, error) { + pod := obj.(*example.Pod) + if pod.Name != updatedPod2.Name || pod.ResourceVersion != updatedPod2.ResourceVersion { + t.Errorf( + "unexpected live object (name=%s, rv=%s), expected name=%s, rv=%s", + pod.Name, + pod.ResourceVersion, + updatedPod2.Name, + updatedPod2.ResourceVersion, + ) + } + attempts++ + return nil, fmt.Errorf("validation or admission error") + }), + updatedPod2, + ) + if err == nil { + t.Fatalf("expected error, got none") + } + if attempts != 1 { + t.Errorf("expected 1 attempt, got %d", attempts) + } } func TestTransformationFailure(t *testing.T) {