Revert "Fix the unpredictable order randomization issue with randomized content blocks"
This commit is contained in:
David Ormsbee
@@ -37,7 +37,6 @@ def get_course_block_access_transformers(user):
|
||||
"""
|
||||
course_block_access_transformers = [
|
||||
library_content.ContentLibraryTransformer(),
|
||||
library_content.ContentLibraryOrderTransformer(),
|
||||
start_date.StartDateTransformer(),
|
||||
ContentTypeGateTransformer(),
|
||||
user_partitions.UserPartitionTransformer(),
|
||||
|
||||
@@ -2,7 +2,6 @@
|
||||
Content Library Transformer.
|
||||
"""
|
||||
import json
|
||||
import random
|
||||
|
||||
from eventtracking import tracker
|
||||
|
||||
@@ -100,7 +99,6 @@ class ContentLibraryTransformer(FilteringTransformerMixin, BlockStructureTransfo
|
||||
# Save back any changes
|
||||
if any(block_keys[changed] for changed in ('invalid', 'overlimit', 'added')):
|
||||
state_dict['selected'] = list(selected)
|
||||
random.shuffle(state_dict['selected'])
|
||||
StudentModule.save_state(
|
||||
student=usage_info.user,
|
||||
course_id=usage_info.course_key,
|
||||
@@ -178,48 +176,3 @@ class ContentLibraryTransformer(FilteringTransformerMixin, BlockStructureTransfo
|
||||
format_block_keys,
|
||||
publish_event,
|
||||
)
|
||||
|
||||
|
||||
class ContentLibraryOrderTransformer(BlockStructureTransformer):
|
||||
"""
|
||||
A transformer that manipulates the block structure by modifying the order of the
|
||||
selected blocks within a library_content module to match the order of the selections
|
||||
made by the ContentLibraryTransformer or the corresponding XBlock. So this transformer
|
||||
requires the selections for the randomized content block to be already
|
||||
made either by the ContentLibraryTransformer or the XBlock.
|
||||
|
||||
Staff users are *not* exempted from library content pathways/
|
||||
"""
|
||||
WRITE_VERSION = 1
|
||||
READ_VERSION = 1
|
||||
|
||||
@classmethod
|
||||
def name(cls):
|
||||
"""
|
||||
Unique identifier for the transformer's class;
|
||||
same identifier used in setup.py
|
||||
"""
|
||||
return "library_content_randomize"
|
||||
|
||||
@classmethod
|
||||
def collect(cls, block_structure):
|
||||
"""
|
||||
Collects any information that's necessary to execute this
|
||||
transformer's transform method.
|
||||
"""
|
||||
# There is nothing to collect.
|
||||
pass
|
||||
|
||||
def transform(self, usage_info, block_structure):
|
||||
"""
|
||||
Transforms the order of the children of the randomized content block
|
||||
to match the order of the selections made and stored in the XBlock 'selected' field.
|
||||
"""
|
||||
for block_key in block_structure:
|
||||
if block_key.block_type != 'library_content':
|
||||
continue
|
||||
|
||||
state_dict = get_student_module_as_dict(usage_info.user, usage_info.course_key, block_key)
|
||||
library_children = block_structure.get_children(block_key)
|
||||
ordering_data = {block[1]: position for position, block in enumerate(state_dict['selected'])}
|
||||
library_children.sort(key=lambda block, data=ordering_data: data[block.block_id])
|
||||
|
||||
@@ -1,14 +1,13 @@
|
||||
"""
|
||||
Tests for ContentLibraryTransformer.
|
||||
"""
|
||||
import mock
|
||||
|
||||
from openedx.core.djangoapps.content.block_structure.api import clear_course_from_cache
|
||||
from openedx.core.djangoapps.content.block_structure.transformers import BlockStructureTransformers
|
||||
from student.tests.factories import CourseEnrollmentFactory
|
||||
|
||||
from ...api import get_course_blocks
|
||||
from ..library_content import ContentLibraryTransformer, ContentLibraryOrderTransformer
|
||||
from ..library_content import ContentLibraryTransformer
|
||||
from .helpers import CourseStructureTestCase
|
||||
|
||||
|
||||
@@ -181,130 +180,3 @@ class ContentLibraryTransformerTestCase(CourseStructureTestCase):
|
||||
transformers=self.transformers
|
||||
)
|
||||
self.assertEqual(len(list(transformed_blocks.get_block_keys())), len(self.blocks))
|
||||
|
||||
|
||||
class ContentLibraryOrderTransformerTestCase(CourseStructureTestCase):
|
||||
"""
|
||||
ContentLibraryOrderTransformer Test
|
||||
"""
|
||||
TRANSFORMER_CLASS_TO_TEST = ContentLibraryOrderTransformer
|
||||
|
||||
def setUp(self):
|
||||
"""
|
||||
Setup course structure and create user for content library order transformer test.
|
||||
"""
|
||||
super(ContentLibraryOrderTransformerTestCase, self).setUp()
|
||||
self.course_hierarchy = self.get_course_hierarchy()
|
||||
self.blocks = self.build_course(self.course_hierarchy)
|
||||
self.course = self.blocks['course']
|
||||
clear_course_from_cache(self.course.id)
|
||||
|
||||
# Enroll user in course.
|
||||
CourseEnrollmentFactory.create(user=self.user, course_id=self.course.id, is_active=True)
|
||||
|
||||
def get_course_hierarchy(self):
|
||||
"""
|
||||
Get a course hierarchy to test with.
|
||||
"""
|
||||
return [{
|
||||
'org': 'ContentLibraryTransformer',
|
||||
'course': 'CL101F',
|
||||
'run': 'test_run',
|
||||
'#type': 'course',
|
||||
'#ref': 'course',
|
||||
'#children': [
|
||||
{
|
||||
'#type': 'chapter',
|
||||
'#ref': 'chapter1',
|
||||
'#children': [
|
||||
{
|
||||
'#type': 'sequential',
|
||||
'#ref': 'lesson1',
|
||||
'#children': [
|
||||
{
|
||||
'#type': 'vertical',
|
||||
'#ref': 'vertical1',
|
||||
'#children': [
|
||||
{
|
||||
'metadata': {'category': 'library_content'},
|
||||
'#type': 'library_content',
|
||||
'#ref': 'library_content1',
|
||||
'#children': [
|
||||
{
|
||||
'metadata': {'display_name': "CL Vertical 2"},
|
||||
'#type': 'vertical',
|
||||
'#ref': 'vertical2',
|
||||
'#children': [
|
||||
{
|
||||
'metadata': {'display_name': "HTML1"},
|
||||
'#type': 'html',
|
||||
'#ref': 'html1',
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
'metadata': {'display_name': "CL Vertical 3"},
|
||||
'#type': 'vertical',
|
||||
'#ref': 'vertical3',
|
||||
'#children': [
|
||||
{
|
||||
'metadata': {'display_name': "HTML2"},
|
||||
'#type': 'html',
|
||||
'#ref': 'html2',
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
'metadata': {'display_name': "CL Vertical 4"},
|
||||
'#type': 'vertical',
|
||||
'#ref': 'vertical4',
|
||||
'#children': [
|
||||
{
|
||||
'metadata': {'display_name': "HTML3"},
|
||||
'#type': 'html',
|
||||
'#ref': 'html3',
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
}
|
||||
],
|
||||
}
|
||||
],
|
||||
}
|
||||
]
|
||||
}]
|
||||
|
||||
@mock.patch('lms.djangoapps.course_blocks.transformers.library_content.get_student_module_as_dict')
|
||||
def test_content_library_randomize(self, mocked):
|
||||
"""
|
||||
Test whether the order of the children blocks matches the order of the selected blocks when
|
||||
course has content library section
|
||||
"""
|
||||
mocked.return_value = {
|
||||
'selected': [
|
||||
['vertical', 'vertical_vertical3'],
|
||||
['vertical', 'vertical_vertical2'],
|
||||
['vertical', 'vertical_vertical4'],
|
||||
]
|
||||
}
|
||||
for i in range(5):
|
||||
trans_block_structure = get_course_blocks(
|
||||
self.user,
|
||||
self.course.location,
|
||||
self.transformers,
|
||||
)
|
||||
children = []
|
||||
for block_key in trans_block_structure.topological_traversal():
|
||||
if block_key.block_type == 'library_content':
|
||||
children = trans_block_structure.get_children(block_key)
|
||||
break
|
||||
|
||||
expected_children = ['vertical_vertical3', 'vertical_vertical2', 'vertical_vertical4']
|
||||
self.assertEqual(
|
||||
expected_children,
|
||||
[child.block_id for child in children],
|
||||
u"Expected 'selected' equality failed in iteration {}.".format(i)
|
||||
)
|
||||
|
||||
Reference in New Issue
Block a user