Fixing complex binary statement #174
Open
+8
−4
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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 issue
Full path to the refactored file:
src/controllers/search.js:37
What do you think this file does?
(Your answer does not have to be 100% correct; give a reasonable, evidence‑based guess.)
Determines the information that can be searched through, depending on factors like who the user is, what their label is, etc.
What is the scope of your refactoring within that file?
(Name specific functions/blocks/regions touched.)
The beginning of the searchController function.
Which Qlty‑reported issue did you address?
(Name the rule/metric and include the BEFORE value; e.g., “Cognitive Complexity 18 in render()”.)
Complex binary expression
2. Refactoring
How did the specific issue you chose impact the codebase’s maintainability?
It made the code more readable and easier to debug.
What changes did you make to resolve the issue?
I broke up a large binary statement into smaller binary variables that were later combined in a concise equation.
How do your changes improve maintainability? Did you consider alternatives?
If specific parts of the previously large binary expression need to be changed, it can be done easily by changing the separated binary variables I made. This seemed like the best option, so I did not consider alternatives.
3. Validation
How did you trigger the refactored code path from the UI?
The code determines what type of information a user is able to search from, thus it isn't manually triggered, but is instead activated when the code is initially run (so that when the user tries to search, the program already knows what information to search from).
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.