✨(converter) add edx to xapi video converter #211

quitterie-lcs · 2022-09-01T14:22:43Z

Purpose

edX video events can be converted to xAPI for most of them. The interaction events can still not be converted.

Proposal

SergioSim

Looks great) have only minor questions & suggestions)

Also, it seems that some required extensions are missing; a table of required/optional extensions of the video profile can be found here.
If it's not possible to add a required extension due to insufficient data in the edX event, could we add a comment in the converter class doc-string?

src/ralph/models/edx/converters/xapi/video.py

tests/fixtures/hypothesis_strategies.py

src/ralph/models/edx/converters/xapi/video.py

tests/models/edx/converters/xapi/test_server.py

quitterie-lcs · 2022-09-05T14:48:32Z

Also, it seems that some required extensions are missing; a table of required/optional extensions of the video profile can be found here. If it's not possible to add a required extension due to insufficient data in the edX event, could we add a comment in the converter class doc-string?

@SergioSim
Actually, the xAPI statement modelisation for video events have to be changed too. All fields in context, results have been defined as optional, however in the modelisation, it does not fit to the statement rules of the video profile

SergioSim

Looks great) Almost there 👍 only a few comments/suggestions left

src/ralph/models/xapi/video/fields/contexts.py

tests/models/edx/converters/xapi/test_navigational.py

src/ralph/models/edx/converters/xapi/video.py

src/ralph/models/xapi/video/fields/results.py

SergioSim · 2022-10-06T10:31:53Z

src/ralph/models/xapi/video/fields/results.py

    length: Optional[float] = Field(alias=VIDEO_EXTENSION_LENGTH)
-    playedSegments: Optional[str] = Field(alias=VIDEO_EXTENSION_PLAYED_SEGMENTS)


Isn't the length a context extension field (to remove) and the playedSegments a result extension field (to keep)?

playedSegments is not in the template description, and length neither by the way !
https://profiles.adlnet.gov/profile/90b2c849-d744-4d0c-8bd0-403e7859a35b/templates/d0ee8f46-5704-428c-b21e-b583f99cd571

You are right! It seems there are differences between the video profile on the ADL profile server and the video profile documentation (recipe).

This might be because the video profile on the ADL profile server is version https://w3id.org/xapi/video/v1.0.2
and the documentation for the video profile is for version https://w3id.org/xapi/video/v1.0.3 😕

Also, looking at the ADL profile server user guide, it seems that once a profile is published, it cannot be updated (a part of adding translations).
Thus, could it be that the video profile might not be updated to v1.0.3 on the ADL profile server?

Could we add a note in the xAPI video statements model that they are using version 1.0.2 of the video profile?

Where do you see in the documentation the v1.0.3 version ? I don't get it. Only the 1.0.2 version has been published on the ADL server, I don't get why they would have documented a newer version before publishing it 😞

It seems they indeed don't mention a version number on their gitbook, however, the recipe for the video seeked statement looks very similar to the v1.0.3 jsonld template of the video profile on the xapi-authored-profiles repository.
I don't know why they published v1.0.2 on the profile server instead of v1.0.3. Maybe it's more widely accepted/used?

@SergioSim It's very unclear indeed. I based the model on v1.0.2 as it is the more visible on the profile documentation. But indeed, it would change a bit if the v1.0.3 is the official new version for this profile. I can ask in a issue the reason why. WDYT?

Good Idea) I think version v1.0.2 should be fine, however, it's always good to double check)

@SergioSim I opened this issue in the xapi-authored-profile repository.

src/ralph/models/xapi/video/fields/results.py

src/ralph/models/xapi/video/statements.py

src/ralph/models/xapi/video/fields/contexts.py

tests/models/xapi/test_video.py

quitterie-lcs · 2022-11-02T16:10:09Z

@SergioSim the last round! 🙏

SergioSim

This is Wonderful work! 🥇
Have only a few minor questions and optional suggestions)

src/ralph/models/xapi/video/fields/results.py

src/ralph/models/xapi/video/fields/contexts.py

src/ralph/models/edx/converters/xapi/video.py

src/ralph/models/xapi/video/fields/contexts.py

SergioSim · 2022-11-15T08:23:32Z

src/ralph/models/xapi/video/fields/results.py

@@ -17,27 +17,27 @@
 )


-class VideoActionResultExtensionsField(BaseModelWithConfig):
+class VideoResultExtensionsField(BaseModelWithConfig):


Same suggestion here to make the VideoResultExtensionsField inherit from the BaseModel which let's us remove the Config class overwrites in Video*ResultExtensionsField classes.

class Config: # pylint: disable=missing-class-docstring min_anystr_length = 0

src/ralph/models/xapi/video/fields/results.py

src/ralph/models/xapi/video/fields/contexts.py

src/ralph/models/xapi/video/statements.py

tests/fixtures/hypothesis_configuration.py

quitterie-lcs · 2022-11-16T14:42:32Z

@SergioSim even if you have already approved it, I made then modification you suggested. For the pydantic model configuration, I would suggest to keep this in this PR and modify in the future. The problem is a more global one, not only this field should have the additional extensions to be accepted. WDYT?

SergioSim · 2022-11-16T15:35:54Z

@SergioSim even if you have already approved it, I made then modification you suggested. For the pydantic model configuration, I would suggest to keep this in this PR and modify in the future. The problem is a more global one, not only this field should have the additional extensions to be accepted. WDYT?

Thanks a lot @quitterie-lcs ) Good Idea, let's discuss/resolve the optional extensions suggestion in a separate PR)
LGTM)

