Fix agent queue with loads of logs

kylecarbs · kylecarbs · commit decde5c9898b · 2023-03-20T02:01:22.000Z
diff --git a/agent/agent.go b/agent/agent.go
@@ -666,6 +666,13 @@ func (a *agent) runScript(ctx context.Context, lifecycle, script string) error {
 	var flushLogsTimer *time.Timer
 	var logMutex sync.Mutex
 	var logsSending bool
+	defer func() {
+		logMutex.Lock()
+		if flushLogsTimer != nil {
+			flushLogsTimer.Stop()
+		}
+		logMutex.Unlock()
+	}()
 
 	// sendLogs function uploads the queued logs to the server
 	sendLogs := func() {
@@ -708,6 +715,7 @@ func (a *agent) runScript(ctx context.Context, lifecycle, script string) error {
 		// Reset logsSending flag
 		logMutex.Lock()
 		logsSending = false
+		flushLogsTimer.Reset(100 * time.Millisecond)
 		logMutex.Unlock()
 	}
 	// queueLog function appends a log to the queue and triggers sendLogs if necessary
@@ -720,8 +728,10 @@ func (a *agent) runScript(ctx context.Context, lifecycle, script string) error {
 
 		// If there are more than 100 logs, send them immediately
 		if len(queuedLogs) > 100 {
+			// Don't early return after this, because we still want
+			// to reset the timer just in case logs come in while
+			// we're sending.
 			go sendLogs()
-			return
 		}
 		// Reset or set the flushLogsTimer to trigger sendLogs after 100 milliseconds
 		if flushLogsTimer != nil {
diff --git a/cli/agent.go b/cli/agent.go
@@ -117,7 +117,10 @@ func workspaceAgent() *cobra.Command {
 			client := agentsdk.New(coderURL)
 			client.SDK.Logger = logger
 			// Set a reasonable timeout so requests can't hang forever!
-			client.SDK.HTTPClient.Timeout = 10 * time.Second
+			// The timeout needs to be reasonably long, because requests
+			// with large payloads can take a bit. e.g. startup scripts
+			// may take a while to insert.
+			client.SDK.HTTPClient.Timeout = 30 * time.Second
 
 			// Enable pprof handler
 			// This prevents the pprof import from being accidentally deleted.
diff --git a/site/src/components/Resources/AgentRow.tsx b/site/src/components/Resources/AgentRow.tsx
@@ -97,11 +97,17 @@ export const AgentRow: FC<AgentRowProps> = ({
     return logs
   }, [logsMachine.context.startupLogs, agent.startup_logs_overflowed])
   const [bottomOfLogs, setBottomOfLogs] = useState(true)
+  // This is a layout effect to remove flicker when we're scrolling to the bottom.
   useLayoutEffect(() => {
+    // If we're currently watching the bottom, we always want to stay at the bottom.
     if (bottomOfLogs && logListRef.current) {
       logListRef.current.scrollToItem(startupLogs.length - 1, "end")
     }
   }, [showStartupLogs, startupLogs, logListRef, bottomOfLogs])
+
+  // This is a bit of a hack on the react-window API to get the scroll position.
+  // If we're scrolled to the bottom, we want to keep the list scrolled to the bottom.
+  // This makes it feel similar to a terminal that auto-scrolls downwards!
   const handleLogScroll = useCallback(
     (props: ListOnScrollProps) => {
       if (
