SamagraX-Stencil / stencil

NestJS on steroids 💪
https://stencil.samagra.io
MIT License
28 stars 30 forks source link

Adds check empty file upload and tests added tests for file upload. #162

Closed gnaaruag closed 2 months ago

gnaaruag commented 2 months ago

Checklist

Make sure you have

Description

Steps to test

to test manually create a post request to /file/upload-file
test with empty file and non empty file via multipart/form-data

to run automated test navigate to samples/06-file-upload and run npm run test:e2e

fixes #156

Summary by CodeRabbit

coderabbitai[bot] commented 2 months ago

[!WARNING]

Rate limit exceeded

@gnaaruag has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 26 minutes and 22 seconds before requesting another review.

How to resolve this issue? After the wait time has elapsed, a review can be triggered using the `@coderabbitai review` command as a PR comment. Alternatively, push new commits to this PR. We recommend that you space out your commits to avoid hitting the rate limit.
How do rate limits work? CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our [FAQ](https://coderabbit.ai/docs/faq) for further information.
Commits Files that changed from the base of the PR and between 66c734b5a960afbd5d80e14942093d026a762c92 and 5ef09b16314e7259e55bd9ccf914d64886d625e8.

Walkthrough

The recent update improves the robustness of the file upload functionality, adding checks for empty file uploads to enhance resource efficiency and data integrity. It includes revisions across multiple files to support these features and expands test coverage to ensure correct behavior.

Changes

File Path Change Summary
CONTRIBUTING.md Added an extra blank line at the beginning.
.../controllers/file-upload.controller.ts Added a file size check before the file upload operation to return an error response if the file size is 0.
.../interceptors/file-upload.interceptor.ts Added request.raw = request.raw || request before invoking this.multer.single(fieldName).
.../interfaces/file-upload.interface.ts Added size: number; and buffer: Buffer; properties to the MultipartFile interface.
.../test/app.e2e-spec.ts Added imports for fs and path, modified response expectations for the root endpoint, and added tests for file uploads with content and empty files.
sample/06-file-upload/test/app.e2e-spec.ts Added imports for fs and path, and test cases to handle file upload with content and empty files, ensuring appropriate response is returned for empty file upload.

Sequence Diagrams

File Upload Flow Before Changes

sequenceDiagram
    participant User
    participant Controller
    participant FilesService
    User->>Controller: Upload file
    Controller->>FilesService: Save file
    FilesService->>Controller: File saved
    Controller->>User: Success response

File Upload Flow After Changes

sequenceDiagram
    participant User
    participant Controller
    participant FilesService
    User->>Controller: Upload file
    Controller->>Controller: Check file size
    alt file size > 0
        Controller->>FilesService: Save file
        FilesService->>Controller: File saved
        Controller->>User: Success response
    else file size = 0
        Controller->>User: Error response
    end

Assessment against linked issues

Objective (Issue #) Addressed Explanation
Ensure empty file uploads are checked (### #156)

Poem

In the world of bytes and megabytes, We now reject the empty sights. Files hefty or light, Must now have proper byte, To keep our uploads tight and right. 🎉🐇📂


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 - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@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 as 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 resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.