LTI XBlock won't preview in the Content Library

[ttqureshi]

The LTI XBlock preview in the Content Library V2 is not working. Here are the crash logs. (discovered here)

Traceback (most recent call last):
  File "/openedx/venv/lib/python3.11/site-packages/django/core/handlers/exception.py", line 55, in inner
    response = get_response(request)
               ^^^^^^^^^^^^^^^^^^^^^
  File "/openedx/venv/lib/python3.11/site-packages/django/core/handlers/base.py", line 197, in _get_response
    response = wrapped_callback(request, *callback_args, **callback_kwargs)
               ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/opt/pyenv/versions/3.11.8/lib/python3.11/contextlib.py", line 81, in inner
    return func(*args, **kwds)
           ^^^^^^^^^^^^^^^^^^^
  File "/openedx/venv/lib/python3.11/site-packages/django/views/decorators/csrf.py", line 65, in _view_wrapper
    return view_func(request, *args, **kwargs)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/openedx/venv/lib/python3.11/site-packages/django/views/generic/base.py", line 105, in view
    return self.dispatch(request, *args, **kwargs)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/openedx/venv/lib/python3.11/site-packages/rest_framework/views.py", line 515, in dispatch
    response = self.handle_exception(exc)
               ^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/openedx/venv/lib/python3.11/site-packages/rest_framework/views.py", line 475, in handle_exception
    self.raise_uncaught_exception(exc)
  File "/openedx/venv/lib/python3.11/site-packages/rest_framework/views.py", line 486, in raise_uncaught_exception
    raise exc
  File "/openedx/venv/lib/python3.11/site-packages/rest_framework/views.py", line 512, in dispatch
    response = handler(request, *args, **kwargs)
               ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/openedx/venv/lib/python3.11/site-packages/rest_framework/decorators.py", line 50, in handler
    return func(*args, **kwargs)
           ^^^^^^^^^^^^^^^^^^^^^
  File "/openedx/venv/lib/python3.11/site-packages/django/views/decorators/clickjacking.py", line 86, in _view_wrapper
    response = view_func(*args, **kwargs)
               ^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/openedx/edx-platform/openedx/core/djangoapps/xblock/rest_api/views.py", line 118, in embed_block_view
    fragment = _render_block_view(block, view_name, request.user)
               ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/openedx/edx-platform/openedx/core/djangoapps/xblock/api.py", line 261, in render_block_view
    fragment = block.render(view_name)
               ^^^^^^^^^^^^^^^^^^^^^^^
  File "/mnt/xblock/xblock/core.py", line 818, in render
    return self.runtime.render(self, view, context)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/openedx/edx-platform/openedx/core/djangoapps/xblock/runtime/runtime.py", line 415, in render
    fragment = super().render(block, view_name, context)
               ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/openedx/edx-platform/openedx/core/djangoapps/xblock/runtime/shims.py", line 41, in render
    return super().render(block, view_name, context)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/mnt/xblock/xblock/runtime.py", line 823, in render
    frag = view_fn(context)
           ^^^^^^^^^^^^^^^^
  File "/mnt/xblocks-contrib/xblocks_contrib/lti/lti.py", line 536, in student_view
    "templates/lti.html", self.get_context(),
                          ^^^^^^^^^^^^^^^^^^
  File "/mnt/xblocks-contrib/xblocks_contrib/lti/lti.py", line 508, in get_context
    'input_fields': self.get_input_fields(),
                    ^^^^^^^^^^^^^^^^^^^^^^^
  File "/mnt/xblocks-contrib/xblocks_contrib/lti/lti.py", line 438, in get_input_fields
    client_key, client_secret = self.get_client_key_secret()
                                ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/mnt/xblocks-contrib/xblocks_contrib/lti/lti.py", line 994, in get_client_key_secret
    course = self.get_course()
             ^^^^^^^^^^^^^^^^^
  File "/mnt/xblocks-contrib/xblocks_contrib/lti/lti.py", line 767, in get_course
    return self.runtime.modulestore.get_course(self.location.course_key)
           ^^^^^^^^^^^^^^^^^^^^^^^^
