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

BugFix - 41115, 41116, 42099 - Playwright Accessibility And VRT Bug Fixes #3885

Merged
merged 1 commit into from
Aug 29, 2024

Conversation

IamRanjeetSingh
Copy link
Contributor

@IamRanjeetSingh IamRanjeetSingh commented Aug 29, 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 error handling for window size checks in visual testing.
    • Expanded support for accessibility actions and improved feedback for unsupported actions in the Playwright driver.
  • Bug Fixes

    • Added null checks to prevent potential exceptions when accessing the web driver.
  • Refactor

    • Improved code readability and maintainability by restructuring logic in accessibility testing.

Copy link
Contributor

coderabbitai bot commented Aug 29, 2024

Walkthrough

The changes involve enhancements to error handling and logic restructuring in the ActVisualTesting, ActAccessibilityTestingHandler, and PlaywrightDriver classes. Key modifications include null checks for web drivers, improved readability in rule processing, and expanded support for accessibility actions and visual testing analyzers. These updates aim to ensure more robust functionality and clearer feedback regarding action support.

Changes

File Path Change Summary
Ginger/GingerCoreNET/ActionsLib/UI/VisualTesting/ActVisualTesting.cs Added a null check for the IWebDriver instance in CheckSetAppWindowSize to prevent null reference exceptions.
Ginger/GingerCoreNET/Drivers/CoreDrivers/Web/ActionHandlers/ActAccessibilityTestingHandler.cs Restructured CreateAxeRunOptions for improved readability, separating condition checks from rule processing logic.
Ginger/GingerCoreNET/Drivers/CoreDrivers/Web/Playwright/PlaywrightDriver.cs Enhanced RunAction and IsActionSupported methods with additional checks for accessibility actions and visual testing analyzers.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant PlaywrightDriver
    participant ActAccessibilityTestingHandler
    participant ActVisualTesting

    User->>PlaywrightDriver: Request Action
    PlaywrightDriver->>PlaywrightDriver: Check Browser Mode
    alt Private Mode
        PlaywrightDriver->>ActAccessibilityTestingHandler: Execute Accessibility Action
        ActAccessibilityTestingHandler->>PlaywrightDriver: Return Result
    else Non-Private Mode
        PlaywrightDriver-->>User: Error: Action not supported in non-private mode
    end
    PlaywrightDriver->>ActVisualTesting: Check WebDriver
    alt WebDriver is null
        ActVisualTesting-->>PlaywrightDriver: Return True
    else WebDriver is valid
        ActVisualTesting->>PlaywrightDriver: Proceed with Action
    end
Loading

Poem

🐇
In the code where rabbits hop,
Changes made, we’ll never stop!
Null checks here, and rules refined,
A clearer path for all to find.
With every tweak, our joy will grow,
In testing lands, we’ll surely glow!
🌼


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 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 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

Outside diff range, codebase verification and nitpick comments (1)
Ginger/GingerCoreNET/Drivers/CoreDrivers/Web/Playwright/PlaywrightDriver.cs (1)

226-230: Add a comment explaining the need for private mode.

The added condition ensures that accessibility actions can only be executed when the browser is in private mode. It would be helpful to add a comment explaining why this restriction is necessary.

+ // Accessibility actions require the browser to be in private mode.
if (!BrowserPrivateMode)
{
    act.Error = $"Playwright Driver must be in Private mode for using Accessibility actions";
    break;
}
Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between ce7da21 and a69040f.

Files selected for processing (3)
  • Ginger/GingerCoreNET/ActionsLib/UI/VisualTesting/ActVisualTesting.cs (2 hunks)
  • Ginger/GingerCoreNET/Drivers/CoreDrivers/Web/ActionHandlers/ActAccessibilityTestingHandler.cs (1 hunks)
  • Ginger/GingerCoreNET/Drivers/CoreDrivers/Web/Playwright/PlaywrightDriver.cs (3 hunks)
Additional context used
Learnings (1)
Ginger/GingerCoreNET/Drivers/CoreDrivers/Web/Playwright/PlaywrightDriver.cs (2)
Learnt from: IamRanjeetSingh
PR: Ginger-Automation/Ginger#3783
File: Ginger/GingerCoreNET/Drivers/CoreDrivers/Web/Playwright/PlaywrightDriver.cs:129-129
Timestamp: 2024-06-24T08:39:59.351Z
Learning: User IamRanjeetSingh has indicated that the `RunAction` method in the `PlaywrightDriver` class should remain synchronous due to current constraints in the codebase.
Learnt from: GokulBothe99
PR: Ginger-Automation/Ginger#3835
File: Ginger/GingerCoreNET/Drivers/CoreDrivers/Web/Playwright/PlaywrightDriver.cs:1022-1029
Timestamp: 2024-07-18T09:05:15.264Z
Learning: The user prefers readability over concise code in the context of deactivating locators in the `LearnElementInfoDetails` method of the `PlaywrightDriver` class.
Additional comments not posted (4)
Ginger/GingerCoreNET/Drivers/CoreDrivers/Web/ActionHandlers/ActAccessibilityTestingHandler.cs (1)

96-107: LGTM!

The refactoring improves readability and maintainability without altering functionality.

Ginger/GingerCoreNET/ActionsLib/UI/VisualTesting/ActVisualTesting.cs (1)

399-403: LGTM!

The null check prevents potential null reference exceptions, enhancing robustness.

Ginger/GingerCoreNET/Drivers/CoreDrivers/Web/Playwright/PlaywrightDriver.cs (2)

265-265: Expand the list of supported actions.

The condition now includes ActGotoURL and ActAccessibilityTesting as supported actions. This change broadens the scope of actions that can be processed without additional checks.

The code changes are approved.


314-318: Clarify the unsupported visual testing analyzer.

The condition for ActVisualTesting now includes a specific check for the Applitools visual testing analyzer. This change clarifies that Applitools is not supported by the Playwright driver.

The code changes are approved.

@IamRanjeetSingh IamRanjeetSingh merged commit 45f941d into Releases/Beta Aug 29, 2024
8 of 9 checks passed
@IamRanjeetSingh IamRanjeetSingh deleted the BugFix/41115,41116-BugFix branch August 29, 2024 11:39
@IamRanjeetSingh IamRanjeetSingh changed the title BugFix - 41115 & 41116 - Playwright Accessibility And VRT Bug Fixes BugFix - 41115, 41116, 42099 - Playwright Accessibility And VRT Bug Fixes Aug 29, 2024
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