Skip to content

Bugfix/gr ndit 655 fix issues with message templating when utilising params in the br logic #18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
stevenhsd merged 3 commits into from
Dec 16, 2025
Merged

Bugfix/gr ndit 655 fix issues with message templating when utilising params in the br logic #18

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8aa9ac8
fix: fix issue where templated error messages would not correctly for…
georgeRobertson Dec 15, 2025
686eaac
style: remove old implementation for jinja env setup
georgeRobertson Dec 15, 2025
e4878e6
fix: resolve issue with jinja2 environment and security concern aroun…
georgeRobertson Dec 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/dve/core_engine/backends/metadata/reporting.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ class BaseReportingConfig(BaseModel):

"""

UNTEMPLATED_FIELDS: ClassVar[set[str]] = {"message"}
UNTEMPLATED_FIELDS: ClassVar[set[str]] = set()
"""Fields that should not be templated."""

emit: Optional[str] = None
Expand Down
15 changes: 14 additions & 1 deletion src/dve/core_engine/templating.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,16 @@
from dve.core_engine.type_hints import JSONable, TemplateVariables


class PreserveTemplateUndefined(jinja2.Undefined):
"""
Preserve the original template in instances where the value cannot be populated. Whilst this
may result in templates coming back in the FeedbackMessage object, it's more useful to know
exactly what should have been populated rather than just returning blank values.
"""
def __str__(self):
return "{{" + self._undefined_name + "}}"


class RuleTemplateError(ValueError):
"""A rule template error."""

Expand All @@ -21,7 +31,10 @@ def _raise_rule_templating_error(message: str) -> NoReturn:


T = TypeVar("T", bound=JSONable)
ENVIRONMENT = jinja2.Environment(autoescape=False)
ENVIRONMENT = jinja2.Environment(
autoescape=jinja2.select_autoescape(default_for_string=False),
undefined=PreserveTemplateUndefined,
)
ENVIRONMENT.globals["repr"] = repr
ENVIRONMENT.globals["str"] = str
ENVIRONMENT.globals["raise"] = _raise_rule_templating_error
Expand Down