feat: [FC-0074] add support for optional trigger information

[mariajgrimaldi]

Description

Add triggering fields for opened-events annotations so developers can include relevant information about where the event is being triggered by rendering a link that redirects to a GH search with the source file and the event name.

Testing Instructions

1. Create a venv
2. Install this version of openedx-events which uses event_trigger_repository and event_trigger_path
3. Generate docs for openedx-events by running: make docs

You can also review the rendered docs here: https://docsopenedxorg--443.org.readthedocs.build/projects/openedx-events/en/443/

Merge Checklist:

• All reviewers approved
• Reviewer tested the code following the testing instructions
• CI build is green
• Version bumped
• Changelog record added with short description of the change and current date
• Documentation updated (not only docstrings)
• Noted any: Concerns, dependencies, migration issues, deadlines, tickets

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)

[openedx-webhooks]

Thanks for the pull request, @mariajgrimaldi!

This repository is currently maintained by @bmtcril.

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:

• Overview of Review Process for Community Contributions
• Pull Request Status Guide
• Making changes to your pull request

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.

[sarina]

I'm also going to defer this review to @bmtcril

[bmtcril]

I would love to have this functionality, but I'm concerned that this implementation is too limiting. For instance if an event is triggered from multiple places, how would that be handled? I think it would also be challenging to keep the path references up to date when the annotations may be defined far away from the code.

[mariajgrimaldi]

@bmtcril: Thanks for the review! This is how it looks for events triggered in multiple locations. It's simply a list of paths, each with its own GH search link.

Can you explain further what you mean by I think it would also be challenging to keep the path references up to date when the annotations may be defined far away from the code? Also, what do you think would make this less limiting?

[bmtcril]

@bmtcril: Thanks for the review! This is how it looks for events triggered in multiple locations. It's simply a list of paths, each with its own GH search link.

Ah that's great, I had somehow forgotten that you could have repeating annotations.

Can you explain further what you mean by I think it would also be challenging to keep the path references up to date when the annotations may be defined far away from the code? Also, what do you think would make this less limiting?

My concern is that the event annotations live in openedx-events, but the places where events are triggered are elsewhere. So it would be hard to remember that when you refactor and move where an event is triggered, or add a new place, or remove it that you also need to go and update openedx-events to keep the docs up to date. I don't have a solution for that right now, but I think it's an important consideration.

[mariajgrimaldi]

@bmtcril: totally. What we can do is change the GH search to something like https://github.com/search?q=repo%3Aopenedx%2Fedx-platform+CONTENT_OBJECT_ASSOCIATIONS_CHANGED.send_event&type=code, with the repo + event name.send_event, so at least we can inspect where the event is sent from without hardcoding the path. What do you think?

I think this approach would be more maintainable over time since it's less likely that the repository where the event would change frequently. Here's what the change would look like: f82bf19

[mariajgrimaldi]

Reference: #135 (comment)

[bmtcril]

@bmtcril: totally. What we can do is change the GH search to something like https://github.com/search?q=repo%3Aopenedx%2Fedx-platform+CONTENT_OBJECT_ASSOCIATIONS_CHANGED.send_event&type=code, with the repo + event name.send_event, so at least we can inspect where the event is sent from without hardcoding the path. What do you think?

I think this approach would be more maintainable over time since it's less likely that the repository where the event would change frequently. Here's what the change would look like: f82bf19

That looks perfect, thank you!

[bmtcril]

Looks good once tests pass

[mariajgrimaldi]

@bmtcril, done, thank you! You can review the results here: https://docsopenedxorg--443.org.readthedocs.build/projects/openedx-events/en/443/reference/events.html

[bmtcril]

Thanks! This is released in v2.2.0