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.

Sign up for GitHub

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

Jump to bottom

fix(core): add opt out option to studioAnnouncements #7820

Merged
merged 1 commit into from
Nov 15, 2024
Merged

fix(core): add opt out option to studioAnnouncements #7820

merged 1 commit into from
Nov 15, 2024

Conversation

pedrobonamin
Copy link
Contributor

@pedrobonamin pedrobonamin commented Nov 15, 2024 •
edited
Loading

Description

Adds a new config flag that can be used to opt out from announcements.
It also opts out in e2e tests, given tests are failing when the announcement renders

What to review

Is the config name accurate?
Announcements should work as always in the test studio, you can test it by appending the ?reset-announcements to the test studio url.
https://test-studio-git-announcements-opt-out.sanity.dev/test/structure?reset-announcements=true

Testing

New tests for the opt out flag has been added

Notes for release

@pedrobonamin pedrobonamin requested a review from a team as a code owner November 15, 2024 09:11
@pedrobonamin pedrobonamin requested review from EoinFalconer and removed request for a team November 15, 2024 09:11
@vercel Vercel
Copy link

vercel bot commented Nov 15, 2024 •
edited
Loading

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 Nov 15, 2024 9:28am
performance-studio ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 15, 2024 9:28am
test-compiled-studio ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 15, 2024 9:28am
test-next-studio ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 15, 2024 9:28am
test-studio ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 15, 2024 9:28am
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
studio-workshop ⬜️ Ignored (Inspect) Visit Preview Nov 15, 2024 9:28am

@github-actions GitHub Actions
Copy link
Contributor

No changes to documentation

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Nov 15, 2024 •
edited
Loading

Component Testing Report Updated Nov 15, 2024 9:24 AM (UTC)

✅ All Tests Passed -- expand for details
File Status Duration Passed Skipped Failed
comments/CommentInput.spec.tsx ✅ Passed (Inspect) 49s 15 0 0
formBuilder/ArrayInput.spec.tsx ✅ Passed (Inspect) 9s 3 0 0
formBuilder/inputs/PortableText/Annotations.spec.tsx ✅ Passed (Inspect) 31s 6 0 0
formBuilder/inputs/PortableText/copyPaste/CopyPaste.spec.tsx ✅ Passed (Inspect) 39s 11 7 0
formBuilder/inputs/PortableText/copyPaste/CopyPasteFields.spec.tsx ✅ Passed (Inspect) 0s 0 12 0
formBuilder/inputs/PortableText/Decorators.spec.tsx ✅ Passed (Inspect) 17s 6 0 0
formBuilder/inputs/PortableText/DisableFocusAndUnset.spec.tsx ✅ Passed (Inspect) 10s 3 0 0
formBuilder/inputs/PortableText/DragAndDrop.spec.tsx ✅ Passed (Inspect) 2m 32s 1 0 0
formBuilder/inputs/PortableText/FocusTracking.spec.tsx ✅ Passed (Inspect) 46s 15 0 0
formBuilder/inputs/PortableText/Input.spec.tsx ✅ Passed (Inspect) 1m 44s 21 0 0
formBuilder/inputs/PortableText/ObjectBlock.spec.tsx ✅ Passed (Inspect) 1m 20s 18 0 0
formBuilder/inputs/PortableText/PresenceCursors.spec.tsx ✅ Passed (Inspect) 9s 3 9 0
formBuilder/inputs/PortableText/RangeDecoration.spec.tsx ✅ Passed (Inspect) 26s 9 0 0
formBuilder/inputs/PortableText/Styles.spec.tsx ✅ Passed (Inspect) 18s 6 0 0
formBuilder/inputs/PortableText/Toolbar.spec.tsx ✅ Passed (Inspect) 36s 12 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 GitHub Actions
Copy link
Contributor

github-actions bot commented Nov 15, 2024 •
edited
Loading

⚡️ Editor Performance Report

Updated Fri, 15 Nov 2024 09:26:45 GMT

