Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Browse File path Playwright support #4045

Merged
merged 3 commits into from
Jan 2, 2025

Conversation

GokulBothe99
Copy link
Contributor

@GokulBothe99 GokulBothe99 commented Dec 30, 2024

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

    • Enhanced file input handling with new SetFileValueAsync method.
    • Improved network log monitoring capabilities.
  • Improvements

    • Streamlined code for proxy initialization.
    • Updated error handling for network log retrieval.
    • Refined method documentation for clearer understanding.
  • Bug Fixes

    • Corrected file input value setting mechanism.
    • Optimized network log logging process.

Copy link
Contributor

coderabbitai bot commented Dec 30, 2024

Walkthrough

The pull request introduces enhancements to file input handling across multiple web driver components. A new SetFileValueAsync method is added to the IBrowserElement interface and implemented in the PlaywrightBrowserElement class. The ActUIElementHandler is updated to specifically handle file inputs by invoking this new method. Additionally, the SeleniumDriver sees minor improvements in proxy initialization and network log handling, using modern C# syntax and refining log retrieval logic.

Changes

File Change Summary
.../ActUIElementHandler.cs Updated HandleSendKeysAsync method to specifically handle file inputs by checking element type and invoking SetFileValueAsync.
.../IBrowserElement.cs Added new SetFileValueAsync(string[] value) method to interface.
.../PlaywrightBrowserElement.cs Implemented SetFileValueAsync method with support for Playwright locators and element handles.
.../SeleniumDriver.cs Simplified proxy initialization, improved network log handling, and error management.

Possibly related PRs

Suggested reviewers

  • Maheshkale447

Poem

🐰 A rabbit's tale of web automation's grace,
Where file inputs find their rightful place,
With Playwright's magic and Selenium's might,
We send keys and files with pure delight!
Code evolves, smooth as a bunny's hop! 🚀


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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai or @coderabbitai title anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (7)
Ginger/GingerCoreNET/Drivers/CoreDrivers/Web/Selenium/SeleniumDriver.cs (3)

10937-10955: Validate logic when network log monitoring is inactive.

The first if/else block properly checks isNetworkLogMonitoringStarted. However, the code in the else case could be combined into a single log statement to clarify that the action is being skipped. This would help maintain concise logs. Otherwise, the logic is correct.

- else
- {
-   act.ExInfo = $"Action is skipped,{nameof(ActBrowserElement.eControlAction.StartMonitoringNetworkLog)} Action is not started";
-   act.Status = Amdocs.Ginger.CoreNET.Execution.eRunStatus.Skipped;
- }
+ else
+ {
+   act.Status = Amdocs.Ginger.CoreNET.Execution.eRunStatus.Skipped;
+   act.ExInfo = $"Action skipped: {nameof(ActBrowserElement.eControlAction.StartMonitoringNetworkLog)} was never started";
+ }

10957-10961: Catch block lacks detailed error management.

The exception is logged, but the user might benefit from more descriptive error feedback (e.g., appending the exception message to act.Error or storing a reference ID for debugging). Currently, the code sets Reporter.ToLog(eLogLevel.ERROR, ...) but doesn't update act.Error.

catch (Exception ex)
{
    Reporter.ToLog(eLogLevel.ERROR, $"Method - {MethodBase.GetCurrentMethod().Name}, Error - {ex.Message}", ex);
+   act.Error = $"GetNetworkLogAsync failed: {ex.Message}";
}

11025-11029: Repeated loop usage for writing logs.

Both loops add network request/response data to the action. This is fine; however, consider using a helper method to reduce repetition and ensure uniform formatting of the logs.

- foreach (var val in networkRequestLogList.ToList())
- {
-     act.AddOrUpdateReturnParamActual($"{act.ControlAction} {val.Item1}", Convert.ToString(val.Item2));
- }

- foreach (var val in networkResponseLogList.ToList())
- {
-     act.AddOrUpdateReturnParamActual($"{act.ControlAction} {val.Item1}", Convert.ToString(val.Item2));
- }

+ void AddLogEntries(ActBrowserElement act, IEnumerable<Tuple<string, object>> logs)
+ {
+     foreach (var val in logs)
+     {
+         act.AddOrUpdateReturnParamActual($"{act.ControlAction} {val.Item1}", val.Item2?.ToString());
+     }
+ }
+ 
+ AddLogEntries(act, networkRequestLogList);
+ AddLogEntries(act, networkResponseLogList);
Ginger/GingerCoreNET/Drivers/CoreDrivers/Web/IBrowserElement.cs (1)

96-96: Consider adding XML documentation for the new file-input method.
This would provide clarity for other developers regarding intended usage, edge-case behaviors, and error handling requirements for file input automation.

Ginger/GingerCoreNET/Drivers/CoreDrivers/Web/Playwright/PlaywrightBrowserElement.cs (3)

1006-1021: Validate file existence or path validity before calling SetFileValueAsync.
Although not strictly required, pre-validating the file path can help users catch issues earlier when the file is missing or incorrectly specified.


1023-1032: Add logging or exception handling for SetInputFilesAsync failures.
Consider wrapping the call in a try/catch block or adding logging messages to help troubleshoot automation failures caused by invalid file paths or permission issues.


1034-1043: Leverage a common private helper if locator and element handle share identical logic.
Since both SetFileValueAsync methods perform the same operation, consolidating into a single helper method may reduce duplication.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c09a47c and fc1b41c.

📒 Files selected for processing (4)
  • Ginger/GingerCoreNET/Drivers/CoreDrivers/Web/ActionHandlers/ActUIElementHandler.cs (1 hunks)
  • Ginger/GingerCoreNET/Drivers/CoreDrivers/Web/IBrowserElement.cs (1 hunks)
  • Ginger/GingerCoreNET/Drivers/CoreDrivers/Web/Playwright/PlaywrightBrowserElement.cs (1 hunks)
  • Ginger/GingerCoreNET/Drivers/CoreDrivers/Web/Selenium/SeleniumDriver.cs (6 hunks)
🔇 Additional comments (2)
Ginger/GingerCoreNET/Drivers/CoreDrivers/Web/Selenium/SeleniumDriver.cs (1)

402-402: Use of target-typed new expression is fine.

The new C# syntax (private Proxy mProxy = new();) is clear and concise, but ensure that the project’s minimum C# language version is set accordingly (≥ C# 9).

Ginger/GingerCoreNET/Drivers/CoreDrivers/Web/ActionHandlers/ActUIElementHandler.cs (1)

725-744: Ensure usability for non-existent or restricted file paths.
When handling file inputs with SetFileValueAsync, consider validating or gracefully reporting if the file path doesn't exist or cannot be accessed. This avoids silent failures or unexpected test results in ephemeral or locked environments.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between fc1b41c and 208e38b.

📒 Files selected for processing (3)
  • Ginger/GingerCoreNET/Drivers/CoreDrivers/Web/ActionHandlers/ActUIElementHandler.cs (1 hunks)
  • Ginger/GingerCoreNET/Drivers/CoreDrivers/Web/IBrowserElement.cs (1 hunks)
  • Ginger/GingerCoreNET/Drivers/CoreDrivers/Web/Playwright/PlaywrightBrowserElement.cs (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • Ginger/GingerCoreNET/Drivers/CoreDrivers/Web/ActionHandlers/ActUIElementHandler.cs
🔇 Additional comments (2)
Ginger/GingerCoreNET/Drivers/CoreDrivers/Web/IBrowserElement.cs (1)

96-96: LGTM! Well-structured interface method for file input handling.

The new SetFileValueAsync method follows the established async naming convention and provides a clear contract for implementing file upload functionality.

Ginger/GingerCoreNET/Drivers/CoreDrivers/Web/Playwright/PlaywrightBrowserElement.cs (1)

1006-1021: LGTM! Well-structured implementation with clear documentation.

The implementation follows the established class patterns and includes comprehensive XML documentation.

@Maheshkale447 Maheshkale447 merged commit 2a79a21 into master Jan 2, 2025
1 of 2 checks passed
@Maheshkale447 Maheshkale447 deleted the Feature/PlaywrightBrowsebutton branch January 2, 2025 07:15
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