Merge pull request #42 from torchbox/choices-caching

Add caching to choices

Author: RealOrangeOne

wagtail_jotform/models.py

@@ -1,3 +1,4 @@
+from django.core.cache import cache
 from django.db import models
 from django.forms.widgets import Select
 from django.shortcuts import render
@@ -12,16 +13,25 @@
 from .utils import JotFormAPI
 
 
+CHOICES_CACHE_KEY = "jot_form_choices"
+
+
 def jot_form_choices():
-    jot_form_data = []
-    if wagtail_jotform_settings.API_URL and wagtail_jotform_settings.API_KEY:
-        jotform = JotFormAPI()
-        jotform.fetch_from_api()
-        data = jotform.get_data()
-        if "content" in data:
-            for item in data["content"]:
-                jot_form_data.append((item["id"], item["title"]))
-    return jot_form_data
+    # Use a `None` check to allow empty choices to still be cached
+    if (form_choices := cache.get(CHOICES_CACHE_KEY)) is None:
+
+        form_choices = []
+        if wagtail_jotform_settings.API_URL and wagtail_jotform_settings.API_KEY:
+            jotform = JotFormAPI()
+            jotform.fetch_from_api()
+            data = jotform.get_data()
+            if "content" in data:
+                for item in data["content"]:
+                    form_choices.append((item["id"], item["title"]))
+
+        cache.set(CHOICES_CACHE_KEY, form_choices, timeout=300)
+
+    return form_choices
 
 
 class EmbeddedFormPageAdminForm(WagtailAdminPageForm):
@@ -34,10 +44,6 @@ class EmbeddedFormPage(RoutablePageMixin, Page):
 
     base_form_class = EmbeddedFormPageAdminForm
 
-    def __init__(self, *args, **kwargs):
-        super().__init__(*args, **kwargs)
-        jot_form_choices()
-
     thank_you_template = "wagtail_jotform/thank_you.html"
     subpage_types = []
 

wagtail_jotform/tests/settings.py

@@ -77,3 +77,9 @@
 WAGTAILADMIN_BASE_URL = "http://localhost:8000"
 
 STATIC_URL = "/static/"
+
+CACHES = {
+    "default": {
+        "BACKEND": "django.core.cache.backends.dummy.DummyCache",
+    }
+}

wagtail_jotform/tests/tests.py

@@ -499,15 +499,6 @@ def test_jot_form_choices_with_content(self, mock_api):
         self.assertEqual(choices, [("1", "Form 1"), ("2", "Form 2")])
         mock_api_instance.fetch_from_api.assert_called_once()
 
-    @mock.patch("wagtail_jotform.models.jot_form_choices")
-    def test_form_choices_called_in_model_init(self, mock_jot_form_choices):
-        """Test that jot_form_choices is called when initializing EmbeddedFormPage."""
-        # Create a new instance to trigger the __init__ method
-        EmbeddedFormPage(title="Test Form Page")
-
-        # Verify that jot_form_choices was called
-        mock_jot_form_choices.assert_called_once()
-
     def test_thank_you_page_route(self):
         """Test the thank you page route renders correctly."""
         response = self.client.get("/embeded-form-page/thank-you/")