Log any potential encoding errors in template scanning (#215)

joshuadavidthomas · web-flow · commit 9dd2c816bfbe · 2025-03-06T12:21:07.000-06:00
* Log any potential encoding errors in template scanning

- Added logging for template processing errors
- Improved error handling in find_components_in_template to catch UnicodeDecodeError
- Added tests for proper handling of binary/invalid files during template scanning
- Updated IncludeNode visitor to log errors when processing included templates

* change to the tilde syntax?

* okay...
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -34,6 +34,7 @@ and this project attempts to adhere to [Semantic Versioning](https://semver.org/
 ### Fixed
 
 - Fixed bug where assets from components with the same name in different directories weren't being properly collected
+- Fixed template scanning on some platforms by improving error handling for invalid template files
 
 ### Removed
 
diff --git a/pyproject.toml b/pyproject.toml
@@ -254,4 +254,4 @@ required-imports = ["from __future__ import annotations"]
 keep-runtime-typing = true
 
 [tool.uv]
-required-version = "==0.6.*"
+required-version = "<0.7"
diff --git a/src/django_bird/templates.py b/src/django_bird/templates.py
@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+import logging
 import multiprocessing
 from collections.abc import Callable
 from collections.abc import Generator
@@ -28,6 +29,8 @@
 from .utils import get_files_from_dirs
 from .utils import unique_ordered
 
+logger = logging.getLogger(__name__)
+
 
 def get_template_names(name: str) -> list[str]:
     """
@@ -155,8 +158,11 @@ def find_components_in_template(template_path: str | Path) -> set[str]:
         with context.bind_template(template):
             visitor.visit(template, context)
         return visitor.components
-    except (TemplateDoesNotExist, TemplateSyntaxError):
-        # If we can't load the template, return an empty set
+    except (TemplateDoesNotExist, TemplateSyntaxError, UnicodeDecodeError) as e:
+        # If we can't load or process the template for any reason, log the exception and return an empty set
+        logger.debug(
+            f"Could not process template {template_name!r}: {e.__class__.__name__}: {e}"
+        )
         return set()
 
 
@@ -209,6 +215,8 @@ def visit_IncludeNode(self, node: IncludeNode, context: Context) -> None:
             for template_name in included_templates:
                 included_template = self.engine.get_template(template_name)
                 self.visit(included_template, context)
-        except Exception:
-            pass
+        except Exception as e:
+            logger.debug(
+                f"Error processing included template in NodeVisitor: {e.__class__.__name__}: {e}"
+            )
         self.generic_visit(node, context)
diff --git a/tests/test_templates.py b/tests/test_templates.py
@@ -3,6 +3,8 @@
 import pytest
 from django.test import override_settings
 
+from django_bird.templates import find_components_in_template
+from django_bird.templates import gather_bird_tag_template_usage
 from django_bird.templates import get_template_names
 
 
@@ -68,3 +70,27 @@ def test_get_template_names_duplicates():
 
         for _, count in template_counts.items():
             assert count == 1
+
+
+def test_find_components_handles_errors():
+    result = find_components_in_template("non_existent_template.html")
+    assert result == set()
+
+
+def test_find_components_handles_encoding_errors(templates_dir):
+    binary_file = templates_dir / "binary_file.html"
+    with open(binary_file, "wb") as f:
+        f.write(b"\x80\x81\x82invalid binary content\xfe\xff")
+
+    valid_file = templates_dir / "valid_file.html"
+    valid_file.write_text("""
+    <html>
+    <body>
+        {% bird button %}Button{% endbird %}
+    </body>
+    </html>
+    """)
+
+    results = list(gather_bird_tag_template_usage())
+
+    assert all(str(valid_file) in str(path) for path, _ in results)
