Skip to content

Conversation

@GlugovGrGlib
Copy link
Member

@GlugovGrGlib GlugovGrGlib commented Jun 20, 2024

Description

This PR introduces an ADR outlining the approach to enable offline content support in the Open edX mobile application. The ADR documents the proposed solution, including content generation, API extensions, and synchronization mechanisms.

Key Decisions:

Offline Content Generation:

ZIP archives of xBlock content (HTML, assets, and assessments) will be pre-generated during course publishing and stored for mobile download.

Retries failed generation tasks with progressive delays.

Supports both local and S3 storage.

Mobile API:

Extends the Course Home API to include offline content availability (URL, size, last modified timestamp).

JavaScript Bridge:

Enables CAPA problem submissions via JSON messages through native mobile bridges.
Partial support for hints/feedback in problem types.

Supported xBlocks:

Includes common problem types (checkboxes, dropdown, text/numerical input), text/video blocks, and partial support for blocks with hints/feedback.

Consequences:

✅ Pros: Improved accessibility for learners with unreliable connectivity, increased engagement.
⚠️ Cons: Added complexity in content sync/storage, potential app size increase.

Rejected Solutions:

  • Storing shared JS/CSS files separately (tracking changes impractical).
  • On-the-fly content generation (performance concerns).

Supporting information

FC-0047

@openedx-webhooks
Copy link

openedx-webhooks commented Jun 20, 2024

Thanks for the pull request, @GlugovGrGlib!

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.

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:

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.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Jun 20, 2024
@mphilbrick211 mphilbrick211 added the FC Relates to an Axim Funded Contribution project label Jul 30, 2024
@angonz
Copy link
Contributor

angonz commented Aug 9, 2024

I suggest adding a comprehensive list of content types that will support offline viewing (maybe not all will be implemented at a time).
I think that video content deserves special attention. Many courses rely on video content. Open edX usually relies on external streaming services for video (YouTube, Vimeo, etc.) Video files can be huge. How will it handle offload video? Maybe uploading a downloadable version of the video in a separate storage?
Another thing to consider is milestones. If grading cannot be done offline, then probably unlocking content based on subsection grade will not be possible.

@salman2013
Copy link
Contributor

@GlugovGrGlib Just for curiosity how this ADR is different from this PR?

@NiedielnitsevIvan
Copy link
Contributor

I suggest adding a comprehensive list of content types that will support offline viewing (maybe not all will be implemented at a time).
I think that video content deserves special attention. Many courses rely on video content. Open edX usually relies on external streaming services for video (YouTube, Vimeo, etc.) Video files can be huge. How will it handle offload video? Maybe uploading a downloadable version of the video in a separate storage?
Another thing to consider is milestones. If grading cannot be done offline, then probably unlocking content based on subsection grade will not be possible.

Hello @angonz! I have updated the ADR and now there is a list of blocks that are planned to be supported. I also added a diagram to make it clearer how the content generation process will work. Please check it out.

As for videos, video uploading is already implemented in mobile applications.
As for unlocking content based on subsection grade, yes, such functionality is not planned within this work scope and, accordingly, it is not reflected in the ADR.

@NiedielnitsevIvan
Copy link
Contributor

@GlugovGrGlib Just for curiosity how this ADR is different from this PR?

Hi @salman2013, the functionality added in the PR you mentioned corresponds to what is described in this ADR.
This ADR describes the overall vision, but focuses on how it is planned to be done on the backend.

@cmltaWt0 cmltaWt0 marked this pull request as ready for review January 28, 2025 15:36
@kdmccormick kdmccormick self-requested a review January 31, 2025 16:10
Copy link
Member

@kdmccormick kdmccormick left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is very exciting. Here's a first pass. I'll need to think through the implications over the next few days, so I should have more review comments next week--feel free to bug me if I don't get back to you with those.

Comment on lines 23 to 24
* Figma
* Offline mode product pages
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Links?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kdmccormick was this your only blocking feedback?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, there is #35011 (comment), and I also have concerns about the feature's coupling to modulestore, which I will elaborate on shortly.

Comment on lines +93 to +110
It was decided to include a fraction of Open edX xBlocks to be supported.
The following list of blocks is currently planned to be added to the support:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm glad you enumerated these. I agree that it makes sense to start with a subset of XBlocks.

I think it would be good to keep the door open for future XBlocks to be supported. Could you build this in a way that would allow that? For example, can we make sure that it is possible to add support for an external XBlock like xblock-drag-and-drop-v2, without adding knowledge of xblock-drag-and-drop-v2 to edx-platform?

Relatedly, please keep in mind that we are extracting all built-in edx-platform XBlocks into a separate repo. It will take some time, but the CAPA ProblemBlock will eventually be extracted as part of that project. So, when you implement this, it is important that we are not hard-coding more CAPA knowledge into the publishing process-- the CAPA-specific archiving code should stay within the ProblemBlock definition.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for your question!
For offline content generation, we will use an html renderer very similar to the one used in the LMS, so there shouldn't be any significant issues with adding support for new blocks.

As for your question about xblock-drag-and-drop-v2 or other external XBlocks, yes, we won't need to add changes to the edx platform for each of them. I think that some refactoring/improvements will be needed in the future to expand the types of supported blocks, but it definitely shouldn't be for each new block separately.

As for CAPA, yes, the CAPA block will not be used.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As for CAPA, yes, the CAPA block will not be used.

@NiedielnitsevIvan Can you clarify this statement? "CAPA" is just another name for the ProblemBlock, which implements most of the core problem types. To implement offline support for most problems, the app will need to download archives of CAPA problem data and render CAPA html/javascript.

Copy link
Contributor

@NiedielnitsevIvan NiedielnitsevIvan Feb 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, I probably misunderstood the question.
I meant that there should be no direct imports from xmodule.capa...
You can see the draft implementation in this PR.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks. Taking a look through the draft...

Mobile API extension
~~~~~~~~~~~~~~~~~~~~

Extend mobile API endpoint for Course Home, to return information about offline content available for download for supported blocks
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please provide the exact URL

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added



* **Implement of a mechanism for generating and storing on a server or external storage**: The course content should be pre-generated and saved to the storage for later download.
* **Render content**: Generate HTML content of block as it does for LMS.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What Python function will call in order to render the HTML?

Does that function require a user_id? If so, how will you handle that?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The new function will collect the context needed to render the block and call render_to_string of the courseware/courseware-chromeless.html template.
Some existing functions require a user, so a special service user must be created and used for this.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Have you investigated rendering the content on the CMS side instead?

The major difference between CMS and LMS is that LMS supports user state, whereas CMS does not. So, if we just need to render content for a generic stateless enrolled user, then I think it should be possible for CMS to do this (consider that CMS is already able to render the author_view of problems for authors, which are essentially identical to what learners see in the student_view).

This would eliminate the need for cross-communication between LMS and CMS, which I sense would be challenging to implement.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, we've been looking into this, and theoretically, after some modifications, it would indeed be possible to do rendering on the CMS side.
But besides the problem you described with the lack of user state in the case of rendering on the CMS side, even standard xblocks look a little different from what the student sees in the LMS, which can confuse the student, and the appearance of custom/non-standard blocks can be even more different from the appearance in the LMS. Therefore, in the future, this may become a blocker to expanding the types of supported blocks.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

even standard xblocks look a little different from what the student sees in the LMS, which can confuse the student, and the appearance of custom/non-standard blocks can be even more different from the appearance in the LMS.

@NiedielnitsevIvan can you elaborate or show an example? Is this because author_view and student_view can differ, or area you saying that even rendering student_view in CMS will yield a different-looking result than student_view in LMS?

