github-starred/better-auth
2
0
Fork 0
mirror of https://github.com/better-auth/better-auth.git synced 2026-05-23 07:18:56 -05:00
Code Issues 2.5k Packages Projects Releases 112 Wiki Activity

[PR #3365] [MERGED] Extend Rate Limiting Docs and add small warning #30386

New Issue
Closed
opened 2026-04-17 21:29:57 -05:00 by GiteaMirror · 0 comments
GiteaMirror commented 2026-04-17 21:29:57 -05:00
Owner
Copy Link

📋 Pull Request Information

Original PR: https://github.com/better-auth/better-auth/pull/3365
Author: @work-in-progress-danny
Created: 7/14/2025
Status: ✅ Merged
Merged: 7/14/2025
Merged by: @Bekacru

Base: main ← Head: main

📝 Commits (4)

  • 4b12505 refactor: remove useless variable assignment
  • b47ebce refactor: remove unused param
  • 301b801 docs: extend rate limit docs to include info about connecting ip address and how it's used
  • bd60606 fix: linting

📊 Changes

4 files changed (+28 additions, -5 deletions)

View changed files

📝 docs/content/docs/concepts/rate-limit.mdx (+22 -0)
📝 packages/better-auth/src/api/rate-limiter/index.ts (+3 -2)
📝 packages/better-auth/src/types/options.ts (+1 -1)
📝 packages/better-auth/src/utils/get-request-ip.ts (+2 -2)

📄 Description

I fell for something like what this issue is mentioning but my issue was it wasn't clear how rate limiting was working as the docs didn't mention it uses the connecting IP and wasn't throwing any issues and failing silently.

This change is to explicitly mention the use of IP in the rate limiting docs and if it's trying to be used but doesn't find an IP address to console.warn.

I'm using better-auth with cloudflare workers, then the cf-connecting-ip is what cloudflare provides with the request.

Also a small clean up of createDBStorage as the param was not being used inside the function body and removing the unnecessary variable assignment testIP

Summary by cubic

Updated the rate limiting documentation to explain how connecting IP addresses are used, and added a warning if no IP is found during rate limiting.

  • Docs and Warnings
    • Clarified in the docs that rate limiting uses the connecting IP and how to configure custom headers.
    • Added a console warning when no IP address is found for rate limiting.
    • Cleaned up unused variables and parameters in related code.

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/better-auth/better-auth/pull/3365 **Author:** [@work-in-progress-danny](https://github.com/work-in-progress-danny) **Created:** 7/14/2025 **Status:** ✅ Merged **Merged:** 7/14/2025 **Merged by:** [@Bekacru](https://github.com/Bekacru) **Base:** `main` ← **Head:** `main` --- ### 📝 Commits (4) - [`4b12505`](https://github.com/better-auth/better-auth/commit/4b12505f753eeab5da331fbf6e76490bb46777c2) refactor: remove useless variable assignment - [`b47ebce`](https://github.com/better-auth/better-auth/commit/b47ebce985378cae6907022f9ede1454adb6e72c) refactor: remove unused param - [`301b801`](https://github.com/better-auth/better-auth/commit/301b8016652407f632de4cddb7476e81034805f5) docs: extend rate limit docs to include info about connecting ip address and how it's used - [`bd60606`](https://github.com/better-auth/better-auth/commit/bd60606c4a2dd9f8dda5864ba8c862159a55bbdb) fix: linting ### 📊 Changes **4 files changed** (+28 additions, -5 deletions) <details> <summary>View changed files</summary> 📝 `docs/content/docs/concepts/rate-limit.mdx` (+22 -0) 📝 `packages/better-auth/src/api/rate-limiter/index.ts` (+3 -2) 📝 `packages/better-auth/src/types/options.ts` (+1 -1) 📝 `packages/better-auth/src/utils/get-request-ip.ts` (+2 -2) </details> ### 📄 Description I fell for something like what[ this issue](https://github.com/better-auth/better-auth/issues/3264) is mentioning but my issue was it wasn't clear how rate limiting was working as the docs didn't mention it uses the connecting IP and wasn't throwing any issues and failing silently. This change is to explicitly mention the use of IP in the rate limiting docs and if it's trying to be used but doesn't find an IP address to `console.warn`. I'm using better-auth with cloudflare workers, then the `cf-connecting-ip` is what cloudflare provides with the request. Also a small clean up of `createDBStorage` as the param was not being used inside the function body and removing the unnecessary variable assignment `testIP` <!-- This is an auto-generated description by cubic. --> --- ## Summary by cubic Updated the rate limiting documentation to explain how connecting IP addresses are used, and added a warning if no IP is found during rate limiting. - **Docs and Warnings** - Clarified in the docs that rate limiting uses the connecting IP and how to configure custom headers. - Added a console warning when no IP address is found for rate limiting. - Cleaned up unused variables and parameters in related code. <!-- End of auto-generated description by cubic. --> --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
GiteaMirror added the pull-request label 2026-04-17 21:29:57 -05:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
adapter
astro
awaiting external contributor
blocked
breaking
breaking change
bug
c-devops
core
credentials
database
dependencies
devops
devtools
docs
documentation
duplicate
elysia
enhancement
enterprise
expo
express
fastify
good first issue
help wanted
hono
identity
infra
integration
invalid
javascript
locked
maintenance
need-more-information
needs: info
needs: repro
nextjs
nuxt
oauth
organization
P0
payments
perf
platform
plugin
pull-request
Mirrored from GitHub Pull Request
 question
ready
regression
remix
security
social-provider
solid
stale
svelte
tanstack-start
tracking
version-bump
vue
wontfix
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
GiteaMirror ninjasurge
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/better-auth#30386
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?