AttributeError: 'LearningCoreXBlockRuntime' object has no attribute 'modulestore'
Internal Server Error: /xblocks/v2/lb:axim:lib1:lti:28d163a1-8bdb-4ce4-919d-7dcff9bb739c/embed/student_view/
Traceback (most recent call last):
  File "/openedx/venv/lib/python3.11/site-packages/django/core/handlers/exception.py", line 55, in inner
    response = get_response(request)
               ^^^^^^^^^^^^^^^^^^^^^
  File "/openedx/venv/lib/python3.11/site-packages/django/core/handlers/base.py", line 197, in _get_response
    response = wrapped_callback(request, *callback_args, **callback_kwargs)
               ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/opt/pyenv/versions/3.11.8/lib/python3.11/contextlib.py", line 81, in inner
    return func(*args, **kwds)
           ^^^^^^^^^^^^^^^^^^^
  File "/openedx/venv/lib/python3.11/site-packages/django/views/decorators/csrf.py", line 65, in _view_wrapper
    return view_func(request, *args, **kwargs)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/openedx/venv/lib/python3.11/site-packages/django/views/generic/base.py", line 105, in view
    return self.dispatch(request, *args, **kwargs)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/openedx/venv/lib/python3.11/site-packages/rest_framework/views.py", line 515, in dispatch
    response = self.handle_exception(exc)
               ^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/openedx/venv/lib/python3.11/site-packages/rest_framework/views.py", line 475, in handle_exception
    self.raise_uncaught_exception(exc)
  File "/openedx/venv/lib/python3.11/site-packages/rest_framework/views.py", line 486, in raise_uncaught_exception
    raise exc
  File "/openedx/venv/lib/python3.11/site-packages/rest_framework/views.py", line 512, in dispatch
    response = handler(request, *args, **kwargs)
               ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/openedx/venv/lib/python3.11/site-packages/rest_framework/decorators.py", line 50, in handler
    return func(*args, **kwargs)
           ^^^^^^^^^^^^^^^^^^^^^
  File "/openedx/venv/lib/python3.11/site-packages/django/views/decorators/clickjacking.py", line 86, in _view_wrapper
    response = view_func(*args, **kwargs)
               ^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/openedx/edx-platform/openedx/core/djangoapps/xblock/rest_api/views.py", line 118, in embed_block_view
    fragment = _render_block_view(block, view_name, request.user)
               ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/openedx/edx-platform/openedx/core/djangoapps/xblock/api.py", line 261, in render_block_view
    fragment = block.render(view_name)
               ^^^^^^^^^^^^^^^^^^^^^^^
  File "/mnt/xblock/xblock/core.py", line 818, in render
    return self.runtime.render(self, view, context)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/openedx/edx-platform/openedx/core/djangoapps/xblock/runtime/runtime.py", line 415, in render
    fragment = super().render(block, view_name, context)
               ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/openedx/edx-platform/openedx/core/djangoapps/xblock/runtime/shims.py", line 41, in render
    return super().render(block, view_name, context)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/mnt/xblock/xblock/runtime.py", line 823, in render
    frag = view_fn(context)
           ^^^^^^^^^^^^^^^^
  File "/mnt/xblocks-contrib/xblocks_contrib/lti/lti.py", line 536, in student_view
    "templates/lti.html", self.get_context(),
                          ^^^^^^^^^^^^^^^^^^
  File "/mnt/xblocks-contrib/xblocks_contrib/lti/lti.py", line 508, in get_context
    'input_fields': self.get_input_fields(),
                    ^^^^^^^^^^^^^^^^^^^^^^^
  File "/mnt/xblocks-contrib/xblocks_contrib/lti/lti.py", line 438, in get_input_fields
    client_key, client_secret = self.get_client_key_secret()
                                ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/mnt/xblocks-contrib/xblocks_contrib/lti/lti.py", line 994, in get_client_key_secret
    course = self.get_course()
             ^^^^^^^^^^^^^^^^^
  File "/mnt/xblocks-contrib/xblocks_contrib/lti/lti.py", line 767, in get_course
    return self.runtime.modulestore.get_course(self.location.course_key)
           ^^^^^^^^^^^^^^^^^^^^^^^^
