Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
* text=auto eol=lf

/tests export-ignore
.editorconfig export-ignore
.gitattributes export-ignore
.gitignore export-ignore
.php_cs export-ignore
.travis.yml export-ignore
phpcs.xml.dist export-ignore
phpunit.xml.dist export-ignore
/tests export-ignore
.editorconfig export-ignore
.gitattributes export-ignore
.gitignore export-ignore
.php-cs-fixer.php export-ignore
phpcs.xml.dist export-ignore
phpunit.xml.dist export-ignore
.phpstan.neon export-ignore
47 changes: 22 additions & 25 deletions .github/workflows/main.yaml
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
name: "testing"

on:
push:
branches: [ master ]
pull_request:
branches: [ master ]
push:
branches: [ master ]
pull_request:
branches: [ master ]

jobs:
qa:
Expand All @@ -13,19 +13,19 @@ jobs:

steps:
- name: Checkout
uses: actions/checkout@v2
uses: actions/checkout@v4

- name: Validate composer.json and composer.lock
run: composer validate

- name: Cache Composer packages
id: composer-cache
uses: actions/cache@v2
uses: actions/cache@v4
with:
path: vendor
key: ${{ runner.os }}-php-${{ hashFiles('**/composer.lock') }}
restore-keys: |
${{ runner.os }}-php-
path: vendor
key: ${{ runner.os }}-php-${{ hashFiles('**/composer.lock') }}
restore-keys: |
${{ runner.os }}-php-

- name: Install dependencies
if: steps.composer-cache.outputs.cache-hit != 'true'
Expand All @@ -40,37 +40,34 @@ jobs:

strategy:
matrix:
php:
- 7.2
- 7.3
- 7.4
composer-args: [ "" ]
include:
- php: 8.0
composer-args: --ignore-platform-reqs
fail-fast: false
php:
- 7.2
- 7.3
- 7.4
- 8.0
- 8.1
- 8.2
- 8.3
- 8.4

steps:
- name: Checkout
uses: actions/checkout@v2
uses: actions/checkout@v4

- name: Install PHP
uses: shivammathur/setup-php@v2
with:
php-version: ${{ matrix.php }}

- name: Cache PHP dependencies
uses: actions/cache@v2
uses: actions/cache@v4
with:
path: vendor
key: ${{ runner.os }}-php-${{ matrix.php }}-composer-${{ hashFiles('**/composer.json') }}
restore-keys: ${{ runner.os }}-php-${{ matrix.php }}-composer-

- name: Install dependencies
run: composer install --prefer-dist --no-progress ${{ matrix.composer-args }}
run: composer install --prefer-dist --no-progress

- name: Tests
run: composer test

- name: Tests coverage
run: composer coverage
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,5 @@ vendor
composer.lock
coverage
*.cache
.idea
kit
10 changes: 10 additions & 0 deletions .php-cs-fixer.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
<?php

