feat: Request Edit Access flow #7546
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
1 Skipped Deployment
|
|
No changes to documentation |
|
Component Testing Report Updated Oct 1, 2024 5:11 PM (UTC) ✅ All Tests Passed -- expand for details
|
pedrobonamin
previously approved these changes
Oct 1, 2024
pedrobonamin
previously approved these changes
Oct 1, 2024
rexxars
requested changes
Oct 1, 2024
| const [isSubmitting, setIsSubmitting] = useState(false) | ||
|
|
||
| const [note, setNote] = useState('') | ||
| const [noteLength, setNoteLength] = useState<number>(0) |
There was a problem hiding this comment.
Nitpick, but couldn't this be derived from note.length?
Comment on lines
+37
to
+39
| * A confirmation dialog used to prevent unwanted document deletes. Loads all | ||
| * the referencing internal and cross-data references prior to showing the | ||
| * delete button. |
| const [hasTooManyRequests, setHasTooManyRequests] = useState<boolean>(false) | ||
| const [hasBeenDenied, setHasBeenDenied] = useState<boolean>(false) | ||
|
|
||
| const requestedRole$: Observable<'administrator' | 'editor'> = useMemo(() => { |
There was a problem hiding this comment.
Is there always an administrator role, even when using custom roles/role mapping? Or do we assume that if the customer has a viewer role they are using default roles and it shouldn't matter?
There was a problem hiding this comment.
Second one is our inference
| import {defineEvent} from '@sanity/telemetry' | ||
|
|
||
| /** | ||
| * When a draft in a live edit document is published |
...ucture/components/requestPermissionDialog/__telemetry__/RequestPermissionDialog.telemetry.ts
Show resolved
Hide resolved
| /** The pending text for the request permission button that appears for viewer roles */ | ||
| 'banners.permission-check-banner.request-permission-button.sent': 'Editor request sent', | ||
| /** The text for the request permission button that appears for viewer roles */ | ||
| 'banners.permission-check-banner.request-permission-button.text': 'Ask to edit', |
There was a problem hiding this comment.
We technically call it requesting ("Send request"), but tell users to ask. I assume this is already thought through, just wanted calling it out as I saw it.
packages/sanity/src/structure/panes/document/documentPanel/banners/PermissionCheckBanner.tsx
Outdated
Show resolved
Hide resolved
packages/sanity/src/structure/panes/document/documentPanel/banners/PermissionCheckBanner.tsx
Outdated
Show resolved
Hide resolved
rexxars
approved these changes
Oct 1, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR introduces a new "Request Edit Access" feature into the studio that allows users to make a request for a role change from Viewer to Editor/Administrator (depending on the project's available roles).
What to review
There are 2 main areas of the Studio that are touched/introduced with this PR:
PermissionCheckBannerand..RequestPermissionDialogPermissionCheckBannerThis banner has been updated to show an "Ask to edit" button in the action area if the user is ONLY a Viewer.
RequestPermissionDialogThis is where most of the code is introduced. This new Dialog works very similarly to the
RequestAccessScreenwith some changes to the request logic, error handling, and POST params.Testing
This PR introduces no new automated tests.
Notes for release
This new "Request Edit Access" feature will be available to all users - with administrators being able to Approve/Deny requests in the Requests tab in Manage.