Beneos Module: More readable error messages for users

BeneosBattlemaps commented 3 months ago

User often have issues with corrupted files. These files throw errors that stop the import process entirely. Reasons for that are:

bit errors during download
Corrupted files transferred via Wi-Fi
syntax errors on our side

Is there a way to:

A: Corrupted files do not STOP the import but gets skipped?
B: Once the import is done you get a report about all "corrupted/not importes/..." files that were skipped with a message to re-download said items.

That would make the import a way better user experience because we see this kind of error pretty often.

LeRatierBretonnien commented 3 months ago

There are already a lot of check and error catching in the code : do you have an example of what is corrupted exactly ? A JSON ? A webp image ?

BeneosBattlemaps commented 3 months ago

One of the main issues with users is, that they are doing errors. As we as creators also do. There are several different reasons for errors

Corrupted Files
Syntax Errors
missing files

At the moment: If one of thousands of files has an error, the compendium build stops and does not throw any errors on the frontend (Only console). For future reference and to help users faster on discord and increase user experience (and to identify issues made by us) I'd like to have additional "catches" for errors.

If any error occurs with one file, the import should not stop, but to skip the file
At the end of any import, if an error occured, a DM chat message should display the exact token (token folder name) that has thrown an error and (best case) what kind of error (Syntax Error, Missing jsons, not readable files (=corrupted due to formating/Transmission) errors

I know we made a lot in the past. But reports show our module and the entire building process is not hardened and prone to errors. For example, I copied the entire beneos_assets folder onto my laptop for the RPV con in germany and I was not able to build a compendium once due to an issues I could not find. It would have helped me A LOT if the import would not abort (Especially on The Forge where the import takes more than 5 Minutes - if it aborts the entire import after 5 Minutes because of a single issue it gets really frustrating).

Am Fr., 14. Juni 2024 um 20:38 Uhr schrieb LeRatierBretonnien < @.***>:

There are already a lot of check and error catching in the code : do you have an example of what is corrupted exactly ? A JSON ? A webp image ?

— Reply to this email directly, view it on GitHub https://github.com/BeneosBattlemaps/beneos-module/issues/148#issuecomment-2168565634, or unsubscribe https://github.com/notifications/unsubscribe-auth/AWMOCHIQUZLBETNPMGCYLKTZHM2BNAVCNFSM6AAAAABJKVWYBOVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDCNRYGU3DKNRTGQ . You are receiving this because you authored the thread.Message ID: @.***>

--

patreon.com/BeneosBattlemaps http://www.twitter.com/gameaholixtv patreon.com/BeneosTokensTokens http://patreon.com/BeneosTokens youtube.com/beneosbattlemaps https://www.youtube.com/channel/UCmrohObg7fLr1M9KqOWYLCQ https://twitter.com/beneos https://twitter.com/Beneos

Vertraulichkeitshinweis

Diese Nachricht und jeder uebermittelte Anhang beinhaltet vertrauliche Informationen und ist nur fuer die Personen oder das Unternehmen bestimmt, an welche sie tatsaechlich gerichtet ist. Sollten Sie nicht der Bestimmungsempfaenger sein, weisen wir Sie darauf hin, dass die Verbreitung, das (auch teilweise) Kopieren sowie der Gebrauch der empfangenen E-Mail und der darin enthaltenen Informationen gesetzlich verboten ist und gegebenenfalls Schadensersatzpflichten ausloesen kann. Sollten Sie diese Nachricht aufgrund eines Uebermittlungsfehlers erhalten haben, bitten wir Sie, den Sender unverzueglich hiervon in Kenntnis zu setzen.

*Sicherheitswarnung: *Bitte beachten Sie, dass das Internet kein sicheres Kommunikationsmedium ist. Obwohl wir im Rahmen unseres Qualitaetsmanagements und der gebotenen Sorgfalt Schritte eingeleitet haben, um einen Computervirenbefall weitestgehend zu verhindern, koennen wir wegen der Natur des Internet das Risiko eines Computervirenbefalls dieser E-Mail nicht ausschliessen.

Confidentiality note This message (including any attachments) contains confidential information intended for a specific individual or entity as the intended recipient. If you are not the intended recipient, you are hereby notified that any distribution, any copying of this message in part or in whole, or any taking of action based on it, is strictly prohibited by law and may cause liability. In case you have received this message due to an error in transmission, we ask you to notify the sender immediately.

Safety warning: Please note that the Internet is not a safe means of communication or form of media. Although we are continuously increasing our due care of preventing virus attacks as a part of our Quality Management, we are not able to fully prevent virus attacks as a result of the nature of the Internet.

LeRatierBretonnien commented 3 months ago

I understand, but maybe I was not clear : there are already a good amount of checks during import that DO NOT cause break on importing errors. So my point is : what are the exact case that are causing the issues ? I need more real use case/errors in order to understand what is going on.

Meanwhile, I added a few additional checks, and also a status chat message about what has went wrong during the import. Available in the repo.

BeneosBattlemaps commented 3 months ago

I have no concrete error at hand. But it would already be a great help if the import would not stop but SKIP the token, throwing any error (not a warning) and posting what token (foldername or array entry) caused the error so the user can redownload it (99% of the time the download is corrupted leading to issues during import (it looks like even the slightest off-bit could cause issues based on the amount of reports all the time).

Most of the times (as said) the errors are: Syntax errors (wrong brackets, or missing/additional ' or (or ' instead of ") corrupted files (unable to read ....) Missing files (unable to fetch config .... ) <- I know this is just a warning, not an actual error stoping the import.

Am Sa., 15. Juni 2024 um 14:25 Uhr schrieb LeRatierBretonnien < @.***>:

I understand, but maybe I was not clear : there are already a good amount of checks during import that DO NOT cause break on importing errors. So my point is : what are the exact case that are causing the issues ? I need more real use case/errors in order to understand what is going on.

Meanwhile, I added a few additional checks, and also a status chat message about what has went wrong during the import. Available in the repo.

— Reply to this email directly, view it on GitHub https://github.com/BeneosBattlemaps/beneos-module/issues/148#issuecomment-2169459522, or unsubscribe https://github.com/notifications/unsubscribe-auth/AWMOCHL7623YEXQE7F5PQATZHQXDPAVCNFSM6AAAAABJKVWYBOVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDCNRZGQ2TSNJSGI . You are receiving this because you authored the thread.Message ID: @.***>

--

patreon.com/BeneosBattlemaps http://www.twitter.com/gameaholixtv patreon.com/BeneosTokensTokens http://patreon.com/BeneosTokens youtube.com/beneosbattlemaps https://www.youtube.com/channel/UCmrohObg7fLr1M9KqOWYLCQ https://twitter.com/beneos https://twitter.com/Beneos

Vertraulichkeitshinweis

Diese Nachricht und jeder uebermittelte Anhang beinhaltet vertrauliche Informationen und ist nur fuer die Personen oder das Unternehmen bestimmt, an welche sie tatsaechlich gerichtet ist. Sollten Sie nicht der Bestimmungsempfaenger sein, weisen wir Sie darauf hin, dass die Verbreitung, das (auch teilweise) Kopieren sowie der Gebrauch der empfangenen E-Mail und der darin enthaltenen Informationen gesetzlich verboten ist und gegebenenfalls Schadensersatzpflichten ausloesen kann. Sollten Sie diese Nachricht aufgrund eines Uebermittlungsfehlers erhalten haben, bitten wir Sie, den Sender unverzueglich hiervon in Kenntnis zu setzen.

*Sicherheitswarnung: *Bitte beachten Sie, dass das Internet kein sicheres Kommunikationsmedium ist. Obwohl wir im Rahmen unseres Qualitaetsmanagements und der gebotenen Sorgfalt Schritte eingeleitet haben, um einen Computervirenbefall weitestgehend zu verhindern, koennen wir wegen der Natur des Internet das Risiko eines Computervirenbefalls dieser E-Mail nicht ausschliessen.

Confidentiality note This message (including any attachments) contains confidential information intended for a specific individual or entity as the intended recipient. If you are not the intended recipient, you are hereby notified that any distribution, any copying of this message in part or in whole, or any taking of action based on it, is strictly prohibited by law and may cause liability. In case you have received this message due to an error in transmission, we ask you to notify the sender immediately.

Safety warning: Please note that the Internet is not a safe means of communication or form of media. Although we are continuously increasing our due care of preventing virus attacks as a part of our Quality Management, we are not able to fully prevent virus attacks as a result of the nature of the Internet.

LeRatierBretonnien commented 2 months ago

OK, so you can test and distribute the latest commits in the beneos_module. I added additionnal v12 fixes for warnings, as well as additional checks for corrupted JSON data. Each check does not break the rest of the import process, so if errors still occur, I will really need real failure examples to understand the issue.

LeRatierBretonnien commented 1 month ago

Can be closed I guess

BeneosBattlemaps / beneos-module

Beneos Module: More readable error messages for users #148