Skip to content

refactor(controller): encapsulate context cancellation logic #1051

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.

Sign up for GitHub

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

Open
rogercoll wants to merge 4 commits into
base: main
Choose a base branch
from
Open

refactor(controller): encapsulate context cancellation logic #1051

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d9e746d
refactor(controller): encapsulate context cancellation logic
rogercoll Jan 8, 2026
defaae7
Update internal/controller/controller.go
rogercoll Jan 9, 2026
c18e452
Update internal/controller/controller.go
rogercoll Jan 9, 2026
9a2ae6f
Update internal/controller/controller.go
rogercoll Jan 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions internal/controller/controller.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@ type Controller struct {
config *Config
reporter reporter.Reporter
tracer *tracer.Tracer

cancelFunc context.CancelFunc
}

// New creates a new controller
Expand All @@ -48,6 +50,8 @@ func (c *Controller) Start(ctx context.Context) error {
intervals := times.New(c.config.ReporterInterval, c.config.MonitorInterval,
c.config.ProbabilisticInterval)

ctx, c.cancelFunc = context.WithCancel(ctx)
Copy link
Contributor

@florianl florianl Jan 9, 2026

Choose a reason for hiding this comment

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

To avoid shadowing conflicts, the new context should be named differently to the context that is given as argument.

Copy link
Contributor Author

@rogercoll rogercoll Jan 9, 2026 •
edited
Loading

Choose a reason for hiding this comment

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

In this case we intentionally want to override the parent context and prevent its use further down the function. I think that reusing ctx here aligns with Google best practices (“It’s OK to do this when the original value is no longer needed”). Since the derived context fully replaces the parent, keeping the same name makes that intent clear.

Nonetheless, I don't have a strong opinion. I can name it differently if that feels clearer or easier to follow.


// Start periodic synchronization with the realtime clock
times.StartRealtimeSync(ctx, c.config.ClockSyncInterval)

Expand Down Expand Up @@ -151,6 +155,10 @@ func (c *Controller) Start(ctx context.Context) error {
// Shutdown stops the controller
func (c *Controller) Shutdown() {
log.Info("Stop processing ...")
if c.cancelFunc != nil {
c.cancelFunc()
}

if c.reporter != nil {
c.reporter.Stop()
}
Expand Down