Skip to content

[java] remove toml parser warning#14711

Merged
pujagani merged 2 commits intoSeleniumHQ:trunkfrom
Delta456:remove_warning
Nov 5, 2024
Merged

[java] remove toml parser warning#14711
pujagani merged 2 commits intoSeleniumHQ:trunkfrom
Delta456:remove_warning

Conversation

@Delta456
Copy link
Copy Markdown
Member

@Delta456 Delta456 commented Nov 4, 2024 •
edited by qodo-code-review Bot
Loading

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

Remove TOML warning for the upcoming TOML parser change in #14470

Motivation and Context

Remove warning because as said We can add a warning with the current code base about the upcoming change, and maybe merge this PR after 2 versions so the end users get a chance to update the TOML. as said in #14470 (comment)

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

  • 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.
  • All new and existing tests passed.

PR Type

Bug fix

Description

  • Removed the warning message about the upcoming TOML parser change that required quoted strings, as it is no longer necessary.
  • Eliminated the logger import and instance since the warning message was the only usage.

Changes walkthrough 📝

Relevant files
Bug fix
TomlConfig.java
Remove TOML parser warning and logger                                       

java/src/org/openqa/selenium/grid/config/TomlConfig.java

  • Removed the logger import and instance.
  • Deleted the warning message regarding TOML parser changes.
    		•  +0/-5     

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

    @qodo-code-review
    Copy link
    Copy Markdown
    Contributor

    qodo-code-review Bot commented Nov 4, 2024

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    ⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ No major issues detected

    @qodo-code-review
    Copy link
    Copy Markdown
    Contributor

    qodo-code-review Bot commented Nov 4, 2024

    PR Code Suggestions ✨

    Explore these optional code suggestions:

    CategorySuggestion                                                                                                                                    Score
    Enhancement
    Implement custom validation for unquoted strings to maintain previous warning functionality

    Consider adding a custom validation method to check for unquoted strings in the TOML
    content, to maintain the previous warning functionality without using a logger.

    java/src/org/openqa/selenium/grid/config/TomlConfig.java [40-46]

     public TomlConfig(Reader reader) {
   try {
     toml = JToml.parse(reader);
+    validateQuotedStrings(reader);
   } catch (IOException e) {
     throw new ConfigException("Unable to read TOML.", e);
   } catch (ParseException e) {
     throw new ConfigException(
    • Apply this suggestion
    Suggestion importance[1-10]: 7

    Why: This suggestion provides a more proactive approach to maintaining the functionality of the removed warning. Implementing custom validation for unquoted strings helps ensure code quality and prepares for future TOML parser changes, making it a valuable enhancement.

    		7
    Maintainability
    Add a reminder for future TOML parser changes to maintain awareness of potential issues

    Consider adding a deprecation notice or TODO comment to remind developers about the
    upcoming change in TOML parser behavior regarding unquoted strings.

    java/src/org/openqa/selenium/grid/config/TomlConfig.java [40-46]

     public TomlConfig(Reader reader) {
   try {
     toml = JToml.parse(reader);
+    // TODO: Add validation for unquoted strings once new TOML parser is implemented
   } catch (IOException e) {
     throw new ConfigException("Unable to read TOML.", e);
   } catch (ParseException e) {
     throw new ConfigException(
    • Apply this suggestion
    Suggestion importance[1-10]: 5

    Why: The suggestion is relevant as it addresses the removed warning about future TOML parser changes. Adding a TODO comment maintains awareness of the issue without using the removed logger, which is moderately useful for future maintenance.

    		5

    💡 Need additional feedback ? start a PR chat

    @VietND96 VietND96 added the B-grid Everything grid and server related label Nov 5, 2024
    @Delta456 Delta456 mentioned this pull request Nov 5, 2024
    Merged
    8 tasks
    @pujagani pujagani merged commit 4d1752b into SeleniumHQ:trunk Nov 5, 2024
    @Delta456 Delta456 deleted the remove_warning branch November 6, 2024 10:30
    @dependabot dependabot Bot mentioned this pull request Sep 18, 2025
    Merged
    @dependabot dependabot Bot mentioned this pull request Oct 1, 2025
    Closed
    @dependabot dependabot Bot mentioned this pull request Oct 24, 2025
    Closed
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Reviewers

    No reviews

    Assignees

    No one assigned

    Labels

    B-grid Everything grid and server related Review effort [1-5]: 1

    Projects

    None yet

    Milestone

    No milestone

    Development

    Successfully merging this pull request may close these issues.

    3 participants

    @Delta456 @pujagani @VietND96