return My\PhpCsFixerConfig::create()
->setFinder(
PhpCsFixer\Finder::create()
->files()
->name('*.php')
->in(__DIR__.'/src')
->in(__DIR__.'/tests')
);
5 changes: 5 additions & 0 deletions .phpstan.neon
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
parameters:
level: 8
paths:
- src
- tests
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](http://keepachangelog.com/)
and this project adheres to [Semantic Versioning](http://semver.org/).

## [2.1.0] - 2025-03-21
### Added
- Support for PHP 8.4

## [2.0.0] - 2020-12-03
### Added
- Support for PHP 8
Expand Down Expand Up @@ -50,6 +54,7 @@ First version

[#2]: https://github.com/middlewares/proxy/issues/2

[2.1.0]: https://github.com/middlewares/proxy/compare/v2.0.0...v2.1.0
[2.0.0]: https://github.com/middlewares/proxy/compare/v1.1.1...v2.0.0
[1.1.1]: https://github.com/middlewares/proxy/compare/v1.1.0...v1.1.1
[1.1.0]: https://github.com/middlewares/proxy/compare/v1.0.0...v1.1.0
Expand Down
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The MIT License (MIT)

Copyright (c) 2019
Copyright (c) 2019-2025

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
18 changes: 9 additions & 9 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,17 +16,17 @@
},
"require": {
"php": "^7.2 || ^8.0",
"guzzlehttp/guzzle": "^6.2",
"psr/http-server-middleware": "^1.0"
"guzzlehttp/guzzle": "^6 || ^7",
"psr/http-server-middleware": "^1"
},
"require-dev": {
"middlewares/utils": "^3.0",
"phpunit/phpunit": "^8|^9",
"friendsofphp/php-cs-fixer": "^2.0",
"squizlabs/php_codesniffer": "^3.0",
"oscarotero/php-cs-fixer-config": "^1.0",
"phpstan/phpstan": "^0.12",
"laminas/laminas-diactoros": "^2.3"
"middlewares/utils": "^2 || ^3 || ^4",
"phpunit/phpunit": "^8 || ^9",
"friendsofphp/php-cs-fixer": "^3",
"squizlabs/php_codesniffer": "^3",
"oscarotero/php-cs-fixer-config": "^2",
"phpstan/phpstan": "^1 || ^2",
"laminas/laminas-diactoros": "^2 || ^3"
},
"autoload": {
"psr-4": {
Expand Down
16 changes: 16 additions & 0 deletions phpcs.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
<?xml version="1.0"?>
<ruleset name="Middlewares coding standard">
<description>Middlewares coding standard</description>

<!-- display progress -->
<arg value="p"/>
<arg name="report" value="full"/>
<arg name="colors"/>

<!-- coding standard -->
<rule ref="PSR2"/>

<!-- Paths to check -->
<file>src</file>
<file>tests</file>
</ruleset>
33 changes: 33 additions & 0 deletions phpunit.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
<?xml version="1.0" encoding="UTF-8"?>
<phpunit bootstrap="vendor/autoload.php"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"
backupGlobals="false"
backupStaticAttributes="false"
beStrictAboutOutputDuringTests="true"
beStrictAboutTestsThatDoNotTestAnything="true"
beStrictAboutTodoAnnotatedTests="true"
colors="true"
verbose="true"
convertErrorsToExceptions="true"
convertNoticesToExceptions="true"
convertWarningsToExceptions="true"
processIsolation="false"
stopOnFailure="false"
failOnWarning="true">
<testsuites>
<testsuite name="PhpSession test suite">
<directory>tests</directory>
</testsuite>
</testsuites>

<filter>
<whitelist addUncoveredFilesFromWhitelist="true" processUncoveredFilesFromWhitelist="true">
<directory>./src</directory>
<exclude>
<directory>./tests</directory>
<directory>./vendor</directory>
</exclude>
</whitelist>
</filter>
</phpunit>
15 changes: 10 additions & 5 deletions src/Proxy.php
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
use Psr\Http\Message\UriInterface;
use Psr\Http\Server\MiddlewareInterface;
use Psr\Http\Server\RequestHandlerInterface;
use RuntimeException;

class Proxy implements MiddlewareInterface
{
Expand All @@ -26,7 +27,7 @@ class Proxy implements MiddlewareInterface
private $client;

/**
* @var array
* @var array<string,mixed>
*/
private $options = [];

Expand All @@ -50,6 +51,8 @@ public function client(ClientInterface $client): self

/**
* Set the client options
*
* @param array<string,mixed> $options
*/
public function options(array $options): self
{
Expand Down Expand Up @@ -89,10 +92,12 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface

$detachedBody = $response->getBody()->detach();

if (null !== $detachedBody) {
$response = $response->withBody(new Stream($detachedBody));

return $response;
if ($detachedBody === null) {
throw new RuntimeException('Detached body is empty.');
}

$response = $response->withBody(new Stream($detachedBody));

return $response;
}
}
36 changes: 31 additions & 5 deletions tests/ProxyTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,13 @@
use Middlewares\Utils\Dispatcher;
use Middlewares\Utils\Factory;
use PHPUnit\Framework\TestCase;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\StreamInterface;
use RuntimeException;

class ProxyTest extends TestCase
{
public function testProxy()
public function testProxy(): void
{
$response = Dispatcher::run(
[
Expand All @@ -27,7 +30,7 @@ public function testProxy()
$this->assertNotFalse(stripos($html, 'middlewares/psr15-middlewares'));
}

public function testOptionsAndClient()
public function testOptionsAndClient(): void
{
$received = false;
$response = Dispatcher::run(
Expand All @@ -50,7 +53,7 @@ public function testOptionsAndClient()
$this->assertTrue($received);
}

public function testError()
public function testError(): void
{
$response = Dispatcher::run(
[
Expand All @@ -64,7 +67,7 @@ public function testError()
$this->assertEquals(404, $response->getStatusCode());
}

public function testTargetPath()
public function testTargetPath(): void
{
$response = Dispatcher::run(
[
Expand All @@ -85,7 +88,7 @@ public function testTargetPath()
*
* @see https://github.com/middlewares/proxy/issues/1
*/
public function testRethrowsExceptionIfNoResponse()
public function testRethrowsExceptionIfNoResponse(): void
{
$client = $this->createMock(Client::class);
$request = Factory::createServerRequest('GET', 'http://example.com/middlewares/psr15-middlewares');
Expand All @@ -101,4 +104,27 @@ public function testRethrowsExceptionIfNoResponse()
$request
);
}

public function testWhenDettachedBodyIsEmptyThrowsAnException(): void
{
$client = $this->createMock(Client::class);
$request = Factory::createServerRequest('GET', 'http://example.com/middlewares/psr15-middlewares');

$stream = $this->createMock(StreamInterface::class);
$stream->method('detach')->willReturn(null);

$response = $this->createMock(ResponseInterface::class);
$response->method('getBody')->willReturn($stream);

$client->method('send')->willReturn($response);

$this->expectException(RuntimeException::class);

Dispatcher::run(
[
(new Proxy(Factory::createUri('https://github.com')))->client($client),
],
$request
);
}
}