woem.men/forkey
4
2
Fork 3
Code Issues 34 Pull requests 16 Projects Releases Packages Wiki Activity Actions

implement rate limit support for mastodon endpoints #23

Open
sugar wants to merge 1 commit from sugar/forkey:implement-rate-limits-for-mastodon-endpoints into main
pull from: sugar/forkey:implement-rate-limits-for-mastodon-endpoints
merge into: woem.men:main
Conversation 2 Commits 1 Files changed 2 +43 -30
sugar commented 2025-01-11 18:04:36 +00:00
Owner
Copy link

What

Implement rate limits for future Mastodon endpoints.

Why

Some endpoints will need stricter rate limits.

Additional info (optional)

Note that rate limits are by default disabled in development, see RateLimiterService.

Checklist

  • Read the contribution guide
  • Test working in a local environment
  • (If needed) Add story of storybook
  • (If needed) Update CHANGELOG.md
  • (If possible) Add tests
<!-- ℹ お読みください / README PRありがとうございます！ PRを作成する前に、コントリビューションガイドをご確認ください: Thank you for your PR! Before creating a PR, please check the contribution guide: https://github.com/misskey-dev/misskey/blob/develop/CONTRIBUTING.md --> ## What <!-- このPRで何をしたのか？ どう変わるのか？ --> <!-- What did you do with this PR? How will it change things? --> Implement rate limits for future Mastodon endpoints. ## Why <!-- なぜそうするのか？ どういう意図なのか？ 何が困っているのか？ --> <!-- Why do you do it? What are your intentions? What is the problem? --> Some endpoints will need stricter rate limits. ## Additional info (optional) <!-- テスト観点など --> <!-- Test perspective, etc --> Note that rate limits are by default disabled in development, see `RateLimiterService`. ## Checklist - [ ] Read the [contribution guide](https://github.com/misskey-dev/misskey/blob/develop/CONTRIBUTING.md) - [ ] Test working in a local environment - [ ] (If needed) Add story of storybook - [ ] (If needed) Update CHANGELOG.md - [ ] (If possible) Add tests
sugar force-pushed implement-rate-limits-for-mastodon-endpoints from 689ac72c22 to aaa49f2131 2025-01-17 15:29:21 +00:00 Compare
leah reviewed 2025-01-17 22:40:21 +00:00
packages/backend/src/server/api/ApiCallService.ts Outdated
@ -456,1 +440,4 @@
async #checkRateLimit(ep: IEndpoint | IMastodonEndpoint, user: MiLocalUser | null | undefined, request: FastifyRequest<{ Body: Record<string, unknown> | undefined, Querystring: Record<string, unknown> }>): Promise<void> {
const bypassRateLimit = this.config.bypassRateLimit?.some(({ header, value }) => request.headers[header] === value) ?? false;
console.log(ep);
leah commented 2025-01-17 22:40:21 +00:00
Owner
Copy link

Looks like you forgot to remove this console log

Looks like you forgot to remove this console log
sugar commented 2025-01-18 10:22:37 +00:00
Author
Owner
Copy link

fixed :3

fixed :3
sugar marked this conversation as resolved
sugar force-pushed implement-rate-limits-for-mastodon-endpoints from aaa49f2131 to d5983dc12e 2025-01-18 10:22:33 +00:00 Compare
ashten commented 2025-01-20 01:01:28 +00:00
Owner
Copy link

how would i go about testing these endpoints? are there unit tests we can write, perhaps?

how would i go about testing these endpoints? are there unit tests we can write, perhaps?
sugar commented 2025-02-02 16:53:54 +00:00
Author
Owner
Copy link

fae tested them by removing code that only enforces rate limits in production, adding a limit to an already existing endpoint, and repeatedly visiting it

not sure how would fae go about testing it, but if that helps it's the same system as for regular misskey endpoints

also, it's worth noting that rate limiter only works in production environments (as in upstream), which makes it tough to test

		if (process.env.NODE_ENV !== 'production') {
			this.disabled = true;
		}
fae tested them by removing code that only enforces rate limits in production, adding a limit to an already existing endpoint, and repeatedly visiting it not sure how would fae go about testing it, but if that helps it's the same system as for regular misskey endpoints also, it's worth noting that rate limiter only works in production environments (as in upstream), which makes it tough to test ```typescript if (process.env.NODE_ENV !== 'production') { this.disabled = true; } ```
All checks were successful
Lint / pnpm_install (pull_request) Successful in 2m26s
Details
Test (backend) / unit (22.x) (pull_request) Successful in 7m4s
Details
Test (backend) / e2e (22.x) (pull_request) Successful in 9m3s
Details
Test (frontend) / vitest (22.x) (pull_request) Successful in 3m11s
Details
Test (production install and build) / production (22.x) (pull_request) Successful in 2m58s
Details
Test (backend) / validate-api-json (22.x) (pull_request) Successful in 3m21s
Details
Lint / lint (backend) (pull_request) Successful in 2m40s
Details
Lint / lint (frontend) (pull_request) Successful in 9m27s
Details
Lint / lint (misskey-js) (pull_request) Successful in 2m54s
Details
Lint / lint (sw) (pull_request) Successful in 2m17s
Details
Lint / typecheck (backend) (pull_request) Successful in 3m47s
Details
Lint / typecheck (misskey-js) (pull_request) Successful in 2m16s
Details
This pull request has changes conflicting with the target branch.
  • packages/backend/src/server/api/mastodon-endpoints.ts
View command line instructions

Checkout

From your project repository, check out a new branch and test the changes.
git fetch -u implement-rate-limits-for-mastodon-endpoints:sugar-implement-rate-limits-for-mastodon-endpoints
git checkout sugar-implement-rate-limits-for-mastodon-endpoints

Merge

Merge the changes and update on Forgejo.

Warning: The "Autodetect manual merge" setting is not enabled for this repository, you will have to mark this pull request as manually merged afterwards.

git checkout main
git merge --no-ff sugar-implement-rate-limits-for-mastodon-endpoints
git checkout sugar-implement-rate-limits-for-mastodon-endpoints
git rebase main
git checkout main
git merge --ff-only sugar-implement-rate-limits-for-mastodon-endpoints
git checkout sugar-implement-rate-limits-for-mastodon-endpoints
git rebase main
git checkout main
git merge --no-ff sugar-implement-rate-limits-for-mastodon-endpoints
git checkout main
git merge --squash sugar-implement-rate-limits-for-mastodon-endpoints
git checkout main
git merge --ff-only sugar-implement-rate-limits-for-mastodon-endpoints
git checkout main
git merge sugar-implement-rate-limits-for-mastodon-endpoints
git push origin main
Sign in to join this conversation.
Reviewers
No reviewers
Labels
Clear labels   
bug

Something is not working

  
customization

Change something to be more suitable for forkey

  
duplicate

This issue or pull request already exists

  
enhancement

New feature

  
feature parity

Another fork has this feature, and it should be pulled into this fork.

  
help wanted

Need some help

  
high priority

   
invalid

Something is wrong

  
low priority

   
question

More information is needed

  
wontfix

This won't be fixed

No labels
bug
customization
duplicate
enhancement
feature parity
help wanted
high priority
invalid
low priority
question
wontfix
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
3 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference: woem.men/forkey#23
No description provided.
Delete branch "sugar/forkey:implement-rate-limits-for-mastodon-endpoints"

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?