https://github.com/phanxipang/peak
Send multiple requests concurrently using any PSR-18 client implementations
https://github.com/phanxipang/peak
async concurrent http parralel psr-18
Last synced: 20 days ago
JSON representation
Send multiple requests concurrently using any PSR-18 client implementations
- Host: GitHub
- URL: https://github.com/phanxipang/peak
- Owner: phanxipang
- License: mit
- Created: 2023-03-28T15:01:04.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-11-05T13:21:41.000Z (about 2 years ago)
- Last Synced: 2025-12-14T18:05:28.551Z (about 2 months ago)
- Topics: async, concurrent, http, parralel, psr-18
- Language: PHP
- Homepage:
- Size: 70.3 KB
- Stars: 7
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Peak
[![Latest Version on Packagist][ico-version]][link-packagist]
[![Github Actions][ico-gh-actions]][link-gh-actions]
[![Codecov][ico-codecov]][link-codecov]
[![Total Downloads][ico-downloads]][link-downloads]
[![Software License][ico-license]](LICENSE.md)
A simple and efficient solution for concurrently sending HTTP requests using PSR-18 client implementations.
Peak is a library that enables concurrent request sending using a request pool. It leverages the event loop of [AMPHP](https://github.com/amphp), [ReactPHP](https://github.com/reactphp) or [PSL](https://github.com/azjezz/psl) to handle and manage the requests concurrently.
## Requirements
- PHP 8.1 or higher.
- A package that supports non-block I/O using Fibers under the hood (now refer as **driver**).
## Installation
You can install the package via composer:
```bash
composer require fansipan/peak
```
Additionally, depending on your choice of driver, these packages may also need to be installed.
### AMPHP
```bash
composer require amphp/pipeline
```
### PSL
```bash
composer require azjezz/psl
```
### ReactPHP
```bash
composer require clue/mq-react react/async
```
## Usage
### Create Request Pool
Typical applications would use the `PoolFactory` class to create a pool.
```php
use Fansipan\Peak\PoolFactory;
/** @var \Psr\Http\Client\ClientInterface $client */
$pool = PoolFactory::createForClient($client);
```
It will attempt to create async version of the client using `AsyncClientFactory`. The supported clients are [Guzzle](https://github.com/guzzle/guzzle) and [Symfony HTTPClient](https://github.com/symfony/http-client) ([`Psr18Client`](https://symfony.com/doc/current/http_client.html#psr-18-and-psr-17)).
> You can use any PSR-18 client implementations with ReactPHP driver. If an unsupported client is used, it will be replaced with the [`Browser`](https://github.com/reactphp/http#browser) HTTP client (require `react/http` installed).
The `Fansipan\Peak\PoolFactory` provides a configured request pool based on the installed packages, which is suitable for most cases. However, if desired, you can specify a particular implementation if it is available on your platform and/or in your application.
First, you need to create your desired driver:
```php
use Fansipan\Peak\Concurrency\AmpDeferred;
use Fansipan\Peak\Concurrency\PslDeferred;
use Fansipan\Peak\Concurrency\ReactDeferred;
// AMPHP
$defer = new AmpDeferred();
// PSL
$defer = new PslDeferred();
// ReactPHP
$defer = new ReactDeferred();
```
Then create an asynchronous client, which is essentially a decorator for the PSR-18 client:
```php
use Fansipan\Peak\Client\GuzzleClient;
use Fansipan\Peak\Client\SymfonyClient;
use Fansipan\Peak\ClientPool;
// Guzzle
$asyncClient = new GuzzleClient($defer);
// or using existing Guzzle client
/** @var \GuzzleHttp\ClientInterface $client */
$asyncClient = new GuzzleClient($defer, $client);
// Symfony HTTP Client
$asyncClient = new SymfonyClient($defer);
// or using existing Symfony client
/** @var \Symfony\Contracts\HttpClient\HttpClientInterface $client */
$asyncClient = new SymfonyClient($defer, $client);
$pool = new ClientPool($asyncClient);
```
### Sending Requests
The `send` method accepts an iterator of PSR-7 requests or closures/invokable class which receive an `Psr\Http\Client\ClientInterface` instance.
```php
use Psr\Http\Client\ClientInterface;
use Psr\Http\Message\RequestInterface;
use Psr\Http\Message\ResponseInterface;
// Using array
$responses = $pool->send([
$psr7Request,
fn (ClientInterface $client): ResponseInterface => $client->sendRequest($psr7Request),
]);
var_dump($responses[0]);
var_dump($responses[1]);
// Using generator when you have an indeterminate amount of requests you wish to send
$requests = static function (int $total) {
for ($i = 0; $i < $total; $i++) {
yield $psr7Request;
}
}
$responses = $pool->send($requests(100));
```
### Retrieving Responses
As you can see from the example above, each response instance can be accessed using an index. However, the response order is not guaranteed. If you wish, you can assign names to the requests to easily track the specific requests that have been sent. This allows you to access the corresponding responses by their assigned names.
```php
use Psr\Http\Client\ClientInterface;
use Psr\Http\Message\RequestInterface;
use Psr\Http\Message\ResponseInterface;
$responses = $pool->send([
'first' => $psr7Request,
'second' => fn (ClientInterface $client): ResponseInterface => $client->sendRequest($psr7Request),
]);
// Or using generator
$requests = function (): \Generator {
yield 'first' => $psr7Request;
yield 'second' => fn (ClientInterface $client): ResponseInterface => $client->sendRequest($psr7Request);
};
$responses = $pool->send($requests());
var_dump($responses['first']);
var_dump($responses['second']);
```
### Concurrency Limit
Sending an excessive number of requests may either take up all resources on your side or it may even get you banned by the remote side if it sees an unreasonable number of requests from your side.
As a consequence, it's usually recommended to limit concurrency on the sending side to a reasonable value. It's common to use a rather small limit, as doing more than a dozen of things at once may easily overwhelm the receiving side.
You can use `concurrent` method to set the maximum number of requests to send concurrently. The default value is `25`.
```php
$response = $pool
->concurrent(10) // Process up to 10 requests concurrently
->send($requests);
```
Additional requests that exceed the concurrency limit will automatically be enqueued until one of the pending requests completes.
## Testing
```bash
composer test
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) and [CODE_OF_CONDUCT](CODE_OF_CONDUCT.md) for details.
## Security
If you discover any security related issues, please email contact@lynh.me instead of using the issue tracker.
## Credits
- [Lynh](https://github.com/jenky)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
[ico-version]: https://img.shields.io/packagist/v/fansipan/peak.svg?style=for-the-badge
[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=for-the-badge
[ico-gh-actions]: https://img.shields.io/github/actions/workflow/status/phanxipang/peak/testing.yml?branch=main&label=actions&logo=github&style=for-the-badge
[ico-codecov]: https://img.shields.io/codecov/c/github/phanxipang/peak?logo=codecov&style=for-the-badge
[ico-downloads]: https://img.shields.io/packagist/dt/fansipan/peak.svg?style=for-the-badge
[link-packagist]: https://packagist.org/packages/fansipan/peak
[link-gh-actions]: https://github.com/phanxipang/peak
[link-codecov]: https://codecov.io/gh/phanxipang/peak
[link-downloads]: https://packagist.org/packages/fansipan/peak