nus-se-script
commented
2 months ago Team's Response
Thank you for the bug report. We would like to preface that this bug report is unclear, as there is missing important information, such as the tester's installed Java version. Firstly, we would like to demonstrate the "happy scenario" if the user follows the UG step-by-step. This scenario would occur most of the time. Here is a video of Scenario 1: https://raw.githubusercontent.com/nus-cs2103-AY2324S2/pe/master/files/dd2264d1-df46-49a6-9457-ff4648c9224d.mp4
Secondly, we were able to reproduce the issue by installing an incorrect version of Java (e.g., Java 8). Here is a video of Scenario 2: https://raw.githubusercontent.com/nus-cs2103-AY2324S2/pe/master/files/cc539eab-e1f8-47da-8f7b-29a9d7eef1d3.mp4
We make a reasonable assumption that a vast majority of logistics managers are computer-literate and have basic computer knowledge. A common requirement for a logistics manager is to be able to be Proficient in standard logistics software. As demonstrated in Scenario 2, it is, in fact, harder to install a wrong version of Java (e.g., Java 8) using our UG instructions, as the Oracle page already defaults to showing Java 11. Thus, the probability of a user not following the UG's instructions and installing a wrong version of Java is low and can be considered a rare case. Hence, this issue only affects a minority of users.
Furthermore, as stated in the course website,
The software should work on a computer that has version 11 of Java i.e., no other Java version installed.
As demonstrated in Scenario 1, our application works when only Java 11 is installed (i.e., no other Java version installed).
On top of that, we have mentioned in our UG FAQ that AssetBook is not guaranteed to work on other versions of Java:
We recognize that there could be other scenarios such as one with file association issues, where the user is unable to launch the jar file by double clicking. However, this is an issue with the user's system, not our product. If the user had installed Java 11 correctly, as demonstrated in the first scenario, double-clicking works as expected.
We concur that a basic prerequisite for running AssetBook is having Java 11 installed properly (i.e., have jar files associated correctly). If a user does not have Jar files associated correctly, then Java 11 is not installed properly. In such cases, other Java 11 applications would also not work by double-clicking, not just AssetBook.
Finally, this is not a FunctionalityBug, but rather a DocumentationBug, as there is no problem with our application's functionality and it could be resolved by updating the UG.
Further justification for severity.Low:
As demonstrated in Scenario 1, as long as the user has Java 11 installed properly, the issue does not occur. Normal operations means that the user has only Java 11 installed, as stated in Constraint-Java-Version. We consider that having an incorrect Java version installed (e.g., Java 8) constitutes as abnormal operations.
Items for the Tester to Verify
:question: Issue type
Team chose [type.DocumentationBug]
Originally [type.FunctionalityBug]
- [x] I disagree
Reason for disagreement: The documentation is the instruction given despite having Java 11 installed properly. This is checked as we have been told to do the java -version check right before the PE.
This is also a common problem that can be found online and has nothing to do with improper installation of Java in my opinion and has also been mentioned in many online forums, requiring users to take multiple steps that does not necessarily mean that a reinstallation of Java 11 would help.
This should not be a documentation bug as the documentation clearly states that double clicking would work and redirect users to the FAQ if anything happens. But within the FAQ, there is no support for Windows, although for Linux users, it is stated that you can run through the command prompt.
However, the behavior still differs from the User Guide and should hence be a functionality bug rather than a documentation bug.
## :question: Issue severity Team chose [`severity.Low`] Originally [`severity.High`] - [x] I disagree **Reason for disagreement:** This should not be a minor inconvenience as many users have Java 11. This can potentially affect almost all Windows users given that this seems to be an issue with Windows when installing Java 11 (which even my teammate have to configure some Windows settings in order to run our own `.jar` file application by double clicking) and not being able to open the application as advertised as well as the lack of support for the platform (in the FAQ) would make it unusable unless they are familiar with Java and know that they can run the command through the CLI.
In the user guide, it is stated that it is possible to launch the application by double clicking. However, I get an exception when I try to launch it with a supported OS (Windows).
This screenshot pops up when I try to double click the Java file and selecting either Java(TM) Platform or OpenJDK binary throws me an exception.
Exception:
The FAQ section also does not explain what should be done if it does not work for Windows but for other operating systems. I think I do not have my registry set up properly to allow for
.jarfiles to be opened directly and is a setting that a user probably has to go through externally as I did not have it when I first installed Java.Perhaps you may want to include a guide or alternative launch options on the user guide for Windows as well?