Having to handle an event across LMS/CMS boundaries would make this implementation significantly less robust and more complicated. So, unless there is some severe blocker, I would prefer that we render the blocks on the CMS side, even if that requires some technical investment in CMS's rendering capabilities.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note: If we do end up going with LMS-side rendering, I think should use the anonymous public_views rather than creating a service user specifically for this task. This would involve some investment in CAPA's public_view, as it currently contains a comment explaining that it will only render anonymously in the Learning Core runtime, not in the ModuleStore runtime.

Comment on lines 82 to 83
* **Track course publishing events on CMS side**: Signal in the CMS that makes request to LMS to update course content.
* **Track course publishing events on LMS side**: API endpoint to receive the signal from CMS and update course content.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can see that this would work, but I am curious if there is a more elegant approach. I have asked in #architecture.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So far, we've tried the implementation described in ADR and found a problem that in this case, content generation can occur before the course structure is updated. Therefore, I propose a new attribute for SignalHandler.course_cache_updated, which will be called in update_course_in_cache_v2 and the signal listening to this event, which will start generation task after the course structure is updated.
I will add this to the ADR.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Taking into account the use of offline_view, now we can really leave the generation launch on the CMS side.

Comment on lines +87 to +101
* **Sync Mechanism**: Periodically synchronize local data with the server when the device is online.
* **Sync on app side**: On course outline screen, check if the course content is up to date and update it if necessary.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please say more about:

  • How the offline app will respond when a user hits Submit
  • What local state the app will store and in what format it will store it
  • How the app will synchronize this state with the server

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The JS bridge will intercept ajax requests in the mobile application and store the responses. The user will see the message "Your response is accepted" and the Submit button should be disabled.
Then, when the user gets the Internet, the mobile application will send the saved responses to the backend one by one, to the standard xblock handler.
So far, this is the behavior planned within FC-0047, which should be improved in the future within FC-7879, where it is planned to add the ability for the application to send all responses to the backend at once.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The JS bridge will intercept ajax requests in the mobile application and store the responses. The user will see the message "Your response is accepted" and the Submit button should be disabled.
Then, when the user gets the Internet, the mobile application will send the saved responses to the backend one by one, to the standard xblock handler.

Can you add these ^ details to the ADR?

@kdmccormick kdmccormick self-requested a review February 11, 2025 17:44
Comment on lines 131 to 147
Store common .js and .css files of blocks in a separate folder:
* This solution was rejected because it is unclear how to track potential changes to these files and re-generate the content of the blocks.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am concerned that without any de-duping of JS, we will be saving and serving thousands of exactly-identical copies of the ProblemBlock's javascript and css.

Copy link
Member

@kdmccormick kdmccormick left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your patience. This is an ambitious and exciting project; it took a lot of research and thinking on my part develop feedback for it. Generally, pre-rendering content for offline consumption is a great idea. I have some blocking concerns with the proposed approach as it stands now:

  1. The new XBlockRenderer. XBlock rendering is already complicated. Creating a new renderer specifically for offline content will make it even harder to understand and maintain, and it will open us up to behavior drift between online and offline blocks. Because the renderer would be used exclusively for offline content, the only way to test it would be to enable offline content by-default and have Build-Test-Release WG specifically test the offline content system.
  2. Duplication of static resources. Duplicating CAPA JS & CSS into every single ProblemBlock (potentially 100+ per course) would be quite a waste of space, bandwidth, and server computing resources.
  3. The offline service user. This raises red flags for me. To quote Dave O: Having non-real users in the database would have difficult-to-predict knock-on effects in different places that deal with users like reporting, enrollments, analytics, gradebook, etc.
  4. External assumptions about block internals. The proposed system would externally determine which blocks are and aren't offline-ready. That determination would be based on assumptions about each block's internals, and we'd just have to hope and trust that the assumptions don't break in practice, or change over time as the blocks get new features, bugfixes, or refactorings.

With those in mind, I would propose to investigate an alternative approach: introduce a new standard XBlock view, offline_view. This view would render an user-agnostic fragment. In other words, student state would not be available in this view--only content and settings fields would be. Because the rendered HTML would be user-agnostic, the JSS and CSS bundled into offline_view would have to call JSON APIs defined on the XBlock in order to retrieve student state and synchronize user events.

By default, an XBlock class would not support offline_view, but it could opt-in by defining offline_view like any other view method. XBlock classes could also partially implement the view: that is, they could try to render themselves statically, or raise an exception if it's not possible based on its content+settings. For example, the ProblemBlock would need to implement something like this:

class ProblemBlock(...):
    ...
    def offline_view(self, context):
        ...
        if self.randomize != RANDOMIZATION.NEVER:
            raise OfflineViewUnavailable  # Randomization requires student state (the seed)!
        if 'loncapa/python' in response_types:
            raise OfflineViewUnavailable  # Python problems require student state!
        if ...:
            raise OfflineViewUnavailable  # ... any other thing that would require student state
        fragment = ...  # Render fragment based on content and settings
        return fragment

How would offline_view be used?

  • Mobile offline mode, obviously. Upon course publish, CMS would fire off a task to walk through the course hierarchy and pre-render any blocks with offline_view available. If a block raises OfflineViewUnavailable, it is skipped. All pre-rendered blocks could be saved into a single archive and pushed to media storage. JS, CSS, and other shared block resources should be de-duped by using a hash of the file contents.
  • Anonymous access. Out of scope for this project, but we can (in the future) re-implement public_view on top of offline_view. In other words, if it is possible to pre-render a block without knowing user state, then it is possible to serve that pre-renderable view as the public experience for logged-out users.
  • Non-mobile offline mode. Again, out of scope, but realize that there is nothing mobile-specific about this proposal. With enough investment in our Web frontend, it could leverage offline_mode in order to make the Web experience resilient under poor connections.
  • Regular student access. Even further out of scope, but this system leaves open the possibility of eventually implementing student_view on top of offline_view wherever it's supported. In other words, for compatible XBlocks, we would always serve offline-ready content, and if a user has a good connection, that's a special case.

Regarding CMS vs LMS rendering: If implemented to this design, I believe it should be possible to call offline_view from LMS or CMS and get identical results, with the exception of asset paths, which will need to be special-handled either way. Because the result is identical either way, I believe the simplicity of calling a CMS task from CMS makes it more attractive for pre-rendering than LMS.

@e0d
Copy link
Contributor

e0d commented Feb 28, 2025

@kdmccormick and I had a chance to talk through some of the details in his review. I agree that adding a view to XBlocks to support this new case is a superior approach to introducing a new facility to render XBlocks that is outside of the design we currently have.

I'm not as convinced on the duplicate asset question as I think that the transfer and storage cost of problem blocks is probably a rounding error compared to video. We should do some analysis of a highly complex course to see what the impact would be. We are trading off exported blocks being self-sufficient against optimizing transfer and storage. All to say, I think more discovery is required here.

We also discussed that even with XBlocks being able to advertise whether they support offline mode that we probably need a site-wide configuration option that allows operators to allow/deny list which blocks they want available on mobile. This would be new scope here.

It's also worth noting that because the problem block wraps different things, some of which will be offline ready and some of which will not, that there will be some messiness in the internals of the block. This would also complicate implementing the site-wide config because an operator might want to allow some types of problem renderings and not others.

As finalizing this is blocking closing our a project, I recommend that we close the project, leave this ADR open, and come back to it when offline mode is back on the frontlog.

@mphilbrick211 mphilbrick211 moved this from Waiting on Author to In Eng Review in Contributions Mar 3, 2025
@NiedielnitsevIvan NiedielnitsevIvan force-pushed the glugovgrglib/mobile_offline_availability_ADR branch from de31bc4 to 00750b7 Compare April 8, 2025 15:51
@NiedielnitsevIvan
Copy link
Contributor

@kdmccormick Thank you for your detailed response and patience. I have added part of this description to ADR 1 and put the rest of the future improvements in a separate ADR 2.

@kdmccormick kdmccormick self-requested a review April 10, 2025 14:34
Copy link
Member

