Notes Icon Does Not Appear When Course Text Is Selected

[cachob]

Steps to Reproduce

1. Click on the Hide Notes tab to enable Show Notes
2. Highlight any text in the course material

Expected Behavior

1. Notes Icon will appear after the highlighted text
2. Clicking on the Notes icon will allow the learner to enter notes

Actual Behavior

1. Notes Icon does not appear when text is highlighted
2. Notes tab has to be clicked multiple times (show/hide notes) in order for the Notes Icon to finally appear

[cachob]

Here is an example URL where the issue was reproduced:

https://courses.xpro.mit.edu/learn/course/course-v1:xPRO+BioEngx+R11/block-v1:xPRO+BioEngx+R11+type@sequential+block@08ad99daa8b841ad9a0f28a1818bb95b/block-v1:xPRO+BioEngx+R11+type@vertical+block@e1a80e853f194aa0b6189a49eb98f73b

It was initially reported on a MAC OS, but I was able to reproduce on a windows machine.

I've enabled notes for this course in RC in order for the team to troubleshoot:

https://courses-rc.xpro.mit.edu/learn/course/course-v1:xPRO+LASERx3+R2

[pdpinch]

There have been other notes issues reported in the olive release of open edX. I don't know if they are related to this one: https://github.com/openedx/wg-build-test-release/issues?q=is%3Aissue+is%3Aopen+notes+label%3Abug

[asadali145]

@cachob
Everything seems reasonable to me. There isn't any issue with the Notes. Let me know if you think I have misunderstood. This is how it works:

• When the button says Hide Notes, the notes are enabled and you can hide them by clicking on the button.
• When the button says Show Notes, the notes are disabled and you can enable them by clicking on the button.

Screen.Recording.2023-04-10.at.1.36.03.PM.mov

[cachob]

@asadali145 - it looks like it works in RC, but it's still happening in the live course that I had posted as an example (BioEngx). Let me know if you are able to reproduce on that course.

[pdpinch]

a possibly related issue: openedx/frontend-app-learning#1005

[aliraza-abbasi]

I was not able to find the root cause of the issue. I've looked into the code based on PRs openedx/edx-platform#23614 and openedx/frontend-app-learning#44. I also compared the APIs data for a user with a working Notes Icon and a user with a non working Notes Icon but could not find anything. This issue arises randomly. it works well for one user but does not work for another user on the same course page. I tried making some changes in NotesVisibility.jsx but nothing worked for me

I have some findings to reproduce the issue for testing

• Log in as a staff user
• Go to the course page and change the view as role from staff to any other user
• Change it back to the staff role

I've discussed it with @arslanashraf7 he might look further into it.

[asadali145]

Leaving my thoughts

I went through the following edX issues as @pdpinch mentioned in the discussion post:

• [TC_LEARNER_39] Notes failed to load by default openedx/wg-build-test-release#227
• Problem with notes visibility feature openedx/frontend-app-learning#1005
• [TC_LEARNER_39] Notes tab linking not working openedx/wg-build-test-release#233

One of the issues is very similar to the one we are having. As per the discussion on one of the above issues, edX is developing a new MFE for notes and waiting for someone from the frontend wg to pick openedx/frontend-app-learning#1005.

I think we should wait for the new notes MFE and openedx/frontend-app-learning#1005 to get fixed but still, If we want a temporary fix then we can work on it.

CC: @pdpinch @arslanashraf7 @cachob

[Agrendalath]

This should be fixed by openedx/edx-platform#33096 and openedx/frontend-app-learning#1170.

[arslanashraf7]

@asadali145 Can you test if this has been fixed in our current deployment as well? If not, Can you identify the release we should be on to get this fix?

[asadali145]

It looks good on the master branch. I have tested it locally. The issue is still there on xPro Prod as the fix is not backported to any of the named releases.

@pdpinch @arslanashraf7 Should we ask the author for the backports?

[arslanashraf7]

@asadali145 I think we should create the backport PR for Palm (or Olive) releases if that's straightforward. But I'd let @pdpinch decide on that.

[pdpinch]

Since we've upgraded to Quince, can this be closed?

[asadali145]

This looks good to me on RC for https://courses-rc.xpro.mit.edu/learn/course/course-v1:RCTEST+QUINCE_TEST1+TESTR0/block-v1:RCTEST+QUINCE_TEST1+TESTR0+type@sequential+block@b4100fe285a442a2ba6de2e94b28642b/block-v1:RCTEST+QUINCE_TEST1+TESTR0+type@vertical+block@6fddc8e62a094b818e30327c45ebf7f3.

@cachob Could you please verify?

[cachob]

@asadali145 - it works for me as well

[asadali145]

Closing as this one is fixed.