Skip to content

Conversation

@mariajgrimaldi
Copy link
Member

@mariajgrimaldi mariajgrimaldi commented Sep 2, 2021

Description

Second batch of Open edX Events, a continuation of #28266. This time around we add the following events:

  • Add COURSE_ENROLLMENT_CHANGED: sent after the enrollment update
  • Add COURSE_UNENROLLMENT_COMPLETED: sent after the user's unenrollment
  • Add CERTIFICATE_CREATED after the user's certificate generation has
    been completed
  • Add CERTIFICATE_CHANGED: after the certification update has been
    completed
  • Add CERTIFICATE_REVOKED: after the certificate revocation has been completed.
  • Add COHORT_MEMBERSHIP_CHANGED: when a cohort membership update ends

Supporting information

For an overall understanding of the design, check out the Open edX Events ADRs and discussions:

  1. Open edX Event naming and versioning ADR
  2. Open edX Event Payload Conventions ADR
  3. Community discussion about Open edX Events design
  4. Community discussion about Hooks Extension Framework

Discuss on Hooks Extension Framework:
https://discuss.openedx.org/t/configuration-for-the-hooks-extension-framework/4527/

Testing instructions

  1. Checkout to MJG/2nd_batch_openedx_events
  2. Install Open edX Events library:
    pip install openedx-events==0.5.1
  3. Connect your custom receiver to the signal as follows:
from openedx_events.learning.signals import STUDENT_REGISTRATION_COMPLETED

@receiver(COURSE_ENROLLMENT_CHANGED)
def callback(**kwargs):

Deadline

Before Maple cut.

Other information

Author's concerns

  • Is the location of the events correct?

@openedx-webhooks openedx-webhooks added open-source-contribution PR author is not from Axim or 2U waiting on author PR author needs to resolve review requests, answer questions, fix tests, etc. labels Sep 2, 2021
@openedx-webhooks
Copy link

openedx-webhooks commented Sep 2, 2021

Thanks for the pull request, @mariajgrimaldi! I've created BLENDED-953 to keep track of it in Jira. More details are on the BD-32 project page.

When this pull request is ready, tag your edX technical lead.

@mariajgrimaldi mariajgrimaldi force-pushed the MJG/2nd_batch_openedx_events branch 4 times, most recently from 5a2ea61 to 6166575 Compare September 3, 2021 15:38
@mariajgrimaldi mariajgrimaldi changed the title [WIP] feat: add 2nd batch of Open edX Events [BD-32] feat: add 2nd batch of Open edX Events Sep 3, 2021
@mariajgrimaldi mariajgrimaldi marked this pull request as ready for review September 3, 2021 16:28
@openedx-webhooks openedx-webhooks added blended PR is managed through 2U's blended developmnt program needs triage and removed open-source-contribution PR author is not from Axim or 2U waiting on author PR author needs to resolve review requests, answer questions, fix tests, etc. labels Sep 3, 2021
@mariajgrimaldi
Copy link
Member Author

Hi there! @ormsbee @feanil @nasthagiri @felipemontoya

I hope you're having a great week! I just opened this PR with the second batch of Open edX Events and their tests. I look forward to hearing from you!

@mariajgrimaldi mariajgrimaldi force-pushed the MJG/2nd_batch_openedx_events branch from ae13d04 to 560d261 Compare September 6, 2021 12:35
Copy link
Member

@felipemontoya felipemontoya left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All the events for this PR look good, data is consistent and the same is true for tests. I think we could merge this and thus complete the first 8 basic openedx events.

@mariajgrimaldi mariajgrimaldi force-pushed the MJG/2nd_batch_openedx_events branch from 560d261 to 1150860 Compare September 6, 2021 21:32
* Add COURSE_ENROLLMENT_CHANGED: sent after the enrollment update
* Add COURSE_UNENROLLMENT_COMPLETED: sent after the user's unenrollment
* Add CERTIFICATE_CREATED after the user's certificate generation has
been completed
* Add CERTIFICATE_CHANGED: after the certification update has been
completed
* Add CERTIFICATE_REVOKED: after the certificate revocation has been
completed
* Add COHORT_MEMBERSHIP_CHANGED: when a cohort membership update ends
@mariajgrimaldi mariajgrimaldi force-pushed the MJG/2nd_batch_openedx_events branch from 1150860 to 1c447e6 Compare September 15, 2021 18:50
@edx-status-bot
Copy link

Your PR has finished running tests. There were no failures.

@felipemontoya
Copy link
Member

@nasthagiri @ormsbee would you approve us merging this?
We just bumped the version of the openedx-events lib so that the latest changes using the send_robust signals are also included.

@felipemontoya
Copy link
Member

Thanks a lot @mariajgrimaldi and @ormsbee. I will merge this now. Open edx events are now in the platform.

@felipemontoya felipemontoya merged commit dbb4658 into openedx:master Sep 22, 2021
@openedx-webhooks
Copy link

@mariajgrimaldi 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future.

@edx-pipeline-bot
Copy link
Contributor

EdX Release Notice: This PR has been deployed to the staging environment in preparation for a release to production.

@nasthagiri
Copy link
Contributor

Congratulations!

@edx-pipeline-bot
Copy link
Contributor

EdX Release Notice: This PR has been deployed to the production environment.

1 similar comment
@edx-pipeline-bot
Copy link
Contributor

EdX Release Notice: This PR has been deployed to the production environment.

MaferMazu pushed a commit to fccn/edx-platform that referenced this pull request Aug 31, 2022
* Add PreEnrollmentFilter
* Add PreRegisterFilter
* Add PreLoginFilter

For more info: openedx/edx-platform#29449

Some events that were already on the platform were also added:
* Add COURSE_ENROLLMENT_CHANGED: sent after the enrollment update
* Add COURSE_ENROLLMENT_CREATED event after the user's enrollment creation
* Add COURSE_UNENROLLMENT_COMPLETED: sent after the user's unenrollment

For more info:
openedx/edx-platform#28266
openedx/edx-platform#28640
BetoFandino pushed a commit to fccn/edx-platform that referenced this pull request May 24, 2023
* Add PreEnrollmentFilter
* Add PreRegisterFilter
* Add PreLoginFilter

For more info: openedx/edx-platform#29449

Some events that were already on the platform were also added:
* Add COURSE_ENROLLMENT_CHANGED: sent after the enrollment update
* Add COURSE_ENROLLMENT_CREATED event after the user's enrollment creation
* Add COURSE_UNENROLLMENT_COMPLETED: sent after the user's unenrollment

For more info:
openedx/edx-platform#28266
openedx/edx-platform#28640
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

blended PR is managed through 2U's blended developmnt program merged

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants