Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

completion.enable_completion_tracking waffle flag disablement doesn't remove the progress tracking UI #245

Closed
throwaway-a opened this issue Jan 10, 2023 · 21 comments
Assignees
Labels
bug Report of or fix for something that isn't working as intended
Milestone

Comments

@throwaway-a
Copy link

In this thread Braden MacDonald said that the completion.enable_completion_tracking waffle flag should disable the progress tracking UI. I expected it to disable the auto-populating green checkmarks. But that has not been my experience since I upgraded to Nutmeg. This is a regression from the Lilac behavior.

Braden also said "Technically the Waffle flag should simply determine whether or not completion is tracked in the database, not whether or not the green checks are displayed to learners, but I think the same setting was historically used for both."

I would like to request that the Lilac behavior is returned, so that I can have students track their own progress manually via completion xblocks.

@throwaway-a throwaway-a changed the title completion.enable_completion_tracking disablement doesn't remove the UI completion.enable_completion_tracking waffle flag disablement doesn't remove the progress tracking UI Jan 10, 2023
@bradenmacdonald
Copy link

Just to clarify, I'm not sure if the waffle flag should disable the UI. It probably makes more sense to have a separate configuration to toggle the UI (e.g. an environment variable for the Learning MFE). Because I can imagine cases where people want the data to be tracked in the backend but not shown in the frontend. But certainly it's not possible to show the UI if the data isn't there, so the "UI" toggle could default to the value of the waffle flag.

@throwaway-a
Copy link
Author

That is a good point. I wouldn't mind having the data tracked behind the scenes so I can query it, but I don't want it showing up for students, because it tends to confuse them when they don't understand how to get a completion mark on a page.

@throwaway-a
Copy link
Author

Does anyone know where the actual icons for the grayed out circles with checkmarks are, so that I can replace them with 1 pixel empty images? That would at least let me hack my local instance to stop showing these to students, and allow me to upgrade my server to Olive. (This UI is currently a blocking change for me. I can't confuse students like this.)

@jalondonot jalondonot added this to the Olive.3 milestone Feb 20, 2023
@throwaway-a
Copy link
Author

throwaway-a commented Feb 27, 2023

Just to put a finer-point on it, here is what students see due to the inability to hide this UI:

image

They will always see a 0% course completion on their Progress page, even if the grade is non-0%. This is obviously confusing to students, and thus is not something we can ship. We're stuck on Lilac until this is resolved.

The un-checkable checkmarks are bad, but they're not ship-blockers...

image

@pdpinch
Copy link

pdpinch commented Mar 3, 2023 via email

@throwaway-a
Copy link
Author

throwaway-a commented Mar 3, 2023

I certainly didn't manually set that with a tutor plugin or anything like that. And I don't get any hits for either of

grep -r SHOW_PROGRESS_BAR /home/ubuntu/.local/share/tutor/env/
grep SHOW_PROGRESS_BAR /home/ubuntu/.local/share/tutor/config.yml

So is there somewhere else I should look on a tutor Nutmeg install?

Also I'm not sure whether the "we" there is referring to your own organization, or the maintainers of Open edX? I checked the cloned-then-upgrade-to-Olive copy of my server and it displays the same UI as above on Olive.

@mariajgrimaldi mariajgrimaldi added the documentation Relates to documentation improvements label Mar 20, 2023
@mariajgrimaldi
Copy link
Member

@throwaway-a: I'll be testing some configurations. I'll let you know what works for me

@mariajgrimaldi mariajgrimaldi added bug Report of or fix for something that isn't working as intended and removed documentation Relates to documentation improvements bug Report of or fix for something that isn't working as intended labels Mar 20, 2023
@mariajgrimaldi mariajgrimaldi self-assigned this Apr 3, 2023
@jalondonot
Copy link

Any update on this, @mariajgrimaldi?

@jalondonot jalondonot removed this from the Olive.3 milestone May 15, 2023
@throwaway-a
Copy link
Author

@mariajgrimaldi Since this slipped out of Olive.3 is this also not expected to be solved in Palm? (I wanted to upgrade to Palm before its released specifically to test this, since this is my upgrade-blocker.)

@mariajgrimaldi
Copy link
Member

The progress tab can be turned off using the learning MFE using these changes: #278 (comment)
I already opened a PR and it's ready for review. Do you think that would be enough?

@jalondonot jalondonot added this to the Palm.1 milestone May 26, 2023
@throwaway-a
Copy link
Author

If I'm understanding you correctly, and "progress tab can be turned off" means the entire "Progress" tab would disappear, then no, that wouldn't be helpful. Students need to be able to see their course progress, and find any units that they didn't complete. I just need the inaccurate and confusing "Course completion 0%" UI that I showed above to disappear, like it used to.

But I'm not sure if you meant that the fix in #278 turns off the entire Progress tab? Because the fix discussion in #278 seems to be suggesting that it's updating the code to correct the root cause error of an incorrect case in the truth check?

@throwaway-a
Copy link
Author

throwaway-a commented Jun 12, 2023

@mariajgrimaldi I'm testing Palm, and the toggle doesn't seem to be hiding the erroneous 0% progress graph.

First, I would note that when I toggle this off and go to save, there is temporarily an error displayed, as shown below, before the dialog disappears.
image

Then it acts like it applied the change, and I see the below the next time I go into the gear icon:
image

I also see this under "Advanced Settings" for the course.
image

However, the students accounts still see this, so it seems that the change is not actually affecting the UI:
image

@mariajgrimaldi
Copy link
Member

I opened an issue in the MFE repo: openedx/frontend-app-authoring#517

@mariajgrimaldi mariajgrimaldi modified the milestones: Palm.1, Palm.2 Jul 24, 2023
@mariajgrimaldi
Copy link
Member

The latest update is found here: openedx/frontend-app-authoring#517 (comment)

@mariajgrimaldi mariajgrimaldi added the bug Report of or fix for something that isn't working as intended label Aug 7, 2023
@mariajgrimaldi mariajgrimaldi modified the milestones: Palm.2, Palm.3 Aug 16, 2023
@mariajgrimaldi mariajgrimaldi modified the milestones: Palm.3, Quince.1 Oct 16, 2023
@antoviaque
Copy link

@mariajgrimaldi I'm following up on some older items brought up in the core contributor sprints retro - I see that the linked issues are marked as closed/merged, is the current issue thus fixed now? Should the current ticket be closed?

@throwaway-a
Copy link
Author

@antoviaque What's the best way to test this to confirm it's working as expected?

@antoviaque
Copy link

@throwaway-a I do not know - I'm not familiar with this task, I am just trying to figure out if it has been solved for those who reported it.

@cmltaWt0 cmltaWt0 modified the milestones: Quince.1, Quince.2 Jan 8, 2024
@mariajgrimaldi mariajgrimaldi modified the milestones: Quince.2, Quince.3 Feb 12, 2024
@throwaway-a
Copy link
Author

throwaway-a commented Mar 3, 2024

@antoviaque @mariajgrimaldi I confirmed this is not fixed on Tutor 16.1.8 (latest v16) which is using Palm.4. This is insanely discouraging!

I set a class to have progress but not show the progress graph under Content -> Pages & Resources -> Progress:
ProgressFail1

I would note that it seems to very briefly show a "we couldn't apply your changes" error when you hit save.
ProgressFail3

And thus the students still see 0% completion, which means this is not fixed.
ProgressFail2

The students also continue to see un-checkable checkboxes that say "Incomplete" when they hover over them.
ProgressFail4

So until the 0% progress and uncheckable checkboxes are fixed, this is still regressed compared to Maple and this is still a blocker for upgrade (because it confuses students)

Per this ticket it seems like people only tested on devstack, not tutor, which AFAIK is the official correct way to install Open edX these days?

@throwaway-a
Copy link
Author

I can further confirm this doesn't work with Tutor 17.0.2 which uses open-release/quince.2 😫

@arbrandes
Copy link
Contributor

A fix was merged to master in October of 2023: openedx/frontend-app-learning#1194. This explains why it didn't make it into quince: it probably missed the cutoff date. For what it's worth, it'll definitely make it into Redwood.

(And if somebody opens a backport to Quince, I can try and give it some attention.)

@mariajgrimaldi mariajgrimaldi modified the milestones: Quince.3, Redwood.1 Apr 26, 2024
@mariajgrimaldi
Copy link
Member

I'll close this issue since it'll be available for redwood according to the PR merged back in October. Also, I tested it in the community nightly sandbox and it worked as described in the PR. Thank you all!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Report of or fix for something that isn't working as intended
Projects
Development

No branches or pull requests

8 participants