fix(workflow_engine): Sanitize corrupted dynamic_form_fields choice labels by malwilley · Pull Request #115855 · getsentry/sentry

malwilley · 2026-05-19T22:45:56Z

Fixes https://linear.app/getsentry/issue/ISWF-2670/alerts-form-crashes-when-opening-ticket-action-details-modal-in-some

A legacy code path (in the old AbstractExternalIssueForm) could persist React element labels (like <QuestionTooltip />) into choice tuples stored in Action.data.dynamic_form_fields. After JSON round-tripping, these become plain {key, ref, props} objects which, now with the new form components, crash on render. We never should have been saving these react components to the database, so this PR aims to fix that bad data.

This is a post-deploy migration which goes over all ticketing actions and fixes any which have objects saved as the label.

See here for a full list of bad actions in the DB: https://redash.getsentry.net/queries/11274/source

The serialized react elements all look like this, so we can easily extract the actual label:

{
        "key": None,
        "ref": None,
        "props": {
            "children": [
                {...},
                " ",
                "This is the actual label text",
            ]
        }
    }

linear-code · 2026-05-19T22:45:59Z

ISWF-2670

…abels A legacy code path (ensureCurrentOption in AbstractExternalIssueForm) could persist React element labels into choice tuples stored in Action.data. After JSON round-tripping these become {key, ref, props} objects that crash on render. Add a post-deployment data migration that iterates ticket-type actions, extracts visible text from the serialized React elements, and replaces the corrupted labels with plain strings.

github-actions · 2026-05-19T22:59:31Z

This PR has a migration; here is the generated SQL for src/sentry/workflow_engine/migrations/0114_sanitize_dynamic_form_field_choices.py

for 0114_sanitize_dynamic_form_field_choices in workflow_engine

--
-- Raw Python operation
--
-- THIS OPERATION CANNOT BE WRITTEN AS SQL

saponifi3d · 2026-05-19T22:56:03Z

+                    row_changed = True
+
+        if row_changed:
+            action.save(update_fields=["data"])


do we need to modify the json schema for the data field?

The schema only defines dynamic_form_fields as an array of objects:

sentry/src/sentry/notifications/notification_action/action_handler_registry/base.py

Lines 53 to 58 in 2192d98

"dynamic_form_fields": {

"type": "array",

"description": "Dynamic form fields from customer configuration",

"items": {"type": "object"},

"default": [],

},

saponifi3d · 2026-05-19T22:59:28Z

+                "dynamic_form_fields": [
+                    {
+                        "name": "assignee",
+                        "choices": [["user-1", "Alice"], ["user-2", "Bob"]],
+                    }
+                ],


is this data replicated on each action? 🤔 i wonder if it'd be better to have it normalized and shared. probably too big of a lift for now, but food for thought.

Yeah this is probably something we could do? I'm not too well versed on dynamic_form_fields

sg - can think of it as a follow-up / cleanup thing if we can get to it.

saponifi3d · 2026-05-19T23:05:25Z

+    for action in RangeQuerySetWrapper(Action.objects.filter(type__in=TICKET_ACTION_TYPES)):
+        count += 1


Suggested change

for action in RangeQuerySetWrapper(Action.objects.filter(type__in=TICKET_ACTION_TYPES)):

count += 1

for count, action in enumerate(RangeQuerySetWrapper(Action.objects.filter(type__in=TICKET_ACTION_TYPES))):

i'm not sure if enumerate does something to RangeQuerySetWrapper or not, but you can use enumerate like this to also get the count, so you don't have to track it.

cursor

Cursor Bugbot has reviewed your changes and found 1 potential issue.

^{❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.}

^{Reviewed by Cursor Bugbot for commit 2192d98. Configure here.}

saponifi3d

lgtm

