fix: Fix flakiness of JSObjects_navigation_spec.ts spec#39269
fix: Fix flakiness of JSObjects_navigation_spec.ts spec#39269shadabbuchh merged 1 commit intoreleasefrom
Conversation
- Switch to full screen before creating JS Object in TC 3
WalkthroughThe changes update the Cypress test suite for JSObjects by adding a confirmation step for JS object deletion, switching the screen mode to full screen before object creation, and updating the test identifier from "2" to "3". These modifications enhance test robustness by ensuring the environment is correctly set and verifying that operations complete as expected. Changes
Sequence Diagram(s)sequenceDiagram
participant T as Test Runner
participant Ag as agHelper
participant ED as EditorNavigation
T->>Ag: Delete JS object "JSObject1"
Ag-->>T: Show toast "JSObject1 deleted successfully"
T->>ED: Switch to FullScreen Mode
T->>T: Create JS Object in FullScreen
Possibly related PRs
Suggested labels
Suggested reviewers
Poem
✨ Finishing Touches
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
Documentation and Community
|
|
/ci-test-limit-count run_count=50 update_snapshot=true specs_to_run=cypress/e2e/Regression/ClientSide/Debugger/JSObjects_navigation_spec.ts |
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
app/client/cypress/e2e/Regression/ClientSide/Debugger/JSObjects_navigation_spec.ts (1)
89-89: Good defensive programming.Switching to full screen mode before creating JS object prevents failures in split screen mode.
However, consider adding a comment explaining why this is necessary to help future maintainers:
- EditorNavigation.SwitchScreenMode(EditorViewMode.FullScreen); // Switching back to full screen as CreateJSObject() was failing in split screen mode + // Switch to full screen mode to prevent JS object creation failures that occur in split screen mode + EditorNavigation.SwitchScreenMode(EditorViewMode.FullScreen);
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
app/client/cypress/e2e/Regression/ClientSide/Debugger/JSObjects_navigation_spec.ts(2 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`app/client/cypress/**/**.*`: Review the following e2e test ...
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.
app/client/cypress/e2e/Regression/ClientSide/Debugger/JSObjects_navigation_spec.ts
⏰ Context from checks skipped due to timeout of 90000ms (4)
- GitHub Check: client-lint / client-lint
- GitHub Check: client-build / client-build
- GitHub Check: client-unit-tests / client-unit-tests
- GitHub Check: client-prettier / prettier-check
🔇 Additional comments (2)
app/client/cypress/e2e/Regression/ClientSide/Debugger/JSObjects_navigation_spec.ts (2)
74-74: Good addition of deletion confirmation.Adding the toast wait helps prevent race conditions and makes the test more reliable.
77-77: Test identifier updated correctly.The test case number has been updated from 2 to 3.
|
Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/13324441604. |
…39269) ## Description This PR fixes the flakiness of `cypress/e2e/Regression/ClientSide/Debugger/JSObjects_navigation_spec.ts` by making the following improvements: 1. Adding an assertion to verify the deletion of a JS Object in the second test case. 2. Switching to full-screen mode before creating a JS Object in the third test case. Fixes appsmithorg#39267 ## Automation /ok-to-test tags="@tag.JS, @tag.Sanity" ### 🔍 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/13325804763> > Commit: 1e5af61 > <a href="https://internal.appsmith.com/app/cypress-dashboard/rundetails-65890b3c81d7400d08fa9ee5?branch=master&workflowId=13325804763&attempt=1" target="_blank">Cypress dashboard</a>. > Tags: `@tag.JS, @tag.Sanity` > Spec: > <hr>Fri, 14 Feb 2025 09:51:57 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 deletion confirmation checks to ensure users see successful deletion notifications. - Improved test stability by enforcing the correct screen mode before creating new objects. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
Description
This PR fixes the flakiness of
cypress/e2e/Regression/ClientSide/Debugger/JSObjects_navigation_spec.tsby making the following improvements:Fixes #39267
Automation
/ok-to-test tags="@tag.JS, @tag.Sanity"
🔍 Cypress test results
Tip
🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/13325804763
Commit: 1e5af61
Cypress dashboard.
Tags:
@tag.JS, @tag.SanitySpec:
Fri, 14 Feb 2025 09:51:57 UTC
Communication
Should the DevRel and Marketing teams inform users about this change?
Summary by CodeRabbit