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

feat: switch create integration to opt-out flow #8002

Merged
merged 3 commits into from
Dec 10, 2024

Conversation

robinpyon
Copy link
Contributor

@robinpyon robinpyon commented Dec 10, 2024

Description

This PR enables the "Start in Create" banner by default for all documents (essentially running back #7884). Please note that Create is still in early access.

This also updates a few Create links to now use URLs provided by our link management service (should they need to be updated in future).

What to review

  • In the test studio, all documents will now include this banner by default.
  • In the test create integration studio (dev/test-create-integration-studio), you can find an example where this has been disabled for a specific workspace.

Notes for release

This is in-flight and will be added separately by @mmgj

Copy link

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

@robinpyon robinpyon marked this pull request as ready for review December 10, 2024 12:33
@robinpyon robinpyon requested a review from a team as a code owner December 10, 2024 12:33
@robinpyon robinpyon changed the title Feat/make create opt out feat: switch create integration to opt-out flow Dec 10, 2024
bjoerge
bjoerge previously approved these changes Dec 10, 2024
target="_blank"
rel="noreferrer"
>
<a href="https://snty.link/create-config-guide" target="_blank" rel="noreferrer">
Copy link
Member

Choose a reason for hiding this comment

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

oh, nice, TIL we have an url shortener

Copy link
Contributor

Choose a reason for hiding this comment

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

Should this have ?ref=studio for tracking or is that baked into the shortener?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@bjoerge I think it's used elsewhere in the studio too! (Comments and tasks)

@snorrees It's not baked into the shortener – I'll add that here too

Copy link
Contributor

No changes to documentation

snorrees
snorrees previously approved these changes Dec 10, 2024
target="_blank"
rel="noreferrer"
>
<a href="https://snty.link/create-config-guide" target="_blank" rel="noreferrer">
Copy link
Contributor

Choose a reason for hiding this comment

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

Should this have ?ref=studio for tracking or is that baked into the shortener?

Copy link
Contributor

github-actions bot commented Dec 10, 2024

Component Testing Report Updated Dec 10, 2024 1:14 PM (UTC)

✅ All Tests Passed -- expand for details
File Status Duration Passed Skipped Failed
comments/CommentInput.spec.tsx ✅ Passed (Inspect) 1m 17s 15 0 0
formBuilder/ArrayInput.spec.tsx ✅ Passed (Inspect) 14s 3 0 0
formBuilder/inputs/PortableText/Annotations.spec.tsx ✅ Passed (Inspect) 42s 6 0 0
formBuilder/inputs/PortableText/copyPaste/CopyPaste.spec.tsx ✅ Passed (Inspect) 1m 1s 11 7 0
formBuilder/inputs/PortableText/copyPaste/CopyPasteFields.spec.tsx ✅ Passed (Inspect) 0s 0 12 0
formBuilder/inputs/PortableText/Decorators.spec.tsx ✅ Passed (Inspect) 30s 6 0 0
formBuilder/inputs/PortableText/DisableFocusAndUnset.spec.tsx ✅ Passed (Inspect) 18s 3 0 0
formBuilder/inputs/PortableText/DragAndDrop.spec.tsx ✅ Passed (Inspect) 2m 9s 2 0 0
formBuilder/inputs/PortableText/FocusTracking.spec.tsx ✅ Passed (Inspect) 1m 15s 15 0 0
formBuilder/inputs/PortableText/Input.spec.tsx ✅ Passed (Inspect) 3m 7s 21 0 0
formBuilder/inputs/PortableText/ObjectBlock.spec.tsx ✅ Passed (Inspect) 1m 57s 18 0 0
formBuilder/inputs/PortableText/PresenceCursors.spec.tsx ✅ Passed (Inspect) 16s 3 9 0
formBuilder/inputs/PortableText/RangeDecoration.spec.tsx ✅ Passed (Inspect) 45s 9 0 0
formBuilder/inputs/PortableText/Styles.spec.tsx ✅ Passed (Inspect) 30s 6 0 0
formBuilder/inputs/PortableText/Toolbar.spec.tsx ✅ Passed (Inspect) 1m 1s 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

Copy link
Contributor

github-actions bot commented Dec 10, 2024

⚡️ Editor Performance Report

Updated Tue, 10 Dec 2024 13:15:09 GMT

Benchmark reference
latency of sanity@latest
experiment
latency of this branch
Δ (%)
latency difference
article (title) 29.4 efps (34ms) 26.3 efps (38ms) +4ms (+11.8%)
article (body) 74.9 efps (13ms) 72.5 efps (14ms) +0ms (-/-%)
article (string inside object) 27.0 efps (37ms) 25.0 efps (40ms) +3ms (+8.1%)
article (string inside array) 26.0 efps (39ms) 23.3 efps (43ms) +5ms (+11.7%)
recipe (name) 50.0 efps (20ms) 47.6 efps (21ms) +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) 18.9 efps (53ms) 18.5 efps (54ms) +1ms (+1.9%)
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) 34ms 36ms 39ms 63ms 149ms 10.5s
article (body) 13ms 15ms 20ms 75ms 66ms 4.5s
article (string inside object) 37ms 42ms 52ms 255ms 300ms 6.9s
article (string inside array) 39ms 40ms 47ms 260ms 313ms 6.9s
recipe (name) 20ms 23ms 28ms 64ms 0ms 7.5s
recipe (description) 17ms 18ms 22ms 78ms 6ms 4.6s
recipe (instructions) 5ms 6ms 8ms 8ms 0ms 3.0s
synthetic (title) 53ms 55ms 60ms 263ms 531ms 11.9s
synthetic (string inside object) 53ms 56ms 68ms 499ms 1119ms 8.9s