AttributeError: 'LearningCoreXBlockRuntime' object has no attribute 'modulestore'
2026-01-05 14:13:39,088 ERROR 25 [django.request] [user None] [ip None] log.py:253 - Internal Server Error: /xblocks/v2/lb:axim:lib1:lti:28d163a1-8bdb-4ce4-919d-7dcff9bb739c/embed/student_view/
Traceback (most recent call last):
  File "/openedx/venv/lib/python3.11/site-packages/django/core/handlers/exception.py", line 55, in inner
    response = get_response(request)
               ^^^^^^^^^^^^^^^^^^^^^
  File "/openedx/venv/lib/python3.11/site-packages/django/core/handlers/base.py", line 197, in _get_response
    response = wrapped_callback(request, *callback_args, **callback_kwargs)
               ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/opt/pyenv/versions/3.11.8/lib/python3.11/contextlib.py", line 81, in inner
    return func(*args, **kwds)
           ^^^^^^^^^^^^^^^^^^^
  File "/openedx/venv/lib/python3.11/site-packages/django/views/decorators/csrf.py", line 65, in _view_wrapper
    return view_func(request, *args, **kwargs)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/openedx/venv/lib/python3.11/site-packages/django/views/generic/base.py", line 105, in view
    return self.dispatch(request, *args, **kwargs)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/openedx/venv/lib/python3.11/site-packages/rest_framework/views.py", line 515, in dispatch
    response = self.handle_exception(exc)
               ^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/openedx/venv/lib/python3.11/site-packages/rest_framework/views.py", line 475, in handle_exception
    self.raise_uncaught_exception(exc)
  File "/openedx/venv/lib/python3.11/site-packages/rest_framework/views.py", line 486, in raise_uncaught_exception
    raise exc
  File "/openedx/venv/lib/python3.11/site-packages/rest_framework/views.py", line 512, in dispatch
    response = handler(request, *args, **kwargs)
               ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/openedx/venv/lib/python3.11/site-packages/rest_framework/decorators.py", line 50, in handler
    return func(*args, **kwargs)
           ^^^^^^^^^^^^^^^^^^^^^
  File "/openedx/venv/lib/python3.11/site-packages/django/views/decorators/clickjacking.py", line 86, in _view_wrapper
    response = view_func(*args, **kwargs)
               ^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/openedx/edx-platform/openedx/core/djangoapps/xblock/rest_api/views.py", line 118, in embed_block_view
    fragment = _render_block_view(block, view_name, request.user)
               ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/openedx/edx-platform/openedx/core/djangoapps/xblock/api.py", line 261, in render_block_view
    fragment = block.render(view_name)
               ^^^^^^^^^^^^^^^^^^^^^^^
  File "/mnt/xblock/xblock/core.py", line 818, in render
    return self.runtime.render(self, view, context)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/openedx/edx-platform/openedx/core/djangoapps/xblock/runtime/runtime.py", line 415, in render
    fragment = super().render(block, view_name, context)
               ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/openedx/edx-platform/openedx/core/djangoapps/xblock/runtime/shims.py", line 41, in render
    return super().render(block, view_name, context)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/mnt/xblock/xblock/runtime.py", line 823, in render
    frag = view_fn(context)
           ^^^^^^^^^^^^^^^^
  File "/mnt/xblocks-contrib/xblocks_contrib/lti/lti.py", line 536, in student_view
    "templates/lti.html", self.get_context(),
                          ^^^^^^^^^^^^^^^^^^
  File "/mnt/xblocks-contrib/xblocks_contrib/lti/lti.py", line 508, in get_context
    'input_fields': self.get_input_fields(),
                    ^^^^^^^^^^^^^^^^^^^^^^^
  File "/mnt/xblocks-contrib/xblocks_contrib/lti/lti.py", line 438, in get_input_fields
    client_key, client_secret = self.get_client_key_secret()
                                ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/mnt/xblocks-contrib/xblocks_contrib/lti/lti.py", line 994, in get_client_key_secret
    course = self.get_course()
             ^^^^^^^^^^^^^^^^^
  File "/mnt/xblocks-contrib/xblocks_contrib/lti/lti.py", line 767, in get_course
    return self.runtime.modulestore.get_course(self.location.course_key)
           ^^^^^^^^^^^^^^^^^^^^^^^^
