fix: Fix iframe and widget test case for clicking #38039

sagar-qa007 · 2024-12-09T08:43:13Z

Description

Tip

Add a TL;DR when the description is longer than 500 words or extremely technical (helps the content, marketing, and DevRel team).

Please also include relevant motivation and context. List any dependencies that are required for this change. Add links to Notion, Figma or any other documents that might be relevant to the PR.

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

🔍 Cypress test results

Tip

🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/12236274208
Commit: 7bd2b6a
Cypress dashboard.
Tags: @tag.Iframe
Spec:

Mon, 09 Dec 2024 13:30:29 UTC

Communication

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

Yes
No

Summary by CodeRabbit

Bug Fixes
- Improved the Iframe widget test by ensuring button clicks can proceed under all conditions.
- Enhanced entity context management during URL property updates in tests.
Tests
- Updated test specification to include the Iframe widget test, replacing the previous fork template entry.
- Adjusted visibility assertion to use conditional waits in the Iframe widget tests.
Style
- Modified CSS selector spacing in the CommonLocators to improve element targeting.

coderabbitai · 2024-12-09T08:43:23Z

Walkthrough

The pull request modifies the Cypress end-to-end test suite for the Iframe widget. Key changes include an update to the agHelper.ClickButton method, which now includes a { force: true } option, allowing the button to be clicked regardless of its state. Additionally, a line is added to re-select the "Iframe1" entity after updating the URL property, ensuring the correct context is maintained. The srcDoc property is set to a basic HTML structure, followed by a toast message validation to confirm the update.

Changes

File Path	Change Summary
app/client/cypress/e2e/Regression/ClientSide/Widgets/Iframe/IframeTest_spec.ts	Updated `agHelper.ClickButton` to include `{ force: true }` and added context re-selection for "Iframe1" after URL update. Set `srcDoc` to basic HTML and validated toast message.
app/client/cypress/limited-tests.txt	Updated test specification to replace `Fork_Template_spec.js` with `IframeTest_spec.ts`.
app/client/cypress/support/Objects/CommonLocators.ts	Adjusted `_pageHeaderToggle` CSS selector from `".navbar__items>button"` to `".navbar__items > button"` for improved targeting.

Possibly related PRs

test: PartialExport_Widgets_spec - updated test validation logic #33371: This PR updates the test validation logic for widgets, which may relate to the changes in the main PR that enhance the Cypress test suite for the Iframe widget.
test: removed toggleBar command and replaced with ts helper #33835: This PR involves replacing cy.togglebar with agHelper.CheckUncheck, which is relevant as it also deals with improving test interactions, similar to the changes made in the Iframe tests.
chore: Anvil on canvas UI tests #35342: This PR introduces tests for the Anvil editor's UI, which may share similarities in testing widget interactions with the Iframe widget tests.
test: fix flaky case for forkapp #35376: This PR addresses flaky tests, which is a concern also reflected in the main PR's focus on improving test reliability for the Iframe widget.
fix: Fix flaky test case for the iframe spec #38018: This PR directly addresses flaky tests for the Iframe widget, making it highly relevant to the main PR's focus on improving the Iframe test suite.
fix: Update for fix #38035: This PR updates a test case related to API error handling, which may connect to the broader context of improving test robustness in the main PR.

Suggested labels

Test

Suggested reviewers

ApekshaBhosale

🎉 In the realm of code, where tests do play,
The Iframe widget shines brighter today!
With clicks that now force, and context in line,
Our tests are robust, oh how they align!
A toast to the updates, let validation flow,
In the world of Cypress, we’re ready to go! 🎊

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between ef472e3 and 14886c2.

📒 Files selected for processing (1)

app/client/cypress/e2e/Regression/ClientSide/Widgets/Iframe/IframeTest_spec.ts (3 hunks)

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

app/client/cypress/e2e/Regression/ClientSide/Widgets/Iframe/IframeTest_spec.ts

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

sagar-qa007 · 2024-12-09T08:43:48Z

/ci-test-limit-count=20 run_count=20

coderabbitai

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (1)

app/client/cypress/e2e/Regression/ClientSide/Widgets/Iframe/IframeTest_spec.ts (1)
Line range hint 93-101: Add validation for srcDoc content update

While the HTML structure update and toast validation are present, consider adding assertions to verify the iframe's content after the update.
 propPane.UpdatePropertyFieldValue(
   "srcDoc",
   `<!DOCTYPE html>
       <html lang="en">
       <head></head>
       <body></body>
       </html>`,
 );
 agHelper.ValidateToastMessage("src updated");
+// Add validation for the updated content
+getIframeBody(0).should("exist").and("be.visible");
+getIframeBody(0).find("html").should("have.attr", "lang", "en");

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 7184101 and 1c37445.

📒 Files selected for processing (1)

app/client/cypress/e2e/Regression/ClientSide/Widgets/Iframe/IframeTest_spec.ts (2 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

app/client/cypress/e2e/Regression/ClientSide/Widgets/Iframe/IframeTest_spec.ts (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.

coderabbitai · 2024-12-09T08:45:27Z

app/client/cypress/e2e/Regression/ClientSide/Widgets/Iframe/IframeTest_spec.ts

@@ -81,7 +81,7 @@ describe(
      propPane.UpdatePropertyFieldValue("URL", " ");
      agHelper.ValidateToastMessage("url updated");

-      agHelper.ClickButton("Submit");
+      agHelper.ClickButton("Submit", { force: true });


⚠️ Potential issue

Avoid using force: true in button clicks

Using force: true bypasses Cypress's automatic retry and waiting mechanisms, which could mask underlying issues. Consider using Cypress's built-in waiting mechanisms instead.

-agHelper.ClickButton("Submit", { force: true }); +agHelper.WaitUntilEleAppear("Submit"); +agHelper.ClickButton("Submit");

Committable suggestion skipped: line range outside the PR's diff.

sagar-qa007 · 2024-12-09T08:51:00Z

/ci-test-limit-count run_count=20

github-actions · 2024-12-09T08:51:31Z

Tests running at: https://github.com/appsmithorg/appsmith/actions/runs/12232063661.
Cypress dashboard
PR: #38039.

github-actions · 2024-12-09T09:17:35Z

Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/12232063661.
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: 0 Total Passed: 0 Total Failed: 0 Total Skipped: 0 *****************************

sagar-qa007 · 2024-12-09T09:24:38Z

/ci-test-limit-count run_count=20 runId=12232063661

github-actions · 2024-12-09T09:25:08Z

Tests running at: https://github.com/appsmithorg/appsmith/actions/runs/12232616392.
Cypress dashboard
PR: #38039.

github-actions · 2024-12-09T09:37:20Z

Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/12232616392.
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: 0 Total Passed: 0 Total Failed: 0 Total Skipped: 0 *****************************

sagar-qa007 · 2024-12-09T09:44:56Z

/ci-test-limit-count run_count=20 runId=12232063661

github-actions · 2024-12-09T09:45:26Z

Tests running at: https://github.com/appsmithorg/appsmith/actions/runs/12232965024.
Cypress dashboard
PR: #38039.

github-actions · 2024-12-09T10:25:55Z

Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/12232965024.
Cypress dashboard url: Click here!
All cypress tests have passed 🎉🎉🎉

***** Repeat Run Summary ***** Total Tests with repeat: 60 Total Passed: 58 Total Failed: 2 Total Skipped: 0 *****************************

sagar-qa007 · 2024-12-09T11:15:16Z

/ci-test-limit-count run_count=20 runId=12232063661

github-actions · 2024-12-09T11:15:46Z

Tests running at: https://github.com/appsmithorg/appsmith/actions/runs/12234477030.
Cypress dashboard
PR: #38039.

github-actions · 2024-12-09T11:56:59Z

Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/12234477030.
Cypress dashboard url: Click here!
All cypress tests have passed 🎉🎉🎉

***** Repeat Run Summary ***** Total Tests with repeat: 60 Total Passed: 58 Total Failed: 2 Total Skipped: 0 *****************************

sagar-qa007 · 2024-12-09T12:08:46Z

/ci-test-limit-count run_count=30 runId=12232063661

github-actions · 2024-12-09T12:09:20Z

Tests running at: https://github.com/appsmithorg/appsmith/actions/runs/12235316304.
Cypress dashboard
PR: #38039.

github-actions · 2024-12-09T13:04:32Z

Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/12235316304.
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: 90 Total Passed: 90 Total Failed: 0 Total Skipped: 0 *****************************

NandanAnantharamu

Lgtm

## Description > [!TIP] > _Add a TL;DR when the description is longer than 500 words or extremely technical (helps the content, marketing, and DevRel team)._ > > _Please also include relevant motivation and context. List any dependencies that are required for this change. Add links to Notion, Figma or any other documents that might be relevant to the PR._ 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.Iframe" ### 🔍 Cypress test results  > [!TIP] > 🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉 > Workflow run: <https://github.com/appsmithorg/appsmith/actions/runs/12236274208> > Commit: 7bd2b6a > <a href="https://internal.appsmith.com/app/cypress-dashboard/rundetails-65890b3c81d7400d08fa9ee5?branch=master&workflowId=12236274208&attempt=1" target="_blank">Cypress dashboard</a>. > Tags: `@tag.Iframe` > Spec: > <hr>Mon, 09 Dec 2024 13:30:29 UTC  ## Communication Should the DevRel and Marketing teams inform users about this change? - [ ] Yes - [x] No  ## Summary by CodeRabbit - **Bug Fixes** - Improved the Iframe widget test by ensuring button clicks can proceed under all conditions. - Enhanced entity context management during URL property updates in tests. - **Tests** - Updated test specification to include the Iframe widget test, replacing the previous fork template entry. - Adjusted visibility assertion to use conditional waits in the Iframe widget tests. - **Style** - Modified CSS selector spacing in the CommonLocators to improve element targeting.

Fix iframe test case for clicking iframe

1c37445

sagar-qa007 requested a review from ApekshaBhosale as a code owner December 9, 2024 08:43

github-actions bot added the Bug Something isn't working label Dec 9, 2024

sagar-qa007 added the ok-to-test Required label for CI label Dec 9, 2024

sagar-qa007 requested a review from NandanAnantharamu December 9, 2024 08:43

coderabbitai bot reviewed Dec 9, 2024

View reviewed changes

sagar-qa007 changed the title ~~fix: Fix iframe test case for clicking iframe~~ fix: Fix iframe and widget test case for clicking and DB column update Dec 9, 2024

Update

ce63e8c

sagar-qa007 changed the title ~~fix: Fix iframe and widget test case for clicking and DB column update~~ fix: Fix iframe and widget test case for clicking Dec 9, 2024

Minor update

ef472e3

Fix for very rare failure

14886c2

Reverted limit text file

7bd2b6a

NandanAnantharamu approved these changes Dec 9, 2024

View reviewed changes

sagar-qa007 merged commit ab06288 into release Dec 9, 2024
42 checks passed

sagar-qa007 deleted the fix/iframewfailuresnew branch December 9, 2024 13:30

coderabbitai bot mentioned this pull request Dec 11, 2024

fix: Fix for the embedded case #38101

Merged

2 tasks

This was referenced Dec 16, 2024

test: Admin setting test cases #38172

Merged

fix: Updated fix for embedSettings spec #38195

Merged

This was referenced Jan 8, 2025

test: Admin setting new test cases with email #38522

Open

test: adding test for page functionality #38538

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: Fix iframe and widget test case for clicking #38039

fix: Fix iframe and widget test case for clicking #38039

sagar-qa007 commented Dec 9, 2024 •

edited by github-actions bot

Loading

coderabbitai bot commented Dec 9, 2024 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

sagar-qa007 commented Dec 9, 2024

coderabbitai bot left a comment

coderabbitai bot Dec 9, 2024

sagar-qa007 commented Dec 9, 2024

github-actions bot commented Dec 9, 2024

github-actions bot commented Dec 9, 2024

sagar-qa007 commented Dec 9, 2024

github-actions bot commented Dec 9, 2024

github-actions bot commented Dec 9, 2024

sagar-qa007 commented Dec 9, 2024

github-actions bot commented Dec 9, 2024

github-actions bot commented Dec 9, 2024

sagar-qa007 commented Dec 9, 2024

github-actions bot commented Dec 9, 2024

github-actions bot commented Dec 9, 2024

sagar-qa007 commented Dec 9, 2024

github-actions bot commented Dec 9, 2024

github-actions bot commented Dec 9, 2024

NandanAnantharamu left a comment

fix: Fix iframe and widget test case for clicking #38039

fix: Fix iframe and widget test case for clicking #38039

Conversation

sagar-qa007 commented Dec 9, 2024 • edited by github-actions bot Loading

Description

Automation

🔍 Cypress test results

Communication

Summary by CodeRabbit

coderabbitai bot commented Dec 9, 2024 • edited Loading

Walkthrough

Changes

Possibly related PRs

Suggested labels

Suggested reviewers

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

sagar-qa007 commented Dec 9, 2024

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot Dec 9, 2024

Choose a reason for hiding this comment

sagar-qa007 commented Dec 9, 2024

github-actions bot commented Dec 9, 2024

github-actions bot commented Dec 9, 2024

sagar-qa007 commented Dec 9, 2024

github-actions bot commented Dec 9, 2024

github-actions bot commented Dec 9, 2024

sagar-qa007 commented Dec 9, 2024

github-actions bot commented Dec 9, 2024

github-actions bot commented Dec 9, 2024

sagar-qa007 commented Dec 9, 2024

github-actions bot commented Dec 9, 2024

github-actions bot commented Dec 9, 2024

sagar-qa007 commented Dec 9, 2024

github-actions bot commented Dec 9, 2024

github-actions bot commented Dec 9, 2024

NandanAnantharamu left a comment

Choose a reason for hiding this comment

sagar-qa007 commented Dec 9, 2024 •

edited by github-actions bot

Loading

coderabbitai bot commented Dec 9, 2024 •

edited

Loading