Rename store_id variants to request_id

tim-schilling · tim-schilling · commit c4201fa0f0dc · 2023-08-20T21:26:51.000-05:00
This matches the new naming defined in the store module and will make
things eaiser to change moving forward.

This will break anything using the store internally causing issues for
third party packages.
diff --git a/debug_toolbar/panels/history/forms.py b/debug_toolbar/panels/history/forms.py
@@ -5,8 +5,8 @@ class HistoryStoreForm(forms.Form):
     """
     Validate params
 
-        store_id: The key for the store instance to be fetched.
+        request_id: The key for the store instance to be fetched.
     """
 
-    store_id = forms.CharField(widget=forms.HiddenInput())
+    request_id = forms.CharField(widget=forms.HiddenInput())
     exclude_history = forms.BooleanField(widget=forms.HiddenInput(), required=False)
diff --git a/debug_toolbar/panels/history/panel.py b/debug_toolbar/panels/history/panel.py
@@ -23,9 +23,9 @@ class HistoryPanel(Panel):
     def get_headers(self, request):
         headers = super().get_headers(request)
         observe_request = self.toolbar.get_observe_request()
-        store_id = self.toolbar.store_id
-        if store_id and observe_request(request):
-            headers["djdt-store-id"] = store_id
+        request_id = self.toolbar.request_id
+        if request_id and observe_request(request):
+            headers["djdt-request-id"] = request_id
         return headers
 
     @property
