fix: lms compatibility with descriptor->block rename (#370)

Fixes compatibility issue with recent LMS changes to refactor item/module/block/descriptor terminology.

Author: zacharis278

CHANGELOG.rst

@@ -16,6 +16,10 @@ Please See the `releases tab <https://github.com/openedx/xblock-lti-consumer/rel
 Unreleased
 ~~~~~~~~~~
 
+9.4.0 - 2023-05-08
+------------------
+* Fix broken call to LMS `get_block_for_descriptor_internal` due to descriptor->block rename.
+
 9.3.0 - 2023-05-05
 ------------------
 * Added handling for the ACS scope and ACS actions

lti_consumer/__init__.py

@@ -4,4 +4,4 @@
 from .apps import LTIConsumerApp
 from .lti_xblock import LtiConsumerXBlock
 
-__version__ = '9.3.0'
+__version__ = '9.4.0'

lti_consumer/plugin/compat.py

@@ -90,7 +90,7 @@ def load_enough_xblock(location):  # pragma: nocover
     # pylint: disable=import-error,import-outside-toplevel
     from xmodule.modulestore.django import modulestore
 
-    # Retrieve descriptor from modulestore
+    # Retrieve block from modulestore
     return modulestore().get_item(location)
 
 
@@ -103,35 +103,35 @@ def load_block_as_user(location):  # pragma: nocover
     from lms.djangoapps.courseware.block_render import get_block_for_descriptor_internal
     from openedx.core.lib.xblock_utils import request_token
 
-    # Retrieve descriptor from modulestore
-    descriptor = load_enough_xblock(location)
+    # Retrieve block from modulestore
+    block = load_enough_xblock(location)
     user = get_current_user()
     request = get_current_request()
     if user and request:
-        # If we're in request scope, the descriptor may already be a block bound to a user
+        # If we're in request scope, the block may already be bound to a user
         # and we don't need to do any more loading
-        if descriptor.scope_ids.user_id is not None and user.id == descriptor.scope_ids.user_id:
-            return descriptor
+        if block.scope_ids.user_id is not None and user.id == block.scope_ids.user_id:
+            return block
 
         # If not load this block to bind it onto the user
         get_block_for_descriptor_internal(
             user=user,
-            descriptor=descriptor,
+            block=block,
             student_data=None,
             course_id=location.course_key,
             track_function=None,
             request_token=request_token(request),
         )
-        return descriptor
+        return block
     else:
-        return _load_block_as_anonymous_user(location, descriptor)
+        return _load_block_as_anonymous_user(location, block)
 
 
-def _load_block_as_anonymous_user(location, descriptor):  # pragma: nocover
+def _load_block_as_anonymous_user(location, block):  # pragma: nocover
     """
     Load a block as the anonymous user because no user is available.
 
-    This uses a few internal courseware methods to retrieve the descriptor
+    This uses a few internal courseware methods to retrieve the block
     and bind an AnonymousUser to it, in a similar fashion as a `noauth` XBlock
     handler.
     """
@@ -147,14 +147,14 @@ def _load_block_as_anonymous_user(location, descriptor):  # pragma: nocover
         # Load block, attaching it to AnonymousUser
         get_block_for_descriptor_internal(
             user=user,
-            descriptor=descriptor,
+            block=block,
             student_data=None,
             course_id=location.course_key,
             track_function=None,
             request_token="",
         )
 
-        return descriptor
+        return block
 
 
 def get_user_from_external_user_id(external_user_id):  # pragma: nocover