feat: add filter for instructor mfe tabs

[holaontiveros]

Description

In order to achieve openedx/frontend-app-instructor-dashboard#86 this PR will add a filter so the new APIs for the instructor-dashboard app can get the tabs modifed by other plugins like aspects

PR for openedx-platform integration: openedx/openedx-platform#38499
The PR on the platform side will be on-hold while this get's merged

Once this is in place any operator / plugin creator can do something like:

# Add the pipeline step to the LMS configuration
hooks.Filters.ENV_PATCHES.add_item(
    (
        "openedx-lms-common-settings",
        """
# Custom tabs plugin configuration and pipeline step
import logging
from django.conf import settings

# Define the pipeline step class
class CustomTabsStep:
    def __init__(self, filter_type, running_pipeline, **kwargs):
        self.filter_type = filter_type
        self.running_pipeline = running_pipeline

    def run_filter(self, tabs, user, course_key, **kwargs):
        logger = logging.getLogger(__name__)
        logger.error(f"DEBUG: CustomTabsStep.run_filter called for user {user.username if hasattr(user, 'username') else 'unknown'}")

        modified_tabs = tabs.copy()

        # Check if user has permission
        user_has_access = (
            getattr(user, 'is_staff', False) or 
            getattr(user, 'is_superuser', False)
        )
        logger.error(f"DEBUG: User access check - is_staff: {getattr(user, 'is_staff', False)}, is_superuser: {getattr(user, 'is_superuser', False)}, has_access: {user_has_access}")

        if not user_has_access:
            logger.error("DEBUG: User does not have access to custom tabs")
            return {"tabs": modified_tabs}

        # Add custom tab
        custom_tab = {
            'tab_id': 'custom_analytics',
            'title': 'Custom Analytics',
            'url': f"{getattr(settings, 'CUSTOM_TABS_URL', '/instructor-dashboard/course-v1:OpenedX+DemoX+DemoCourse/custom_analytics')}",
            'sort_order': 120,
        }

        modified_tabs.append(custom_tab)
        logger.error(f"DEBUG: Added custom tab. Total tabs: {len(modified_tabs)}")

        return {"tabs": modified_tabs}

# Add the class to sys.modules so it can be imported by string
import sys
import types

# Create a module for our custom class
custom_module = types.ModuleType('custom_tabs_module')
custom_module.CustomTabsStep = CustomTabsStep
sys.modules['custom_tabs_module'] = custom_module

# Register the filter configuration
if "OPEN_EDX_FILTERS_CONFIG" not in locals():
    OPEN_EDX_FILTERS_CONFIG = {}

OPEN_EDX_FILTERS_CONFIG.update({
    "org.openedx.learning.instructor.dashboard.tabs.requested.v1": {
        "pipeline": [
            "custom_tabs_module.CustomTabsStep",
        ],
        "fail_silently": False,
    },
})
""",
    )
)

in whichever shape fits their need to be able to conditionally add or modify data of the tabs for the instructor dashboard.

Testing instructions

Note: to test this through the API or the UI edx-platform changes that leverage this filter need to be available (TBD)

• While having instructor dashbboard app and openedx-platform working add the example tutor-plugin from the description
• Save configs
• Restart server
• Go to instructor dashboard, the new tab should be available

Take in account that the frontend should have a slot to manage the URL that it's being returned for example a slot like this

{
    slotId: 'org.openedx.frontend.slot.instructorDashboard.routes.v1',
    id: 'org.openedx.frontend.widget.instructorDashboard.route.custom_analytics',
    op: WidgetOperationTypes.APPEND,
    element: <PlaceholderSlot tabId="custom_analytics" content={<div>Dynamic Content</div>} />,
  }

is added to the frontend-base build then the custom_analytics from the path from the plugin example will match the tabId custom_analytics from here and the tab will be displayed

The API request that uses this is: `http://local.openedx.io:8000/api/instructor/v2/courses/{:courseId}

Deadline

None

Checklists

Check off if complete or not applicable:

Merge Checklist:

• All reviewers approved
• Reviewer tested the code following the testing instructions
• CI build is green
• Changelog entry added using scriv with short description of the change
• Documentation updated (not only docstrings)
• Code dependencies reviewed
• Fixup commits are squashed away
• Unit tests added/updated
• Noted any: Concerns, dependencies, migration issues, deadlines, tickets

Post Merge:

• Trigger the release workflow to create a new GitHub release.
• Check new version is pushed to PyPI after tag-triggered build is finished.
• Delete working branch (if not needed anymore)
• Upgrade the package in the Open edX platform requirements (if applicable)

[openedx-webhooks]

Thanks for the pull request, @holaontiveros!

This repository is currently maintained by @openedx/committers-openedx-filters.

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.

Details

---

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.

[wgu-taylor-payne]

The filter concept and placement are solid — this is the right extension point for the MFE instructor dashboard. Main feedback: the run_filter method adds custom defensive logic that no other filter in the codebase uses. Simplifying it to match the standard pattern resolves most of the inline comments below. Also, the PR checklist marks the changelog entry as done but I don't see a scriv fragment in changelog.d/ in the diff.

Review assisted by Kiro

[wgu-taylor-payne]

LGTM

[BryanttV]

Overall, it looks good, thanks! I just have a few comments:

1. Could we link the openedx-platform PR that executes the filter?
2. Although scriv is configured in the repository, we still need to resolve a few things to get it 100% ready. Please manually add a new entry to the CHANGELOG and bump the version to 3.4.0 in both __init__ and pyproject.toml. Thanks a lot!

[holaontiveros]

@BryanttV I added the WIP of the platform PR and addressed your requests, thanks for the review

[felipemontoya]

I think the usage is solid. I left some comments about some conventions worth following.

Often times filters are added at the botom of the file, but I think it would be better to keep this next to InstructorDashboardRenderStarted so people looking for instructor dashboards filters get the MFE version next to the non-mfe.

I think it would be a nice touch to add the comment in the docstring about this being the mfe version of the same pattern from the old filter. You could even add that in both docstrings so this flows into the auto generated documentation that reads such strings (e.g: https://arunmozhi.in/openedx-plugin-slots-browser/filters/InstructorDashboardRenderStarted/)

[BryanttV]

LGTM! Thanks

Since we add the entry manually, could we remove the entry generated in the changelog.d folder?

[holaontiveros]

All done again, thanks for those suggestions @felipemontoya I did change the things but my autocomplete reverted some of them back, great catch

Whenever someone with enough power has time, please merge it

[felipemontoya]

I'll merge later. I just need the ci to run

[felipemontoya]

The only outstanding issue comes from the commit messages that were suggested via the github UI and those will disappear during the squash and merge process. I'm moving on to merging now.