feat(analytics): add analytics and xapi-reporter #1196

JPSchellenberg · 2021-01-26T20:38:06Z

Hey,

I added a first draft of the analytics tool and the xapi reporter to the html export.
You can try everything by exporting a .html file, do the h5p, download the xapi-report as .lumi file and import the .lumi file in Lumi by using the Analytics tool.

…ture/repoter-client

sr258 · 2021-01-27T11:11:52Z

Build & starting it works on Windows. The idea seems to work!

A few remarks:

The header for the table should include the title of the (sub)content and the human readable-version of the content type name.
Clicking on the cards in the first page does nothing, you have to click on "start".
Just tried this video with it and the .lumi file is excessively large: it has 7,5 MBs! The reason seems to be that the base64 encoded resources are included; looks like some libraries include the params in the xAPI statement. We have to filter this out to make the files managable.
it's great that the "player" in the html file limits the width of the content - for some content types. But it should be customizable, as Drag & Drop, Interactive Video, Course Presentation and other content types shouldn't be limited in screen size.
What does the "Search" box search for? Students' names? This should be clearer
If you put report files of different H5Ps into the same directory, the results are unexpected
The main menu "File, Edit, etc." is still the one for the editor, even if the Analytics tool is open

JPSchellenberg · 2021-01-27T22:59:15Z

Ok, I fixed almost everything you mentioned, except the width. I will fix the e2e test tomorrow. Any other things that should be fixed?

sr258 · 2021-01-28T06:16:51Z

