fix: LTI 1.3 extra claims and custom parameters

[kuipumu]

Description

This PR adds a feature that allows the LTI consumer XBlock to send custom parameters (including dynamic custom parameters) and extra claims to LTI 1.3 launches.

Type of Change

• Add LtiConsumerXBlock get_lti_1p3_custom_parameters method.
• Modify LtiConsumerXBlock get_lti_1p3_launch_data method.
• Include tests for all added and modified code.

Testing:

2. Add LTI custom params template setting:

# Here we set the value to any module and function
# that can be imported and returns a str.
LTI_CUSTOM_PARAM_TEMPLATES = {
    'test_param': 'django.utils.html:escape'
}

3. Add a LTI processors to XBLOCK_SETTINGS (Example: https://github.com/appsembler/tahoe-lti).
4. Create a course and add a LTI 1.3 consumer XBlock.
5. Add custom parameters to the XBlock settings.

["test=test", "test_param=${test_param}"] 

6. Enable the "Send extra parameters" setting.
7. Go to the live course and execute an LTI 1.3 launch.
8. The custom parameters and extra claims should be present on the https://purl.imsglobal.org/spec/lti/claim/custom claim.

[openedx-webhooks]

Thanks for the pull request, @kuipumu! Please note that it may take us up to several weeks or months to complete a review and merge your PR.

Feel free to add as much of the following information to the ticket as you can:

• supporting documentation
• Open edX discussion forum threads
• timeline information ("this must be merged by XX date", and why that is)
• partner information ("this is a course on edx.org")
• any other information that can help Product understand the context for the PR

All technical communication about the code itself will be done via the GitHub pull request interface. As a reminder, our process documentation is here.

Please let us know once your PR is ready for our review and all tests are green.

[codecov]

Codecov Report

Patch coverage: 100.00% and project coverage change: +0.02% 🎉

Comparison is base (3de9bcb) 97.91% compared to head (2c04bcc) 97.94%.

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #392      +/-   ##
==========================================
+ Coverage   97.91%   97.94%   +0.02%     
==========================================
  Files          77       77              
  Lines        6475     6555      +80     
==========================================
+ Hits         6340     6420      +80     
  Misses        135      135              

Flag	Coverage Δ
unittests	97.94% <100.00%> (+0.02%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files Changed	Coverage Δ
lti_consumer/__init__.py	100.00% <100.00%> (ø)
lti_consumer/data.py	100.00% <100.00%> (ø)
lti_consumer/lti_xblock.py	96.62% <100.00%> (+0.13%)	⬆️
lti_consumer/plugin/views.py	97.94% <100.00%> (+0.01%)	⬆️
lti_consumer/tests/unit/plugin/test_views.py	100.00% <100.00%> (ø)
lti_consumer/tests/unit/test_lti_xblock.py	99.25% <100.00%> (+0.03%)	⬆️

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[e0d]

@kuipumu It looks like there's a coverage decrease that needs attention.

[kuipumu]

@e0d I just added a commit to include a test to cover the missing lines, please let me know if there is any other improvement that should be added to the tests

[mphilbrick211]

Hi @openedx/masters-devs-cosmonauts! Would someone be able to please review/merge this for us? Thank you!

[zacharis278]

@kuipumu This looks good but I think we should include some documentation on the new custom params. At minimum adding similar setup instructions to the /docs folder in this repo would be a great help. It's a small feature but I wouldn't want knowledge of how to use this to get lost in just the PR description here.

[kuipumu]

@zacharis278 I was about to add documentation about this feature but I noticed there is already documentation about these features on the docs/developing.rst document, do you think there is anything else about the feature that should be remarked on that document?, the feature is still the same, this PR only includes a fix for these features to work on LTI 1.3, this also includes a minor improvement to the validation of the custom parameters field on the XBlock.

[zacharis278]

ahh thankyou I hadn't noticed it was already there. That seems like to wrong doc for this to me but that's not your problem.

[zacharis278]

@kuipumu this does look good can you add the init.py and changelog entries for the new version? With those added I can merge this in.

[kuipumu]

@zacharis278 I just updated the changelog and the version of the package.

[zacharis278]

tested locally and this is working as expected 👍

Thanks!

[openedx-webhooks]

@kuipumu 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future.