feat: adds the ability to lock documents while they are being edited #7970
Conversation
This file contains hidden or 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
…t/beta/locked-document
…t/beta/locked-document
…t/beta/locked-document
…t/beta/locked-document
…t/beta/locked-document
…t/beta/locked-document
…t/beta/locked-document
…t/beta/locked-document
…t/beta/locked-document
…t/beta/locked-document
…t/beta/locked-document
…t/beta/locked-document
…t/beta/locked-document
…t/beta/locked-document
PatrikKozak
changed the title
…t/beta/locked-document
…t/beta/locked-document
…t/beta/locked-document
…t/beta/locked-document
…t/beta/locked-document
…t/beta/locked-document
…t/beta/locked-document
DanRibbens
reviewed
Sep 17, 2024
| } | ||
| } catch (error) { | ||
| // eslint-disable-next-line no-console | ||
| console.error('Failed to unlock the document', error) |
There was a problem hiding this comment.
Shouldn't we have a toast.error?
| } | ||
| } catch (error) { | ||
| // eslint-disable-next-line no-console | ||
| console.error('Failed to update the document editor', error) |
| } | ||
|
|
||
| return result | ||
| if (returnLockStatus && req.user && (id || globalSlug)) { |
There was a problem hiding this comment.
Should there also be another condition in the if condition to prevent this block when locking isn't enabled for the collection/global?
| } | ||
| } | ||
|
|
||
| if (lockedDocumentQuery) { |
There was a problem hiding this comment.
This should really be it's own function that returns the lockStatus. Can always refactor later.
|
🚀 This is included in version v3.0.0-beta.108 |
|
Just my 2 cents. I am wondering why you didnt opt for optimistic locking which is far more scalable and less problematic on the database. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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
Adds a new property to
collection/globalconfigs calledlockDocuments.Set to
trueby default - the lock is automatically triggered when a user begins editing a document within the Admin Panel and remains in place until the user exits the editing view or the lock expires due to inactivity.Set to
falseto disable document locking entirely - i.e.lockDocuments: falseYou can pass an object to this property to configure the
durationin seconds, which defines how long the document remains locked without user interaction. If no edits are made within the specified time (default: 300 seconds), the lock expires, allowing other users to edit / update or delete the document.Type of change
Checklist: