Download the PHP package swiftmade/playback without Composer
On this page you can find all versions of the php package swiftmade/playback. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download swiftmade/playback
More information about swiftmade/playback
Files in swiftmade/playback
Package playback
Short Description Implement idempotent endpoints in Laravel à la Stripe
License MIT
Homepage https://github.com/swiftmade/playback
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package playback
Laravel Playback
Idempotent endpoints in Laravel à la Stripe.
Playback gives you idempotent endpoints in Laravel, using Redis locks. What's even idempotency, and why should I care?
Features
- 📼 Records and plays back 2xx and 5xx responses, without running your controller code again.
- 🔐 Built-in validation to prevent attacks by stolen/guessed idempotency keys.
- ⚠️ Won't store the response if there was a validation error (4xx).
- 🏎 Prevents race conditions using atomical Redis locks.
Installation
💡 Supports Laravel 8.x, Laravel 9.x on PHP 7.4, 8.0 or 8.1
-
You can install the package via composer:
-
Publish the config file (optional):
- Add the playback cache store
Open config/cache.php and add a new store.
💡 Apply the middleware
Just apply the Swiftmade\Playback\Playback middleware to your endpoints. There are many ways of doing it, so here's a link to the docs:
Use
Even when middleware is active on a route, it's business as usual unless the client sends an Idempotency-Key in their request header.
Once Playback detects a key, it'll look it up in redis. If found, it will serve the same response without hitting your controller action again. You can know that happened by looking at the response headers. If it contains Is-Playback, you know it's just a repetition.
If the key is not found during the lookup, a race begins. The first request to acquire the redis lock gets to process the request and cache the response. Any other unlucky requests that land during that time window will return 425 status code.
Errors:
-
400 Bad Request If you get back status
400, it means your request was not identical to the cached one. It's the client's responsibility to repeat the exact same request. This is also why another user can't steal a response just by stealing/guessing the idempotency key. The cookies/authentication token would be different, which fails the signature check. - 425 Too Early If you get this error, it means you retried too fast after your initial attempt. Don't panic and try again a second later or so. It's perfectly safe to do so!
🚨 Pro tip: If your controller action returns 4xx or 3xx status code, Playback won't cache the response. It's your responsibility to ensure no side effects take place (or they are rolled back) if a validation fails, a related db record was not found, etc and therefore the response status is 4xx or 3xx.
Testing
Changelog
Please see CHANGELOG for more information what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
Credits
- Ahmet Özisik
- All Contributors
License
The MIT License (MIT). Please see License File for more information.
