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

OSOE-771: Adding more navigation methods #342

Merged
merged 9 commits into from
Feb 13, 2024
Merged

OSOE-771: Adding more navigation methods #342

merged 9 commits into from
Feb 13, 2024

Conversation

Piedone
Copy link
Member

@Piedone Piedone commented Feb 9, 2024

Copy link
Contributor

coderabbitai bot commented Feb 9, 2024

Walkthrough

Walkthrough

The recent update introduces a new method for more efficient navigation testing by combining two existing functionalities, streamlining the process of clicking an element and waiting for a URL change. It also includes a method renaming that clarifies its purpose and adds a new method dedicated to waiting for a URL change post-click, enhancing the intuitiveness and efficiency of automated UI tests.

Changes

File(s) Change Summary
NavigationUITestContextExtensions.cs
OrchardCoreDashboardUITestContextExtensions.cs
Added ClickReliablyOnByLinkTextAsync for clicking on a link identified by text and improved element clicking based on dropdown presence.
NavigationWebElementExtensions.cs Renamed ClickReliablyUntilPageLeaveAsync to ClickReliablyOnUntilPageLeaveAsync and introduced ClickReliablyThenWaitForUrlChangeAsync for waiting for a URL change after clicking.
TenantsUITestContextExtensions.cs Refactored method calls to click on elements by link text for improved reliability.

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-tests for this file.
  • 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 tests 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 from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

@github-actions github-actions bot changed the title Adding more navigation methods OSOE-771: Adding more navigation methods Feb 9, 2024
…oo, not just wait for the URL change, thus also renaming to ClickReliablyUntilUrlChangeAsync
Comment on lines +153 to +155
context.Scope.AtataContext.Log.Info("Log section {0} started.", section.Message);
var result = await functionAsync();
context.Scope.AtataContext.Log.Info("Log section {0} ended.", section.Message);
Copy link
Contributor

Choose a reason for hiding this comment

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

The addition of logging statements to indicate the start and end of a log section enhances the visibility of operations within tests. However, consider adding error logging within the catch block for StaleElementReferenceException to provide insights into failures that trigger retries.

catch (StaleElementReferenceException) when (notLast)
{
+   context.Scope.AtataContext.Log.Warn("Encountered a StaleElementReferenceException, retrying...");
    await Task.Delay(TimeSpan.FromSeconds(1));
}

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
context.Scope.AtataContext.Log.Info("Log section {0} started.", section.Message);
var result = await functionAsync();
context.Scope.AtataContext.Log.Info("Log section {0} ended.", section.Message);
context.Scope.AtataContext.Log.Info("Log section {0} started.", section.Message);
var result = await functionAsync();
context.Scope.AtataContext.Log.Info("Log section {0} ended.", section.Message);
catch (StaleElementReferenceException) when (notLast)
{
context.Scope.AtataContext.Log.Warn("Encountered a StaleElementReferenceException, retrying...");
await Task.Delay(TimeSpan.FromSeconds(1));
}

@DemeSzabolcs DemeSzabolcs merged commit 5b283da into dev Feb 13, 2024
1 check passed
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