fix(core): disable scheduledPublishing and tasks if `/features` returns error #7517

pedrobonamin · 2024-09-17T12:11:10Z

Description

Some users have reported that they see the upsell ui even though the feature is enabled for the project.
That is due to the features api returning an error if the user doesn't have the right permissions to query it.

This PR adds the same check for scheduledPublishing and tasks plugins.
In comments we are currently doing that check here https://github.com/sanity-io/sanity/blob/edx-1599/packages/sanity/src/core/comments/hooks/useResolveCommentsEnabled.ts#L42-L43

What to review

Are this changes ok?

Testing

New tests have been introduced to guard this behavior.

Notes for release

Disable schedule publishing and tasks plugin if user doesn't have the right access.

vercel · 2024-09-17T12:11:14Z

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	Oct 22, 2024 9:16am
performance-studio	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 22, 2024 9:16am
test-compiled-studio	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 22, 2024 9:16am
test-next-studio	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 22, 2024 9:16am
test-studio	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 22, 2024 9:16am

1 Skipped Deployment

Name	Status	Preview	Comments	Updated (UTC)
studio-workshop	⬜️ Ignored (Inspect)	Visit Preview		Oct 22, 2024 9:16am

github-actions · 2024-09-17T12:14:27Z

No changes to documentation

github-actions · 2024-09-17T12:26:46Z

Component Testing Report Updated Oct 22, 2024 9:09 AM (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)	38s	11	7
formBuilder/inputs/PortableText/copyPaste/CopyPasteFields.spec.tsx	✅ Passed (Inspect)	0s	0	12
formBuilder/inputs/PortableText/Decorators.spec.tsx	✅ Passed (Inspect)	17s	6	0
formBuilder/inputs/PortableText/DisableFocusAndUnset.spec.tsx	✅ Passed (Inspect)	11s	3	0
formBuilder/inputs/PortableText/DragAndDrop.spec.tsx	✅ Passed (Inspect)	3m 0s	0	0
formBuilder/inputs/PortableText/FocusTracking.spec.tsx	✅ Passed (Inspect)	46s	15	0
formBuilder/inputs/PortableText/Input.spec.tsx	✅ Passed (Inspect)	1m 41s	21	0
formBuilder/inputs/PortableText/ObjectBlock.spec.tsx	✅ Passed (Inspect)	1m 17s	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)	18s	6	0
formBuilder/inputs/PortableText/Toolbar.spec.tsx	✅ Passed (Inspect)	36s	12	0
formBuilder/tree-editing/TreeEditing.spec.tsx	✅ Passed (Inspect)	0s	0	3
formBuilder/tree-editing/TreeEditingNestedObjects.spec.tsx	✅ Passed (Inspect)	0s	0	3

pedrobonamin · 2024-09-17T15:25:14Z

packages/sanity/src/core/scheduledPublishing/tool/Tool.tsx

+      <Container width={1} paddingTop={4}>
+        <Box paddingTop={4} paddingX={4}>
+          <ErrorCallout
+            description="You do not have permission to edit schedules."


ℹ️ We don't have translations in scheduledPublishing
Instead of showing the same error that we show when the request fails we add an specific not enabled error.

Current error

Updated error

rexxars

Thanks for raising this! I've made changes to the backend API to avoid needing more permissions to read features, but this will still be nice for other errors.

…api returns error

pedrobonamin · 2024-10-22T07:24:03Z

Thanks for raising this! I've made changes to the backend API to avoid needing more permissions to read features, but this will still be nice for other errors.

Thanks for reviewing @rexxars

So I think it would be better in this case to update the message to this

-            description="You do not have permission to edit schedules."
+            description="Something went wrong loading permissions, please try again."
-            title="Insufficient permissions"
+            title="Permissions check failed"

github-actions · 2024-10-22T07:33:11Z

⚡️ Editor Performance Report

Updated Tue, 22 Oct 2024 09:11:38 GMT

