Skip to content

Latest commit

 

History

History
543 lines (395 loc) · 19.8 KB

CHANGELOG.rst

File metadata and controls

543 lines (395 loc) · 19.8 KB
Raw

Changelog

Please See the releases tab for the complete changelog.

Unreleased

9.12.0 - 2024-11-14

  • Dropped support for Python 3.8 and added support for Python 3.12.
  • Removed importlib-metadata<7 pin from constraints as it's unpin issue was closed.
  • Updated pylintrc file with latest version of edx-lint.
  • Fixed app_label error for model named CourseAllowPIISharingInLTIFlag.

9.11.3 - 2024-05-30

  • Remove utf-8 encoding for user full name

9.11.2 - 2024-05-30

  • Update python version for pypi publish workflow

9.11.1 - 2024-05-30

  • Add utf-8 encoding for user full name

9.11.0 - 2024-04-24

  • Remove lxml pin

9.10.0 - 2024-02-29

  • Remove Transifex calls and bundled translation files for the OEP-58 proposal.
  • BREAKING CHANGE: This version breaks translations with Quince and earlier releases.
  • Adding python 3.11 support. Dropping django32 support.

9.9.0 (2024-01-24)

  • XBlockI18NService js translations support

9.8.3 - 2024-01-23

  • Additional NewRelic traces to functions suspected of causing performance issues.

9.8.2 - 2024-01-19

  • Add NewRelic traces to functions suspected of causing performance issues.

9.8.1 - 2023-11-17

  • Fix custom_parameters xblock field validation.

9.7.0 - 2023-10-23

  • Added LTI 1.3 reusable configuration compatibility.

9.6.2 - 2023-08-22

  • Fix extra claims and custom parameters for LTI 1.3.
  • Add validation to custom_parameters xblock field.

9.6.1 - 2023-06-28

  • Fix CCX LTI configuration compatibility

9.6.0 - 2023-08-01

  • Added support for Django 4.2

9.5.7 - 2023-07-27

  • Fixed ACS actions constant.

9.5.6 - 2023-07-25

  • Added LTI launch error messages to the template returned when these errors occur.

9.5.5 - 2023-07-13

  • Fix broken call to LMS get_block_for_descriptor_internal due to merge with get_block_for_descriptor.

9.5.4 - 2023-06-28

  • Allow basic LtiResourceLink launch for an LtiProctoringConsumer

9.5.3 - 2023-06-09

  • Redirect to exam on same LTI proctoring launch tab once ready to start.
  • Show a warning in Studio if an LTI 1.1 consumer has an invalid lti_id.

9.5.2 - 2023-05-24

  • Allow start_proctoring_assessment_endpoint from an iframe during proctoring services launch.

9.5.1 - 2023-05-19

  • Added gate to ensure the ACS scope is only added when using the LtiProctoringConsumer
  • Moved scope validation to a helper function
  • Improved logging for Proctoring LTI 1.3 launch failure.

9.5.0 - 2023-05-08

  • Return HTML message telling user that exam is ready to start on start assessment response to LTI proctoring launch.

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
  • Added permissions class for ACS

9.2.1 - 2023-05-02

  • Bug fix for adding platform name as an LTI parameter

9.2.0 - 2023-05-02

  • Add platform name as an LTI parameter to LTI 1.1 launches as the "tool_consumer_info_product_family_code" parameter.
  • Add platform name as an LTI parameter to LTI 1.3 launches as the "platform instance" claim.

9.1.0 - 2023-04-28

  • Add full name as an LTI parameter to LTI 1.1 launches as the "lis_person_name_full" parameter.
  • Add full name as an LTI parameter to LTI 1.3 launches as the "name" ID token claim.

9.0.4 - 2023-04-25

  • Standardize translation directory to comply with openedx-translations.
  • Add creation of JS translations to compile_translations command.
  • Add support for JS translations in student_view.

9.0.3 - 2023-04-18

  • Add logging for error cases in the access_token_endpoint view and the key handler classes.

9.0.2 - 2023-04-12

  • Updated PII JS so strings can be extracted for translation.
  • Updated translations using transifex pull.

9.0.1 - 2023-04-11

  • Updated translations.

9.0.0 - 2023-03-03

BREAKING CHANGE:

  • Validates Tool provided redirect_uri against new lti_1p3_redirect_uris field per LTI Specification.
  • lti_1p3_redirect_uris defaults to {lti_1p3_launch_url, lti_1p3_redirect_uris} when empty to provide minimal distruption to existing integrations.
  • NOTE: Since the redirect URI was never validated in the past, there is always a chance it is something other than the launch url/deep linking url, so you may have to explicitly set it as appropriate.

8.0.1 - 2023-02-03

  • This releases fixes the PII sharing consent dialog for inline launches to no longer refer to a nonexistent "Cancel" button.

8.0.0 - 2023-01-31

  • Update to work with bleachk>=6.0.0 and make that an explicit requirement in install_requires since the changes are incompatible with the older versions of bleach.

7.3.0 - 2023-01-30

  • Rename edx-platform import of get_module_for_descriptor_internal.

7.2.3 - 2023-01-24

  • This release fixes a bug in the way that the PII sharing consent dialog renders. The bug resulted in the "OK" and "Cancel" buttons as well as the text of the PII sharing consent prompt appearing inside an inappropriate component when there was more than one LTI component in a unit.

7.2.2 - 2023-01-12

  • Fixes LTI 1.3 grade injection vulnerability that allowed LTI integrations to modify scores for any block.

7.2.1 - 2023-01-10

  • Adds support for LTI_BASE and LTI_API_BASE Django settings to allow URL configuration independent of LMS settings.

7.2.0 - 2022-12-15

This release addresses a number of issues with and bugs in sharing personally identifiable information (PII) in LTI launches.

  • Replaces the PII sharing consent modal with an inline PII sharing consent dialog to better suit the three different LTI launch types (i.e. inline, modal, and new_window).
  • Adds a PII consent dialog for inline LTI launches.
  • Fixes a bug in the modal LTI launch in LTI 1.3 that was preventing the LTI launch.
  • Fixes a bug in evaluating and caching whether PII sharing is enabled via the CourseAllowPIISharingInLTIFlag.
    • This fixes a bug where the PII sharing fields in the LTI XBlock edit menu appeared regardless of the existence or value of this flag. The PII sharing fields will now always be hidden if either no CourseAllowPIISharingInLTIFlag exists for a course or if a CourseAllowPIISharingInLTIFlag exists for the course but is not enabled.
    • This fixes a bug in the backwards compatibility code in lti_access_to_learners_editable. Now, CourseAllowPIISharingInLTIFlag will always be created for courses that contain (an) LTI XBlock(s) that have (a) PII sharing field(s) set to True when a user opens the LTI XBlock edit menu. Before, this would occur inconsistently due to a bug in the caching code.
  • Enables sharing username and email in LTI 1.3 launches.
    • Adds preferred_username and email attributes to the Lti1p3LaunchData class. The application or context that instantiates Lti1p3LaunchData is responsible for ensuring that username and email can be sent via an LTI 1.3 launch and supplying these data, if appropriate.
  • Adds code to eventually support the value of CourseAllowPIISharingInLTIFlag controlling PII sharing for a given course in LTI 1.1 and LTI 1.3 launches.
    • This code does not currently work, because the LTI configuration service is not available or defined in all runtime contexts. This code works in the LTI XBlock edit menu (i.e. the studio_view), but it does not work in the Studio preview context (i.e. the author_view) or the LMS (i.e. the student_view). The effect is that the CourseAllowPIISharingInLTIFlag can only control the appearance of the username and email PII sharing fields in the XBlock edit menu; it does not control PII sharing. We plan to fix this bug in the future.

7.1.0 - 2022-12-09

  • Add support for platform setting LTI_NRPS_DISALLOW_PII to prevent sharing of pii over the names and roles provisioning service.

7.0.3 - 2022-12-02

  • Removed check against LMS specific database_config_enabled in LtiConfiguration model.

7.0.2 - 2022-11-29

  • Fix the LTI 1.1 Outcome Results Service to be able to tie an outcome pass back to a user when the user ID is an external_user_id.
  • Fix the LTI 2.0 Result Service to be able to tie a result pass back to a user when the user ID is an external_user_id.
  • Update the RESULT_SERVICE_SUFFIX_PARSER regex string to be able to parse UUIDs to accommodate external_user_ids.
  • Add a get_lti_1p1_user_from_user_id method to the LtiConsumerXBlock to get the user object associated with a user ID.

7.0.1 - 2022-11-29

