fix: use correct interval for healthcheck loop (#4212)

f0ssel · web-flow · commit 20bcb04e8a2c · 2022-09-26T21:00:58.000Z
diff --git a/agent/apphealth.go b/agent/apphealth.go
@@ -109,7 +109,7 @@ func NewWorkspaceAppHealthReporter(logger slog.Logger, workspaceAgentApps Worksp
 						mu.Unlock()
 					}
 
-					t.Reset(time.Duration(app.Healthcheck.Interval))
+					t.Reset(time.Duration(app.Healthcheck.Interval) * time.Second)
 				}
 			}()
 		}
diff --git a/agent/apphealth_test.go b/agent/apphealth_test.go
@@ -5,6 +5,7 @@ import (
 	"net/http"
 	"net/http/httptest"
 	"sync"
+	"sync/atomic"
 	"testing"
 	"time"
 
@@ -129,6 +130,37 @@ func TestAppHealth(t *testing.T) {
 			return apps[0].Health == codersdk.WorkspaceAppHealthUnhealthy
 		}, testutil.WaitLong, testutil.IntervalSlow)
 	})
+
+	t.Run("NotSpamming", func(t *testing.T) {
+		t.Parallel()
+		ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
+		defer cancel()
+		apps := []codersdk.WorkspaceApp{
+			{
+				Name: "app2",
+				Healthcheck: codersdk.Healthcheck{
+					// URL: We don't set the URL for this test because the setup will
+					// create a httptest server for us and set it for us.
+					Interval:  1,
+					Threshold: 1,
+				},
+				Health: codersdk.WorkspaceAppHealthInitializing,
+			},
+		}
+
+		var counter = new(int32)
+		handlers := []http.Handler{
+			http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+				atomic.AddInt32(counter, 1)
+			}),
+		}
+		_, closeFn := setupAppReporter(ctx, t, apps, handlers)
+		defer closeFn()
+		// Ensure we haven't made more than 2 (expected 1 + 1 for buffer) requests in the last second.
+		// if there is a bug where we are spamming the healthcheck route this will catch it.
+		time.Sleep(time.Second)
+		require.LessOrEqual(t, *counter, int32(2))
+	})
 }
 
 func setupAppReporter(ctx context.Context, t *testing.T, apps []codersdk.WorkspaceApp, handlers []http.Handler) (agent.WorkspaceAgentApps, func()) {

Original file line number	Diff line number	Diff line change
`@@ -109,7 +109,7 @@ func NewWorkspaceAppHealthReporter(logger slog.Logger, workspaceAgentApps Worksp`
`109`	`109`	`mu.Unlock()`
`110`	`110`	`}`
`111`	`111`
`112`		`- t.Reset(time.Duration(app.Healthcheck.Interval))`
	`112`	`+ t.Reset(time.Duration(app.Healthcheck.Interval) * time.Second)`
`113`	`113`	`}`
`114`	`114`	`}()`
`115`	`115`	`}`