@@ -91,18 +91,18 @@ def content(self):
             stores[id] = {
                 "toolbar": toolbar,
                 "form": HistoryStoreForm(
-                    initial={"store_id": id, "exclude_history": True}
+                    initial={"request_id": id, "exclude_history": True}
                 ),
             }
 
         return render_to_string(
             self.template,
             {
-                "current_store_id": self.toolbar.store_id,
+                "current_request_id": self.toolbar.request_id,
                 "stores": stores,
                 "refresh_form": HistoryStoreForm(
                     initial={
-                        "store_id": self.toolbar.store_id,
+                        "request_id": self.toolbar.request_id,
                         "exclude_history": True,
                     }
                 ),
diff --git a/debug_toolbar/panels/history/views.py b/debug_toolbar/panels/history/views.py
@@ -13,12 +13,12 @@ def history_sidebar(request):
     form = HistoryStoreForm(request.GET)
 
     if form.is_valid():
-        store_id = form.cleaned_data["store_id"]
-        toolbar = DebugToolbar.fetch(store_id)
+        request_id = form.cleaned_data["request_id"]
+        toolbar = DebugToolbar.fetch(request_id)
         exclude_history = form.cleaned_data["exclude_history"]
         context = {}
         if toolbar is None:
-            # When the store_id has been popped already due to
+            # When the request_id has been popped already due to
             # RESULTS_CACHE_SIZE
             return JsonResponse(context)
         for panel in toolbar.panels:
@@ -58,7 +58,7 @@ def history_refresh(request):
                                 "toolbar": toolbar,
                                 "form": HistoryStoreForm(
                                     initial={
-                                        "store_id": id,
+                                        "request_id": id,
                                         "exclude_history": True,
                                     }
                                 ),
diff --git a/debug_toolbar/static/debug_toolbar/js/history.js b/debug_toolbar/static/debug_toolbar/js/history.js
@@ -25,14 +25,17 @@ function refreshHistory() {
     const formTarget = djDebug.querySelector(".refreshHistory");
     const container = document.getElementById("djdtHistoryRequests");
     const oldIds = new Set(
-        pluckData(container.querySelectorAll("tr[data-store-id]"), "storeId")
+        pluckData(
+            container.querySelectorAll("tr[data-request-id]"),
+            "requestId"
+        )
     );
 
     ajaxForm(formTarget)
         .then(function (data) {
             // Remove existing rows first then re-populate with new data
             container
-                .querySelectorAll("tr[data-store-id]")
+                .querySelectorAll("tr[data-request-id]")
                 .forEach(function (node) {
                     node.remove();
                 });
@@ -43,8 +46,8 @@ function refreshHistory() {
         .then(function () {
             const allIds = new Set(
                 pluckData(
-                    container.querySelectorAll("tr[data-store-id]"),
-                    "storeId"
+                    container.querySelectorAll("tr[data-request-id]"),
+                    "requestId"
                 )
             );
             const newIds = difference(allIds, oldIds);
@@ -58,23 +61,23 @@ function refreshHistory() {
         .then(function (refreshInfo) {
             refreshInfo.newIds.forEach(function (newId) {
                 const row = container.querySelector(
-                    `tr[data-store-id="${newId}"]`
+                    `tr[data-request-id="${newId}"]`
                 );
                 row.classList.add("flash-new");
             });
             setTimeout(() => {
                 container
-                    .querySelectorAll("tr[data-store-id]")
+                    .querySelectorAll("tr[data-request-id]")
                     .forEach((row) => {
                         row.classList.remove("flash-new");
                     });
             }, 2000);
         });
 }
 
-function switchHistory(newStoreId) {
+function switchHistory(newRequestId) {
     const formTarget = djDebug.querySelector(
-        ".switchHistory[data-store-id='" + newStoreId + "']"
+        ".switchHistory[data-request-id='" + newRequestId + "']"
     );
     const tbody = formTarget.closest("tbody");
 
@@ -88,16 +91,16 @@ function switchHistory(newStoreId) {
         if (Object.keys(data).length === 0) {
             const container = document.getElementById("djdtHistoryRequests");
             container.querySelector(
-                'button[data-store-id="' + newStoreId + '"]'
+                'button[data-request-id="' + newRequestId + '"]'
             ).innerHTML = "Switch [EXPIRED]";
         }
-        replaceToolbarState(newStoreId, data);
+        replaceToolbarState(newRequestId, data);
     });
 }
 
 $$.on(djDebug, "click", ".switchHistory", function (event) {
     event.preventDefault();
-    switchHistory(this.dataset.storeId);
+    switchHistory(this.dataset.requestId);
 });
 
 $$.on(djDebug, "click", ".refreshHistory", function (event) {
diff --git a/debug_toolbar/static/debug_toolbar/js/toolbar.js b/debug_toolbar/static/debug_toolbar/js/toolbar.js
@@ -37,13 +37,13 @@ const djdt = {
                 const inner = current.querySelector(
                         ".djDebugPanelContent .djdt-scroll"
                     ),
-                    storeId = djDebug.dataset.storeId;
-                if (storeId && inner.children.length === 0) {
+                    requestId = djDebug.dataset.requestId;
+                if (requestId && inner.children.length === 0) {
                     const url = new URL(
                         djDebug.dataset.renderPanelUrl,
                         window.location
                     );
-                    url.searchParams.append("store_id", storeId);
+                    url.searchParams.append("request_id", requestId);
                     url.searchParams.append("panel_id", panelId);
                     ajax(url).then(function (data) {
                         inner.previousElementSibling.remove(); // Remove AJAX loader
@@ -270,11 +270,11 @@ const djdt = {
             document.getElementById("djDebug").dataset.sidebarUrl;
         const slowjax = debounce(ajax, 200);
 
-        function handleAjaxResponse(storeId) {
-            storeId = encodeURIComponent(storeId);
-            const dest = `${sidebarUrl}?store_id=${storeId}`;
+        function handleAjaxResponse(requestId) {
+            requestId = encodeURIComponent(requestId);
+            const dest = `${sidebarUrl}?request_id=${requestId}`;
             slowjax(dest).then(function (data) {
-                replaceToolbarState(storeId, data);
+                replaceToolbarState(requestId, data);
             });
         }
 
@@ -286,9 +286,11 @@ const djdt = {
                 // when the header can't be fetched. While it doesn't impede execution
                 // it's worrisome to developers.
                 if (
-                    this.getAllResponseHeaders().indexOf("djdt-store-id") >= 0
+                    this.getAllResponseHeaders().indexOf("djdt-request-id") >= 0
                 ) {
-                    handleAjaxResponse(this.getResponseHeader("djdt-store-id"));
+                    handleAjaxResponse(
+                        this.getResponseHeader("djdt-request-id")
+                    );
                 }
             });
             origOpen.apply(this, arguments);
@@ -298,8 +300,8 @@ const djdt = {
         window.fetch = function () {
             const promise = origFetch.apply(this, arguments);
             promise.then(function (response) {
-                if (response.headers.get("djdt-store-id") !== null) {
-                    handleAjaxResponse(response.headers.get("djdt-store-id"));
+                if (response.headers.get("djdt-request-id") !== null) {
+                    handleAjaxResponse(response.headers.get("djdt-request-id"));
                 }
                 // Don't resolve the response via .json(). Instead
                 // continue to return it to allow the caller to consume as needed.
diff --git a/debug_toolbar/static/debug_toolbar/js/utils.js b/debug_toolbar/static/debug_toolbar/js/utils.js
@@ -105,10 +105,10 @@ function ajaxForm(element) {
     return ajax(url, ajaxData);
 }
 
-function replaceToolbarState(newStoreId, data) {
+function replaceToolbarState(newRequestId, data) {
     const djDebug = document.getElementById("djDebug");
-    djDebug.setAttribute("data-store-id", newStoreId);
-    // Check if response is empty, it could be due to an expired storeId.
+    djDebug.setAttribute("data-request-id", newRequestId);
+    // Check if response is empty, it could be due to an expired requestId.
     Object.keys(data).forEach(function (panelId) {
         const panel = document.getElementById(panelId);
         if (panel) {
diff --git a/debug_toolbar/templates/debug_toolbar/base.html b/debug_toolbar/templates/debug_toolbar/base.html
@@ -8,7 +8,7 @@
 {% endblock %}
 <div id="djDebug" class="djdt-hidden" dir="ltr"
      {% if not toolbar.should_render_panels %}
-     data-store-id="{{ toolbar.store_id }}"
+     data-request-id="{{ toolbar.request_id }}"
      data-render-panel-url="{% url 'djdt:render_panel' %}"
      {% endif %}
      {% url 'djdt:history_sidebar' as history_url %}
diff --git a/debug_toolbar/templates/debug_toolbar/panels/history_tr.html b/debug_toolbar/templates/debug_toolbar/panels/history_tr.html
@@ -1,5 +1,5 @@
 {% load i18n %}
-<tr class="{% if id == current_store_id %}djdt-highlighted{% endif %}" id="historyMain_{{ id }}" data-store-id="{{ id }}">
+<tr class="{% if id == current_request_id %}djdt-highlighted{% endif %}" id="historyMain_{{ id }}" data-request-id="{{ id }}">
     <td>
         {{ store_context.toolbar.stats.HistoryPanel.time|escape }}
     </td>
@@ -44,7 +44,7 @@
     <td class="djdt-actions">
         <form method="get" action="{% url 'djdt:history_sidebar' %}">
             {{ store_context.form }}
-            <button data-store-id="{{ id }}" class="switchHistory">Switch</button>
+            <button data-request-id="{{ id }}" class="switchHistory">Switch</button>
         </form>
     </td>
 </tr>
diff --git a/debug_toolbar/toolbar.py b/debug_toolbar/toolbar.py
@@ -42,7 +42,7 @@ def __init__(self, request, get_response):
             self._panels[panel.panel_id] = panel
         self.stats = {}
         self.server_timing_stats = {}
-        self.store_id = None
+        self.request_id = None
         self._created.send(request, toolbar=self)
 
     # Manage panels
@@ -110,16 +110,16 @@ def should_render_panels(self):
 
     def store(self):
         # Store already exists.
-        if self.store_id:
+        if self.request_id:
             return
-        self.store_id = uuid.uuid4().hex
-        self._store[self.store_id] = self
+        self.request_id = uuid.uuid4().hex
+        self._store[self.request_id] = self
         for _ in range(self.config["RESULTS_CACHE_SIZE"], len(self._store)):
             self._store.popitem(last=False)
 
     @classmethod
-    def fetch(cls, store_id):
-        return cls._store.get(store_id)
+    def fetch(cls, request_id):
+        return cls._store.get(request_id)
 
     # Manually implement class-level caching of panel classes and url patterns
     # because it's more obvious than going through an abstraction.
diff --git a/debug_toolbar/views.py b/debug_toolbar/views.py
@@ -10,7 +10,7 @@
 @render_with_toolbar_language
 def render_panel(request):
     """Render the contents of a panel"""
-    toolbar = DebugToolbar.fetch(request.GET["store_id"])
+    toolbar = DebugToolbar.fetch(request.GET["request_id"])
     if toolbar is None:
         content = _(
             "Data for this panel isn't available anymore. "
diff --git a/docs/changes.rst b/docs/changes.rst
@@ -9,6 +9,8 @@ Serializable (don't include in main)
   storage mechanism. Defaults to ``debug_toolbar.store.MemoryStore``.
 * Added setting ``SUPPRESS_SERIALIZATION_ERRORS`` to suppress
   warnings when a ``TypeError`` occurs during a panel's serialization.
+* Rename ``store_id`` properties to ``request_id`` and ``Toolbar.store`` to
+  ``Toolbar.init_store``.
 
 
 Pending
diff --git a/tests/panels/test_history.py b/tests/panels/test_history.py
@@ -101,22 +101,22 @@ def test_history_sidebar_invalid(self):
     def test_history_headers(self):
         """Validate the headers injected from the history panel."""
         response = self.client.get("/json_view/")
-        store_id = list(DebugToolbar._store)[0]
-        self.assertEqual(response.headers["djdt-store-id"], store_id)
+        request_id = list(DebugToolbar._store)[0]
+        self.assertEqual(response.headers["djdt-request-id"], request_id)
 
     @override_settings(
         DEBUG_TOOLBAR_CONFIG={"OBSERVE_REQUEST_CALLBACK": lambda request: False}
     )
     def test_history_headers_unobserved(self):
         """Validate the headers aren't injected from the history panel."""
         response = self.client.get("/json_view/")
-        self.assertNotIn("djdt-store-id", response.headers)
+        self.assertNotIn("djdt-request-id", response.headers)
 
     def test_history_sidebar(self):
         """Validate the history sidebar view."""
         self.client.get("/json_view/")
-        store_id = list(DebugToolbar._store)[0]
-        data = {"store_id": store_id, "exclude_history": True}
+        request_id = list(DebugToolbar._store)[0]
+        data = {"request_id": request_id, "exclude_history": True}
         response = self.client.get(reverse("djdt:history_sidebar"), data=data)
         self.assertEqual(response.status_code, 200)
         self.assertEqual(
@@ -130,8 +130,8 @@ def test_history_sidebar_includes_history(self):
         panel_keys = copy.copy(self.PANEL_KEYS)
         panel_keys.add("HistoryPanel")
         panel_keys.add("RedirectsPanel")
-        store_id = list(DebugToolbar._store)[0]
-        data = {"store_id": store_id}
+        request_id = list(DebugToolbar._store)[0]
+        data = {"request_id": request_id}
         response = self.client.get(reverse("djdt:history_sidebar"), data=data)
         self.assertEqual(response.status_code, 200)
         self.assertEqual(
@@ -142,11 +142,11 @@ def test_history_sidebar_includes_history(self):
     @override_settings(
         DEBUG_TOOLBAR_CONFIG={"RESULTS_CACHE_SIZE": 1, "RENDER_PANELS": False}
     )
-    def test_history_sidebar_expired_store_id(self):
+    def test_history_sidebar_expired_request_id(self):
         """Validate the history sidebar view."""
         self.client.get("/json_view/")
-        store_id = list(DebugToolbar._store)[0]
-        data = {"store_id": store_id, "exclude_history": True}
+        request_id = list(DebugToolbar._store)[0]
+        data = {"request_id": request_id, "exclude_history": True}
         response = self.client.get(reverse("djdt:history_sidebar"), data=data)
         self.assertEqual(response.status_code, 200)
         self.assertEqual(
@@ -155,15 +155,15 @@ def test_history_sidebar_expired_store_id(self):
         )
         self.client.get("/json_view/")
 
-        # Querying old store_id should return in empty response
-        data = {"store_id": store_id, "exclude_history": True}
+        # Querying old request_id should return in empty response
+        data = {"request_id": request_id, "exclude_history": True}
         response = self.client.get(reverse("djdt:history_sidebar"), data=data)
         self.assertEqual(response.status_code, 200)
         self.assertEqual(response.json(), {})
 
-        # Querying with latest store_id
-        latest_store_id = list(DebugToolbar._store)[0]
-        data = {"store_id": latest_store_id, "exclude_history": True}
+        # Querying with latest request_id
+        latest_request_id = list(DebugToolbar._store)[0]
+        data = {"request_id": latest_request_id, "exclude_history": True}
         response = self.client.get(reverse("djdt:history_sidebar"), data=data)
         self.assertEqual(response.status_code, 200)
         self.assertEqual(
@@ -179,15 +179,15 @@ def test_history_refresh(self):
         )
 
         response = self.client.get(
-            reverse("djdt:history_refresh"), data={"store_id": "foo"}
+            reverse("djdt:history_refresh"), data={"request_id": "foo"}
         )
         self.assertEqual(response.status_code, 200)
         data = response.json()
         self.assertEqual(len(data["requests"]), 2)
 
-        store_ids = list(DebugToolbar._store)
-        self.assertIn(html.escape(store_ids[0]), data["requests"][0]["content"])
-        self.assertIn(html.escape(store_ids[1]), data["requests"][1]["content"])
+        request_ids = list(DebugToolbar._store)
+        self.assertIn(html.escape(request_ids[0]), data["requests"][0]["content"])
+        self.assertIn(html.escape(request_ids[1]), data["requests"][1]["content"])
 
         for val in ["foo", "bar"]:
             self.assertIn(val, data["requests"][0]["content"])
diff --git a/tests/test_integration.py b/tests/test_integration.py
