Skip to content

Conversation

@josegerm
Copy link

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.

You are not permitted to use generative AI services (e.g., ChatGPT) to compose the answers.
Any such use will be treated as a violation of academic integrity.

1. Issue

Link to the associated GitHub issue:
#141

Full path to the refactored file:
src/controllers/user.js

What do you think this file does?
(Your answer does not have to be 100% correct; give a reasonable, evidence‑based guess.)
I think this file controls user operations and sends data from the database to the client as its in the src/controllers folder and has functions like userController.getUserByUID, userController.getUserByUsername, and userController.getUserByEmail.

What is the scope of your refactoring within that file?
(Name specific functions/blocks/regions touched.)
I changed byType, userController.getUserByUID, userController.getUserByUsername, and userController.getUserByEmail.

Which Qlty‑reported issue did you address?
(Name the rule/metric and include the BEFORE value; e.g., “Cognitive Complexity 18 in render()”.)
Function with many parameters (count = 4): byType

2. Refactoring

How did the specific issue you chose impact the codebase’s maintainability?
Because of byType's four parameters, all the wrapper functions had to keep forwarding (req, res, next) to byType, which was very repetitive and made the functions harder to read.

What changes did you make to resolve the issue?
I made byType a function that only takes in a single type as a parameter and then return a function that also handles the request for (req, res, next) internally. Then I just edited the wrapper functions to use the one parameter.

How do your changes improve maintainability? Did you consider alternatives?
My changes make the code easier to read by reducing the repetitive code. I considered making the four parameters into a tuple instead, but that would still leave the repetitive code, so I opted for my solution instead.

3. Validation

How did you trigger the refactored code path from the UI?
I inserted "console.log('Jose German'); into my byType function and as soon as I started my instance of node bb it triggered.

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.)
logproof
UIProof

Attach a screenshot of qlty smells --no-snippets <full/path/to/file.js> showing fewer reported issues after the changes.
smellproof

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant