feat: Add event for LTI Launches#501
Conversation
|
Thanks for the pull request, @xitij2000! This repository is currently maintained by 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 approvalIf you haven't already, check this list to see if your contribution needs to go through the product review process.
🔘 Provide contextTo 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:
🔘 Get a green buildIf one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green. DetailsWhere 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:
💡 As a result it may take up to several weeks or months to complete a review and merge your PR. |
1217faf to
c6b4e47
Compare
a2c00a7 to
53ee0c1
Compare
53ee0c1 to
b60a2c3
Compare
tecoholic
left a comment
There was a problem hiding this comment.
- I tested this: Tested this along with openedx/openedx-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
| Data required for a successful LTI launch. | ||
|
|
||
| Attributes: | ||
| roles (str): The roles (as per LTI Spec) of the User. |
There was a problem hiding this comment.
@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.
b60a2c3 to
d084a15
Compare
d084a15 to
e0f7fa3
Compare
mariajgrimaldi
left a comment
There was a problem hiding this comment.
Thank you for the contribution! We really appreciate it. I left two minor comments to address, so we can merge after. Thank you!
| """ | ||
| Class that encapsulates LTI data for an LTI launch event. | ||
| """ | ||
| user = attr.ib(type=UserData) |
There was a problem hiding this comment.
Is there a reason why we're duplicating user's the info?
There was a problem hiding this comment.
The user data here is for the Open edX user, whereas the user in the LtiProviderLaunchParamsData is the remote user id received via LTI.
There was a problem hiding this comment.
Oh great. Can we add that detail in the docstring?
| @attr.s(frozen=True) | ||
| class LtiProviderLaunchData: | ||
| """ | ||
| Class that encapsulates LTI data for an LTI launch event. |
There was a problem hiding this comment.
Can we add the attrs description as well here?
|
@mariajgrimaldi I've updated the PR as per you suggestion. Do tell me if there are any issues with including the user data. |
mariajgrimaldi
left a comment
There was a problem hiding this comment.
LGTM!
Thank you so much
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.
Checklists
Check off if complete or not applicable:
Merge Checklist:
Post Merge:
finished.