Skip to content

fix: Fix flakiness of JSObjects_navigation_spec.ts spec#39269

Merged
shadabbuchh merged 1 commit intoreleasefrom
fix/JSObjects_navigation_specFlakiness
Feb 14, 2025
Merged

fix: Fix flakiness of JSObjects_navigation_spec.ts spec#39269
shadabbuchh merged 1 commit intoreleasefrom
fix/JSObjects_navigation_specFlakiness

Conversation

@shadabbuchh
Copy link
Contributor

@shadabbuchh shadabbuchh commented Feb 14, 2025

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 #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.Sanity
Spec:


Fri, 14 Feb 2025 09:51:57 UTC

Communication

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

  • Yes
  • No

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.

- Switch to full screen before creating JS Object in TC 3
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 14, 2025

Walkthrough

The 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

File Change Summary
app/client/cypress/e2e/Regression/ClientSide/Debugger/JSObjects_navigation_spec.ts - Deletion Confirmation: Added agHelper.WaitUntilToastDisappear("JSObject1 deleted successfully"); to wait for a success toast after deletion.
- Screen Mode Adjustment: Inserted EditorNavigation.SwitchScreenMode(EditorViewMode.FullScreen); before JS object creation.
- Test Identifier Update: Changed test ID from "2." to "3." for Bug 24990.

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
Loading

Possibly related PRs

Suggested labels

Bug, ok-to-test, Test

Suggested reviewers

  • ApekshaBhosale
  • NandanAnantharamu
  • sagar-qa007

Poem

In our code realm, where tests take flight,
A toast appears to mark deletion right.
Full screen now guides our scripted dream,
Bug IDs aligned like a well-tuned team.
Code dances on—bright and light!
🎉🐱‍💻

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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>, 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 Automation Test Cypress flaky tests Test scripts that need to be fixed on Cypress by dev or SDET cypress-flaky-fix This label is auto-added when a PR which only has Cypress fixes are merged to release QA Pod Issues under the QA Pod Task A simple Todo Bug Something isn't working labels Feb 14, 2025
@shadabbuchh
Copy link
Contributor Author

/ci-test-limit-count run_count=50 update_snapshot=true specs_to_run=cypress/e2e/Regression/ClientSide/Debugger/JSObjects_navigation_spec.ts

@github-actions
Copy link

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

🧹 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

📥 Commits

Reviewing files that changed from the base of the PR and between 400f894 and 1e5af61.

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

@github-actions
Copy link

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

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

@shadabbuchh shadabbuchh added the ok-to-test Required label for CI label Feb 14, 2025
@shadabbuchh shadabbuchh merged commit 2e73bfe into release Feb 14, 2025
51 checks passed
@shadabbuchh shadabbuchh deleted the fix/JSObjects_navigation_specFlakiness branch February 14, 2025 11:27
github-actions bot pushed a commit to Zeral-Zhang/appsmith that referenced this pull request Apr 12, 2025
…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 -->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Automation Test Bug Something isn't working Cypress flaky tests Test scripts that need to be fixed on Cypress by dev or SDET cypress-flaky-fix This label is auto-added when a PR which only has Cypress fixes are merged to release ok-to-test Required label for CI QA Pod Issues under the QA Pod Task A simple Todo

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Task]: Fix flakiness of JSObjects_navigation_spec.ts spec

2 participants