MiddlewarePipeline::mountResponse() - Code Metrics - Inspection of "more tests" - spiral/framework - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — 09branch (946dde)

by Anton

created 2017-02-01 23:11 UTC

MiddlewarePipeline::mountResponse() B

↳ Parent: MiddlewarePipeline

Complexity

Conditions	4
Paths	32

Size

Total Lines	31
Code Lines	19

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	4
eloc	19
nc	32
nop	2
dl	0
loc	31
rs	8.5806
c	0
b	0
f	0

<?php
/**
 * Spiral Framework.
 *
 * @license   MIT
 * @author    Anton Titov (Wolfy-J)
 */

namespace Spiral\Http;

use Psr\Http\Message\ResponseInterface as Response;
use Psr\Http\Message\ServerRequestInterface as Request;
use Spiral\Core\ContainerInterface;
use Spiral\Core\Exceptions\ScopeException;
use Spiral\Http\Exceptions\MiddlewareException;
use Spiral\Http\Traits\JsonTrait;
use Spiral\Http\Traits\MiddlewaresTrait;

/**
 * Pipeline used to pass request and response thought the chain of middlewares.
 *
 * Spiral middlewares are similar to Laravel's one. However router and http itself
 * can be in used in zend expressive.
 */
class MiddlewarePipeline
{
    use JsonTrait, MiddlewaresTrait;

    /**
     * @invisible
     * @var ContainerInterface
     */
    private $container;

    /**
     * Endpoint should be called at the deepest level of pipeline.
     *
     * @var callable
     */
    private $target = null;

    /**
     * @param callable[]|MiddlewareInterface[] $middlewares
     * @param ContainerInterface               $container Spiral container is needed, due scoping.
     *
     * @throws ScopeException
     */
    public function __construct(array $middlewares = [], ContainerInterface $container)
    {
        $this->middlewares = $middlewares;
        $this->container = $container;
    }

    /**
     * Set pipeline target.
     *
     * @param callable $target
     *
     * @return $this|self
     */
    public function target(callable $target): MiddlewarePipeline
    {
        $this->target = $target;

        return $this;
    }

    /**
     * @param Request  $request
     * @param Response $response
     *
     * @return Response
     */
    public function __invoke(Request $request, Response $response): Response
    {
        return $this->run($request, $response);
    }

    /**
     * Pass request and response though every middleware to target and return generated and wrapped
     * response.
     *
     * @param Request  $request
     * @param Response $response
     *
     * @return Response
     *
     * @throws MiddlewareException
     */
    public function run(Request $request, Response $response): Response
    {
        if (empty($this->target)) {
            throw new MiddlewareException("Unable to run pipeline without specified target");
        }

        return $this->next(0, $request, $response);
    }

    /**
     * Get next chain to be called. Exceptions will be converted to responses.
     *
     * @param int      $position
     * @param Request  $request
     * @param Response $response
     *
     * @return null|Response
     * @throws \Exception
     */
    protected function next(int $position, Request $request, Response $response)
    {
        if (!isset($this->middlewares[$position])) {
            //Middleware target endpoint to be called and converted into response
            return $this->mountResponse($request, $response);
        }

        /**
         * @var callable $next
         */
        $next = $this->middlewares[$position];

        if (is_string($next)) {
            //Resolve using container
            $next = $this->container->get($next);
        }

        //Executing next middleware
        return $next($request, $response, $this->getNext($position, $request, $response));
    }

    /**
     * Run pipeline target and return generated response.
     *
     * @param Request  $request
     * @param Response $response
     *
     * @return Response
     *
     * @throws \Throwable
     */
    protected function mountResponse(Request $request, Response $response): Response
    {
        $outputLevel = ob_get_level();
        ob_start();

        $output = '';
        $result = null;

        $scope = [
            $this->container->replace(Request::class, $request),
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            $this->container->replace(Response::class, $response)
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        ];

        try {
            $result = call_user_func($this->target, $request, $response);
        } catch (\Throwable $e) {
            //Close buffer due error
            ob_get_clean();
            throw  $e;
        } finally {
            foreach (array_reverse($scope) as $payload) {
                $this->container->restore($payload);
            }

            while (ob_get_level() > $outputLevel + 1) {
                $output = ob_get_clean() . $output;
            }
        }

        return $this->wrapResponse($response, $result, ob_get_clean() . $output);
    }

