Add comment about Report callers needing to cancel context

elastic · Oct 12, 2023 · 89ca86b · 89ca86b
1 parent e9fc097
commit 89ca86b
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/internal/pkg/agent/application/upgrade/artifact/download/http/progress_reporter.go b/internal/pkg/agent/application/upgrade/artifact/download/http/progress_reporter.go
@@ -44,6 +44,8 @@ func (dp *downloadProgressReporter) Write(b []byte) (int, error) {
 	return n, nil
 }
 
+// Report periodically reports download progress to registered observers. Callers MUST cancel
+// the context passed to this method to avoid resource leaks.
 func (dp *downloadProgressReporter) Report(ctx context.Context) {
 	started := time.Now()
 	dp.started = started