zackjh / pe

0 stars 0 forks source link

Corrupted JSON data file is not handled properly #5

Open zackjh opened 1 week ago

zackjh commented 1 week ago

Description

In the DG, it is mentioned that if the JSON data file is corrupted, the app 'should show an error message and initialise with default data'.

However, after corrupting the JSON data file:

Screenshot of DG

dg-corrupted-data.png

Demo Video of Bug

I apologise for the low quality video - I had to re-export the screen recording in 480p because of file size limitations of CATcher.


video:https://raw.githubusercontent.com/zackjh/pe/main/files/f2cd481e-463a-4630-b7f9-3328ff55747c.mov

nus-se-script commented 1 week ago

Team's Response

image.png

Thank you for the report and the high effort video! There was certainly an issue in the DG that has resulted in this bug. However, it was a typo as seen from the warning in our UG that, if your changes to the data file makes its format invalid, Prudy will start with an empty data file at the next run.

As the app still works as intended and aligned with the UG, we have decided to classify this report as a DocumentationBug instead. Furthermore, as this issue will only pop up very rarely when users decide to edit the .json file despite warnings, we felt that a severity of Low is more appropriate.

Screenshot 2024-11-18 at 11.07.22 PM.png

Items for the Tester to Verify

:question: Issue type

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

Reason for disagreement: [replace this with your explanation]


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