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

fix: Checking fix working for js indent failure #38382

Merged
merged 2 commits into from
Dec 27, 2024

Conversation

sagar-qa007
Copy link
Contributor

@sagar-qa007 sagar-qa007 commented Dec 26, 2024

Description

Snapshot update

Fixes # https://app.zenhub.com/workspaces/stability-pod-6690c4814e31602e25cab7fd/issues/gh/appsmithorg/appsmith/38383

Automation

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

🔍 Cypress test results

Tip

🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/12507108172
Commit: 2b95b2e
Cypress dashboard.
Tags: @tag.Visual
Spec:


Thu, 26 Dec 2024 18:51:05 UTC

Communication

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

  • Yes
  • No

Summary by CodeRabbit

  • New Features

    • Added a comment line to the test suite for clarity.
    • Updated the limited tests configuration to include a new test file.
  • Bug Fixes

    • No bug fixes were made in this release.
  • Documentation

    • Improved documentation within the test suite for better understanding.

Copy link
Contributor

coderabbitai bot commented Dec 26, 2024

Important

Review skipped

Review was skipped due to path filters

⛔ Files ignored due to path filters (1)
  • app/client/cypress/snapshots/Regression/ClientSide/VisualTests/JSEditorIndent_spec.js/formattedJSONBodyAfterSave.snap.png is excluded by !**/*.png

CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including **/dist/** will override the default block on the dist directory, by removing the pattern from both the lists.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

This pull request involves a minor modification to a Cypress test file and an update to the limited tests configuration. A comment was added to the JSEditorIndent_spec.js test file, and the limited-tests.txt file was updated to reference this specific test file instead of the previous Fork_Template_spec.js.

Changes

File Change Summary
app/client/cypress/e2e/VisualTests/JSEditorIndent_spec.js Added a single comment line //test comment
app/client/cypress/limited-tests.txt Replaced test file reference from Fork_Template_spec.js to JSEditorIndent_spec.js

Possibly related PRs

Suggested Labels

skip-changelog, ok-to-test

Suggested Reviewers

  • NandanAnantharamu

Poem

A tiny comment, a test file's delight,
In Cypress's realm, a playful byte
Limited tests, now rerouted with care
A subtle change, beyond compare! 🧪✨


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

@sagar-qa007
Copy link
Contributor Author

/ci-test-limit-count run_count=1 update_snapshot=false specs_to_run=cypress/e2e/Regression/ClientSide/VisualTests/JSEditorIndent_spec.js runId=12503879298

@sagar-qa007
Copy link
Contributor Author

/ci-test-limit-count run_count=1 runId=12503879298

Copy link

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: 1

🧹 Nitpick comments (1)
app/client/cypress/limited-tests.txt (1)

Line range hint 1-6: Consider documenting the test selection criteria.

The file would benefit from a brief comment explaining why this specific test was chosen for limited testing.

Add a comment like:

 # To run only limited tests - give the spec names in below format:
+# Selected JSEditorIndent_spec.js for visual regression testing of editor indentation
 cypress/e2e/Regression/ClientSide/VisualTests/JSEditorIndent_spec.js
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 6905aa9 and 05e7c6d.

📒 Files selected for processing (2)
  • app/client/cypress/e2e/Regression/ClientSide/VisualTests/JSEditorIndent_spec.js (1 hunks)
  • app/client/cypress/limited-tests.txt (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • app/client/cypress/e2e/Regression/ClientSide/VisualTests/JSEditorIndent_spec.js
🧰 Additional context used
📓 Path-based instructions (1)
app/client/cypress/limited-tests.txt (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.

@@ -1,5 +1,5 @@
# To run only limited tests - give the spec names in below format:
cypress/e2e/Regression/ClientSide/Templates/Fork_Template_spec.js
cypress/e2e/Regression/ClientSide/VisualTests/JSEditorIndent_spec.js
Copy link
Contributor

Choose a reason for hiding this comment

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

💡 Codebase verification

Consider optimizing test performance by replacing Sleep calls

The test file exists and is properly structured, but it contains multiple agHelper.Sleep() calls which can make tests slower and flakier. Consider replacing these with Cypress's built-in automatic retry-ability and waiting mechanisms.

  • Replace agHelper.Sleep() calls in app/client/cypress/e2e/Regression/ClientSide/VisualTests/JSEditorIndent_spec.js with more reliable alternatives:
    • For UI changes, use cy.should('be.visible') or other assertions
    • For network requests, use cy.wait('@aliasName')
    • For DOM changes, use cy.should() with appropriate assertions
🔗 Analysis chain

Verify the new test specification file.

Let's ensure the new test file exists and is appropriate for limited testing.


Let me verify the content of the test file since the path seems to be different from what we initially tried.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the existence and content of the new test file

# Check if the new test file exists
fd "JSEditorIndent_spec.js" --type f

# Check the content of the test file for potential it.only or similar limiting patterns
rg -A 2 "it\.only|describe\.only|context\.only" "cypress/e2e/Regression/ClientSide/VisualTests/JSEditorIndent_spec.js" || echo "No .only found (good)"

# Check for sleep/wait usage which should be avoided
rg "cy\.wait|cy\.pause|agHelper\.sleep|\.Sleep" "cypress/e2e/Regression/ClientSide/VisualTests/JSEditorIndent_spec.js" || echo "No problematic wait/sleep patterns found (good)"

Length of output: 730


Script:

#!/bin/bash
# Check the content of the test file at the correct path
rg -A 2 "it\.only|describe\.only|context\.only" "app/client/cypress/e2e/Regression/ClientSide/VisualTests/JSEditorIndent_spec.js" || echo "No .only found (good)"

# Check for sleep/wait usage which should be avoided
rg "cy\.wait|cy\.pause|agHelper\.sleep|\.Sleep" "app/client/cypress/e2e/Regression/ClientSide/VisualTests/JSEditorIndent_spec.js" || echo "No problematic wait/sleep patterns found (good)"

# Get a glimpse of the test content
head -n 20 "app/client/cypress/e2e/Regression/ClientSide/VisualTests/JSEditorIndent_spec.js"

Length of output: 1392

@sagar-qa007
Copy link
Contributor Author

/ci-test-limit-count run_count=1 update_snapshot=true specs_to_run=cypress/e2e/Regression/ClientSide/VisualTests/JSEditorIndent_spec.js runId=12503879298

Copy link

Copy link

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

***** Repeat Run Summary ***** Total Tests with repeat: 8 Total Passed: 7 Total Failed: 1 Total Skipped: 0 *****************************

Copy link

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

***** Repeat Run Summary ***** Total Tests with repeat: 8 Total Passed: 7 Total Failed: 1 Total Skipped: 0 *****************************

Copy link

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

@sagar-qa007 sagar-qa007 added the ok-to-test Required label for CI label Dec 26, 2024
@sagar-qa007 sagar-qa007 changed the title DNM: Checking failure DNM: Checking fix working for js indent failure Dec 26, 2024
@sagar-qa007
Copy link
Contributor Author

/ci-test-limit-count run_count=1 update_snapshot=false specs_to_run=cypress/e2e/Regression/ClientSide/VisualTests/JSEditorIndent_spec.js runId=12503879298

Copy link

@sagar-qa007 sagar-qa007 changed the title DNM: Checking fix working for js indent failure fix: Checking fix working for js indent failure Dec 26, 2024
@github-actions github-actions bot added the Bug Something isn't working label Dec 26, 2024
Copy link

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

@sagar-qa007 sagar-qa007 merged commit 542814a into release Dec 27, 2024
55 checks passed
@sagar-qa007 sagar-qa007 deleted the fix/JSEditorIndent_specsnap branch December 27, 2024 03:13
NandanAnantharamu pushed a commit that referenced this pull request Dec 27, 2024
## Description
Snapshot update


Fixes #
https://app.zenhub.com/workspaces/stability-pod-6690c4814e31602e25cab7fd/issues/gh/appsmithorg/appsmith/38383

## Automation

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

### 🔍 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/12507108172>
> Commit: 2b95b2e
> <a
href="https://internal.appsmith.com/app/cypress-dashboard/rundetails-65890b3c81d7400d08fa9ee5?branch=master&workflowId=12507108172&attempt=1"
target="_blank">Cypress dashboard</a>.
> Tags: `@tag.Visual`
> Spec:
> <hr>Thu, 26 Dec 2024 18:51:05 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

- **New Features**
	- Added a comment line to the test suite for clarity.
	- Updated the limited tests configuration to include a new test file.

- **Bug Fixes**
	- No bug fixes were made in this release. 

- **Documentation**
- Improved documentation within the test suite for better understanding.

<!-- 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