openedx / openedx/openedx-events

Guidelines for proactive vs reactive event definitions in openedx-events

Open
#247 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
13
Forks
33
Avg merge
14h 37m
Merged PRs (30d)
4

Description

The Open edX platform includes many types of events, and this post is specifically addressing event signals in this repo. These are mainly used for plugins within a service, or to put on the event bus for cross-service communication.

Most of my experience from the event bus work has been with what I'll call "reactive event definitions", which are signal events that were added once a known consumer needed the event. It is possible that some of the earlier events were implemented more proactively, where we weren't sure when and if there would be a consumer, but were making the events available just in case.

A question has arisen as to whether we should proactively be publishing create/update/delete events for all key models as part of their public API, and I'm wondering what others think.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No files, tests, or entry points are identified in the issue. Read the discussion and existing openedx-events event definitions first, then establish whether proactive and reactive events need documented guidelines; done means the project has an agreed, written policy.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
distributed-systems
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.