refactor: reduce expose function parameters #170
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:
#115
Full path to the refactored file:
src/middleware/index.js
What do you think this file does?
(Your answer does not have to be 100% correct; give a reasonable, evidence‑based guess.)
I believe this file connects the user with the server since I see a "middleware.ensureLoggedIn" function which refers to the user and "middleware.logApiUsage" which determines the number of tokens used.
What is the scope of your refactoring within that file?
(Name specific functions/blocks/regions touched.)
The scope of my refactoring was to reduce the number of parameters in the "function expose(options)", "middleware.exposeGroupName", and "middleware.exposeUid".
Which Qlty‑reported issue did you address?
(Name the rule/metric and include the BEFORE value; e.g., “Cognitive Complexity 18 in render()”.)
I addressed the issue <Function with many parameters (count = 6): expose>
2. Refactoring
How did the specific issue you chose impact the codebase’s maintainability?
I impacted the codebase's maintainability by reducing the number of parameters of the function which can make it clearer to understand how to call the function and how the expose function uses these variables.
What changes did you make to resolve the issue?
I turned the expose function's parameters in to a single object which contained all of the original parameters. The original function had (exposedField, method, field, req, res, next) and the refactored function had the options object parameter.
How do your changes improve maintainability? Did you consider alternatives?
With my changes, it is now easier to edit the expose function if we want to pass more values to the options object since we will now have to only edit the expose function and not go back to every other function that calls the expose function and change the number parameters.
3. Validation
How did you trigger the refactored code path from the UI?


I triggered the refactored code path from the UI by going to the navigation bar and clicking the groups tab and then the administrators tab to trigger the expose function which is triggered by the middleware.exposeGroupName function.
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.