Skip to content

fix: Fix re-captcha case#38997

Merged
sagar-qa007 merged 2 commits intoreleasefrom
fix/recaptchaerror
Feb 4, 2025
Merged

fix: Fix re-captcha case#38997
sagar-qa007 merged 2 commits intoreleasefrom
fix/recaptchaerror

Conversation

@sagar-qa007
Copy link
Contributor

@sagar-qa007 sagar-qa007 commented Feb 4, 2025

Description

Verify toast before disapper.

Fixes #Issue Number
or
Fixes Issue URL

Warning

If no issue exists, please create an issue first, and check with the maintainers if the issue is valid.

Automation

/ok-to-test tags="@tag.Binding"

🔍 Cypress test results

Tip

🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/13129952231
Commit: e0a07d1
Cypress dashboard.
Tags: @tag.Binding
Spec:


Tue, 04 Feb 2025 08:41:43 UTC

Communication

Should the DevRel and Marketing teams inform users about this change?

  • Yes
  • No

Summary by CodeRabbit

  • Tests
    • Enhanced error notification handling for Google reCAPTCHA failures to ensure users receive consistent and reliable feedback.
    • Improved the process for validating that error messages display correctly and clear as expected during failure scenarios.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 4, 2025

Walkthrough

This pull request updates the error handling in the Cypress test cases for a button widget binding with a Text widget employing Google reCAPTCHA. The changes modify how toast messages are checked: the previous direct assertion is replaced with a validation method. Additionally, the method for waiting for toast disappearance is updated to validate the toast's content before waiting until all toast messages are cleared. Method signatures in the support file have been updated accordingly.

Changes

File(s) Change Summary
app/client/cypress/e2e/Regression/ClientSide/Binding/Button_Text_WithRecaptcha_spec.js Replaced AssertContains with ValidateToastMessage for verifying Google reCAPTCHA error message and updated waiting mechanism from WaitUntilToastDisappear to a combination of toast validation and WaitUntilAllToastsDisappear.
app/client/cypress/support/Objects/ObjectsCore.js Updated method signatures: AssertContains(message)ValidateToastMessage(message) and WaitUntilToastDisappear(message)WaitUntilAllToastsDisappear().

Sequence Diagram(s)

sequenceDiagram
    participant Test as TestCase
    participant Helper as agHelper

    Test->>Helper: ValidateToastMessage("Google reCAPTCHA token generation failed!")
    alt Toast is present
        Helper-->>Test: Toast validated
    end
    Test->>Helper: ValidateToastMessage(testdata.errorMsg)
    Test->>Helper: WaitUntilAllToastsDisappear()
    Helper-->>Test: Confirmation received
Loading

Suggested labels

Test

Suggested reviewers

  • ApekshaBhosale
  • NandanAnantharamu

Poem

In lines of code, a toast takes flight,
Validated messages shining bright.
Errors checked with methods anew,
Robust tests that stick like glue.
Cheers to changes that keep tests tight!
🚀 Happy coding and endless delight!

Tip

🌐 Web search-backed reviews and chat
  • We have enabled web search-based reviews and chat for all users. This feature allows CodeRabbit to access the latest documentation and information on the web.
  • You can disable this feature by setting web_search: false in the knowledge_base settings.
  • Please share any feedback in the Discord discussion.

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5e09113 and e0a07d1.