Fix LtiConfiguration clean method to look only at location so that it can work in environments that cannot load the block.

7.0.0 - 2022-11-29

  • Refactor anonymous user to real user rebinding function to use rebind_user service.
  • Refactor accessing hostname from runtime attribute to using settings.LMS_BASE.
  • Refactor usage of get_real_user with UserService.
  • Refactor deprecated usage of runtime.course_id and replace with runtime.scope_ids.usage_id.context_key.
  • Refactor deprecated usage of block.location with block.scope_ids.usage_id.

6.4.0 - 2022-11-18

Adds support for sending an external_user_id in LTI 1.1 XBlock launches. When the lti_consumer.enable_external_user_id_1p1_launches CourseWaffleFlag is enabled, the LTI 1.1 launch will send an external_user_id as the user_id attribute of the launch. When the lti_consumer.enable_external_user_id_1p1_launches CourseWaffleFlag is disabled, the LTI 1.1 launch will continue to send the anonymous_user_id. The external_user_id is defined, created, and stored by the external_user_ids Djangoapp in edx-platform.

6.3.0 - 2022-11-16

  • Adds support for LTI 1.3 Proctoring Service specification in-browser proctoring launch.
    • Adds an Lti1p3ProctoringLaunchData data class. It should be included as an attribute of the Lti1p3LaunchData data class to provide necessary proctoring data for a proctoring launch.
    • Adds an LtiProctoringConsumer class. This class is used to generate LTI proctoring launch requests and to decode and validate the JWT send back by the Tool with the LtiStartAssessment message.
    • Adds an lti_1p3_proctoring_enabled BooleanField to the LtiConfiguration model. This field controls whether proctoring is enabled for a particular LTI integration.
    • Modifies the launch_gate_endpoint to support LtiStartProctoring and LtiEndAssessment LTI launch messages.
    • Adds an start_proctoring_assessment_endpoint to support LtiStartAssessment messages from the Tool.
    • Adds an LTI_1P3_PROCTORING_ASSESSMENT_STARTED signal. This signal is emitted when the LtiStartAssessment message is sent from the Tool to inform users of the library that the LtiStartAssessment message has been received.

6.1.0 - 2022-11-08

  • 6.0.0 broke studio functionality because it leaned more heavily on the xblock load which only worked in the LMS.
    • Fix by greatly limiting when we attempt a full xblock load and bind

6.0.0 - 2022-10-24

BREAKING CHANGE:

Please note that additional breaking changes will be forthcoming in future versions of this library.

  • Modified Python API methods to use config_id (the UUID field) exclusively rather than config.id or block.
    • For the functions changed in 5.0.0 the config_id is available in the launch_data.
    • Other functions had config.id changed to config_id and block removed as an argument.
    • The new function config_id_for_block gets that config ID if all you have is a block.

5.0.1 - 2022-10-17

  • Fixed a bug that prevented LTI 1.3 launches from occurring in the browser due to Django's clickjacking protection.
    • Added the xframe_options_exempt view decorator to launch_gate_endpoint to allow loading response in an <iframe> tags
  • Fixed a bug in the URL used for an LTI 1.3 launch; the library now sends LTI 1.3 launches to the redirect_uri provided by the Tool in the authentication request, instead of the preregistered target_link_uri.

5.0.0 - 2022-10-12

BREAKING CHANGE:

Please note that additional breaking changes will be forthcoming in future versions of this library.

  • 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
  • Added an Lti1p3LaunchData data class
  • Added caching for Lti1p3LaunchData to limit data sent in request query or form parameters
  • 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
  • Changed the access token URL and Keyset URL to use the LtiConfiguration.config_id in the URL instead of the LtiConfiguration.location

4.4.0 - 2022-08-17

  • Move the LTI 1.3 Access Token and Launch Callback endpoint logic from the XBlock to the Django views
  • Adds support for accessing LTI 1.3 URLs using both location and the lti_config_id

4.2.2 - 2022-06-30

  • Fix server 500 error when using names/roles and grades services, due to not returning a user during auth.

4.2.1 - 2022-06-27

  • Add event tracking to LTI launches

4.0.1 - 2022-05-09

  • Add Learner to LTI launch roles in addition to the Student value

