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.

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

Expose xAPI forwarding endpoint #88

Merged
merged 23 commits into from
Jan 30, 2025
Merged

Expose xAPI forwarding endpoint #88

merged 23 commits into from
Jan 30, 2025

Conversation

milt
Copy link

@milt milt commented Jan 23, 2025

Description

This PR adds an api endpoint /statements that forwards xAPI statements from the UI to an LRS if one is configured in an XDSConfiguration. It also adds that configuration via a migration.
The forwarding endpoint respects a whitelist of approved verbs, applies an xAPI actor to the statement based on authentication, and generates a session-based registration UUID.

See corresponding xds-ui PR here: OpenLXP/openlxp-xds-ui#130

TO DO

  • Whitelist verbs
  • Get CI running on our fork, test
  • Set actor on backend
  • Set registration on backend
  • Allow anonymous statements
  • DOCS
  • Possibly make corresponding updates to e2e tests? (post-merge probably)

Pre-Merge Checklist:

  • I have ensured this code follows the style guidelines of this project.
  • I have performed a comprehensive self-review of the code.
  • I have included comments clarifying hard-to-understand areas of the code.
  • I have updated the documentation corresponding to my change(s).
  • I have confirmed the code executes properly on my local environment.
  • I have confirmed all new/modified data models are structured correctly.
  • I have included all necessary database migration files.
  • I have verified that all new and existing tests pass.
  • I have received approval from the requisite number of reviewers.
  • I have squashed all working commits into as few final commits as reasonably possible.
  • I have confirmed Github reports all automated tests/checks are passing.

Post-Merge Checklist:

  • Delete working branch @ Github repository
  • Pull latest master branch to local repository
  • Delete working branch @ local repository

@milt milt requested a review from JDTobin January 23, 2025 16:03
@milt milt marked this pull request as ready for review January 24, 2025 17:24
@milt milt merged commit 1e53af5 into dev Jan 30, 2025
2 checks passed
@milt milt deleted the feature/xapi_forwarding branch January 30, 2025 16:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants