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

fix(presentation): always show all documents in use #8320

Merged
merged 1 commit into from
Jan 20, 2025

Conversation

stipsan
Copy link
Member

@stipsan stipsan commented Jan 17, 2025

Description

Fixes a regression (I don't know exactly when this regressed) causing only published documents to show up in the list of documents in use in presentation.

What to review

Does it make sense?

Testing

When using the default Drafts perspective, notice the before and after (the right hand side is correct, the left hand side only shows documents that are published and have no drafts):

image

For the Published perspective it should only filter out documents that only have a draft variant:

image

Notes for release

The Presentation Tool's "Documents in use" pane is now including draft documents, and unpublished documents. So that it actually shows all documents in use, and not just some of them.

Copy link

vercel bot commented Jan 17, 2025

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 17, 2025 8:17pm
performance-studio ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 17, 2025 8:17pm
test-studio ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 17, 2025 8:17pm
2 Skipped Deployments
Name Status Preview Comments Updated (UTC)
studio-workshop ⬜️ Ignored (Inspect) Visit Preview Jan 17, 2025 8:17pm
test-next-studio ⬜️ Ignored (Inspect) Jan 17, 2025 8:17pm

Copy link
Contributor

No changes to documentation

Copy link
Contributor

github-actions bot commented Jan 17, 2025

Component Testing Report Updated Jan 17, 2025 8:16 PM (UTC)

❌ Failed Tests (2) -- expand for details
File Status Duration Passed Skipped Failed
comments/CommentInput.spec.tsx ✅ Passed (Inspect) 1m 10s 15 0 0
formBuilder/ArrayInput.spec.tsx ✅ Passed (Inspect) 12s 3 0 0
formBuilder/inputs/PortableText/Annotations.spec.tsx ❌ Failed (Inspect) 2m 0s 4 0 2
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) 26s 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 1s 21 0 0
formBuilder/inputs/PortableText/PresenceCursors.spec.tsx ✅ Passed (Inspect) 12s 3 9 0
formBuilder/inputs/PortableText/Styles.spec.tsx ✅ Passed (Inspect) 26s 6 0 0
formBuilder/inputs/PortableText/Toolbar.spec.tsx ✅ Passed (Inspect) 1m 42s 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

Copy link
Contributor

github-actions bot commented Jan 17, 2025

⚡️ Editor Performance Report

Updated Fri, 17 Jan 2025 21:23:45 GMT

Benchmark reference
latency of sanity@latest
experiment
latency of this branch
Δ (%)
latency difference
article (title) 24.7 efps (41ms) 25.0 efps (40ms) -1ms (-1.2%)
article (body) 69.9 efps (14ms) 72.7 efps (14ms) -1ms (-/-%)
article (string inside object) 27.8 efps (36ms) 27.0 efps (37ms) +1ms (+2.8%)
article (string inside array) 24.1 efps (42ms) 24.1 efps (42ms) +0ms (-/-%)
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 (5ms) +0ms (-/-%)
synthetic (title) 18.3 efps (55ms) 19.2 efps (52ms) -3ms (-4.6%)
synthetic (string inside object) 19.6 efps (51ms) 19.2 efps (52ms) +1ms (+2.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
article (title) 41ms 51ms 73ms 403ms 854ms 10.7s
article (body) 14ms 16ms 22ms 138ms 227ms 5.3s
article (string inside object) 36ms 38ms 43ms 189ms 230ms 6.3s
article (string inside array) 42ms 44ms 48ms 254ms 293ms 7.0s
recipe (name) 20ms 22ms 25ms 58ms 0ms 6.5s
recipe (description) 17ms 18ms 21ms 49ms 0ms 4.6s
recipe (instructions) 5ms 6ms 8ms 17ms 0ms 3.1s
synthetic (title) 55ms 57ms 68ms 119ms 997ms 13.3s
synthetic (string inside object) 51ms 54ms 61ms 128ms 1050ms 8.3s

🧪 Experiment result

The performance result of this branch

Benchmark latency p75 p90 p99 blocking time test duration
article (title) 40ms 46ms 64ms 454ms 701ms 10.1s
article (body) 14ms 15ms 19ms 165ms 226ms 5.1s
article (string inside object) 37ms 40ms 48ms 220ms 246ms 6.8s
article (string inside array) 42ms 44ms 48ms 160ms 173ms 6.7s
recipe (name) 19ms 21ms 25ms 40ms 3ms 6.9s
recipe (description) 17ms 19ms 20ms 29ms 0ms 4.3s
recipe (instructions) 5ms 7ms 7ms 8ms 0ms 3.0s
synthetic (title) 52ms 57ms 71ms 501ms 1215ms 15.4s
synthetic (string inside object) 52ms 52ms 56ms 259ms 404ms 7.7s

📚 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

@georgedoescode georgedoescode left a comment

Choose a reason for hiding this comment

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

LGTM! ❤️

@stipsan stipsan added this pull request to the merge queue Jan 20, 2025
Merged via the queue into next with commit cbbebd5 Jan 20, 2025
56 checks passed
@stipsan stipsan deleted the fix-presentation-document-list-regression branch January 20, 2025 10:09
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