4.0.0 - 2022-05-09

  • Adds support for loading external LTI configurations from Open edX plugins implementing filters for the event org.openedx.xblock.lti_consumer.configuration.listed.v1. This can be enabled by setting a Course Waffle Flag lti_consumer.enable_external_config_filter for specific courses.

3.4.7 - 2022-07-08

  • Fix server 500 error when using names/roles and grades services, due to not returning a user during auth. This is a bugfix backport of 4.2.2 for the Nutmeg release.

3.4.6 - 2022-03-31

  • Fix rendering of lti_1p3_launch_error.html and lti_1p3_permission_error.html templates

3.4.5 - 2022-03-16

  • Fix LTI Deep Linking return endpoint permission checking method by replacing the old one with the proper Studio API call.

3.4.4 - 2022-03-03

3.4.3 - 2022-02-01

  • Fix LTI 1.1 template rendering when using embeds in the platform

3.4.2 - 2022-02-01

  • Fix LTI 1.1 form rendering so it properly renders quotes present in titles.
  • Migrate LTI 1.1 launch template from Mako to Django template.
  • Internationalize LTI 1.1 launch template.

3.4.1 - 2022-02-01

3.4.0 - 2022-01-31

  • Fix the version number by bumping it up to 3.4.0

3.3.0 - 2022-01-20

  • Added support for specifying LTI 1.3 JWK URLs.

3.2.0 - 2022-01-18

  • Dynamic custom parameters support with the help of template parameter processors.

3.1.2 - 2021-11-12

  • The modal to confirm information transfer on open of lti in new tab/window has been updated because of a change in how browsers handle iframe permissions.

3.1.0 - 2021-10-?

  • The changes which led to this version change were not adequetly documented.

3.0.1 - 2021-07-09

  • Added multi device support on student_view for mobile.

3.0.0 - 2021-06-16

  • Rename CourseEditLTIFieldsEnabledFlag to CourseAllowPIISharingInLTIFlag to highlight its increased scope.
  • Use CourseAllowPIISharingInLTIFlag for LTI1.3 in lieu of the current CourseWaffleFlag.

2.11.0 - 2021-06-10

  • NOTE: This release requires a corresponding change in edx-platform that was implemented in openedx/edx-platform#27529 As such, this release cannot be installed in releases before Maple.
  • Move CourseEditLTIFieldsEnabledFlag from edx-platform to this repo while retaining data from existing model.

2.10.1 - 2021-06-09

  • LTI 1.3 and LTI Advantage features are now enabled by default.
  • LTI 1.3 settings were simplified to reduce confusion when setting up a LTI tool.
  • Code quality issues fixed

2.9.1 - 2021-06-03

  • LTI Advantage - NRP Service: this completes Advantage compliance.

2.8.0 - 2021-04-13

  • LTI Advantage - AGS Service: Added support for programmatic grade management by LTI tools.
  • Improved grade publishing to LMS when using LTI-AGS.
  • Increase LTI 1.3 token validity to 1h.

2.7.0 - 2021-02-16

  • Add support for presenting ltiResourceLink content from deep linking.

2.6.0 - 2021-02-16

  • Deep Linking content presentation implementation, for resource links, HTML, HTML links, and images.
  • Fix bug with config_id migration where an entry was created _during_ the migration and did _not_ receive a valid UUID value.

2.5.3 - 2021-01-26

  • LTI Deep Linking Launch implementation, implementing DeepLinking Classes and request request preparation.
  • LTI Deep Linking response endpoint implementation, along with model to store selected configuration and content items.

2.5.2 - 2021-01-20

  • Fix issue with migration that causes migration failure due to duplicate config_id values.

2.5.1 - 2021-01-19

  • Simplify LTI 1.3 launches by removing OIDC launch start view.

2.5.0 - 2021-01-15

  • Add LTI 1.1 config on model.

2.4.0 - 2020-12-02

  • Partially implemented the Assignment and Grades Service to enable tools reporting grades back. Tools cannot create new LineItems.

2.3 – 2020-08-27

  • Move LTI configuration access to plugin model.

2.2 – 2020-08-19

  • Modals are sent to the parent window to work well with the courseware micro-frontend. A new message is sent to the parent window to request a modal containing the contents ot the LTI launch iframe.

2.1 – 2020-08-03

  • The LTI consumer XBlock is now indexable.
  • Implement the LTI 1.3 context claim.

2.0.0 – 2020-06-26

  • LTI 1.3 support.