Asad_Ali
May 22, 2023, 12:49pm
1
Any help/lead would be much appreciated.
While trying to debug https://github.com/mitodl/mitxpro/issues/2543 , we noticed a couple of issues related to the inconsistent behavior of the Notes Visibility button and the working of notes.
Issue #1 (Issue for some of the users only and might not get reproduced by everyone):
Visit any chapter of the course like Course | edX
Notes are enabled and the notes visibility button says Hide Notes but notes do not work.
If the notes are not working, click Hide Notes and then again click Show Notes. Now the notes should work.
For us this issue is very inconsistent as it might work for some users or might not work for others.
Issue # 2:
Visit any page like Course | edX
If notes are working click on Hide Notes, and now the notes won’t work and the button will say Show Notes. Note: If the notes are not working when you load the page for the first time then click on the Hide Notes button twice and the notes will work. Now follow the steps by again clicking on that button.
Now click on Next to go to the next chapter and notice that the notes button says Show Notes but notes are working fine.
We just wanted to know whether the student notes visibility is associated with the individual course blocks or if it is enabled/disabled for a course as a whole.
pdpinch
May 23, 2023, 9:08pm
2
pdpinch
September 17, 2023, 4:52pm
3
Does this PR fix the issue?
openedx:master ← ArturGaspar:notes-visibility-user
opened 08:37AM - 25 Aug 23 UTC
## Description
* Add method to bind course overview model to a student, so th… at user preferences correctly override course defaults, and use this in courseware API to return correct notes visibility, so that the MFE is initialised with the correct visibility state.
* Add block argument (for user-bound block) to toggle_notes.html template (used by course block iframe) so notes visibility can be loaded from it instead of course default.
Impacts Learner users.
Fixes openedx/wg-build-test-release#227
## Supporting information
openedx/wg-build-test-release#227
openedx/frontend-app-learning#1005
## Testing instructions
(Parts from openedx/wg-build-test-release#227)
1. Enable Notes in a Course Advanced settings
2. Open Course as a Student
3. Check Notes tab
4. Open any Unit in a subsection
5. Select text to note
6. Save the note
7. Check the Note tab
8. Return to the Course Subsection
9. Check that notes are visible and that the previously noted text is highlighted
10. Check that the button state corresponds to the visibility of notes (i.e. "Hide Notes" when notes are visible and "Show Notes" when notes are not visible)
11. Toggle note visibility until they are hidden (or visible, if openedx/frontend-app-learning#1170 is not applied)\*
12. Reload page and check that notes are hidden
13. Toggle note visibility until they are visible (or hidden, if openedx/frontend-app-learning#1170 is not applied)\*
14. Reload page and check that notes are visible
\*Due to the issue documented at openedx/frontend-app-learning#1170, the "Show/Hide Notes" button persists the state that is opposite to the one applied. I.e., if the button is used and notes are hidden, they will be visible when the page is reloaded and vice-versa. Running the MFE with the branch from that pull request should allow observing the correct non-reversed behaviour. This is independent of this issue.
Asad_Ali
September 18, 2023, 1:05pm
4
It should be fixed as it seems. I will test it.