Bugfix: Close heartbeat thread more reliably (#54)

VERSION

@@ -1 +1 @@
-0.8.11
+0.8.12

src/boardwalk/cli_run.py

@@ -634,8 +634,8 @@ def unmutex_boardwalkd_workspace():
     ctx.call_on_close(unmutex_boardwalkd_workspace)
 
     # Send heartbeats in background
-    heartbeat_coroutine = boardwalkd_client.heartbeat_keepalive_connect()
-    ctx.call_on_close(heartbeat_coroutine.cancel)
+    heartbeat_quit = boardwalkd_client.heartbeat_keepalive_connect()
+    ctx.call_on_close(heartbeat_quit.set)
 
 
 def update_host_facts_in_local_state(host: Host, workspace: Workspace):

src/boardwalkd/protocol.py

@@ -7,6 +7,7 @@
 import json
 import logging
 import socket
+import threading
 import time
 import webbrowser
 from collections import deque
@@ -257,9 +258,14 @@ def workspace_post_heartbeat(self, workspace_name: str):
             else:
                 raise e
 
-    def workspace_heartbeat_keepalive(self, workspace_name: str) -> None:
+    def workspace_heartbeat_keepalive(
+        self, workspace_name: str, quit: threading.Event
+    ) -> None:
         """Tries to post a heartbeat to the server every 5 seconds"""
         while True:
+            if quit.is_set():
+                logging.debug("Heartbeat keepalive thread closing")
+                return
             try:
                 self.workspace_post_heartbeat(workspace_name)
             except (
@@ -275,12 +281,13 @@ def workspace_heartbeat_keepalive(self, workspace_name: str) -> None:
 
     def workspace_heartbeat_keepalive_connect(
         self, workspace_name: str
-    ) -> concurrent.futures.Future[None]:
+    ) -> threading.Event:
         """Starts a background thread to post heartbeats to the server so it
         knows when a client is alive"""
         executor = concurrent.futures.ThreadPoolExecutor()
-        future = executor.submit(self.workspace_heartbeat_keepalive, workspace_name)
-        return future
+        quit = threading.Event()
+        executor.submit(self.workspace_heartbeat_keepalive, workspace_name, quit)
+        return quit
 
     def workspace_post_event(
         self,