Add a generic interface for ACL keys to Group and User #5761
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
knowledge about how the ACL keys are handled for Groups is spread throughout the codebase. treating this information as an attribute on the group seems cleaner. `Hyrax::Group#user_key` is provided for easy compatibility with `::User`.
Also fixes an incorrect implementation of `Hyrax::Group.from_key`. The Sipity specs were inspired by the similar specs for `Hyrax::User`.
These methods help reduce the amount of knowledge that ACLs require regarding agents. For Users, the default implementation is just to use `#user_key` and `User.find_by_user_key`. (An alternate approach would be just to implement `#user_key` and `.find_by_user_key` directly on `Hyrax::Group`, but I’m not sure we want Groups to be treatable as Users in all contexts where `#user_key` might be used.)
no-reply
approved these changes
Jun 29, 2022
Merged
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.
Resumes work on #5439.
Adds a full set of tests for
Hyrax::Group, and adds#agent_keyand.from_agent_keyas new methods onHyrax::Groupand[Hyrax::]User. In the latter case, these just fall back to#user_keyandUser.find_by_user_key.The
#to_sipity_agenttests onHyrax::Groupwere mostly copied from the ones onHyrax::User, and may warrant a closer look by someone more familiar with what they should be testing.(If adding methods on
Useris undesirable, we could either ⓐ fallback to the existing#user_keyandUser.find_by_user_keyif#agent_keyand.from_agent_keyare not defined, or ⓑ just implement#user_keyand.find_by_user_keyonHyrax::Groupdirectly. I’d probably prefer the first option, but neither of these solutions felt ideal to me.)I’ll open a PR to backport this to
3.x-stableif this gets merged, as we would like it for our current experimental work on ahyrax-aclgem.@samvera/hyrax-code-reviewers