Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -2166,7 +2166,8 @@ export class WorkflowBuilder {
),
};
}).filter(rule => (
rule.notify_submitter
rule.rule_id
|| rule.notify_submitter
|| rule.email_field
|| rule.static_emails
|| rule.notify_stage_assignees
Expand Down
100 changes: 81 additions & 19 deletions django_forms_workflows/workflow_builder_views.py
Original file line number Diff line number Diff line change
Expand Up @@ -89,15 +89,25 @@ def _resolve_builder_workflow(


def _normalize_trigger_conditions(raw_conditions):
if not raw_conditions:
if (
raw_conditions is None
or raw_conditions == ""
or raw_conditions == []
or raw_conditions == {}
):
return None

if isinstance(raw_conditions, str):
try:
raw_conditions = json.loads(raw_conditions)
except json.JSONDecodeError as exc:
raise ValidationError("Trigger conditions must be valid JSON.") from exc
if not raw_conditions:
if (
raw_conditions is None
or raw_conditions == ""
or raw_conditions == []
or raw_conditions == {}
):
return None

if isinstance(raw_conditions, list):
Expand Down Expand Up @@ -490,8 +500,11 @@ def is_valid_field_name(value):
f"{stage_label} has invalid requires_manager_approval value; expected a boolean."
)
requires_manager_approval_flag = requires_manager_approval_raw is True
has_approval_group_source = any(
(entry.get("role") or "approval") == "approval" for entry in group_entries
)
has_approver_source = bool(
group_entries
has_approval_group_source
or requires_manager_approval_flag
or stage_data.get("assignee_form_field")
)
Expand Down Expand Up @@ -813,11 +826,15 @@ def _serialize_notification_rule(rule, stage_node_id=None):
"event": rule.event,
"conditions": rule.conditions,
"subject_template": rule.subject_template,
"body_template": rule.body_template,
"notify_submitter": rule.notify_submitter,
"email_field": rule.email_field,
"static_emails": rule.static_emails,
"cc_email_field": rule.cc_email_field,
"cc_static_emails": rule.cc_static_emails,
"notify_stage_assignees": rule.notify_stage_assignees,
"notify_stage_groups": rule.notify_stage_groups,
"use_triggering_stage": rule.use_triggering_stage,
"notify_groups": [
{"id": group.id, "name": group.name}
for group in sorted(rule.notify_groups.all(), key=lambda group: group.name)
Expand Down Expand Up @@ -2556,7 +2573,11 @@ def graph_action_ids(graph):
)

# ── Notification rules ───────────────────────────────────────────────
workflow.notification_rules.all().delete()
existing_notification_rules = {
rule.id: rule for rule in workflow.notification_rules.all()
}
kept_notification_rule_ids = set()

for rule_data in settings_data.get("notification_rules", []) or []:
stage = None
raw_stage_node_id = rule_data.get("stage_node_id")
Expand All @@ -2570,6 +2591,26 @@ def graph_action_ids(graph):
has_stage_id = stage_id is not None and stage_id != ""
explicit_stage_reference = has_stage_node_id or has_stage_id

raw_rule_id = rule_data.get("rule_id")
if raw_rule_id in ("", None):
rule_obj = None
else:
if isinstance(raw_rule_id, bool) or not isinstance(raw_rule_id, int | str):
raise ValidationError("Invalid notification rule identifier.")
rule_id_text = str(raw_rule_id).strip()
if not rule_id_text.isascii() or not rule_id_text.isdigit():
raise ValidationError("Invalid notification rule identifier.")
normalized_rule_id = int(rule_id_text)
if not 0 < normalized_rule_id <= 2**63 - 1:
raise ValidationError("Invalid notification rule identifier.")
rule_obj = existing_notification_rules.get(normalized_rule_id)
if rule_obj is None:
raise ValidationError(
"Notification rule does not belong to this workflow."
)
if normalized_rule_id in kept_notification_rule_ids:
raise ValidationError("Duplicate notification rule identifier.")

if has_stage_node_id:
if isinstance(stage_node_id, bool) or not isinstance(
stage_node_id, str | int
Expand Down Expand Up @@ -2624,22 +2665,43 @@ def graph_action_ids(graph):
if event not in supported_events:
raise ValidationError("Invalid notification event.")

rule = NotificationRule.objects.create(
workflow=workflow,
stage=stage,
event=event,
conditions=_normalize_trigger_conditions(rule_data.get("conditions")),
subject_template=rule_data.get("subject_template", ""),
notify_submitter=rule_data.get("notify_submitter", False),
email_field=rule_data.get("email_field", ""),
static_emails=rule_data.get("static_emails", ""),
notify_stage_assignees=rule_data.get("notify_stage_assignees", False),
notify_stage_groups=rule_data.get("notify_stage_groups", False),
rule_values = {
"stage": stage,
"event": event,
"conditions": _normalize_trigger_conditions(rule_data.get("conditions")),
"subject_template": rule_data.get("subject_template", ""),
"body_template": rule_data.get(
"body_template", rule_obj.body_template if rule_obj else ""
),
"notify_submitter": rule_data.get("notify_submitter", False),
"email_field": rule_data.get("email_field", ""),
"static_emails": rule_data.get("static_emails", ""),
"cc_email_field": rule_data.get(
"cc_email_field", rule_obj.cc_email_field if rule_obj else ""
),
"cc_static_emails": rule_data.get(
"cc_static_emails", rule_obj.cc_static_emails if rule_obj else ""
),
"notify_stage_assignees": rule_data.get("notify_stage_assignees", False),
"notify_stage_groups": rule_data.get("notify_stage_groups", False),
"use_triggering_stage": rule_data.get(
"use_triggering_stage",
rule_obj.use_triggering_stage if rule_obj else False,
),
}
if rule_obj is None:
rule = NotificationRule.objects.create(workflow=workflow, **rule_values)
else:
rule = rule_obj
for field_name, value in rule_values.items():
setattr(rule, field_name, value)
rule.save(update_fields=list(rule_values))
rule.notify_groups.set(
Group.objects.filter(id__in=normalized_group_ids).order_by("name")
)
if normalized_group_ids:
rule.notify_groups.set(
Group.objects.filter(id__in=normalized_group_ids).order_by("name")
)
kept_notification_rule_ids.add(rule.id)

workflow.notification_rules.exclude(id__in=kept_notification_rule_ids).delete()

# ── Post-submission actions (unchanged logic) ───────────────────────
existing_actions_by_id = {
Expand Down
125 changes: 125 additions & 0 deletions tests/test_builders.py
Original file line number Diff line number Diff line change
Expand Up @@ -968,9 +968,11 @@ def test_loads_notification_rules_into_workflow_settings(
stage=stage,
event="approval_request",
subject_template="Approval Needed: {form_name}",
body_template="<p>Custom body</p>",
notify_submitter=True,
email_field="manager_email",
static_emails="ops@example.com",
cc_static_emails="copy@example.com",
notify_stage_assignees=True,
notify_stage_groups=True,
conditions={
Expand All @@ -996,6 +998,8 @@ def test_loads_notification_rules_into_workflow_settings(
assert loaded_rule["stage_id"] == stage.id
assert loaded_rule["stage_node_id"]
assert loaded_rule["email_field"] == "manager_email"
assert loaded_rule["body_template"] == "<p>Custom body</p>"
assert loaded_rule["cc_static_emails"] == "copy@example.com"
assert loaded_rule["notify_stage_groups"] is True
assert {group["id"] for group in loaded_rule["notify_groups"]} == {
approval_group.id,
Expand Down Expand Up @@ -1321,6 +1325,17 @@ def test_rejects_unsupported_notification_event(self, form_definition):

assert not NotificationRule.objects.exists()

@pytest.mark.parametrize("conditions", [0, False])
def test_rejects_invalid_falsy_trigger_conditions(
self, form_definition, conditions
):
visual = self._make_visual(settings={"trigger_conditions": conditions})

with pytest.raises(ValidationError, match="Trigger conditions"):
convert_visual_to_workflow(visual, form_definition)

assert not form_definition.workflows.exists()

def test_rejects_duplicate_stage_ids_across_integer_and_string(
self, staged_workflow, form_definition
):
Expand Down Expand Up @@ -1583,6 +1598,99 @@ def test_saves_workflow_settings(self, form_with_fields):
],
}

def test_updates_notification_rule_without_replacing_identity(
self, form_definition, approval_group
):
workflow = WorkflowDefinition.objects.create(form_definition=form_definition)
rule = NotificationRule.objects.create(
workflow=workflow,
event="approval_request",
subject_template="Original",
body_template="Custom body",
cc_static_emails="copy@example.com",
use_triggering_stage=True,
)
rule.notify_groups.add(approval_group)
removed_rule = NotificationRule.objects.create(
workflow=workflow, event="workflow_approved"
)
visual = self._make_visual(
settings={
"notification_rules": [
{
"rule_id": str(rule.id),
"event": "approval_request",
"subject_template": "Updated",
"static_emails": "team@example.com",
}
]
}
)

convert_visual_to_workflow(visual, form_definition, workflow=workflow)

rule.refresh_from_db()
assert rule.subject_template == "Updated"
assert rule.body_template == "Custom body"
assert rule.cc_static_emails == "copy@example.com"
assert rule.use_triggering_stage is True
assert not rule.notify_groups.exists()
assert list(workflow.notification_rules.values_list("id", flat=True)) == [
rule.id
]
assert not NotificationRule.objects.filter(pk=removed_rule.id).exists()

def test_rejects_notification_rule_from_another_workflow(self, form_definition):
workflow = WorkflowDefinition.objects.create(form_definition=form_definition)
other = WorkflowDefinition.objects.create(form_definition=form_definition)
foreign_rule = NotificationRule.objects.create(
workflow=other, event="approval_request"
)
visual = self._make_visual(
settings={
"notification_rules": [
{
"rule_id": foreign_rule.id,
"event": "approval_request",
"static_emails": "team@example.com",
}
]
}
)

with pytest.raises(ValidationError, match="does not belong"):
convert_visual_to_workflow(visual, form_definition, workflow=workflow)

assert not workflow.notification_rules.exists()
assert other.notification_rules.filter(pk=foreign_rule.id).exists()

def test_rejects_duplicate_notification_rule_id(self, form_definition):
workflow = WorkflowDefinition.objects.create(form_definition=form_definition)
rule = NotificationRule.objects.create(
workflow=workflow, event="approval_request"
)
visual = self._make_visual(
settings={
"notification_rules": [
{
"rule_id": rule.id,
"event": "approval_request",
"static_emails": "team@example.com",
},
{
"rule_id": rule.id,
"event": "approval_request",
"static_emails": "team@example.com",
},
]
}
)

with pytest.raises(ValidationError, match="Duplicate notification rule"):
convert_visual_to_workflow(visual, form_definition, workflow=workflow)

assert workflow.notification_rules.get().id == rule.id

def test_updates_specific_workflow_when_passed(self, form_definition):
first = WorkflowDefinition.objects.create(
form_definition=form_definition,
Expand Down Expand Up @@ -1932,6 +2040,7 @@ def test_accepts_supported_stage_group_roles(
stages=[
{
"name": "Review",
"requires_manager_approval": role != "approval",
"approval_groups": [{"id": approval_group.id, "role": role}],
}
]
Expand All @@ -1941,6 +2050,22 @@ def test_accepts_supported_stage_group_roles(

assert workflow.stages.get().stageapprovalgroup_set.get().role == role

@pytest.mark.parametrize("role", ["validation", "reassignment"])
def test_rejects_stage_with_only_nonapproval_group(
self, form_definition, approval_group, role
):
visual = self._make_visual(
stages=[
{
"name": "Review",
"approval_groups": [{"id": approval_group.id, "role": role}],
}
]
)

with pytest.raises(ValidationError, match="approver source"):
convert_visual_to_workflow(visual, form_definition)

def test_numeric_string_stage_group_id_is_persisted_as_integer(
self, form_definition, approval_group
):
Expand Down
Loading