Fix component caching when DEBUG=True to properly track assets (#96)

Author: joshuadavidthomas

CHANGELOG.md

@@ -18,6 +18,10 @@ and this project attempts to adhere to [Semantic Versioning](https://semver.org/
 
 ## [Unreleased]
 
+### Fixed
+
+- **Internal**: Fixed component caching behavior to properly track assets. Components are now always cached for asset tracking, while still providing fresh templates in `DEBUG` mode.
+
 ## [0.8.1]
 
 ### Fixed

src/django_bird/components.py

@@ -91,7 +91,8 @@ def discover_components(self) -> None:
                     component_path.relative_to(component_dir).with_suffix("")
                 )
                 try:
-                    self.get_component(component_name)
+                    component = Component.from_name(component_name)
+                    self._components[component_name] = component
                 except TemplateDoesNotExist:
                     continue
 
@@ -101,12 +102,14 @@ def clear(self) -> None:
 
     def get_component(self, name: str) -> Component:
         try:
-            return self._components[name]
-        except KeyError:
-            component = Component.from_name(name)
             if not settings.DEBUG:
-                self._components[name] = component
-            return component
+                return self._components[name]
+        except KeyError:
+            pass
+
+        component = Component.from_name(name)
+        self._components[name] = component
+        return component
 
     def get_assets(self, asset_type: AssetType) -> list[Asset]:
         assets: list[Asset] = []

tests/test_components.py

@@ -396,6 +396,56 @@ def test_missing_asset_file(self, templates_dir):
 
 
 class TestComponentRegistryCaching:
+    def test_debug_mode_caching(self, templates_dir):
+        component = TestComponent(
+            name="button", content="<button>Original</button>"
+        ).create(templates_dir)
+
+        with override_settings(DEBUG=True):
+            first = components.get_component("button")
+
+            assert "button" in components._components
+            assert "Original" in first.template.template.source
+
+            component.file.write_text("<button>Updated</button>")
+            second = components.get_component("button")
+
+            assert second is not first
+            assert "Updated" in second.template.template.source
+
+    def test_production_mode_caching(self, templates_dir):
+        component = TestComponent(
+            name="button", content="<button>Original</button>"
+        ).create(templates_dir)
+
+        with override_settings(DEBUG=False):
+            first = components.get_component("button")
+
+            component.file.write_text("<button>Updated</button>")
+            second = components.get_component("button")
+
+            assert second is first
+            assert "Original" in second.template.template.source
+
+    @pytest.mark.parametrize("debug", [True, False])
+    def test_asset_tracking(self, debug, templates_dir):
+        button = TestComponent(
+            name="button", content="<button>Click me</button>"
+        ).create(templates_dir)
+
+        button_css = TestAsset(
+            component=button,
+            content=".button { color: red; }",
+            asset_type=AssetType.CSS,
+        ).create()
+
+        with override_settings(DEBUG=debug):
+            components.get_component("button")
+            css_assets = components.get_assets(AssetType.CSS)
+
+            assert len(css_assets) == 1
+            assert Asset(button_css.file, button_css.asset_type) in css_assets
+
     def test_lru_cache_limit(self, templates_dir):
         small_registry = ComponentRegistry(maxsize=2)
 
@@ -412,19 +462,6 @@ def test_lru_cache_limit(self, templates_dir):
         assert "button1" in small_registry._components
         assert "button2" in small_registry._components
 
-    def test_debug_mode_caching(self, templates_dir):
-        TestComponent(name="button", content="<button>Cache Me</button>").create(
-            templates_dir
-        )
-
-        with override_settings(DEBUG=True):
-            components.get_component("button")
-            assert "button" not in components._components
-
-        with override_settings(DEBUG=False):
-            components.get_component("button")
-            assert "button" in components._components
-
     def test_cache_clear(self, templates_dir):
         TestComponent(name="button", content="<button>Clear Me</button>").create(
             templates_dir