selenium icon indicating copy to clipboard operation
selenium copied to clipboard
verified publisher icon SeleniumHQ

[java]: fix decoding of line endings

Open Delta456 opened this issue 1 year ago • 2 comments

User description

Thanks for contributing to Selenium! A PR well described will help maintainers to quickly review and merge it

Before submitting your PR, please check our contributing guidelines. Avoid large PRs, help reviewers by making them as simple and short as possible.

Description

Fixes https://github.com/SeleniumHQ/selenium/issues/13207

Motivation and Context

It removes old code which changed the line endings from \r\n to \n because it is not needed anymore and also breaks encoding-decoding. @titusfortner said removing this shouldn't impact anything and this code is also useless because other bindings don't do it.

Types of changes

  • [ ] Bug fix (non-breaking change which fixes an issue)
  • [ ] New feature (non-breaking change which adds functionality)
  • [ ] Breaking change (fix or feature that would cause existing functionality to change)

Checklist

  • [x] I have read the contributing document.
  • [ ] My change requires a change to the documentation.
  • [ ] I have updated the documentation accordingly.
  • [] I have added tests to cover my changes.
  • [x] All new and existing tests passed.

PR Type

Bug fix

Description

  • Removed the code that changed line endings from \r\n to \n in the AbstractHttpResponseCodec class, as it was unnecessary and caused encoding-decoding issues.
  • Ensured that the response value is set directly without altering line endings, aligning with other bindings.

Changes walkthrough 📝

Relevant files
Bug fix
AbstractHttpResponseCodec.java
Remove unnecessary line ending normalization in response decoding

java/src/org/openqa/selenium/remote/codec/AbstractHttpResponseCodec.java

  • Removed code that normalized line endings from \r\n to \n.
  • Ensured that the response value is set without altering line endings.
    		•  +0/-6     

    💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information

    Delta456 avatar Sep 26 '24 07:09 Delta456

    PR Reviewer Guide 🔍

    ⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ Key issues to review

    Potential Compatibility Issue
    Removing line ending normalization might affect systems expecting normalized line endings. Ensure this change doesn't break existing functionality across different platforms.

    qodo-code-review[bot] avatar Sep 26 '24 07:09 qodo-code-review[bot]

    PR Code Suggestions ✨

    CategorySuggestion                                                                                                                                    Score
    Maintainability
    Add a comment to explain the removal of line ending normalization

    Consider adding a comment explaining why the line ending normalization was removed.
    This will help future maintainers understand the reasoning behind this change.

    java/src/org/openqa/selenium/remote/codec/AbstractHttpResponseCodec.java [105-107]

     if (!content.isEmpty()) {
+  // Line ending normalization removed to preserve original content
   response.setValue(content);
 }
    • [ ] Apply this suggestion
    Suggestion importance[1-10]: 7

    Why: Adding a comment to explain the removal of line ending normalization can improve maintainability by providing context for future developers, though it is not crucial for functionality.

    		7

    💡 Need additional feedback ? start a PR chat

    qodo-code-review[bot] avatar Sep 26 '24 07:09 qodo-code-review[bot]