Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix for latestRevision routes may point to older revisions if latestCreated is not ready #5319

Merged
97 changes: 87 additions & 10 deletions pkg/reconciler/configuration/configuration.go
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,16 @@ import (
"context"
"fmt"
"reflect"
"sort"
"strconv"

"go.uber.org/zap"
corev1 "k8s.io/api/core/v1"
"k8s.io/apimachinery/pkg/api/equality"
"k8s.io/apimachinery/pkg/api/errors"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/labels"
"k8s.io/apimachinery/pkg/selection"
"k8s.io/client-go/tools/cache"
"knative.dev/pkg/controller"
"knative.dev/pkg/logging"
Expand Down Expand Up @@ -167,23 +170,14 @@ func (c *Reconciler) reconcile(ctx context.Context, config *v1alpha1.Configurati

case rc.Status == corev1.ConditionTrue:
logger.Infof("Revision %q of configuration is ready", revName)

created, ready := config.Status.LatestCreatedRevisionName, config.Status.LatestReadyRevisionName
if ready == "" {
if config.Status.LatestReadyRevisionName == "" {
// Surface an event for the first revision becoming ready.
c.Recorder.Event(config, corev1.EventTypeNormal, "ConfigurationReady",
"Configuration becomes ready")
}
// Update the LatestReadyRevisionName and surface an event for the transition.
config.Status.SetLatestReadyRevisionName(lcr.Name)
if created != ready {
c.Recorder.Eventf(config, corev1.EventTypeNormal, "LatestReadyUpdate",
"LatestReadyRevisionName updated to %q", lcr.Name)
}

case rc.Status == corev1.ConditionFalse:
logger.Infof("Revision %q of configuration has failed", revName)

// TODO(mattmoor): Only emit the event the first time we see this.
config.Status.MarkLatestCreatedFailed(lcr.Name, rc.Message)
c.Recorder.Eventf(config, corev1.EventTypeWarning, "LatestCreatedFailed",
Expand All @@ -192,10 +186,93 @@ func (c *Reconciler) reconcile(ctx context.Context, config *v1alpha1.Configurati
default:
return fmt.Errorf("unrecognized condition status: %v on revision %q", rc.Status, revName)
}
if rc != nil && rc.Status == corev1.ConditionTrue {
old, new := config.Status.LatestReadyRevisionName, lcr.Name
config.Status.SetLatestReadyRevisionName(lcr.Name)
if old != new {
c.Recorder.Eventf(config, corev1.EventTypeNormal, "LatestReadyUpdate",
"LatestReadyRevisionName updated to %q", new)
}
} else {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, what I meant by my previous comment was: Can we just delete these lines, and if so will findAndSet... do the right thing? If not why not?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually it won't work for the byo revision name rollback use case. Because findAndSet... will try to get the list of created revision starting from the generation number of the current LRR, it won't fetch the rollback revision and consequently update LRR to the correct previous revision.

if err = c.findAndSetLatestReadyRevision(config); err != nil {
return fmt.Errorf("failed to find and set latest ready revision: %w", err)
}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

184-188 look like a special case of this, so perhaps we can just eliminate that and sink this call? I like getting as much mileage through code as possible, so if we can make this a single code path 🎉

}

return nil
}

// findAndSetLatestReadyRevision finds the last ready revision and sets LatestReadyRevisionName to it
func (c *Reconciler) findAndSetLatestReadyRevision(config *v1alpha1.Configuration) error {
sortedRevisions, err := c.getSortedCreatedRevisions(config)
if err != nil {
return err
}
for _, rev := range sortedRevisions {
if rev.Status.IsReady() {
// No need to update latest ready revision in this case
if rev.Name == config.Status.LatestReadyRevisionName {
return nil
}
config.Status.SetLatestReadyRevisionName(rev.Name)
c.Recorder.Eventf(config, corev1.EventTypeNormal, "LatestReadyUpdate",
"LatestReadyRevisionName updated to %q", rev.Name)
return nil
}
}
return nil
}

// getSortedCreatedRevisions returns the list of created revisions sorted in descending
// generation order between the generation of the latest ready revision and config's generation.
func (c *Reconciler) getSortedCreatedRevisions(config *v1alpha1.Configuration) ([]*v1alpha1.Revision, error) {
lister := c.revisionLister.Revisions(config.Namespace)
configSelector := labels.SelectorFromSet(map[string]string{
serving.ConfigurationLabelKey: config.Name,
})
if config.Status.LatestReadyRevisionName != "" {
latestReadyRev, err := lister.Get(config.Status.LatestReadyRevisionName)
if err != nil {
return nil, err
}
start := latestReadyRev.Generation
var generations []string
for i := start + 1; i <= int64(config.Generation); i++ {
generations = append(generations, strconv.FormatInt(i, 10))
}

// Add an "In" filter so that the configurations we get back from List have generation
// in range (config's latest ready generation, config's generation]
generationKey := serving.ConfigurationGenerationLabelKey
inReq, err := labels.NewRequirement(generationKey,
selection.In,
generations,
)
if err != nil {
return nil, err
}
configSelector = configSelector.Add(*inReq)
}

list, err := lister.List(configSelector)

if err == nil && len(list) > 0 {
// Return a sorted list with Generation in descending order
if len(list) > 1 {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This double predicate is a bit weird, I would use:

if err != nil {
  return nil, err
}
// Does this panic if list is nil? I doubt it would...
sort.Slice(list, func(){})

sort.Slice(list, func(i, j int) bool {
intI, errI := strconv.Atoi(list[i].Labels[serving.ConfigurationGenerationLabelKey])
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Based on what you have said above, what is here seems incomplete.

I think that we need a check that says that if config.Spec.Template.Name == list[i].Name then return true (BYO Name always sorts first).

intJ, errJ := strconv.Atoi(list[j].Labels[serving.ConfigurationGenerationLabelKey])
if errI != nil || errJ != nil {
return true
}
return intI > intJ
})
}
return list, nil
}
return nil, err
}

// CheckNameAvailability checks that if the named Revision specified by the Configuration
// is available (not found), exists (but matches), or exists with conflict (doesn't match).
func CheckNameAvailability(config *v1alpha1.Configuration, lister listers.RevisionLister) (*v1alpha1.Revision, error) {
Expand Down
32 changes: 32 additions & 0 deletions pkg/reconciler/configuration/configuration_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -387,6 +387,38 @@ func TestReconcile(t *testing.T) {
WithCreationTimestamp(now), MarkRevisionReady),
},
Key: "foo/double-trouble",
}, {
Name: "three revisions with the latest revision failed, the latest ready should be updated to the last ready revision",
Objects: []runtime.Object{
cfg("threerevs", "foo", 3,
WithLatestCreated("threerevs-00002"),
WithLatestReady("threerevs-00001"), WithObservedGen, func(cfg *v1alpha1.Configuration) {
cfg.Spec.GetTemplate().Name = "threerevs-00003"
},
),
rev("threerevs", "foo", 1,
WithRevName("threerevs-00001"),
WithCreationTimestamp(now), MarkRevisionReady),
rev("threerevs", "foo", 2,
WithRevName("threerevs-00002"),
WithCreationTimestamp(now), MarkRevisionReady),
rev("threerevs", "foo", 3,
WithRevName("threerevs-00003"),
WithCreationTimestamp(now), MarkInactive("", "")),
},
WantStatusUpdates: []clientgotesting.UpdateActionImpl{{
Object: cfg("threerevs", "foo", 3,
WithLatestCreated("threerevs-00003"),
WithLatestReady("threerevs-00002"),
WithObservedGen, func(cfg *v1alpha1.Configuration) {
cfg.Spec.GetTemplate().Name = "threerevs-00003"
},
),
}},
WantEvents: []string{
Eventf(corev1.EventTypeNormal, "LatestReadyUpdate", "LatestReadyRevisionName updated to %q", "threerevs-00002"),
},
Key: "foo/threerevs",
}}

table.Test(t, MakeFactory(func(ctx context.Context, listers *Listers, cmw configmap.Watcher) controller.Reconciler {
Expand Down