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.

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

Note

There are currently no sticky param keys. These will be added with content releases. The perspective param key used by presentation is not sticky, until content releases makes it so

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

2 Skipped Deployments

Name	Status	Preview	Comments	Updated (UTC)
studio-workshop	⬜️ Ignored (Inspect)	Visit Preview		Jan 23, 2025 5:14pm
test-next-studio	⬜️ Ignored (Inspect)			Jan 23, 2025 5:14pm

[github-actions]

No changes to documentation

[github-actions]

Component Testing Report Updated Jan 23, 2025 5:17 PM (UTC)

❌ Failed Tests (1) -- 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)	1m 21s	5	0	1
formBuilder/inputs/PortableText/copyPaste/CopyPaste.spec.tsx	✅ Passed (Inspect)	52s	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 8s	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 5s	21	0	0
formBuilder/inputs/PortableText/PresenceCursors.spec.tsx	✅ Passed (Inspect)	13s	3	9	0
formBuilder/inputs/PortableText/Styles.spec.tsx	✅ Passed (Inspect)	27s	6	0	0
formBuilder/inputs/PortableText/Toolbar.spec.tsx	✅ Passed (Inspect)	1m 46s	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 Thu, 23 Jan 2025 17:18:49 GMT

Benchmark	reference latency of sanity@latest	experiment latency of this branch	Δ (%) latency difference
article (title)	23.8 efps (42ms)	25.6 efps (39ms)	-3ms (-7.1%)	✅
article (body)	78.1 efps (13ms)	72.5 efps (14ms)	+1ms (-/-%)	✅
article (string inside object)	27.8 efps (36ms)	27.0 efps (37ms)	+1ms (+2.8%)	✅
article (string inside array)	23.3 efps (43ms)	23.3 efps (43ms)	+0ms (-/-%)	✅
recipe (name)	47.6 efps (21ms)	47.6 efps (21ms)	+0ms (-/-%)	✅
recipe (description)	52.6 efps (19ms)	50.0 efps (20ms)	+1ms (+5.3%)	✅
recipe (instructions)	99.9+ efps (6ms)	99.9+ efps (6ms)	+0ms (-/-%)	✅
synthetic (title)	18.9 efps (53ms)	19.2 efps (52ms)	-1ms (-1.9%)	✅
synthetic (string inside object)	19.6 efps (51ms)	18.7 efps (54ms)	+3ms (+4.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)	42ms	47ms	62ms	398ms	217ms	10.9s
article (body)	13ms	15ms	16ms	27ms	69ms	4.6s
article (string inside object)	36ms	38ms	42ms	198ms	186ms	6.4s
article (string inside array)	43ms	46ms	48ms	189ms	239ms	7.0s
recipe (name)	21ms	23ms	35ms	46ms	12ms	6.9s
recipe (description)	19ms	20ms	21ms	41ms	0ms	4.5s
recipe (instructions)	6ms	7ms	9ms	10ms	0ms	3.2s
synthetic (title)	53ms	55ms	62ms	93ms	599ms	12.2s
synthetic (string inside object)	51ms	54ms	60ms	236ms	438ms	7.8s

🧪 Experiment result

The performance result of this branch

Benchmark	latency	p75	p90	p99	blocking time	test duration
article (title)	39ms	45ms	63ms	485ms	739ms	10.5s
article (body)	14ms	16ms	29ms	100ms	211ms	5.0s
article (string inside object)	37ms	39ms	44ms	80ms	224ms	6.5s
article (string inside array)	43ms	46ms	51ms	156ms	197ms	7.0s
recipe (name)	21ms	23ms	30ms	46ms	3ms	7.0s
recipe (description)	20ms	21ms	22ms	36ms	0ms	4.6s
recipe (instructions)	6ms	7ms	9ms	18ms	0ms	3.2s
synthetic (title)	52ms	54ms	58ms	268ms	784ms	12.0s
synthetic (string inside object)	54ms	56ms	67ms	270ms	749ms	8.0s

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

[juice49]

This is great!