garbage collection and memory cleanup upon tab closure to prevent memory leak across users

Author: m-beau

channelmap_generator/__init__.py

@@ -7,6 +7,6 @@
 
 from .backend import *
 
-__version__ = "0.3.9"
+__version__ = "0.3.10"
 __author__ = "Maxime Beau"
 __email__ = "maxime@princeton.edu"

channelmap_generator/gui/app_util.py

@@ -37,20 +37,13 @@ def monitor_memory():
 
 
 def main(show=True, local=True):
-    # Create app
-    app = create_app()
-
     # Monitor potential memory leak
     monitor_memory()
 
     # Serve the app
     print("Starting app...")
     if local:
         port = find_free_port(5003)
-        pn.serve(app, port=port, show=show, title="Neuropixels Channelmap Generator", verbose=True)
+        pn.serve(create_app, port=port, show=show, title="Neuropixels Channelmap Generator", verbose=True)
     else:
-        app.servable(title="Neuropixels Channelmap Generator")
-
-
-if __name__ == "__main__":
-    main(show=True, local=True)
+        create_app().servable(title="Neuropixels Channelmap Generator")

channelmap_generator/gui/gui.py

@@ -167,6 +167,27 @@ def __init__(self, **params):
         # Create widgets
         self.create_widgets()
 
+        # Register cleanup on session destroy
+        if pn.state.curdoc:
+            pn.state.curdoc.on_session_destroyed(self._cleanup_session)
+
+    def _cleanup_session(self, session_context):
+        """Clean up resources when session ends"""
+
+        self.clear_bokeh_data()
+
+        if hasattr(self, 'electrode_source'):
+            del self.electrode_source
+        if hasattr(self, 'tool_state_source'):
+            del self.tool_state_source
+        if hasattr(self, 'plot'):
+            del self.plot
+        if hasattr(self, 'plot_pane'):
+            del self.plot_pane
+
+        gc.collect()
+        print(f"🧹🧹🧹 Session {session_context.id} cleaned up")
+
 
     #####################################
     ##### Probe geometry and wiring #####
@@ -493,9 +514,7 @@ def on_electrode_selection(self, _, old, new):
         # Clear the selection to allow for new interactions
         self.electrode_source.selected.indices = []
 
-        # Force garbage collection after large selections to free memory
-        if len(new) > 100:
-            gc.collect()
+        gc.collect()
 
 
     def get_zigzag_subset(self):
@@ -676,10 +695,8 @@ def generate_pdf_content(self):
             buffer.seek(0)
 
         finally:
-            # Force cleanup of matplotlib resources
-            plt.close('all')  # Close all figures
-            plt.clf()         # Clear current figure
-            plt.cla()         # Clear current axes
+            plt.close('all')
+            gc.collect()
 
         return buffer
 

entrypoint.sh

@@ -18,4 +18,7 @@ exec uv run panel serve ./app.py \
     --port "$INTERNAL_PORT" \
     --allow-websocket-origin "$ALLOW_WEBSOCKET_ORIGIN" \
     --num-procs "$NUM_PROCS" \
+    --session-token-expiration 3600000 \
+    --check-unused-sessions 10000 \
+    --unused-session-lifetime 60000 \
     --show