Skip to content

Conversation

@holaontiveros
Copy link
Contributor

@holaontiveros holaontiveros commented May 23, 2025

fixes #1692

Description

Currently when the ENABLE_COMPLETION_TRACKING_SWITCH waffle switch is disabled the frontend doesn't take it into account and still displays completion for anything that was already completed.

This PRs uses the same API fo the sidebar toggles that already exists where in this PR for edx-platform was added the current status of the switch and based on that it changes how the "completion status" it's shown, which it would be the default for nothing being touched at that point on the course

Testing instructions

Assumptions:

  • You have a tutor dev environment running
  • This MFE with the feature branch
  • You have any course already imported (testing course is good enough)

Steps:

  • Make sure that completion.enable_completion_tracking is on. (in a normal install you could find it here: http://local.openedx.io:8000/admin/waffle/switch/1/change/)
  • Go to your course and complete a couple of sections and make sure you see the green checks
  • Disable the completion.enable_completion_tracking
  • Check the course again, you shouldn't see any completion checks even if you already had some (this is purely visual and it's the expected behaviour)

Screenshots

flag disabled
image

flag enabled
image

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label May 23, 2025
@openedx-webhooks
Copy link

Thanks for the pull request, @holaontiveros!

This repository is currently maintained by @openedx/committers-frontend-app-learning.

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.

@codecov
Copy link

codecov bot commented May 23, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.43%. Comparing base (67bb54a) to head (4206dbf).
Report is 1 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1714      +/-   ##
==========================================
+ Coverage   90.42%   90.43%   +0.01%     
==========================================
  Files         344      344              
  Lines        5785     5793       +8     
  Branches     1348     1394      +46     
==========================================
+ Hits         5231     5239       +8     
+ Misses        537      535       -2     
- Partials       17       19       +2     

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@jacobo-dominguez-wgu jacobo-dominguez-wgu added the mao-onboarding Reviewing this will help onboard devs from an Axim mission-aligned organization (MAO). label May 27, 2025
@holaontiveros holaontiveros requested a review from Copilot May 27, 2025 16:03
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

@holaontiveros holaontiveros requested a review from Copilot May 27, 2025 16:12
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

@holaontiveros holaontiveros requested a review from a team May 30, 2025 19:27
Copy link
Contributor

@arbrandes arbrandes left a comment

Choose a reason for hiding this comment

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

@holaontiveros, the code looks good, thanks!

Can you please include step-by-step testing instructions in the PR, though? Assume the reviewer has a standard Tutor dev environment with the demo course loaded and this PR checked out and running, but nothing more.

@holaontiveros
Copy link
Contributor Author

holaontiveros commented Jun 4, 2025

@holaontiveros, the code looks good, thanks!

Can you please include step-by-step testing instructions in the PR, though? Assume the reviewer has a standard Tutor dev environment with the demo course loaded and this PR checked out and running, but nothing more.

@arbrandes Done, thank you

Copy link
Contributor

@arbrandes arbrandes 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 test instructions! This works as intended, and the code is good. Approved!

@arbrandes arbrandes merged commit 31b02d7 into openedx:master Jun 4, 2025
7 checks passed
@github-project-automation github-project-automation bot moved this from Needs Triage to Done in Contributions Jun 4, 2025
@holaontiveros holaontiveros deleted the feat/OEXCOM-80-disable-completion-item-icons-on-flag branch June 4, 2025 19:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

mao-onboarding Reviewing this will help onboard devs from an Axim mission-aligned organization (MAO). 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.

UI Show Completion even when completion.enable_completion_tracking is disabled.

6 participants