Skip to content

BugFix - 39422 - Implement By Pass Proxy For Playwright#3819

Merged
Maheshkale447 merged 3 commits into
Releases/Official-Releasefrom
BugFix/39422-ImplementByPassProxyForPlaywright
Jul 10, 2024
Merged

BugFix - 39422 - Implement By Pass Proxy For Playwright#3819
Maheshkale447 merged 3 commits into
Releases/Official-Releasefrom
BugFix/39422-ImplementByPassProxyForPlaywright

Conversation

@IamHarsimranjeet

@IamHarsimranjeet IamHarsimranjeet commented Jul 9, 2024

Copy link
Copy Markdown
Contributor

Thank you for your contribution.
Before submitting this PR, please make sure:

  • PR description and commit message should describe the changes done in this PR
  • Verify the PR is pointing to correct branch i.e. Release or Beta branch if the code fix is for specific release , else point it to master
  • Latest Code from master or specific release branch is merged to your branch
  • No unwanted\commented\junk code is included
  • No new warning upon build solution
  • Code Summary\Comments are added to my code which explains what my code is doing
  • Existing unit test cases are passed
  • New Unit tests are added for your development
  • Sanity Tests are successfully executed for New and Existing Functionality
  • Verify that changes are compatible with all relevant browsers and platforms.
  • After creating pull request there should not be any conflicts
  • Resolve all Codacy comments
  • Builds and checks are passed before PR is sent for review
  • Resolve code review comments
  • Update the Help Library document to match any feature changes

Summary by CodeRabbit

  • New Features

    • Added proxy configuration capabilities, allowing users to set proxy server information and bypass proxy URLs.
    • Introduced headless browser mode for background browser operations.
  • Changes

    • Updated Playwright driver to conditionally set proxy bypass options.
    • Modified Selenium driver by removing the ByPassProxy property and adding ProxyAutoConfigUrl for enhanced proxy settings.

@coderabbitai

coderabbitai Bot commented Jul 9, 2024

Copy link
Copy Markdown
Contributor

Walkthrough

The recent updates include the addition of proxy settings and a headless mode to the GingerWebDriver class, conditional proxy configuration in the PlaywrightDriver, and a reconfiguration of proxy settings in the SeleniumDriver. These enhancements aim to improve flexibility and control over web drivers within the GingerCoreNET framework.

Changes

Files Change Summary
Ginger/…/GingerWebDriver.cs Added Proxy, ByPassProxy, and HeadlessBrowserMode properties to GingerWebDriver.
Ginger/…/Playwright/PlaywrightDriver.cs Updated BuildPlaywrightBrowserOptions method to conditionally set options.Proxy.Bypass based on ByPassProxy string value.
Ginger/…/Selenium/SeleniumDriver.cs Removed ByPassProxy property and added ProxyAutoConfigUrl property, modifying the proxy configuration approach in the SeleniumDriver class.

Poem

In the land of code where drivers dwell,
New features rise, a tale to tell.
Proxies to set, headless to roam,
In Ginger's heart, they find their home.
Selenium too, a tweak, a tune,
Web adventures beneath the moon.
🐇✨


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 547af21 and 3a39e88.

Files selected for processing (4)
  • Ginger/Ginger/Agents/AgentDriverConfigPage.xaml.cs (1 hunks)
  • Ginger/GingerCoreNET/Drivers/CoreDrivers/Web/GingerWebDriver.cs (1 hunks)
  • Ginger/GingerCoreNET/Drivers/CoreDrivers/Web/Playwright/PlaywrightDriver.cs (1 hunks)
  • Ginger/GingerCoreNET/Drivers/CoreDrivers/Web/Selenium/SeleniumDriver.cs (1 hunks)
Files skipped from review due to trivial changes (1)
  • Ginger/Ginger/Agents/AgentDriverConfigPage.xaml.cs
Additional comments not posted (2)
Ginger/GingerCoreNET/Drivers/CoreDrivers/Web/Selenium/SeleniumDriver.cs (2)

Line range hint 1-1:
Verify the necessity of the Proxy property.

The Proxy property is defined but not annotated with [UserConfigured] or [UserConfiguredDescription], unlike the ProxyAutoConfigUrl property. Ensure that this property is necessary and consider adding appropriate annotations if it is user-configurable.


Line range hint 4-6:
LGTM! Ensure usage consistency.

