-
-
Couldn't load subscription status.
- Fork 374
Fix: replace Array.map with for..of loop to comply with Sonar rule S2201 #2862
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Fix: replace Array.map with for..of loop to comply with Sonar rule S2201 #2862
Conversation
Reviewer's guide (collapsed on small PRs)Reviewer's GuideReplaced the use of Object.keys().map with a for..of loop in getSyncOperations to satisfy Sonar rule S2201, eliminate unused return values, and improve code clarity without altering functionality. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey there - I've reviewed your changes - here's some feedback:
- Consider using Object.entries on normalizedNewState to destructure key and value directly and avoid the extra property lookup.
- If there are other similar map-for-side-effects patterns in the codebase, consider refactoring them to maintain consistency.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Consider using Object.entries on normalizedNewState to destructure key and value directly and avoid the extra property lookup.
- If there are other similar map-for-side-effects patterns in the codebase, consider refactoring them to maintain consistency.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Summary of Changes
Hello @jayamrutiya, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request introduces a targeted refactoring to enhance code quality and maintainability within the async-storage-sync.ts file. It specifically addresses a SonarQube violation related to unused return values from Array.map by transitioning to a for..of loop for iterations that primarily involve side effects. This modification ensures compliance with coding standards and improves the expressiveness of the code without altering its functional behavior.
Highlights
- Sonar Rule S2201 Resolution: The pull request resolves Sonar rule S2201 ("Return values from functions should not be ignored") by replacing an
Object.keys(...).mapcall, where the return value was unused, with afor..ofloop. - Code Readability and Efficiency: The change improves code clarity by explicitly indicating side-effect-only iteration and avoids the creation of an unnecessary intermediate array that
mapwould produce.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in pull request comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request correctly replaces an Array.map call used for side-effects with a for..of loop, which improves code clarity, performance, and fixes a SonarQube issue. This is a good improvement. I've added one suggestion to further optimize the loop for memory efficiency by using for..in, which avoids creating an intermediate array of keys. Overall, this is a good, focused refactoring.
(Sonar S2201)
Fixes
Bug fix / Code quality improvement.
Replaced Object.keys(...).map with a for..of loop since the return value from map was unused.
This resolves Sonar rule S2201 ("Return values from functions should not be ignored") and
makes the iteration intent clearer while avoiding unnecessary array creation. No functional
changes were introduced.
Checks
yarn test-buildChanges proposed in this pull request:
What is the current behavior?
The code was using Object.keys(...).map to iterate over keys,
but the return value of map was not used. This triggered
SonarQube rule TypeScript:S2201 ("Return values from functions
should not be ignored").
What is the new behavior?
Replaced the .map() call with a for..of loop, since the iteration
was intended only for side effects (ops.push). This makes the
intention clearer, avoids unnecessary array creation, and resolves
the Sonar violation.
Why is this change needed?
Other information
No functional changes. Only a refactor to improve clarity and
maintainability.
Summary by Sourcery
Refactor side-effect iteration in async-storage-sync to use a for..of loop instead of Object.keys().map to comply with Sonar rule S2201 and improve code clarity
Bug Fixes:
Enhancements: