feat(cli): add test-template for testing `--template` flag #7877

RostiMelk · 2024-11-25T14:48:57Z

Description

Added a test template in the cli/test directory solely for the purpose of testing the init --template command when using remote templates.

The template added is a fork of the officially maintained template at:
https://github.com/vercel/next.js/tree/canary/examples/cms-sanity

This PR needs to be merged in order for #7867 to pass its tests

What to review

Is this causing too much bloat to the package? Should we slim the template down?

Testing

N/A

Notes for release

No notes

vercel · 2024-11-25T14:49:02Z

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 25, 2024 3:47pm
performance-studio	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Nov 25, 2024 3:47pm
test-next-studio	🛑 Canceled (Inspect)			Nov 25, 2024 3:47pm
test-studio	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Nov 25, 2024 3:47pm

1 Skipped Deployment

Name	Status	Preview	Comments	Updated (UTC)
studio-workshop	⬜️ Ignored (Inspect)	Visit Preview		Nov 25, 2024 3:47pm

socket-security · 2024-11-25T14:50:09Z

New dependencies detected. Learn more about Socket for GitHub ↗︎

Package	New capabilities	Transitives	Size	Publisher
npm/@sanity/[email protected]	None	`+6`	4.99 MB	ash
npm/@tailwindcss/[email protected]	None	`+2`	298 kB	adamwathan
npm/@vercel/[email protected]	None	`0`	285 kB	vercel-release-bot
npm/[email protected]	environment	`+1`	285 kB	ai
npm/[email protected]	None	`0`	22.6 MB	kossnocorp
npm/[email protected]	unsafe Transitive: environment, filesystem	`+27`	14 MB	vercel-release-bot
npm/[email protected]	environment Transitive: filesystem, network	`+49`	38.1 MB	sanity-io
npm/[email protected]	Transitive: environment, filesystem, network	`+50`	38.8 MB	sanity-io
npm/[email protected]	None	`0`	611 B	sebmarkbage
npm/[email protected]	Transitive: environment, filesystem, network, shell, unsafe	`+25`	9.56 MB	adamwathan, malfaitrobin, reinink

View full report↗︎

github-actions · 2024-11-25T14:53:34Z

No changes to documentation

github-actions · 2024-11-25T14:58:56Z

Component Testing Report Updated Nov 25, 2024 3:37 PM (UTC)

✅ All Tests Passed -- expand for details

File	Status	Duration	Passed	Skipped
comments/CommentInput.spec.tsx	✅ Passed (Inspect)	45s	15	0
formBuilder/ArrayInput.spec.tsx	✅ Passed (Inspect)	9s	3	0
formBuilder/inputs/PortableText/Annotations.spec.tsx	✅ Passed (Inspect)	31s	6	0
formBuilder/inputs/PortableText/copyPaste/CopyPaste.spec.tsx	✅ Passed (Inspect)	39s	11	7
formBuilder/inputs/PortableText/copyPaste/CopyPasteFields.spec.tsx	✅ Passed (Inspect)	0s	0	12
formBuilder/inputs/PortableText/Decorators.spec.tsx	✅ Passed (Inspect)	18s	6	0
formBuilder/inputs/PortableText/DisableFocusAndUnset.spec.tsx	✅ Passed (Inspect)	11s	3	0
formBuilder/inputs/PortableText/DragAndDrop.spec.tsx	✅ Passed (Inspect)	2m 33s	1	0
formBuilder/inputs/PortableText/FocusTracking.spec.tsx	✅ Passed (Inspect)	45s	15	0
formBuilder/inputs/PortableText/Input.spec.tsx	✅ Passed (Inspect)	1m 43s	21	0
formBuilder/inputs/PortableText/ObjectBlock.spec.tsx	✅ Passed (Inspect)	1m 19s	18	0
formBuilder/inputs/PortableText/PresenceCursors.spec.tsx	✅ Passed (Inspect)	9s	3	9
formBuilder/inputs/PortableText/RangeDecoration.spec.tsx	✅ Passed (Inspect)	27s	9	0
formBuilder/inputs/PortableText/Styles.spec.tsx	✅ Passed (Inspect)	19s	6	0
formBuilder/inputs/PortableText/Toolbar.spec.tsx	✅ Passed (Inspect)	37s	12	0
formBuilder/tree-editing/TreeEditing.spec.tsx	✅ Passed (Inspect)	0s	0	3
formBuilder/tree-editing/TreeEditingNestedObjects.spec.tsx	✅ Passed (Inspect)	0s	0	3

github-actions · 2024-11-25T15:01:18Z

⚡️ Editor Performance Report

Updated Mon, 25 Nov 2024 15:39:44 GMT

