Skip to content

Commit 3562529

Browse files
glaubinixglaubinix
authored
Psr17: prevent usage of deprecated StreamFactory and use StreamFactoryInterface instead (#87)
1 parent a4d05cf commit 3562529

File tree

4 files changed

+28
-29
lines changed

4 files changed

+28
-29
lines changed

‎CHANGELOG.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
11
# Change Log
22

3+
# Version 2
4+
5+
## 2.0.0 - (unreleased)
6+
7+
### Changed
8+
- Drop support of deprecated PHP-HTTP `StreamFactory`, only PSR-17 `StreamFactoryInterface` is now supported.
9+
310
# Version 1
411

512
## 1.8.0 - 2023-04-28

‎composer.json‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,12 @@
1414
"php": "^7.1 || ^8.0",
1515
"psr/cache": "^1.0 || ^2.0 || ^3.0",
1616
"php-http/client-common": "^1.9 || ^2.0",
17-
"php-http/message-factory": "^1.0",
17+
"psr/http-factory-implementation": "^1.0",
1818
"symfony/options-resolver": "^2.6 || ^3.0 || ^4.0 || ^5.0 || ^6.0"
1919
},
2020
"require-dev": {
21-
"phpspec/phpspec": "^5.1 || ^6.0 || ^7.0"
21+
"phpspec/phpspec": "^5.1 || ^6.0 || ^7.0",
22+
"nyholm/psr7": "^1.6.1"
2223
},
2324
"autoload": {
2425
"psr-4": {

‎spec/CachePluginSpec.php‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@
55
use Http\Client\Common\Plugin\Cache\Generator\SimpleGenerator;
66
use PhpSpec\Wrapper\Collaborator;
77
use Prophecy\Argument;
8-
use Http\Message\StreamFactory;
98
use Http\Promise\FulfilledPromise;
109
use PhpSpec\ObjectBehavior;
1110
use Psr\Cache\CacheItemInterface;
1211
use Psr\Cache\CacheItemPoolInterface;
1312
use Psr\Http\Message\RequestInterface;
1413
use Psr\Http\Message\ResponseInterface;
14+
use Psr\Http\Message\StreamFactoryInterface;
1515
use Psr\Http\Message\StreamInterface;
1616
use Psr\Http\Message\UriInterface;
1717
use Http\Client\Common\Plugin\CachePlugin;
@@ -20,11 +20,11 @@
2020
class CachePluginSpec extends ObjectBehavior
2121
{
2222
/**
23-
* @var StreamFactory&Collaborator
23+
* @var StreamFactoryInterface&Collaborator
2424
*/
2525
private $streamFactory;
2626

27-
function let(CacheItemPoolInterface $pool, StreamFactory $streamFactory)
27+
function let(CacheItemPoolInterface $pool, StreamFactoryInterface $streamFactory)
2828
{
2929
$this->streamFactory = $streamFactory;
3030
$this->beConstructedWith($pool, $streamFactory, [
@@ -126,7 +126,7 @@ function it_stores_post_requests_when_allowed(
126126
RequestInterface $request,
127127
UriInterface $uri,
128128
ResponseInterface $response,
129-
StreamFactory $streamFactory,
129+
StreamFactoryInterface $streamFactory,
130130
StreamInterface $stream
131131
) {
132132
$this->beConstructedWith($pool, $streamFactory, [
@@ -181,7 +181,7 @@ function it_does_not_allow_invalid_request_methods(
181181
CacheItemInterface $item,
182182
RequestInterface $request,
183183
ResponseInterface $response,
184-
StreamFactory $streamFactory,
184+
StreamFactoryInterface $streamFactory,
185185
StreamInterface $stream
186186
) {
187187
$this
@@ -312,7 +312,7 @@ function it_adds_etag_and_modfied_since_to_request(CacheItemPoolInterface $pool,
312312
$this->handleRequest($request, $next, function () {});
313313
}
314314

315-
function it_serves_a_cached_response(CacheItemPoolInterface $pool, CacheItemInterface $item, RequestInterface $request, UriInterface $uri, StreamInterface $requestBody, ResponseInterface $response, StreamInterface $stream, StreamFactory $streamFactory)
315+
function it_serves_a_cached_response(CacheItemPoolInterface $pool, CacheItemInterface $item, RequestInterface $request, UriInterface $uri, StreamInterface $requestBody, ResponseInterface $response, StreamInterface $stream, StreamFactoryInterface $streamFactory)
316316
{
317317
$httpBody = 'body';
318318

@@ -343,7 +343,7 @@ function it_serves_a_cached_response(CacheItemPoolInterface $pool, CacheItemInte
343343
$this->handleRequest($request, $next, function () {});
344344
}
345345

346-
function it_serves_and_resaved_expired_response(CacheItemPoolInterface $pool, CacheItemInterface $item, RequestInterface $request, UriInterface $uri, StreamInterface $requestStream, ResponseInterface $response, StreamInterface $stream, StreamFactory $streamFactory)
346+
function it_serves_and_resaved_expired_response(CacheItemPoolInterface $pool, CacheItemInterface $item, RequestInterface $request, UriInterface $uri, StreamInterface $requestStream, ResponseInterface $response, StreamInterface $stream, StreamFactoryInterface $streamFactory)
347347
{
348348
$httpBody = 'body';
349349

@@ -398,7 +398,7 @@ function it_caches_private_responses_when_allowed(
398398
RequestInterface $request,
399399
UriInterface $uri,
400400
ResponseInterface $response,
401-
StreamFactory $streamFactory,
401+
StreamFactoryInterface $streamFactory,
402402
StreamInterface $stream
403403
) {
404404
$this->beConstructedThrough('clientCache', [$pool, $streamFactory, [
@@ -452,7 +452,7 @@ function it_does_not_store_responses_of_requests_to_blacklisted_paths(
452452
RequestInterface $request,
453453
UriInterface $uri,
454454
ResponseInterface $response,
455-
StreamFactory $streamFactory,
455+
StreamFactoryInterface $streamFactory,
456456
StreamInterface $stream
457457
) {
458458
$this->beConstructedThrough('clientCache', [$pool, $streamFactory, [
@@ -498,7 +498,7 @@ function it_stores_responses_of_requests_not_in_blacklisted_paths(
498498
RequestInterface $request,
499499
UriInterface $uri,
500500
ResponseInterface $response,
501-
StreamFactory $streamFactory,
501+
StreamFactoryInterface $streamFactory,
502502
StreamInterface $stream
503503
) {
504504
$this->beConstructedThrough('clientCache', [$pool, $streamFactory, [
@@ -550,7 +550,7 @@ function it_stores_responses_of_requests_not_in_blacklisted_paths(
550550
function it_can_be_initialized_with_custom_cache_key_generator(
551551
CacheItemPoolInterface $pool,
552552
CacheItemInterface $item,
553-
StreamFactory $streamFactory,
553+
StreamFactoryInterface $streamFactory,
554554
RequestInterface $request,
555555
UriInterface $uri,
556556
ResponseInterface $response,

‎src/CachePlugin.php‎

Lines changed: 7 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,6 @@
66
use Http\Client\Common\Plugin\Exception\RewindStreamException;
77
use Http\Client\Common\Plugin\Cache\Generator\CacheKeyGenerator;
88
use Http\Client\Common\Plugin\Cache\Generator\SimpleGenerator;
9-
use Http\Client\Common\Plugin\Cache\Listener\CacheListener;
10-
use Http\Message\StreamFactory;
119
use Http\Promise\FulfilledPromise;
1210
use Http\Promise\Promise;
1311
use Psr\Cache\CacheItemInterface;
@@ -35,7 +33,7 @@ final class CachePlugin implements Plugin
3533
private $pool;
3634

3735
/**
38-
* @var StreamFactory|StreamFactoryInterface
36+
* @var StreamFactoryInterface
3937
*/
4038
private $streamFactory;
4139

@@ -52,8 +50,7 @@ final class CachePlugin implements Plugin
5250
private $noCacheFlags = ['no-cache', 'private', 'no-store'];
5351

5452
/**
55-
* @param StreamFactory|StreamFactoryInterface $streamFactory
56-
* @param mixed[] $config
53+
* @param mixed[] $config
5754
*
5855
* bool respect_cache_headers: Whether to look at the cache directives or ignore them
5956
* int default_ttl: (seconds) If we do not respect cache headers or can't calculate a good ttl, use this value
@@ -69,12 +66,8 @@ final class CachePlugin implements Plugin
6966
* Defaults to an empty array
7067
* }
7168
*/
72-
public function __construct(CacheItemPoolInterface $pool, $streamFactory, array $config = [])
69+
public function __construct(CacheItemPoolInterface $pool, StreamFactoryInterface $streamFactory, array $config = [])
7370
{
74-
if (!($streamFactory instanceof StreamFactory) && !($streamFactory instanceof StreamFactoryInterface)) {
75-
throw new \TypeError(\sprintf('Argument 2 passed to %s::__construct() must be of type %s|%s, %s given.', self::class, StreamFactory::class, StreamFactoryInterface::class, \is_object($streamFactory) ? \get_class($streamFactory) : \gettype($streamFactory)));
76-
}
77-
7871
$this->pool = $pool;
7972
$this->streamFactory = $streamFactory;
8073

@@ -95,12 +88,11 @@ public function __construct(CacheItemPoolInterface $pool, $streamFactory, array
9588
* This method will setup the cachePlugin in client cache mode. When using the client cache mode the plugin will
9689
* cache responses with `private` cache directive.
9790
*
98-
* @param StreamFactory|StreamFactoryInterface $streamFactory
99-
* @param mixed[] $config For all possible config options see the constructor docs
91+
* @param mixed[] $config For all possible config options see the constructor docs
10092
*
10193
* @return CachePlugin
10294
*/
103-
public static function clientCache(CacheItemPoolInterface $pool, $streamFactory, array $config = [])
95+
public static function clientCache(CacheItemPoolInterface $pool, StreamFactoryInterface $streamFactory, array $config = [])
10496
{
10597
// Allow caching of private requests
10698
if (\array_key_exists('respect_response_cache_directives', $config)) {
@@ -118,12 +110,11 @@ public static function clientCache(CacheItemPoolInterface $pool, $streamFactory,
118110
* This method will setup the cachePlugin in server cache mode. This is the default caching behavior it refuses to
119111
* cache responses with the `private`or `no-cache` directives.
120112
*
121-
* @param StreamFactory|StreamFactoryInterface $streamFactory
122-
* @param mixed[] $config For all possible config options see the constructor docs
113+
* @param mixed[] $config For all possible config options see the constructor docs
123114
*
124115
* @return CachePlugin
125116
*/
126-
public static function serverCache(CacheItemPoolInterface $pool, $streamFactory, array $config = [])
117+
public static function serverCache(CacheItemPoolInterface $pool, StreamFactoryInterface $streamFactory, array $config = [])
127118
{
128119
return new self($pool, $streamFactory, $config);
129120
}

0 commit comments

Comments
 (0)