The ProxyAutoConfigUrl property is correctly annotated with [UserConfigured] and [UserConfiguredDescription]. Ensure that this property is consistently used throughout the codebase and properly initialized.

Comment on lines +52 to +56

[UserConfigured]
[UserConfiguredDefault("http://127.0.0.1;http://localhost;")]
[UserConfiguredDescription("Set multiple By Pass Proxy URLs separated with ';'|| By Pass Proxy works only when Proxy URL is mentioned")]
public string ByPassProxy { get; set; }

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add nullability annotations and validation for ByPassProxy.

The ByPassProxy property is missing nullability annotations and validation. To ensure robustness, consider adding nullability annotations and validating the property.

[UserConfigured]
[UserConfiguredDefault("http://127.0.0.1;http://localhost;")]
[UserConfiguredDescription("Set multiple By Pass Proxy URLs separated with ';'|| By Pass Proxy works only when Proxy URL is mentioned")]
public string? ByPassProxy { get; set; } = string.Empty;

Additionally, consider adding validation logic to ensure the URLs are correctly formatted.

Comment on lines +76 to +82
Server = Proxy,
};

if (!string.IsNullOrEmpty(ByPassProxy))
{
options.Proxy.Bypass = string.Join(',', ByPassProxy.Split(';'));
}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ensure proper handling of empty ByPassProxy values.

The ByPassProxy property is being split and joined without checking for empty or null values. This could lead to unexpected behavior if ByPassProxy is not set.

if (!string.IsNullOrEmpty(ByPassProxy))
{
    options.Proxy.Bypass = string.Join(',', ByPassProxy.Split(';', StringSplitOptions.RemoveEmptyEntries));
}

This ensures that empty entries are not included in the Bypass property.

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
Server = Proxy,
};
if (!string.IsNullOrEmpty(ByPassProxy))
{
options.Proxy.Bypass = string.Join(',', ByPassProxy.Split(';'));
}
Server = Proxy,
};
if (!string.IsNullOrEmpty(ByPassProxy))
{
options.Proxy.Bypass = string.join(',', ByPassProxy.Split(';', StringSplitOptions.RemoveEmptyEntries));
}

@@ -168,12 +168,6 @@ public override string GetDriverConfigsEditPageName(Agent.eDriverType driverSubT
public string Proxy { get; set; }

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please move all common properties between selenium and playwright to GingerWebDriver.cs

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 3a39e88 and 402697e.

Files selected for processing (3)
  • Ginger/GingerCoreNET/Drivers/CoreDrivers/Web/GingerWebDriver.cs (1 hunks)
  • Ginger/GingerCoreNET/Drivers/CoreDrivers/Web/Playwright/PlaywrightDriver.cs (2 hunks)
  • Ginger/GingerCoreNET/Drivers/CoreDrivers/Web/Selenium/SeleniumDriver.cs (1 hunks)
Files skipped from review as they are similar to previous changes (3)
  • Ginger/GingerCoreNET/Drivers/CoreDrivers/Web/GingerWebDriver.cs
  • Ginger/GingerCoreNET/Drivers/CoreDrivers/Web/Playwright/PlaywrightDriver.cs
  • Ginger/GingerCoreNET/Drivers/CoreDrivers/Web/Selenium/SeleniumDriver.cs

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 402697e and a5b4fba.

Files selected for processing (3)
  • Ginger/GingerCoreNET/Drivers/CoreDrivers/Web/GingerWebDriver.cs (1 hunks)
  • Ginger/GingerCoreNET/Drivers/CoreDrivers/Web/Playwright/PlaywrightDriver.cs (2 hunks)
  • Ginger/GingerCoreNET/Drivers/CoreDrivers/Web/Selenium/SeleniumDriver.cs (2 hunks)
Files skipped from review as they are similar to previous changes (3)
  • Ginger/GingerCoreNET/Drivers/CoreDrivers/Web/GingerWebDriver.cs
  • Ginger/GingerCoreNET/Drivers/CoreDrivers/Web/Playwright/PlaywrightDriver.cs
  • Ginger/GingerCoreNET/Drivers/CoreDrivers/Web/Selenium/SeleniumDriver.cs

@Maheshkale447
Maheshkale447 merged commit 8664dec into Releases/Official-Release Jul 10, 2024
@Maheshkale447
Maheshkale447 deleted the BugFix/39422-ImplementByPassProxyForPlaywright branch July 10, 2024 13:59
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