Merge pull request #434 from MongoEngine/debug-panel-update

Debug panel source code simplified

Author: insspb

flask_mongoengine/operation_tracker.py

@@ -18,7 +18,6 @@
     "updates",
     "removes",
     "install_tracker",
-    "uninstall_tracker",
     "reset",
     "response_sizes",
 ]
@@ -486,33 +485,6 @@ def install_tracker():
         pymongo.command_cursor.CommandCursor._unpack_response = _unpack_response
 
 
-def uninstall_tracker():
-    if pymongo.collection.Collection.insert == _insert:
-        pymongo.collection.Collection.insert = _original_methods["insert"]
-    if pymongo.collection.Collection.insert_one == _insert_one:
-        pymongo.collection.Collection.insert_one = _original_methods["insert_one"]
-    if pymongo.collection.Collection.insert_many == _insert_many:
-        pymongo.collection.Collection.insert_many = _original_methods["insert_many"]
-    if pymongo.collection.Collection.update == _update:
-        pymongo.collection.Collection.update = _original_methods["update"]
-    if pymongo.collection.Collection.update_one == _update_one:
-        pymongo.collection.Collection.update_one = _original_methods["update_one"]
-    if pymongo.collection.Collection.update_many == _update_many:
-        pymongo.collection.Collection.update_many = _original_methods["update_many"]
-    if pymongo.collection.Collection.remove == _remove:
-        pymongo.collection.Collection.remove = _original_methods["remove"]
-    if pymongo.collection.Collection.delete_one == _delete_one:
-        pymongo.collection.Collection.delete_one = _original_methods["delete_one"]
-    if pymongo.collection.Collection.delete_many == _delete_many:
-        pymongo.collection.Collection.delete_many = _original_methods["delete_many"]
-    if pymongo.cursor.Cursor._refresh == _cursor_refresh:
-        pymongo.cursor.Cursor._refresh = _original_methods["cursor_refresh"]
-    if pymongo.command_cursor.CommandCursor._unpack_response == _unpack_response:
-        pymongo.command_cursor.CommandCursor._unpack_response = _original_methods[
-            "_unpack_response"
-        ]
-
-
 def reset():
     global queries, inserts, updates, removes, response_sizes
     queries = []
@@ -548,7 +520,8 @@ def _tidy_stacktrace():
             fname = sys._getframe(i).f_code.co_filename
             if ".html" in fname:
                 fnames.append(fname)
-        except Exception:
+        # Stack can have not enough frames
+        except ValueError:
             break
     fnames = list(set(fnames))
     trace = []

flask_mongoengine/panels.py

@@ -18,10 +18,7 @@ def _maybe_patch_jinja_loader(jinja_env):
 
 
 class MongoDebugPanel(DebugPanel):
-    """Panel that shows information about MongoDB operations (including stack)
-
-    Adapted from https://github.com/hmarr/django-debug-toolbar-mongo
-    """
+    """Panel that shows information about MongoDB operations."""
 
     name = "MongoDB"
     has_content = True
@@ -34,33 +31,38 @@ def __init__(self, *args, **kwargs):
     def process_request(self, request):
         operation_tracker.reset()
 
-    def nav_title(self):
-        return "MongoDB"
-
-    def nav_subtitle(self):
-        attrs = ["queries", "inserts", "updates", "removes"]
-        ops = sum(
-            sum((1 for o in getattr(operation_tracker, a) if not o["internal"]))
-            for a in attrs
-        )
-        total_time = sum(
-            sum(o["time"] for o in getattr(operation_tracker, a)) for a in attrs
-        )
-        return "{0} operations in {1:.2f}ms".format(ops, total_time)
-
-    def title(self):
+    def nav_title(self) -> str:
+        return self.name
+
+    def nav_subtitle(self) -> str:
+        """Count operations and total time, excluding any toolbar related operations."""
+        total_time = 0
+        operations_count = 0
+        for query_type in {"queries", "inserts", "updates", "removes"}:
+            for operation in getattr(operation_tracker, query_type):
+                if operation.get("internal", False):
+                    continue
+
+                operations_count += 1
+                total_time += operation.get("time", 0)
+
+        return "{0} operations in {1:.2f}ms".format(operations_count, total_time)
+
+    def title(self) -> str:
         return "MongoDB Operations"
 
-    def url(self):
+    def url(self) -> str:
         return ""
 
     def content(self):
-        context = self.context.copy()
-        context["queries"] = operation_tracker.queries
-        context["inserts"] = operation_tracker.inserts
-        context["updates"] = operation_tracker.updates
-        context["removes"] = operation_tracker.removes
-        context["slow_query_limit"] = current_app.config.get(
-            "MONGO_DEBUG_PANEL_SLOW_QUERY_LIMIT", 100
-        )
+        """Gather all template required variables in one dict."""
+        context = {
+            "queries": operation_tracker.queries,
+            "inserts": operation_tracker.inserts,
+            "updates": operation_tracker.updates,
+            "removes": operation_tracker.removes,
+            "slow_query_limit": current_app.config.get(
+                "MONGO_DEBUG_PANEL_SLOW_QUERY_LIMIT", 100
+            ),
+        }
         return self.render("panels/mongo-panel.html", context)