    /**
     * Convert endpoint result into valid response.
     *
     * @param Response $response Initial pipeline response.
     * @param mixed    $result   Generated endpoint output.
     * @param string   $output   Buffer output.
     *
     * @return Response
     */
    private function wrapResponse(Response $response, $result = null, string $output = ''): Response
    {
        if ($result instanceof Response) {
            if (!empty($output) && $result->getBody()->isWritable()) {
                $result->getBody()->write($output);
            }

            return $result;
        }

        if (is_array($result) || $result instanceof \JsonSerializable) {
if ($x instanceof DoesNotExist) {
    // Do something.
}
            $response = $this->writeJson($response, $result);
        } else {
            $response->getBody()->write($result);
        }

        //Always glue buffered output
        $response->getBody()->write($output);

        return $response;
    }

    /**
     * Get next callable element.
     *
     * @param int      $position
     * @param Request  $outerRequest
     * @param Response $outerResponse
     *
     * @return \Closure
     */
    private function getNext(
        int $position,
        Request $outerRequest,
        Response $outerResponse
    ): \Closure {
        $next = function ($request = null, $response = null) use (
            $position,
            $outerRequest,
            $outerResponse
        ) {
            //This function will be provided to next (deeper) middleware
            return $this->next(
                ++$position,
                $request ?? $outerRequest,
                $response ?? $outerResponse
            );
        };

        return $next;
    }
}


Branch — 09branch (946dde)

MiddlewarePipeline::mountResponse() B

Complexity

Size

Duplication

Importance

1. Missing dependencies

2. Missing use statement

