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

Update to Selenium 4.24.0 #96

Merged
merged 4 commits into from
Sep 9, 2024
Merged

Conversation

mialeska
Copy link
Contributor

@mialeska mialeska commented Sep 9, 2024

Stabilize wait for FindElements in the ElementFactory +semver:feature

PR Details

Related Issue Link:
How Has This Been Tested
Checklist
  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

Stabilize wait for FindElements in the ElementFactory
@mialeska mialeska added enhancement New feature or request java dependencies Pull requests that update a dependency file labels Sep 9, 2024
@mialeska mialeska self-assigned this Sep 9, 2024
Copy link

coderabbitai bot commented Sep 9, 2024

Warning

Rate limit exceeded

@mialeska has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 16 minutes and 32 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between a599d9b and fce9024.

Walkthrough

The pull request introduces updates to the pom.xml file, upgrading several dependencies to newer versions, including log4j, guava, jackson-databind, selenium-java, java-client, and commons-lang3. Additionally, the findElements method in ElementFactory.java has been modified to implement a conditionalWait mechanism, enhancing element retrieval by incorporating exception handling and flexible return options based on the count of elements found. The Azure Pipelines configuration in azure-pipelines.yml has also been updated to reflect newer task versions and parameters.

Changes

File Change Summary
pom.xml Updated versions of dependencies: log4j (2.24.0), guava (33.3.0), jackson-databind (2.17.2), selenium-java (4.24.0), java-client (9.3.0), commons-lang3 (3.17.0).
src/main/java/aquality/selenium/core/elements/ElementFactory.java Modified findElements method to include a conditionalWait mechanism, improved exception handling, and flexible element count options.
azure-pipelines.yml Upgraded task versions for SonarCloudPrepare, Maven, SonarCloudAnalyze, and SonarCloudPublish. Adjusted input parameters for Maven tasks and simplified extraProperties.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant ElementFactory
    participant WebDriver

    User->>ElementFactory: findElements(locator, name, state, count)
    ElementFactory->>WebDriver: Wait for condition
    WebDriver-->>ElementFactory: Elements found or exception
    ElementFactory->>User: Return elements based on count
Loading

Possibly related PRs

Poem

🐰 In the garden of code, we hop with glee,
Upgrading our friends, as happy as can be!
With waits and catches, our elements shine,
A dance of dependencies, all perfectly aligned!
So here's to the changes, a joyful delight,
Let's code and create, from morning till night! 🌼


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

@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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 6f0f4ac and f6d5a1c.

Files selected for processing (2)
  • pom.xml (2 hunks)
  • src/main/java/aquality/selenium/core/elements/ElementFactory.java (2 hunks)
Additional comments not posted (2)
pom.xml (1)

20-20: Dependency updates look good, but verify compatibility and run tests.

The pull request updates several dependencies to newer versions:

  • log4j from 2.23.1 to 2.24.0
  • guava from 33.1.0-jre to 33.3.0-jre
  • jackson-databind from 2.17.0 to 2.17.2
  • selenium-java from 4.23.0 to 4.24.0
  • java-client from 9.2.3 to 9.3.0
  • commons-lang3 from 3.14.0 to 3.17.0

These updates are likely to include bug fixes, security patches, and new features. However, it's important to ensure that the updated versions are compatible with the project's codebase and other dependencies.

Please verify the compatibility of the updated dependencies and run a comprehensive test suite to ensure that the changes do not introduce any regressions or breaking changes.

Also applies to: 124-124, 129-129, 134-134, 139-139, 145-145

src/main/java/aquality/selenium/core/elements/ElementFactory.java (1)

86-104: Robust element retrieval with conditional wait and exception handling.

The changes to the findElements method introduce a more robust approach to element retrieval:

  1. The method now uses a conditionalWait to wait for the desired count of elements to be present, based on the specified count parameter (ANY, ZERO, or MORE_THAN_ZERO). This ensures that the method returns only when the expected number of elements is found.

  2. The wait mechanism handles specific exceptions like StaleElementReferenceException, JavascriptException, and TimeoutException. This helps to mitigate issues related to stale elements and JavaScript errors that can occur during element retrieval.

  3. The assignment of webElements and the creation of IElement instances have been moved inside the conditionalWait block. This ensures that elements are fetched and wrapped only when the wait condition is satisfied, improving the reliability of the returned elements.

Overall, these changes enhance the robustness and flexibility of the findElements method, making it more resilient to common issues encountered during element retrieval in dynamic web pages.

Copy link

@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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between f6d5a1c and fb06a64.

Files selected for processing (1)
  • azure-pipelines.yml (2 hunks)
Additional comments not posted (5)
azure-pipelines.yml (5)

12-19: LGTM!

The changes to the SonarCloudPrepare task are approved:

  • Upgrading the task version to 2 may include enhancements or bug fixes.
  • Simplifying the extraProperties input to a single-line string improves the configuration readability.

21-34: LGTM!

The changes to the Maven task are approved:

  • Upgrading the task version to 4 may include enhancements or bug fixes.
  • Adding the clean goal ensures a clean state before building the project.
  • Updating the jdkVersionOption to 1.11 aligns with a more explicit versioning format.
  • Introducing new parameters such as mavenVersionOption, mavenAuthenticateFeed, effectivePomSkip, and sonarQubeRunAnalysis allows for a more detailed configuration of Maven operations.

36-38: LGTM!

The changes to the SonarCloudAnalyze task are approved:

  • Upgrading the task version to 2 may include enhancements or bug fixes.
  • Setting the jdkversion input to JAVA_HOME ensures that the task uses the JDK version specified by the JAVA_HOME environment variable.

42-42: LGTM!

The change to the SonarCloudPublish task is approved:

  • Upgrading the task version to 2 may include enhancements or bug fixes.

96-109: LGTM!

The changes to the Maven task are approved:

  • Upgrading the task version to 4 may include enhancements or bug fixes.
  • Updating the goals parameter to clean test -Dprofile=local ensures a clean state before running tests with the local profile.
  • Updating the jdkVersionOption to 1.11 aligns with a more explicit versioning format.
  • Introducing new parameters such as mavenVersionOption, mavenAuthenticateFeed, effectivePomSkip, and sonarQubeRunAnalysis allows for a more detailed configuration of Maven operations.

Copy link

@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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between fb06a64 and a599d9b.

Files selected for processing (1)
  • azure-pipelines.yml (2 hunks)
Files skipped from review as they are similar to previous changes (1)
  • azure-pipelines.yml

Copy link

sonarcloud bot commented Sep 9, 2024

@mialeska mialeska merged commit e842eca into master Sep 9, 2024
4 checks passed
@mialeska mialeska deleted the enhancement/update-to-selenium-4.24.0 branch September 9, 2024 20:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file enhancement New feature or request java
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

1 participant