Skip to content

feat: increase request body size limit to 50MB with verification#109

Merged
Sma1lboy merged 1 commit intomainfrom
chore-adding-more-limit-in-single-request
Feb 3, 2025
Merged

feat: increase request body size limit to 50MB with verification#109
Sma1lboy merged 1 commit intomainfrom
chore-adding-more-limit-in-single-request

Conversation

@Sma1lboy
Copy link
Collaborator

@Sma1lboy Sma1lboy commented Feb 2, 2025

Summary by CodeRabbit

  • New Features
    • Enhanced error handling for incoming JSON requests by enforcing a 50MB size limit and providing clear error alerts if exceeded.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 2, 2025

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

llm-server/src/main.ts

Oops! Something went wrong! :(

ESLint: 8.57.1

ESLint couldn't find the plugin "eslint-plugin-prettier".

(The package "eslint-plugin-prettier" was not found when loaded as a Node module from the directory "/llm-server".)

It's likely that the plugin isn't installed correctly. Try reinstalling by running the following:

npm install eslint-plugin-prettier@latest --save-dev

The plugin "eslint-plugin-prettier" was referenced from the config file in "llm-server/.eslintrc.cjs".

If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team.

Walkthrough

The update modifies the JSON body parsing middleware in the App constructor. The middleware now uses a configuration that limits the request body size to 50MB and includes a verification function that throws an error when the limit is exceeded. The overall application control flow remains the same, and no changes were made to the declarations of exported or public entities.

Changes

File Path Change Summary
llm-server/.../main.ts Modified the JSON middleware in the App constructor to impose a 50MB body size limit and added a verification callback to throw an error if the limit is exceeded.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant Server
    participant Middleware

    Note over Server: App constructor initializes middleware

    Client->>Middleware: Send request with JSON body
    Middleware->>Middleware: Parse JSON (limit: 50MB)
    alt Body within limit
        Middleware-->>Client: Process request normally
    else Body exceeds limit
        Middleware-->>Client: Throw error: "Payload too large"
    end
Loading

Poem

Hey there, I'm Hopper, a coding rabbit on the run,
In the JSON woods, I made some fun!
Now the bodies are limited to fifty megabytes,
Verification hops in with error insights!
Carrots and code, let’s celebrate this new height!
🥕🐇
Happy coding under moonlit bytes!

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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.

CodeRabbit Configuration 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 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 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.

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

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c197d8f and a335760.

📒 Files selected for processing (1)
  • llm-server/src/main.ts (1 hunks)

Comment on lines +35 to +44
this.app.use(
express.json({
limit: '50mb',
verify: (req, res, buf) => {
if (buf?.length > 50 * 1024 * 1024) {
throw new Error('Request body exceeds 50MB limit');
}
},
}),
);
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

Simplify the middleware configuration and improve error handling.

The current implementation has redundant size checks and suboptimal error handling. Consider these improvements:

+const MAX_REQUEST_BODY_SIZE = '50mb';
+
 export class App {
   private readonly logger = new Logger(App.name);
   private app: Express;
   // ...
   constructor(llmProvider: LLMProvider) {
     this.app = express();
-    this.app.use(
-      express.json({
-        limit: '50mb',
-        verify: (req, res, buf) => {
-          if (buf?.length > 50 * 1024 * 1024) {
-            throw new Error('Request body exceeds 50MB limit');
-          }
-        },
-      }),
-    );
+    this.app.use(express.json({ limit: MAX_REQUEST_BODY_SIZE }));

Rationale:

  1. The limit option in express.json() already handles size limits and automatically sends a 413 (Payload Too Large) status code.
  2. The verification function adds unnecessary overhead with a redundant check.
  3. Defining the limit as a constant improves maintainability.

@Sma1lboy Sma1lboy merged commit 5593ce0 into main Feb 3, 2025
2 of 3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants