Download the PHP package algoyounes/idempotency without Composer
On this page you can find all versions of the php package algoyounes/idempotency. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download algoyounes/idempotency
More information about algoyounes/idempotency
Files in algoyounes/idempotency
Package idempotency
Short Description Laravel Idempotency Middleware package to prevent duplicate requests
License MIT
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 idempotency
Idempotency
Idempotency is a Laravel package that helps you make your requests idempotent. Idempotent requests can be safely retried without causing any side effects. This is useful when you're dealing with unreliable networks or when you want to prevent duplicate requests from being processed.
Features ✨
- Idempotent Requests: Ensure that requests can be safely retried without side effects.
- Middleware Integration: Easily add
idempotencymiddleware to routes or route groups. - Customizable Cache: Configure cache TTL and store for idempotency keys.
- Duplicate Handling: Choose between replaying cached responses or throwing exceptions for duplicate requests.
- Custom Resolvers: Implement custom logic for resolving user IDs or generating cache keys.
- Header-Based Idempotency: Use the
Idempotency-Keyheader to identify requests. - Race Condition Handling: Prevent race conditions with configurable lock wait times.
- Unauthenticated Support: Define a default user ID name for unauthenticated requests.
Installation
You can install the package via Composer:
You can publish the configuration file using the following command:
Here are the available options in the configuration file:
| Option | Default Value | Description |
|---|---|---|
enable |
true |
Enable or disable the idempotency middleware |
cache.ttl |
86400 (1 Day) |
The time-to-live for idempotency keys in minutes |
cache.store |
default |
The cache store to use for idempotency keys |
idempotency_header |
Idempotency-Key |
The header to use for idempotency keys |
idempotency_relayed_header |
Idempotency-Relayed |
The header for relaying idempotency keys |
duplicate_handling |
replay |
The action to take when a duplicate request is detected. Options are replay or exception |
enforced_verbs |
['GET', 'POST', 'PUT', 'PATCH', 'DELETE'] |
The HTTP verbs to enforce idempotency on |
max_lock_wait_time |
10 (10 seconds) |
The maximum time to wait for a lock in seconds |
user_id_resolver |
null |
The user ID resolver to use for generating cache keys |
unauthenticated_user_id |
guest |
The default user ID name for unauthenticated requests |
Usage
To request idempotent, try adding something like idempotency middleware to the route or group of routes you want to protect. The middleware will check if the request is idempotent by looking for the Idempotency-Key header. If the header is present, the middleware will cache the response and reuse it for subsequent requests with the same key.
You can also add the middleware to a group of routes:
Custom Resolver 🔧
You can create your resolver by implementing the Resolver interface.
This is useful when you want to store the cache in a different store or when you want to customize the key generation logic.
Contributing
Thank you for considering contributing to the Idempotency package. For more details, please check the CONTRIBUTING file.
License
The Idempotency package is open-sourced software licensed under the MIT license.
