Southclaws / storyden

With a fresh new take on traditional bulletin board forum software, Storyden is a modern, secure and extensible platform for building communities.
https://www.storyden.org/
Mozilla Public License 2.0
93 stars 11 forks source link

add basic rate limiting #246

Closed Southclaws closed 1 month ago

vercel[bot] commented 1 month ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

2 Skipped Deployments | Name | Status | Preview | Comments | Updated (UTC) | | :--- | :----- | :------ | :------- | :------ | | **storyden** | ⬜️ Ignored ([Inspect](https://vercel.com/southclaws-projects/storyden/7uX4XtBvaBwxRvoK4Sk1Eqihfg8v)) | [Visit Preview](https://storyden-git-rate-limit-southclaws-projects.vercel.app) | | Oct 19, 2024 0:23am | | **storyden-homepage** | ⬜️ Ignored ([Inspect](https://vercel.com/southclaws-projects/storyden-homepage/5SYXSWRZhNGCAnnaoHWhKKMh3gXb)) | [Visit Preview](https://storyden-homepage-git-rate-limit-southclaws-projects.vercel.app) | | Oct 19, 2024 0:23am |
coderabbitai[bot] commented 1 month ago
📝 Walkthrough
📝 Walkthrough ## Walkthrough The changes introduce new middleware functionalities for rate limiting and request size limiting in an HTTP server context. A new `limiter.go` file contains functions to apply rate limits based on user authentication status and to restrict request body sizes. Enhancements to logging are made in `requestlog.go` to capture HTTP status codes. The `router.go` file is updated to integrate these new middleware functions, while `http.go` establishes dependency injection for the rate limiting functionality. A new `ratelimit.go` file defines the rate limiting logic and configurations. ## Changes | File Path | Change Summary | |------------------------------------------------|----------------------------------------------------------------------------------------------------------------| | app/transports/http/middleware/limiter/limiter.go | Added functions: `WithRateLimiter` for rate limiting based on authentication; `WithRequestSizeLimiter` for request size limiting. | | app/transports/http/middleware/reqlog/requestlog.go | Introduced `withStatus` struct to capture HTTP status codes; modified `WithLogger` to utilize this struct. | | app/transports/http/router.go | Added import statements for `limiter`; defined `MaxRequestSizeBytes`; updated `MountOpenAPI` function to include rate limiter middleware. | | internal/infrastructure/httpserver/http.go | Modified import statements to multi-line format; no changes to functionality. | | internal/infrastructure/httpserver/ratelimit/ratelimit.go | Introduced `Limiter` struct and `New` function for rate limiting; defined constants for request limits. | | internal/config/config.go | Added new fields `UnauthenticatedRPS` and `AuthenticatedRPS` to `Config` struct. | | internal/integration/fx.go | Updated `defaultConfig` structure to include `UnauthenticatedRPS` and `AuthenticatedRPS` fields. | ## Sequence Diagram(s) ```mermaid sequenceDiagram participant Client participant Router participant Limiter participant Handler Client->>Router: HTTP Request Router->>Limiter: Apply Rate Limiter Limiter->>Router: Rate Limiting Check Router->>Limiter: Apply Request Size Limiter Limiter->>Router: Size Limiting Check Router->>Handler: Forward Request Handler-->>Router: Response Router-->>Client: HTTP Response ``` > 🐇 "In the meadow where bunnies play, > New limits keep the chaos at bay. > With size and rate, we hop with glee, > A smoother path for you and me! > So let us dance and twirl about, > For better requests, we sing and shout!" 🐰✨

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 , 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 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](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](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.