Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

test(releases): fixing issues with virtual list and releases overview and summary tests #8123

Merged
merged 3 commits into from
Dec 20, 2024

Conversation

jordanl17
Copy link
Member

@jordanl17 jordanl17 commented Dec 20, 2024

Description

With Tanstack Virtual being upgraded in Next, this introduces issues in testing environments where the size of virtual list items is 0px, resulting in none of them being rendered (failing tests).

The workaround is already present in next, but has been abstracted into a function as it's quite likely this will need to be used in other places as there's no clear sign this will be rectified.

This also necessitated some changes to the testing harnesses for RealeasesOverview and ReleaseSummary to ensure the virtual list isn't rendered until the exact sized parent is first.

What to review

Testing

Tests updated and all now pass on COREL

Notes for release

N/A

Copy link

vercel bot commented Dec 20, 2024

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 Dec 20, 2024 2:40pm
performance-studio ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 20, 2024 2:40pm
test-next-studio ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 20, 2024 2:40pm
test-studio ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 20, 2024 2:40pm
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
studio-workshop ⬜️ Ignored (Inspect) Visit Preview Dec 20, 2024 2:40pm

@jordanl17 jordanl17 force-pushed the corel-virtual-test-fix branch from 799e942 to cdb12bb Compare December 20, 2024 14:08
Copy link
Contributor

No changes to documentation

Copy link
Contributor

github-actions bot commented Dec 20, 2024

⚡️ Editor Performance Report

Updated Fri, 20 Dec 2024 16:07:51 GMT

Benchmark reference
latency of sanity@latest
experiment
latency of this branch
Δ (%)
latency difference
recipe (name) 50.0 efps (20ms) 30.3 efps (33ms) +13ms (+65.0%) 🔴
recipe (description) 55.6 efps (18ms) 33.3 efps (30ms) +12ms (+66.7%) 🔴
recipe (instructions) 99.9+ efps (6ms) 99.9+ efps (6ms) +0ms (-/-%)
synthetic (title) 19.4 efps (52ms) 7.9 efps (127ms) +75ms (+145.6%) 🔴
synthetic (string inside object) 20.0 efps (50ms) 8.5 efps (118ms) +68ms (+136.0%) 🔴

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
recipe (name) 20ms 21ms 25ms 75ms 5ms 6.9s
recipe (description) 18ms 20ms 22ms 54ms 6ms 4.7s
recipe (instructions) 6ms 9ms 10ms 31ms 0ms 3.4s
synthetic (title) 52ms 54ms 58ms 313ms 468ms 13.0s
synthetic (string inside object) 50ms 54ms 70ms 138ms 470ms 8.8s

🧪 Experiment result

The performance result of this branch

Benchmark latency p75 p90 p99 blocking time test duration
recipe (name) 33ms 35ms 38ms 77ms 0ms 8.8s
recipe (description) 30ms 32ms 41ms 72ms 49ms 6.0s
recipe (instructions) 6ms 7ms 9ms 28ms 0ms 3.2s
synthetic (title) 127ms 130ms 154ms 603ms 5677ms 19.4s
synthetic (string inside object) 118ms 126ms 145ms 587ms 5146ms 14.6s

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

Copy link
Contributor

github-actions bot commented Dec 20, 2024

Component Testing Report Updated Dec 20, 2024 2:30 PM (UTC)

❌ Failed Tests (1) -- expand for details
File Status Duration Passed Skipped Failed
comments/CommentInput.spec.tsx ✅ Passed (Inspect) 1m 7s 15 0 0
formBuilder/ArrayInput.spec.tsx ✅ Passed (Inspect) 13s 3 0 0
formBuilder/inputs/PortableText/Annotations.spec.tsx ✅ Passed (Inspect) 38s 6 0 0
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 8s 15 0 0
formBuilder/inputs/PortableText/Input.spec.tsx ✅ Passed (Inspect) 1m 29s 21 0 0
formBuilder/inputs/PortableText/ObjectBlock.spec.tsx ❌ Failed (Inspect) 2m 19s 17 0 1
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

@jordanl17 jordanl17 marked this pull request as ready for review December 20, 2024 14:42
@jordanl17 jordanl17 requested a review from a team as a code owner December 20, 2024 14:42
@jordanl17 jordanl17 requested review from bjoerge and removed request for a team December 20, 2024 14:42
Copy link
Member

@bjoerge bjoerge left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh wow, that's some really amazing detective work @jordanl17! Great call extracting this into a shared util as well <3

@jordanl17 jordanl17 merged commit 12c37ca into corel Dec 20, 2024
56 of 57 checks passed
@jordanl17 jordanl17 deleted the corel-virtual-test-fix branch December 20, 2024 16:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants