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

[TC_AUTHOR_53] Text Xblocks do not render Xblock Title in LMS #375

Closed
yuliiazubak opened this issue May 30, 2024 · 9 comments
Closed

[TC_AUTHOR_53] Text Xblocks do not render Xblock Title in LMS #375

yuliiazubak opened this issue May 30, 2024 · 9 comments
Labels
redwood release testing Affects the upcoming release (attention needed)

Comments

@yuliiazubak
Copy link

Release

Redwood

Expected behavior

The title of each XBlock should be visible to students in the LMS.

Actual behavior

The title of the XBlock is visible in the CMS but does not render in the LMS. Students cannot see the title of the XBlock. This issue affects the following XBlocks:

  • Text
  • Announcement
  • Anonymous User ID
  • iFrame
  • Raw HTML

Xblocks title visible in CMS
Xblocks title visible in CMS
Blank titles in LMS
Blank titles in LMS

Steps to reproduce

  1. In CMS, add any of the following XBlocks to the unit: Text, Announcement, Anonymous User ID, iFrame, or Raw HTML.
  2. Add content to the XBlock and save the changes.
  3. Publish the unit.
  4. Switch to the LMS view as a student.

Additional information

Zooming Image tool and Problem Xblocks have no problems with rendering the title in the LMS

@yuliiazubak
Copy link
Author

label: release testing

@github-actions github-actions bot added the release testing Affects the upcoming release (attention needed) label May 30, 2024
@mariajgrimaldi
Copy link
Member

For problems, the display_name is displayed by adding it automatically to the block fragment itself:
image

But for text blocks, that doesn't happen.

I tested in redwood and quince; @DonatoBD, can you help me test in older versions to make sure this was always the case? Thanks!

@sarina
Copy link
Contributor

sarina commented Jun 3, 2024

For Text components, at least, this is not a regression. I don't ever recall seeing the text component Studio title rendering in the LMS.

I don't know what release the eduNEXT site is on, but it's not newer than Palm iirc. You can see here https://training.openedx.org/courses/course-v1:Axim+DemoX+Demo_Course/courseware/30b3fbb840024953b2d4b2e700a53002/4e1de5e13fc3422997fe246b40a43aa1/?activate_block_id=block-v1%3AAxim%2BDemoX%2BDemo_Course%2Btype%40sequential%2Bblock%404e1de5e13fc3422997fe246b40a43aa1 a bunch of text components, who have titles in the Studio:

Image

but no titles in the LMS.

Image

@sarina
Copy link
Contributor

sarina commented Jun 3, 2024

I said this to @crathbun428 already, but, I would say if this is a regression it's med to hi priority but I wouldn't consider it a blocker. if it's not a regression, i actually think it should be a product conversation for each component as to whether or not to make a behavior change - and I might argue against it. In the course I made, my text components often have default, shitty, or shorthand names I wouldn't want exposed, specifically because I knew they wouldn't render in the LMS and it was useful to have notes to myself.

@DonatoBD
Copy link

DonatoBD commented Jun 4, 2024

Hi @mariajgrimaldi and @sarina, indeed this seems to be the normal behaviour of these components, I tested it on old versions (nutmeg, olive palm) and the same thing happens. Should we leave a note in the tests so that it is not marked as failed again?

@sarina
Copy link
Contributor

sarina commented Jun 4, 2024

This is a good question, and not one for us to figure out right now. @jmakowski1123 @crathbun428 - as we refine the tests for Sumac, let's look at this test and any others to figure out what the behavior should be, and whether or not to:

  • Keep this test as-is and file bugs to fix behavior;
  • Keep this test but modify so it captures current behavior;
  • Deprioritise this test entirely, removing it from the test sheet

For now, what's a good way of marking this test as "do not test for Redwood but revisit for Sumac"?

@jmakowski1123
Copy link

One of the core product projects is to reassess all of the text block types anyway, and I'd like to do that before Sumac. That will then impact what and how we test here.

@mariajgrimaldi
Copy link
Member

For now, what's a good way of marking this test as "do not test for Redwood but revisit for Sumac"?

@sarina: We can mark this as complete and leave a revisit warning in the instructions column. Or, if we already have a list of these kinds of tests, we can add them to the suggestions tab, which we should revisit for sumac.

@sarina
Copy link
Contributor

sarina commented Jun 6, 2024

Added to suggestions list, and marked the test as passing.

@sarina sarina closed this as completed Jun 6, 2024
@github-project-automation github-project-automation bot moved this from Doing to Done in Data Working Group Jun 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
redwood release testing Affects the upcoming release (attention needed)
Projects
Development

No branches or pull requests

5 participants