Skip to content

Commit 707562c

Browse files
committed
add String() to source interface
Signed-off-by: Troy Connor <[email protected]>
1 parent d19d76c commit 707562c

File tree

2 files changed

+5
-1
lines changed

2 files changed

+5
-1
lines changed

pkg/internal/controller/controller.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,7 @@ func (c *Controller[request]) Start(ctx context.Context) error {
175175
// caches.
176176
errGroup := &errgroup.Group{}
177177
for _, watch := range c.startWatches {
178-
log := c.LogConstructor(nil).WithValues("source", fmt.Sprintf("%s", watch))
178+
log := c.LogConstructor(nil).WithValues("source", watch.String())
179179
didStartSyncingSource := &atomic.Bool{}
180180
errGroup.Go(func() error {
181181
// Use a timeout for starting and syncing the source to avoid silently

pkg/source/source.go

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,10 @@ type TypedSource[request comparable] interface {
5656
// Start is internal and should be called only by the Controller to start the source.
5757
// Start must be non-blocking.
5858
Start(context.Context, workqueue.TypedRateLimitingInterface[request]) error
59+
60+
// String enforces the custom source to adhere to the fmt.Stringer interface
61+
// to print when being logged.
62+
String() string
5963
}
6064

6165
// SyncingSource is a source that needs syncing prior to being usable. The controller

0 commit comments

Comments
 (0)