fix: updating advance settings should update corresponding course_app

[marslanabdulrauf]

Related Ticket (Internal):

https://github.com/mitodl/hq/issues/9178

Description

This PR adds bidirectional sync for common settings that can be control from both "Pages & Resources" page and advanced settings page.
It updates:

1. Advanced_settings PATCH request to update corresponding course_app status if exists
2. Adds advance setting key/field in plugins to identify its related setting
3. Adds a new function in PluginManager to return the mappings for course advance setting -> plugin app

Steps to Reproduce

1. Go to the Pages & Resources section of a course
2. Change the flags for Notes and Calculator each to be disabled.
3. Go to Settings -> Advanced Settings
4. Find "Enable student notes" - the field should read "false"
5. Change the field to "true"
6. Find "Show calculator" - the field should read "false"
7. Change the field to "true"
8. Save changes
9. Go back to Content -> Pages & Resources
10. Open the settings for Notes and Calculator - both will be disabled.
11. View the course live and go to any unit.
12. Both the calculator and Notes feature will be available.
13. Go back to the Pages & Resources
14. Change the setting on Notes to first be enabled (save), and then disabled again (save again)
15. Viewing the advanced settings page will show that notes are now disabled.
16. View the course live.
17. Notes will be disabled.
18. Repeat step 14-17 for calculator and it will also be disabled.

Expected Behavior

The two settings should match - changing the state of the setting in Advanced Settings should update the setting on Pages & Resources.

For a working example, see "Flexible peer grading for ORAs" - which links to "Force Flexible Grading for Peer ORAs" in the advanced settings. Changing the setting on Pages & Resources to disabled or enabled will change the setting in Advanced Settings to true or false.

Actual Behavior

Changing the settings for calculator and notes within Advanced Settings does not change the settings on Pages & Resources. The course will update based on what is in the Advanced Settings, meaning that there can be a mismatch between the two settings but the course will always follow the flag in the Advanced Setting.

Updating the flag in Pages & Resources will update the Advanced Settings.

Testing instructions

1. Follow the steps to reproduce after checkout to this branch
2. Verify that updating advance_settings also updates related/corresponding course app status as well

[openedx-webhooks]

Thanks for the pull request, @marslanabdulrauf!

This repository is currently maintained by @openedx/wg-maintenance-edx-platform.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are 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.

---

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.

[regisb]

Why all the named arguments? The set_course_app_status function has only positional arguments.

(same for the other call to set_course_app_status above)

[marslanabdulrauf]

Named arguments are always better specifically when we have 3+ arguments and boolean parameter. Its self-documented, future-proof, and improve readability.

[regisb]

We may have to disagree on this, but you should comply with the current practices in the Open edX codebase, which is not to use keyword arguments when they are declared as positional.

[marslanabdulrauf]

Open edX code that I updated was already using named arguments

[regisb]

I suggest the following:

 try:
    course_app = CourseAppsPluginManager.get_plugin(app_id)
except PluginError:
    raise ValidationError({"id": f"Invalid app ID={app_id]"})
if not course_app.is_available(course_key):
    raise ValidationError({"id": f"Unavailable app ID={app_id}"})

[regisb]

There are several issues here:

1. Why is there a big piece of code right in the middle of this otherwise simple function for a change that would happen very infrequently? At the very least, this piece of code should be in a separate function.
2. But then, this separate function should not modify the request object. This is a side effect that is too hard to understand.
3. Why are we collecting all advanced settings in a single dictionary? This looks like the wrong API to me. Instead, we could write:

apps_to_toggle:: list[tuple[str, bool]] = []
for advanced_setting, setting_enabled in request.data.items():
    # note how get_advanced_app_id returns str | None
    if app_id := CourseAppsPluginManager.get_advanced_app_id(advanced_setting): 
        course_app_enabled = setting_enabled.get("value")
        if course_app_enabled is not None:
            apps_to_toggle.append((app_id, course_app_enabled))
for app_id, is_enabled in apps_to_toggle:
    set_course_app_status(course_key, app_id, is_enabled, request.user)

[marslanabdulrauf]

There is no direct way to find course_app/app_id using advanced_setting.
We need to get all plugins check if any of them have set advanced_setting_field and generate a map for it.

This method get_advanced_app_id looks good to return only app_id for given advanced_setting however it will iterate on all plugins for each advanced_setting.

Let me move it to different function(s) and reduce the nesting 👍

[arslanashraf7]

@marslanabdulrauf has all the existing feedback been addressed? I still see some comments that might need addressing.