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

refactor: move to system-only release documents #7824

Merged
merged 3 commits into from
Nov 15, 2024
Merged

refactor: move to system-only release documents #7824

merged 3 commits into from
Nov 15, 2024

Conversation

bjoerge
Copy link
Member

@bjoerge bjoerge commented Nov 15, 2024

No description provided.

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

bjoerge
bjoerge commented Nov 15, 2024
View reviewed changes
packages/sanity/src/core/releases/store/createReleaseStore.ts
const RELEASE_METADATA_TMP_DOC_PATH = 'system-tmp-releases'
// todo: remove this after first tagged release
function migrateWith(client: SanityClient) {
return client.observable.fetch(`*[_id in path('${RELEASE_METADATA_TMP_DOC_PATH}.**')]`).pipe(
Copy link
Member Author

@bjoerge bjoerge Nov 15, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

this migrates from old system-tmp-releases docments in the background (for projects that may have created them during testing). We should remove this shortly

@github-actions GitHub Actions
Copy link
Contributor

No changes to documentation

bjoerge
bjoerge commented Nov 15, 2024
View reviewed changes
packages/sanity/src/core/releases/store/createReleaseStore.ts
releases.map(
(releaseDoc: ReleaseDocument): ReleaseDocument => ({
...releaseDoc,
metadata: {...(releaseDoc as any).userMetadata, ...releaseDoc.metadata},
Copy link
Member Author

Choose a reason for hiding this comment

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

userMetadata is going to be renamed to metadata very soon – this makes sure both works

bjoerge
bjoerge commented Nov 15, 2024
View reviewed changes
packages/sanity/src/core/releases/store/useReleaseOperations.ts
return useMemo(
() =>
createReleaseOperationsStore({
client: studioClient,
// todo: is this non-null assertion safe?
currentUser: currentUser!,
Copy link
Member Author

Choose a reason for hiding this comment

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

release store doesn't require current user anymore

@bjoerge bjoerge marked this pull request as ready for review November 15, 2024 14:25
@bjoerge bjoerge requested a review from a team as a code owner November 15, 2024 14:25
@bjoerge bjoerge requested review from juice49, jordanl17, RitaDias and pedrobonamin and removed request for a team and juice49 November 15, 2024 14:25
@github-actions GitHub Actions
Copy link
Contributor

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

⚡️ Editor Performance Report

Updated Fri, 15 Nov 2024 15:24:33 GMT

Benchmark reference
latency of sanity@latest		 experiment
latency of this branch		 Δ (%)
latency difference
article (title) 15.2 efps (66ms) 11.3 efps (89ms) +23ms (+34.1%) 🔴
article (body) 54.6 efps (18ms) 50.8 efps (20ms) +1ms (+7.7%) ✅
article (string inside object) 17.9 efps (56ms) 12.0 efps (83ms) +27ms (+48.2%) 🔴
article (string inside array) 14.5 efps (69ms) 10.5 efps (95ms) +26ms (+37.7%) 🔴
recipe (name) 30.3 efps (33ms) 20.0 efps (50ms) +17ms (+51.5%) 🔴
recipe (description) 34.5 efps (29ms) 21.3 efps (47ms) +18ms (+62.1%) 🔴
recipe (instructions) 99.9+ efps (6ms) 99.9+ efps (7ms) +1ms (-/-%) ✅
synthetic (title) 14.7 efps (68ms) 6.0 efps (168ms) +100ms (+147.1%) 🔴
synthetic (string inside object) 15.3 efps (66ms) 6.0 efps (168ms) +103ms (+156.5%) 🔴

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) 66ms 75ms 99ms 286ms 705ms 14.9s
article (body) 18ms 21ms 32ms 197ms 296ms 6.2s
article (string inside object) 56ms 59ms 69ms 210ms 316ms 8.8s
article (string inside array) 69ms 73ms 80ms 235ms 933ms 9.6s
recipe (name) 33ms 35ms 40ms 71ms 0ms 8.6s
recipe (description) 29ms 32ms 33ms 53ms 0ms 5.8s
recipe (instructions) 6ms 7ms 8ms 10ms 0ms 3.2s
synthetic (title) 68ms 72ms 78ms 367ms 1539ms 15.3s
synthetic (string inside object) 66ms 71ms 105ms 573ms 1550ms 10.1s

🧪 Experiment result

The performance result of this branch

Benchmark latency p75 p90 p99 blocking time test duration
article (title) 89ms 98ms 133ms 400ms 3341ms 19.1s
article (body) 20ms 24ms 42ms 280ms 629ms 7.3s
article (string inside object) 83ms 88ms 104ms 301ms 2779ms 12.0s
article (string inside array) 95ms 101ms 114ms 331ms 3455ms 13.0s
recipe (name) 50ms 54ms 59ms 98ms 923ms 10.9s
recipe (description) 47ms 48ms 54ms 87ms 766ms 7.9s
recipe (instructions) 7ms 9ms 9ms 32ms 0ms 3.3s
synthetic (title) 168ms 175ms 185ms 1186ms 10145ms 44.0s
synthetic (string inside object) 168ms 180ms 198ms 798ms 9437ms 20.8s

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

@github-actions GitHub Actions
Copy link
Contributor

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

Component Testing Report Updated Nov 15, 2024 3:21 PM (UTC)

✅ All Tests Passed -- 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) 40s 6 0 0
formBuilder/inputs/PortableText/copyPaste/CopyPaste.spec.tsx ✅ Passed (Inspect) 53s 11 7 0
formBuilder/inputs/PortableText/copyPaste/CopyPasteFields.spec.tsx ✅ Passed (Inspect) 0s 0 12 0
formBuilder/inputs/PortableText/Decorators.spec.tsx ✅ Passed (Inspect) 28s 6 0 0
formBuilder/inputs/PortableText/DisableFocusAndUnset.spec.tsx ✅ Passed (Inspect) 15s 3 0 0
formBuilder/inputs/PortableText/DragAndDrop.spec.tsx ✅ Passed (Inspect) 3m 0s 0 0 0
formBuilder/inputs/PortableText/FocusTracking.spec.tsx ✅ Passed (Inspect) 1m 6s 15 0 0
formBuilder/inputs/PortableText/Input.spec.tsx ✅ Passed (Inspect) 2m 54s 21 0 0
formBuilder/inputs/PortableText/ObjectBlock.spec.tsx ✅ Passed (Inspect) 1m 42s 18 0 0
formBuilder/inputs/PortableText/PresenceCursors.spec.tsx ✅ Passed (Inspect) 14s 3 9 0
formBuilder/inputs/PortableText/RangeDecoration.spec.tsx ✅ Passed (Inspect) 40s 9 0 0
formBuilder/inputs/PortableText/Styles.spec.tsx ✅ Passed (Inspect) 26s 6 0 0
formBuilder/inputs/PortableText/Toolbar.spec.tsx ✅ Passed (Inspect) 52s 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

@bjoerge bjoerge merged commit 78c3214 into corel Nov 15, 2024
18 checks passed
@bjoerge bjoerge deleted the system-only-release-docs branch November 15, 2024 16:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jordanl17 jordanl17 Awaiting requested review from jordanl17

@RitaDias RitaDias Awaiting requested review from RitaDias

@pedrobonamin pedrobonamin Awaiting requested review from pedrobonamin

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

Successfully merging this pull request may close these issues.
1 participant
@bjoerge