AttributeError: 'LearningCoreXBlockRuntime' object has no attribute 'modulestore'```

[kdmccormick]

The problematic method is this one, as it assume that the block is part of a modulestore course: https://github.com/openedx/edx-platform/blob/master/xmodule/lti_block.py#L610-L618

    def get_course(self):
        """
        Return course by course id.

        Returns None if the current block is not part of a course (i.e part of a library).
        """
        if isinstance(self.course_id, CourseKey):
            return self.runtime.modulestore.get_course(self.course_id)
        return None

The method is called exclusively here https://github.com/openedx/edx-platform/blob/master/xmodule/lti_block.py#L967:

    def get_client_key_secret(self):
        """
        Obtains client_key and client_secret credentials from current course.
        """
        course = self.get_course()
        lti_passports = course.lti_passports if course else []
        for lti_passport in lti_passports:
            try:
                lti_id, key, secret = [i.strip() for i in lti_passport.split(':')]
            except ValueError:
                _ = self.runtime.service(self, "i18n").ugettext
                msg = _('Could not parse LTI passport: {lti_passport}. Should be "id:key:secret" string.').format(
                    lti_passport=f'{lti_passport!r}'
                )
                raise LTIError(msg)  # lint-amnesty, pylint: disable=raise-missing-from

            if lti_id == self.lti_id.strip():
                return key, secret
        return '', ''

@feanil , based on your experience with the new LTIConsumerBlock, do you know if there an easy way to build this client key and secret without depending on modulestore? Or this issue fundamental to the old LTIBlock?

[feanil]

So it looks like with this block, it needs to get the secrets that are stored in the advanced settings by the user. I think this might be another situation where we would need to introduce a service to abstract accessing this data.

[ttqureshi]

@kdmccormick @feanil
I have identified the root cause of the issue: the extracted LTI XBlock is missing a condition that checks whether the block’s location.course_key is a CourseKey before attempting to fetch the course from the modulestore.

As a result, when the LTI XBlock is previewed in the Content Library runtime, where the key is not a course key, the code still attempts to look up a course and failed.
When the LTIBlock is previewed in the LearningCoreXBlockRuntime, location.course_key is a LibraryLocatorV2, not a CourseKey:

(Pdb) self.location.course_key
LibraryLocatorV2('edx', '1')

This condition fixes the issue:

if isinstance(self.location.course_key, CourseKey):
    return self.runtime.modulestore.get_course(self.location.course_key)

cc: @farhan

[feanil]

FYI, I suspect the block just never worked in content libraries so this is actually an improvement (less crashy) but I think without being able to retrieve the credentials, it will probably not work correctly in a library in a more broad sense. That said, I think this is probably fine to merge now and we can deal with the other issue later. Thanks for digging into it @ttqureshi

[ttqureshi]

@feanil
As per my testing, the BuiltIn LTI Block preview works fine as well in the Content Library. There was a missing condition in the extracted LTI XBlock which I've added in the linked PR.

So it looks like with this block, it needs to get the secrets that are stored in the advanced settings by the user.

Also, we are able to get the secrets. I have tested it by integrating the Zoom LTI.