Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
| 1 | <?php declare(strict_types=1); |
||
| 15 | final class MiddlewareRunner |
||
| 16 | { |
||
| 17 | const TRAITS = [ |
||
| 18 | 'pre' => PreTrait::class, |
||
| 19 | 'post' => PostTrait::class, |
||
| 20 | 'error' => ErrorTrait::class, |
||
| 21 | ]; |
||
| 22 | |||
| 23 | /** |
||
| 24 | * @var array |
||
| 25 | */ |
||
| 26 | private $options; |
||
| 27 | |||
| 28 | /** |
||
| 29 | * @var MiddlewareInterface[] |
||
| 30 | */ |
||
| 31 | private $middlewares; |
||
| 32 | |||
| 33 | /** |
||
| 34 | * @var AnnotationReader |
||
| 35 | */ |
||
| 36 | private $annotationReader; |
||
| 37 | |||
| 38 | /** |
||
| 39 | * @var string |
||
| 40 | */ |
||
| 41 | private $id; |
||
| 42 | |||
| 43 | /** |
||
| 44 | * MiddlewareRunner constructor. |
||
| 45 | * @param array $options |
||
| 46 | * @param MiddlewareInterface[] $middlewares |
||
| 47 | */ |
||
| 48 | 2 | public function __construct(array $options, MiddlewareInterface ...$middlewares) |
|
| 55 | |||
| 56 | /** |
||
| 57 | * @param RequestInterface $request |
||
| 58 | * @return CancellablePromiseInterface |
||
| 59 | */ |
||
| 60 | 2 | View Code Duplication | public function pre( |
| 61 | RequestInterface $request |
||
| 62 | ): CancellablePromiseInterface { |
||
| 63 | 2 | $promise = resolve($request); |
|
| 64 | |||
| 65 | 2 | $middlewares = $this->middlewares; |
|
| 66 | 2 | $middlewares = $this->orderMiddlewares('pre', ...$middlewares); |
|
| 67 | |||
| 68 | 2 | foreach ($middlewares as $middleware) { |
|
| 69 | 2 | $requestMiddleware = $middleware; |
|
| 70 | 2 | $promise = $promise->then(function (RequestInterface $request) use ($requestMiddleware) { |
|
| 71 | 2 | return $requestMiddleware->pre($request, $this->id, $this->options); |
|
| 72 | 2 | }); |
|
| 73 | } |
||
| 74 | |||
| 75 | 2 | return $promise; |
|
| 76 | } |
||
| 77 | |||
| 78 | /** |
||
| 79 | * @param ResponseInterface $response |
||
| 80 | * @return CancellablePromiseInterface |
||
| 81 | */ |
||
| 82 | 2 | View Code Duplication | public function post( |
| 83 | ResponseInterface $response |
||
| 84 | ): CancellablePromiseInterface { |
||
| 85 | 2 | $promise = resolve($response); |
|
| 86 | |||
| 87 | 2 | $middlewares = $this->middlewares; |
|
| 88 | 2 | $middlewares = $this->orderMiddlewares('post', ...$middlewares); |
|
| 89 | |||
| 90 | 2 | foreach ($middlewares as $middleware) { |
|
| 91 | 2 | $responseMiddleware = $middleware; |
|
| 92 | 2 | $promise = $promise->then(function (ResponseInterface $response) use ($responseMiddleware) { |
|
| 93 | 2 | return $responseMiddleware->post($response, $this->id, $this->options); |
|
| 94 | 2 | }); |
|
| 95 | } |
||
| 96 | |||
| 97 | 2 | return $promise; |
|
| 98 | } |
||
| 99 | |||
| 100 | /** |
||
| 101 | * @param Throwable $throwable |
||
| 102 | * @return CancellablePromiseInterface |
||
| 103 | */ |
||
| 104 | 2 | View Code Duplication | public function error( |
| 105 | Throwable $throwable |
||
| 106 | ): CancellablePromiseInterface { |
||
| 107 | 2 | $promise = reject($throwable); |
|
| 108 | |||
| 109 | 2 | $middlewares = $this->middlewares; |
|
| 110 | 2 | $middlewares = $this->orderMiddlewares('error', ...$middlewares); |
|
| 111 | |||
| 112 | 2 | foreach ($middlewares as $middleware) { |
|
| 113 | 2 | $errorMiddleware = $middleware; |
|
| 114 | 2 | $promise = $promise->then(null, function (Throwable $throwable) use ($errorMiddleware) { |
|
| 115 | 2 | return reject($errorMiddleware->error($throwable, $this->id, $this->options)); |
|
| 116 | 2 | }); |
|
| 117 | } |
||
| 118 | |||
| 119 | 2 | return $promise; |
|
| 120 | } |
||
| 121 | |||
| 122 | /** |
||
| 123 | * Sort the middlewares by priority. |
||
| 124 | * |
||
| 125 | * @param string $method |
||
| 126 | * @param MiddlewareInterface[] $middlewares |
||
| 127 | * @return array |
||
| 128 | */ |
||
| 129 | protected function orderMiddlewares(string $method, MiddlewareInterface ...$middlewares): array |
||
| 140 | |||
| 141 | 2 | private function getPriority(string $method, MiddlewareInterface $middleware): int |
|
| 156 | } |
||
| 157 |
Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property.
Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property..