feat: Add event for LTI Launches #501

xitij2000 · 2025-05-20T04:28:11Z

Description

Adds an LTI launch event with data related to LTI Launches.

Supporting information

Link to other information about the change, such as Jira issues, GitHub issues, or Discourse discussions. Also, link to any relevant documentation useful for reviewers.
Be sure to check they are publicly readable, or if not, repeat the information here.

Testing instructions

Please provide detailed step-by-step instructions for testing this change, including any necessary setup, e.g., additional requirements, plugins, configuration variables, etc, and environment details to ensure the reviewer can test the change.

Deadline

"None" if there's no rush, or provide a specific date or event (and reason) if there is one.

Other information

Include anything else that will help reviewers and consumers understand the change.

Any other PRs or issues that should be linked here? Any related PRs?
Any special concerns or limitations? For example: deprecations, security, or anything you think should be noted.

Checklists

Check off if complete or not applicable:

Merge Checklist:

Post Merge:

Create a tag
Create a release on GitHub
Check new version is pushed to PyPI after tag-triggered build is
finished.
Delete working branch (if not needed anymore)
Upgrade the package in the Open edX platform requirements (if applicable)

openedx-webhooks · 2025-05-20T04:28:16Z

Thanks for the pull request, @xitij2000!

This repository is currently maintained by @openedx/hooks-extension-framework.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
- This process (including the steps you'll need to take) is documented here.
If it doesn't, simply proceed with the next step.

🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

Dependencies

This PR must be merged before / after / at the same time as ...
Blockers

This PR is waiting for OEP-1234 to be accepted.
Timeline information

This PR must be merged by XX date because ...
Partner information

This is for a course on edx.org.
Supporting documentation
Relevant Open edX discussion forum threads

🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

The size and impact of the changes that it introduces
The need for product review
Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

tecoholic

@xitij2000 👍

I tested this: Tested this along with openedx/edx-platform#36756 and open-craft/platform-plugin-lti-launch-monitor#1 and verified that the events are generated and consumed as expected.
I read through the code
I checked for accessibility issues
Includes documentation

tecoholic · 2025-05-26T07:27:39Z

openedx_events/learning/data.py

+    Data required for a successful LTI launch.
+
+    Attributes:
+        roles (str): The roles (as per LTI Spec) of the User.


@xitij2000 I think it would be useful to expand this and mention it's a comma separated list of roles. It's natural to expect a list for the plural form (roles vs role) here and get confused in the future.

mariajgrimaldi

Thank you for the contribution! We really appreciate it. I left two minor comments to address, so we can merge after. Thank you!

mariajgrimaldi · 2025-06-30T10:30:33Z

openedx_events/learning/data.py

+    """
+    Class that encapsulates LTI data for an LTI launch event.
+    """
+    user = attr.ib(type=UserData)


Is there a reason why we're duplicating user's the info?

The user data here is for the Open edX user, whereas the user in the LtiProviderLaunchParamsData is the remote user id received via LTI.

Oh great. Can we add that detail in the docstring?

mariajgrimaldi · 2025-06-30T10:30:48Z

openedx_events/learning/data.py

+@attr.s(frozen=True)
+class LtiProviderLaunchData:
+    """
+    Class that encapsulates LTI data for an LTI launch event.


Can we add the attrs description as well here?

xitij2000 · 2025-06-30T17:58:00Z

@mariajgrimaldi I've updated the PR as per you suggestion. Do tell me if there are any issues with including the user data.

mariajgrimaldi

LGTM!

Thank you so much

mariajgrimaldi · 2025-07-02T12:25:44Z

https://github.com/openedx/openedx-events/releases/tag/10.3.0

openedx-webhooks added open-source-contribution PR author is not from Axim or 2U core contributor PR author is a Core Contributor (who may or may not have write access to this repo). labels May 20, 2025

openedx-webhooks added this to Contributions May 20, 2025

github-project-automation bot moved this to Needs Triage in Contributions May 20, 2025

xitij2000 force-pushed the kshitij/lti-launch-event branch 2 times, most recently from 1217faf to c6b4e47 Compare May 22, 2025 12:23

xitij2000 mentioned this pull request May 22, 2025

feat: new event to track LTI Launches via LTI Provider openedx/edx-platform#36756

Open

xitij2000 force-pushed the kshitij/lti-launch-event branch 3 times, most recently from a2c00a7 to 53ee0c1 Compare May 22, 2025 17:26

xitij2000 marked this pull request as ready for review May 23, 2025 07:06

xitij2000 requested a review from a team as a code owner May 23, 2025 07:06

xitij2000 force-pushed the kshitij/lti-launch-event branch from 53ee0c1 to b60a2c3 Compare May 23, 2025 07:09

tecoholic approved these changes May 26, 2025

View reviewed changes

xitij2000 force-pushed the kshitij/lti-launch-event branch from b60a2c3 to d084a15 Compare May 26, 2025 09:41

tecoholic mentioned this pull request May 26, 2025

feat: Platform plugin to record when there is an LTI launch open-craft/platform-plugin-lti-launch-monitor#1

Merged

7 tasks

mphilbrick211 moved this from Needs Triage to Ready for Review in Contributions May 27, 2025

feat: Add event for LTI Launches

e0f7fa3

xitij2000 force-pushed the kshitij/lti-launch-event branch from d084a15 to e0f7fa3 Compare June 3, 2025 10:02

mariajgrimaldi requested changes Jun 30, 2025

View reviewed changes

fixup! feat: Add event for LTI Launches

a290182

mariajgrimaldi approved these changes Jun 30, 2025

View reviewed changes

fixup! fixup! feat: Add event for LTI Launches

78d9c03

mariajgrimaldi approved these changes Jul 2, 2025

View reviewed changes

mariajgrimaldi merged commit 72e66cc into openedx:main Jul 2, 2025
13 checks passed

github-project-automation bot moved this from Ready for Review to Done in Contributions Jul 2, 2025

xitij2000 deleted the kshitij/lti-launch-event branch July 2, 2025 17:02

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: Add event for LTI Launches #501

feat: Add event for LTI Launches #501

Uh oh!

xitij2000 commented May 20, 2025

Uh oh!

openedx-webhooks commented May 20, 2025 •

edited

Loading

Uh oh!

tecoholic left a comment

Uh oh!

tecoholic May 26, 2025

Uh oh!

mariajgrimaldi left a comment

Uh oh!

mariajgrimaldi Jun 30, 2025

Uh oh!

xitij2000 Jun 30, 2025 •

edited

Loading

Uh oh!

mariajgrimaldi Jun 30, 2025

Uh oh!

mariajgrimaldi Jun 30, 2025

Uh oh!

xitij2000 commented Jun 30, 2025

Uh oh!

mariajgrimaldi left a comment

Uh oh!

Uh oh!

mariajgrimaldi commented Jul 2, 2025

Uh oh!

Uh oh!

feat: Add event for LTI Launches #501

feat: Add event for LTI Launches #501

Uh oh!

Conversation

xitij2000 commented May 20, 2025

Description

Supporting information

Testing instructions

Deadline

Other information

Checklists

Uh oh!

openedx-webhooks commented May 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tecoholic left a comment

Choose a reason for hiding this comment

Uh oh!

tecoholic May 26, 2025

Choose a reason for hiding this comment

Uh oh!

mariajgrimaldi left a comment

Choose a reason for hiding this comment

Uh oh!

mariajgrimaldi Jun 30, 2025

Choose a reason for hiding this comment

Uh oh!

xitij2000 Jun 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mariajgrimaldi Jun 30, 2025

Choose a reason for hiding this comment

Uh oh!

mariajgrimaldi Jun 30, 2025

Choose a reason for hiding this comment

Uh oh!

xitij2000 commented Jun 30, 2025

Uh oh!

mariajgrimaldi left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

mariajgrimaldi commented Jul 2, 2025

Uh oh!

Uh oh!

openedx-webhooks commented May 20, 2025 •

edited

Loading

xitij2000 Jun 30, 2025 •

edited

Loading