Skip to content

Commit 0528c33

Browse files
clebsclebs
committed
Revert renaming of GetEventRecorderFor
Signed-off-by: Borja Clemente <[email protected]>
1 parent a774c9b commit 0528c33

File tree

11 files changed

+48
-52
lines changed

11 files changed

+48
-52
lines changed

‎designs/move-cluster-specific-code-out-of-manager.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,8 +61,8 @@ type Cluster interface {
6161
// GetCache returns a cache.Cache
6262
GetCache() cache.Cache
6363

64-
//GetEventRecorder returns a new EventRecorder for the provided name
65-
GetEventRecorder(name string) record.EventRecorder
64+
// GetEventRecorderFor returns a new EventRecorder for the provided name
65+
GetEventRecorderFor(name string) record.EventRecorder
6666

6767
// GetRESTMapper returns a RESTMapper
6868
GetRESTMapper() meta.RESTMapper

‎pkg/cluster/cluster_test.go

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ import (
2929
"k8s.io/apimachinery/pkg/api/meta"
3030
"k8s.io/apimachinery/pkg/runtime"
3131
"k8s.io/client-go/rest"
32+
"k8s.io/client-go/tools/events"
3233
"sigs.k8s.io/controller-runtime/pkg/cache"
3334
"sigs.k8s.io/controller-runtime/pkg/client"
3435
intrec "sigs.k8s.io/controller-runtime/pkg/internal/recorder"
@@ -86,7 +87,7 @@ var _ = Describe("cluster.Cluster", func() {
8687

8788
It("should return an error it can't create a recorder.Provider", func() {
8889
c, err := New(cfg, func(o *Options) {
89-
o.newRecorderProvider = func(_ *rest.Config, _ *http.Client, _ *runtime.Scheme, _ logr.Logger, _ intrec.EventBroadcasterProducer) (*intrec.Provider, error) {
90+
o.newRecorderProvider = func(_ *rest.Config, _ *http.Client, _ *runtime.Scheme, _ logr.Logger, _ events.EventBroadcaster, _ bool) (*intrec.Provider, error) {
9091
return nil, fmt.Errorf("expected error")
9192
}
9293
})
@@ -157,7 +158,7 @@ var _ = Describe("cluster.Cluster", func() {
157158
It("should provide a function to get the EventRecorder", func() {
158159
c, err := New(cfg)
159160
Expect(err).NotTo(HaveOccurred())
160-
Expect(c.GetEventRecorder("test")).NotTo(BeNil())
161+
Expect(c.GetEventRecorderFor("test")).NotTo(BeNil())
161162
})
162163
It("should provide a function to get the APIReader", func() {
163164
c, err := New(cfg)

‎pkg/cluster/internal.go

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -84,12 +84,12 @@ func (c *cluster) GetCache() cache.Cache {
8484
return c.cache
8585
}
8686

87-
func (c *cluster) GetEventRecorder(name string) events.EventRecorder {
88-
return c.recorderProvider.GetEventRecorder(name)
87+
func (c *cluster) GetEventRecorderFor(name string) record.EventRecorder {
88+
return c.recorderProvider.GetEventRecorderFor(name)
8989
}
9090

91-
func (c *cluster) GetOldEventRecorder(name string) record.EventRecorder {
92-
return c.recorderProvider.GetOldEventRecorder(name)
91+
func (c *cluster) GetEventRecorder(name string) events.EventRecorder {
92+
return c.recorderProvider.GetEventRecorder(name)
9393
}
9494

9595
func (c *cluster) GetRESTMapper() meta.RESTMapper {

‎pkg/internal/recorder/recorder.go

Lines changed: 16 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,6 @@ import (
3131
"k8s.io/client-go/tools/record"
3232
)
3333

34-
// EventBroadcasterProducer makes an event broadcaster, returning
35-
// whether or not the broadcaster should be stopped with the Provider,
36-
// or not (e.g. if it's shared, it shouldn't be stopped with the Provider).
37-
type EventBroadcasterProducer func() (caster events.EventBroadcaster, stopWithProvider bool)
38-
3934
// Provider is a recorder.Provider that records events to the k8s API server
4035
// and to a logr Logger.
4136
type Provider struct {
@@ -45,9 +40,8 @@ type Provider struct {
4540
// scheme to specify when creating a recorder
4641
scheme *runtime.Scheme
4742
// logger is the logger to use when logging diagnostic event info
48-
logger logr.Logger
49-
evtClient eventsv1client.EventsV1Interface
50-
makeBroadcaster EventBroadcasterProducer
43+
logger logr.Logger
44+
evtClient eventsv1client.EventsV1Interface
5145

5246
broadcasterOnce sync.Once
5347
broadcaster events.EventBroadcaster
@@ -133,18 +127,9 @@ func NewProvider(config *rest.Config, httpClient *http.Client, scheme *runtime.S
133127
return p, nil
134128
}
135129

136-
// GetEventRecorder returns an event recorder that broadcasts to this provider's
137-
// broadcaster. All events will be associated with a component of the given name.
138-
func (p *Provider) GetEventRecorder(name string) events.EventRecorder {
139-
return &lazyRecorder{
140-
prov: p,
141-
name: name,
142-
}
143-
}
144-
145-
// GetOldEventRecorder returns an event recorder that broadcasts to this provider's
130+
// GetEventRecorderFor returns an event recorder that broadcasts to this provider's
146131
// broadcaster. All events will be associated with a component of the given name.
147-
func (p *Provider) GetOldEventRecorder(name string) record.EventRecorder {
132+
func (p *Provider) GetEventRecorderFor(name string) record.EventRecorder {
148133
return &oldRecorder{
149134
newRecorder: &lazyRecorder{
150135
prov: p,
@@ -153,6 +138,15 @@ func (p *Provider) GetOldEventRecorder(name string) record.EventRecorder {
153138
}
154139
}
155140

141+
// GetEventRecorder returns an event recorder that broadcasts to this provider's
142+
// broadcaster. All events will be associated with a component of the given name.
143+
func (p *Provider) GetEventRecorder(name string) events.EventRecorder {
144+
return &lazyRecorder{
145+
prov: p,
146+
name: name,
147+
}
148+
}
149+
156150
// lazyRecorder is a recorder that doesn't actually instantiate any underlying
157151
// recorder until the first event is emitted.
158152
type lazyRecorder struct {
@@ -171,7 +165,7 @@ func (l *lazyRecorder) ensureRecording() {
171165
})
172166
}
173167

174-
func (l *lazyRecorder) Eventf(regarding runtime.Object, related runtime.Object, eventtype, reason, action, note string, args ...interface{}) {
168+
func (l *lazyRecorder) Eventf(regarding runtime.Object, related runtime.Object, eventtype, reason, action, note string, args ...any) {
175169
l.ensureRecording()
176170

177171
l.prov.lock.RLock()
@@ -192,10 +186,10 @@ func (l *oldRecorder) Event(object runtime.Object, eventtype, reason, message st
192186
l.newRecorder.Eventf(object, nil, eventtype, reason, "unsupported", message)
193187
}
194188

195-
func (l *oldRecorder) Eventf(object runtime.Object, eventtype, reason, messageFmt string, args ...interface{}) {
189+
func (l *oldRecorder) Eventf(object runtime.Object, eventtype, reason, messageFmt string, args ...any) {
196190
l.newRecorder.Eventf(object, nil, eventtype, reason, "unsupported", messageFmt, args...)
197191
}
198192

199-
func (l *oldRecorder) AnnotatedEventf(object runtime.Object, annotations map[string]string, eventtype, reason, messageFmt string, args ...interface{}) {
193+
func (l *oldRecorder) AnnotatedEventf(object runtime.Object, annotations map[string]string, eventtype, reason, messageFmt string, args ...any) {
200194
l.newRecorder.Eventf(object, nil, eventtype, reason, "unsupported", messageFmt, args...)
201195
}

‎pkg/internal/recorder/recorder_integration_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ var _ = Describe("recorder", func() {
4343
Expect(err).NotTo(HaveOccurred())
4444

4545
By("Creating the Controller")
46-
recorder := cm.GetEventRecorder("test-recorder")
46+
recorder := cm.GetEventRecorderFor("test-recorder")
4747
instance, err := controller.New("foo-controller", cm, controller.Options{
4848
Reconciler: reconcile.Func(
4949
func(ctx context.Context, request reconcile.Request) (reconcile.Result, error) {

‎pkg/internal/recorder/recorder_test.go

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -21,15 +21,13 @@ import (
2121
. "github.com/onsi/ginkgo/v2"
2222
. "github.com/onsi/gomega"
2323
"k8s.io/client-go/kubernetes/scheme"
24-
"k8s.io/client-go/tools/record"
2524
"sigs.k8s.io/controller-runtime/pkg/internal/recorder"
2625
)
2726

2827
var _ = Describe("recorder.Provider", func() {
29-
makeBroadcaster := func() (record.EventBroadcaster, bool) { return record.NewBroadcaster(), true }
3028
Describe("NewProvider", func() {
3129
It("should return a provider instance and a nil error.", func() {
32-
provider, err := recorder.NewProvider(cfg, httpClient, scheme.Scheme, logr.Discard(), makeBroadcaster)
30+
provider, err := recorder.NewProvider(cfg, httpClient, scheme.Scheme, logr.Discard(), nil, true)
3331
Expect(provider).NotTo(BeNil())
3432
Expect(err).NotTo(HaveOccurred())
3533
})
@@ -38,17 +36,17 @@ var _ = Describe("recorder.Provider", func() {
3836
// Invalid the config
3937
cfg1 := *cfg
4038
cfg1.Host = "invalid host"
41-
_, err := recorder.NewProvider(&cfg1, httpClient, scheme.Scheme, logr.Discard(), makeBroadcaster)
39+
_, err := recorder.NewProvider(&cfg1, httpClient, scheme.Scheme, logr.Discard(), nil, true)
4240
Expect(err).To(HaveOccurred())
4341
Expect(err.Error()).To(ContainSubstring("failed to init client"))
4442
})
4543
})
46-
Describe("GetEventRecorder", func() {
44+
Describe("GetEventRecorderFor", func() {
4745
It("should return a recorder instance.", func() {
48-
provider, err := recorder.NewProvider(cfg, httpClient, scheme.Scheme, logr.Discard(), makeBroadcaster)
46+
provider, err := recorder.NewProvider(cfg, httpClient, scheme.Scheme, logr.Discard(), nil, true)
4947
Expect(err).NotTo(HaveOccurred())
5048

51-
recorder := provider.GetEventRecorder("test")
49+
recorder := provider.GetEventRecorderFor("test")
5250
Expect(recorder).NotTo(BeNil())
5351
})
5452
})

‎pkg/leaderelection/leader_election.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ func NewResourceLock(config *rest.Config, recorderProvider recorder.Provider, op
128128
coordinationClient,
129129
resourcelock.ResourceLockConfig{
130130
Identity: id,
131-
EventRecorder: recorderProvider.GetOldEventRecorder(id),
131+
EventRecorder: recorderProvider.GetEventRecorderFor(id),
132132
},
133133
options.LeaderLabels,
134134
)

‎pkg/manager/internal.go

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -256,12 +256,12 @@ func (cm *controllerManager) GetCache() cache.Cache {
256256
return cm.cluster.GetCache()
257257
}
258258

259-
func (cm *controllerManager) GetEventRecorder(name string) events.EventRecorder {
260-
return cm.cluster.GetEventRecorder(name)
259+
func (cm *controllerManager) GetEventRecorderFor(name string) record.EventRecorder {
260+
return cm.cluster.GetEventRecorderFor(name)
261261
}
262262

263-
func (cm *controllerManager) GetOldEventRecorder(name string) record.EventRecorder {
264-
return cm.cluster.GetOldEventRecorder(name)
263+
func (cm *controllerManager) GetEventRecorder(name string) events.EventRecorder {
264+
return cm.cluster.GetEventRecorder(name)
265265
}
266266

267267
func (cm *controllerManager) GetRESTMapper() meta.RESTMapper {

‎pkg/manager/manager_test.go

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ import (
4040
"k8s.io/apimachinery/pkg/runtime"
4141
"k8s.io/apimachinery/pkg/runtime/schema"
4242
"k8s.io/client-go/rest"
43+
"k8s.io/client-go/tools/events"
4344
"k8s.io/client-go/tools/leaderelection/resourcelock"
4445
"sigs.k8s.io/controller-runtime/pkg/cache"
4546
"sigs.k8s.io/controller-runtime/pkg/cache/informertest"
@@ -106,7 +107,7 @@ var _ = Describe("manger.Manager", func() {
106107

107108
It("should return an error it can't create a recorder.Provider", func() {
108109
m, err := New(cfg, Options{
109-
newRecorderProvider: func(_ *rest.Config, _ *http.Client, _ *runtime.Scheme, _ logr.Logger, _ intrec.EventBroadcasterProducer) (*intrec.Provider, error) {
110+
newRecorderProvider: func(_ *rest.Config, _ *http.Client, _ *runtime.Scheme, _ logr.Logger, _ events.EventBroadcaster, _ bool) (*intrec.Provider, error) {
110111
return nil, fmt.Errorf("expected error")
111112
},
112113
})
@@ -1861,7 +1862,7 @@ var _ = Describe("manger.Manager", func() {
18611862
ns := corev1.Namespace{}
18621863
ns.Name = "default"
18631864

1864-
recorder := m.GetEventRecorder("rock-and-roll")
1865+
recorder := m.GetEventRecorderFor("rock-and-roll")
18651866
Expect(m.Add(RunnableFunc(func(_ context.Context) error {
18661867
recorder.Event(&ns, "Warning", "BallroomBlitz", "yeah, yeah, yeah-yeah-yeah")
18671868
return nil
@@ -1934,7 +1935,7 @@ var _ = Describe("manger.Manager", func() {
19341935
It("should provide a function to get the EventRecorder", func() {
19351936
m, err := New(cfg, Options{})
19361937
Expect(err).NotTo(HaveOccurred())
1937-
Expect(m.GetEventRecorder("test")).NotTo(BeNil())
1938+
Expect(m.GetEventRecorderFor("test")).NotTo(BeNil())
19381939
})
19391940
It("should provide a function to get the APIReader", func() {
19401941
m, err := New(cfg, Options{})

‎pkg/recorder/example_test.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ var (
3030

3131
func Example_event() {
3232
// recorderProvider is a recorder.Provider
33-
recorder := recorderProvider.GetEventRecorder("my-controller")
33+
recorder := recorderProvider.GetEventRecorderFor("my-controller")
3434

3535
// emit an event with a fixed message
3636
recorder.Event(somePod, corev1.EventTypeWarning,
@@ -39,7 +39,7 @@ func Example_event() {
3939

4040
func Example_eventf() {
4141
// recorderProvider is a recorder.Provider
42-
recorder := recorderProvider.GetEventRecorder("my-controller")
42+
recorder := recorderProvider.GetEventRecorderFor("my-controller")
4343

4444
// emit an event with a variable message
4545
mildCheese := "Wensleydale"

0 commit comments

Comments
 (0)