Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: make some of this app work in tutor #381

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

kdmccormick
Copy link
Member

@kdmccormick kdmccormick commented Apr 5, 2024

sandbox at: https://app.pr-381-98a602.sandboxes.opencraft.hosting/support-tools/learner_information/?username=openedx

Description

This makes most of the support-tools pages render when running in Tutor. The main problem was that getConfig() was being run at init-time instead of runtime, so the MFE was using values from the .env files instead of from the MFE Config API.

Running in Tutor

This just requires enabling tutor-mfe plus a simple custom plugin:

from tutor.hooks import Filters
from tutormfe.hooks import MFE_APPS

@MFE_APPS.add()
def _add_support_tools(apps: dict) -> dict:
    return {
        **apps,
        "support-tools": {
            "repository": "https://github.com/openedx/frontend-app-support-tools",
            "port": 2007,
            "version": "master",
        },
    }

Open issues

  • Several features don't work because the feature they depend on is disabled in LMS/CMS, such as feature-based-enrollment.
  • Several pages don't work because their routes assume they are running on the root (/) instead of a subpath (/support-tools). We have fixed this problem in several MFEs and it could be fixed here too.
  • Several features are disabled because they depend on microservices: credentials, discovery, ecommerce, enterprise-catalog, license-manager.
  • Some links are hard-coded to 2U accounts so they will never work outside of edx.org.

Status

This was mostly for my own reference. I don't plan on trying to merge this unless it becomes clear that we want to keep this MFE in the openedx org.

Some screenshots of pages that do work

st1
st2
st3

@kdmccormick kdmccormick added the create-sandbox open-craft-grove should create a sandbox environment from this PR label Apr 5, 2024
Copy link

codecov bot commented Apr 5, 2024

Codecov Report

Attention: Patch coverage is 56.25000% with 7 lines in your changes are missing coverage. Please review.

Project coverage is 88.34%. Comparing base (da37a62) to head (327545a).

Files Patch % Lines
src/supportHeader/Header.jsx 0.00% 7 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master     #381      +/-   ##
==========================================
- Coverage   88.35%   88.34%   -0.02%     
==========================================
  Files         164      164              
  Lines        3462     3459       -3     
  Branches      856      856              
==========================================
- Hits         3059     3056       -3     
  Misses        399      399              
  Partials        4        4              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@kdmccormick kdmccormick changed the title fix: make most of this app work in tutor fix: make some of this app work in tutor Apr 5, 2024
@open-craft-grove
Copy link

Sandbox deployment successful 🚀
🎓 LMS
📝 Studio
ℹ️ Grove Config, Tutor Config, Tutor Requirements

@kdmccormick kdmccormick removed the create-sandbox open-craft-grove should create a sandbox environment from this PR label May 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants