feat(boards2): initial permissions support #3151
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
Interface is defined based on Jae's idea to handle permissioned tasks. Co-authored-by: Jae Kwon <[email protected]>
Also rename `auth.gno` file to `permission.gno`
The `HasPermission` methods has been removed in favor of using the permissioner interface. Currently there is only a global permissioner but once the AdminDAO is implemented permissions will provably be handled by each individual board and the realm.
There are function that require checks that should be done by an implementer, like a DAO. Initially the implementer might choose to use proposals under the hood making it impossible to return the ID of a newly created entity syncronically. This change just adds permission support but the pattern must be improved to handle these cases.
This check might be reintroduced in the default permissioner implementation.
github-actions
bot
added
the
🧾 package/realm
Codecov ReportAll modified and coverable lines are covered by tests ✅ 📢 Thoughts on this report? Let us know! |
Removed two methods which are not yet used. These methods can be added later if boards2 requires them.
This implementation doesn't have support for proposals, it's only intended to have the minimal initial AdminDAO implementation required to start writting other boards2 features.
DAO only implementes support for members and eventually proposals. Roles and permissions should be managed by another entity.
Users must have the permission configured in the ACL and also be a member of the AdminDAO.
jeronimoalbi
commented
Nov 25, 2024
| Role string | ||
|
|
||
| // ACL or access control list manages user roles and permissions. | ||
| ACL struct { |
There was a problem hiding this comment.
This type could be named Permissions (or DefaultPermissions) instead of ACL. Naming it ACL makes sense thinking that it not only handles permissions but also roles.
jeronimoalbi
commented
Nov 25, 2024
jeronimoalbi
commented
Nov 25, 2024
jeronimoalbi
commented
Nov 25, 2024
Comment on lines
30
to
38
| args := Args{name, id} | ||
| // TODO: Do the callback really need the args or we could have the same result directly referencing? | ||
| gAuth.WithPermission(caller, PermissionBoardCreate, args, func(a Args) { // TODO: Caller could be an extra func arg | ||
| name := a[0].(string) | ||
| id := a[1].(BoardID) | ||
| board := newBoard(id, name, caller) | ||
| gBoardsByID.Set(id.Key(), board) | ||
| gBoardsByName.Set(name, board) | ||
| }) |
There was a problem hiding this comment.
Sending the arguments to WithPermission is necessary for the case where the Permissioner interface implementer, for example a DAO, creates a proposal under the hood. The arguments could be considered parameters for the proposal in that case.
Does using the args in the callback function make sense? Code would be cleaner if outer variables are used instead. Or is it better for the VM to use args from the function instead of outer references?
Caller is normally used within the callback, so we could send the caller as an argument for the callback if we don't want to use outer references.
Using `WithPermission` is not needed in many cases at this point and it can be introduced once the functionalities are better defined.
x1unix
pushed a commit
to gnostudio/gno
that referenced
this pull request
Jan 6, 2025
Related to gnolang#3139 Permissioner interface is defined based on Jae's idea to handle permissioned tasks. --------- Co-authored-by: Jae Kwon <[email protected]>
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.
Related to #3139