Locked Content Support #430

0x29a · 2025-02-17T19:01:28Z

Description

Here is what happens when you try to access any section before completing prerequisites in LMS:

Here is what happens when you try to access any unit in a gated subsection using the mobile app (the first subsection on the video is a prerequisite to the second):

before.mp4

With the fix from this PR:

after.mp4

Testing instructions

Setup the latest version of Tutor locally with https://github.com/overhangio/tutor-android. It doesn't matter if it can't build an image. We only need it to create OAuth application.
Create and configure a course like this:
https://github.com/user-attachments/assets/0e943622-0577-4c98-a538-e407f53a9e96
Launch the app in the Android emulator. Be sure to make this and this local changes to allow it to connect to a local Tutor instance.
Run ./adb reverse tcp:8000 tcp:8000 from ~/Android/Sdk/platform-tools (if you're on Linux) directory to allow your virtual device communicate with the Tutor instance.
Replicate the behavior from the "after.mp4" video above in the description.

openedx-webhooks · 2025-02-17T19:01:34Z

Thanks for the pull request, @0x29a!

This repository is currently maintained by @openedx/openedx-mobile-maintainers.

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.

core/src/main/java/org/openedx/core/data/model/GatedContentModel.kt

core/src/main/java/org/openedx/core/data/model/SequenceModel.kt

core/src/main/java/org/openedx/core/domain/model/GatedContent.kt

core/src/main/java/org/openedx/core/domain/model/Subsection.kt

Adds a "locked" screen when trying to access content that's locked due to incomplete prerequisites.

e0d · 2025-02-19T21:43:01Z

@marcotuts and @edschema this looks pretty useful, but needs a product eye.

volodymyr-chekyrta · 2025-02-21T09:43:25Z

course/src/main/java/org/openedx/course/presentation/section/CourseSectionViewModel.kt

+                if (networkConnection.isOnline()) {
+                    val sectionData = interactor.getSubsection(blockId)
+                    if (sectionData.gatedContent.gated) {
+                        _uiState.value = CourseSectionUIState.Gated(
+                            prereqId = sectionData.gatedContent.prereqId,
+                            prereqSubsectionName = sectionData.gatedContent.prereqSubsectionName,
+                            gatedSubsectionName = sectionData.gatedContent.gatedSubsectionName,
+                        )
+                        return@launch
+                    }
+                }


@0x29a, thanks for the contribution; it's a great improvement.

A few architectural concerns:

The CourseSubsection screen is optional, it's ignored if COURSE_DROPDOWN_NAVIGATION_ENABLED is enabled.

openedx-app-android/course/src/main/java/org/openedx/course/presentation/outline/CourseOutlineScreen.kt

Line 111 in 18c50f5

if (viewModel.isCourseDropdownNavigationEnabled) {

The current implementation works only if the internet is available, which leads to inconsistent behavior in offline mode.

To address both issues, we must rely on the /api/mobile/{api_version}/course_info/blocks/ endpoint that we use to work with course structure and related data. If that endpoint doesn't provide us with that information, I would consider starting by adding that data to the endpoint.

@e0d @marcotuts wdyt?

Thank you for the review, @volodymyr-chekyrta!

We've tried to add the locked content information to that endpoint, but it proved to be really hard, so we had to resort to this "online-only" half-measure, which solves the problem for us. Once locked content data is available in the /api/mobile/{api_version}/course_info/blocks/ endpoint, it should be very trivial to update the implementation of this feature to use it.

edschema · 2025-02-21T18:01:25Z

This is great..! A couple product notes:

We have a pattern for similar screens that shows a large icon, text, and call to action. For the prerequisite lock screen, I'd suggest following that pattern for the sake of consistency.
For the button, I'd suggest a minor change from 'Go to Prerequisite Section" to just "Go to Prerequisite".

cc: @marcotuts @sdaitzman, any other product notes?

mphilbrick211 · 2025-03-12T15:03:07Z

Hi @edschema @marcotuts - just checking to see if there's any updates here?

sdaitzman · 2025-03-12T17:52:51Z

No other notes from me, the proposed design from @edschema looks good here!

mphilbrick211 · 2025-05-12T18:55:14Z

@marcotuts @edschema is this all set?

edschema · 2025-05-12T18:57:26Z

Yes, all set thank you @mphilbrick211!

mphilbrick211 · 2025-05-12T19:12:41Z

@openedx/openedx-mobile-maintainers - would someone be able to please review / merge this for us?

volodymyr-chekyrta · 2025-05-14T08:49:19Z

@openedx/openedx-mobile-maintainers - would someone be able to please review / merge this for us?

@0x29a @mphilbrick211 I reviewed it previously. I had only one concern: This solution is not suitable for everyone.
We can merge it, but I would like to have a feature flag to manage this feature.

@0x29a Could you please introduce a feature flag for this feature?

0x29a · 2025-05-16T09:46:14Z

Thank you for your review, @edschema!

@mphilbrick211, @volodymyr-chekyrta - I apologize for the lack of activity here. We've run out of budget for up-streaming this feature and had to pause work on it back then. Before adding the feature flag, I'd like to address @edschema comments and review again your first concern from this comment. I'll try to re-visit this in the coming weeks.

mphilbrick211 · 2025-09-16T20:06:20Z

Thank you for your review, @edschema!

@mphilbrick211, @volodymyr-chekyrta - I apologize for the lack of activity here. We've run out of budget for up-streaming this feature and had to pause work on it back then. Before adding the feature flag, I'd like to address @edschema comments and review again your first concern from this comment. I'll try to re-visit this in the coming weeks.

Just checking in on this, @0x29a!

mphilbrick211 · 2025-12-19T18:20:34Z

Closing for now - can reopen if needed.

openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Feb 17, 2025

github-advanced-security bot found potential problems Feb 17, 2025

View reviewed changes

0x29a force-pushed the 0x29a/BB-9492/locked-content branch from 23797f1 to 58739a1 Compare February 18, 2025 13:24

feat: locked content support

2947fa7

Adds a "locked" screen when trying to access content that's locked due to incomplete prerequisites.

0x29a force-pushed the 0x29a/BB-9492/locked-content branch from 58739a1 to 2947fa7 Compare February 18, 2025 13:29

mphilbrick211 requested a review from a team February 19, 2025 21:40

volodymyr-chekyrta reviewed Feb 21, 2025

View reviewed changes

itsjeyd added the product review PR requires product review before merging label Mar 13, 2025

itsjeyd moved this from Ready for Review to Product Review in Contributions Mar 13, 2025

mphilbrick211 moved this from Product Review to Ready for Review in Contributions May 12, 2025

mphilbrick211 requested a review from a team May 12, 2025 19:12

mphilbrick211 added product review complete PR has gone through product review and removed product review PR requires product review before merging labels May 12, 2025

mphilbrick211 added the inactive PR author has been unresponsive for several months label Sep 16, 2025

mphilbrick211 added closed inactivity PR was closed because the author abandoned it and removed inactive PR author has been unresponsive for several months labels Dec 19, 2025

mphilbrick211 closed this Dec 19, 2025

github-project-automation bot moved this from Ready for Review to Done in Contributions Dec 19, 2025

Locked Content Support #430

Locked Content Support #430

Uh oh!

Conversation

0x29a commented Feb 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Testing instructions

Uh oh!

openedx-webhooks commented Feb 17, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

e0d commented Feb 19, 2025

Uh oh!

volodymyr-chekyrta Feb 21, 2025

Choose a reason for hiding this comment

Uh oh!

0x29a Feb 21, 2025

Choose a reason for hiding this comment

Uh oh!

edschema commented Feb 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mphilbrick211 commented Mar 12, 2025

Uh oh!

sdaitzman commented Mar 12, 2025

Uh oh!

mphilbrick211 commented May 12, 2025

Uh oh!

edschema commented May 12, 2025

Uh oh!

mphilbrick211 commented May 12, 2025

Uh oh!

volodymyr-chekyrta commented May 14, 2025

Uh oh!

0x29a commented May 16, 2025

Uh oh!

mphilbrick211 commented Sep 16, 2025

Uh oh!

mphilbrick211 commented Dec 19, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

0x29a commented Feb 17, 2025 •

edited

Loading

edschema commented Feb 21, 2025 •

edited

Loading