edX video events can be converted to xAPI for most of them. The interaction events can still not be converted.

When statements and events fields have to be tested for the edx models, two separate files are created for statements and events fields tests respectively.

`unhashable-member` pylint warning has to be disabled for some parts of the code.

quitterie-lcs self-assigned this Sep 1, 2022

quitterie-lcs added improvement FUN WIP labels Sep 1, 2022

quitterie-lcs force-pushed the add-edx-xapi-video-converter branch 2 times, most recently from daa38ad to 3ff6eb9 Compare September 1, 2022 15:04

quitterie-lcs added needs review and removed WIP labels Sep 1, 2022

quitterie-lcs requested a review from SergioSim September 1, 2022 15:05

quitterie-lcs force-pushed the add-edx-xapi-video-converter branch from 3ff6eb9 to 1eed42d Compare September 2, 2022 10:09

SergioSim reviewed Sep 2, 2022

View reviewed changes

quitterie-lcs force-pushed the add-edx-xapi-video-converter branch from 1eed42d to 38f7110 Compare September 5, 2022 15:28

quitterie-lcs added this to Open in Edx learning event modeling via automation Sep 5, 2022

quitterie-lcs moved this from Open to Review in progress in Edx learning event modeling Sep 5, 2022

quitterie-lcs requested a review from SergioSim September 27, 2022 13:44

SergioSim reviewed Oct 6, 2022

View reviewed changes

quitterie-lcs force-pushed the add-edx-xapi-video-converter branch from dbe301c to 398d4f3 Compare October 20, 2022 08:59

SergioSim reviewed Oct 20, 2022

View reviewed changes

src/ralph/models/xapi/video/fields/contexts.py Outdated Show resolved Hide resolved

quitterie-lcs force-pushed the add-edx-xapi-video-converter branch 3 times, most recently from b88deff to 763d10e Compare October 20, 2022 12:11

quitterie-lcs requested a review from SergioSim October 20, 2022 12:14

quitterie-lcs force-pushed the add-edx-xapi-video-converter branch from 763d10e to 1158247 Compare October 21, 2022 15:11

quitterie-lcs force-pushed the add-edx-xapi-video-converter branch from 1158247 to 02c65b0 Compare October 31, 2022 08:37

quitterie-lcs commented Oct 31, 2022

View reviewed changes

tests/models/xapi/test_video.py Outdated Show resolved Hide resolved

quitterie-lcs force-pushed the add-edx-xapi-video-converter branch 4 times, most recently from 5e7154d to cdaa89b Compare November 2, 2022 16:02

quitterie-lcs force-pushed the add-edx-xapi-video-converter branch 3 times, most recently from 6f1bcce to 707af4b Compare November 15, 2022 08:45

SergioSim approved these changes Nov 15, 2022

View reviewed changes

Edx learning event modeling automation moved this from Review in progress to Reviewer approved Nov 15, 2022

quitterie-lcs added 3 commits November 17, 2022 10:54

✨(converter) add edx to xapi video converter

68858ed

edX video events can be converted to xAPI for most of them. The interaction events can still not be converted.

🚚(models) restructure tests files for edx models

ad29675

When statements and events fields have to be tested for the edx models, two separate files are created for statements and events fields tests respectively.

🚨(project) fix pylint warnings

2d94ecd

`unhashable-member` pylint warning has to be disabled for some parts of the code.

quitterie-lcs force-pushed the add-edx-xapi-video-converter branch from 75dca8d to 2d94ecd Compare November 17, 2022 09:54

quitterie-lcs merged commit 71c58f8 into master Nov 17, 2022

Edx learning event modeling automation moved this from Reviewer approved to Done Nov 17, 2022

quitterie-lcs deleted the add-edx-xapi-video-converter branch November 17, 2022 10:28

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

✨(converter) add edx to xapi video converter #211

✨(converter) add edx to xapi video converter #211

quitterie-lcs commented Sep 1, 2022 •

edited

SergioSim left a comment

quitterie-lcs commented Sep 5, 2022

SergioSim left a comment

SergioSim Oct 6, 2022

quitterie-lcs Oct 20, 2022

SergioSim Oct 20, 2022

quitterie-lcs Oct 21, 2022

SergioSim Oct 21, 2022

quitterie-lcs Oct 24, 2022 •

edited

SergioSim Oct 24, 2022

quitterie-lcs Oct 25, 2022

quitterie-lcs commented Nov 2, 2022

SergioSim left a comment

SergioSim Nov 15, 2022

quitterie-lcs commented Nov 16, 2022

SergioSim commented Nov 16, 2022

		length: Optional[float] = Field(alias=VIDEO_EXTENSION_LENGTH)
		playedSegments: Optional[str] = Field(alias=VIDEO_EXTENSION_PLAYED_SEGMENTS)

✨(converter) add edx to xapi video converter #211

✨(converter) add edx to xapi video converter #211

Conversation

quitterie-lcs commented Sep 1, 2022 • edited

Purpose

Proposal

SergioSim left a comment

Choose a reason for hiding this comment

quitterie-lcs commented Sep 5, 2022

SergioSim left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

quitterie-lcs Oct 24, 2022 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

quitterie-lcs commented Nov 2, 2022

SergioSim left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

quitterie-lcs commented Nov 16, 2022

SergioSim commented Nov 16, 2022

quitterie-lcs commented Sep 1, 2022 •

edited

quitterie-lcs Oct 24, 2022 •

edited