Skip to content

[dotnet] Add back in a public parameterless constructor to HttpRequestData - #15258

Merged
RenderMichael merged 7 commits into
SeleniumHQ:trunkfrom
RenderMichael:http-request-data
Feb 9, 2025
Merged

[dotnet] Add back in a public parameterless constructor to HttpRequestData#15258
RenderMichael merged 7 commits into
SeleniumHQ:trunkfrom
RenderMichael:http-request-data

Conversation

@RenderMichael

@RenderMichael RenderMichael commented Feb 9, 2025 •
edited by qodo-code-review Bot
Loading

Copy link
Copy Markdown
Contributor

User description

…stData`

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.

Motivation and Context

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

  • Added a public parameterless constructor to HttpRequestData.

  • Updated RequestId property to allow null values.

Changes walkthrough 📝

Relevant files
Bug fix
HttpRequestData.cs
Add parameterless constructor and nullable `RequestId`     

dotnet/src/webdriver/HttpRequestData.cs

  • Added a public parameterless constructor initializing default values.
  • Changed RequestId property to nullable type.
    		• +11/-1   
    Need help?
  • Type /help how to ... in the comments thread for any questions about Qodo Merge usage.
  • Check out the documentation for more information.
    •

    @qodo-code-review

    qodo-code-review Bot commented Feb 9, 2025

    Copy link
    Copy Markdown
    Contributor

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    ⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ Recommended focus areas for review

    Null Reference

    The parameterless constructor initializes required properties with null values which could lead to NullReferenceException when these properties are accessed. Consider initializing with empty values instead.

    this.Method = null!;
this.Url = null!;
this.Headers = null!;

    @RenderMichael RenderMichael changed the title [dotnet] Add back in a public parameterless constructor to `HttpReque… [dotnet] Add back in a public parameterless constructor to HttpRequestData Feb 9, 2025
    @qodo-code-review

    qodo-code-review Bot commented Feb 9, 2025 •
    edited
    Loading

    Copy link
    Copy Markdown
    Contributor

    PR Code Suggestions ✨

    Explore these optional code suggestions:

    CategorySuggestion                                                                                                                                    Impact
    Possible issue
    ✅ Initialize collection to prevent nulls
    Suggestion Impact:The commit implements the suggestion by initializing Headers with a new Dictionary instance, but does it at the property level instead of in the constructor

    code diff:

    -        public Dictionary<string, string> Headers { get; set; }
+        public Dictionary<string, string> Headers { get; set; } = new Dictionary<string, string>();

    Initialize the Headers dictionary in the parameterless constructor to prevent
    NullReferenceException when adding headers.

    dotnet/src/webdriver/HttpRequestData.cs [34-39]

     public HttpRequestData()
 {
     this.Method = null!;
     this.Url = null!;
-    this.Headers = null!;
+    this.Headers = new Dictionary<string, string>();
 }
    • Apply this suggestion
    Suggestion importance[1-10]: 8

    __

    Why: Initializing Headers with null! could lead to NullReferenceException at runtime. Using a new Dictionary instance is a safer approach that prevents potential crashes.

    		Medium
    General
    ✅ Use meaningful defaults over nulls
    Suggestion Impact:The commit addresses the same issue but takes a different approach by making properties nullable and initializing Headers with default value

    code diff:

    -        public string Method { get; set; }
+        public string? Method { get; set; }
 
         /// <summary>
         /// Gets the URL of the HTTP request.
         /// </summary>
-        public string Url { get; set; }
+        public string? Url { get; set; }
 
         /// <summary>
         /// Gets the POST data of the HTTP request, if any.
@@ -73,7 +70,7 @@
         /// <summary>
         /// Gets the headers of the HTTP request.
         /// </summary>
-        public Dictionary<string, string> Headers { get; set; }
+        public Dictionary<string, string> Headers { get; set; } = new Dictionary<string, string>();

    Avoid using null-forgiving operator (!) for required properties. Instead,
    initialize with meaningful default values.

    dotnet/src/webdriver/HttpRequestData.cs [34-39]

     public HttpRequestData()
 {
-    this.Method = null!;
-    this.Url = null!;
-    this.Headers = null!;
+    this.Method = "GET";
+    this.Url = string.Empty;
+    this.Headers = new Dictionary<string, string>();
 }
    • Apply this suggestion
    Suggestion importance[1-10]: 7

    __

    Why: Using meaningful default values instead of null-forgiving operators improves code safety and clarity. The suggestion provides sensible defaults that better represent the initial state of an HTTP request.

    		Medium

    nvborisenko
    nvborisenko reviewed Feb 9, 2025
    View reviewed changes
    Comment thread dotnet/src/webdriver/DevTools/v130/V130Network.cs Outdated
    nvborisenko
    nvborisenko reviewed Feb 9, 2025
    View reviewed changes
    Comment thread dotnet/src/webdriver/NetworkRequestSentEventArgs.cs
    nvborisenko
    nvborisenko reviewed Feb 9, 2025
    View reviewed changes
    Comment thread dotnet/src/webdriver/HttpRequestData.cs Outdated
    RenderMichael
    RenderMichael commented Feb 9, 2025
    View reviewed changes
    Comment thread dotnet/src/webdriver/DevTools/v132/V132Network.cs Outdated
    RenderMichael
    RenderMichael commented Feb 9, 2025
    View reviewed changes
    Comment thread dotnet/src/webdriver/DevTools/v85/V85Network.cs Outdated
    RenderMichael
    RenderMichael commented Feb 9, 2025
    View reviewed changes
    Comment thread dotnet/src/webdriver/DevTools/v131/V131Network.cs Outdated
    RenderMichael and others added 2 commits February 9, 2025 15:08
    @RenderMichael @nvborisenko
    Apply suggestions from code review
    836ab74 
    Simplify null check

Co-authored-by: Nikolay Borisenko <22616990+nvborisenko@users.noreply.github.com>
    @RenderMichael
    Update dotnet/src/webdriver/HttpRequestData.cs
    e9efd68
    @RenderMichael
    RenderMichael merged commit d9093cc into SeleniumHQ:trunk Feb 9, 2025
    @RenderMichael
    RenderMichael deleted the http-request-data branch February 9, 2025 21:58
    sandeepsuryaprasad pushed a commit to sandeepsuryaprasad/selenium that referenced this pull request Mar 23, 2025
    @RenderMichael @nvborisenko @sandeepsuryaprasad
    [dotnet] Add back in a public parameterless constructor to `HttpReque…
    710304c 
    …stData` (SeleniumHQ#15258)

* [dotnet] Add back in a public parameterless constructor to `HttpRequestData`

* Improve nullability

* Make RequestId only settable internally

* Revert "Make RequestId only settable internally"

This reverts commit d0afea9.

* Handle nullability, make new constructor internal

* Apply suggestions from code review

Simplify null check

Co-authored-by: Nikolay Borisenko <22616990+nvborisenko@users.noreply.github.com>

* Update dotnet/src/webdriver/HttpRequestData.cs

---------

Co-authored-by: Nikolay Borisenko <22616990+nvborisenko@users.noreply.github.com>
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Reviewers

    @nvborisenko nvborisenko nvborisenko approved these changes

    Assignees

    No one assigned

    Labels

    Review effort [1-5]: 2

    Projects

    None yet

    Milestone

    No milestone

    Development

    Successfully merging this pull request may close these issues.

    2 participants

    @RenderMichael @nvborisenko