🧪 Experiment result

The performance result of this branch

Benchmark latency p75 p90 p99 blocking time test duration
article (title) 38ms 43ms 49ms 86ms 158ms 11.1s
article (body) 14ms 17ms 27ms 72ms 57ms 5.0s
article (string inside object) 40ms 42ms 46ms 61ms 238ms 6.8s
article (string inside array) 43ms 45ms 52ms 258ms 296ms 7.2s
recipe (name) 21ms 23ms 27ms 42ms 0ms 6.8s
recipe (description) 18ms 20ms 21ms 40ms 0ms 4.6s
recipe (instructions) 6ms 7ms 9ms 18ms 0ms 3.1s
synthetic (title) 54ms 56ms 63ms 313ms 648ms 15.9s
synthetic (string inside object) 52ms 55ms 60ms 87ms 175ms 7.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.

@robinpyon robinpyon dismissed stale reviews from snorrees and bjoerge via 42e8e23 December 10, 2024 12:57
@robinpyon robinpyon added this pull request to the merge queue Dec 10, 2024
Merged via the queue into next with commit 6b322cb Dec 10, 2024
31 checks passed
@robinpyon robinpyon deleted the feat/make-create-opt-out branch December 10, 2024 13:02
bjoerge added a commit that referenced this pull request Dec 12, 2024
* next: (49 commits)
  fix: delays rendering the Start in Create banner until document is ready (#8020)
  fix(deps): update dependency @sanity/ui to ^2.10.9 (#8009)
  chore(deps): dedupe pnpm-lock.yaml (#8023)
  test(playwright-ct): fix issues and flake (#8016)
  feat(cli): misc copy changes (#8003)
  feat(cli): remove is-builtin-module (#6579)
  v3.67.1
  chore(deps): bump minimum requirement of @sanity/import and @sanity/export (#8012)
  chore(deps): update dependency @sanity/pkg-utils to v6.12.0 (#8010)
  fix(core): tasks UpdatedTimeAgo should be a hook (#8011)
  v3.67.0
  chore(prettier): fix unformatted files 🤖 ✨ (#8006)
  chore: reduce renovate double PR noise
  fix(deps): update dependency @sanity/ui to ^2.10.7 (#8005)
  fix(deps): update dependency @sanity/ui to ^2.10.7 (#7998)
  feat(cli): use `@vercel/frameworks` in `bootstrapRemoteTemplate` (#8001)
  feat: switch create integration to opt-out flow (#8002)
  feat: use eslint 9 for new studios (#7978)
  fix(sanity): optimise getLeafWeights to not stack overflow (#7999)
  feat(test-studio): enable `groq2024` search strategy
  ...
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.

3 participants