datavisyn/tdp_matomo

Matomo tracking for TDP applications using provenance commands

tdp_matomo's Issues

Anonymize user names

When using the LDAP plugin the user names are stored in plain text. Hence, the user names should be replaced by an anonymized IDs (e.g., the md5sum of the user name). However, please make sure that for a given user name the anonymized ID is always the same to allow to assess the total number of unique users.

Update requirements and dependencies

We should use the latest versions both for requirements and dependencies.
Except for Typescript, tslint and d3 dependencies, which will be updated in a separate step.

Migrate to Jest

We should migrate from Karma to Jest for testing due to compatibility issues.

After the update to Typescript 3.8, we can use the latest version.
For the usage of ts-jest it is important to use a pinned version without ^. The reason for that is that its Major version follows Jest, which means that minor changes can be breaking. See the docs.

Update to Typescript 3.8

Observed behavior

Updating the typescript and typedoc versions according to the snippet below without using stricter linting makes it possible to use the current typescript version with a minimum amount of errors.

"typedoc": "~0.16.9",
"typescript": "~3.8.1-rc",

Expected behavior

Updating the dependencies in the package.json and adding the following line of code in tsconfig.json (as well as fixing appearing type errors) should be sufficient for the usage of Typescript 3.8 as a first step.

"downlevelIteration": true, // required as long as target is `es5`

Update dependencies

See https://github.com/datavisyn/visyn2020/issues/3

We should update all dependencies to the latest accessible versions, except for:

• all webpack dependencies
• all test dependencies
• d3 and bootstrap

It might be necessary to update jQuery and React in a separate step as well.

Update requirements

See https://github.com/datavisyn/visyn2020/issues/9

We should update all requirements to the latest accessible versions.

Avoid active initialization for each app

The current approach requires an active initialization of the matomo tracking:

const trackableActions: ITrackableAction[] = [
  // id = phovea extension id
  {id: 'targidCreateView', event: {category:'view', action: 'create'}},
];
trackApp(app, trackableActions);

In addition the we duplicate the actionFunctions in the action.ts:

tdp_matomo/src/actions.ts

Lines 12 to 27 in 981f6df

	// from tdp_core\src\internal\cmds.ts
	trackableActions.set('tdpInitSession', {category:'session', action: 'init'});
	trackableActions.set('tdpSetParameter', {category:'view', action: 'setParameter'});
	// from tdp_core\src\lineup\internal\scorecmds.ts
	trackableActions.set('tdpAddScore', {category:'score', action: 'add'});
	trackableActions.set('tdpRemoveScore', {category:'score', action: 'remove'});
	// from tdp_core\src\lineup\internal\cmds.ts
	trackableActions.set('lineupSetRankingSortCriteria', {category:'lineup', action: 'setRankingSortCriteria'});
	trackableActions.set('lineupSetSortCriteria', {category:'lineup', action: 'setRankingSortCriteria'});
	trackableActions.set('lineupSetGroupCriteria', {category:'lineup', action: 'setGroupCriteria'});
	trackableActions.set('lineupAddRanking', {category:'lineup', action: 'addRanking'});
	trackableActions.set('lineupSetColumn', {category:'lineup', action: 'setColumn'});
	trackableActions.set('lineupAddColumn', {category:'lineup', action: 'addColumn'});
	trackableActions.set('lineupMoveColumn', {category:'lineup', action: 'moveColumn'});

A better approach would be to filter phovea extensions with id actionFunction. Only action functions that are annotated with the required name category and action will be tracked then.

Add json stringify to build id

Observed behaviour

• Build ID in webpack config causes errors if it is used without JSON.stringify()

Enable gif files

See https://github.com/datavisyn/visyn2020/issues/40

Summary

• enable gif files where necessary

Update Codeowner

The code owner of this repository has changed, therefore it is necessary to update the repo.