Refactor the role filtering parameter to be a tuple #7020
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
All method that return a query of users or a roster take a role scope and a role type parameter. Refactor that to be a tuple of values instead. This is to accommodate a future change to add new parameter to "exclude" a certain type of role. This refactor is big enough that deserves its own commit to make it easier to review.
marcospri
commented
Feb 20, 2025
| @@ -219,8 +219,7 @@ def get_assignment_roster( | |||
| # If rostering is enabled and we do have the data, use it | |||
| query = self._roster_service.get_assignment_roster( | |||
| assignment, | |||
| role_scope=RoleScope.COURSE, | |||
| role_type=RoleType.LEARNER, | |||
| include_role=(RoleScope.COURSE, RoleType.LEARNER), | |||
There was a problem hiding this comment.
Most of the changes is this, from two parameters to a tuple.
I might create a type alias when we add exclude_role.
| select(LTIRole.id).where( | ||
| LTIRole.scope == role_scope, LTIRole.type == role_type | ||
| ) | ||
| self._filter_membership_by_role_clause( |
There was a problem hiding this comment.
Adding a small helper function here to avoid a bit duplication.
Again, this will make more sense once we add exclude_role, the helper function will do the filtering for both.
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.
For:
All method that return a query of users or a roster take a role scope and a role type parameter.
Refactor that to be a tuple of values instead.
This is to accommodate a future change to add new parameter to "exclude" a certain type of role.
This refactor is big enough that deserves its own commit to make it easier to review.
Testing
There should not be any functional changes, for sanity checking navigate around the dashboards.