In Linux in the "import lumi report" file picker dialog I can't navigate into any subfolder. They are all grayed out and inaccessible.
the analytics tool scan all subfolders, which is difficult to understand at first, as it can result in errors if there are also .lumi files in the root folder
if the window is smaller, the text overflow in boxes is not dealt with gracefully:
the red color of low scores could be nicer
the student search should not care about case (if I enter "sebastian" it doesn't find "Sebastian") and should trim whitespace at the beginning and end
Hovering over a percentage could show the time the interaction was finished.
The analytics app window becomes completely blank when I open the file picker and abort it.
in the Reporter Client:
- there should be some padding in the content card
- pressing enter after entering your name should trigger the "ok"
if you open a report of a h5p that is not composed of others (e.g. Fill in the Blanks) you still see the ubername (H5P.Blank 1.12) instead of the human readable version and the title.

Sidenote:

We still need to publish the new version of @lumieducation/h5p-server: there are still incorrectly escaped characters in titles (')

JPSchellenberg · 2021-01-30T00:31:36Z

I fixed everything expect the design issues (red color, overflow, hovering over percentage) as I will have a designer have a look at it how to improve it.
What do you think about the functionality? Is it ready to be merged (or even released)?
I will update the h5p-library in a different PR.

sr258 · 2021-01-31T09:39:39Z

This issue still exists: In Linux in the "import lumi report" file picker dialog I can't navigate into any subfolder. They are all grayed out and inaccessible.

Maybe it's because of the fact the there is a selector "lumi report" which doesn't do anything?

JPSchellenberg · 2021-01-31T09:50:12Z

I guess it is due to the openDirectory setting in the OpenDialog from electron. Are there any .lumi files in the subfolder?

sr258 · 2021-01-31T12:07:53Z

Sometimes there are, but you still can‘t select them.

# [0.5.0](v0.4.0...v0.5.0) (2021-02-01) ### Bug Fixes * **analytics-import:** folder with dots in their name can be imported ([#1205](#1205)) ([7f4b999](7f4b999)) * **config:** broken/missing configs dealt with gracefully ([#1137](#1137)) ([729f997](729f997)) * **configuration:** config allows larger file sizes ([#1127](#1127)) ([5ef7523](5ef7523)) * **deps:** pin dependencies ([e87d68c](e87d68c)) * **deps:** update dependency @material-ui/core to v4.11.3 ([6875f02](6875f02)) * **deps:** update dependency @sentry/browser to v5.29.2 ([475c48a](475c48a)) * **deps:** update dependency @sentry/electron to v2.1.0 ([#1154](#1154)) ([260087c](260087c)) * **deps:** update dependency @sentry/electron to v2.2.0 ([1ab4ac1](1ab4ac1)) * **deps:** update dependency @testing-library/jest-dom to v5.11.8 ([eaa0cd8](eaa0cd8)) * **deps:** update dependency @testing-library/jest-dom to v5.11.9 ([#1155](#1155)) ([6510d76](6510d76)) * **deps:** update dependency @testing-library/react to v11.2.2 ([5a717cf](5a717cf)) * **deps:** update dependency @testing-library/react to v11.2.3 ([#1144](#1144)) ([227519b](227519b)) * **deps:** update dependency @testing-library/user-event to v12.6.0 ([0cf08f2](0cf08f2)) * **deps:** update dependency @testing-library/user-event to v12.6.1 ([982b227](982b227)) * **deps:** update dependency @testing-library/user-event to v12.6.2 ([d47d60a](d47d60a)) * **deps:** update dependency @types/jest to v26.0.19 ([54198bc](54198bc)) * **deps:** update dependency @types/jest to v26.0.20 ([#1140](#1140)) ([72b8776](72b8776)) * **deps:** update dependency @types/node to v12.19.11 ([8986fdb](8986fdb)) * **deps:** update dependency @types/node to v12.19.12 ([4b9f75c](4b9f75c)) * **deps:** update dependency @types/node to v12.19.13 ([#1156](#1156)) ([f155ddc](f155ddc)) * **deps:** update dependency @types/node to v12.19.14 ([#1175](#1175)) ([3a13e7e](3a13e7e)) * **deps:** update dependency @types/node to v12.19.15 ([dd999b5](dd999b5)) * **deps:** update dependency @types/react to v16.14.2 ([de82c3d](de82c3d)) * **deps:** update dependency @types/react to v17 ([#1108](#1108)) ([7151f05](7151f05)) * **deps:** update dependency @types/react-dom to v16.9.10 ([3943396](3943396)) * **deps:** update dependency @types/react-dom to v17 ([#1109](#1109)) ([eb583b9](eb583b9)) * **deps:** update dependency electron-log to v4.3.1 ([95edbe3](95edbe3)) * **deps:** update dependency express-fileupload to v1.2.1 ([#1153](#1153)) ([f37d962](f37d962)) * **deps:** update dependency fs-extra to v9.1.0 ([8c08202](8c08202)) * **deps:** update dependency h5p-nodejs-library to v6.1.3 ([f554fe9](f554fe9)) * **deps:** update dependency h5p-nodejs-library to v6.2.0 ([a15a7dc](a15a7dc)) * **deps:** update dependency i18next to v19.8.5 ([49a03ae](49a03ae)) * **deps:** update dependency i18next-fs-backend to v1.0.8 ([7111875](7111875)) * **deps:** update dependency nucleus-nodejs to v3.0.8 ([1866bd8](1866bd8)) * **deps:** update dependency react-scripts to v4.0.1 ([3f673fd](3f673fd)) * **deps:** update dependency socket.io to v2.4.1 ([#1141](#1141)) ([c3e7b8c](c3e7b8c)) * **deps:** update dependency typescript to v4.1.3 ([ed43a7d](ed43a7d)) * **deps:** update dependency web-vitals to v1 ([#1110](#1110)) ([94c154b](94c154b)) * **deps:** update dependency web-vitals to v1.1.0 ([ecbb6a0](ecbb6a0)) * **deps:** update h5p-react to v0.1.2 ([#1146](#1146)) ([5a0d450](5a0d450)) * **deps:** update h5p-server to v7.0.0-alpha.1 ([#1208](#1208)) ([2882b9e](2882b9e)) * **deps:** update mui monorepo to v4.11.2 ([e55078d](e55078d)) * **deps:** update sentry monorepo to v5.30.0 ([#1160](#1160)) ([654dcaa](654dcaa)) * **deps:** update socket.io packages to v2.4.0 ([0da5e88](0da5e88)) * **dev tools:** corrected dev tool setup ([#1126](#1126)) ([99c6695](99c6695)) * **devtools-start:** fix missing path on npm start ([#1133](#1133)) ([417c9b1](417c9b1)) * **editor:** localization files are found correctly ([#1171](#1171)) ([9480c2d](9480c2d)) * **error handling:** server deals more gracefully with invalid content ([#1174](#1174)) ([10010e1](10010e1)) * **multi instances:** old content isn't deleted on startup ([#1145](#1145)) ([8605612](8605612)) * **player:** content resizes with window ([#1142](#1142)) ([b50cd04](b50cd04)) * **saving:** last change is always saved now ([#1170](#1170)) ([9c2eb34](9c2eb34)) * **sentry:** deactivate sentry ([#1147](#1147)) ([866453c](866453c)) * **ui:** display a backbutton if not in launchpad ([#1209](#1209)) ([72c6bc1](72c6bc1)) * **windows:** config file created correctly on windows ([#1115](#1115)) ([f3113e0](f3113e0)) ### Features * **analytics:** add analytics and xapi-reporter ([#1196](#1196)) ([daa02d2](daa02d2)) * **gui:** overhaul save & export options ([#1134](#1134)) ([e01192e](e01192e)) * **htmlexport:** add HTML Export ([#1094](#1094)) ([a58b899](a58b899)), closes [#1091](#1091) * **notifications:** reenable notifications ([#1135](#1135)) ([1e95e3c](1e95e3c)) * **server:** in-memory cache speeds up editor load times ([#1125](#1125)) ([7e2a35b](7e2a35b)) * **ui:** re-added custom h5p styles ([#1138](#1138)) ([d4e8f34](d4e8f34))

github-actions · 2021-02-01T13:36:55Z

🎉 This PR is included in version 0.5.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

JPSchellenberg added 2 commits January 26, 2021 00:14

feat(analytics): add reporter and analytics

80e5e82

test(data): add test data

948dc5e

JPSchellenberg self-assigned this Jan 26, 2021

JPSchellenberg requested a review from sr258 January 26, 2021 20:38

JPSchellenberg added the [type] feature Changes that introduce a new feature (resulting in minor-version-bump) label Jan 26, 2021

JPSchellenberg added 7 commits January 26, 2021 21:52

Merge branch 'master' into feature/repoter-client

ef06ff5

test(h5proutes): increase timeout limit

6047830

ci(reporter): run npm ci for reporter-client

11b5f21

Merge remote-tracking branch 'origin/feature/repoter-client' into fea…

aec7015

…ture/repoter-client

ci(reporter): fix workflow

7b24f72

deps(reporter): update package-lock.json

fa1c951

ci(build-win): fix reporter build

5b63930

JPSchellenberg added 11 commits January 27, 2021 14:50

fix(htmlexport): add missing include-reporter-dialog

d9b6902

fix(launchpad): clicking on the card now opens the tool

b2961e1

fix(menu): display different menus for h5peditor and analytics

3d133b6

fix(analytics): use search for student names in placeholder

e7f8cda

fix(analytics): display title & content type in list

f603343

fix(reporter): remove files from report-files

7bf0814

feat(reporter): include timestamp in xAPI statements

16d9db6

fix(analytics): show an error when importing data from different content

a06ac9d

fix(client): add noreferrer to links

bbec68c

ci(reporter): build reporter-client

ff2cb19

ci(reporter): remove reporter unit-test

e67aa5e

JPSchellenberg marked this pull request as ready for review January 27, 2021 22:57

JPSchellenberg added 3 commits January 28, 2021 15:36

fix(analytics): make search case insensitive

854745c

fix(analytics): show human readable library name in non-composed content

c60d55b

fix(analytics): blackout window after canceling import

4078ec5

JPSchellenberg added 3 commits January 28, 2021 15:54

fix(reporter): add padding to content

7c31dd9

fix(reporter): handleSubmit when enter key is pressed

8b1b9f2

fix(analytics): allow file + multiple selection when importing analytic

4ff0215

JPSchellenberg added 2 commits January 30, 2021 01:49

Merge branch 'master' into feature/repoter-client

d87de16

chore(deps): update package lock

edcaef5

JPSchellenberg merged commit daa02d2 into master Jan 31, 2021

JPSchellenberg deleted the feature/repoter-client branch February 1, 2021 12:04

github-actions bot added the released label Feb 1, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(analytics): add analytics and xapi-reporter #1196

feat(analytics): add analytics and xapi-reporter #1196

JPSchellenberg commented Jan 26, 2021

sr258 commented Jan 27, 2021 •

edited

JPSchellenberg commented Jan 27, 2021

sr258 commented Jan 28, 2021

JPSchellenberg commented Jan 30, 2021 •

edited

sr258 commented Jan 31, 2021

JPSchellenberg commented Jan 31, 2021

sr258 commented Jan 31, 2021

github-actions bot commented Feb 1, 2021

feat(analytics): add analytics and xapi-reporter #1196

feat(analytics): add analytics and xapi-reporter #1196

Conversation

JPSchellenberg commented Jan 26, 2021

sr258 commented Jan 27, 2021 • edited

JPSchellenberg commented Jan 27, 2021

sr258 commented Jan 28, 2021

JPSchellenberg commented Jan 30, 2021 • edited

sr258 commented Jan 31, 2021

JPSchellenberg commented Jan 31, 2021

sr258 commented Jan 31, 2021

github-actions bot commented Feb 1, 2021

sr258 commented Jan 27, 2021 •

edited

JPSchellenberg commented Jan 30, 2021 •

edited