feat: adds xApiTransforms for completion aggregator events #205
Conversation
pomegranited
force-pushed
the
jill/nelc/and/add_completion_events
branch
2 times, most recently
from
1e6e047 to
f886219
Compare
* adds dependency on edx-event-routing-backends * adds transformers to xapi.completion and xapi.progress * adds the completion_aggregator events to the event tracking whitelist
pomegranited
force-pushed
the
jill/nelc/and/add_completion_events
branch
from
f886219 to
7652429
Compare
and adds CHANGELOG entry.
test settings and plugin settings. The previous commit resulted in the COMPLETION_AGGREGATOR_ASYNC_AGGREGATION flag being flipped for some tests -- it was True in test_settings, but False in plugin_settings() So for these tests, we're now overriding that setting as needed.
…_completion_events
and rearrange INSTALLED_APPS to fix tests.
Uses transforms fixture test utilities from ERB to ensure that raw aggregator events are transformed to xAPI as expected. * test_output/ -- used by ERB to write failed event transforms for debugging * adds 'factory' as a test requirement because ERB tests needs it.
…_completion_events
not Score.scaled
Ordinary completion events are simply "progress" events with a recorded progress %, so we should do the same here -- no need for "completed" events.
…_completion_events
pomegranited
requested review from
bmtcril and
Agrendalath
and removed request for
bmtcril
There was a problem hiding this comment.
@pomegranited, is there a simple configuration to check the sent events without the tutor plugin? I'm getting the edx.devstack-palm.lms | 2024-06-17 15:50:18,680 INFO 3682 [eventtracking.backends.async_routing] [user 3] [ip 172.29.0.1] async_routing.py:41 - [EventEmissionExit] skipping event openedx.completion_aggregator.completion.vertical every time the event should be sent.
…tings Initialize EVENT_TRACKING_BACKENDS_ALLOWED_XAPI_EVENTS and EVENT_TRACKING_BACKENDS_ALLOWED_CALIPER_EVENTS if they aren't already, and append our events to them. ERB will do the same to preserve our settings if they're loaded first.
There was a problem hiding this comment.
@pomegranited, the changes look good to me. Could you please expand the readme section from #206 to include a note about the xAPI events and update the changelog (I think we should bump the minor version once again).
👍
- I tested this: I can see the
xapi_trackingINFO logs with theSuccessfully processed event "openedx.completion_aggregator.progress.{block_type}"message without any additional configuration on the devstack. - I read through the code
- I checked for accessibility issues: n/a
- Includes documentation:
⚠️ not yet
|
@Agrendalath I've fixed the event-routing-backends requirement (812188c), bumped the package version to 4.2.0 (a4858e5) and added a note about xAPI transforms to the README (3850789). Thank you so much for your thorough reviews! I'll merge this now. |
Description: Describe in a couple of sentence what this PR adds
Defines xAPI event transformers and tests for the aggregator events using the base event-routing-backends transformers.
Based heavily on openedx/event-routing-backends#377 -- thank you @andrey-canon!
Part of openedx/openedx-aspects#222
JIRA: FAL-3766 (private link)
Dependencies:
Installation instructions:
OPENEDX_EXTRA_PIP_REQUIREMENTS.OPENEDX_EXTRA_PIP_REQUIREMENTStoo -- have to do this otherwise Aspects will install its own version.Testing instructions:
You should be able to see
progressedandcompletedevents corresponding tochapter,sequential,vertical, andunitobjects in thexapi.xapi_events_all_parsed_mvtable.Reviewers:
Merge checklist:
Post merge:
finished.