search

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

rewrite local cache with ristretto and add tests as well as a basic c… #303

Closed Southclaws closed 3 days ago

Southclaws commented 3 days ago

…oncurrency benchmark to ensure there are no data races

vercel[bot] commented 3 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/Hrd9k49UqWT6V8dbp8KChP6JHV7B)) | [Visit Preview](https://storyden-git-rework-local-cache-southclaws-projects.vercel.app) | | Nov 22, 2024 11:21am | | **storyden-homepage** | ⬜️ Ignored ([Inspect](https://vercel.com/southclaws-projects/storyden-homepage/Eh7UtMcAYveo6QTLiMp6ijFu5EUo)) | [Visit Preview](https://storyden-homepage-git-rework-local-cache-southclaws-projects.vercel.app) | | Nov 22, 2024 11:21am |
coderabbitai[bot] commented 3 days ago

[!CAUTION]

Review failed

The pull request is closed.

📝 Walkthrough
📝 Walkthrough ## Walkthrough The changes include modifications to the `Build` function in the `cache` package to improve error handling when initializing the local cache. The local cache implementation has been significantly updated to replace `xsync.MapOf` with `ristretto.Cache`, simplifying the storage mechanism. Additionally, a new test file has been introduced to validate the functionality of the local cache, including tests for setting, incrementing, and handling concurrent access. ## Changes | File Path | Change Summary | |------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | internal/infrastructure/cache/cache.go | Updated the `Build` function to capture and return errors from `local.New()`, enhancing error handling. | | internal/infrastructure/cache/local/local.go | Replaced `xsync.MapOf` with `ristretto.Cache` for local storage. Removed `Entry` struct; cache now stores byte slices directly. Modified `New` function to return an error. Updated `Get`, `Set`, `Delete`, `HIncrBy`, `HGetAll`, `HDel`, and `Expire` methods to work with `ristretto.Cache`. Introduced `HSet` type for managing hash structures. | | internal/infrastructure/cache/local/local_test.go | Introduced tests for the local cache implementation, including `get_set`, `hincr`, and `concurrency` tests to validate functionality and performance. Added `BenchmarkLocalCache` for performance testing under concurrent load. Utilized the `testify` package for assertions. | ## Sequence Diagram(s) ```mermaid sequenceDiagram participant Client participant Cache participant LocalCache Client->>Cache: Build() Cache->>LocalCache: New() LocalCache->>Cache: (LocalCache, error) Cache->>Client: (LocalCache, error) Client->>LocalCache: Set(key, value, ttl) LocalCache->>LocalCache: Store in ristretto.Cache LocalCache->>Client: nil Client->>LocalCache: Get(key) LocalCache->>LocalCache: Retrieve from ristretto.Cache LocalCache->>Client: (value, nil) Client->>LocalCache: HIncrBy(key, field, incr) LocalCache->>LocalCache: Update hash LocalCache->>Client: (newValue, nil) ``` > > 🐇 In the cache, where bytes do play, > 🐰 We store our treasures, come what may. > 🌟 With `ristretto`, swift and bright, > 🌙 Our data dances, day and night. > 🥕 Tests are hopping, all in line, > 🎉 Celebrate the changes, oh so fine! >

[!WARNING]

Rate limit exceeded

@Southclaws has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 16 minutes and 1 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://docs.coderabbit.ai/faq) for further information.
📥 Commits Reviewing files that changed from the base of the PR and between 04badff9951ea7216a08a72e7ab859c589fb98af and aa2b8c99d6cc8b3bcad810ad81b9c7ea901a578b.

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.