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

chore: Updated the mockdb code #38603

Merged
merged 1 commit into from
Jan 13, 2025
Merged

Conversation

sagar-qa007
Copy link
Contributor

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

Description

We have identified that the mock database is accessible to multiple stakeholders, increasing the risk of data corruption. To address this, we have commented out unnecessary and potentially flaky test code to ensure stability and reliability.

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

Automation

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

🔍 Cypress test results

Tip

🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/12743407394
Commit: f74f769
Cypress dashboard.
Tags: @tag.Datasource
Spec:


Mon, 13 Jan 2025 09:51:58 UTC

Communication

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

  • Yes
  • No

Summary by CodeRabbit

  • Tests
    • Modified Cypress test for Mock Databases by removing specific query count and response verification assertions.

@sagar-qa007 sagar-qa007 added the ok-to-test Required label for CI label Jan 13, 2025
Copy link
Contributor

coderabbitai bot commented Jan 13, 2025

Walkthrough

The pull request involves modifications to the Cypress end-to-end test specification for Mock Databases, specifically in the MockDBs_Spec.ts file. The changes primarily consist of commenting out assertions related to query count verification for Mock Postgres and Mock Mongo databases. These modifications remove specific validation checks that previously confirmed the expected number of queries and their responses in the application.

Changes

File Change Summary
app/client/cypress/e2e/Sanity/Datasources/MockDBs_Spec.ts Commented out assertions for query count and response verification in mock database tests

Possibly related issues

Possibly related PRs

Suggested labels

skip-changelog

Suggested reviewers

  • ApekshaBhosale
  • NandanAnantharamu

Poem

🧪 Cypress tests, once strict and bold
Assertions now rest, their story untold
Mock databases whisper, "Count me not"
Silence replaces what validation sought
Test magic fades, yet code marches on! 🚀

Finishing Touches

  • 📝 Generate Docstrings (Beta)

🪧 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 skip-changelog Adding this label to a PR prevents it from being listed in the changelog label Jan 13, 2025
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: 2

🔭 Outside diff range comments (1)
app/client/cypress/e2e/Sanity/Datasources/MockDBs_Spec.ts (1)

Line range hint 85-89: Remove explicit sleep and use proper wait conditions

The use of agHelper.Sleep(500) violates the coding guidelines. Replace with appropriate wait conditions.

-        agHelper.Sleep(500);
+        cy.waitUntil(() => 
+          cy.get('@getDatasourceStructure').then((xhr) => 
+            xhr.response?.statusCode === 200
+          )
+        );
🧹 Nitpick comments (1)
app/client/cypress/e2e/Sanity/Datasources/MockDBs_Spec.ts (1)

Line range hint 1-101: Reconsider the approach to handling flaky tests

While commenting out flaky tests temporarily solves stability issues, it reduces test coverage. Consider:

  1. Using API-level assertions instead of UI-dependent checks
  2. Implementing retry mechanisms for potentially unstable operations
  3. Following Cypress best practices for async operations

Would you like me to provide examples of implementing these patterns?

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between f8784fc and f74f769.

📒 Files selected for processing (1)
  • app/client/cypress/e2e/Sanity/Datasources/MockDBs_Spec.ts (2 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
app/client/cypress/e2e/Sanity/Datasources/MockDBs_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 (7)
  • GitHub Check: perform-test / client-build / client-build
  • GitHub Check: perform-test / server-build / server-unit-tests
  • GitHub Check: perform-test / rts-build / build
  • GitHub Check: client-unit-tests / client-unit-tests
  • GitHub Check: client-build / client-build
  • GitHub Check: client-lint / client-lint
  • GitHub Check: client-prettier / prettier-check

Copy link
Collaborator

@NandanAnantharamu NandanAnantharamu left a comment

Choose a reason for hiding this comment

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

Lgtm

@sagar-qa007 sagar-qa007 merged commit 97ebfaa into release Jan 13, 2025
47 checks passed
@sagar-qa007 sagar-qa007 deleted the chore/mockdbflakystepsremove branch January 13, 2025 10:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ok-to-test Required label for CI skip-changelog Adding this label to a PR prevents it from being listed in the changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants