Refactor src/search.js : reduced complexity through the use of helper functions that separated the function into more readable segments #168
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
P1B: Starter Task: Refactoring PR
Use this pull request template to briefly answer the questions below in one to two sentences each.
Feel free to delete this text at the top after filling out the template.
1. Issue
[Link to the associated GitHub issue:] - (#126)
Full path to the refactored file: - src/search.js
What do you think this file does? - I think that this file takes in the inputs from searches and posts that users make on NodeBB and sorts them and finds them based on what the user wants to search/ sort by.
What is the scope of your refactoring within that file? - specifically updated sortPosts with a high complexity issue, fixed the issue by adding a helper function that did the sorting for things that were not numeric in a separate helper function called sortStringHelper()
Which Qlty‑reported issue did you address? - Function with high complexity (count = 10): sortPosts
2. Refactoring
How did the specific issue you chose impact the codebase’s maintainability? - It was difficult to understand and read the code due to how many if else statement in on block there were without many indications of what each if else did
What changes did you make to resolve the issue? - added a helper function sortStringHelper so that the main function was separated and as such had lower complexity and easier to understand
How do your changes improve maintainability? Did you consider alternatives? - this change improves the maintainability becaue of the fact that the seperate helper function os labled and can lead to a better and easier understanding of what that portion f code is met to do additionally you can not test the helper separately to see if it works
3. Validation
How did you trigger the refactored code path from the UI?
Attach a screenshot of the logs and UI demonstrating the trigger.
(If you refactored a public/src/ file (front-end related file), watch logging via DevTools (Ctrl+Shift+I to open and then navigate to the 'Console' tab). If you refactored a src/ file, watch logging via ./nodebb log. Include the relevant UI view. Temporary logs should be removed before final commit.)
Attach a screenshot of
qlty smells --no-snippets <full/path/to/file.js>showing fewer reported issues after the changes.