Benchmark	reference ^{latency of sanity@latest}	experiment ^{latency of this branch}	Δ (%) ^{latency difference}
article (title)	16.5 efps (61ms)	16.4 efps (61ms)	+1ms (+0.8%)	✅
article (body)	59.5 efps (17ms)	56.5 efps (18ms)	+1ms (+5.4%)	✅
article (string inside object)	17.5 efps (57ms)	19.2 efps (52ms)	-5ms (-8.8%)	✅
article (string inside array)	14.1 efps (71ms)	14.9 efps (67ms)	-4ms (-5.6%)	✅
recipe (name)	29.4 efps (34ms)	30.3 efps (33ms)	-1ms (-2.9%)	✅
recipe (description)	33.3 efps (30ms)	34.5 efps (29ms)	-1ms (-3.3%)	✅
recipe (instructions)	99.9+ efps (6ms)	99.9+ efps (6ms)	+0ms (-/-%)	✅
synthetic (title)	15.9 efps (63ms)	15.9 efps (63ms)	+0ms (-/-%)	✅
synthetic (string inside object)	15.5 efps (65ms)	16.1 efps (62ms)	-3ms (-3.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)	61ms	64ms	76ms	250ms	440ms	13.9s
article (body)	17ms	19ms	26ms	136ms	340ms	5.7s
article (string inside object)	57ms	58ms	61ms	67ms	80ms	8.0s
article (string inside array)	71ms	77ms	88ms	272ms	1189ms	10.0s
recipe (name)	34ms	37ms	51ms	88ms	1ms	9.1s
recipe (description)	30ms	31ms	33ms	62ms	0ms	6.0s
recipe (instructions)	6ms	9ms	9ms	22ms	0ms	3.4s
synthetic (title)	63ms	66ms	71ms	95ms	688ms	12.6s
synthetic (string inside object)	65ms	68ms	76ms	409ms	802ms	16.3s

🧪 Experiment result

The performance result of this branch

Benchmark	latency	p75	p90	p99	blocking time	test duration
article (title)	61ms	65ms	84ms	131ms	334ms	14.4s
article (body)	18ms	20ms	23ms	145ms	180ms	5.8s
article (string inside object)	52ms	55ms	64ms	238ms	292ms	8.5s
article (string inside array)	67ms	72ms	82ms	223ms	935ms	9.6s
recipe (name)	33ms	37ms	46ms	82ms	21ms	9.3s
recipe (description)	29ms	32ms	37ms	60ms	4ms	6.2s
recipe (instructions)	6ms	9ms	9ms	13ms	0ms	3.2s
synthetic (title)	63ms	72ms	87ms	267ms	1560ms	15.9s
synthetic (string inside object)	62ms	68ms	75ms	455ms	1586ms	9.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.

…iders

