fix(migrate): always use raw perspective for migrations

[bjoerge]

Description

perspective=raw is currently default for all current API versions, but that might not be true in for all future API versions.

For migrations in particular, perspective=raw is the most sensible default (and currently what's being used), so this PR explicitly sets perspective=raw when fetching documents for migration.

Note: If there's a compelling use case for having user-provided perspectives, we can always consider adding support for that that later, but this change ensures that perspective=raw is always used, no matter what the default is backend side.

What to review

• Does it makes sense?

Testing

unit test included

Notes for release

n/a - not visible to end users

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

2 Skipped Deployments

Name	Status	Preview	Comments	Updated (UTC)
studio-workshop	⬜️ Ignored (Inspect)			Jan 31, 2025 2:39pm
test-next-studio	⬜️ Ignored (Inspect)			Jan 31, 2025 2:39pm

[github-actions]

No changes to documentation

[github-actions]

Component Testing Report Updated Jan 31, 2025 2:44 PM (UTC)

❌ Failed Tests (2) -- expand for details

File	Status	Duration	Passed	Skipped	Failed
comments/CommentInput.spec.tsx	✅ Passed (Inspect)	1m 5s	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)	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 34s	21	0	0
formBuilder/inputs/PortableText/ObjectBlock.spec.tsx	✅ Passed (Inspect)	2m 3s	21	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 Fri, 31 Jan 2025 14:45:55 GMT

Benchmark	reference latency of sanity@latest	experiment latency of this branch	Δ (%) latency difference
article (title)	20.2 efps (50ms)	16.3 efps (62ms)	+12ms (+24.2%)	🔴
article (body)	53.3 efps (19ms)	53.5 efps (19ms)	-0ms (-0.3%)	✅
article (string inside object)	21.3 efps (47ms)	21.7 efps (46ms)	-1ms (-2.1%)	✅
article (string inside array)	19.2 efps (52ms)	19.2 efps (52ms)	+0ms (-/-%)	✅
recipe (name)	50.0 efps (20ms)	52.6 efps (19ms)	-1ms (-5.0%)	✅
recipe (description)	58.8 efps (17ms)	55.6 efps (18ms)	+1ms (+5.9%)	✅
recipe (instructions)	99.9+ efps (5ms)	99.9+ efps (6ms)	+1ms (-/-%)	✅
synthetic (title)	19.6 efps (51ms)	19.6 efps (51ms)	+0ms (-/-%)	✅
synthetic (string inside object)	18.9 efps (53ms)	19.2 efps (52ms)	-1ms (-1.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)	50ms	75ms	91ms	463ms	1031ms	15.1s
article (body)	19ms	25ms	54ms	226ms	473ms	6.9s
article (string inside object)	47ms	49ms	60ms	176ms	622ms	8.3s
article (string inside array)	52ms	56ms	69ms	319ms	851ms	8.6s
recipe (name)	20ms	21ms	22ms	40ms	0ms	6.7s
recipe (description)	17ms	19ms	20ms	30ms	0ms	4.4s
recipe (instructions)	5ms	6ms	8ms	14ms	0ms	3.0s
synthetic (title)	51ms	53ms	58ms	323ms	817ms	12.8s
synthetic (string inside object)	53ms	59ms	70ms	153ms	818ms	8.1s

🧪 Experiment result

The performance result of this branch

Benchmark	latency	p75	p90	p99	blocking time	test duration
article (title)	62ms	94ms	112ms	780ms	1575ms	12.9s
article (body)	19ms	24ms	74ms	280ms	441ms	7.3s
article (string inside object)	46ms	49ms	55ms	350ms	664ms	7.9s
article (string inside array)	52ms	57ms	69ms	174ms	747ms	8.5s
recipe (name)	19ms	20ms	24ms	45ms	1ms	6.6s
recipe (description)	18ms	19ms	20ms	34ms	0ms	4.5s
recipe (instructions)	6ms	7ms	8ms	19ms	0ms	3.1s
synthetic (title)	51ms	53ms	56ms	297ms	744ms	13.0s
synthetic (string inside object)	52ms	55ms	70ms	520ms	1238ms	8.4s

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