Skip to content

Comments

Sanitize ServletContextPath on JSON read#2498

Merged
ihrasko merged 1 commit intoPANTHEONtech:mainfrom
PeterSuna:mainRemoveSlashFromContextPath
Dec 17, 2025
Merged

Sanitize ServletContextPath on JSON read#2498
ihrasko merged 1 commit intoPANTHEONtech:mainfrom
PeterSuna:mainRemoveSlashFromContextPath

Conversation

@PeterSuna
Copy link
Contributor

Updating the restconf path in the getter method may cause incorrect behavior in the equals() and hashCode() methods.

Move this logic into the ConfigUtils classes to fix this while reading the JSON configuration with Jackson.

JIRA: LIGHTY-333

@gemini-code-assist
Copy link

Summary of Changes

Hello @PeterSuna, 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 addresses a potential issue where the restconfServletContextPath configuration property, if containing a leading slash, could lead to incorrect behavior in object comparison methods. The change centralizes the logic for sanitizing this path by moving it into the ConfigUtils classes, where it is applied during JSON deserialization. This ensures that the internal representation of the path is consistently stored without a leading slash, thereby enhancing the robustness and predictability of configuration handling across the application.

Highlights

  • Centralized Path Sanitization: The logic for removing leading slashes from the restconfServletContextPath has been moved from getter methods in configuration classes to dedicated utility methods within the ConfigUtils classes.
  • Improved Configuration Consistency: Sanitization of the restconfServletContextPath now occurs during JSON deserialization, ensuring that the internal field always stores the path without a leading slash. This prevents potential inconsistencies that could affect equals() and hashCode() methods.
  • Refactored Getters: The getRestconfServletContextPath() methods in RestConfConfiguration and NettyRestConfConfiguration have been simplified to directly return the stored path, as the sanitization is now handled earlier in the configuration loading process.
  • New Utility Method: A private static removeSlashFromContextPath utility method has been introduced in both RestConfConfigUtils and NettyRestConfUtils to perform the leading slash removal on the JSON node during configuration parsing.
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

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

Copy link

@gemini-code-assist gemini-code-assist bot left a 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 moves the sanitization logic for restconfServletContextPath from the getter into the configuration reading utility classes. This resolves an issue where equals() and hashCode() could behave incorrectly. The changes are applied consistently across both restconf-nb-community and restconf-netty-nb-community modules. I've found a potential null pointer exception in the new sanitization logic and some code duplication that could be addressed to improve maintainability. Overall, a good improvement.

@PeterSuna PeterSuna force-pushed the mainRemoveSlashFromContextPath branch from 0dd2003 to 3dd4df8 Compare December 17, 2025 13:20
@PeterSuna PeterSuna closed this Dec 17, 2025
@PeterSuna PeterSuna reopened this Dec 17, 2025
@PeterSuna PeterSuna requested a review from ihrasko December 17, 2025 15:28
Updating the restconf path in the getter method may cause
incorrect behavior in the equals() and hashCode() methods.

Move this logic into the ConfigUtils classes to fix this while
reading the JSON configuration with Jackson.

JIRA: LIGHTY-333
Signed-off-by: Peter Suna <[email protected]>
@PeterSuna PeterSuna force-pushed the mainRemoveSlashFromContextPath branch from 3dd4df8 to d9b0b15 Compare December 17, 2025 15:32
@ihrasko ihrasko merged commit 2da7c0b into PANTHEONtech:main Dec 17, 2025
5 of 6 checks passed
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.

2 participants