Resolved function with high complexity#134
Open
Mridula-collab wants to merge 1 commit intoCMU-313:mainfrom
Open
Resolved function with high complexity#134Mridula-collab wants to merge 1 commit intoCMU-313:mainfrom
Mridula-collab wants to merge 1 commit intoCMU-313:mainfrom
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
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:
#111
Full path to the refactored file:
src/posts/bookmarks.js
What do you think this file does?
(Your answer does not have to be 100% correct; give a reasonable, evidence‑based guess.)
This file helps you bookmark and unbookmark the posts you have created.
What is the scope of your refactoring within that file?
(Name specific functions/blocks/regions touched.)
The refactoring is limited to the bookmark and unbookmark logic within this file. The function, toggleBookmark, was extracted into a new helper function which was moved outside the module.exports block to reduce complexity and improve reuse. The exported bookmark and unbookmark methods now simply call this helper, while Posts.hasBookmarked and all other code remain unchanged.
Which Qlty‑reported issue did you address?
Function with high complexity (count = 12): exports
2. Refactoring
How did the specific issue you chose impact the codebase’s maintainability?
The issue affected maintainability by concentrating too much logic and too many conditional branches inside the exported functions, which made the code harder to read and reason about. Having similar bookmark and unbookmark logic in exported methods also made it more difficult to debug issues, since any future change would need to carefully replicate it in multiple places.
What changes did you make to resolve the issue?
To resolve this, the shared bookmark and unbookmark logic was extracted into a single helper function, toggleBookmark, which was moved outside the module.exports block. This reduced the number of conditional branches inside exported functions and put all related logic in one place.
How do your changes improve maintainability? Did you consider alternatives?
These changes improve maintainability by reducing duplication. An alternative approach could have been to keep the logic inside the exported functions and try reorganizing the conditionals, but that would not have addressed the root problem of having duplicate code.
3. Validation
How did you trigger the refactored code path from the UI?
I triggered the refactored the code by creating a post and then bookmarking it.
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.