CARDS-2514: New "locking" module, with basic locking feature #1756
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
|
Improved UI so it updates subject data whenever the locking dialog is completed Locking3.mp4 |
sdumitriu
reviewed
Apr 18, 2024
modules/locking/src/main/java/io/uhndata/cards/locking/LockServlet.java
Outdated
Show resolved
Hide resolved
modules/data-entry/src/main/frontend/src/questionnaire/Subject.jsx
Outdated
Show resolved
Hide resolved
modules/data-entry/src/main/frontend/src/questionnaire/Subject.jsx
Outdated
Show resolved
Hide resolved
marta-
reviewed
Apr 18, 2024
modules/data-entry/src/main/frontend/src/dataHomepage/LockButton.jsx
Outdated
Show resolved
Hide resolved
|
Updated lock and unlock dialogs: Changed HTTP method from POST to LOCK and UNLOCK |
sdumitriu
reviewed
Apr 19, 2024
acrowthe
commented
Apr 24, 2024
modules/locking/src/main/java/io/uhndata/cards/locking/LockServlet.java
Outdated
Show resolved
Hide resolved
| final VersionManager versionManager = session.getWorkspace().getVersionManager(); | ||
|
|
||
| final Node requestNode = request.getResource().adaptTo(Node.class); | ||
| // TODO: check if user has permission to lock and unlock the request node |
There was a problem hiding this comment.
This should be implemented in a separate issue that adds rights to lock and unlock resources
marta-
reviewed
Apr 24, 2024
modules/locking/src/main/frontend/src/locking/SubjectLockAction.jsx
Outdated
Show resolved
Hide resolved
|
Suggestion: Add |
sdumitriu
reviewed
Apr 26, 2024
modules/data-entry/src/main/frontend/src/questionnaire/QuestionnaireStyle.jsx
Outdated
Show resolved
Hide resolved
...ta-entry/src/main/resources/SLING-INF/content/apps/cards/ExtensionPoints/SubjectActions.json
Outdated
Show resolved
Hide resolved
modules/locking/src/main/resources/SLING-INF/nodetypes/locking.cnd
Outdated
Show resolved
Hide resolved
modules/locking/src/main/resources/SLING-INF/nodetypes/locking.cnd
Outdated
Show resolved
Hide resolved
| // Hardcode the resource type | ||
| - sling:resourceType (STRING) = "cards/Lock" mandatory autocreated protected | ||
| // Hardcode the resource supertype: the login page is a resource | ||
| - sling:resourceSuperType (STRING) = "cards/Resource" mandatory autocreated protected |
There was a problem hiding this comment.
This isn't a resource. It should be a cards:Item, but that PR is still a draft.
...ocking/src/main/resources/SLING-INF/content/Extensions/SubjectActions/subjectLockAction.json
Outdated
Show resolved
Hide resolved
modules/locking/src/main/java/io/uhndata/cards/locking/LockedRestrictionPattern.java
Outdated
Show resolved
Hide resolved
modules/locking/src/main/java/io/uhndata/cards/locking/LockServlet.java
Outdated
Show resolved
Hide resolved
modules/locking/src/main/java/io/uhndata/cards/locking/LockedRestrictionPattern.java
Show resolved
Hide resolved
|
I think this will need adjusting, but not right now: creating a new form from the dashboard should not allow selecting a locked subject. I think this would be better handled by checking rights themselves, instead of customizing even more the subject selector component. |
Initial implementation including:
- Locking restriction
- TODO: Once lock and unlock rights are implemented, apply locked restriction to everyone by default
- Lock node on subjects
- Includes author who locked the node
- Only locked subjects with a child lock node can be unlocked and only if their parent is unlocked
to prevent partially unlocked child trees
- TODO: add time to lock node
- Basic UI for locking and unlocking
- Single lock/unlock button based on current lock state
- TODO: list any incomplete forms
- TODO: update UI when locking or unlocking successfull to reflect new lock state
- TODO: list current user and timestamp
Other tasks TODO:
- Make locking opt-in
- Make subject actions extensible to move the locking button into the locking modules
Lock button will now update the subject view so changes to locked status will be displayed to the user without needing to refresh the page
Switch to LOCK and UNLOCK HTTP methods rather than Post
- Add username and date to lock dialog
Create new Subject Action extension - Move lock button into locking module and access it through the extension
Fix incorrectly named configuration
- Make locking opt-in
- Restrict form and child subject creation for locked subjects
- Improve locking UI - Simplify subject actions extension - Add list of incomplete forms to lock UI - Update child form display when a subject is locked or unlocked
Improve locking UI - Split locking dialog into up to 2 dialogs: - List of incomplete forms + continue - Sign off - Convert username and date into disabled inputs - Convert list of incomplete forms into Material UI list
Refactor lock handling into LockManager rather than built into LockServlet
Remove extraneous lock action extension definition
Update locking module version
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.
Initial implementation including:
to prevent partially unlocked child trees
Testing:
./start_cards.sh --test --devto make sure nothing has changed and that locking is disabled by default./start_cards.sh --test --dev --lockingto test that locking is can be enabled and is working as expectedpython3 generate_compose_yaml.py --cards_project cards4prems --oak_filesystem --dev_docker_image --lockingdocker-compose build && docker-compose updocker-compose down && docker-compose rm && docker volume prune -f && ./cleanup.shpython3 generate_compose_yaml.py --cards_project cards4prems --oak_filesystem --dev_docker_imageMake sure that:
Locking2.mp4