* next: test(sanity): update timeout to avoid slow test from being flaky (#7969) v3.66.1 fix(deps): update dependency @sanity/presentation to v1.19.7 (#7966) fix(core): guard against missing process variable (#7967) fix(sanity): reset search cursor state when any parameter changes (#7889) fix(deps): allow react v19 as peer dependency (#7962) v3.66.0 fix: reword warning about vector images not support crop/hotspot (#7960) fix(deps): Update dev-non-major (#7959) fix(core): add telemetry debug/noop logger (#7958) fix(deps): update dependency @sanity/presentation to v1.19.5 (#7957) fix(core): only open one annotation object edit modal at a time (#7898) fix(cli): remove v2 commands (#5750) feat(cli): generate read token conditionally for remote template (#7953) fix(deps): update dependency @sanity/mutate to ^0.11.1 (#7903) fix(deps): update dependency @sanity/ui to ^2.9.1 (#7948) feat(vision): link to edit documents on `_id`, `_ref` attributes (#6124) fix(core): disable scheduledPublishing and tasks if `/features` returns error (#7517) test(e2e): restore last e2e tests (#7926)

pedrobonamin requested review from a team and rexxars and removed request for a team September 17, 2024 12:11

pedrobonamin changed the title ~~fix(core): disable scheduledPublishing and tasks plugins if features returns error~~ fix(core): disable scheduledPublishing and tasks plugins if /features returns error Sep 17, 2024

pedrobonamin changed the title ~~fix(core): disable scheduledPublishing and tasks plugins if /features returns error~~ fix(core): disable scheduledPublishing and tasks if /features returns error Sep 17, 2024

vercel bot deployed to Preview – page-building-studio September 17, 2024 12:22 View deployment

vercel bot deployed to Preview – performance-studio September 17, 2024 12:22 View deployment

vercel bot deployed to Preview – test-studio September 17, 2024 12:24 View deployment

vercel bot deployed to Preview – test-next-studio September 17, 2024 12:27 View deployment

vercel bot deployed to Preview – test-compiled-studio September 17, 2024 12:29 View deployment

vercel bot deployed to Preview – page-building-studio September 17, 2024 15:24 View deployment

vercel bot deployed to Preview – performance-studio September 17, 2024 15:24 View deployment

vercel bot deployed to Preview – test-studio September 17, 2024 15:24 View deployment

pedrobonamin commented Sep 17, 2024

View reviewed changes

vercel bot deployed to Preview – test-next-studio September 17, 2024 15:29 View deployment

vercel bot deployed to Preview – test-compiled-studio September 17, 2024 15:32 View deployment

pedrobonamin requested a review from a team September 17, 2024 15:32

ricokahler force-pushed the next branch from f1f9c51 to 92de3d9 Compare October 4, 2024 20:16

rexxars reviewed Oct 21, 2024

View reviewed changes

pedrobonamin added 3 commits October 22, 2024 09:23

fix(core): disable scheduledPublishing and tasks plugins if features …

97f0755

…api returns error

chore(core): add no permissions message to scheduledPublishing tool

a900a37

fix(core): update schedule publishing permissions error message

dba6a31

pedrobonamin force-pushed the edx-1599 branch from acadbd8 to dba6a31 Compare October 22, 2024 07:23

vercel bot deployed to Preview – performance-studio October 22, 2024 07:27 View deployment

vercel bot deployed to Preview – page-building-studio October 22, 2024 07:27 View deployment

vercel bot deployed to Preview – test-studio October 22, 2024 07:28 View deployment

vercel bot deployed to Preview – test-next-studio October 22, 2024 07:31 View deployment

vercel bot deployed to Preview – test-compiled-studio October 22, 2024 07:35 View deployment

fix(core): update tests imports - tasks and scheduled publishing prov…

ed39607

…iders

vercel bot deployed to Preview – performance-studio October 22, 2024 09:00 View deployment

vercel bot deployed to Preview – page-building-studio October 22, 2024 09:00 View deployment

pedrobonamin force-pushed the edx-1599 branch from 321ddc2 to ed39607 Compare October 22, 2024 09:00

vercel bot deployed to Preview – performance-studio October 22, 2024 09:04 View deployment

vercel bot deployed to Preview – page-building-studio October 22, 2024 09:04 View deployment

vercel bot deployed to Preview – test-studio October 22, 2024 09:04 View deployment

vercel bot deployed to Preview – test-next-studio October 22, 2024 09:13 View deployment

vercel bot deployed to Preview – test-compiled-studio October 22, 2024 09:16 View deployment

pedrobonamin requested a review from rexxars October 22, 2024 12:16

juice49 requested a review from a team as a code owner November 22, 2024 11:56

rexxars approved these changes Dec 4, 2024

View reviewed changes

rexxars merged commit a20fb8f into next Dec 4, 2024
67 checks passed

rexxars deleted the edx-1599 branch December 4, 2024 23:25

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(core): disable scheduledPublishing and tasks if `/features` returns error #7517

fix(core): disable scheduledPublishing and tasks if `/features` returns error #7517

pedrobonamin commented Sep 17, 2024

vercel bot commented Sep 17, 2024 •

edited

Loading

github-actions bot commented Sep 17, 2024

github-actions bot commented Sep 17, 2024 •

edited

Loading

pedrobonamin Sep 17, 2024 •

edited

Loading

rexxars left a comment

pedrobonamin commented Oct 22, 2024

github-actions bot commented Oct 22, 2024 •

edited

Loading

🏠 Reference result

🧪 Experiment result

📚 Glossary

column definitions

fix(core): disable scheduledPublishing and tasks if /features returns error #7517

fix(core): disable scheduledPublishing and tasks if /features returns error #7517

Conversation

pedrobonamin commented Sep 17, 2024

Description

What to review

Testing

Notes for release

vercel bot commented Sep 17, 2024 • edited Loading

github-actions bot commented Sep 17, 2024

github-actions bot commented Sep 17, 2024 • edited Loading

pedrobonamin Sep 17, 2024 • edited Loading

Choose a reason for hiding this comment

rexxars left a comment

Choose a reason for hiding this comment

pedrobonamin commented Oct 22, 2024

github-actions bot commented Oct 22, 2024 • edited Loading

⚡️ Editor Performance Report

🏠 Reference result

🧪 Experiment result

📚 Glossary

column definitions

fix(core): disable scheduledPublishing and tasks if `/features` returns error #7517

fix(core): disable scheduledPublishing and tasks if `/features` returns error #7517

vercel bot commented Sep 17, 2024 •

edited

Loading

github-actions bot commented Sep 17, 2024 •

edited

Loading

pedrobonamin Sep 17, 2024 •

edited

Loading

github-actions bot commented Oct 22, 2024 •

edited

Loading