Move logger into context

README.md

@@ -52,9 +52,8 @@ Parent reconcilers tend to be quite simple, as they delegate their work to sub r
 
 ```go
 func FunctionReconciler(c reconcilers.Config) *reconcilers.ParentReconciler {
-	c.Log = c.Log.WithName("Function")
-
 	return &reconcilers.ParentReconciler{
+		Name: "Function",
 		Type: &buildv1alpha1.Function{},
 		Reconciler: reconcilers.Sequence{
 			FunctionTargetImageReconciler(c),
@@ -81,10 +80,11 @@ While sync reconcilers have the ability to do anything a reconciler can do, it's
 
 ```go
 func FunctionTargetImageReconciler(c reconcilers.Config) reconcilers.SubReconciler {
-	c.Log = c.Log.WithName("TargetImage")
-
 	return &reconcilers.SyncReconciler{
+		Name: "TargetImage",
 		Sync: func(ctx context.Context, parent *buildv1alpha1.Function) error {
+			log := logr.FromContextOrDiscard(ctx)
+
 			targetImage, err := resolveTargetImage(ctx, c.Client, parent)
 			if err != nil {
 				return err
@@ -125,9 +125,8 @@ Now it's time to create the child Image resource that will do the work of buildi
 
 ```go
 func FunctionChildImageReconciler(c reconcilers.Config) reconcilers.SubReconciler {
-	c.Log = c.Log.WithName("ChildImage")
-
 	return &reconcilers.ChildReconciler{
+		Name:          "ChildImage",
 		ChildType:     &kpackbuildv1alpha1.Image{},
 		ChildListType: &kpackbuildv1alpha1.ImageList{},
 
@@ -214,9 +213,8 @@ JSON encoding is used as the intermediate representation. Operations on a cast p
 
 ```go
 func FunctionReconciler(c reconcilers.Config) *reconcilers.ParentReconciler {
-	c.Log = c.Log.WithName("Function")
-
 	return &reconcilers.ParentReconciler{
+		Name: "Function",
 		Type: &buildv1alpha1.Function{},
 		Reconciler: reconcilers.Sequence{
 			&reconcilers.CastParent{
@@ -247,9 +245,8 @@ A Sequence is commonly used in a ParentReconciler, but may be used anywhere a Su
 
 ```go
 func FunctionReconciler(c reconcilers.Config) *reconcilers.ParentReconciler {
-	c.Log = c.Log.WithName("Function")
-
 	return &reconcilers.ParentReconciler{
+		Name: "Function",
 		Type: &buildv1alpha1.Function{},
 		Reconciler: reconcilers.Sequence{
 			FunctionTargetImageReconciler(c),
@@ -391,9 +388,8 @@ The stash allows passing arbitrary state between sub reconcilers within the scop
 const exampleStashKey reconcilers.StashKey = "example"
 
 func StashExampleSubReconciler(c reconcilers.Config) reconcilers.SubReconciler {
-	c.Log = c.Log.WithName("StashExample")
-
 	return &reconcilers.SyncReconciler{
+		Name: "StashExample",
 		Sync: func(ctx context.Context, resource *examplev1.MyExample) error {
 			value := Example{} // something we want to expose to a sub reconciler later in this chain
 			reconcilers.StashValue(ctx, exampleStashKey, *value)
@@ -406,9 +402,8 @@ func StashExampleSubReconciler(c reconcilers.Config) reconcilers.SubReconciler {
 
 
 func StashExampleSubReconciler(c reconcilers.Config) reconcilers.SubReconciler {
-	c.Log = c.Log.WithName("StashExample")
-
 	return &reconcilers.SyncReconciler{
+		Name: "StashExample",
 		Sync: func(ctx context.Context, resource *examplev1.MyExample) error {
 			value, ok := reconcilers.RetrieveValue(ctx, exampleStashKey).(Example)
 			if !ok {
@@ -432,10 +427,11 @@ The stream gateways in projectriff fetch the image references they use to run fr
 
 ```go
 func InMemoryGatewaySyncConfigReconciler(c reconcilers.Config, namespace string) reconcilers.SubReconciler {
-	c.Log = c.Log.WithName("SyncConfig")
-
 	return &reconcilers.SyncReconciler{
+		Name: "SyncConfig",
 		Sync: func(ctx context.Context, parent *streamingv1alpha1.InMemoryGateway) error {
+			log := logr.FromContextOrDiscard(ctx)
+
 			var config corev1.ConfigMap
 			key := types.NamespacedName{Namespace: namespace, Name: inmemoryGatewayImages}
 			// track config for new images
@@ -456,13 +452,13 @@ func InMemoryGatewaySyncConfigReconciler(c reconcilers.Config, namespace string)
 		},
 
 		Config: c,
-		Setup: func(mgr reconcilers.Manager, bldr *reconcilers.Builder) error {
+		Setup: func(ctx context.Context, mgr reconcilers.Manager, bldr *reconcilers.Builder) error {
 			// enqueue the tracking resource for reconciliation from changes to
 			// tracked ConfigMaps. Internally `EnqueueTracked` sets up an 
 			// Informer to watch to changes of the target resource. When the
 			// informer emits an event, the tracking resources are looked up
 			// from the tracker and enqueded for reconciliation.
-			bldr.Watches(&source.Kind{Type: &corev1.ConfigMap{}}, reconcilers.EnqueueTracked(&corev1.ConfigMap{}, c.Tracker, c.Scheme))
+			bldr.Watches(&source.Kind{Type: &corev1.ConfigMap{}}, reconcilers.EnqueueTracked(ctx, &corev1.ConfigMap{}, c.Tracker, c.Scheme))
 			return nil
 		},
 	}

reconcilers/enqueuer.go

@@ -6,6 +6,8 @@ SPDX-License-Identifier: Apache-2.0
 package reconcilers
 
 import (
+	"context"
+
 	"k8s.io/apimachinery/pkg/runtime"
 	"k8s.io/apimachinery/pkg/types"
 	"sigs.k8s.io/controller-runtime/pkg/client"
@@ -15,7 +17,7 @@ import (
 	"github.com/vmware-labs/reconciler-runtime/tracker"
 )
 
-func EnqueueTracked(by client.Object, t tracker.Tracker, s *runtime.Scheme) handler.EventHandler {
+func EnqueueTracked(ctx context.Context, by client.Object, t tracker.Tracker, s *runtime.Scheme) handler.EventHandler {
 	return handler.EnqueueRequestsFromMapFunc(
 		func(a client.Object) []reconcile.Request {
 			var requests []reconcile.Request
@@ -29,7 +31,7 @@ func EnqueueTracked(by client.Object, t tracker.Tracker, s *runtime.Scheme) hand
 				gvks[0],
 				types.NamespacedName{Namespace: a.GetNamespace(), Name: a.GetName()},
 			)
-			for _, item := range t.Lookup(key) {
+			for _, item := range t.Lookup(ctx, key) {
 				requests = append(requests, reconcile.Request{NamespacedName: item})
 			}
 

reconcilers/logger.go

@@ -0,0 +1,68 @@
+/*
+Copyright 2022 VMware, Inc.
+SPDX-License-Identifier: Apache-2.0
+*/
+
+package reconcilers
+
+import (
+	"fmt"
+	"sync"
+
+	"github.com/go-logr/logr"
+)
+
+var (
+	_ logr.LogSink = (*warnOnceLogSink)(nil)
+)
+
+// Deprecated
+func newWarnOnceLogger(log logr.Logger) logr.Logger {
+	return logr.New(&warnOnceLogSink{
+		sink: log.GetSink(),
+	})
+}
+
+// Deprecated
+type warnOnceLogSink struct {
+	sink logr.LogSink
+	once sync.Once
+}
+
+func (s *warnOnceLogSink) Init(info logr.RuntimeInfo) {
+	s.sink.Init(info)
+}
+
+func (s *warnOnceLogSink) Enabled(level int) bool {
+	return s.sink.Enabled(level)
+}
+
+func (s *warnOnceLogSink) Info(level int, msg string, keysAndValues ...interface{}) {
+	s.warn()
+	s.sink.Info(level, msg, keysAndValues...)
+}
+
+func (s *warnOnceLogSink) Error(err error, msg string, keysAndValues ...interface{}) {
+	s.warn()
+	s.sink.Error(err, msg, keysAndValues...)
+}
+
+func (s *warnOnceLogSink) WithValues(keysAndValues ...interface{}) logr.LogSink {
+	return &warnOnceLogSink{
+		sink: s.sink.WithValues(keysAndValues...),
+		once: s.once,
+	}
+}
+
+func (s *warnOnceLogSink) WithName(name string) logr.LogSink {
+	return &warnOnceLogSink{
+		sink: s.sink.WithName(name),
+		once: s.once,
+	}
+}
+
+func (s *warnOnceLogSink) warn() {
+	s.once.Do(func() {
+		s.sink.Error(fmt.Errorf("Config.Log is deprecated"), "use a logger from the context: `log := logr.FromContext(ctx)`")
+	})
+}