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

test: Cypress test for validating file uploads greater than 20MB #38496

Merged
merged 2 commits into from
Jan 7, 2025

Conversation

shadabbuchh
Copy link
Contributor

@shadabbuchh shadabbuchh commented Jan 6, 2025

Description

This PR introduces a Cypress test to validate the functionality of uploading files larger than 20MB using the File Picker widget and a POST API.

Tests: #34123

Automation

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

🔍 Cypress test results

Tip

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


Mon, 06 Jan 2025 14:20:44 UTC

Communication

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

  • Yes
  • No

Summary by CodeRabbit

  • New Tests
    • Added a new Cypress test suite for validating file uploads larger than 20MB
    • Test covers file upload via File Picker widget with multipart form data
    • Verifies successful file upload and API response for large files

Copy link
Contributor

coderabbitai bot commented Jan 6, 2025

Walkthrough

This pull request introduces a new Cypress test suite focused on validating file upload functionality for files larger than 20MB. The test specifically checks file upload using binary format and multipart form data, addressing potential issues with large file uploads. The test suite involves configuring a File Picker widget, uploading a file, and verifying the API response, with the test being added to the limited test configuration.

Changes

File Change Summary
app/client/cypress/e2e/Regression/ServerSide/ApiTests/API_Bug_Upload_File_GreaterThan_20MB_spec.ts New test suite for large file upload validation
app/client/cypress/limited-tests.txt Updated test spec path from visual test to API upload test

Possibly related issues

Possibly related PRs

Suggested labels

Test, ok-to-test, skip-changelog

Suggested reviewers

  • ApekshaBhosale
  • sagar-qa007
  • rahulbarwal

Poem

🚀 Uploading files, big and bold
Cypress tests, a story untold
Twenty megs? No sweat, we'll see
API dancing with glee! 📤
Code conquers all, large and small 💻


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 skip-changelog Adding this label to a PR prevents it from being listed in the changelog Test labels Jan 6, 2025
@shadabbuchh
Copy link
Contributor Author

/ci-test-limit-count run_count=20 update_snapshot=true specs_to_run=cypress/e2e/Regression/ServerSide/ApiTests/API_Bug_Upload_File_GreaterThan_20MB_spec.ts

Copy link

github-actions bot commented Jan 6, 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: 0

🧹 Nitpick comments (3)
app/client/cypress/e2e/Regression/ServerSide/ApiTests/API_Bug_Upload_File_GreaterThan_20MB_spec.ts (3)

1-10: Consider consistent import style and naming.

You're mixing CommonJS (require) and ES imports. For consistency, prefer using ES import syntax or ensure both styles follow a uniform approach across your codebase.


19-38: Use data- attributes for better maintainability.*

Currently, "Select Files" is used to locate the button. The coding guidelines recommend data-* attributes instead of text-based locators. It improves test stability and consistency.


39-63: Multiple assertions recommended.

While you're correctly asserting the status code and checking the response text, consider adding additional expectations, such as verifying headers, response time, or other relevant checks if applicable to ensure a more robust test.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between bd32f53 and bf71bf5.

📒 Files selected for processing (2)
  • app/client/cypress/e2e/Regression/ServerSide/ApiTests/API_Bug_Upload_File_GreaterThan_20MB_spec.ts (1 hunks)
  • app/client/cypress/limited-tests.txt (1 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
app/client/cypress/e2e/Regression/ServerSide/ApiTests/API_Bug_Upload_File_GreaterThan_20MB_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.
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.
⏰ Context from checks skipped due to timeout of 90000ms (4)
  • 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/ApiTests/API_Bug_Upload_File_GreaterThan_20MB_spec.ts (1)

13-16: Good use of describe block with tags.

The describe block is clear, references the bug number, and includes relevant tags. No issues here.

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

2-2: Good update to limited tests path.

Replacing the visual test spec with this new server-side test spec helps focus on the file upload scenario.

Copy link

github-actions bot commented Jan 6, 2025

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

***** Repeat Run Summary ***** Total Tests with repeat: 20 Total Passed: 18 Total Failed: 2 Total Skipped: 0 *****************************

@shadabbuchh shadabbuchh added the ok-to-test Required label for CI label Jan 6, 2025
@shadabbuchh
Copy link
Contributor Author

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

***** Repeat Run Summary ***** Total Tests with repeat: 20 Total Passed: 18 Total Failed: 2 Total Skipped: 0 *****************************

2 failures were due to the fact that settings config failed to load. Not related to the test.
Screenshot 2025-01-06 at 6 48 03 PM

@shadabbuchh shadabbuchh merged commit a75c530 into release Jan 7, 2025
50 checks passed
@shadabbuchh shadabbuchh deleted the test/APIFileUpload20MB branch January 7, 2025 04:58
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 Test
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants