ref(forms): Migrate highlights settings by priscilawebdev · Pull Request #115778 · getsentry/sentry

priscilawebdev · 2026-05-19T09:13:29Z

Replace the legacy highlights JsonForm with AutoSaveForm text areas for tags and context.

This keeps the existing autosave behavior, preserves the project cache updates,
and tightens the tests around the autosave requests.

closes https://linear.app/getsentry/issue/DE-1251/migrate-eventshighlightshighlightssettingsformtsx-from-legacy-form

linear-code · 2026-05-19T09:13:33Z

DE-1251

github-actions · 2026-05-19T09:16:52Z

📊 Type Coverage Diff

Metric	Before	After	Delta
Coverage	93.59%	93.59%	±0%
Typed	135,603	135,611	🟢 +8
Untyped	9,292	9,292	±0

🔍 3 new type safety issues introduced

Type assertions (as) (3 new)

File	Line	Detail
`static/app/components/core/form/autoSaveForm.tsx`	208	`as never` — `{ [name]: {message: t('Failed to save')}, } as never`
`static/app/components/core/form/autoSaveForm.tsx`	218	`as never` — `{[name]: true} as never`
`static/app/components/core/form/autoSaveForm.tsx`	224	`as Record<

    TFieldName,
    SchemaOutput<TSchema>[TFieldName]
  >` — `parsedValue.data as Record< TFieldName, SchemaOutput<TSchema>[TFieldName] >` |

This is informational only and does not block the PR.

TkDodo · 2026-05-20T08:54:46Z

+    return {};
+  }
+
+  return JSON.parse(highlightContext) as NonNullable<DetailedProject['highlightContext']>;


could we re-use the schema here instead of doing another manual JSON.parse ?

Agreed in principle ....and I tried this. To re-use the schema we need AutoSaveForm to apply the transform on submit (so mutationFn receives the parsed output instead of the raw form value). This required a lot of changes in other files (PR is updated)... What is your take on this?

TkDodo · 2026-05-20T13:03:52Z

lots of unrelated formatting changes here

yes... I was expecting these to be auto fixed in this PR 😅

TkDodo · 2026-05-20T13:04:48Z

+`AutoSaveForm` keeps field state typed as the schema input, but submits the schema's parsed output to the mutation. This matches `useScrapsForm` and lets you use transforms or narrower output types without extra parsing in `mutationFn`.
+
+> [!WARNING]
+> The schema is applied to the form value on submit, so unknown keys are stripped per Zod's default behavior. For map-like fields with arbitrary keys, use `z.record(z.string(), …)` — not `z.object({})`, which declares zero keys and will strip everything at submit time.


we can also use passthrough to allow arbitrary values

passthrough is deprecated, so I am using looseObject({}) instead 710fe6e

Restore single quotes, brace spacing, and arrow-param style to match the rest of the file; keep only the new "Transformed Submit Values" section as the intended change.

Switch the choice_mapper schema in backendJsonFormAdapter to z.looseObject({}) so arbitrary keys pass through, matching the modern Zod 4 idiom (replaces deprecated .passthrough()). Mention z.looseObject alongside z.record in the AutoSaveForm doc warning.

…ings-form-migration

Replace the legacy highlights JsonForm with AutoSaveForm text areas for tags and context. This keeps the existing autosave behavior, preserves the project cache updates, and tightens the tests around the autosave requests. closes https://linear.app/getsentry/issue/DE-1251/migrate-eventshighlightshighlightssettingsformtsx-from-legacy-form

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

vercel Bot deployed to Preview May 19, 2026 09:15 View deployment

vercel Bot deployed to Preview May 19, 2026 11:19 View deployment

priscilawebdev force-pushed the priscilawebdev/ref/de-1251-highlights-settings-form-migration branch from 8438cf1 to e3f74f3 Compare May 19, 2026 11:20

vercel Bot deployed to Preview May 19, 2026 11:21 View deployment

priscilawebdev force-pushed the priscilawebdev/ref/de-1251-highlights-settings-form-migration branch from e3f74f3 to 0021112 Compare May 19, 2026 11:22

vercel Bot deployed to Preview May 19, 2026 11:24 View deployment

priscilawebdev force-pushed the priscilawebdev/ref/de-1251-highlights-settings-form-migration branch from 0021112 to ea42b1f Compare May 19, 2026 11:27

vercel Bot deployed to Preview May 19, 2026 11:29 View deployment

priscilawebdev force-pushed the priscilawebdev/ref/de-1251-highlights-settings-form-migration branch 2 times, most recently from 0bd5d8d to 26c9707 Compare May 19, 2026 11:31

vercel Bot deployed to Preview May 19, 2026 11:33 View deployment

priscilawebdev force-pushed the priscilawebdev/ref/de-1251-highlights-settings-form-migration branch 3 times, most recently from a631887 to fb3d394 Compare May 19, 2026 11:36

vercel Bot deployed to Preview May 19, 2026 11:38 View deployment

vercel Bot deployed to Preview May 20, 2026 07:49 View deployment

vercel Bot deployed to Preview May 20, 2026 07:51 View deployment

vercel Bot deployed to Preview May 20, 2026 08:01 View deployment

vercel Bot deployed to Preview May 20, 2026 08:05 View deployment

vercel Bot deployed to Preview May 20, 2026 08:10 View deployment

priscilawebdev marked this pull request as ready for review May 20, 2026 08:12

priscilawebdev requested a review from a team as a code owner May 20, 2026 08:12

priscilawebdev requested a review from a team May 20, 2026 08:12

TkDodo reviewed May 20, 2026

View reviewed changes

vercel Bot deployed to Preview May 20, 2026 09:55 View deployment

vercel Bot deployed to Preview May 20, 2026 10:01 View deployment

vercel Bot deployed to Preview May 20, 2026 10:09 View deployment

vercel Bot deployed to Preview May 20, 2026 11:19 View deployment

vercel Bot deployed to Preview May 20, 2026 11:24 View deployment

vercel Bot deployed to Preview May 20, 2026 11:46 View deployment

priscilawebdev force-pushed the priscilawebdev/ref/de-1251-highlights-settings-form-migration branch from 753c6de to ecc4f1f Compare May 20, 2026 11:52

vercel Bot deployed to Preview May 20, 2026 11:54 View deployment

ref(forms): Migrate highlights settings

cc24014

priscilawebdev force-pushed the priscilawebdev/ref/de-1251-highlights-settings-form-migration branch from ecc4f1f to cc24014 Compare May 20, 2026 11:55

vercel Bot deployed to Preview May 20, 2026 11:56 View deployment

vercel Bot deployed to Preview May 20, 2026 12:02 View deployment

vercel Bot deployed to Preview May 20, 2026 12:06 View deployment

priscilawebdev force-pushed the priscilawebdev/ref/de-1251-highlights-settings-form-migration branch from bf0dbd7 to 2ac4318 Compare May 20, 2026 12:19

priscilawebdev added 2 commits May 20, 2026 14:20

ref(forms): submit parsed autosave values

f7c6b8c

ref(forms): parse highlights context via schema transform

249df1e

priscilawebdev force-pushed the priscilawebdev/ref/de-1251-highlights-settings-form-migration branch from 2ac4318 to 249df1e Compare May 20, 2026 12:21

vercel Bot deployed to Preview May 20, 2026 12:22 View deployment

TkDodo approved these changes May 20, 2026

View reviewed changes

ref(forms): revert formatter changes in autoSaveForm.mdx

4db2943

Restore single quotes, brace spacing, and arrow-param style to match the rest of the file; keep only the new "Transformed Submit Values" section as the intended change.

vercel Bot deployed to Preview May 21, 2026 05:53 View deployment

ref(forms): mention passthrough for arbitrary keys in autosave docs

9579857

vercel Bot deployed to Preview May 21, 2026 05:55 View deployment

vercel Bot deployed to Preview May 21, 2026 06:00 View deployment

ref(forms): restore type-flow test in autoSaveForm.spec

e7cf6ed

vercel Bot deployed to Preview May 21, 2026 06:03 View deployment

Merge branch 'master' into priscilawebdev/ref/de-1251-highlights-sett…

dd29f65

…ings-form-migration

priscilawebdev enabled auto-merge (squash) May 21, 2026 06:04

vercel Bot deployed to Preview May 21, 2026 06:05 View deployment

priscilawebdev merged commit cf93ddb into master May 21, 2026
71 checks passed

priscilawebdev deleted the priscilawebdev/ref/de-1251-highlights-settings-form-migration branch May 21, 2026 06:11

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

ref(forms): Migrate highlights settings#115778

ref(forms): Migrate highlights settings#115778
priscilawebdev merged 8 commits into
masterfrom
priscilawebdev/ref/de-1251-highlights-settings-form-migration

priscilawebdev commented May 19, 2026 •

edited

Loading

Uh oh!

linear-code Bot commented May 19, 2026

Uh oh!

github-actions Bot commented May 19, 2026 •

edited

Loading

Uh oh!

TkDodo May 20, 2026

Uh oh!

priscilawebdev May 20, 2026

Uh oh!

Uh oh!

TkDodo May 20, 2026

Uh oh!

priscilawebdev May 21, 2026

Uh oh!

priscilawebdev May 21, 2026

Uh oh!

TkDodo May 20, 2026

Uh oh!

priscilawebdev May 21, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

priscilawebdev commented May 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

linear-code Bot commented May 19, 2026

Uh oh!

github-actions Bot commented May 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

📊 Type Coverage Diff

Uh oh!

TkDodo May 20, 2026

Choose a reason for hiding this comment

Uh oh!

priscilawebdev May 20, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

TkDodo May 20, 2026

Choose a reason for hiding this comment

Uh oh!

priscilawebdev May 21, 2026

Choose a reason for hiding this comment

Uh oh!

priscilawebdev May 21, 2026

Choose a reason for hiding this comment

Uh oh!

TkDodo May 20, 2026

Choose a reason for hiding this comment

Uh oh!

priscilawebdev May 21, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

priscilawebdev commented May 19, 2026 •

edited

Loading

github-actions Bot commented May 19, 2026 •

edited

Loading