feat: releases overview shows total docs in release #8232

jordanl17 · 2025-01-10T03:05:23Z

Description

Scenario	Before	After
Active releases
Archived/Published releases

Split out the cell components for ReleasesOverview into separate components rather than all inside the column defs
Added tests for these cell components
Updated the cell component for the document count (ReleaseDocumentsCount), to:
- use the documentsMetadata count for active releases
- use the finalDocumentStates count for published or archived releases
Removed existingDocumentCount from the release metadata aggregator store as it's no longer needed

What to review

Testing

Added tests to the cell components

Notes for release

N/A

vercel · 2025-01-10T03:05:28Z

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 16, 2025 2:10pm
performance-studio	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 16, 2025 2:10pm
test-studio	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 16, 2025 2:10pm

2 Skipped Deployments

Name	Status	Preview	Comments	Updated (UTC)
studio-workshop	⬜️ Ignored (Inspect)	Visit Preview		Jan 16, 2025 2:10pm
test-next-studio	⬜️ Ignored (Inspect)			Jan 16, 2025 2:10pm

github-actions · 2025-01-10T03:10:18Z

No changes to documentation

github-actions · 2025-01-10T03:16:16Z

Component Testing Report Updated Jan 16, 2025 2:10 PM (UTC)

❌ Failed Tests (1) -- expand for details

File	Status	Duration	Passed	Skipped	Failed
comments/CommentInput.spec.tsx	✅ Passed (Inspect)	1m 4s	15	0	0
formBuilder/ArrayInput.spec.tsx	✅ Passed (Inspect)	12s	3	0	0
formBuilder/inputs/PortableText/Annotations.spec.tsx	❌ Failed (Inspect)	1m 18s	5	0	1
formBuilder/inputs/PortableText/copyPaste/CopyPaste.spec.tsx	✅ Passed (Inspect)	51s	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 6s	15	0	0
formBuilder/inputs/PortableText/Input.spec.tsx	✅ Passed (Inspect)	1m 28s	21	0	0
formBuilder/inputs/PortableText/ObjectBlock.spec.tsx	✅ Passed (Inspect)	1m 41s	18	0	0
formBuilder/inputs/PortableText/PresenceCursors.spec.tsx	✅ Passed (Inspect)	13s	3	9	0
formBuilder/inputs/PortableText/Styles.spec.tsx	✅ Passed (Inspect)	26s	6	0	0
formBuilder/inputs/PortableText/Toolbar.spec.tsx	✅ Passed (Inspect)	1m 43s	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

github-actions · 2025-01-10T03:17:57Z

⚡️ Editor Performance Report

Updated Thu, 16 Jan 2025 14:11:27 GMT

Benchmark	reference ^{latency of sanity@latest}	experiment ^{latency of this branch}	Δ (%) ^{latency difference}
article (title)	25.3 efps (40ms)	27.8 efps (36ms)	-4ms (-8.9%)	✅
article (body)	67.8 efps (15ms)	63.3 efps (16ms)	+1ms (-/-%)	✅
article (string inside object)	25.6 efps (39ms)	29.4 efps (34ms)	-5ms (-12.8%)	✅
article (string inside array)	25.3 efps (40ms)	25.0 efps (40ms)	+1ms (+1.3%)	✅
recipe (name)	47.6 efps (21ms)	62.5 efps (16ms)	-5ms (-23.8%)	✅
recipe (description)	55.6 efps (18ms)	62.5 efps (16ms)	-2ms (-11.1%)	✅
recipe (instructions)	99.9+ efps (5ms)	99.9+ efps (5ms)	+0ms (-/-%)	✅
synthetic (title)	19.2 efps (52ms)	21.3 efps (47ms)	-5ms (-9.6%)	✅
synthetic (string inside object)	18.9 efps (53ms)	19.8 efps (51ms)	-3ms (-4.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)	40ms	51ms	71ms	520ms	916ms	10.9s
article (body)	15ms	16ms	20ms	188ms	202ms	5.4s
article (string inside object)	39ms	42ms	45ms	136ms	177ms	6.7s
article (string inside array)	40ms	42ms	48ms	174ms	150ms	6.7s
recipe (name)	21ms	24ms	28ms	47ms	0ms	7.0s
recipe (description)	18ms	19ms	21ms	39ms	0ms	4.6s
recipe (instructions)	5ms	7ms	8ms	19ms	0ms	3.0s
synthetic (title)	52ms	54ms	58ms	97ms	488ms	12.3s
synthetic (string inside object)	53ms	55ms	64ms	459ms	1176ms	8.6s