…abels (#115855) A legacy code path (in the old `AbstractExternalIssueForm`) could persist React element labels (like `<QuestionTooltip />`) into choice tuples stored in `Action.data.dynamic_form_fields`. After JSON round-tripping, these become plain `{key, ref, props}` objects which, now with the new form components, crash on render. We never should have been saving these react components to the database, so this PR aims to fix that bad data. This is a post-deploy migration which goes over all ticketing actions and fixes any which have objects saved as the label. See here for a full list of bad actions in the DB: https://redash.getsentry.net/queries/11274/source The serialized react elements all look like this, so we can easily extract the actual label: ``` { "key": None, "ref": None, "props": { "children": [ {...}, " ", "This is the actual label text", ] } } ```

One assert per test gives clearer failure output than the single multi-block test_migration. Also drops a stale `self.apps_before` reference that would have AttributeError'd if the class were ever unskipped — use the live Rule model in setup, matching #115855's style. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>

malwilley requested review from a team as code owners May 19, 2026 22:45

github-actions Bot added the Scope: Backend Automatically applied to PRs that change backend components label May 19, 2026

cursor Bot reviewed May 19, 2026

View reviewed changes

Comment thread src/sentry/workflow_engine/migrations/0114_sanitize_dynamic_form_field_choices.py

malwilley force-pushed the malwilley/fix-dynamic-form-labels branch from fab5775 to ad837f8 Compare May 19, 2026 22:51

cursor Bot reviewed May 19, 2026

View reviewed changes

Comment thread src/sentry/workflow_engine/migrations/0114_sanitize_dynamic_form_field_choices.py Outdated

saponifi3d reviewed May 19, 2026

View reviewed changes

Fix instance whewre props does not have children

2192d98

cursor Bot reviewed May 19, 2026

View reviewed changes

Comment thread src/sentry/workflow_engine/migrations/0114_sanitize_dynamic_form_field_choices.py Outdated

Simplify logic and respond to comments

f97958a

saponifi3d approved these changes May 20, 2026

View reviewed changes

Merge branch 'master' into malwilley/fix-dynamic-form-labels

7572500

vercel Bot deployed to Preview May 20, 2026 21:40 View deployment

Merge branch 'master' into malwilley/fix-dynamic-form-labels

e5692f9

vercel Bot deployed to Preview May 21, 2026 16:18 View deployment

malwilley enabled auto-merge (squash) May 21, 2026 16:20

malwilley merged commit f5026e9 into master May 21, 2026
83 of 84 checks passed

malwilley deleted the malwilley/fix-dynamic-form-labels branch May 21, 2026 16:34

priscilawebdev mentioned this pull request May 22, 2026

fix(rules): Sanitize legacy Rule dynamic_form_fields choice labels #116081

Closed

sentry-release-bot Bot mentioned this pull request May 27, 2026

publish: getsentry/sentry@26.5.1 getsentry/publish#8288

Closed

3 tasks

	"dynamic_form_fields": {
	"type": "array",
	"description": "Dynamic form fields from customer configuration",
	"items": {"type": "object"},
	"default": [],
	},

		for action in RangeQuerySetWrapper(Action.objects.filter(type__in=TICKET_ACTION_TYPES)):
		count += 1

	for action in RangeQuerySetWrapper(Action.objects.filter(type__in=TICKET_ACTION_TYPES)):
	count += 1
	for count, action in enumerate(RangeQuerySetWrapper(Action.objects.filter(type__in=TICKET_ACTION_TYPES))):

Uh oh!

Conversation

malwilley commented May 19, 2026

Uh oh!

linear-code Bot commented May 19, 2026

Uh oh!

Uh oh!

Uh oh!

github-actions Bot commented May 19, 2026

Uh oh!

saponifi3d May 19, 2026

Choose a reason for hiding this comment

Uh oh!

malwilley May 19, 2026

Choose a reason for hiding this comment

Uh oh!

saponifi3d May 19, 2026

Choose a reason for hiding this comment

Uh oh!

malwilley May 19, 2026

Choose a reason for hiding this comment

Uh oh!

saponifi3d May 20, 2026

Choose a reason for hiding this comment

Uh oh!

saponifi3d May 19, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

cursor Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

saponifi3d left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants