feat: document function

nathantournant · nathantournant · commit ed23e84b0ab7 · 2022-08-23T16:26:36.000+02:00
diff --git a/controllers/cache_handler.go b/controllers/cache_handler.go
@@ -583,6 +583,8 @@ func (r *DisruptionReconciler) clearExpiredCacheContexts() {
 	}
 }
 
+// cacheDeletionSafety is thought to be run in a goroutine to assert a cache is not running without its disruption
+// the polling is living on the cache context, meaning if it's deleted elsewhere this function will return early.
 func (r *DisruptionReconciler) cacheDeletionSafety(ctxTpl CtxTuple, disHash string) {
 	_ = wait.PollInfiniteWithContext(ctxTpl.Ctx, time.Minute, func(context.Context) (bool, error) {
 		if err := r.Get(ctxTpl.Ctx, ctxTpl.DisruptionNamespacedName, &chaosv1beta1.Disruption{}); err != nil {

Original file line number	Diff line number	Diff line change
`@@ -583,6 +583,8 @@ func (r *DisruptionReconciler) clearExpiredCacheContexts() {`
`583`	`583`	`}`
`584`	`584`	`}`
`585`	`585`
	`586`	`+// cacheDeletionSafety is thought to be run in a goroutine to assert a cache is not running without its disruption`
	`587`	`+// the polling is living on the cache context, meaning if it's deleted elsewhere this function will return early.`
`586`	`588`	`func (r *DisruptionReconciler) cacheDeletionSafety(ctxTpl CtxTuple, disHash string) {`
`587`	`589`	`_ = wait.PollInfiniteWithContext(ctxTpl.Ctx, time.Minute, func(context.Context) (bool, error) {`
`588`	`590`	`if err := r.Get(ctxTpl.Ctx, ctxTpl.DisruptionNamespacedName, &chaosv1beta1.Disruption{}); err != nil {`