Benchmark reference
latency of sanity@latest		 experiment
latency of this branch		 Δ (%)
latency difference
article (title) 16.4 efps (61ms) 16.1 efps (62ms) +1ms (+1.6%) ✅
article (body) 59.5 efps (17ms) 58.1 efps (17ms) +0ms (+2.4%) ✅
article (string inside object) 18.9 efps (53ms) 18.2 efps (55ms) +2ms (+3.8%) ✅
article (string inside array) 15.2 efps (66ms) 15.6 efps (64ms) -2ms (-3.0%) ✅
recipe (name) 30.3 efps (33ms) 30.3 efps (33ms) +0ms (-/-%) ✅
recipe (description) 34.5 efps (29ms) 35.7 efps (28ms) -1ms (-3.4%) ✅
recipe (instructions) 99.9+ efps (6ms) 99.9+ efps (6ms) +0ms (-/-%) ✅
synthetic (title) 14.7 efps (68ms) 15.3 efps (66ms) -3ms (-3.7%) ✅
synthetic (string inside object) 14.8 efps (68ms) 15.4 efps (65ms) -3ms (-3.7%) ✅

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) 61ms 77ms 113ms 333ms 758ms 15.8s
article (body) 17ms 20ms 29ms 79ms 168ms 5.5s
article (string inside object) 53ms 56ms 68ms 216ms 399ms 8.8s
article (string inside array) 66ms 70ms 74ms 226ms 838ms 9.7s
recipe (name) 33ms 36ms 52ms 89ms 0ms 9.4s
recipe (description) 29ms 31ms 33ms 56ms 0ms 5.8s
recipe (instructions) 6ms 9ms 10ms 29ms 1ms 3.4s
synthetic (title) 68ms 72ms 79ms 338ms 1442ms 15.8s
synthetic (string inside object) 68ms 74ms 80ms 564ms 1753ms 10.3s

🧪 Experiment result

The performance result of this branch

Benchmark latency p75 p90 p99 blocking time test duration
article (title) 62ms 65ms 79ms 224ms 552ms 14.0s
article (body) 17ms 21ms 35ms 262ms 452ms 6.1s
article (string inside object) 55ms 60ms 71ms 94ms 292ms 8.4s
article (string inside array) 64ms 67ms 78ms 178ms 812ms 9.5s
recipe (name) 33ms 36ms 55ms 90ms 17ms 9.3s
recipe (description) 28ms 31ms 32ms 55ms 0ms 5.7s
recipe (instructions) 6ms 7ms 9ms 9ms 0ms 3.3s
synthetic (title) 66ms 72ms 129ms 354ms 1420ms 15.6s
synthetic (string inside object) 65ms 71ms 99ms 362ms 1271ms 10.5s

📚 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 pedrobonamin merged commit 3efc59d into next Nov 15, 2024
60 checks passed
@pedrobonamin pedrobonamin deleted the announcements-opt-out branch November 15, 2024 10:50
bjoerge added a commit that referenced this pull request Nov 15, 2024
@bjoerge
Merge branch 'next' into corel
6b9fe6e 
* next:
  chore(core): update announcements card close icon (#7822)
  fix(core): add opt out option to studioAnnouncements  (#7820)
  chore(lockfile): update dependency @sanity/asset-utils to v2.1.0 (#7818)
  chore(deps): update pnpm to v9.13.1 (#7817)
  chore(lockfile): update dependency sanity-plugin-mux-input to v2.4.0 (#7814)
  fix(deps): Update dev-non-major (#7809)
  chore(deps): update typescript-tooling (#7812)
  fix(deps): update dependency @portabletext/editor to ^1.8.0 (#7810)
  v3.64.1
  fix: add --legacy-peer-deps to next-sanity pacakge install (#7806)
  fix(deps): Update dev-non-major (#7804)
  fix(deps): update dependency @portabletext/editor to ^1.7.1 (#7807)
  fix(deps): update dependency @sanity/presentation to v1.18.2 (#7808)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bjoerge bjoerge bjoerge approved these changes

@EoinFalconer EoinFalconer Awaiting requested review from EoinFalconer EoinFalconer is a code owner automatically assigned from sanity-io/studio

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@pedrobonamin @bjoerge