Reduced cylcomatic complexity from 4 to 2, made 3 new helper functions. #183
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
handleForbiddenApi - handles 403 API responses for authenticated users handleForbiddenPage - 403 page renders for unauthenticated users handleUnauthenticated - responses for unauthenticated users (API & redirect cases) Logic: - fires the plugin hooks - checks if headers already sent - determines if user authenticated - assigns current handler function
Author
|
nodebb log |
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.
handleForbiddenApi - handles 403 API responses for authenticated users
handleForbiddenPage - 403 page renders for unauthenticated users
handleUnauthenticated - responses for unauthenticated users (API & redirect cases)
Logic:
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: #175
Full path to the refactored file: src/controllers/helpers.js
What do you think this file does?
(Your answer does not have to be 100% correct; give a reasonable, evidence‑based guess.)
Handles errors (unauthorized or bad forms) and formatting
What is the scope of your refactoring within that file?
I refactored some of the authentication logic and forbidden page logic
I made 3 new functions - handleForbiddenApi, handleForbiddenPage, handleUnauthenticated
(Name specific functions/blocks/regions touched.)
Which Qlty‑reported issue did you address?
Function with high complexity (count = 14)
(Name the rule/metric and include the BEFORE value; e.g., “Cognitive Complexity 18 in render()”.)
2. Refactoring
How did the specific issue you chose impact the codebase’s maintainability?
It made it more understandable so people understand what happens in different cases.
What changes did you make to resolve the issue?
I got rid of the loops and used the variables of req to check if the user was authenticated, if the case was an API case.
How do your changes improve maintainability? Did you consider alternatives?
On our backend we can see what kind of errors users are running into.
3. Validation
How did you trigger the refactored code path from the UI?
Tried logging into an account that I didn't have access to
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.