feat: support for sticky params and intent operations

[jordanl17]

Description

This is a resurrection of a previous PR raised here. This PR was reverted since it clashed with similar behaviours in presentation.

Warning

This cannot be merged yet, until a way forward with updating the @latest for presentation is decided

Adds ability to define sticky search params which will be retained state-fully in the URL throughout navigation

What to review

Primarily packages/sanity/src/router/RouterProvider.tsx is where the handling and persistence of the params is handled

Testing

Notes for release

N/A

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
page-building-studio	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 17, 2025 6:06pm
performance-studio	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 17, 2025 6:06pm
test-studio	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 17, 2025 6:06pm

2 Skipped Deployments

Name	Status	Preview	Comments	Updated (UTC)
studio-workshop	⬜️ Ignored (Inspect)	Visit Preview		Jan 17, 2025 6:06pm
test-next-studio	⬜️ Ignored (Inspect)			Jan 17, 2025 6:06pm

[github-actions]

No changes to documentation

[github-actions]

Component Testing Report Updated Jan 17, 2025 6:12 PM (UTC)

❌ Failed Tests (2) -- expand for details

File	Status	Duration	Passed	Skipped	Failed
comments/CommentInput.spec.tsx	✅ Passed (Inspect)	1m 14s	15	0	0
formBuilder/ArrayInput.spec.tsx	✅ Passed (Inspect)	12s	3	0	0
formBuilder/inputs/PortableText/Annotations.spec.tsx	❌ Failed (Inspect)	2m 1s	4	0	2
formBuilder/inputs/PortableText/copyPaste/CopyPaste.spec.tsx	✅ Passed (Inspect)	51s	11	7	0
formBuilder/inputs/PortableText/copyPaste/CopyPasteFields.spec.tsx	✅ Passed (Inspect)	0s	0	12	0
formBuilder/inputs/PortableText/Decorators.spec.tsx	✅ Passed (Inspect)	25s	6	0	0
formBuilder/inputs/PortableText/DisableFocusAndUnset.spec.tsx	✅ Passed (Inspect)	14s	3	0	0
formBuilder/inputs/PortableText/DragAndDrop.spec.tsx	✅ Passed (Inspect)	26s	6	0	0
formBuilder/inputs/PortableText/FocusTracking.spec.tsx	✅ Passed (Inspect)	1m 6s	15	0	0
formBuilder/inputs/PortableText/Input.spec.tsx	✅ Passed (Inspect)	1m 40s	21	0	0
formBuilder/inputs/PortableText/ObjectBlock.spec.tsx	✅ Passed (Inspect)	2m 1s	21	0	0
formBuilder/inputs/PortableText/PresenceCursors.spec.tsx	✅ Passed (Inspect)	12s	3	9	0
formBuilder/inputs/PortableText/Styles.spec.tsx	✅ Passed (Inspect)	26s	6	0	0
formBuilder/inputs/PortableText/Toolbar.spec.tsx	✅ Passed (Inspect)	1m 42s	21	0	0
formBuilder/tree-editing/TreeEditing.spec.tsx	✅ Passed (Inspect)	0s	0	3	0
formBuilder/tree-editing/TreeEditingNestedObjects.spec.tsx	✅ Passed (Inspect)	0s	0	3	0

[github-actions]

⚡️ Editor Performance Report

Updated Fri, 17 Jan 2025 18:10:24 GMT

Benchmark	reference latency of sanity@latest	experiment latency of this branch	Δ (%) latency difference
article (title)	25.0 efps (40ms)	25.0 efps (40ms)	+0ms (-/-%)	✅
article (body)	77.5 efps (13ms)	72.5 efps (14ms)	+1ms (-/-%)	✅
article (string inside object)	26.3 efps (38ms)	26.7 efps (38ms)	-1ms (-1.3%)	✅
article (string inside array)	23.3 efps (43ms)	22.2 efps (45ms)	+2ms (+4.7%)	✅
recipe (name)	50.0 efps (20ms)	50.0 efps (20ms)	+0ms (-/-%)	✅
recipe (description)	55.6 efps (18ms)	58.8 efps (17ms)	-1ms (-5.6%)	✅
recipe (instructions)	99.9+ efps (6ms)	99.9+ efps (5ms)	-1ms (-/-%)	✅
synthetic (title)	18.5 efps (54ms)	18.3 efps (55ms)	+1ms (+0.9%)	✅
synthetic (string inside object)	19.6 efps (51ms)	18.9 efps (53ms)	+2ms (+3.9%)	✅

efps — editor "frames per second". The number of updates assumed to be possible within a second.

Derived from input latency. efps = 1000 / input_latency

Detailed information

🏠 Reference result

The performance result of sanity@latest

Benchmark	latency	p75	p90	p99	blocking time	test duration
article (title)	40ms	50ms	67ms	491ms	857ms	10.2s
article (body)	13ms	15ms	18ms	71ms	56ms	4.6s
article (string inside object)	38ms	40ms	44ms	78ms	213ms	6.7s
article (string inside array)	43ms	45ms	52ms	66ms	281ms	7.0s
recipe (name)	20ms	21ms	23ms	37ms	0ms	7.1s
recipe (description)	18ms	19ms	21ms	37ms	0ms	4.4s
recipe (instructions)	6ms	7ms	8ms	17ms	0ms	3.1s
synthetic (title)	54ms	58ms	63ms	251ms	776ms	13.9s
synthetic (string inside object)	51ms	54ms	61ms	294ms	221ms	7.9s

🧪 Experiment result

The performance result of this branch

Benchmark	latency	p75	p90	p99	blocking time	test duration
article (title)	40ms	45ms	63ms	358ms	756ms	10.0s
article (body)	14ms	15ms	17ms	64ms	190ms	5.1s
article (string inside object)	38ms	41ms	45ms	157ms	155ms	6.7s
article (string inside array)	45ms	47ms	50ms	161ms	223ms	7.1s
recipe (name)	20ms	21ms	24ms	43ms	0ms	6.9s
recipe (description)	17ms	19ms	24ms	38ms	0ms	4.6s
recipe (instructions)	5ms	6ms	8ms	9ms	0ms	3.2s
synthetic (title)	55ms	58ms	65ms	160ms	722ms	12.8s
synthetic (string inside object)	53ms	58ms	63ms	457ms	1214ms	8.5s

📚 Glossary

column definitions

• benchmark — the name of the test, e.g. "article", followed by the label of the field being measured, e.g. "(title)".
• latency — the time between when a key was pressed and when it was rendered. derived from a set of samples. the median (p50) is shown to show the most common latency.
• p75 — the 75th percentile of the input latency in the test run. 75% of the sampled inputs in this benchmark were processed faster than this value. this provides insight into the upper range of typical performance.
• p90 — the 90th percentile of the input latency in the test run. 90% of the sampled inputs were faster than this. this metric helps identify slower interactions that occurred less frequently during the benchmark.
• p99 — the 99th percentile of the input latency in the test run. only 1% of sampled inputs were slower than this. this represents the worst-case scenarios encountered during the benchmark, useful for identifying potential performance outliers.
• blocking time — the total time during which the main thread was blocked, preventing user input and UI updates. this metric helps identify performance bottlenecks that may cause the interface to feel unresponsive.
• test duration — how long the test run took to complete.