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: console log update and fix modal issue #38692

Open
wants to merge 7 commits into
base: release
Choose a base branch
from

Conversation

sagar-qa007
Copy link
Contributor

@sagar-qa007 sagar-qa007 commented Jan 16, 2025

Description

Fix the issue for modal and remove unwanted logs.

Fixes # https://app.zenhub.com/workspaces/qa-63316faf86bb2e170ed2e46b/issues/gh/appsmithorg/appsmith/38729

Automation

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

🔍 Cypress test results

Tip

🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/12843319044
Commit: 8cd4512
Cypress dashboard.
Tags: @tag.JS
Spec:


Sat, 18 Jan 2025 18:43:41 UTC

Communication

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

  • Yes
  • No

Summary by CodeRabbit

Summary by CodeRabbit

  • Tests
    • Improved test reliability by adding page reload and modal visibility checks in end-to-end testing.
    • Increased timeout for sidebar visibility checks to accommodate varying load times.
    • Removed unnecessary console log statements to clean up test output across various test cases.
    • Verified download functionality with various scenarios, ensuring appropriate error messages are displayed.
    • Streamlined tests for local storage operations by removing debug output.
    • Cleaned up test output for show alert functions by removing debug log statements.

Copy link
Contributor

coderabbitai bot commented Jan 16, 2025

Walkthrough

The pull request modifies several Cypress end-to-end test specifications for client-side action execution. Key changes include the addition of the assertHelper import for enhanced assertion capabilities and the inclusion of agHelper.WaitUntilEleAppear(locators._modalWrapper); to ensure the modal wrapper is present before further assertions. Additionally, unnecessary console log statements have been removed for cleaner output. The updates also involve adjusting timeout configurations in the Sidebar class, allowing for more flexible handling of visibility assertions.

Changes

File Change Summary
app/client/cypress/e2e/Regression/ClientSide/ActionExecution/FrameworkFunctions_ShowCloseModalFunctions_spec.ts - Added assertHelper import
- Added agHelper.WaitUntilEleAppear(locators._modalWrapper); after page reload
- Removed console log statements
app/client/cypress/e2e/Regression/ClientSide/ActionExecution/FrameworkFunctions_NavigateToFunctions_spec.ts - Added homePage and debuggerHelper imports
- Added agHelper.CypressReload() before waiting for debugger icon
- Removed console log statements
app/client/cypress/support/Pages/IDE/Sidebar.ts - Updated navigate method to include dynamic timeout
- Increased default timeout in assertVisible method from 10000 to 60000 milliseconds
app/client/cypress/e2e/Regression/ClientSide/ActionExecution/FrameworkFunctions_DownloadFunctions_spec.ts - Removed console log statements
app/client/cypress/e2e/Regression/ClientSide/ActionExecution/FrameworkFunctions_LocalRemoveValueFunctions_spec.ts - Removed console log statements
app/client/cypress/e2e/Regression/ClientSide/ActionExecution/FrameworkFunctions_LocalStoreValueFunctions_spec.ts - Removed console log statements
app/client/cypress/e2e/Regression/ClientSide/ActionExecution/FrameworkFunctions_ShowAlertFunctions_spec.ts - Removed console log statements

Possibly related PRs

Suggested labels

Task

Suggested reviewers

  • ApekshaBhosale
  • NandanAnantharamu

Poem

🧪 In the realm of tests, a reload we greet,
Modal now visible, a victory sweet.
Logs are now silent, clarity reigns,
With assertions in place, no room for pains.
🚀 Cypress dances, as tests take their flight,
In the world of code, everything feels right!


📜 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 5836c9e and 8cd4512.

📒 Files selected for processing (1)
  • app/client/cypress/e2e/Regression/ClientSide/ActionExecution/FrameworkFunctions_NavigateToFunctions_spec.ts (3 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • app/client/cypress/e2e/Regression/ClientSide/ActionExecution/FrameworkFunctions_NavigateToFunctions_spec.ts
⏰ Context from checks skipped due to timeout of 90000ms (7)
  • GitHub Check: perform-test / rts-build / build
  • GitHub Check: perform-test / client-build / client-build
  • GitHub Check: perform-test / server-build / server-unit-tests
  • GitHub Check: client-lint / client-lint
  • GitHub Check: client-unit-tests / client-unit-tests
  • 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 Jan 16, 2025
@sagar-qa007
Copy link
Contributor Author

/ci-test-limit-count run_count=20 update_snapshot=false specs_to_run=cypress/e2e/Regression/ClientSide/ActionExecution/FrameworkFunctions_ShowCloseModalFunctions_spec.ts,

@sagar-qa007
Copy link
Contributor Author

/ci-test-limit-count run_count=20 update_snapshot=false specs_to_run=cypress/e2e/Regression/ClientSide/ActionExecution/FrameworkFunctions_ShowCloseModalFunctions_spec.ts,cypress/e2e/Regression/ClientSide/ActionExecution/FrameworkFunctions_NavigateToFunctions_spec.ts

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/e2e/Regression/ClientSide/ActionExecution/FrameworkFunctions_ShowCloseModalFunctions_spec.ts (1)

Line range hint 1-200: Consider enhancing test reliability and maintainability.

While the overall test structure is good, consider these improvements:

  1. Add data-cy attributes to modal elements for better selector stability
  2. Consider extracting common modal verification steps into a custom command
  3. Group related assertions using expect() for better error reporting

Example custom command:

// In commands.ts
Cypress.Commands.add('verifyModalState', (isVisible: boolean) => {
  if (isVisible) {
    agHelper.AssertElementVisibility(locators._modalWrapper);
    cy.get(locators._modalButtonText).should(($els) => {
      expect($els.eq(1)).to.contain('Confirm');
      expect($els.eq(0)).to.contain('Close');
    });
  } else {
    agHelper.AssertElementAbsence(locators._modalWrapper);
  }
});
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 2b8ba77 and c37faba.

📒 Files selected for processing (1)
  • app/client/cypress/e2e/Regression/ClientSide/ActionExecution/FrameworkFunctions_ShowCloseModalFunctions_spec.ts (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
app/client/cypress/e2e/Regression/ClientSide/ActionExecution/FrameworkFunctions_ShowCloseModalFunctions_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.
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: client-unit-tests / client-unit-tests
  • GitHub Check: client-build / client-build
🔇 Additional comments (1)
app/client/cypress/e2e/Regression/ClientSide/ActionExecution/FrameworkFunctions_ShowCloseModalFunctions_spec.ts (1)

70-70: LGTM! Good addition of explicit wait.

The addition of WaitUntilEleAppear improves test reliability by ensuring the modal is visible before proceeding with assertions.

Comment on lines 68 to 69
cy.reload();
agHelper.RefreshPage();
Copy link
Contributor

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Remove redundant page reload calls.

The code has both cy.reload() and agHelper.RefreshPage() consecutively, which is redundant. Choose one method consistently throughout the test suite.

-      cy.reload();
       agHelper.RefreshPage();
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
cy.reload();
agHelper.RefreshPage();
agHelper.RefreshPage();

@sagar-qa007
Copy link
Contributor Author

/ci-test-limit-count run_count=20 update_snapshot=false specs_to_run=cypress/e2e/Regression/ClientSide/ActionExecution/FrameworkFunctions_ShowCloseModalFunctions_spec.ts,cypress/e2e/Regression/ClientSide/ActionExecution/FrameworkFunctions_NavigateToFunctions_spec.ts

Copy link

@sagar-qa007
Copy link
Contributor Author

/ci-test-limit-count run_count=1 update_snapshot=false specs_to_run=cypress/e2e/Regression/ClientSide/ActionExecution/FrameworkFunctions_ShowCloseModalFunctions_spec.ts,cypress/e2e/Regression/ClientSide/ActionExecution/FrameworkFunctions_NavigateToFunctions_spec.ts runId=12807676303

Copy link

Copy link

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

***** Repeat Run Summary ***** Total Tests with repeat: 8 Total Passed: 6 Total Failed: 2 Total Skipped: 0 *****************************

@sagar-qa007
Copy link
Contributor Author

/ci-test-limit-count run_count=5 update_snapshot=false specs_to_run=cypress/e2e/Regression/ClientSide/ActionExecution/FrameworkFunctions_ShowCloseModalFunctions_spec.ts,cypress/e2e/Regression/ClientSide/ActionExecution/FrameworkFunctions_NavigateToFunctions_spec.ts runId=12807676303

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

🔭 Outside diff range comments (1)
app/client/cypress/e2e/Regression/ClientSide/ActionExecution/FrameworkFunctions_NavigateToFunctions_spec.ts (1)

Line range hint 144-145: Remove console.log statements

Remove debug console.log statements to keep test output clean.

- console.log("Mera variable: ", jsObjectName);

Also applies to: 232-233

🧹 Nitpick comments (2)
app/client/cypress/support/Pages/IDE/Sidebar.ts (1)

25-27: Consider using Cypress config for default timeout

Instead of hardcoding the 60000ms timeout, consider using Cypress.config().defaultCommandTimeout for better maintainability.

- assertVisible(timeout: number = 60000) {
+ assertVisible(timeout: number = Cypress.config().defaultCommandTimeout) {
    cy.get(this.locators.sidebar, { timeout }).should("be.visible");
  }
app/client/cypress/e2e/Regression/ClientSide/ActionExecution/FrameworkFunctions_NavigateToFunctions_spec.ts (1)

Line range hint 189-193: Consider moving URLs to constants

Extract hardcoded URLs like 'https://www.google.com/' to a constants file for better maintainability.

// Add to a constants file
export const TEST_URLS = {
  THIRD_PARTY: 'https://www.google.com/',
};
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between c37faba and fb3a912.

📒 Files selected for processing (2)
  • app/client/cypress/e2e/Regression/ClientSide/ActionExecution/FrameworkFunctions_NavigateToFunctions_spec.ts (2 hunks)
  • app/client/cypress/support/Pages/IDE/Sidebar.ts (2 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
app/client/cypress/support/Pages/IDE/Sidebar.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.
app/client/cypress/e2e/Regression/ClientSide/ActionExecution/FrameworkFunctions_NavigateToFunctions_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.
⏰ 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 (3)
app/client/cypress/support/Pages/IDE/Sidebar.ts (1)

13-13: Good use of configurable timeout!

Using Cypress.config().pageLoadTimeout instead of a hardcoded value allows for better test configuration management.

app/client/cypress/e2e/Regression/ClientSide/ActionExecution/FrameworkFunctions_NavigateToFunctions_spec.ts (2)

4-4: Good addition of assertHelper!

Adding network response assertions improves test reliability.


184-184: Network assertion placement is appropriate

Good practice to verify network response before proceeding with navigation tests.

Copy link

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

***** Repeat Run Summary ***** Total Tests with repeat: 40 Total Passed: 32 Total Failed: 8 Total Skipped: 0 *****************************

@sagar-qa007
Copy link
Contributor Author

/ci-test-limit-count run_count=5 update_snapshot=false specs_to_run=cypress/e2e/Regression/ClientSide/ActionExecution/FrameworkFunctions_ShowCloseModalFunctions_spec.ts runId=12807676303

Copy link

Copy link

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

***** Repeat Run Summary ***** Total Tests with repeat: 160 Total Passed: 147 Total Failed: 13 Total Skipped: 0 *****************************

Copy link

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

***** Repeat Run Summary ***** Total Tests with repeat: 20 Total Passed: 19 Total Failed: 1 Total Skipped: 0 *****************************

@sagar-qa007
Copy link
Contributor Author

/ci-test-limit-count run_count=20 update_snapshot=false specs_to_run=cypress/e2e/Regression/ClientSide/ActionExecution/FrameworkFunctions_ShowCloseModalFunctions_spec.ts runId=12807676303

Copy link

Copy link

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

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

@sagar-qa007
Copy link
Contributor Author

/ci-test-limit-count run_count=20 update_snapshot=false specs_to_run=cypress/e2e/Regression/ClientSide/ActionExecution/FrameworkFunctions_ShowCloseModalFunctions_spec.ts runId=12812720179

Copy link

@sagar-qa007 sagar-qa007 added the ok-to-test Required label for CI label Jan 17, 2025
@sagar-qa007 sagar-qa007 changed the title fix: console log update fix: console log update and fix modal issue Jan 17, 2025
Copy link

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

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

@sagar-qa007
Copy link
Contributor Author

/ci-test-limit-count run_count=20 update_snapshot=false specs_to_run=cypress/e2e/Regression/ClientSide/ActionExecution/FrameworkFunctions_ShowCloseModalFunctions_spec.ts

@sagar-qa007
Copy link
Contributor Author

/ci-test-limit-count run_count=5 update_snapshot=false specs_to_run=cypress/e2e/Regression/ClientSide/ActionExecution/FrameworkFunctions_NavigateToFunctions_spec.ts

Copy link

Copy link

Copy link

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

***** Repeat Run Summary ***** Total Tests with repeat: 20 Total Passed: 14 Total Failed: 6 Total Skipped: 0 *****************************

Copy link

Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/12832964544.
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
Copy link
Contributor Author

/ci-test-limit-count run_count=25 update_snapshot=false specs_to_run=cypress/e2e/Regression/ClientSide/ActionExecution/FrameworkFunctions_NavigateToFunctions_spec.ts

Copy link

Copy link

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

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