Skip to content

Supported Playwight locator#4242

Merged
GokulBothe99 merged 3 commits into
masterfrom
Feature/Playwight_Locator
Jun 24, 2025
Merged

Supported Playwight locator#4242
GokulBothe99 merged 3 commits into
masterfrom
Feature/Playwight_Locator

Conversation

@GokulBothe99

@GokulBothe99 GokulBothe99 commented Jun 23, 2025

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

    • Expanded support for element identification with new locator options: ByLabel, ByPlaceholder, ByAltText, ByTestID, and Chained.
    • Additional locator types now available in browser automation, including ByHref, ByValue, ByIndex, ByTitle, ByUrl, Angular-specific locators, ByResourceID, ByContentDescription, ByText, and ByModelName.
  • Enhancements

    • Improved locator handling for web automation, offering greater flexibility and precision when identifying UI elements.

@coderabbitai

coderabbitai Bot commented Jun 23, 2025

Copy link
Copy Markdown
Contributor

Walkthrough

This change expands the supported UI element locator strategies by adding new locator types to the eLocateBy enum, updating the Playwright driver to handle these new strategies, and including them in the web platform's list of available locators. No other functional or structural changes are introduced.

Changes

File(s) Change Summary
Ginger/GingerCoreCommon/UIElement/ElementInfo.cs Added five new locator types to the eLocateBy enum: ByLabel, ByPlaceholder, ByAltText, ByTestID, and Chained.
Ginger/GingerCoreNET/Drivers/CoreDrivers/Web/Playwright/PlaywrightBrowserTab.cs Expanded supported element locators and updated locator resolution logic to handle new types, including chained logic.
Ginger/GingerCoreNET/Run/Platforms/PlatformsInfo/WebPlatformInfo.cs Appended new locator types to the list returned by GetPlatformUIElementLocatorsList.

Sequence Diagram(s)

sequenceDiagram
    participant TestRunner
    participant PlaywrightBrowserTab
    participant PlaywrightAPI

    TestRunner->>PlaywrightBrowserTab: Request element (locateBy, value)
    PlaywrightBrowserTab->>PlaywrightBrowserTab: GetElementLocator(locateBy, value)
    alt Standard locator
        PlaywrightBrowserTab->>PlaywrightAPI: Use corresponding locator (e.g., GetByLabel, GetByPlaceholder)
    else Chained locator
        PlaywrightBrowserTab->>PlaywrightAPI: Split value, resolve each locator in sequence
    end
    PlaywrightAPI-->>PlaywrightBrowserTab: Element handle
    PlaywrightBrowserTab-->>TestRunner: Return element handle
Loading

Possibly related PRs

Suggested reviewers

  • Maheshkale447

Poem

In the garden of locators, new seeds now grow,
ByLabel and Placeholder, AltText in tow.
Chained paths and TestIDs join the quest,
Playwright now finds elements with zest!
A rabbit hops through code so bright—
More ways to find, more reasons to delight! 🐇✨


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 8455b39 and 7b16927.

📒 Files selected for processing (1)
  • Ginger/GingerCoreNET/Drivers/CoreDrivers/Web/Playwright/PlaywrightBrowserTab.cs (4 hunks)
🧰 Additional context used
🧠 Learnings (1)
Ginger/GingerCoreNET/Drivers/CoreDrivers/Web/Playwright/PlaywrightBrowserTab.cs (1)
Learnt from: GokulBothe99
PR: Ginger-Automation/Ginger#4242
File: Ginger/GingerCoreNET/Drivers/CoreDrivers/Web/Playwright/PlaywrightBrowserTab.cs:623-656
Timestamp: 2025-06-24T06:08:31.780Z
Learning: In Ginger/GingerCoreNET/Drivers/CoreDrivers/Web/Playwright/PlaywrightBrowserTab.cs, the CSS selector construction by directly interpolating user input values in the GetElementLocator method is considered acceptable by the team and working as expected for their use cases.
🔇 Additional comments (5)
Ginger/GingerCoreNET/Drivers/CoreDrivers/Web/Playwright/PlaywrightBrowserTab.cs (5)

50-80: LGTM! Comprehensive locator support expansion.

The addition of numerous locator types including Angular-specific (ByngModel, ByngRepeat, etc.), mobile-specific (ByResourceID, ByContentDescription), and semantic locators (ByLabel, ByPlaceholder, ByAltText, ByTestID) significantly enhances Playwright's element location capabilities.


597-597: Good consolidation of duplicate cases.

Consolidating ByCSSSelector with ByCSS eliminates code duplication and maintains consistent behavior for both locator types.


653-664: Excellent use of Playwright's semantic locator methods.

Using Playwright's built-in GetByLabel(), GetByPlaceholder(), GetByAltText(), and GetByTestId() methods is the recommended approach for these locator types. This provides better reliability and follows Playwright best practices.


665-686: Well-implemented chained locator with proper validation.

The chained locator implementation includes comprehensive validation:

  • Null/empty value checks
  • Minimum parts requirement
  • Empty parts validation

This robust approach prevents runtime errors and provides clear error messages for invalid input.


732-734: Clean formatting improvements.

The removal of trailing spaces and unnecessary blank lines improves code cleanliness without affecting functionality.

✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate Unit Tests
  • Create PR with Unit Tests
  • Post Copyable Unit Tests in Comment
  • Commit Unit Tests in branch Feature/Playwight_Locator

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai auto-generate unit tests to generate unit tests for this 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.

@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: 5

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between d98d9fd and 96e9c25.

📒 Files selected for processing (3)
  • Ginger/GingerCoreCommon/UIElement/ElementInfo.cs (1 hunks)
  • Ginger/GingerCoreNET/Drivers/CoreDrivers/Web/Playwright/PlaywrightBrowserTab.cs (4 hunks)
  • Ginger/GingerCoreNET/Run/Platforms/PlatformsInfo/WebPlatformInfo.cs (1 hunks)
🔇 Additional comments (3)
Ginger/GingerCoreCommon/UIElement/ElementInfo.cs (1)

612-621: LGTM! New locator enums properly added.

The new locator types are correctly added with appropriate descriptive attributes following the existing pattern.

Ginger/GingerCoreNET/Run/Platforms/PlatformsInfo/WebPlatformInfo.cs (1)

597-601: LGTM! Platform locator list correctly updated.

The new locator types are properly added to the platform's supported locators list, maintaining consistency with the enum additions.

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

597-598: Good refactoring: Merged duplicate CSS selector cases.

Merging ByCSSSelector with ByCSS eliminates code duplication.

@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: 3

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between d98d9fd and 96e9c25.

📒 Files selected for processing (3)
  • Ginger/GingerCoreCommon/UIElement/ElementInfo.cs (1 hunks)
  • Ginger/GingerCoreNET/Drivers/CoreDrivers/Web/Playwright/PlaywrightBrowserTab.cs (4 hunks)
  • Ginger/GingerCoreNET/Run/Platforms/PlatformsInfo/WebPlatformInfo.cs (1 hunks)
🔇 Additional comments (8)
Ginger/GingerCoreCommon/UIElement/ElementInfo.cs (1)

612-621: New locator enum entries correctly added
The eLocateBy enum now includes ByLabel, ByPlaceholder, ByAltText, ByTestID, and Chained with accurate EnumValueDescription attributes and naming consistency.

Ginger/GingerCoreNET/Run/Platforms/PlatformsInfo/WebPlatformInfo.cs (1)

597-601: New locators appended to platform list
The GetPlatformUIElementLocatorsList method now includes the five new locator types in the cached list, matching the eLocateBy enum updates.

Ginger/GingerCoreNET/Drivers/CoreDrivers/Web/Playwright/PlaywrightBrowserTab.cs (6)

50-80: Good expansion of supported locators for comprehensive web automation.

The addition of these locator strategies significantly enhances the flexibility of element location in Playwright. The inclusion of Angular-specific locators (Byng*) and Playwright's built-in GetBy* methods is particularly valuable.

Note that some locators like ByResourceID and ByContentDescription appear to be mobile-oriented and may not be applicable in web contexts.


597-597: Good consolidation of duplicate locator cases.

Consolidating ByCSSSelector with the existing ByCSS case eliminates redundancy and improves maintainability.


657-668: Excellent use of Playwright's built-in locator methods.

Using Playwright's native GetByLabel, GetByPlaceholder, GetByAltText, and GetByTestId methods provides robust and reliable element location with built-in waiting and error handling.


722-724: Good formatting cleanup.

Removing trailing whitespace and unnecessary blank lines improves code consistency.


629-631: Verify ByIndex locator syntax.

The nth={value} syntax may not be correct for Playwright's nth selector. Typically, nth selectors require a base locator.

Verify the correct syntax for Playwright's nth selector:

#!/bin/bash
# Search for usage patterns of nth selector in Playwright documentation or existing code
rg -A 3 -B 3 "nth=" --type cs

651-656: ```shell
#!/bin/bash

Show PlaywrightBrowserTab implementation around mobile locators

sed -n '630,680p' Ginger/GingerCoreNET/Drivers/CoreDrivers/Web/Playwright/PlaywrightBrowserTab.cs

Show how mobile Appium driver handles these enums

sed -n '490,540p' Ginger/GingerCoreNET/Drivers/CoreDrivers/Mobile/Appium/GenericAppiumDriver.cs

Inspect WebPlatformInfo to see which eLocateBy values are advertised for web

sed -n '570,620p' Ginger/GingerCoreNET/Run/Platforms/PlatformsInfo/WebPlatformInfo.cs

Find all definitions & uses of ByContentDescription in platform info

rg -n "ByContentDescription" -g "Ginger/GingerCoreNET/Run/Platforms/PlatformsInfo/*.cs"


</details>

</blockquote></details>

</details>

<!-- This is an auto-generated comment by CodeRabbit for review status -->

coderabbitai[bot]
coderabbitai Bot previously approved these changes Jun 24, 2025
Maheshkale447
Maheshkale447 previously approved these changes Jun 24, 2025
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