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: add --legacy-peer-deps to next-sanity pacakge install #7806

Merged
merged 1 commit into from
Nov 13, 2024
Merged

fix: add --legacy-peer-deps to next-sanity pacakge install #7806

merged 1 commit into from
Nov 13, 2024

Conversation

SimeonGriggs
Copy link
Contributor

Description

When running npx sanity@latest init inside a Next.js 15 project the install errors because of React 19 incompatability.

What to review

That the yarn and pnpm install commands don't also need editing.

Notes for release

  • Added --legacy-peer-deps flag to the automatic install of next-sanity inside Next.js projects

@SimeonGriggs SimeonGriggs requested a review from a team as a code owner November 13, 2024 09:52
@SimeonGriggs SimeonGriggs requested review from ricokahler and removed request for a team November 13, 2024 09:52
@vercel Vercel
Copy link

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

@SimeonGriggs SimeonGriggs requested review from stipsan and a team November 13, 2024 09:52
@github-actions GitHub Actions
Copy link
Contributor

No changes to documentation

@github-actions GitHub Actions
Copy link
Contributor

Component Testing Report Updated Nov 13, 2024 9:58 AM (UTC)

✅ All Tests Passed -- expand for details
File Status Duration Passed Skipped Failed
comments/CommentInput.spec.tsx ✅ Passed (Inspect) 46s 15 0 0
formBuilder/ArrayInput.spec.tsx ✅ Passed (Inspect) 8s 3 0 0
formBuilder/inputs/PortableText/Annotations.spec.tsx ✅ Passed (Inspect) 32s 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) 19s 6 0 0
formBuilder/inputs/PortableText/DisableFocusAndUnset.spec.tsx ✅ Passed (Inspect) 11s 3 0 0
formBuilder/inputs/PortableText/DragAndDrop.spec.tsx ✅ Passed (Inspect) 3m 0s 0 0 0
formBuilder/inputs/PortableText/FocusTracking.spec.tsx ✅ Passed (Inspect) 47s 15 0 0
formBuilder/inputs/PortableText/Input.spec.tsx ✅ Passed (Inspect) 1m 46s 21 0 0
formBuilder/inputs/PortableText/ObjectBlock.spec.tsx ✅ Passed (Inspect) 1m 19s 18 0 0
formBuilder/inputs/PortableText/PresenceCursors.spec.tsx ✅ Passed (Inspect) 9s 3 9 0
formBuilder/inputs/PortableText/RangeDecoration.spec.tsx ✅ Passed (Inspect) 27s 9 0 0
formBuilder/inputs/PortableText/Styles.spec.tsx ✅ Passed (Inspect) 18s 6 0 0
formBuilder/inputs/PortableText/Toolbar.spec.tsx ✅ Passed (Inspect) 37s 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

⚡️ Editor Performance Report

Updated Wed, 13 Nov 2024 10:03:27 GMT

Benchmark reference
latency of sanity@latest		 experiment
latency of this branch		 Δ (%)
latency difference
article (title) 17.2 efps (58ms) 16.4 efps (61ms) +3ms (+5.2%) ✅
article (body) 56.3 efps (18ms) 56.5 efps (18ms) -0ms (-0.3%) ✅
article (string inside object) 18.5 efps (54ms) 17.5 efps (57ms) +3ms (+5.6%) ✅
article (string inside array) 15.9 efps (63ms) 15.4 efps (65ms) +2ms (+3.2%) ✅
recipe (name) 31.3 efps (32ms) 31.3 efps (32ms) +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.1 efps (71ms) 14.1 efps (71ms) +0ms (-/-%) ✅
synthetic (string inside object) 14.8 efps (68ms) 14.3 efps (70ms) +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) 58ms 61ms 77ms 105ms 374ms 13.5s
article (body) 18ms 22ms 30ms 81ms 155ms 5.7s
article (string inside object) 54ms 58ms 72ms 311ms 478ms 8.6s
article (string inside array) 63ms 68ms 88ms 332ms 946ms 9.5s
recipe (name) 32ms 33ms 39ms 69ms 7ms 10.1s
recipe (description) 29ms 31ms 38ms 92ms 0ms 5.9s
recipe (instructions) 6ms 8ms 9ms 23ms 0ms 3.5s
synthetic (title) 71ms 75ms 82ms 554ms 1697ms 15.9s
synthetic (string inside object) 68ms 71ms 80ms 324ms 1408ms 11.0s

🧪 Experiment result

The performance result of this branch

Benchmark latency p75 p90 p99 blocking time test duration
article (title) 61ms 66ms 115ms 484ms 862ms 13.9s
article (body) 18ms 21ms 39ms 79ms 149ms 5.8s
article (string inside object) 57ms 59ms 76ms 292ms 372ms 8.7s
article (string inside array) 65ms 70ms 88ms 301ms 922ms 9.5s
recipe (name) 32ms 35ms 43ms 65ms 12ms 10.3s
recipe (description) 28ms 30ms 31ms 61ms 7ms 5.7s
recipe (instructions) 6ms 7ms 8ms 22ms 0ms 3.2s
synthetic (title) 71ms 74ms 92ms 388ms 1673ms 15.3s
synthetic (string inside object) 70ms 74ms 85ms 488ms 1756ms 10.4s

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

stipsan
stipsan approved these changes Nov 13, 2024
View reviewed changes
Copy link
Member

@stipsan stipsan left a comment

Choose a reason for hiding this comment

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

It's not ideal, but I don't see a better option available to us :/

@SimeonGriggs SimeonGriggs added this pull request to the merge queue Nov 13, 2024
Merged via the queue into next with commit cb3739b Nov 13, 2024
58 checks passed
@SimeonGriggs SimeonGriggs deleted the fix/next-init-legacy-peer-deps branch November 13, 2024 12:46
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

@stipsan stipsan stipsan approved these changes

@ricokahler ricokahler Awaiting requested review from ricokahler ricokahler 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
@SimeonGriggs @stipsan