jmestxr / pe

0 stars 0 forks source link

Modifying the `ultron.json` file incorrectly will cause all data to disappear on subsequent launch of app #7

Open jmestxr opened 1 year ago

jmestxr commented 1 year ago

Advanced users might wish to modify the json file directly. However, if they do so such that the format of the json file is incorrect, all the data in json file will be deleted upon the next launch of the app:

Screenshot 2023-04-14 at 2.36.59 PM.png

This will be disastrous to advanced users who modified the json file wrongly (perhaps by accident or carelessness) as their data could not be retrieved back. This behavior of the app is not displayed as a warning in the UG.

I will put this as medium severity as this is only applicable for advanced users. However, within advanced users, it might not be a rare occurrence as it is easy to corrupt the json file in this way, especially due to carelessness.

nus-pe-script commented 1 year ago

Team's Response

We failed to warn users that the file should not be edited in the User Guide and that doing so could lead to a risk of losing data. However, this only applies to a very small amount of people, especially since most people would just use our app directly instead of directly editing the file.

Items for the Tester to Verify

:question: Issue type

Team chose [type.DocumentationBug] Originally [type.FunctionalityBug]

Reason for disagreement: The bug was reported during the first phase of the PE when I was testing the app against the instructions given in the UG. There was no warning of this behavior indicated in the UG and hence I reported this as a FunctionalityBug (and not a DocumentationBug) because this behavior is not specified and differs from normal expectations (as a user who has no knowledge on the workings of AB3).

Screenshot 2023-04-20 at 11.01.37 PM.png


## :question: Issue severity Team chose [`severity.Low`] Originally [`severity.Medium`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]