feat: add schedule queryset request filter integration

[BryanttV]

Description

This PR introduces the integration of a new openedx-filter (ScheduleQuerySetRequested) designed to provide an intermediate point to perform more specific filtering on the Schedules QuerySet.

Use Case Example

A practical example of its application is in NAU, where this filter will be used in a specific pipeline. Currently, when the Schedule Emails feature is enabled, learners receive emails by default without the option to disable it. With this new filter, it becomes possible to customize the behavior by applying additional filtering to include only learners who meet certain conditions, such as having the allow_newsletter field equal to True.

Benefits:

• Greater Control: Enables fine-tuning of Schedules QuerySets to meet specific project or client requirements.
• Flexibility: Facilitates the implementation of custom rules without altering the platform's default logic.
• Scalability: This intermediate point is reusable for similar use cases in the future.

Supporting information

• The filter definition in: feat: add schedule queryset requested filter openedx-filters#235
• A filter pipeline example in: feat: reactive schedules nudge emails filter fccn/nau-openedx-extensions#56

Testing instructions

1. Create a Tutor environment.

2. Create a mount of edx-platform with the changes in this branch (For testing purposes).

3. Install nau-openedx-extensions plugin with the changes in this PR. ⚠️ Don't forget to run migrations.

4. Install openedx-filters with the changes in this PR.

5. Create a new Schedule config for your site in {lms_domain}/admin/schedules/scheduleconfig/

   

6. Create some users and enroll them in a course.

7. Create an NAU user extended model for each user in {lms_domain}/admin/nau_openedx_extensions/nauuserextendedmodel/. Update the following field, depending on whether you want to receive the newsletter.

   

8. Create a Tutor inline plugin with the filter configuration:

   name: filter-settings
   version: 0.1.0
   patches:
     openedx-common-settings: |
       OPEN_EDX_FILTERS_CONFIG = {
         "org.openedx.learning.schedule.queryset.requested.v1": {
           "fail_silently": False,
           "pipeline": [
             "nau_openedx_extensions.filters.pipeline.FilterUsersWithAllowedNewsletter",
           ],
         },
       }

9. Send a message of recurring nudge using the following command in the LMS container:

   python manage.py lms send_recurring_nudge {site} --date {enroll-date + 3 days}
   # Example
   python manage.py lms send_recurring_nudge local.edly.io:8000 --date 2024-12-07

10. Depending on the value of each user's allow_newsletter field, you should see the filtered QuerySet of Schedules in the console. For example, here the Schedule was filtered because the user does not have the field set to True

    

Deadline

None

Other information

Important

The PR in openedx-filters should be merged before this one.

• feat: add schedule queryset requested filter openedx-filters#235

[openedx-webhooks]

Thanks for the pull request, @BryanttV!

What's next?

Please work through the following steps to get your changes ready for engineering review:

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

• If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
  • This process (including the steps you'll need to take) is documented here.
• If it doesn't, simply proceed with the next step.

🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

• Dependencies

  This PR must be merged before / after / at the same time as ...

• Blockers

  This PR is waiting for OEP-1234 to be accepted.

• Timeline information

  This PR must be merged by XX date because ...

• Partner information

  This is for a course on edx.org.

• Supporting documentation
• Relevant Open edX discussion forum threads

🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

🔘 Let us know that your PR is ready for review:

Who will review my changes?

This repository is currently maintained by @openedx/wg-maintenance-edx-platform. Tag them in a comment and let them know that your changes are ready for review.

Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

• Overview of Review Process for Community Contributions
• Pull Request Status Guide
• Making changes to your pull request

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

• The size and impact of the changes that it introduces
• The need for product review
• Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

[MaferMazu]

Hello @BryanttV, thanks for this.

I tested and the filter works as expected.
About this PR, I left a comment about the naming and flow.

I think your arguments about adding this filter are good, but I would like a second opinion about this.

Note: when we merge openedx/openedx-filters#235, we should update the openedx-filter version here.

[BryanttV]

Hi @MaferMazu, the openedx-filters PR was merged, so, I upgraded the version.

[MaferMazu]

Everything worked as expected; the filter worked, and when the filter is not set, this follow the default flow.

This looks good to me. Thanks ✨

I don't know if @mariajgrimaldi has anything to add. If not, we could merge this.

[mariajgrimaldi]

@MaferMazu @BryanttV: I'll approve once unittests are included in the PR, you can see some examples here: https://github.com/openedx/edx-platform/pull/32448/files#diff-e74d6ca48afe9122896613ff0f5c27e885f505e95d2075e4893145623bc75583

[mariajgrimaldi]

can we also test the default case when the filter is not configured?