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 15, 2025 7:02pm
performance-studio	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 15, 2025 7:02pm
test-studio	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 15, 2025 7:02pm

2 Skipped Deployments

Name	Status	Preview	Comments	Updated (UTC)
studio-workshop	⬜️ Ignored (Inspect)	Visit Preview		Jan 15, 2025 7:02pm
test-next-studio	⬜️ Ignored (Inspect)			Jan 15, 2025 7:02pm

[github-actions]

No changes to documentation

[github-actions]

Component Testing Report Updated Jan 15, 2025 7:06 PM (UTC)

❌ Failed Tests (1) -- expand for details

File	Status	Duration	Passed	Skipped	Failed
comments/CommentInput.spec.tsx	✅ Passed (Inspect)	1m 30s	15	0	0
formBuilder/ArrayInput.spec.tsx	✅ Passed (Inspect)	12s	3	0	0
formBuilder/inputs/PortableText/Annotations.spec.tsx	❌ Failed (Inspect)	1m 19s	5	0	1
formBuilder/inputs/PortableText/copyPaste/CopyPaste.spec.tsx	✅ Passed (Inspect)	50s	11	7	0
formBuilder/inputs/PortableText/copyPaste/CopyPasteFields.spec.tsx	✅ Passed (Inspect)	0s	0	12	0
formBuilder/inputs/PortableText/Decorators.spec.tsx	✅ Passed (Inspect)	26s	6	0	0
formBuilder/inputs/PortableText/DisableFocusAndUnset.spec.tsx	✅ Passed (Inspect)	14s	3	0	0
formBuilder/inputs/PortableText/DragAndDrop.spec.tsx	✅ Passed (Inspect)	27s	6	0	0
formBuilder/inputs/PortableText/FocusTracking.spec.tsx	✅ Passed (Inspect)	1m 7s	15	0	0
formBuilder/inputs/PortableText/Input.spec.tsx	✅ Passed (Inspect)	1m 28s	21	0	0
formBuilder/inputs/PortableText/ObjectBlock.spec.tsx	✅ Passed (Inspect)	1m 41s	18	0	0
formBuilder/inputs/PortableText/PresenceCursors.spec.tsx	✅ Passed (Inspect)	13s	3	9	0
formBuilder/inputs/PortableText/Styles.spec.tsx	✅ Passed (Inspect)	26s	6	0	0
formBuilder/inputs/PortableText/Toolbar.spec.tsx	✅ Passed (Inspect)	1m 44s	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 Wed, 15 Jan 2025 19:07:27 GMT

Benchmark	reference latency of sanity@latest	experiment latency of this branch	Δ (%) latency difference
article (title)	25.0 efps (40ms)	23.8 efps (42ms)	+2ms (+5.0%)	✅
article (body)	78.1 efps (13ms)	72.5 efps (14ms)	+1ms (-/-%)	✅
article (string inside object)	25.6 efps (39ms)	25.0 efps (40ms)	+1ms (+2.6%)	✅
article (string inside array)	22.5 efps (45ms)	22.2 efps (45ms)	+1ms (+1.1%)	✅
recipe (name)	50.0 efps (20ms)	52.6 efps (19ms)	-1ms (-5.0%)	✅
recipe (description)	58.8 efps (17ms)	58.8 efps (17ms)	+0ms (-/-%)	✅
recipe (instructions)	99.9+ efps (5ms)	99.9+ efps (6ms)	+1ms (-/-%)	✅
synthetic (title)	19.2 efps (52ms)	19.6 efps (51ms)	-1ms (-1.9%)	✅
synthetic (string inside object)	18.9 efps (53ms)	20.8 efps (48ms)	-5ms (-9.4%)	✅

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	46ms	71ms	504ms	843ms	10.7s
article (body)	13ms	15ms	19ms	78ms	99ms	5.0s
article (string inside object)	39ms	46ms	66ms	196ms	367ms	7.3s
article (string inside array)	45ms	47ms	51ms	167ms	202ms	6.9s
recipe (name)	20ms	21ms	22ms	35ms	0ms	7.1s
recipe (description)	17ms	19ms	21ms	35ms	0ms	4.5s
recipe (instructions)	5ms	6ms	7ms	8ms	0ms	3.0s
synthetic (title)	52ms	54ms	56ms	370ms	817ms	13.4s
synthetic (string inside object)	53ms	57ms	62ms	556ms	1325ms	8.7s

🧪 Experiment result

The performance result of this branch

Benchmark	latency	p75	p90	p99	blocking time	test duration
article (title)	42ms	58ms	71ms	473ms	769ms	10.7s
article (body)	14ms	16ms	17ms	205ms	266ms	5.2s
article (string inside object)	40ms	42ms	50ms	118ms	164ms	7.1s
article (string inside array)	45ms	48ms	57ms	334ms	364ms	7.6s
recipe (name)	19ms	21ms	24ms	45ms	0ms	7.2s
recipe (description)	17ms	18ms	19ms	29ms	0ms	4.3s
recipe (instructions)	6ms	7ms	8ms	9ms	0ms	3.3s
synthetic (title)	51ms	53ms	62ms	101ms	407ms	12.4s
synthetic (string inside object)	48ms	52ms	57ms	129ms	893ms	7.8s

📚 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.