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

implement SWC rate limiting and introduce an optional Redis cache provider #299

Closed Southclaws closed 2 days ago

vercel[bot] commented 2 days 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/3RimFzkR8CwPvLCnoj4gyahEHf7w)) | [Visit Preview](https://storyden-git-cache-and-better-rate-limiting-southclaws-projects.vercel.app) | | Nov 19, 2024 2:05pm | | **storyden-homepage** | ⬜️ Ignored ([Inspect](https://vercel.com/southclaws-projects/storyden-homepage/CPagYt8tXhjhPrRdo19Zay6Lwuk7)) | [Visit Preview](https://storyden-homepage-git-cache-and-bett-b9a167-southclaws-projects.vercel.app) | | Nov 19, 2024 2:05pm |
coderabbitai[bot] commented 2 days ago

[!CAUTION]

Review failed

The pull request is closed.

📝 Walkthrough
📝 Walkthrough ## Walkthrough The changes in this pull request involve a comprehensive restructuring of middleware handling within the HTTP transport layer, particularly focusing on session and rate limiting functionalities. The `http.go` file now utilizes a generalized middleware import, while the `limiter` package has been overhauled to introduce a new `Middleware` struct. Additional files have been added to support caching mechanisms and integrate rate limiting, with new configuration fields introduced to manage these features. Overall, the modifications enhance the modularity and organization of middleware components in the application. ## Changes | File | Change Summary | |------|----------------| | `app/transports/http/http.go` | Updated import for session middleware to a general middleware import; modified `Build` function to use `middleware.Build()`. | | `app/transports/http/middleware/limiter/limiter.go` | Introduced `Middleware` struct; replaced `WithRateLimiter` with `New` constructor; added `WithRateLimit` method for rate limiting logic; introduced `fromIP` key function; removed previous unauthenticated/authenticated request handling. | | `app/transports/http/middleware/middleware.go` | Added new `middleware.go` file with `Build` function for middleware registration. | | `app/transports/http/middleware/reqlog/requestlog.go` | Enhanced error handling in `WithLogger` to include stack trace on panic. | | `app/transports/http/router.go` | Modified `MountOpenAPI` function to accept a rate limiter middleware parameter. | | `internal/config/config.go` | Added new fields for rate limiting and caching in `Config` struct. | | `internal/infrastructure/cache/cache.go` | Introduced `Store` interface and `Build` function for cache provider setup. | | `internal/infrastructure/cache/local/local.go` | Added `LocalCache` implementation for in-memory caching. | | `internal/infrastructure/cache/redis/redis_cache.go` | Introduced `RedisCache` struct for Redis-based caching. | | `internal/infrastructure/infrastructure.go` | Updated to include new cache and rate limiting dependencies in `Build` function. | | `internal/infrastructure/rate/factory.go` | Added `LimiterFactory` type for creating rate limiters. | | `internal/integration/e2e/provider.go` | Changed middleware import and setup to use `middleware.Build()`. | | `internal/integration/fx.go` | Updated `defaultConfig` to streamline rate limiting configuration. | ## Possibly related PRs - **#246**: The changes in this PR introduce middleware for rate limiting, which is directly related to the modifications in the main PR that restructure middleware handling in the HTTP transport layer. Both PRs focus on enhancing middleware functionality, specifically around rate limiting and session management. > 🐰 In the meadow, where bunnies play, > Middleware changes brighten the day. > With limits set and sessions neat, > Our code hops along, quick on its feet! > Caching and logging, all in a row, > A joyful dance, watch our features grow! 🌼

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://docs.coderabbit.ai) 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.