🧪 Experiment result

The performance result of this branch

Benchmark	latency	p75	p90	p99	blocking time	test duration
article (title)	36ms	45ms	65ms	498ms	828ms	10.6s
article (body)	16ms	19ms	27ms	169ms	238ms	5.4s
article (string inside object)	34ms	37ms	40ms	177ms	171ms	7.1s
article (string inside array)	40ms	43ms	48ms	174ms	185ms	6.8s
recipe (name)	16ms	19ms	21ms	37ms	0ms	6.7s
recipe (description)	16ms	17ms	20ms	36ms	0ms	4.5s
recipe (instructions)	5ms	7ms	7ms	10ms	0ms	3.1s
synthetic (title)	47ms	48ms	52ms	81ms	317ms	12.8s
synthetic (string inside object)	51ms	53ms	64ms	400ms	1302ms	8.9s

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

jordanl17 · 2025-01-14T10:19:55Z

packages/sanity/src/core/releases/hooks/__tests__/useDocumentVersions.test.tsx

This test change isn't entirely relevant to the task at hand, but I came across it and thought it would be good to try and move as quickly as possible to using the release fixtures everywhere

jordanl17 · 2025-01-14T10:20:43Z

packages/sanity/src/core/releases/store/createReleaseMetadataAggregator.ts

Removing existingDocumentsCount from the store record

RitaDias · 2025-01-16T08:02:17Z

packages/sanity/src/core/releases/tool/overview/columnCells/ReleaseDocumentsCounter.tsx

+    return (
+      <Translate
+        t={t}
+        i18nKey={documentCount > 1 ? `document-count_other` : `document-count_one`}


our i18n tool actually handles these causes automatically, as far as I know you shouldn't need to do this :)
You need to send in the count like this (example on our code base, translation with count, use in component)

Oh well that's quite nice! There are a few other places I've done this (the wrong) thing. I'll remember to go back and update them.

Thanks for flagging. However clever of them!

RitaDias

This looks great to me!
I guess the only thing would be about the translation key but otherwise everything looks good to go. My question is: are we going to add the separation of document changes (added, modified, deleted etc) at a later point or is that something that was dropped for now?

RitaDias · 2025-01-16T08:05:36Z

Also, from a design stand point I really don't like how the numbers and text split the line, do we have to have the "documents" text there? :( Can't we add the header with the information that we are showing the count?

jordanl17 · 2025-01-16T14:00:26Z

This looks great to me! I guess the only thing would be about the translation key but otherwise everything looks good to go. My question is: are we going to add the separation of document changes (added, modified, deleted etc) at a later point or is that something that was dropped for now?

That's been dropped now. The document action will only be present on release dashboard lists, but since this requires some backend work in places to make performant, we aren't going to touch it until a later date.

jordanl17 · 2025-01-16T14:03:10Z

Also, from a design stand point I really don't like how the numbers and text split the line, do we have to have the "documents" text there? :( Can't we add the header with the information that we are showing the count?

Valid concern. I've sort of designed this interpolating between a few different versions of prototype we've had. I'll note for Marius to look over this retrospectively

vercel bot deployed to Preview – performance-studio January 10, 2025 03:11 View deployment

vercel bot deployed to Preview – page-building-studio January 10, 2025 03:11 View deployment

vercel bot deployed to Preview – test-studio January 10, 2025 03:12 View deployment

jordanl17 force-pushed the corel-292-total-overview-count branch from aac22cd to b8f3e20 Compare January 10, 2025 10:46

vercel bot deployed to Preview – performance-studio January 10, 2025 10:47 View deployment

vercel bot deployed to Preview – page-building-studio January 10, 2025 10:47 View deployment

vercel bot deployed to Preview – test-studio January 10, 2025 10:47 View deployment

vercel bot deployed to Preview – page-building-studio January 10, 2025 14:59 View deployment

vercel bot deployed to Preview – performance-studio January 10, 2025 14:59 View deployment

vercel bot deployed to Preview – test-studio January 10, 2025 15:00 View deployment

vercel bot deployed to Preview – performance-studio January 10, 2025 15:34 View deployment

vercel bot deployed to Preview – page-building-studio January 10, 2025 15:34 View deployment

vercel bot deployed to Preview – test-studio January 10, 2025 15:35 View deployment

vercel bot deployed to Preview – performance-studio January 10, 2025 16:04 View deployment

vercel bot deployed to Preview – page-building-studio January 10, 2025 16:04 View deployment

vercel bot deployed to Preview – test-studio January 10, 2025 16:06 View deployment

jordanl17 marked this pull request as ready for review January 10, 2025 16:19

jordanl17 requested a review from a team as a code owner January 10, 2025 16:19

jordanl17 requested review from rexxars, bjoerge, RitaDias and pedrobonamin and removed request for a team, rexxars, bjoerge and RitaDias January 10, 2025 16:19

jordanl17 requested review from bjoerge, pedrobonamin and RitaDias January 13, 2025 20:35

jordanl17 commented Jan 14, 2025

View reviewed changes

jordanl17 requested a review from juice49 January 14, 2025 13:30

jordanl17 added 7 commits January 15, 2025 10:56

feat: releases overview shows total docs in release for open releases

06330cd

feat: showing document count for archived releases

d4d3313

test: tests for some release overview cells

f1b559d

test: tests for some release overview cells

b9a21d4

refactor: removing existing document count from metadata aggregator

f3f79b4

test: using release fixture inside useDocumentVersions tests

c297e63

fix: resolving ui-components issue

b6efb20

jordanl17 force-pushed the corel-292-total-overview-count branch from 9045cb8 to b6efb20 Compare January 15, 2025 10:56

vercel bot deployed to Preview – performance-studio January 15, 2025 11:24 View deployment

vercel bot deployed to Preview – page-building-studio January 15, 2025 11:25 View deployment

vercel bot deployed to Preview – test-studio January 15, 2025 11:25 View deployment

RitaDias reviewed Jan 16, 2025

View reviewed changes

RitaDias requested changes Jan 16, 2025

View reviewed changes

refactor: using i18n's built in puluraliser

ddb5b71

jordanl17 requested a review from RitaDias January 16, 2025 14:03

RitaDias approved these changes Jan 16, 2025

View reviewed changes

vercel bot deployed to Preview – page-building-studio January 16, 2025 14:08 View deployment

vercel bot deployed to Preview – performance-studio January 16, 2025 14:09 View deployment

vercel bot deployed to Preview – test-studio January 16, 2025 14:10 View deployment

jordanl17 merged commit da1979a into corel Jan 16, 2025
54 of 55 checks passed

jordanl17 deleted the corel-292-total-overview-count branch January 16, 2025 14:18

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: releases overview shows total docs in release #8232

feat: releases overview shows total docs in release #8232

jordanl17 commented Jan 10, 2025 •

edited

Loading

vercel bot commented Jan 10, 2025 •

edited

Loading

github-actions bot commented Jan 10, 2025

github-actions bot commented Jan 10, 2025 •

edited

Loading

github-actions bot commented Jan 10, 2025 •

edited

Loading

🏠 Reference result

🧪 Experiment result

📚 Glossary

column definitions

jordanl17 Jan 14, 2025

jordanl17 Jan 14, 2025

RitaDias Jan 16, 2025

jordanl17 Jan 16, 2025

RitaDias left a comment

RitaDias commented Jan 16, 2025

jordanl17 commented Jan 16, 2025

jordanl17 commented Jan 16, 2025

feat: releases overview shows total docs in release #8232

feat: releases overview shows total docs in release #8232

Conversation

jordanl17 commented Jan 10, 2025 • edited Loading

Description

What to review

Testing

Notes for release

vercel bot commented Jan 10, 2025 • edited Loading

github-actions bot commented Jan 10, 2025

github-actions bot commented Jan 10, 2025 • edited Loading

github-actions bot commented Jan 10, 2025 • edited Loading

⚡️ Editor Performance Report

🏠 Reference result

🧪 Experiment result

📚 Glossary

column definitions

jordanl17 Jan 14, 2025

Choose a reason for hiding this comment

jordanl17 Jan 14, 2025

Choose a reason for hiding this comment

RitaDias Jan 16, 2025

Choose a reason for hiding this comment

jordanl17 Jan 16, 2025

Choose a reason for hiding this comment

RitaDias left a comment

Choose a reason for hiding this comment

RitaDias commented Jan 16, 2025

jordanl17 commented Jan 16, 2025

jordanl17 commented Jan 16, 2025

jordanl17 commented Jan 10, 2025 •

edited

Loading

vercel bot commented Jan 10, 2025 •

edited

Loading

github-actions bot commented Jan 10, 2025 •

edited

Loading

github-actions bot commented Jan 10, 2025 •

edited

Loading