openedx / openedx/openedx-events
Audit for timestamp sent on existing signals
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 13
- Forks
- 33
- Avg merge
- 14h 37m
- Merged PRs (30d)
- 4
Description
Signals implemented and sent before timestamp was an available parameter are possibly not meeting the time requirements as documented in OEP-41.
This issue proposes a one-time audit and cataloging of which implementations should be updated. That work could potentially be separately ticketed. I know things will be missed with the current process, where I try to remember to ask others when they put events on the event bus. The XBLOCK_X related events are soon to be produced to the event bus, and I'm not clear if there is an appropriate timestamp to be used.
FYI: @ormsbee
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the timestamp requirements in OEP-41 and locating existing signal implementations that are sent before timestamps are supported. Catalog which implementations need review, including the upcoming XBLOCK_X events, and document which timestamp choices or follow-up updates are required.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- backend-api-design
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100