Add note to onboarding document about request size#599
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
📝 WalkthroughWalkthroughAdded two warning notes in the solver onboarding documentation indicating the Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Tip Try Coding Plans. Let us write the prompt for your AI agent so you can ship faster (with fewer bugs). Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/cow-protocol/tutorials/solvers/onboard.md`:
- Line 50: Update the note to say the large payload is the HTTP request body
sent TO your /solve endpoint (not the response), and add a concrete Nginx
configuration example to raise allowed request size (e.g., instruct operators to
set client_max_body_size to an appropriate value like "10M" in their server or
http block). Mention the specific endpoint name (/solve) so readers know which
handler receives the large request body and include the exact Nginx directive
(client_max_body_size) and where to place it (server/http block).
| envName values: shadow, staging, prod | ||
| supported networks: arbitrum-one, avalanche, base, bnb, lens, linea, mainnet, polygon, xdai (gnosis) and more are coming out! | ||
|
|
||
| > **_NOTE_** The `/solve` response sent to your solver is quite large. If you are using Nginx then the default request size will be too small and prevent you from receiving any auctions. |
There was a problem hiding this comment.
Clarify HTTP terminology and add an actionable Nginx setting.
On Line 50, “/solve response sent to your solver” is confusing; this should describe the request body received by your /solve endpoint. Please also include a concrete Nginx example (e.g., client_max_body_size ...;) so operators can fix it immediately.
Suggested doc tweak
-> **_NOTE_** The `/solve` response sent to your solver is quite large. If you are using Nginx then the default request size will be too small and prevent you from receiving any auctions.
+> **_NOTE:_** Requests to your `/solve` endpoint can have large bodies. If you use Nginx, increase `client_max_body_size` (default is often too low), or auctions may be dropped/rejected (e.g., HTTP 413).📝 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.
| > **_NOTE_** The `/solve` response sent to your solver is quite large. If you are using Nginx then the default request size will be too small and prevent you from receiving any auctions. | |
| > **_NOTE:_** Requests to your `/solve` endpoint can have large bodies. If you use Nginx, increase `client_max_body_size` (default is often too low), or auctions may be dropped/rejected (e.g., HTTP 413). |
🧰 Tools
🪛 LanguageTool
[style] ~50-~50: As an alternative to the over-used intensifier ‘quite’, consider replacing this phrase.
Context: .../solve` response sent to your solver is quite large. If you are using Nginx then the defaul...
(EN_WEAK_ADJECTIVE)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/cow-protocol/tutorials/solvers/onboard.md` at line 50, Update the note
to say the large payload is the HTTP request body sent TO your /solve endpoint
(not the response), and add a concrete Nginx configuration example to raise
allowed request size (e.g., instruct operators to set client_max_body_size to an
appropriate value like "10M" in their server or http block). Mention the
specific endpoint name (/solve) so readers know which handler receives the large
request body and include the exact Nginx directive (client_max_body_size) and
where to place it (server/http block).
|
This is the preview, and something looks off to me we usually do this, i think |
There was a problem hiding this comment.
♻️ Duplicate comments (1)
docs/cow-protocol/tutorials/solvers/onboard.md (1)
50-51:⚠️ Potential issue | 🟡 MinorUse correct HTTP direction and include the exact Nginx directive.
Line 51 still describes this as a
/solve“response,” but this issue is the request body received by your/solveendpoint. Please also add a concrete Nginx setting (for example,client_max_body_size 10M;inhttp/server) so operators can fix it immediately.Suggested wording
:::note -The `/solve` response sent to your solver is quite large. If you are using Nginx then the default request size will be too small and prevent you from receiving any auctions. +Requests to your `/solve` endpoint can have large bodies. If you use Nginx, increase `client_max_body_size` (e.g., `client_max_body_size 10M;` in the `http` or `server` block), otherwise auctions may be rejected (HTTP 413). :::🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/cow-protocol/tutorials/solvers/onboard.md` around lines 50 - 51, Update the note to refer to the "/solve" request body received by your /solve endpoint (not the "response") and add a concrete Nginx directive example so operators can fix it immediately; specifically mention adding e.g. client_max_body_size 10M; in the http or server block of nginx.conf and explain that increasing client_max_body_size prevents large /solve requests from being rejected.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Duplicate comments:
In `@docs/cow-protocol/tutorials/solvers/onboard.md`:
- Around line 50-51: Update the note to refer to the "/solve" request body
received by your /solve endpoint (not the "response") and add a concrete Nginx
directive example so operators can fix it immediately; specifically mention
adding e.g. client_max_body_size 10M; in the http or server block of nginx.conf
and explain that increasing client_max_body_size prevents large /solve requests
from being rejected.
|
@bram-vdberg i applied the change i mentioned above. Let me know if you agree with it. Here is how it looks now 
|
3 participants
Description
This PR adds a note to the onboarding document to solvers to increase the default request size for Nginx. We notice many solvers running into this issue and not realizing this until we look into the logs. By adding this to the documentation we will hopefully make it easier for solvers to debug or avoid this in the future.
Changes
Summary by CodeRabbit