📒 Files selected for processing (1)
  • app/client/cypress/e2e/Regression/ClientSide/Binding/Button_Text_WithRecaptcha_spec.js (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • app/client/cypress/e2e/Regression/ClientSide/Binding/Button_Text_WithRecaptcha_spec.js
⏰ Context from checks skipped due to timeout of 90000ms (7)
  • GitHub Check: perform-test / server-build / server-unit-tests
  • GitHub Check: perform-test / rts-build / build
  • GitHub Check: client-unit-tests / client-unit-tests
  • GitHub Check: client-lint / client-lint
  • GitHub Check: client-check-cyclic-deps / check-cyclic-dependencies
  • GitHub Check: client-build / client-build
  • GitHub Check: client-prettier / prettier-check

🪧 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.
    • 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 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 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

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.

@github-actions github-actions bot added the Bug Something isn't working label Feb 4, 2025
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 comments (2)
app/client/cypress/e2e/Regression/ClientSide/Binding/Button_Text_WithRecaptcha_spec.js (2)

43-43: Remove all instances of _.agHelper.Sleep().

Using Sleep() makes tests flaky and slower. Replace with appropriate Cypress wait commands or assertions.

Replace the Sleep() calls with proper Cypress commands:

- _.agHelper.Sleep();
+ _.agHelper.WaitUntilAllToastsDisappear();
+ _.agHelper.WaitForNetworkCall('POST');  // If waiting for API response

Also applies to: 53-53, 62-62, 76-76


19-20: Replace CSS selectors with data- attributes.*

Using CSS selectors like widgetInCanvas("textwidget") + " span" is fragile. Use data-* attributes instead.

Update the selectors to use data attributes:

- _.locators._widgetInCanvas("textwidget") + " span"
+ _.locators._dataAttribute("widget-text-content")

Also applies to: 28-29, 45-46, 54-56, 85-86, 93-94

🧹 Nitpick comments (1)
app/client/cypress/e2e/Regression/ClientSide/Binding/Button_Text_WithRecaptcha_spec.js (1)

77-91: Refactor complex conditional logic.

The body check with multiple conditions makes the test hard to maintain. Consider extracting this into a helper function.

Consider refactoring to:

- cy.get("body").then(($ele) => {
-   if (
-     $ele.find(
-       _.locators._specificToast(
-         "Google reCAPTCHA token generation failed!",
-       ),
-     ).length ||
-     $ele
-       .find(_.locators._widgetInCanvas("textwidget") + " span")
-       .text() == ""
-   ) {
-     _.agHelper.WaitUntilAllToastsDisappear();
-     _.agHelper.ClickButton("Submit");
-   }
- });
+ _.agHelper.RetryUntilSuccess(() => {
+   _.agHelper.ClickButton("Submit");
+   _.agHelper.ValidateTextNotEmpty(_.locators._dataAttribute("widget-text-content"));
+ });
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 84474ae and 5e09113.

📒 Files selected for processing (1)
  • app/client/cypress/e2e/Regression/ClientSide/Binding/Button_Text_WithRecaptcha_spec.js (2 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
app/client/cypress/e2e/Regression/ClientSide/Binding/Button_Text_WithRecaptcha_spec.js (1)

Pattern app/client/cypress/**/**.*: Review the following e2e test code written using the Cypress test library. Ensure that:

  • Follow best practices for Cypress code and e2e automation.
  • Avoid using cy.wait in code.
  • Avoid using cy.pause in code.
  • Avoid using agHelper.sleep().
  • Use locator variables for locators and do not use plain strings.
  • Use data-* attributes for selectors.
  • Avoid Xpaths, Attributes and CSS path.
  • Avoid selectors like .btn.submit or button[type=submit].
  • Perform logins via API with LoginFromAPI.
  • Perform logout via API with LogOutviaAPI.
  • Perform signup via API with SignupFromAPI.
  • Avoid using it.only.
  • Avoid using after and aftereach in test cases.
  • Use multiple assertions for expect statements.
  • Avoid using strings for assertions.
  • Do not use duplicate filenames even with different paths.
  • Avoid using agHelper.Sleep, this.Sleep in any file in code.
⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: client-lint / client-lint
  • GitHub Check: client-unit-tests / client-unit-tests
  • GitHub Check: client-prettier / prettier-check
  • GitHub Check: client-build / client-build
🔇 Additional comments (1)
app/client/cypress/e2e/Regression/ClientSide/Binding/Button_Text_WithRecaptcha_spec.js (1)

101-102: LGTM! Improved toast message handling.

The changes to use ValidateToastMessage followed by WaitUntilAllToastsDisappear improve test reliability by properly validating toast content before waiting for disappearance.

Also applies to: 113-114, 121-122

@sagar-qa007
Copy link
Contributor Author

/ci-test-limit-count run_count=20 update_snapshot=false specs_to_run=cypress/e2e/Regression/ClientSide/Binding/Button_Text_WithRecaptcha_spec.js

@github-actions
Copy link

github-actions bot commented Feb 4, 2025

@sagar-qa007 sagar-qa007 added the ok-to-test Required label for CI label Feb 4, 2025
Copy link
Contributor

@NandanAnantharamu NandanAnantharamu left a comment

Choose a reason for hiding this comment

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

Lgtm

@github-actions
Copy link

github-actions bot commented Feb 4, 2025

Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/13129606515.
Cypress dashboard: Click here!
The following are new failures, please fix them before merging the PR:
To know the list of identified flaky tests - Refer here

***** Repeat Run Summary ***** Total Tests with repeat: 80 Total Passed: 80 Total Failed: 0 Total Skipped: 0 *****************************

@sagar-qa007 sagar-qa007 merged commit d9ea6dd into release Feb 4, 2025
47 checks passed
@sagar-qa007 sagar-qa007 deleted the fix/recaptchaerror branch February 4, 2025 08:41
github-actions bot pushed a commit to Zeral-Zhang/appsmith that referenced this pull request Feb 7, 2025
## Description
Verify toast before disapper.


Fixes #`Issue Number`  
_or_  
Fixes `Issue URL`
> [!WARNING]  
> _If no issue exists, please create an issue first, and check with the
maintainers if the issue is valid._

## Automation

/ok-to-test tags="@tag.Binding"

### 🔍 Cypress test results
<!-- This is an auto-generated comment: Cypress test results  -->
> [!TIP]
> 🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
> Workflow run:
<https://github.com/appsmithorg/appsmith/actions/runs/13129952231>
> Commit: e0a07d1
> <a
href="https://internal.appsmith.com/app/cypress-dashboard/rundetails-65890b3c81d7400d08fa9ee5?branch=master&workflowId=13129952231&attempt=2"
target="_blank">Cypress dashboard</a>.
> Tags: `@tag.Binding`
> Spec:
> <hr>Tue, 04 Feb 2025 08:41:43 UTC
<!-- end of auto-generated comment: Cypress test results  -->


## Communication
Should the DevRel and Marketing teams inform users about this change?
- [ ] Yes
- [x] No


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

- **Tests**
- Enhanced error notification handling for Google reCAPTCHA failures to
ensure users receive consistent and reliable feedback.
- Improved the process for validating that error messages display
correctly and clear as expected during failure scenarios.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Bug Something isn't working ok-to-test Required label for CI

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants