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: Fix the S3 error case #39240

Merged
merged 1 commit into from
Feb 13, 2025
Merged

fix: Fix the S3 error case #39240

merged 1 commit into from
Feb 13, 2025

Conversation

sagar-qa007
Copy link
Contributor

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

Description

Fix: Changed to aghelper functions and added check for remove all toast message.

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

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/13303544816
Commit: c4ff737
Cypress dashboard.
Tags: @tag.Datasource
Spec:


Thu, 13 Feb 2025 09:21:50 UTC

Communication

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

  • Yes
  • No

Summary by CodeRabbit

  • Tests

    • Enhanced automated testing for data page generation and user actions, ensuring smoother and more reliable interactions.
    • Improved handling of notifications for a more consistent application experience.
  • Refactor

    • Streamlined internal processes for managing data interactions, enhancing clarity and maintainability in testing routines.

Copy link
Contributor

coderabbitai bot commented Feb 13, 2025

Walkthrough

The changes refactor the Cypress test script for CRUD page generation by replacing direct Cypress commands with higher-level functions from the dataSources module. The test now uses dataSources.GeneratePageForDS, dataSources.TestDatasource(true), and dataSources.SaveDatasource() to encapsulate navigation and interaction logic. Additionally, the assertHelper is imported and calls to wait for all toast messages (agHelper.WaitUntilAllToastsDisappear()) are added. In the support file, property visibility for _testDs and _saveDs in the DataSources class is updated from private to public.

Changes

File/Path Change Summary
app/client/.../GenerateCRUD/S3_Spec.js Refactored tests: imported assertHelper, replaced cy.NavigateToDSGeneratePage with dataSources.GeneratePageForDS(datasourceName), replaced direct Cypress commands with dataSources.TestDatasource(true) and dataSources.SaveDatasource(), and added agHelper.WaitUntilAllToastsDisappear() calls.
app/client/.../Pages/DataSources.ts Updated property visibility: changed _testDs and _saveDs from private to public to allow external access.

Sequence Diagram(s)

sequenceDiagram
    participant Test as Cypress Test
    participant DS as dataSources Module
    participant agHelper as agHelper

    Test->>DS: GeneratePageForDS(datasourceName)
    Test->>DS: TestDatasource(true)
    DS->>agHelper: WaitUntilAllToastsDisappear()
    Test->>DS: SaveDatasource()
    DS->>agHelper: WaitUntilAllToastsDisappear()
Loading

Possibly related PRs

Suggested labels

Bug, ok-to-test, Test

Suggested reviewers

  • ApekshaBhosale
  • NandanAnantharamu

Poem

In the realm of tests so keen,
New functions make the flow serene.
Toasts vanish in a graceful dance,
As data sources now get their chance.
Code refined, our tests advance! 🚀

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

@sagar-qa007
Copy link
Contributor Author

/ci-test-limit-count run_count=50 update_snapshot=false specs_to_run=cypress/e2e/Regression/ServerSide/GenerateCRUD/S3_Spec.js

@github-actions github-actions bot added the Bug Something isn't working label Feb 13, 2025
@sagar-qa007 sagar-qa007 added the ok-to-test Required label for CI label Feb 13, 2025
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 (2)
app/client/cypress/e2e/Regression/ServerSide/GenerateCRUD/S3_Spec.js (2)

48-49: Good addition of toast wait, but consider using a more robust approach.

While waiting for toasts to disappear is good, consider using Cypress's built-in wait mechanisms or data-testid attributes for more reliable test synchronization.

-      agHelper.WaitUntilAllToastsDisappear();
+      cy.waitUntil(() => !cy.get('[data-testid="t--toast-container"]').should('not.exist'), {
+        timeout: 5000,
+        interval: 500,
+      });

133-138: Good addition of toast waits, but consolidate the operations.

The test and save operations with their respective toast waits could be combined into a single helper function for better maintainability.

-      dataSources.TestDatasource(true);
-      agHelper.WaitUntilAllToastsDisappear();
-      dataSources.SaveDatasource();
-      agHelper.WaitUntilAllToastsDisappear();
+      dataSources.TestSaveDatasource();
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between e71d14b and c4ff737.

📒 Files selected for processing (2)
  • app/client/cypress/e2e/Regression/ServerSide/GenerateCRUD/S3_Spec.js (4 hunks)
  • app/client/cypress/support/Pages/DataSources.ts (1 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/support/Pages/DataSources.ts
  • app/client/cypress/e2e/Regression/ServerSide/GenerateCRUD/S3_Spec.js
⏰ Context from checks skipped due to timeout of 90000ms (6)
  • GitHub Check: perform-test / rts-build / build
  • GitHub Check: perform-test / server-build / server-unit-tests
  • GitHub Check: client-unit-tests / client-unit-tests
  • GitHub Check: client-lint / client-lint
  • GitHub Check: client-build / client-build
  • GitHub Check: client-prettier / prettier-check
🔇 Additional comments (2)
app/client/cypress/e2e/Regression/ServerSide/GenerateCRUD/S3_Spec.js (2)

9-9: LGTM! Good addition of assertHelper.

The import of assertHelper improves test reliability by providing better assertion handling capabilities.


85-85: LGTM! Good refactor to use helper function.

Replacing direct navigation with dataSources.GeneratePageForDS improves code maintainability and reusability.

Comment on lines +88 to +89
public _testDs = ".t--test-datasource";
public _saveDs = ".t--save-datasource";
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

Consider keeping selectors private and exposing through methods.

While making selectors public enables direct access, it breaks encapsulation. Consider keeping them private and exposing functionality through methods.

-  public _testDs = ".t--test-datasource";
-  public _saveDs = ".t--save-datasource";
+  private _testDs = ".t--test-datasource";
+  private _saveDs = ".t--save-datasource";
+  public getTestDatasourceSelector() { return this._testDs; }
+  public getSaveDatasourceSelector() { return this._saveDs; }
📝 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
public _testDs = ".t--test-datasource";
public _saveDs = ".t--save-datasource";
private _testDs = ".t--test-datasource";
private _saveDs = ".t--save-datasource";
public getTestDatasourceSelector() { return this._testDs; }
public getSaveDatasourceSelector() { return this._saveDs; }

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

Copy link

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

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

@sagar-qa007 sagar-qa007 merged commit ec4ea27 into release Feb 13, 2025
47 checks passed
@sagar-qa007 sagar-qa007 deleted the fix/s3specfile branch February 13, 2025 11:12
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

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