Benchmark	reference ^{latency of sanity@latest}	experiment ^{latency of this branch}	Δ (%) ^{latency difference}
article (title)	15.4 efps (65ms)	21.5 efps (47ms)	-19ms (-28.5%)	✅
article (body)	60.2 efps (17ms)	59.9 efps (17ms)	+0ms (+0.6%)	✅
article (string inside object)	17.5 efps (57ms)	24.7 efps (41ms)	-17ms (-28.9%)	✅
article (string inside array)	15.6 efps (64ms)	21.3 efps (47ms)	-17ms (-26.6%)	✅
recipe (name)	29.9 efps (34ms)	50.0 efps (20ms)	-14ms (-40.3%)	✅
recipe (description)	34.5 efps (29ms)	55.6 efps (18ms)	-11ms (-37.9%)	✅
recipe (instructions)	99.9+ efps (6ms)	99.9+ efps (6ms)	+0ms (-/-%)	✅
synthetic (title)	14.9 efps (67ms)	18.9 efps (53ms)	-14ms (-20.9%)	✅
synthetic (string inside object)	14.5 efps (69ms)	20.4 efps (49ms)	-20ms (-29.0%)	✅

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)	65ms	68ms	77ms	293ms	760ms	14.4s
article (body)	17ms	20ms	38ms	138ms	346ms	5.8s
article (string inside object)	57ms	61ms	68ms	181ms	498ms	8.7s
article (string inside array)	64ms	68ms	81ms	335ms	849ms	9.7s
recipe (name)	34ms	36ms	47ms	67ms	0ms	10.5s
recipe (description)	29ms	31ms	32ms	62ms	0ms	5.7s
recipe (instructions)	6ms	8ms	9ms	10ms	0ms	3.2s
synthetic (title)	67ms	71ms	81ms	381ms	1440ms	15.9s
synthetic (string inside object)	69ms	79ms	86ms	580ms	1419ms	10.9s

🧪 Experiment result

The performance result of this branch

Benchmark	latency	p75	p90	p99	blocking time	test duration
article (title)	47ms	52ms	59ms	194ms	351ms	12.4s
article (body)	17ms	18ms	33ms	173ms	230ms	5.6s
article (string inside object)	41ms	44ms	49ms	244ms	422ms	7.4s
article (string inside array)	47ms	50ms	60ms	175ms	156ms	7.7s
recipe (name)	20ms	23ms	25ms	42ms	0ms	7.6s
recipe (description)	18ms	20ms	21ms	36ms	0ms	4.6s
recipe (instructions)	6ms	9ms	10ms	16ms	0ms	3.2s
synthetic (title)	53ms	57ms	67ms	310ms	725ms	13.3s
synthetic (string inside object)	49ms	51ms	61ms	287ms	105ms	7.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.

RostiMelk added 2 commits November 25, 2024 15:35

fix: remove trailing commas when sanitizing

62e862d

feat: test-template

eebc106

RostiMelk requested a review from a team as a code owner November 25, 2024 14:48

RostiMelk requested review from jordanl17 and removed request for a team November 25, 2024 14:48

feat: bad rebase maybe

72c1f3d

vercel bot deployed to Preview – performance-studio November 25, 2024 14:58 View deployment

vercel bot deployed to Preview – page-building-studio November 25, 2024 14:59 View deployment

vercel bot deployed to Preview – test-studio November 25, 2024 15:02 View deployment

RostiMelk added 4 commits November 25, 2024 16:14

add /test/test-template to eslintignore

f439511

feat: prettier template

3c4144a

feat: prettier ignore

f4915f0

feat: try again

3d9d9fe

vercel bot deployed to Preview – page-building-studio November 25, 2024 15:34 View deployment

vercel bot deployed to Preview – performance-studio November 25, 2024 15:35 View deployment

vercel bot deployed to Preview – test-studio November 25, 2024 15:37 View deployment

vercel bot deployed to Preview – test-next-studio November 25, 2024 15:47 View deployment

RostiMelk changed the title ~~feat: add test-template for testing --template flag~~ feat(cli): add test-template for testing --template flag Nov 27, 2024

RostiMelk requested a review from a team November 27, 2024 12:00

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(cli): add test-template for testing `--template` flag #7877

feat(cli): add test-template for testing `--template` flag #7877

RostiMelk commented Nov 25, 2024 •

edited

Loading

vercel bot commented Nov 25, 2024 •

edited

Loading

socket-security bot commented Nov 25, 2024 •

edited

Loading

github-actions bot commented Nov 25, 2024

github-actions bot commented Nov 25, 2024 •

edited

Loading

github-actions bot commented Nov 25, 2024 •

edited

Loading

🏠 Reference result

🧪 Experiment result

📚 Glossary

column definitions

feat(cli): add test-template for testing --template flag #7877

Are you sure you want to change the base?

feat(cli): add test-template for testing --template flag #7877

Conversation

RostiMelk commented Nov 25, 2024 • edited Loading

Description

What to review

Testing

Notes for release

vercel bot commented Nov 25, 2024 • edited Loading

socket-security bot commented Nov 25, 2024 • edited Loading

github-actions bot commented Nov 25, 2024

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

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

⚡️ Editor Performance Report

🏠 Reference result

🧪 Experiment result

📚 Glossary

column definitions

feat(cli): add test-template for testing `--template` flag #7877

feat(cli): add test-template for testing `--template` flag #7877

RostiMelk commented Nov 25, 2024 •

edited

Loading

vercel bot commented Nov 25, 2024 •

edited

Loading

socket-security bot commented Nov 25, 2024 •

edited

Loading

github-actions bot commented Nov 25, 2024 •

edited

Loading

github-actions bot commented Nov 25, 2024 •

edited

Loading