hyxnnii / pe

0 stars 0 forks source link

Find command does return correct list when used with multiple whitespaces #10

Open hyxnnii opened 2 weeks ago

hyxnnii commented 2 weeks ago

Screenshot 2024-11-15 at 5.12.16 PM.png

After typing in "find n/amy lee" (with double whitespace) Screenshot 2024-11-15 at 5.12.37 PM.png

Expected: Amy Lee and amy lee should be returned. Actual: None returned. Problem: User may unintentionally add multiple white space. However, if none is returned, user would be misled into thinking that the name he/she is searching for does not exist.

soc-pe-bot commented 2 weeks ago

Team's Response

Thank you for bringing up this issue.

From the provided screenshots, we understand that the names given are Amy Lee and amy lee.

Running find n/ amy lee, find n/amy lee would return both Amy Lee and amy lee as per our team’s tests.

However, running find n/amy--lee with 2 whitespaces in between amy and lee (- indicates a whitespace since double whitespace is not allowed in GitHub issue) will not return any Udders because the search result is found by exact string matching which includes a whitespace character.

According to the bug report given, we understand that your expected output would be to produce both Amy Lee and amy lee as results even if there is double whitespace between the 2 words in the name.

Our team believes that this would lead to false positives in broader use cases. From a design POV, one solution would be to split the input given and search by words instead of exact string matching. Let’s take the example of finding someone with the name ang hui ling. Let’s also consider that the user was to search for ang--hui with 2 whitespaces between each of the words. Following this solution would lead to false positives such as returning ang ming hui ling when the user only intends to find ang hui ling. While there might be more search results, there would be more inaccurate search results that can confuse the user further. For the context and application of our app, this solution whereby ignoring whitespaces is not a good idea.

Another solution would be to shrink any cases where multiple whitespaces are used, to be considered as one whitespace. This would backfire in the scenario where the user purposefully used multiple whitespaces in a name, resulting in no results being returned when finding a certain name with multiple whitespaces.

For this purpose, we believe that exact string matching is the best case design that can be followed, and the onus to make a proper search would fall on the user. We agree that there might be a minor inconvenience to the user to check their input once again but this design solution is most likely to provide the most accurate search results for users as well. As such, due to further enhancements that may be needed to fix this bug and this would not be our priority at this stage, we would be marking this as response.NotInScope to work on it on future iterations.

Items for the Tester to Verify

:question: Issue response

Team chose [response.NotInScope]

Reason for disagreement: [replace this with your explanation]