openedx / openedx/event-routing-backends

xAPI Video events don't report required progress for paused, terminated, completed verbs

Open
#232 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
14
Forks
23
PR merge metrics
No merged PRs in 30d

Description

The progress extension is:

Used to expresses the percentage of media consumed by the actor.

We are required to emit it in certain cases:

The LRP MUST assign progress value to statements with "paused", "terminated" and "completed" verbs.

Used to expresses the percentage of media consumed by the actor.
LRP Obligations
The LRP MUST assign progress value to statements with "paused", "terminated" and "completed" verbs.

It should be represented in the statement as follows:

    "result": {
        "completion": true,
        "extensions": {
            "https://w3id.org/xapi/video/extensions/played-segments": "0[.]46.613",
            "https://w3id.org/xapi/video/extensions/progress": 1,
            "https://w3id.org/xapi/video/extensions/time": 46.613
        }
    }

Full sample events are available here.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the event transformation path for xAPI Video statements and compare handling of paused, terminated, and completed verbs. Use the linked xAPI Video Profile templates as the expected format; done means those statements include the progress extension in result.extensions, with tests covering the required verbs.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
backend
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.