PYTHON-1704 Close periodic task thread when client is closed (mongodb#389)

ShaneHarvey · web-flow · commit ff5f1ce8a449 · 2018-12-13T12:04:03.000-08:00
diff --git a/pymongo/mongo_client.py b/pymongo/mongo_client.py
@@ -1030,8 +1030,9 @@ def close(self):
         session_ids = self._topology.pop_all_sessions()
         if session_ids:
             self._end_sessions(session_ids)
-        # Run _process_periodic_tasks to send pending killCursor requests
-        # before closing the topology.
+        # Stop the periodic task thread and then run _process_periodic_tasks
+        # to send pending killCursor requests before closing the topology.
+        self._kill_cursors_executor.close()
         self._process_periodic_tasks()
         self._topology.close()
 
@@ -1071,6 +1072,8 @@ def _get_topology(self):
         launches the connection process in the background.
         """
         self._topology.open()
+        with self.__lock:
+            self._kill_cursors_executor.open()
         return self._topology
 
     @contextlib.contextmanager
@@ -1136,10 +1139,6 @@ def _send_message_with_response(self, operation, exhaust=False,
           - `address` (optional): Optional address when sending a message
             to a specific server, used for getMore.
         """
-        with self.__lock:
-            # If needed, restart kill-cursors thread after a fork.
-            self._kill_cursors_executor.open()
-
         topology = self._get_topology()
         if address:
             server = topology.select_server_by_address(address)
diff --git a/test/test_client.py b/test/test_client.py
@@ -640,6 +640,23 @@ def test_close_kills_cursors(self):
         self.client._process_periodic_tasks()
         self.assertFalse(self.client._topology._opened)
 
+    def test_close_stops_kill_cursors_thread(self):
+        client = rs_client()
+        client.test.test.find_one()
+        self.assertFalse(client._kill_cursors_executor._stopped)
+
+        # Closing the client should stop the thread.
+        client.close()
+        self.assertTrue(client._kill_cursors_executor._stopped)
+
+        # Reusing the closed client should restart the thread.
+        client.admin.command('isMaster')
+        self.assertFalse(client._kill_cursors_executor._stopped)
+
+        # Again, closing the client should stop the thread.
+        client.close()
+        self.assertTrue(client._kill_cursors_executor._stopped)
+
     def test_bad_uri(self):
         with self.assertRaises(InvalidURI):
             MongoClient("http://localhost")
