feat: optional xblocks

[DanielVZ96]

Description

This PR implements separating optional progress from normal progress, and also displaying optional chapters and sequences in the outline.

• Impacts: Learners and authors

Supporting information

• Fontend App Learning PR: feat: optional xblocks frontend-app-learning#9

Testing instructions

1. Run the MFE from this branch: feat: optional xblocks openedx/frontend-app-learning#1296
2. Add "done" to the advanced module list
3. As a non-staff user go to the progress tab and assert only the typical progress donut appears
4. As a staff user, on the cms open the settings of any sequence or chapter and mark as optional
5. As a non-staff user, complete some units, and also the optional unit
6. Navigate to the progress tab again and assert a new optional donut appears with your progress

Screenshots

Private-ref: https://tasks.opencraft.com/browse/BB-8586

[Agrendalath]

Nit: we should not mix the snake_case with camelCase.

[DanielVZ96]

fixed

[Agrendalath]

Actually, this seems to be a backward-compatible change, so we can revert bumping this version.

[DanielVZ96]

reverted

[Agrendalath]

Nit: can we use a more verbose name for this test, like "test_optional_completion_off_by_default"?

[DanielVZ96]

good idea!

[Agrendalath]

What if the optional_completion is set to False (default), but the parent XBlock has it set to True? In this use case, the field is still active. We should disable this checkbox when ancestor_has_optional_completion returns True, regardless of the xblock_info['optional_completion'] value.

[DanielVZ96]

good point

[Agrendalath]

Regarding this comment about hiding the editor when the completion tracking is not enabled, please see the following parts of code that handle a similar scenario for another editor:

edx-platform/cms/templates/base.html

Line 160 in a8535ff

is_custom_relative_dates_active: ${CUSTOM_RELATIVE_DATES.is_enabled(context_course.id) | n, dump_js_escaped_json},

https://github.com/open-craft/edx-platform/blob/42451caa2612a63b42bf5686e6217817e0dd2098/cms/static/js/views/modals/course_outline_modals.js#L1290-L1292

I think we shouldn't move this to a follow-up ticket because this feature is not enabled by default in edx-platform.

[DanielVZ96]

wow i didn't realize it'd be so straight forward. implementing this

[DanielVZ96]

done. I wasn't able to test it manually without hardcoding the value in the base.html. it seems waffle flags are cached somewhere and take quite some time to invalidate the cache.

In case you want to test it and have my same problem you can hard code completion_tracking_enabled to False in cms/templates/base.html line 162.

[Agrendalath]

Suggested change

	<% var message = gettext('Optional %(xblockType)ss won\'t count towards course or parent completion. Only has an effect if completion module is enabled.') %>
	<% var message = gettext('Optional %(xblockType)ss won\'t count towards course or parent completion.') %>

Once we hide the editor when the completion tracking is not enabled, we can remove this part.

[DanielVZ96]

done

[Agrendalath]

@DanielVZ96, the completion tracking should be enabled for the course instead of the section.

Also, you should be able to use something like console.warn(window. course) to verify that it's applied correctly.