Skip to content

docs: integrated unkey's ratelimiter into my project and wrote a blog post on the same#2347

Merged
chronark merged 5 commits intounkeyed:mainfrom
Devansh-Baghel:oss.gg-blog
Oct 28, 2024
Merged

docs: integrated unkey's ratelimiter into my project and wrote a blog post on the same#2347
chronark merged 5 commits intounkeyed:mainfrom
Devansh-Baghel:oss.gg-blog

Conversation

@Devansh-Baghel
Copy link
Contributor

@Devansh-Baghel Devansh-Baghel commented Oct 11, 2024

What does this PR do?

Integrated Unkey's ratelimiter into my latest project CodeStash to ratelimit an AI feature.

And then wrote an extensive technical blog on dev.to about the same.

Fixes #2346

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • Chore (refactoring code, technical debt, workflow improvements)
  • Enhancement (small improvements)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How should this be tested?

Link to the blog post

Link to the AI feature/ratelimited route, Click the "Explain this" button more than 10 times in 60 seconds to get ratelimited.

Checklist

Required

  • Filled out the "How to test" section in this PR
  • Read Contributing Guide
  • Self-reviewed my own code
  • Commented on my code in hard-to-understand areas
  • Ran pnpm build
  • Ran pnpm fmt
  • Checked for warnings, there are none
  • Removed all console.logs
  • Merged the latest changes from main onto my branch with git pull origin main
  • My changes don't cause any responsiveness issues

Appreciated

  • If a UI change was made: Added a screen recording or screenshots to this PR
  • Updated the Unkey Docs if changes were necessary

Summary by CodeRabbit

  • New Features
    • Introduced a new side quest for creating a template to build an API protected by Unkey.
    • Added a side quest encouraging users to integrate Unkey into their app and document the process in a blog post.
  • Updates
    • Updated requirements and points system for the new side quests.
    • Added recent contributions section with new entries, including a starter template by Devansh Baghel.
    • Updated blog post entry with new date and author information.

@changeset-bot
Copy link

changeset-bot bot commented Oct 11, 2024

⚠️ No Changeset found

Latest commit: 797ac24

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@vercel
Copy link

vercel bot commented Oct 11, 2024

@Devansh-Baghel is attempting to deploy a commit to the Unkey Team on Vercel.

A member of the Team first needs to authorize it.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 11, 2024

Warning

Rate limit exceeded

@chronark has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 15 minutes and 6 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 for further information.

📥 Commits

Files that changed from the base of the PR and between b9afa41 and 797ac24.

📝 Walkthrough
📝 Walkthrough

Walkthrough

The pull request introduces two new side quests related to the integration of Unkey for API protection and rate limiting. The first quest focuses on creating a template for building an API using a specific framework, while the second encourages users to document their integration experience in a blog post. Updates include new requirements, a points system for participation, and contributions from users, including a blog post entry by Devansh Baghel.

Changes

Files Change Summary
oss.gg/7_create_a_template.md Added a new side quest for creating a template using a framework for API protection with Unkey; outlined requirements and points system; updated contributions list.
oss.gg/8_use_unkey_blog.md Introduced a new side quest for integrating Unkey and writing a blog post; updated blog post entry with new date and author details.

Assessment against linked issues

Objective Addressed Explanation
Use Unkey in your app and write a blog post about it (Issue #2346)
Provide proof that you've completed the task (Issue #2346)

Possibly related PRs

Suggested labels

🕹️ oss.gg, :joystick: 750 points, hacktoberfest

Suggested reviewers

  • mcstepp
  • chronark
  • perkinsjr
  • MichaelUnkey

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

@vercel
Copy link

vercel bot commented Oct 11, 2024

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

Name Status Preview Comments Updated (UTC)
engineering ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 28, 2024 10:40am

@github-actions
Copy link
Contributor

github-actions bot commented Oct 11, 2024

Thank you for following the naming conventions for pull request titles! 🙏

@Devansh-Baghel Devansh-Baghel changed the title Oss.gg blog docs: integrated unkey's ratelimiter into my project and wrote a blog post on the same Oct 11, 2024
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: 0

🧹 Outside diff range and nitpick comments (1)
oss.gg/7_create_a_template.md (1)

43-44: LGTM! Consider a minor formatting adjustment for consistency.

The new entry for the Deno Unkey Ratelimit Starter by Devansh Baghel is correctly formatted and placed. It adheres to the required structure and provides all necessary information.

For consistency with some of the other entries, consider adding a space after the closing square bracket:

-» 10-October-2024 by Devansh Baghel [Deno Unkey Ratelimit Starter](https://github.com/Devansh-Baghel/deno-unkey-ratelimit-starter)
+» 10-October-2024 by Devansh Baghel [Deno Unkey Ratelimit Starter] (https://github.com/Devansh-Baghel/deno-unkey-ratelimit-starter)

This is a minor suggestion and doesn't affect the functionality or readability of the document.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 6c9f72e and b9afa41.

📒 Files selected for processing (2)
  • oss.gg/7_create_a_template.md (1 hunks)
  • oss.gg/8_use_unkey_blog.md (1 hunks)
🧰 Additional context used
🔇 Additional comments (1)
oss.gg/8_use_unkey_blog.md (1)

23-23: LGTM! Blog post entry updated correctly.

The changes align well with the PR objectives. The blog post entry has been properly updated with the correct author name, date, and a link to the blog post. This fulfills the requirements of the side quest.

Let's verify the blog post link:

✅ Verification successful

Blog post link verified successfully.

The blog post at the provided link contains all the necessary information regarding Unkey’s ratelimiter and CodeStash. The verification confirms that the link is correct and relevant.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the blog post link and check its content

# Test: Check if the blog post link is accessible and contains relevant content
curl -s https://dev.to/devanshbaghel/enhancing-codestash-with-unkeys-ratelimiter-4d8c | grep -iE "unkey|ratelimit|codestash"

# Expected output: Multiple matches for the keywords, indicating the blog post is about the correct topic

Length of output: 11255

@perkinsjr
Copy link
Member

Hi @Devansh-Baghel can you point out where this is in your project?

I don't see Unkey integrated in the main branch and no mention of it in the stack.

It looks like you made a template which is separate from the actual repository.

@Devansh-Baghel
Copy link
Contributor Author

Hi @perkinsjr sorry the latest commit wasn't pushed yet.

Here is the commit in the main branch that adds this, also added in the readme of the project.

The template repo that i created was for a separate oss.gg submission which i have now gotten the points awarded for. (issue, pr) but the pr for that is still open.

@Devansh-Baghel
Copy link
Contributor Author

Hey @chronark

Hi, is there anything else I should do or notify someone for this pr?

@chronark
Copy link
Collaborator

@Devansh-Baghel james will get to it when he's available

@chronark chronark merged commit fa15c65 into unkeyed:main Oct 28, 2024
@oss-gg
Copy link

oss-gg bot commented Oct 28, 2024

Awarding Devansh-Baghel: 1500 points 🕹️ Well done! Check out your new contribution on oss.gg/Devansh-Baghel

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.

[oss.gg hackathon] Integrated unkey's ratelimiter into my project and wrote a blog post on the same

3 participants