New: network connection test

[danielghost]

Fixes #268

New

• Added feature to test the network connection when transferring data to the LMS API.
• Raises an error if the connection is lost.

Further error handling can be utlised with adapt-contrib-trackingErrors.

[joe-replin]

This is great. The connection test is triggering appropriately in my LMS testing. While I have previously seen the data error in a live setting triggering appropriately, I'm not entirely sure how to appropriately test an initialization, data or termination error without triggering the events in the console.

Lastly, I am getting a slight warning in logger.js to change the four instances of 'str: str' to a simple 'str' shorthand.

adapt-contrib-spoor/js/scorm/logger.js

Line 24 in a1386ce

this.logArr[this.logArr.length] = { str: str, type: Logger.LOG_TYPE_INFO, time: Date.now() };

[joe-replin]

@danielghost, I also tested this by disabling adapt-contrib-trackingErrors. I haven't been given any indication that I do have a connection error even after attempting to adjust my level of logging. Am I to expect a console or alert message without it?

I understand that some LMSs (e.g. SCORM Cloud) do a good job of notifying users of a network issue via their own popups, so we aren't going to use this feature everywhere. But I suppose a console log would be sufficient for when adapt-contrib-trackingErrors is not attached to the framework.

[joe-replin]

I've committed schemas for the connection test feature. I'm not sure if we'll need the legacy schema anymore and this plug-in is currently not compatible with our legacy testing site. I'm also unable to test on a v1 testing site at the moment, but will test these as son as I have an instance available to use.

[joe-replin]

@danielghost, one more thing I discovered in testing is that the framework won't build unless "_connectionTest" is part of config. I think you just need to add a simple return check to see if it exists wherever the check is made.

[danielghost]

@joe-replin - please see comments below:

@danielghost, I also tested this by disabling adapt-contrib-trackingErrors. I haven't been given any indication that I do have a connection error even after attempting to adjust my level of logging. Am I to expect a console or alert message without it?

Good point. Have included this in 4dd09c5.

Lastly, I am getting a slight warning in logger.js to change the four instances of 'str: str' to a simple 'str' shorthand.

Not seeing this, but it shouldn't be linked to the connection test changes, so you may need to investigate this further and raise as a separate issue if it can be replicated.

@danielghost, one more thing I discovered in testing is that the framework won't build unless "_connectionTest" is part of config. I think you just need to add a simple return check to see if it exists wherever the check is made.

Not seeing this issue myself. If the config is missing it will use the defaults, otherwise it merges them together.

[joe-replin]

This looks great. :)

[oliverfoster]

See #273 for suggested amends

[github-actions]

🎉 This PR is included in version 5.6.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