imotionsApi v2.9.0 - major update of how AOI metrics are stored/computed in online to try to fasten the process.

[agrappe]

Feature additions:

• Renaming all functions containing "AOI" to follow a better convention (ie. getAOIs becomes getAois).

• Addition of some caching inside privateAoiFormatting() so AOIs for an online study only get retrieved once (there is only one endpoint at the study level so the result will always be the same).

• Addition of an optional localPath parameter to imConnection() to allow us to save metrics and downloaded signals for online locally (if provided)

• Updating uploadAoiMetrics() to work with online at a respondent level and write back metrics locally. Also creating some new functions (privateUploadAoiMetrics(), privateUploadAoiMetrics.imRespondent() and privateUploadAoiMetrics.imSegment()) to improve the workflow.

• Updating privateDownloadData() to not delete local files in case a localPath was added. These files will be removed at the end of the whole processing (ie when all respondents/stimuli have been processed).

• Updating getAoiRespondentMetrics() to work with online and retrieve the newly stored metrics using uploadAoiMetrics().

• Updating getFile() to store and retrieve local downloaded signals in case a localPath was added.

Bug fixes:

• Fixing a small issue inside privateAoiFormatting() with the new AOIs from online (with respondent timeline) that were filtered out by mistake.

• Fixing a small issue inside privateGetAoiDetails and privateAoiFiltering.imRespondent() where broken in/out data would make the functions crash. Also changing the order of the filtering inside privateAoiFiltering.imRespondent() so we do not make unneeded calls to privateGetAoiDetails().

[github-actions]

Test Results

    1 files  ±  0     56 suites  +1   10s ⏱️ -1s
  198 tests +  8    198 ✅ +  8  0 💤 ±0  0 ❌ ±0 
2 041 runs  +160  2 041 ✅ +160  0 💤 ±0  0 ❌ ±0 

Results for commit ff11986. ± Comparison against base commit 9b23a92.

This pull request removes 52 and adds 60 tests. Note that renamed tests count towards both.

getAOIRespondentData_ ‑ _unnamed_
getAOIRespondentData_ ‑ error_arguments_are_missing_or_not_from_the_good_class
getAOIRespondentData_ ‑ local_check_work_if_no_AOI_exposure
getAOIRespondentData_ ‑ local_check_work_if_no_gazes_or_mouse_click_in
getAOIRespondentData_ ‑ local_return_inOutGaze_for_a_specific_AOI_respondent_pair
getAOIRespondentData_ ‑ local_return_inOutMouse_for_a_specific_AOI_respondent_pair
getAOIRespondentData_ ‑ local_return_intervals_for_a_specific_AOI_respondent_pair
getAOIRespondentData_ ‑ remote_return_inOutGaze_for_a_specific_AOI_respondent_pair
getAOIRespondentData_ ‑ remote_return_inOutMouse_for_a_specific_AOI_respondent_pair
getAOIRespondentData_ ‑ remote_return_intervals_for_a_specific_AOI_respondent_pair
…

getAoiRespondentData_ ‑ _unnamed_
getAoiRespondentData_ ‑ error_arguments_are_missing_or_not_from_the_good_class
getAoiRespondentData_ ‑ local_check_work_if_no_AOI_exposure
getAoiRespondentData_ ‑ local_check_work_if_no_gazes_or_mouse_click_in
getAoiRespondentData_ ‑ local_return_inOutGaze_for_a_specific_AOI_respondent_pair
getAoiRespondentData_ ‑ local_return_inOutMouse_for_a_specific_AOI_respondent_pair
getAoiRespondentData_ ‑ local_return_intervals_for_a_specific_AOI_respondent_pair
getAoiRespondentData_ ‑ remote_return_inOutGaze_for_a_specific_AOI_respondent_pair
getAoiRespondentData_ ‑ remote_return_inOutMouse_for_a_specific_AOI_respondent_pair
getAoiRespondentData_ ‑ remote_return_intervals_for_a_specific_AOI_respondent_pair
…

♻️ This comment has been updated with latest results.