BugFix - 42099 Accessibility Bug Fix for Playwright

[IamRanjeetSingh]

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

  • Introduced a method to retrieve accessibility targets based on input parameters, enhancing accessibility testing capabilities.
  • Updated handling of accessibility targets to improve flexibility and adaptability in testing scenarios.

• Bug Fixes

  • Streamlined accessibility target retrieval process to enhance clarity and maintainability.

• Refactor

  • Consolidated functionality around the accessibility testing instance for improved code readability and efficiency.

[coderabbitai]

Walkthrough

The changes involve modifications to accessibility testing functionality across multiple files. A new method GetAccessibilityTarget() is introduced in the ReportTypes enum, enhancing how accessibility targets are retrieved. The ActAccessibilityTestingHandler class sees the removal of its previous GetAccessibilityTarget() method, streamlining the process by relying on the _act instance. Additionally, the RunAction method in PlaywrightDriver is updated to handle accessibility testing actions with improved conditional logic based on target types.

Changes

Files	Change Summary
Ginger/GingerCoreNET/ActionsLib/UI/Web/ActAccessibilityTesting.cs	Added a new public method GetAccessibilityTarget() to the ReportTypes enum for parsing input parameters to determine accessibility targets.
Ginger/GingerCoreNET/Drivers/CoreDrivers/Web/ActionHandlers/ActAccessibilityTestingHandler.cs	Removed the GetAccessibilityTarget() method from ActAccessibilityTestingHandler, consolidating functionality around the _act instance for accessibility target retrieval.
Ginger/GingerCoreNET/Drivers/CoreDrivers/Web/Playwright/PlaywrightDriver.cs	Updated RunAction method to conditionally handle accessibility targets, creating instances of ActAccessibilityTestingHandler based on the target type and modifying the parameter used for locating values.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant PlaywrightDriver
    participant ActAccessibilityTestingHandler

    User->>PlaywrightDriver: Request accessibility test
    PlaywrightDriver->>PlaywrightDriver: Determine accessibility target
    alt Target is Element
        PlaywrightDriver->>ActAccessibilityTestingHandler: Create handler with BrowserElementLocator
    else Target is not Element
        PlaywrightDriver->>ActAccessibilityTestingHandler: Create handler without BrowserElementLocator
    end
    ActAccessibilityTestingHandler-->>PlaywrightDriver: Return test results
    PlaywrightDriver-->>User: Deliver results

Loading

Poem

🐰 In the meadow, changes bloom,
New paths for targets, dispelling gloom.
A method added, a handler refined,
Accessibility testing, beautifully aligned.
Hops of progress, we cheer with delight,
In code we trust, our future is bright! 🌼

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

Actionable comments posted: 3

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 1c7b6a4 and adc7aa6.

Files selected for processing (3)

• Ginger/GingerCoreNET/ActionsLib/UI/Web/ActAccessibilityTesting.cs (1 hunks)
• Ginger/GingerCoreNET/Drivers/CoreDrivers/Web/ActionHandlers/ActAccessibilityTestingHandler.cs (2 hunks)
• Ginger/GingerCoreNET/Drivers/CoreDrivers/Web/Playwright/PlaywrightDriver.cs (1 hunks)

Additional context used

Learnings (1)

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

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.

Additional comments not posted (2)

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

Line range hint 41-45: LGTM!

The change simplifies the code by directly using _act.GetAccessibilityTarget() instead of calling a separate method. This improves readability and maintainability.

The code changes are approved.

Ginger/GingerCoreNET/ActionsLib/UI/Web/ActAccessibilityTesting.cs (1)

393-400: LGTM!

The method is implemented correctly and provides a fallback mechanism if parsing fails. This enhances the robustness of the code.

The code changes are approved.

[coderabbitai]

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 adc7aa6 and ef5d363.

Files selected for processing (1)

• Ginger/GingerCoreNET/Drivers/CoreDrivers/Web/Playwright/PlaywrightDriver.cs (1 hunks)

Files skipped from review as they are similar to previous changes (1)

• Ginger/GingerCoreNET/Drivers/CoreDrivers/Web/Playwright/PlaywrightDriver.cs