Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[8.x] Document RateLimited and WithoutOverlapping Job Middleware #6505

Merged
merged 2 commits into from Oct 20, 2020
Merged

[8.x] Document RateLimited and WithoutOverlapping Job Middleware #6505

merged 2 commits into from Oct 20, 2020

Conversation

paras-malhotra
Copy link
Contributor

@paras-malhotra paras-malhotra commented Oct 19, 2020

Document the 2 new job middleware: RateLimited (laravel/framework#34829) and WithoutOverlapping (laravel/framework#34794) to be released tomorrow on Laravel 8.11.

There was a section on rate limiting using Redis::throttle and Redis::funnel. This section is removed because:

  1. The RateLimitedWithRedis class does the same thing as Redis::throttle. The Redis::throttle is also already documented in the job middleware section.
  2. The Redis::funnel method is now moved to the job middleware section as an example to limit concurrency.

This way, all 3 types of middleware (rate limiting, preventing overlapping and concurrency limiting) are documented together in the job middleware section.

@taylorotwell taylorotwell merged commit 6dfe4ca into laravel:8.x Oct 20, 2020
@paras-malhotra paras-malhotra deleted the job_middleware branch October 20, 2020 14:46
@sansebi
Copy link

sansebi commented Oct 23, 2020

WithoutOverlapping works like a charm! 👍
I run into a dead end with my CACHE_DRIVER being set to file

Call to undefined method Illuminate\Cache\FileStore::lock()

Would be nice to extend the docs that it only works for specific cache drivers.

@driesvints
Copy link
Member

@sansebi can you send in a PR for that?

@paras-malhotra
Copy link
Contributor Author

Thanks @sansebi, I sent a PR to document this: #6520

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
4 participants