feat: external plugin integration in instructor dashboard

[MAbdurrehman12]

Description

There are plugins which return context which is then embedded/used accordingly. So in instructor dashboard we need a flow/function which get/fetches the context from external plugins and updates the existing context with the context returned from external plugins. This has been done via a function get_plugins_view_context of edx_django_utils.plugins. A separate constant file has been created in instructor which consist of a constant: INSTRUCTOR_DASHBOARD_PLUGIN_VIEW_NAME. Any external plugin which uses this constant, will return context to instructor dashboard.

While installing an external plugin, all the settings should be derived first and add_plugins function should be called afterwards in lms -> envs -> production.py but currently add_plugins function is being called before derive_settings function, hence their order has been switched. Same goes for cms -> envs -> production.py

In lms/templates/instructor/instructor_dashboard_2/instructor_dashboard_2.html, we include the html files of sections from relative path, but in case of plugin, we need to give absolute path, as plugin's html file is inside plugin so in order to give absolute path we need to add a prefix "/".

Supporting information

None

Testing instructions

• Any external plugin which uses the constant INSTRUCTOR_DASHBOARD_PLUGIN_VIEW_NAME to return any context, will be received in instructor dashboard.
• If we call the add_plugins function before derive_settings function, then an exception can be seen while adding plugin's template in app_dirs.
• If we call the add_plugins function after derive_settings function, then plugin's template is successfully added in app_dirs.
• If we don't place a prefix "/" while including a html file from some other directory/app then an exception can be seen as it automatically adds relative path to it while including and the file can not be found on this path because plugin's html file is inside plugin templates.
• If we place a prefix "/" while including a html file from some other directory/app then it includes the file successfully as now absolute path is provided by appending this prefix.

Deadline

None

Other information

None

[openedx-webhooks]

Thanks for the pull request, @MAbdurrehman12! I've created OSPR-6232 to keep track of it in JIRA, where we prioritize reviews. Please note that it may take us up to several weeks or months to complete a review and merge your PR.

Feel free to add as much of the following information to the ticket as you can:

• supporting documentation
• Open edX discussion forum threads
• timeline information ("this must be merged by XX date", and why that is)
• partner information ("this is a course on edx.org")
• any other information that can help Product understand the context for the PR

All technical communication about the code itself will be done via the GitHub pull request interface. As a reminder, our process documentation is here.

Please let us know once your PR is ready for our review and all tests are green.

[edx-pipeline-bot]

EdX Release Notice: This PR has been deployed to the staging environment in preparation for a release to production.

[ziafazal]

@natabene Can I review this PR?

[natabene]

@MAbdurrehman12 Thank you for your contribution. @ziafazal Thanks for offering, let me check with the owning team. I will post an update here.

[natabene]

@ziafazal Please review.

[ziafazal]

@MAbdurrehman12 Could you please add unit test to support you changes in instructor dashboard view?

[MAbdurrehman12]

@MAbdurrehman12 Could you please add unit test to support you changes in instructor dashboard view?

Sure. I'll add it

[ziafazal]

👍

[openedx-webhooks]

@MAbdurrehman12 🎉 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-status-bot]

Your PR has finished running tests. There were no failures.

[edx-pipeline-bot]

EdX Release Notice: This PR has been deployed to the staging environment in preparation for a release to production.

[edx-pipeline-bot]

EdX Release Notice: This PR has been deployed to the production environment.