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.

Sign up for GitHub

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

Jump to bottom

feat: [FC-0047] Implement offline content generation: #36409

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

feat: [FC-0047] Implement offline content generation: #36409

wants to merge 1 commit into from
+2,058 −5

Conversation

NiedielnitsevIvan
Copy link
Contributor

Description

This request implements the functionality of generating content for offline mode, and extending the UI to enable it, allowing users to access certain features of the Open edX platform without an internet connection. The motivation behind this feature is to enhance the user experience by providing uninterrupted access to educational content.

Currently, the following blocks are supported:

  • Common problems:
    • Checkboxes - full support
    • Dropdown - full support
    • Multiple Choice - full support
    • Numerical Input - full support
    • Text Input - full support
    • Checkboxes with Hints and Feedback - partial support without Hints and Feedback
    • 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
  • Text:
    • Text - full support
    • IFrame Tool - full support
    • Raw HTML - full support
    • Zooming Image Tool - full support
  • Video - already supported

Changes:

  • Added a new event to track course structure updates.
  • Added a new signal to start generating xblocks archives when a course is published.
  • Added a renderer for html of xblocks with changes of paths to static files (css and js files) to local ones.
  • Added collection and saving of static files to the block archive.
  • Added a new waffle flag offline_mode.enable_offline_mode to enable/disable the generation of course content offline.
  • Expanded /api/mobile/v4/course_info/blocks/ with information about the block archive for downloading it to a mobile device.

Useful information to include:

  • More detailed information is available in this ADR.

Supporting information

FC-0047

Testing instructions

TBD

Deadline

ASAP

@NiedielnitsevIvan
feat: [FC-0047] Implement offline content generation:
41783d5 
 * feat: [FC-0047] create xblock renderer

 * feat: [FC-0047] Add retry to content generation task

 * feat: [FC-0047] Add authorization via cms worker for content generation view

 * fix: [FC-0047] fix problem block offline generations

 * feat: [FC-0047] Implement s3 storage supporting

 * fix: [FC-0047] fix error 404 handling and optimize for not modified blocks

 * refactor: [FC-0047] refactor JS bridge for IOS and Android

 * feat: [FC-0047] save external files and fonts to offline block content

 * test: [FC-0047] Cover Offline Mode API with unit tests

 * fix: [FC-0047] provide a file URL by using url method

 * feat: [FC-0047] add js bridge to xblock html

 * fix: [FC-0047] fix data sent to the bridges

 * feat: [FC-0047] add delete offline content functionality on block delete
@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Mar 19, 2025
@openedx-webhooks
Copy link

Thanks for the pull request, @NiedielnitsevIvan!

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

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.
🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads
🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

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.

@mphilbrick211 mphilbrick211 added the FC Relates to an Axim Funded Contribution project label Mar 19, 2025
@e0d
Copy link
Contributor

e0d commented Mar 19, 2025

@NiedielnitsevIvan Looks like there are some failing tests. I also have some context questions that I'll ask in Slack.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
FC Relates to an Axim Funded Contribution project open-source-contribution PR author is not from Axim or 2U
Projects
Contributions
Status: Waiting on Author
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@NiedielnitsevIvan @openedx-webhooks @e0d @mphilbrick211