Skip to content
Snippets Groups Projects
  1. Nov 07, 2022
    • Andy Shultz's avatar
      fix: remove general use of load_block_as_user · 5f964f1d
      Andy Shultz authored
      For the config model we do not need to go as far as binding the block
      to the user and already get enough data out of the modulestore to
      satisfy the storage on the xblock case. Add a new function to get that
      much xblock only.
      
      For the limited cases where we are using the block more directly as a
      block we maintain the old function.
      
      Also includes a fix to test_views that was closing the wrong level
      mock and leaving an open patch into other tests.
      5f964f1d
  2. Oct 20, 2022
    • Andy Shultz's avatar
      feat: update lti API to pick config via launch data · a52eef76
      Andy Shultz authored
      Note that this uses config_id (the UUID) not config.id (the int)
      
      This required a way to get config_id if we only have the block.
      
      And it means that we are more likely to go through load_block_as_user
      because we have not created the config off the block even when calling
      from the block (since the block has to go through that config ID).
      
      A lot of tests had to be updated to have more complete configuration
      setup because config_id is now load bearing.
      a52eef76
  3. Oct 17, 2022
  4. Oct 13, 2022
    • michaelroytman's avatar
      feat!: decouple LTI 1.3 launch from LtiConsumerXBlock · f7b9d401
      michaelroytman authored
      Purpose
      -------
      
      The purpose of these changes is to decouple the LTI 1.3 launch from the LtiConsumerXBlock. It is in accordance with the ADR "0007 Decouple LTI 1.3 Launch from XBlock and edX Platform", which is currently under review. The pull request for the ADR is here: https://github.com/openedx/xblock-lti-consumer/pull/281.
      
      The general premise of these changes is to shift the responsibility of defining key launch claims to users of the library. Such claims include user ID, user role, resource link ID, etc. Prior to this change, this context was defined directly in the launch view by referencing XBlock fields and functions, thereby tying the LTI 1.3 launch to the XBlock. By shifting the responsibility out of the view, we will be able to genericize the launch and make it functional in more contexts than just the XBlock and the XBlock runtime.
      
      In short, the key launch claims are encoded in an instance of a data class Lti1p3LaunchData. Users of the library will instantiate this class with necessary launch data to it and pass the instance to various methods of the Python API to communicate the data to the library. Please see the aforementioned ADR for more details about this decoupling strategy.
      
      Note that the majority of these changes affect only the basic LTI 1.3 launch. There have largely been no changes to LTI 1.3 Advantage Services. The one exception is the Deep Linking content launch endpoint. This is because this launch is implemented in the basic LTI 1.3 launch, and it was necessary to make the same changes to the deep linking content launch to ensure that it works properly. Otherwise, LTI 1.3 Advantage Services are out of scope of these changes.
      
      Change Summary for Developers
      -----------------------------
      
      Below is a summary of changes contained in this pull request.
      
      * added an Lti1p3LaunchData data class
      * added caching for Lti1p3LaunchData to limit data sent in request query or form parameters
      * BREAKING CHANGE: modified Python API methods to take Lti1p3LaunchData as a required argument
      ** get_lti_1p3_launch_info
      ** get_lti_1p3_launch_start_url
      ** get_lti_1p3_content_url
      * replaced references to LtiConsumerXBlock.location with Lti1p3LaunchData.config_id
      * removed definition of key LTI 1.3 claims from the launch_gate_endpoint and instantiated Lti1p3LaunchData from within the LtiConsumerXBlock instead
      * added a required launch_data_key request query parameter to the deep_linking_content_endpoint and refactored associated templates and template tags to pass this parameter in the request to the view
      
      Change Summary for Course Staff and Instructors
      -----------------------------------------------
      
      The only changes relevant for course staff and instructors is that the access token and keyset URLs displayed in Studio have changed in format.
      
      The old format was:
      
      Access Token URL: https://courses.edx.org/api/lti_consumer/v1/token/block-v1:edX+999+2022Q3+type@lti_consumer+block@714c10a5e4df452da9d058788acb56be
      Keyset URL: https://courses.edx.org/api/lti_consumer/v1/public_keysets/block-v1:edX+999+2022Q3+type@lti_consumer+block@714c10a5e4df452da9d058788acb56be
      
      The new format is:
      
      Access Token URL: https://courses.edx.org/api/lti_consumer/v1/token/c3f6af60-dbf2-4f85-8974-4ff870068d43
      Keyset URL: https://courses.edx.org/api/lti_consumer/v1/public_keysets/c3f6af60-dbf2-4f85-8974-4ff870068d43
      
      The difference is in the slug at the end of the URL. In the old format, the slug was the UsageKey of the XBlock associated with the LTI integration. In the new format, the slug is the config_id of the LtiConfiguration associated with the LTI integration. This is an iterative step toward decoupling the access_token_endpoint and the public_keyset_endpoint views from the XBlock location field. The XBlock location field appears as the usage_key parameter to both views. We cannot simply remove the usage_key parameter from the views, because existing LTI 1.3 integrations may have been created using the old format, and we need to maintain backwards compatibility. This change, however, prevents new integrations from being created that are coupled to the XBlock. In the future, we may address integrations that use the old format to fully decouple the XBlock from the views.
      
      Testing
      -------
      
      Unit tests were added for all changes.
      
      In addition, manual testing was performed using the instructions in the documents listed below.
      
      * https://github.com/openedx/xblock-lti-consumer#lti-13
      * https://openedx.atlassian.net/wiki/spaces/COMM/pages/1858601008/How+to+run+the+LTI+Validation+test
      
      Resources
      ---------
      JIRA: MST-1603: https://2u-internal.atlassian.net/browse/MST-1603
      
      BREAKING CHANGE
      f7b9d401
  5. Sep 13, 2022
Loading