1			<?php
2			/**
3			* Spiral Framework.
4			*
5			* @license MIT
6			* @author Anton Titov (Wolfy-J)
7			*/
8
9			namespace Spiral\Http;
10
11			use Psr\Http\Message\ResponseInterface as Response;
12			use Psr\Http\Message\ServerRequestInterface as Request;
13			use Spiral\Core\ContainerInterface;
14			use Spiral\Core\Exceptions\ScopeException;
15			use Spiral\Http\Exceptions\MiddlewareException;
16			use Spiral\Http\Traits\JsonTrait;
17			use Spiral\Http\Traits\MiddlewaresTrait;
18
19			/**
20			* Pipeline used to pass request and response thought the chain of middlewares.
21			*
22			* Spiral middlewares are similar to Laravel's one. However router and http itself
23			* can be in used in zend expressive.
24			*/
25			class MiddlewarePipeline
26			{
27			use JsonTrait, MiddlewaresTrait;
28
29			/**
30			* @invisible
31			* @var ContainerInterface
32			*/
33			private $container;
34
35			/**
36			* Endpoint should be called at the deepest level of pipeline.
37			*
38			* @var callable
39			*/
40			private $target = null;
41
42			/**
43			* @param callable[]\|MiddlewareInterface[] $middlewares
44			* @param ContainerInterface $container Spiral container is needed, due scoping.
45			*
46			* @throws ScopeException
47			*/
48			public function __construct(array $middlewares = [], ContainerInterface $container)
49			{
50			$this->middlewares = $middlewares;
51			$this->container = $container;
52			}
53
54			/**
55			* Set pipeline target.
56			*
57			* @param callable $target
58			*
59			* @return $this\|self
60			*/
61			public function target(callable $target): MiddlewarePipeline
62			{
63			$this->target = $target;
64
65			return $this;
66			}
67
68			/**
69			* @param Request $request
70			* @param Response $response
71			*
72			* @return Response
73			*/
74			public function __invoke(Request $request, Response $response): Response
75			{
76			return $this->run($request, $response);
77			}
78
79			/**
80			* Pass request and response though every middleware to target and return generated and wrapped
81			* response.
82			*
83			* @param Request $request
84			* @param Response $response
85			*
86			* @return Response
87			*
88			* @throws MiddlewareException
89			*/
90			public function run(Request $request, Response $response): Response
91			{
92			if (empty($this->target)) {
93			throw new MiddlewareException("Unable to run pipeline without specified target");
94			}
95
96			return $this->next(0, $request, $response);
97			}
98
99			/**
100			* Get next chain to be called. Exceptions will be converted to responses.
101			*
102			* @param int $position
103			* @param Request $request
104			* @param Response $response
105			*
106			* @return null\|Response
107			* @throws \Exception
108			*/
109			protected function next(int $position, Request $request, Response $response)
110			{
111			if (!isset($this->middlewares[$position])) {
112			//Middleware target endpoint to be called and converted into response
113			return $this->mountResponse($request, $response);
114			}
115
116			/**
117			* @var callable $next
118			*/
119			$next = $this->middlewares[$position];
120
121			if (is_string($next)) {
122			//Resolve using container
123			$next = $this->container->get($next);
124			}
125
126			//Executing next middleware
127			return $next($request, $response, $this->getNext($position, $request, $response));
128			}
129
130			/**
131			* Run pipeline target and return generated response.
132			*
133			* @param Request $request
134			* @param Response $response
135			*
136			* @return Response
137			*
138			* @throws \Throwable
139			*/
140			protected function mountResponse(Request $request, Response $response): Response
141			{
142			$outputLevel = ob_get_level();
143			ob_start();
144
145			$output = '';
146			$result = null;
147
148			$scope = [
149			$this->container->replace(Request::class, $request),
			0 ignored issues – show Documentation introduced 2017-02-01 23:16 UTC by Report Bug Copy Issue Report `$request` is of type `object<Psr\Http\Message\ServerRequestInterface>`, but the function expects a `callable`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
150			$this->container->replace(Response::class, $response)
			0 ignored issues – show Documentation introduced 2017-02-01 23:16 UTC by Report Bug Copy Issue Report `$response` is of type `object<Psr\Http\Message\ResponseInterface>`, but the function expects a `callable`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
151			];
152
153			try {
154			$result = call_user_func($this->target, $request, $response);
155			} catch (\Throwable $e) {
156			//Close buffer due error
157			ob_get_clean();
158			throw $e;
159			} finally {
160			foreach (array_reverse($scope) as $payload) {
161			$this->container->restore($payload);
162			}
163
164			while (ob_get_level() > $outputLevel + 1) {
165			$output = ob_get_clean() . $output;
166			}
167			}
168
169			return $this->wrapResponse($response, $result, ob_get_clean() . $output);
170			}
171
172			/**
173			* Convert endpoint result into valid response.
174			*
175			* @param Response $response Initial pipeline response.
176			* @param mixed $result Generated endpoint output.
177			* @param string $output Buffer output.
178			*
179			* @return Response
180			*/
181			private function wrapResponse(Response $response, $result = null, string $output = ''): Response
182			{
183			if ($result instanceof Response) {
184			if (!empty($output) && $result->getBody()->isWritable()) {
185			$result->getBody()->write($output);
186			}
187
188			return $result;
189			}
190
191			if (is_array($result) \|\| $result instanceof \JsonSerializable) {
			0 ignored issues – show Bug introduced 2016-01-31 18:45 UTC by Report Bug Copy Issue Report The class `JsonSerializable` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
192			$response = $this->writeJson($response, $result);
193			} else {
194			$response->getBody()->write($result);
195			}
196
197			//Always glue buffered output
198			$response->getBody()->write($output);
199
200			return $response;
201			}
202
203			/**
204			* Get next callable element.
205			*
206			* @param int $position
207			* @param Request $outerRequest
208			* @param Response $outerResponse
209			*
210			* @return \Closure
211			*/
212			private function getNext(
213			int $position,
214			Request $outerRequest,
215			Response $outerResponse
216			): \Closure {
217			$next = function ($request = null, $response = null) use (
218			$position,
219			$outerRequest,
220			$outerResponse
221			) {
222			//This function will be provided to next (deeper) middleware
223			return $this->next(
224			++$position,
225			$request ?? $outerRequest,
226			$response ?? $outerResponse
227			);
228			};
229
230			return $next;
231			}
232			}
233

spiral / framework

Branch — 09branch (946dde)

MiddlewarePipeline::mountResponse() B

Complexity

Size

Duplication

Importance

1. Missing dependencies

2. Missing use statement

Duplication Side-by-Side

Filter issues like