Skip to content

Conversation

@alexbock2
Copy link

@alexbock2 alexbock2 commented Jan 24, 2026

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:
#176

Full path to the refactored file:
src/user/index.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 seems to handle user information (getting users and usernames by email/uids/from set etc).

What is the scope of your refactoring within that file?
(Name specific functions/blocks/regions touched.)
I changed the function User.getUsersFromSet. I changed the parameters from set,uid, start, stop to {set,uid, start, stop}

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): getUsersFromSet

2. Refactoring

How did the specific issue you chose impact the codebase’s maintainability?
Having 4 parameters runs the risk of the coder accidentally putting the wrong values if they forgot the correct order. It makes the codebase harder to maintain or update since every call to the function needs to meet the parameters.

What changes did you make to resolve the issue?
I put all 4 of the variables into one parameter object {set, uid, start, stop}

How do your changes improve maintainability? Did you consider alternatives?
Now when the function is called, the four variables can be in any order inside the single parameter, making it much easier to read and use. I did not consider alternatives.

3. Validation

How did you trigger the refactored code path from the UI?
I went to Home / Groups and clicked on Administrators and Global Moderators which printing out my name in the console log.

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

Screenshot 2026-01-23 at 11 34 17 PM

Screenshot 2026-01-23 at 10 56 40 PM

Attach a screenshot of qlty smells --no-snippets <full/path/to/file.js> showing fewer reported issues after the changes.
Screenshot 2026-01-23 at 11 35 26 PM

@alexbock2 alexbock2 closed this Jan 24, 2026
@alexbock2 alexbock2 reopened this Jan 24, 2026
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