test(e2e): add checks for properties in reference tests #8279

RitaDias · 2025-01-15T11:01:49Z

Description

Tests added after the latest round of Actions API feedback

Add e2e to check that properties are being added when reference is created
Add e2e to check that the properties are being removed when the reference and document are published
Add e2e to check that the properties are not removed when the weak property is set in the schema

What to review

Do the tests make sense?

Notes for release

N/A internal test

vercel · 2025-01-15T11:01:54Z

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 16, 2025 9:05am
performance-studio	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 16, 2025 9:05am
test-studio	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 16, 2025 9:05am

2 Skipped Deployments

Name	Status	Preview	Comments	Updated (UTC)
studio-workshop	⬜️ Ignored (Inspect)	Visit Preview		Jan 16, 2025 9:05am
test-next-studio	⬜️ Ignored (Inspect)			Jan 16, 2025 9:05am

github-actions · 2025-01-15T11:02:32Z

No changes to documentation

github-actions · 2025-01-15T11:08:10Z

Component Testing Report Updated Jan 16, 2025 9:04 AM (UTC)

✅ All Tests Passed -- expand for details

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

github-actions · 2025-01-15T11:13:23Z

⚡️ Editor Performance Report

Updated Thu, 16 Jan 2025 09:06:47 GMT

Benchmark	reference ^{latency of sanity@latest}	experiment ^{latency of this branch}	Δ (%) ^{latency difference}
article (title)	22.7 efps (44ms)	23.0 efps (44ms)	-1ms (-1.1%)	✅
article (body)	59.7 efps (17ms)	59.7 efps (17ms)	+0ms (-/-%)	✅
article (string inside object)	25.6 efps (39ms)	23.8 efps (42ms)	+3ms (+7.7%)	✅
article (string inside array)	21.5 efps (47ms)	21.3 efps (47ms)	+1ms (+1.1%)	✅
recipe (name)	47.6 efps (21ms)	51.3 efps (20ms)	-2ms (-7.1%)	✅
recipe (description)	52.6 efps (19ms)	58.8 efps (17ms)	-2ms (-10.5%)	✅
recipe (instructions)	99.9+ efps (5ms)	99.9+ efps (6ms)	+1ms (-/-%)	✅
synthetic (title)	18.5 efps (54ms)	19.2 efps (52ms)	-2ms (-3.7%)	✅
synthetic (string inside object)	20.4 efps (49ms)	19.6 efps (51ms)	+2ms (+4.1%)	✅

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)	44ms	65ms	78ms	352ms	794ms	10.9s
article (body)	17ms	18ms	22ms	212ms	269ms	5.8s
article (string inside object)	39ms	42ms	47ms	178ms	143ms	6.8s
article (string inside array)	47ms	49ms	54ms	77ms	369ms	7.5s
recipe (name)	21ms	23ms	25ms	50ms	0ms	7.2s
recipe (description)	19ms	22ms	26ms	38ms	0ms	4.6s
recipe (instructions)	5ms	6ms	8ms	9ms	0ms	3.0s
synthetic (title)	54ms	57ms	65ms	246ms	723ms	13.4s
synthetic (string inside object)	49ms	51ms	62ms	268ms	620ms	7.9s

🧪 Experiment result

The performance result of this branch

Benchmark	latency	p75	p90	p99	blocking time	test duration
article (title)	44ms	58ms	70ms	460ms	845ms	10.6s
article (body)	17ms	19ms	33ms	272ms	362ms	5.7s
article (string inside object)	42ms	45ms	55ms	174ms	181ms	6.9s
article (string inside array)	47ms	49ms	52ms	98ms	202ms	7.2s
recipe (name)	20ms	21ms	23ms	39ms	0ms	7.2s
recipe (description)	17ms	18ms	20ms	32ms	0ms	4.4s
recipe (instructions)	6ms	7ms	8ms	9ms	0ms	3.2s
synthetic (title)	52ms	55ms	60ms	266ms	679ms	13.0s
synthetic (string inside object)	51ms	52ms	56ms	268ms	582ms	8.2s

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

pedrobonamin

Thanks for doing this Rita! Added a small suggestion on a selector that would be nice to use in other way

test/e2e/tests/inputs/reference.spec.ts

RitaDias added 3 commits January 15, 2025 12:00

test(e2e): add checks for properties in reference tests

8090890

docs(e2e): update comments

a9158da

test(e2e): update test for when weak property is set up in schema

d4814fe

test(e2e): update reference tests

3333421

vercel bot deployed to Preview – page-building-studio January 15, 2025 11:31 View deployment

RitaDias requested a review from juice49 January 15, 2025 11:45

RitaDias marked this pull request as ready for review January 15, 2025 11:45

RitaDias requested a review from a team as a code owner January 15, 2025 11:45

vercel bot deployed to Preview – performance-studio January 15, 2025 11:56 View deployment

vercel bot deployed to Preview – page-building-studio January 15, 2025 11:57 View deployment

vercel bot deployed to Preview – test-studio January 15, 2025 11:57 View deployment

pedrobonamin reviewed Jan 15, 2025

View reviewed changes

test/e2e/tests/inputs/reference.spec.ts Outdated Show resolved Hide resolved

vercel bot deployed to Preview – performance-studio January 16, 2025 08:03 View deployment

vercel bot deployed to Preview – page-building-studio January 16, 2025 08:03 View deployment

vercel bot deployed to Preview – test-studio January 16, 2025 08:04 View deployment

test(e2e): update testid selectors

a152d9a

RitaDias force-pushed the update-reference-tests branch from 0f1afab to a152d9a Compare January 16, 2025 08:49

vercel bot deployed to Preview – performance-studio January 16, 2025 08:50 View deployment

vercel bot deployed to Preview – page-building-studio January 16, 2025 08:50 View deployment

vercel bot deployed to Preview – test-studio January 16, 2025 08:50 View deployment

Merge branch 'next' into update-reference-tests

3327b18

RitaDias requested a review from pedrobonamin January 16, 2025 08:59

vercel bot deployed to Preview – page-building-studio January 16, 2025 09:04 View deployment

vercel bot deployed to Preview – performance-studio January 16, 2025 09:05 View deployment

vercel bot deployed to Preview – test-studio January 16, 2025 09:05 View deployment

pedrobonamin approved these changes Jan 16, 2025

View reviewed changes

RitaDias added this pull request to the merge queue Jan 16, 2025

Merged via the queue into next with commit 21aba08 Jan 16, 2025
57 checks passed

RitaDias deleted the update-reference-tests branch January 16, 2025 13:09

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

test(e2e): add checks for properties in reference tests #8279

test(e2e): add checks for properties in reference tests #8279

RitaDias commented Jan 15, 2025

vercel bot commented Jan 15, 2025 •

edited

Loading

github-actions bot commented Jan 15, 2025

github-actions bot commented Jan 15, 2025 •

edited

Loading

github-actions bot commented Jan 15, 2025 •

edited

Loading

🏠 Reference result

🧪 Experiment result

📚 Glossary

column definitions

pedrobonamin left a comment

test(e2e): add checks for properties in reference tests #8279

test(e2e): add checks for properties in reference tests #8279

Conversation

RitaDias commented Jan 15, 2025

Description

What to review

Notes for release

vercel bot commented Jan 15, 2025 • edited Loading

github-actions bot commented Jan 15, 2025

github-actions bot commented Jan 15, 2025 • edited Loading

github-actions bot commented Jan 15, 2025 • edited Loading

⚡️ Editor Performance Report

🏠 Reference result

🧪 Experiment result

📚 Glossary

column definitions

pedrobonamin left a comment

Choose a reason for hiding this comment

vercel bot commented Jan 15, 2025 •

edited

Loading

github-actions bot commented Jan 15, 2025 •

edited

Loading

github-actions bot commented Jan 15, 2025 •

edited

Loading