[BD-32] feat: integrate cohort assignment filter definition #30431
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
openedx-webhooks
added
needs triage
open-source-contribution
|
Thanks for the pull request, @mariajgrimaldi! I've created BLENDED-1236 to keep track of it in Jira. More details are on the BD-32 project page. When this pull request is ready, tag your edX technical lead. |
mariajgrimaldi
changed the title
openedx-webhooks
added
blended
|
How it looks stopping the cohort assignment: |
mariajgrimaldi
changed the title
openedx-webhooks
added
needs triage
and removed
waiting on author
felipemontoya
approved these changes
Jun 8, 2022
There was a problem hiding this comment.
Sorry @mariajgrimaldi this took me a long time to review. I tested it running the filter against my own pipeline step and made sure that all connections were working as expected.
I even made a filter that only lets certain users be assigned to the cohort and not the others to test the partial error message. All superb.
I think this is ready. Just a squash before merging would be in order.
mariajgrimaldi
force-pushed
the
MJG/cohort-assignment-filter
branch
2 times, most recently
from
2a29e32 to
0b65f6b
Compare
mariajgrimaldi
force-pushed
the
MJG/cohort-assignment-filter
branch
from
0b65f6b to
ec69659
Compare
|
I'll be merging this now! 😄 @felipemontoya |
|
@mariajgrimaldi 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future. |
|
EdX Release Notice: This PR has been deployed to the staging environment in preparation for a release to production. |
|
EdX Release Notice: This PR has been deployed to the production environment. |
|
EdX Release Notice: This PR has been deployed to the staging environment in preparation for a release to production. |
|
EdX Release Notice: This PR has been deployed to the production environment. |
github-actions bot
added a commit
that referenced
this pull request
Aug 8, 2022
<!--
🌰🌰
🌰🌰🌰🌰 🌰 Note: the Nutmeg master branch has been created. Please consider whether your change
🌰🌰🌰🌰 should also be applied to Nutmeg. If so, make another pull request against the
🌰🌰🌰🌰 open-release/nutmeg.master branch, or ping @nedbat for help or questions.
🌰🌰
Please give your pull request a short but descriptive title.
Use conventional commits to separate and summarize commits logically:
https://open-edx-proposals.readthedocs.io/en/latest/oep-0051-bp-conventional-commits.html
Use this template as a guide. Omit sections that don't apply. You may link to information rather than copy it.
More details about the template are at openedx/open-edx-proposals#180
(link will be updated when that document merges)
-->
## Description
Backport filters that didn't make it to nutmeg release:
**Add filter before certificate creation starts**
(cherry picked from commit e8fa890)
**Add cohort change filter before moving users from cohorts**
(cherry picked from commit 465e5c0)
**Add filter before certificate rendering process starts**
(cherry picked from commit 7f974d1)
**Add filter before course dashboard rendering process starts**
(cherry picked from commit 895a649)
**Add filter before course about rendering process starts**
(cherry picked from commit ccfa0b4)
**Integrate cohort assignment filter definition to cohort model**
(cherry picked from commit ec69659)
## Supporting information
Refer to the BTR wg github issue for the rationale behind this PR: openedx/wg-build-test-release#187
## Testing instructions
1. Install the needed library release: `openedx-filters==0.7.0`
2. Install the samples library:
`pip install git+https://github.com/eduNEXT/openedx-filters-samples.git@master#egg=openedx_filters_samples`
3. Then, configure each filter. If you want to test all the filters simultaneously, use this configuration and try to do each operation the filter is related to; the filter sample step will stop the operation.
```
OPEN_EDX_FILTERS_CONFIG = {
"org.openedx.learning.certificate.creation.requested.v1": {
"fail_silently": False,
"pipeline": [
"openedx_filters_samples.samples.pipeline.StopCertificateCreation"
]
},
"org.openedx.learning.cohort.change.requested.v1": {
"fail_silently": False,
"pipeline": [
"openedx_filters_samples.samples.pipeline.StopCohortChange"
]
},
"org.openedx.learning.certificate.render.started.v1": {
"fail_silently": False,
"pipeline": [
"openedx_filters_samples.samples.pipeline.RenderAlternativeCertificate",
]
},
"org.openedx.learning.dashboard.render.started.v1": {
"fail_silently": False,
"pipeline": [
"openedx_filters_samples.samples.pipeline.RenderAlternativeDashboard",
]
},
"org.openedx.learning.course_about.render.started.v1": {
"fail_silently": False,
"pipeline": [
"openedx_filters_samples.samples.pipeline.RenderAlternativeCourseAbout",
]
},
"org.openedx.learning.cohort.assignment.requested.v1": {
"fail_silently": False,
"pipeline": [
"openedx_filters_samples.samples.pipeline.StopCohortAssignment"
]
},
}
```
Please, for detailed instructions on how to test each filter, refer to each of these PR(s):
Filter for certificate creation:
#29949
Filter for cohort change:
#29964
Filter for certificate rendering:
#29976
Filter for dashboard rendering:
#29994
Filter for course about rendering:
#29996
Filter for cohort assignment:
#30431
## Deadline
For the next nutmeg release.
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.
Description
This PR integrates the Cohort Assignment filter definition meant to be triggered when assigning a user into a cohort.
Supporting information
ADR(s) on:
Testing instructions
With this configuration, you won't be able to:
org.openedx.learning.cohort.assignment.requested.v1Deadline
Before nutmeg official release (this PR it's intended to be backported along with the other filters that didn't make it)