Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: [FC-0074] add event trigger information in code annotations #443

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

feat: [FC-0074] add event trigger information in code annotations #443

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
8385cbe
feat: add trigger code-annotations
mariajgrimaldi Dec 27, 2024
0647f18
temp: use 2.1 based branch instead
mariajgrimaldi Dec 27, 2024
afc320c
docs: use more specific name for trigger path
mariajgrimaldi Dec 27, 2024
898a771
temp: use latest code-annotations version
mariajgrimaldi Dec 30, 2024
4104946
refactor: drop todo comments in favor of issue
mariajgrimaldi Dec 30, 2024
97a5e86
docs: add multiple triggers to event
mariajgrimaldi Dec 30, 2024
8b6706a
refactor: disable line too long warning for line
mariajgrimaldi Dec 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions openedx_events/analytics/signals.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@
# .. event_key_field: tracking_log.name
# .. event_description: emitted when a tracking log is created.
# .. event_data: TrackingLogData
# .. event_trigger_repository: openedx/event-tracking
# .. event_trigger_path: eventtracking/backends/event_bus.py
TRACKING_EVENT_EMITTED = OpenEdxPublicSignal(
event_type="org.openedx.analytics.tracking.event.emitted.v1",
data={
Expand Down
34 changes: 34 additions & 0 deletions openedx_events/content_authoring/signals.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@
# .. event_key_field: catalog_info.course_key
# .. event_description: Fired when a course changes in Studio in a way that is relevant for catalog consumers.
# .. event_data: CourseCatalogData
# .. event_trigger_repository: openedx/edx-platform
# .. event_trigger_path: cms/djangoapps/contentstore/signals/handlers.py
COURSE_CATALOG_INFO_CHANGED = OpenEdxPublicSignal(
event_type="org.openedx.content_authoring.course.catalog_info.changed.v1",
data={
Expand All @@ -38,6 +40,8 @@
# .. event_key_field: xblock_info.usage_key
# .. event_description: Fired when an XBlock is created.
# .. event_data: XBlockData
# .. event_trigger_repository: openedx/edx-platform
# .. event_trigger_path: xmodule/modulestore/mixed.py
XBLOCK_CREATED = OpenEdxPublicSignal(
event_type="org.openedx.content_authoring.xblock.created.v1",
data={
Expand All @@ -50,6 +54,8 @@
# .. event_key_field: xblock_info.usage_key
# .. event_description: Fired when an XBlock is updated.
# .. event_data: XBlockData
# .. event_trigger_repository: openedx/edx-platform
# .. event_trigger_path: xmodule/modulestore/mixed.py
XBLOCK_UPDATED = OpenEdxPublicSignal(
event_type="org.openedx.content_authoring.xblock.updated.v1",
data={
Expand All @@ -67,6 +73,8 @@
# only a single event is fired with section details like :
# `XBlockData(usage_key="section-usage-key", block_type="chapter")`
# .. event_data: XBlockData
# .. event_trigger_repository: openedx/edx-platform
# .. event_trigger_path: xmodule/modulestore/mixed.py
XBLOCK_PUBLISHED = OpenEdxPublicSignal(
event_type="org.openedx.content_authoring.xblock.published.v1",
data={
Expand All @@ -80,6 +88,8 @@
# .. event_key_field: xblock_info.usage_key
# .. event_description: Fired when an XBlock is deleted.
# .. event_data: XBlockData
# .. event_trigger_repository: openedx/edx-platform
# .. event_trigger_path: xmodule/modulestore/mixed.py
XBLOCK_DELETED = OpenEdxPublicSignal(
event_type="org.openedx.content_authoring.xblock.deleted.v1",
data={
Expand All @@ -93,6 +103,8 @@
# .. event_key_field: xblock_info.usage_key
# .. event_description: Fired when an XBlock is duplicated in Studio.
# .. event_data: DuplicatedXBlockData
# .. event_trigger_repository: openedx/edx-platform
# .. event_trigger_path: xmodule/modulestore/mixed.py
XBLOCK_DUPLICATED = OpenEdxPublicSignal(
event_type="org.openedx.content_authoring.xblock.duplicated.v1",
data={
Expand Down Expand Up @@ -129,6 +141,8 @@
# .. event_name: COURSE_CREATED
# .. event_description: emitted when a course is created
# .. event_data: CourseData
# .. event_trigger_repository: openedx/edx-platform
# .. event_trigger_path: xmodule/modulestore/mixed.py
COURSE_CREATED = OpenEdxPublicSignal(
event_type="org.openedx.content_authoring.course.created.v1",
data={
Expand All @@ -140,6 +154,8 @@
# .. event_name: CONTENT_LIBRARY_CREATED
# .. event_description: emitted when a content library is created
# .. event_data: ContentLibraryData
# .. event_trigger_repository: openedx/edx-platform
# .. event_trigger_path: openedx/core/djangoapps/content_libraries/api.py
CONTENT_LIBRARY_CREATED = OpenEdxPublicSignal(
event_type="org.openedx.content_authoring.content_library.created.v1",
data={
Expand All @@ -151,6 +167,8 @@
# .. event_name: CONTENT_LIBRARY_UPDATED
# .. event_description: emitted when a content library is updated
# .. event_data: ContentLibraryData
# .. event_trigger_repository: openedx/edx-platform
# .. event_trigger_path: openedx/core/djangoapps/content_libraries/api.py
CONTENT_LIBRARY_UPDATED = OpenEdxPublicSignal(
event_type="org.openedx.content_authoring.content_library.updated.v1",
data={
Expand All @@ -162,6 +180,8 @@
# .. event_name: CONTENT_LIBRARY_DELETED
# .. event_description: emitted when a content library is deleted
# .. event_data: ContentLibraryData
# .. event_trigger_repository: openedx/edx-platform
# .. event_trigger_path: openedx/core/djangoapps/content_libraries/api.py
CONTENT_LIBRARY_DELETED = OpenEdxPublicSignal(
event_type="org.openedx.content_authoring.content_library.deleted.v1",
data={
Expand All @@ -173,6 +193,8 @@
# .. event_name: LIBRARY_BLOCK_CREATED
# .. event_description: emitted when a library block is created
# .. event_data: LibraryBlockData
# .. event_trigger_repository: openedx/edx-platform
# .. event_trigger_path: openedx/core/djangoapps/content_libraries/api.py
LIBRARY_BLOCK_CREATED = OpenEdxPublicSignal(
event_type="org.openedx.content_authoring.library_block.created.v1",
data={
Expand All @@ -184,6 +206,8 @@
# .. event_name: LIBRARY_BLOCK_UPDATED
# .. event_description: emitted when a library block is updated
# .. event_data: LibraryBlockData
# .. event_trigger_repository: openedx/edx-platform
# .. event_trigger_path: openedx/core/djangoapps/content_libraries/library_context.py
LIBRARY_BLOCK_UPDATED = OpenEdxPublicSignal(
event_type="org.openedx.content_authoring.library_block.updated.v1",
data={
Expand All @@ -195,6 +219,8 @@
# .. event_name: LIBRARY_BLOCK_DELETED
# .. event_description: emitted when a library block is deleted
# .. event_data: LibraryBlockData
# .. event_trigger_repository: openedx/edx-platform
# .. event_trigger_path: openedx/core/djangoapps/content_libraries/api.py
LIBRARY_BLOCK_DELETED = OpenEdxPublicSignal(
event_type="org.openedx.content_authoring.library_block.deleted.v1",
data={
Expand All @@ -206,6 +232,8 @@
# .. event_name: CONTENT_OBJECT_ASSOCIATIONS_CHANGED
# .. event_description: emitted when an object's associations are changed, e.g tags, collections
# .. event_data: ContentObjectData
# .. event_trigger_repository: openedx/edx-platform
# .. event_trigger_path: openedx/core/djangoapps/content_tagging/api.py
CONTENT_OBJECT_ASSOCIATIONS_CHANGED = OpenEdxPublicSignal(
event_type="org.openedx.content_authoring.content.object.associations.changed.v1",
data={
Expand All @@ -229,6 +257,8 @@
# .. event_name: LIBRARY_COLLECTION_CREATED
# .. event_description: emitted when a content library collection is created
# .. event_data: LibraryCollectionData
# .. event_trigger_repository: openedx/edx-platform
# .. event_trigger_path: openedx/core/djangoapps/content_libraries/signal_handlers.py
LIBRARY_COLLECTION_CREATED = OpenEdxPublicSignal(
event_type="org.openedx.content_authoring.content_library.collection.created.v1",
data={
Expand All @@ -240,6 +270,8 @@
# .. event_name: LIBRARY_COLLECTION_UPDATED
# .. event_description: emitted when when a content library collection is updated
# .. event_data: LibraryCollectionData
# .. event_trigger_repository: openedx/edx-platform
# .. event_trigger_path: openedx/core/djangoapps/content_libraries/signal_handlers.py
LIBRARY_COLLECTION_UPDATED = OpenEdxPublicSignal(
event_type="org.openedx.content_authoring.content_library.collection.updated.v1",
data={
Expand All @@ -251,6 +283,8 @@
# .. event_name: LIBRARY_COLLECTION_DELETED
# .. event_description: emitted when an when a content library collection is deleted
# .. event_data: LibraryCollectionData
# .. event_trigger_repository: openedx/edx-platform
# .. event_trigger_path: openedx/core/djangoapps/content_libraries/signal_handlers.py
LIBRARY_COLLECTION_DELETED = OpenEdxPublicSignal(
event_type="org.openedx.content_authoring.content_library.collection.deleted.v1",
data={
Expand Down
10 changes: 10 additions & 0 deletions openedx_events/enterprise/signals.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,8 @@
# .. event_description: emitted when an enterprise ledger transaction is created.
# See: https://github.com/openedx/openedx-ledger/tree/main/docs/decisions
# .. event_data: LedgerTransaction
# .. event_trigger_repository: openedx/enterprise-subsidy
# .. event_trigger_path: enterprise_subsidy/apps/core/event_bus.py
LEDGER_TRANSACTION_CREATED = OpenEdxPublicSignal(
event_type="org.openedx.enterprise.subsidy_ledger_transaction.created.v1",
data={
Expand All @@ -52,6 +54,8 @@
# .. event_description: emitted when an enterprise ledger transaction is committed.
# See: https://github.com/openedx/openedx-ledger/tree/main/docs/decisions
# .. event_data: LedgerTransaction
# .. event_trigger_repository: openedx/enterprise-subsidy
# .. event_trigger_path: enterprise_subsidy/apps/core/event_bus.py
LEDGER_TRANSACTION_COMMITTED = OpenEdxPublicSignal(
event_type="org.openedx.enterprise.subsidy_ledger_transaction.committed.v1",
data={
Expand All @@ -65,6 +69,8 @@
# .. event_description: emitted when an enterprise ledger transaction fails.
# See: https://github.com/openedx/openedx-ledger/tree/main/docs/decisions
# .. event_data: LedgerTransaction
# .. event_trigger_repository: openedx/enterprise-subsidy
# .. event_trigger_path: enterprise_subsidy/apps/core/event_bus.py
LEDGER_TRANSACTION_FAILED = OpenEdxPublicSignal(
event_type="org.openedx.enterprise.subsidy_ledger_transaction.failed.v1",
data={
Expand All @@ -78,6 +84,8 @@
# .. event_description: emitted when an enterprise ledger transaction is reversed.
# See: https://github.com/openedx/openedx-ledger/tree/main/docs/decisions
# .. event_data: LedgerTransaction
# .. event_trigger_repository: openedx/enterprise-subsidy
# .. event_trigger_path: enterprise_subsidy/apps/core/event_bus.py
LEDGER_TRANSACTION_REVERSED = OpenEdxPublicSignal(
event_type="org.openedx.enterprise.subsidy_ledger_transaction.reversed.v1",
data={
Expand All @@ -91,6 +99,8 @@
# .. event_description: emitted when a LearnerCreditEnterpriseCourseEnrollment is revoked. This most often happens when
# an enterprise learner unenrolls from a course which was LC-subsidized.
# .. event_data: LearnerCreditEnterpriseCourseEnrollment
# .. event_trigger_repository: openedx/edx-enterprise
# .. event_trigger_path: enterprise/event_bus.py
LEARNER_CREDIT_COURSE_ENROLLMENT_REVOKED = OpenEdxPublicSignal(
event_type="org.openedx.enterprise.learner_credit_course_enrollment.revoked.v1",
data={
Expand Down
Loading
Loading