Project ID

https://openedx.atlassian.net/browse/ARCHBOM-1524

https://openedx.atlassian.net/browse/ARCHBOM-1659

edX Product Lead

Nimisha Asthagiri (Deactivated)

edX Technical Primary

Tim McCormack

Provider

edly

Provider Lead

Zia Fazal

Calendly Scheduling Link

Slack Channel

#external-openedx-edly

Meeting Cadence / Preference

Method of Action Item Tracking

Confluence, Slack, etc.

Escalation Path

Insert link to provider's private page here as the escalation path is outlined there

Relevant Discovery Documents

OEP-26: Real-time Events

Status Update Frequency

Insert agreed upon cadence of project status updates from provider (ideally this should be every 1-2 weeks)

Target Completion Date

Project Epic (Tracks Pull Requests)

https://openedx.atlassian.net/browse/ARCHBOM-1524

Open Action Items

Project Plan

  1. Setup a new django app cookiecutter for xapi-caliper (repo name: event-routing-backends)

  2. edly team publishes ADRs to new repo for design and decsions already made.

  3. edx + edly review and revise ADRs and land ADR changes.

  4. edly team PRs basic implementation into the new repo.

  5. edX + edly work together to deploy basic app to edx.org environments.

  6. Configure new backends and Test against IMS test-suite in a sandbox environment. (blue star)

  7. Update code to make PII Leaking harder to do on accident.

    1. PII leakage regression test

      1. Add “negative” tests to ensure we do not send fields that are not in the Django-model-config “allow-list”.

  8. Replace enterprise xAPI implementation with this new implementation.

    1. Discovery: Which events are enterprise sending?

    2. Access control / filtering (see #9).

    3. Routers: Implement routers per enterprise.

  9. Access-control/Filtering: Update code to support access control and filtering of events for different consumers.

    1. Write an ADR to be reviewed by edX and Open edX community (publicize on Discourse)

    2. Organizations/External Services to support

      1. Must-have: enterprises

      2. Super-nice-to-have: LRSes, university partners

      3. Nice-to-have: external tool services

  10. Configure prod to be able to test Caliper in production.

Status Updates

Time Frame

Updates & Actions Needed

  • Met with edly team and established initial project plan.

Add action items by selecting the check box icon from the editing menu above. These actions will appear in the task table you create above.

  • Next steps

    • Edly will implement a PII leakage regression test, which will provide a clear abstraction layer and a test for the definition of done.

    • Edly to write an ADR for the access-control.

Relevant Jira Stories, Tasks, Bugs

This section will link to all the development stories, tasks, and bugs connected to the single (or multiple) epics used to track the work on the Open edX JIRA site.