This repository has been archived by the owner on Apr 4, 2024. It is now read-only.
FEATURE: Add script to modify user group memberships through badges #206
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
This change adds a new script, `user_group_membership_through_badge` which provides the option to automate user group memberships through badges. Given a badge name and a group, this script adds users with the specified badged to the the given group on login or on a recurring schedule. It also has an optional flag which when enabled ensures only users with the specified badge are members of the given group
s3lase
commented
Aug 25, 2023
|
|
||
| DiscourseAutomation::Scriptable::USER_GROUP_MEMBERSHIP_THROUGH_BADGE = | ||
| "user_group_membership_through_badge" | ||
| DiscourseAutomation::Scriptable::USER_GROUP_MEMBERSHIP_THROUGH_BADGE_BULK_MODIFY_START_COUNT = 1000 |
There was a problem hiding this comment.
🤷🏾 Arbitrary limit alert. I wonder if this is even needed, the add_user_to_group_through_custom_field script doesn't do this at the moment.
Better safe than sorry, we probably don't want to be doing 1000s of Group#add calls anyways
jjaffeux
reviewed
Aug 28, 2023
Comment on lines
+56
to
+65
| if user_ids_to_add.count < bulk_modify_start_count | ||
| User | ||
| .where(id: user_ids_to_add) | ||
| .each do |user| | ||
| group.add(user) | ||
| GroupActionLogger.new(Discourse.system_user, group).log_add_user_to_group(user) | ||
| end | ||
| else | ||
| group.bulk_add(user_ids_to_add) | ||
| end |
There was a problem hiding this comment.
Maybe we always do bulk_add ?
There was a problem hiding this comment.
How essential are the user_added_to_group and user_removed_from_group events? The bulk methods understandably don't trigger these.
I considered going all in with the bulk methods but decided against it for two main reasons:
- We lose the events and ability to trigger other automations off of the badge-group sync
- Compatibility with
exisiting add_user_to_group_through_custom_fieldscript. It does not perform bulk adds
jjaffeux
reviewed
Aug 28, 2023
Comment on lines
+85
to
+94
| if user_ids_to_remove.count < bulk_modify_start_count | ||
| User | ||
| .where(id: user_ids_to_remove) | ||
| .each do |user| | ||
| group.remove(user) | ||
| GroupActionLogger.new(Discourse.system_user, group).log_remove_user_from_group(user) | ||
| end | ||
| else | ||
| group.bulk_remove(user_ids_to_remove) | ||
| end |
There was a problem hiding this comment.
same, maybe only bulk_remove ?
|
Thanks @jjaffeux |
OsamaSayegh
pushed a commit
that referenced
this pull request
Mar 29, 2024
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
This change adds a new script,
user_group_membership_through_badgewhich provides the option to automate user group memberships through badges.Given a badge name and a group, it adds users with the specified badged to the the given group either on login or on a recurring schedule.
It also has an optional flag to synchronize these two in "strict mode". It does this by ensuring only users with the specified badge belong to the given group.