@kdmccormick kdmccormick left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the edits. Some questions and requests, but this is heading in the right direction.

  • Please clarify that this offline content generation happens in the CMS process, not LMS.
  • The text of the ADR does a good job explaining what offline_view is and how it fits into the system. Could you edit the diagram to also include of offline_view?
  • I'm glad that de-duping of assets is now in the plan. But, I'm skeptical that we should be generating a zip archive for the entire course. This would cause the regeneration of the entire zip each time any block in the course is edited. Could you explain the decision to zip the entire course rather than zip at a lower level, like the Unit?
  • The view methods of the structural blocks (course, section/chapter, and subsection/sequential) are not used any more since legacy courseware and legacy Studio have been deprecated. The medium-term direction is actually to stop treating those as a XBlocks. So, I do not think we should add offline_view to them. Will you still need to pre-render those structures, or would it work to only pre-render components (problems, text, etc.), and assume that the app has already downloaded the structure of the course?

@openedx-webhooks openedx-webhooks added the core contributor PR author is a Core Contributor (who may or may not have write access to this repo). label Jun 19, 2025
@kyrylo-kh
Copy link
Member

Hello @kdmccormick! Here are answers on questions:

Please clarify that this offline content generation happens in the CMS process, not LMS.

Currently, offline content generation is handled inside the LMS process. The CMS sends a publish signal (course_cache_updated), which triggers a Celery task that lives in LMS and renders content using the LMS-based XBlockRenderer. Since block content in CMS is currently rendered using legacy backbone JS, a huge number of JS files would need to be included in the block archive, and mobile devices would then have to work with them. In the future, we may consider shifting the full generation pipeline to CMS to reduce cross-system complexity.

I'm glad that de-duping of assets is now in the plan. But, I'm skeptical that we should be generating a zip archive for the entire course. This would cause the regeneration of the entire zip each time any block in the course is edited. Could you explain the decision to zip the entire course rather than zip at a lower level, like the Unit?

We do not make one big ZIP for the whole course. Instead, we build and store a ZIP file for each block (e.g. each problem or text unit). When you update a block, only that block’s ZIP is re‑created, not the entire course.

The view methods of the structural blocks (course, section/chapter, and subsection/sequential) are not used any more since legacy courseware and legacy Studio have been deprecated. The medium-term direction is actually to stop treating those as a XBlocks. So, I do not think we should add offline_view to them. Will you still need to pre-render those structures, or would it work to only pre-render components (problems, text, etc.), and assume that the app has already downloaded the structure of the course?

We don’t plan to add offline_view to structural blocks like course, chapter, or sequential. These blocks don’t contain content themselves and are used only to organize other blocks. The course structure can be provided separately, so we only pre-render content blocks like problems, HTML, and videos.

The text of the ADR does a good job explaining what offline_view is and how it fits into the system. Could you edit the diagram to also include of offline_view?

Currently I'm uploading updated diagram. I also extended CMS part a bit with course cache updates process.

@kdmccormick
Copy link
Member

kdmccormick commented Jul 21, 2025

@kyrylo-kh

We do not make one big ZIP for the whole course. Instead, we build and store a ZIP file for each block (e.g. each problem or text unit). When you update a block, only that block’s ZIP is re‑created, not the entire course.

Sounds good.

We don’t plan to add offline_view to structural blocks like course, chapter, or sequential. These blocks don’t contain content themselves and are used only to organize other blocks. The course structure can be provided separately, so we only pre-render content blocks like problems, HTML, and videos.

Perfect!

Currently, offline content generation is handled inside the LMS process. The CMS sends a publish signal (course_cache_updated), which triggers a Celery task that lives in LMS and renders content using the LMS-based XBlockRenderer.

I still feel strongly that CMS should be pre-rendering these ZIP archives rather than the LMS. The pre-rendering is part of the "publish" stage of the content lifecycle and does not involve student state, so it conceptually belongs with the CMS. From a practical standpoint, handling CMS events in the LMS is not something we have done before... doing this would introduce new failure modes and create unnecessary coupling between CMS and LMS.

Since block content in CMS is currently rendered using legacy backbone JS, a huge number of JS files would need to be included in the block archive, and mobile devices would then have to work with them. In the future, we may consider shifting the full generation pipeline to CMS to reduce cross-system complexity.

Are you referencing the studio_view (the view that renders the editors)? We would not be pre-rending the studio_view. The offline_view would be more similar to the author_view, which is very similar to the student_view that the LMS displays. I do not know of any additional legacy backbone JS dependencies necessary to render the author_views of problem, html, or video blocks. Could you point me to some code that shows how CMS would need these additional dependencies in order to pre-render blocks?

@kdmccormick kdmccormick marked this pull request as draft August 14, 2025 16:53
@kdmccormick kdmccormick marked this pull request as ready for review August 14, 2025 16:53
@kdmccormick
Copy link
Member

Hey @kyrylo-kh , can you give me a rough estimate on when you'll be working on this again, just so I can make sure I can carve out some time to give a prompt review and help get it merged?

@kyrylo-kh
Copy link
Member

Hello @kdmccormick
We’ve scheduled the investigation to reproduce the offline content rendering issue in CMS and will follow up with an estimate and proposed next steps in approximately one week.

@kyrylo-kh
Copy link
Member

@kdmccormick
At the moment the ZIP export uses the LMS courseware-chromeless.html LMS template. This template already includes the right LMS JS/CSS and renders correctly on its own. That is why the ZIP works fine when generated from the LMS.

I tried moving the rendering into the CMS, but the closest template there is container_chromeless.html. This one is very different: it bootstraps Studio editing UI and loads container.js, which pulls in Backbone/Underscore views and many Studio-only dependencies. Example:

<script src="assets/bundles/js/factories/container.js" type="text/javascript"></script>
<script type="text/javascript">
    ContainerFactory(
        [{"type": "html", ...}],
        "view",
        {
            isUnitPage: false,
            canEdit: true,
            outlineURL: "/course/course\u002Dv1:offline+1+1?format\u003Dconcise",
            clipboardData: {"content": null, "source_usage_key": "", "source_context_title": "", "source_edit_url": ""},
            isIframeEmbed: true,
        }
    );
</script>

That code is meant for authoring, not for student/offline use. It brings a whole chain of legacy modules that are hard to run in a simple offline archive.

To realistically support this in the CMS we would need to:

  • write and maintain a new template specifically for offline rendering (or container preview),
  • investigate the full import chain of container.js and related modules
  • mock or remove many Studio-only dependencies (api calls)

Disadvantages of this approach:

  • Huge size of archive because we need to download all of the backbone libraries in any archive
  • Dependencies must be carefully collected (big effort)
  • Major changes in CMS (existing js files will have to be reused or supplemented)

I heard from Ed that Backbone.js will be obsolete in OpenEdx. frontend-app-authoring will use own render (not iframe with Backbone.js)

@kdmccormick
Copy link
Member

I heard from Ed that Backbone.js will be obsolete in OpenEdx. frontend-app-authoring will use own render (not iframe with Backbone.js)

This is partially correct, at most. While the vast majority of the legacy studio frontend is being removed, frontend-app-authoring will still iframe in the CMS backend's container_embed URL, which renders the new CMS templatecontainer-chromeless.html. The React-based editing UI is layered on top of the iframe. Here is the PR which added that template, if that helps: e4a1e41

@kyrylo-kh Does that shed any light on a CMS-based solution? For example, would it be possible to use container-chromless.html as a guide for making a simplified component-chromeless.html, which renders an XBlock offline view with minimal unnecessary JS and CSS?

@kyrylo-kh
Copy link
Member

kyrylo-kh commented Oct 2, 2025

@kdmccormick

I investigated how XBlock is rendered in Open edX, what JS files are used, etc.
The conclusion: an XBlock can be rendered the same way in both LMS and CMS.
I built a small proof of concept.

To do this, you need to set up the XBlock correctly and provide the required services.
Here is a minimal working example:

services = {
    "studio_user_permissions": StudioPermissionsService(request.user),
    "i18n": XBlockI18nService,
    "mako": mako_service,
    "settings": SettingsService(),
    "user": DjangoXBlockUserService(
        request.user,
        user_role=get_user_role(request.user, self.usage_key.course_key),
    ),
    "partitions": StudioPartitionService(course_id=self.usage_key.course_key),
    "teams_configuration": TeamsConfigurationService(),
    "sandbox": SandboxService(contentstore=contentstore, course_id=self.usage_key.course_key),
    "cache": CacheService(cache),
    "replace_urls": ReplaceURLService,
}

Then you can call next code to get fragment:

block.render("student_view", context=student_view_context)

I also created a new HTML template called offline_container.html and included the minimal set of JS files needed to render the problem:

<script src="assets/common/js/vendor/jquery.js" type="text/javascript"></script>
<script src="assets/bundles/commons.5b0663a1e4e51afc5fb2.js" type="text/javascript"></script>
<script src="assets/bundles/ProblemBlockDisplay.0d6e10aabc21778c1aae.js" type="application/javascript"></script>
<script src="assets/bundles/XModuleShim.f78dfb4f07eae2a41a0c.js" type="application/javascript"></script>
<script src="assets/bundles/bootstrap.bundle.js" type="application/javascript"></script>
<script src="assets/common/js/xblock/core.js" type="text/javascript"></script>
<script src="assets/common/js/xblock/runtime.v1.js" type="text/javascript"></script>
<script src="assets/xmodule.js" type="text/javascript"></script>

With this setup it worked.
In CMS, the archive is generated with these JS files and the problem renders successfully.

Next step: I’ll update the diagram and close this topic. From now on, generation will be handled on the CMS side.

@kdmccormick
Copy link
Member

Nice! Thanks @kyrylo-kh .

@stan-neichev
Copy link

@kdmccormick hi! Can we approve the ADR and move forward with the suggested solution?

Copy link
Member

@kdmccormick kdmccormick left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great. Just some small changes, but otherwise I'm ready to approve and merge.

* **Dropdown with Hints and Feedback** - partial support without Hints and Feedback
* **Multiple Choice with Hints and Feedback** - partial support without Hints and Feedback
* **Numerical Input with Hints and Feedback** - partially supported without Hints and Feedback
* **Text Input with Hints and Feedback** - partially supported without Hints and Feedback
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* **Text Input with Hints and Feedback** - partially supported without Hints and Feedback
* **Text Input with Hints and Feedback** - partially supported without Hints and Feedback
* **Blank Advanced Problems** - partially supported, without loncapa/python problems or multi-part problems

I presume that python-evaluated problems will not be supported. @stan-neichev can you confirm?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kdmccormick python-evaluated problems won't be supported for now, you're right

Status
------

Proposed
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Proposed
Accepted

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

Comment on lines +87 to +101
* **Sync Mechanism**: Periodically synchronize local data with the server when the device is online.
* **Sync on app side**: On course outline screen, check if the course content is up to date and update it if necessary.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The JS bridge will intercept ajax requests in the mobile application and store the responses. The user will see the message "Your response is accepted" and the Submit button should be disabled.
Then, when the user gets the Internet, the mobile application will send the saved responses to the backend one by one, to the standard xblock handler.

Can you add these ^ details to the ADR?

@kdmccormick kdmccormick self-requested a review October 10, 2025 17:05
Copy link
Member

@kdmccormick kdmccormick left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚀

@kdmccormick kdmccormick merged commit 515a301 into openedx:master Oct 10, 2025
49 checks passed
@github-project-automation github-project-automation bot moved this from In Eng Review to Done in Contributions Oct 10, 2025
efortish added a commit to eduNEXT/edx-platform that referenced this pull request Oct 26, 2025
feat: removed spaces check for spam urls (openedx#37238)

fix: remove CSRF_TRUSTED_ORIGINS_WITH_SCHEME variable (openedx#37195)

fix: Passing unsaved model instances to related filters is no longer … (openedx#37227)

* fix: Passing unsaved model instances to related filters is no longer allowed.

fix: sidebar completion for completable XBlocks with children

It is possible to create a completable XBlock with children.
An example is the Library Content Block with the
`MARK_LIBRARY_CONTENT_BLOCK_COMPLETE_ON_VIEW` feature toggle.
The sidebar should use the same mechanism as the `BlockCompletionTransformer`
and the `edx-completion` library. It means that we should treat:
1. An aggregator XBlock as completed only when all its children are completed.
2. A completable XBlock as completed when it is directly marked as completed
   (without checking the completion of its children).

fix: show correct icons in the sidebar for units with custom XBlocks

Currently, the sidebar relies only on the XBlock's `category` class attribute
(called `type` in the transformers). This behavior is inconsistent with the
legacy subsection navigation, which relies on the `XModuleMixin.get_icon_class`
method. This commit adds the `icon_class` to the fields collected by the
transformers and uses it to determine whether the "problem" or "video" icon
should be displayed for a unit in the sidebar.

feat: Use dropdown for units when more then 15

When dealing with subsections that have a lot of units, show a dropdown for
unit selection to simplify navigation.

feat: add a POST endpoint for listing courses (openedx#35586)

* feat: add a POST endpoint for listing courses

feat: reindex course and recreate upstream links post import and course re-run (openedx#37237)

Index the newly created course after import and course re-run. Also recreate upstream links after course re-run.

We make use of newly created COURSE_RERUN_COMPLETED signal to run post re-run processes.

feat: Add the top-level parent logic to the ready_to_sync value in the UpstreamLink (openedx#37217)

- Updates `UpstreamLink.ready_to_sync` with the top-level parent logic: In a container, `ready_to_sync` is `True` if the container or any children have changes.
- Updates `decline_sync` to decline children recursively.

fix!: session ID stability while maintaining inactivity timeout (openedx#36896)

This change modifies the SessionInactivityTimeout middleware to prevent
the session ID from changing on every request while still enforcing the
inactivity timeout.

Key improvements:
- Store datetime values as ISO strings for proper serialization
- Implement hybrid session save approach that only allows full session
  saves periodically (controlled by SESSION_SAVE_FREQUENCY_SECONDS)
- Preserve session ID between requests while still tracking user activity

This resolves the issue where lms_sessionid was changing on every user
interaction, which caused problems.

BREAKING CHANGE: The breaking change is that SESSION_ACTIVITY_SAVE_DELAY_SECONDS was introduced with a 15 minute default, which will change the current behavior. It is not necessarily breaking (since it actually fixes an issue), but this is to bring more attention to the new setting because the default is reasonable, but also somewhat arbitrary.

feat: Add DOI-specific headers for link validation (openedx#37246)

feat: Upgrade Python dependency edx-enterprise (openedx#37261)

fix: bump edx-enterprise version to bump django-simple-history

Commit generated by workflow `openedx/edx-platform/.github/workflows/upgrade-one-python-dependency.yml@refs/heads/master`

Co-authored-by: UsamaSadiq <41958659+UsamaSadiq@users.noreply.github.com>

chore: Upgrade Python requirements (openedx#37229)

chore: Upgrade Python requirements (openedx#37263)

chore!: remove Proctortrack dependency

Remove all Proctortrack dependencies from the project, including:
- Python package dependencies in requirements files
- JavaScript package dependency in package.json
- Translation configuration in conf/locale/config.yaml

BREAKING CHANGE: Proctortrack proctoring provider is no longer available as a dependency.
This change removes the Proctortrack Dependency while preserving code references.

feat: Update the package lock

chore: Updating the requirements

fix: Discussion xblock error when loading for the first time
This PR fixes the user not being created when accessing the discussion xblock as the course_key was missing in some of the api calls and that lead to the forum backend not being fetched correctly.

feat!: Drop import_from_modulestore app (1/3 -- code only) (openedx#37239)

Part of: openedx#37242

feat: Allow adding custom LTI parameters via LTI_CUSTOM_PARAMS django setting

Adds a new Django setting called `LTI_CUSTOM_PARAMS` that allows extending the
list of optional LTI parameters processed by the platform. These parameters can
be used by plugins for deeper platform integration.

fix: intermittent "utils attribute not found" issue in webpack_loader (openedx#37109)

chore: Upgrade Python requirements

feat: Remove the `SEND_CATALOG_INFO_SIGNAL`

This setting controls an additive feature to send a signal on catalog
changes.  The signal is documented as a part of the list of supported
events in our openedx-events reference. It has also been running live in
the edx.org deployment for some time.

This change removes the signal and defaults to the behavior as if it is
net to true.

OPERATORS NOTE: If you override the `SEND_CATALOG_INFO_SIGNAL` in your
settings overrides for the edx-platform, you can remove that override.
This signal will always fire on catalog changes now.  The performance
impact of this change should be negligible.

chore: Updating the requirements2

fix: django52 tightened consistency around delete ordering and signal/delete() method invocation. (openedx#37250)

fix: added thread id in comment/response reported event (openedx#37276)

Co-authored-by: Ayesha Waris <ayesha.waris@A006-01000.local>

feat: added rate limit on one click unsubscribe api (openedx#37272)

* feat: added rate limit on one click unsubscribe api

* fix: fixed failing test

* chore: raise 400 error on invalid username

* fix: fixed pylint

chore: remove edx.notifications.preferences.viewed event (openedx#37285)

fix: Updated tuple unpacking of signal receivers to match current structure in django52. (openedx#37249)

fix: ensure _get_user returns saved user (with id) (openedx#37290)

Django 5.2 tightened model handling: unsaved User objects (no primary key) no longer pass through in some checks.

feat: implement course access role history table (openedx#37260)

Co-authored-by: Muhammad Faraz  Maqsood <faraz.maqsood@A006-01130.local>

chore: Upgrade Python requirements (openedx#37292)

fix: fix timezone for Django 5.2 (openedx#37293)

fix: fix test_html_tags_removal (openedx#37209)

chore: Clean up comments in github.in

Remove comment about django42 support pending release.

feat!: Drop import_from_modulestore app (2/3 -- models) (openedx#37240)

Part of: openedx#37242

fix: fix script tag quot escaped (openedx#37296)

feat: Add `unlinkable` to xblock actions and update `top_level_parent_key` on unlink [FC-0097] (openedx#37215)

- Adds the `unlinkable` action to the XBlock object sent to the frontend
- Updates the `top_level_parent_key` reference when unlinking containers. If you unlink a Section with Subsections and Units, this updates the `top_level_parent_key` for the Subsections to `None` (they are the top level now), and the `top_level_parent_key` for the Units to the corresponding parent Subsection.

fix: exception while trying to check sync status of deleted upstream (openedx#37298)

Use `Upstream.try_get_for_block` instead of `Upstream.get_for_block` which raises `BadUpstream` if upstream block is deleted.

test: Disable the Django Debug Toolbar by default.

Disable the toolbar by default but make it easy to turn back on as
needed.  This is in response to the discussion here:
    https://discuss.openedx.org/t/lets-remove-django-debug-toolbar/16847

fix: added info in notification preferences (openedx#37295)

feat: Added pluggable override on financial_assistance (openedx#37303)

chore: Upgrade Python requirements

chore: removing ENABLE_V2_CERT_DISPLAY_SETTINGS (openedx#37302)

the remnants of the logic that used this setting has been gone for a long time.
This removes the toggle.

FIXES: APER-1405

feat: Add support for using LTI data to populate user profile

Currently the LTI provider implementation auto-creates a random user when
logging in, however, the LTI launch can include relevant user details such as
their email, full name and even a username. This change makes the LTI code
use the provided details if the "Use lti pii" setting is set in the Django
admin.

chore: upgrade social-auth-core

chore: Management command to update preferences (openedx#37297)

feat: tpa automatic logout with a single redirect

feat: enhance Course Optimizer to update previous course links via API (openedx#37206)

* feat: API to update previous-run course links

* feat: handle edge cases and update tests for prev-run links API

chore: Upgrade Python requirements

feat!: Drop import_from_modulestore app (3/3 -- uninstall app) (openedx#37241)

openedx#37242

feat: Upgrade Python dependency edx-enterprise

fix: [edx-enterprise] upgrade djangorestframework and skip automatic validators

Commit generated by workflow `openedx/edx-platform/.github/workflows/upgrade-one-python-dependency.yml@refs/heads/master`

chore: geoip2: update maxmind geolite country database

feat: add custom attributes to moniter export course task (openedx#37314)

fix: Update SAMLProviderConfig for site-specific configurations (openedx#37294)

Fixes minor bugs in new SAMLProviderConfig signal
handlers.

chore: Update openedx-forum version (openedx#37320)

feat: added api for mobile configs (openedx#37323)

feat: extend courseware api with new fields

refactor: add some fields to serailizer for FE & update API docstring

refactor: fix prerequisites source

refactor: add missing docstrings, rename * remove some fields

fix: remove redundant test which breaks everything

docs: update docstring for prerequisite course serializer

docs: update docstring for course info serializer

refactor: move import inside testcase

refactor: fix unused imports

docs: add comment for skip_unless_lms

fix: remove unused fields 'prerequisites', 'ocw_links'

chore: remove deprecated DEFAULT_FILE_STORAGE and STATICFILES_STORAGE settings (openedx#37002)

Revert "feat: added api for mobile configs (openedx#37323)" (openedx#37332)

This reverts commit 3d46524.

fix: Invalid read param in forum thread api
This PR fixes the invalid read parameter being passed in forum update_thread api.
this was somehow introduced in this commit openedx@6f522f3#diff-b9d08209a02c673887f6ca72b0018758174e95508539adbcb6885f22c7844eb8L292

fix: unlink broken link (openedx#37329)

This fixes a bug that occurs when unlinking a block from a downstream block that has a broken link

fix: program details dashboard (openedx#37203)

Co-authored-by: Deborah Kaplan <deborahgu@users.noreply.github.com>

fix: fix bad serialization of courseware metadata (openedx#37338)

* Formats single_paid_mode as a dict, rather than named tuple which couldn't be serialized to DictField
* Allow ecommerce_checkout_link to be empty

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

fix: [FC-0092] fix 500 when return_type is list (openedx#36969)

There was problem in filter_discussion_xblocks_from_response(). This
function was breaking the list response for the BlocksInCourseView by
returning a dict instead of list.

chore: Upgrade Python requirements

build: Upgrade to Node 24 (openedx#37166)

Upgrade node and re-build package-lock.json

feat: Upgrade Python dependency edx-enterprise (openedx#37346)

New version adds a missed migration for Django 5.2 support

Commit generated by workflow `openedx/edx-platform/.github/workflows/upgrade-one-python-dependency.yml@refs/heads/master`

Co-authored-by: UsamaSadiq <41958659+UsamaSadiq@users.noreply.github.com>

chore!: removing of pyjwkest dependency from edx-platform (openedx#37159)

feat: automatically follow post when creating comments/responses (openedx#37318)

* feat: automatically follow  post while createing comments/responses

* feat: follow post when a comment or response is created

* test: updated tests

---------

Co-authored-by: Ayesha Waris <ayesha.waris@192.168.10.28>
Co-authored-by: Muhammad Adeel Tajamul <muhammadadeeltajamul@hotmail.com>

feat: added configurable param to rate limit email change in account settings (openedx#37349)

chore: Upgrade to django-pipeline to its latest. It has django52 support. (openedx#37355)

feat: added feature to rate limit secondary email change (openedx#37356)

feat!: remove cs_comments_service support for forum's content APIs

- This will force the use of the new v2 forum's APIs for Threads & Comment.
- Update params for get_user_subscription function. It uses the same structure as we have in the get_user_threads.

feat: Upgrade Python dependency edx-enterprise

gracefully decouples enterprise from ecommerce

Commit generated by workflow `openedx/edx-platform/.github/workflows/upgrade-one-python-dependency.yml@refs/heads/master`

feat: Upgrade Python dependency enterprise-integrated-channels

Commit generated by workflow `openedx/edx-platform/.github/workflows/upgrade-one-python-dependency.yml@refs/heads/master`

Fix: CORS issues in third-party auth disconnect by adding JSON endpoint (openedx#37100)

Add a json auth endpoint where previously there was only an HTML redirect version. This will make it easier to work with MFEs.

---------

Co-authored-by: Feanil Patel <feanil@axim.org>

docs: Fix the docs build.

With the settings re-organization the docs settings file was missing a
setting needed to properly run django.  This wasn't caught in CI because
the docs build is slow enough that we don't run it on every PR.

docs: Update the checked-in lms-openapi docs.

These are checked-in because there are some downstream users that
depend on them being checked-in.  They are also used to generate sphinx
docs based on the openapi spec.

build: Parallize the docs build.

There is no technical issue that prevents us from running this build in
parallel as far as I can tell. We can see if this will sufficiently
speed up the build for us to turn it on for PRs.

test: running tests with django52. (openedx#37357)

feat: Upgrade Python dependency edx-enterprise (openedx#37360)

fix: Moodle configuration updates were not being saved correctly

Commit generated by workflow `openedx/edx-platform/.github/workflows/upgrade-one-python-dependency.yml@refs/heads/master`

Co-authored-by: zamanafzal <11922730+zamanafzal@users.noreply.github.com>
Co-authored-by: Zaman Afzal <zamanafzal@gmail.com>

chore: Upgrade Python requirements

feat: allow editing imported text blocks (openedx#37124)

* feat: allow editing html block imported from upstream

The modified field is left untouched in future sync while storing the
upstream values in hidden fields to allow authors to revert to upstream
version at any point.

* fix: sync downstream_customized field for copy-pasted modified block

* test: add more tests

* fix: lint issues

* test: copy paste

* feat: skip sync if html data is modified

* feat: update upstream fields only when modified

* refactor: use version_synced field to skip sync

* feat: edit title inplace for library source components

* fixup! feat: edit title inplace for library source components

* fix: edit title button style

* fix: test case

* fix: lint issue

* refactor: don't show different icon for modified upstream blocks

* Revert "refactor: use version_synced field to skip sync"

This reverts commit 8b784ff.

* feat: only skip sync for modified blocks if updated as part of container

* refactor: update sync behaviour when synced individually and as part of parent

* feat: include ready to sync children info in downstream link get api

* test: fix failing tests

* fix: lint issues

* feat: new tests and update api to allow overriding modified fields in sync

* test: api changes

* refactor: edit options should be visible for individual imports

* docs: update api docs

* chore: remove old comments

chore: update @edx/brand dependency to new package @openedx/brand-openedx (openedx#37244)

feat: update saml management command (openedx#37330)

The SAML management command has been refactored from
an auto-update tool to a comprehensive report-only audit system.
The changes introduce a new --run-checks option that provides
detailed reporting on SAML configuration issues without making
any automatic changes.

feat: add ability to override middlewares for recurring nudges

* feat: add ability to override middlewares for recurring nudges

* feat: add ability to run command for all sites

fix: styles for share video functionality of the video xblock

fix: visual and progress score display enhancement

fix: add missing styles

build: Unpin pip and pip-tools.

Test with unpinning both pip and pip-tools. The latest versions have
fixed the pathing issues with `make upgrade` and the dependency
resolution issues reported in openedx/edx-lint#458

chore: Run `make upgrade`

refactor: flatten FEATURES dictionary with backward compatible proxy

feat: [AXM-2398] Add short label to assignment (openedx#36970)

Rationale: The instructor may create short labels that are longer than
3 characters, and they can be hard to work with in the mobile UI. Thus,
on mobile, it was decided to add short labels to the api response by
getting them from section breakdown, which ensures they are consistent
with the labels the user sees in the Grading section.

fix(deps): update dependency webpack-bundle-tracker to v3

fix: Upgrade django-webpack-loader to match webpack-bundle-tracker

The versions of these two tools is now kept in sync.  As a part of the
migration, the method signature for render_bundle changes which we
needed to update in our Mako templates where it doesn't automatically
pass context.

test: Fix test monkeypatches for render_bundle

Now that the signature has changed, update the testing monkeypatches as well.

fix: Use CI oriented FakeWebpackLoader

This was added in a newer version of django-webpack loader to be used in
CI.  Previously we had some monkey patches to deal with this but they
could break when changes happen to the upstream django-webpack-loader
library.

This should be a more robust solution to keep CI working and to reduce
complexity on future upgrades.

docs: Document what MFEs are on by default

Document which MFEs are currently on by default in the edx-platform code
and where the code expects those MFEs to be running including the
settings that can be overridden to change those default locations.

Consolidate common settings to platform wide settings module (openedx#37337)

* refactor: lift same settings up to openedx common module

feat!: Remove Proctortrack dependency (openedx#37284)

* chore!: remove Proctortrack dependency

Remove all Proctortrack dependencies from the project, including:
- Python package dependencies in requirements files
- JavaScript package dependency in package.json
- Translation configuration in conf/locale/config.yaml

BREAKING CHANGE: Proctortrack proctoring provider is no longer available as a dependency.
This change removes the Proctortrack Dependency while preserving code references.

* feat: Update the package lock

* chore: Updating the requirements

* chore: Updating the requirements2

* chore: Clean up comments in github.in

Remove comment about django42 support pending release.

feat: Upgrade Python dependency edx-enterprise (openedx#37372)

* feat: Upgrade Python dependency edx-enterprise

Commit generated by workflow `openedx/edx-platform/.github/workflows/upgrade-one-python-dependency.yml@refs/heads/master`

* fix: typo fix to trigger tests

---------

Co-authored-by: kiram15 <31229189+kiram15@users.noreply.github.com>
Co-authored-by: Kira Miller <kira.miller15@yahoo.com>

chore: remove outdated JWT auth related settings

fix(deps): update dependency webpack-merge to v6

fix: Use the default merge for webpack config.

The smart merge feature has been dropped from the webpack-merge library
that we were using. Use the basic merge feature instead since we're not
actually doing anything too complicated.

Also don't return null from the WorkerConfig as it can't be correctly
merged.

fix: Inconsistent update state in Course Optimizer API (openedx#37369)

* fix: Inconsistent update state in Course Optimizer API

* fix: update re-run link issue

docs: add DEPR ticket for some mfe_config settings (openedx#37370)

refactor: course container children api [FC-0097] (openedx#37375)

* feat: course container children view

* refactor: rename

* refactor: include children info in upstream info of container children

* fix: tests

* fix: test

* refactor: children check

chore: remove unused mockprock devDependency

feat!: modulestore_migrator (openedx#36873)

This introduces the modulestore_migrator app, which can be
used to copy content (courses and libraries) from modulestore
into Learning Core. It is currently aimed to work on the legacy
library -> v2 library migration, but it will be used in the future
for course->library and course->course migrations.

This includes an initial REST API, Django admin interface,
and Python API.

Closes: openedx#37211

Requires some follow-up work before this is production-ready:
openedx#37259

Co-authored-by: Andrii <andrii.hantkovskyi@raccoongang.com>
Co-authored-by: Maksim Sokolskiy <maksim.sokolskiy@raccoongang.com>

feat: updates legacy libraries list API to include migration info [FC-0097] (openedx#37286)

Adds migration info like `migrated_to_title`, `migrated_to_key` and `is_migrated` fields indicating whether the legacy library was migrated to library v2. If yes, it includes the new library name and key.

Users can also filter by migration status using `is_migrated` query param.

fix: update Course Highlights help URL (openedx#37388)

build(deps): bump codecov/codecov-action from 4 to 5

Bumps [codecov/codecov-action](https://github.com/codecov/codecov-action) from 4 to 5.
- [Release notes](https://github.com/codecov/codecov-action/releases)
- [Changelog](https://github.com/codecov/codecov-action/blob/main/CHANGELOG.md)
- [Commits](codecov/codecov-action@v4...v5)

---
updated-dependencies:
- dependency-name: codecov/codecov-action
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>

build(deps): bump actions/checkout from 4 to 5

Bumps [actions/checkout](https://github.com/actions/checkout) from 4 to 5.
- [Release notes](https://github.com/actions/checkout/releases)
- [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md)
- [Commits](actions/checkout@v4...v5)

---
updated-dependencies:
- dependency-name: actions/checkout
  dependency-version: '5'
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>

build(deps): bump actions/download-artifact from 4 to 5

Bumps [actions/download-artifact](https://github.com/actions/download-artifact) from 4 to 5.
- [Release notes](https://github.com/actions/download-artifact/releases)
- [Commits](actions/download-artifact@v4...v5)

---
updated-dependencies:
- dependency-name: actions/download-artifact
  dependency-version: '5'
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>

chore(deps): bump peter-evans/create-pull-request from 6 to 7

Bumps [peter-evans/create-pull-request](https://github.com/peter-evans/create-pull-request) from 6 to 7.
- [Release notes](https://github.com/peter-evans/create-pull-request/releases)
- [Commits](peter-evans/create-pull-request@v6...v7)

---
updated-dependencies:
- dependency-name: peter-evans/create-pull-request
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>

fix: always generate block structure from "published-only" branch (openedx#37335)

Block structures are meant to be an optimization for the LMS, meaning
that they should always be collecting from the published branch of
modulestore. This is what happens by default when it's run from the LMS
celery process, but this code is sometimes invoked from a Studio worker
(e.g. development mode celery, running in immediate in-proc mode).

---------

Co-authored-by: Peter Pinch <pdpinch@mit.edu>

docs: ADR for Visually Configuring Course Components (openedx#36856)

---------

Co-authored-by: Maksim Sokolskiy <maksim.sokolskiy@raccoongang.com>

build: use ubuntu-lts-latest in readthedocs build (openedx#37392)

feat: Upgrade Python dependency edx-enterprise (openedx#37390)

Upgrade python requirements

Commit generated by workflow `openedx/edx-platform/.github/workflows/upgrade-one-python-dependency.yml@refs/heads/master`

Co-authored-by: brobro10000 <82611798+brobro10000@users.noreply.github.com>
Co-authored-by: Hamzah Ullah <hamzahullah@yahoo.com>

feat: update course_about & catalog link generation

refactor: switch to global mfe state check

chore: updated settings for mfes

fix: fix gettings ENABLE_CATALOG_MICROFRONTEND FEATURE

fix: append /catalog to CATALOG_MICROFRONTEND_URL

test: fix ddt in test_link_with_new_catalog_page

fix: put CATALOG_MICROFRONTEND_URL with the other mfe urls

fix: look up ENABLE_CATALOG_MICROFRONTEND in settings directly, adjust tests

refactor: move filter out of if, extract about_base_url

test: fix ENABLE_CATALOG_MICROFRONTEND look up in tests

fix: use getattr in use_catalog_mfe

test: fix test overrides

feat: Add `blockType` to xblockPreview & title to xblock_iframe [FC-0097] (openedx#37362)

- Adds `blockType` and `is_modified` to the `showXBlockLibraryChangesPreview` iframe message.
- Add title to the `xblock_iframe`
- Add `is-modified` to `studio_xblock_wrapper`
- Add `disable_staff_debug_info` as a query param in `render_xblock`
- `downstream_is_modified` added to ComponentLink and ContainerLink

feat: add redirects to mfe for catalog-related legacy pages

refactor: switch to global mfe state check

refactor: use get_link_for_about_page, remove duplicate function

test: use ENABLE_CATALOG_MICROFRONTEND from settings

feat: extend program dash endpoint to b2c (openedx#37387)

chore: geoip2: update maxmind geolite country database

chore: Upgrade Django to 4.2.25 to pick up security patch (openedx#37418)

This is from running `make upgrade-package package=Django`

feat: adds new fork migration strategy (openedx#37408)

Implements the `fork` strategy, allowing the user to create new copies while migrating courses/legacy libraries to v2 libraries.

fix: reindex_studio could crash if an XBlock child isn't loadable (openedx#37177)

Co-authored-by: Chris Chávez <xnpiochv@gmail.com>

fix: survey questions options alignment in mobile view

fix: Fix the docs build.

The docs settings file needed an update for a new djangoapp that was
added. Long term we need to probably think more deeply about how we want
the LMS/CMS docs builds to work.  Do we want to separate them, or make
it easier to have a django settings file that will work with both.  For
now, we have a single settings file that is referenced for the docs
build so it needs to have all the installed apps from both.

feat: add unified certificate task API with toggle, generate, and regenerate support

fix: support parsing the pointer-tag OLX for external XBlocks (openedx#37133)

Previously, the built-in XBlocks (problem, video, etc) could be parsed
from pointer tag syntax, but externally-defined XBlocks (drag-and-drop,
ORA, etc.) could only be parsed from inline syntax. This is because the
built-in blocks have special parsing logic, defined in XmlMixin,
which is not available to external blocks.

This PR shifts the pointer tag parsing "up a level" such that the parent
blocks parse the pointer tag, regardless of whether the child is built-in
or external:
* vertical (aka unit)
* split_test (aka content experiment)
* itembank (aka problem bank)
* library_content (aka randomized legacy library)

The following parent blocks still lack support for external pointer-tag children;
we will fix this in a follow-up PR:
* randomize
* all externally defined container blocks

Part of: openedx/XBlock#823

revert: fix: support parsing the pointer-tag OLX for external XBlocks (openedx#37426)

This reverts commit d382721,
which seems to break edx-platform's ability to load the content of externally-
defined xblocks (e.g. lti_consumer) from course exports.

fix: make ALLOWED_HOSTS configurable through YAML

refactor: move ALLOWED_HOSTS to openedx/envs/common

fix: add '*' wild card in common ALLOWED_HOSTS

refactor: Move user_util library to edx-platform

The library consisted of this set of utilities and a cli and was only
being used in the edx-platform repo.  The CLI will be DEPRed along with
the repo but the code that is being used for retirement will be moved
here.

build: Drop the user-util dependency.

chore: Run `make upgrade`

build: Drop unused docker compose and sql files.

fix: Only update downstream_customized for upstream-linked blocks (openedx#37412)

We only need to track field customizations for upstream-linked (i.e.,
library-linked) blocks. Thd downstream_customized field is irrelevant for other
blocks. It would just add a ton of noise to the OLX.

Additionally, we now clear downstream_customized when severing an upstream
link.

Fixes: openedx#37411

fix: fix fork on multiple migrations (openedx#37422)

Fixes a bug where, when running a migration using the fork strategy, it was only looking at the last migration, resulting in a slug reuse, which would cause a component update instead of a new component creation.

fix: add default to `target_collection_slug` (openedx#37391)

adds a default `None` value to the `target_collection_slug` parameter of the migration rest API endpoint, to prevent a `KeyError`.

feat: Implementation of library v2 backup endpoints

Fix upgrade job pin cryptography (openedx#37436)

* fix: pin cryptography to fix the upgrade job
* fix: pin pact-python<3.0.0
---------

Co-authored-by: edX requirements bot <49161187+edx-requirements-bot@users.noreply.github.com>

feat: Upgrade Python dependency enterprise-integrated-channels

Commit generated by workflow `openedx/edx-platform/.github/workflows/upgrade-one-python-dependency.yml@refs/heads/master`

refactor: Update and migrate Video Block JS files into xmodule/assets

- Move Video Block JS files from xmodule/js/src/video/ to xmodule/assets/video/public/js/
- Update JavaScript files from  RequireJS to ES6 import/export
- test: Enable and fix Karma Js tests for Video XBlock (openedx#37351)

---------

Co-authored-by: salmannawaz <salman.nawaz@arbisoft.com>

fix: Profile MFE redirection issue (URL path override)

This error was occurring because the way the redirect URL was constructed caused the entire base path to be removed. This commit updates the URL construction method to correctly preserve the MFE's path.

feat!: Upgrading to `django52`.

chore: Run unit tests only pinned which is 5.2

Removed Django version '5.2' from the workflow.

fix: add Djang<6.0 local constraint

chore: python requirements upgrade

refactor: include container display name in children api (openedx#37429)

This helps us avoid additional API calls just to fetch display name of
the container block that is being previewed.

feat: Certificate sharing to linkedin (optionally) consider course level organization name (openedx#37331)

By adjusting social media sharing settings(specifically linkedin) certificate parameters are autopopulated to LinkedIn API. Additional setting parameters(such as CERTIFICATE_LINKEDIN_DEFAULTS_TO_COURSE_ORGANIZATION_NAME) are introduced to override existing(platform level parameter for organization name) parameters for an operator to configure course level organization name. This will enable learners to share certificate in to LinkedIn with an option for course associated organization to be autopopulated.

fix: prevent None entrance_exam_minimum_score_pct from breaking CourseOverview sync (openedx#37339)

* fix: prevent None entrance_exam_minimum_score_pct from breaking CourseOverview sync

When entrance exams are disabled in Studio, the field
`entrance_exam_minimum_score_pct` was set to `None`. This caused silent failures
when saving `CourseOverview` because the database column requires a float (NOT NULL).

This patch ensures that:
- CourseOverview sanitizes None values by falling back to
  `settings.ENTRANCE_EXAM_MIN_SCORE_PCT` (default=50).
- Studio avoids writing `None` and instead applies the configured default.

Impact:
- Prevents IntegrityErrors and silent failures when updating course settings.
- Restores proper syncing between modulestore (Mongo) and CourseOverview (MySQL).
- Fixes reported issues such as display name changes not persisting and course
  start dates not syncing.

Closes: openedx#37319

* refactor: clean up entrance_exam_minimum_score_pct handling

- Consolidate logic to avoid repeated assignments
- Centralize None fallback and int/float normalization
- Improve readability with inline comment and consistency with Open edX style

* test: update entrance exam deletion test to expect default min score

- Adjusted `test_entrance_exam_created_updated_and_deleted_successfully` to check for
  `settings.ENTRANCE_EXAM_MIN_SCORE_PCT` instead of `None` after exam deletion
- Added handling for both int and float defaults (`/100` for integer case)

feat!: remove last calls to cs_comments_service (openedx#37376)

This removes the last remaining code that called out to the
cs_comments_service. All forums backend logic now uses the v2 API from
the forum repo (https://github.com/openedx/forum). This does NOT remove
MongoDB support.

This also implements the endpoint to retrieve all comments for a user
using the new forum backend. This is not actually called from any known
frontend code, but it has not been formally deprecated as an endpoint,
and therefore needs to be supported.

As part of the cleanup, the ENABLE_FORUM_V2 course waffle flag has also
been removed, along with all remaining switching logic that used to
route between the Python API in the forum repo and service calls to the
cs_comments_service Ruby service.

Other endpoints affected (switching logic removed):

* get course commentable counts
* get/update course user stats
* update comment/thread/user
* delete thread (implementation moved to forum repo)
* follow
* retire user

This is part of the following overall DEPR ticket:
  https://github.com/openedx/cs_comments_service/issues/437

feat: api for shifting all relative past due dates

refactor: rename and refactor functions and view

refactor: use path instead of re_path

chore: upgrade jQuery UI to version 1.14.1 (openedx#37025)

revert: chore: upgrade jQuery UI to version 1.14.1 (openedx#37025) (openedx#37449)

This reverts commit e427078.

feat: query_feature_names extended by custom fields, siteconfig name changed

fix: pytlint issue

docs: docstring updated

docs: refine important notes in get_student_features_with_custom docstring

fix: use parameterized logging in extract_attr

refactor: use get_user_model() instead of

refactor: replace setattr/delattr with direct assignment

refactor: centralize get_badge_count in test class

test: remove unnecessary badge_count setup in non-matching org test

docs: add missing docstrings

fix: over-intended fix

test: similar test removed

test: another similar test removed

test: removed redundant test

test: improve enrollment_date test reliability using direct lookup

refactor!: use String field instead of Dict field to store top_level_downstream_parent_key (openedx#37448)

* refactor!: use String field instead of Dict field to store top_level_downstream_parent_key

Since this is a new field no production instance should have this field
yet. Developers need to delete their old courses as this change will
raise error in all course pages.

* chore: add `top_level_parent` field in ComponentLink and ContainerLink admin

* refactor: use ":" as separator

* refactor: block key parsing and tests

feat!: Remove Studio Maintenance & Announcements (openedx#37432)

The announcements editor was never ported to frontend-app-authoring, and
the announcements display was never ported to frontend-app-learner-dashboard.
This announcements feature is rarely used, undocumented, non-a11y-friendly, and
there were no volunteers to port it to the new frontends. It is the last
remaining part of the legacy Studio "Maintenance" dashboard. So, we are
removing it.

BREAKING CHANGE: This removes...
* Studio Maintenance dashboard legacy frontend
* Studio Edit Announcements legacy frontend
* The snippet of legacy learner dashboard which renders announcements
* openedx/features/announcements djangoapp
* The ENABLE_ANNOUNCEMENTS feature flag

Not removed:
* The announcements_announcement table from openedx/features/announcements .
  The table is most likely very small, as it is only populated by administrators. Removing
  it would be more labor for us and more risk of toil for operators than is worthwhile.

Closes: openedx#36263

 docs: ADR introducing mobile offline content support (openedx#35011)

Co-authored-by: Іван Нєдєльніцев <ivan.niedielnitsev@raccoongang.com>
Co-authored-by: Kyrylo Kholodenko <kyrylo.kholodenko@raccoongang.com>
Co-authored-by: Glib Glugovskiy <glib.glugovskiy@raccoongang.com>

feat: Upgrade Python dependency edx-enterprise

feat: add an endpoint to create a customer admin user

Commit generated by workflow `openedx/edx-platform/.github/workflows/upgrade-one-python-dependency.yml@refs/heads/master`

chore: Move sharing_sites into video_configuration app

- openedx#37456

feat: bulk modulestore migration [FC-0097] (openedx#37381)

- Adds the task, python api, and rest api view for bulk migration.
- Refactor the code to share code between single migration and bulk migration.

fix: formated_name updated

refactor: nested functions inside enrolled_students_features are now at the top of the module
naincy128 pushed a commit to edx/edx-platform that referenced this pull request Oct 27, 2025
Co-authored-by: Іван Нєдєльніцев <ivan.niedielnitsev@raccoongang.com>
Co-authored-by: Kyrylo Kholodenko <kyrylo.kholodenko@raccoongang.com>
Co-authored-by: Glib Glugovskiy <glib.glugovskiy@raccoongang.com>
naincy128 pushed a commit to edx/edx-platform that referenced this pull request Oct 27, 2025
Co-authored-by: Іван Нєдєльніцев <ivan.niedielnitsev@raccoongang.com>
Co-authored-by: Kyrylo Kholodenko <kyrylo.kholodenko@raccoongang.com>
Co-authored-by: Glib Glugovskiy <glib.glugovskiy@raccoongang.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

core contributor PR author is a Core Contributor (who may or may not have write access to this repo). FC Relates to an Axim Funded Contribution project open-source-contribution PR author is not from Axim or 2U

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

10 participants