BatchEndpointAction::validateBatchData() - Code Metrics - Inspection of "[WIP] General batch endpoint" - api-platform/core - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#1645)

by Yanick

created 2018-01-12 18:45 UTC

BatchEndpointAction::validateBatchData() A

↳ Parent: BatchEndpointAction

Complexity

Conditions	4
Paths	4

Size

Total Lines	14
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	14
rs	9.2
c	0
b	0
f	0
cc	4
eloc	7
nc	4
nop	1

<?php

/*
 * This file is part of the API Platform project.
 *
 * (c) Kévin Dunglas <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

declare(strict_types=1);

namespace ApiPlatform\Core\Action;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
use Symfony\Component\HttpKernel\HttpKernelInterface;

/**
 * Provides an endpoint for batch processing by splitting up
 *
 * @author Yanick Witschi <[email protected]>
 */
class BatchEndpointAction
{
    /**
     * @var HttpKernelInterface
     */
    private $kernel;

    /**
     * @var array
     */
    private $validKeys = [
        'path',
        'method',
        'headers',
        'body',
    ];

    /**
     * @param HttpKernelInterface $kernel
     */
    public function __construct(HttpKernelInterface $kernel)
    {
        $this->kernel = $kernel;
    }

    /**
     * Execute multiple subrequests from batch request.
     *
     * @param Request $request
     * @param array   $data
     *
     * @return array
     */
    public function __invoke(Request $request, array $data = null): array
    {
        if (!$this->validateBatchData((array) $data)) {
            throw new BadRequestHttpException('Batch request data not accepted.');
        }

        $result = [];

        foreach ($data as $k => $item) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }

            // Copy current headers if no specific provided for simplicity
            // otherwise one would have to provide Content-Type with every
            // single entry.
            if (!isset($item['headers'])) {
                $item['headers'] = $request->headers->all();
            }

            $result[] = $this->convertResponse(
                $this->executeSubRequest(
                    $k,
                    $item['path'],
                    $item['method'],
                    $item['headers'],
                    $item['body']
                )
            );
        }

        return $result;
    }

    /**
     * Converts a response into an array.
     *
     * @param Response $response
     *
     * @return array
     */
    private function convertResponse(Response $response): array
    {
        return [
            'status' => $response->getStatusCode(),
            'body' => $response->getContent(),
            'headers' => $response->headers->all(),
        ];
    }

    /**
     * Validates that the keys are all correctly present.
     *
     * @param array $data
     *
     * @return bool
     */
    private function validateBatchData(array $data)
    {
        if (0 === count($data)) {
            return false;
        }

        foreach ($data as $item) {
            if (0 !== count(array_diff(array_keys($item), $this->validKeys))) {
                return false;
            }
        }

        return true;
    }

    /**
     * Executes a subrequest.
     *
     * @param int    $index
     * @param string $path
     * @param string $method
     * @param array  $headers
     * @param string $body
     *
     * @return Response
     */
    private function executeSubRequest(int $index, string $path, string $method, array $headers, string $body): Response
    {
        $subRequest = Request::create($path, $method, [], [], [], [], $body);
        $subRequest->headers->replace($headers);

        try {
            return $this->kernel->handle($subRequest, HttpKernelInterface::SUB_REQUEST);
        } catch (\Exception $e) {
            return Response::create(sprintf('Batch element #%d failed, check the log files.', $index), 400);
        }
    }
}


1			<?php
2
3			/*
4			* This file is part of the API Platform project.
5			*
6			* (c) Kévin Dunglas <[email protected]>
7			*
8			* For the full copyright and license information, please view the LICENSE
9			* file that was distributed with this source code.
10			*/
11
12			declare(strict_types=1);
13
14			namespace ApiPlatform\Core\Action;
15			use Symfony\Component\HttpFoundation\Request;
16			use Symfony\Component\HttpFoundation\Response;
17			use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
18			use Symfony\Component\HttpKernel\HttpKernelInterface;
19
20			/**
21			* Provides an endpoint for batch processing by splitting up
22			*
23			* @author Yanick Witschi <[email protected]>
24			*/
25			class BatchEndpointAction
26			{
27			/**
28			* @var HttpKernelInterface
29			*/
30			private $kernel;
31
32			/**
33			* @var array
34			*/
35			private $validKeys = [
36			'path',
37			'method',
38			'headers',
39			'body',
40			];
41
42			/**
43			* @param HttpKernelInterface $kernel
44			*/
45			public function __construct(HttpKernelInterface $kernel)
46			{
47			$this->kernel = $kernel;
48			}
49
50			/**
51			* Execute multiple subrequests from batch request.
52			*
53			* @param Request $request
54			* @param array $data
55			*
56			* @return array
57			*/
58			public function __invoke(Request $request, array $data = null): array
59			{
60			if (!$this->validateBatchData((array) $data)) {
61			throw new BadRequestHttpException('Batch request data not accepted.');
62			}
63
64			$result = [];
65
66			foreach ($data as $k => $item) {
			0 ignored issues – show Bug introduced 2018-01-12 19:17 UTC by Report Bug Copy Issue Report The expression `$data` of type `null\|array` is not guaranteed to be traversable. How about adding an additional type check? There are different options of fixing this problem. If you want to be on the safe side, you can add an additional type-check: $collection = json_decode($data, true); if ( ! is_array($collection)) { throw new \RuntimeException('$collection must be an array.'); } foreach ($collection as $item) { /** ... / } If you are sure that the expression is traversable, you might want to add a doc comment cast* to improve IDE auto-completion and static analysis: /** @var array $collection / $collection = json_decode($data, true); foreach ($collection as $item) { /* .. / } Mark the issue as a false-positive*: Just hover the remove button, in the top-right corner of this issue for more options. Loading history...
67
68			// Copy current headers if no specific provided for simplicity
69			// otherwise one would have to provide Content-Type with every
70			// single entry.
71			if (!isset($item['headers'])) {
72			$item['headers'] = $request->headers->all();
73			}
74
75			$result[] = $this->convertResponse(
76			$this->executeSubRequest(
77			$k,
78			$item['path'],
79			$item['method'],
80			$item['headers'],
81			$item['body']
82			)
83			);
84			}
85
86			return $result;
87			}
88
89			/**
90			* Converts a response into an array.
91			*
92			* @param Response $response
93			*
94			* @return array
95			*/
96			private function convertResponse(Response $response): array
97			{
98			return [
99			'status' => $response->getStatusCode(),
100			'body' => $response->getContent(),
101			'headers' => $response->headers->all(),
102			];
103			}
104
105			/**
106			* Validates that the keys are all correctly present.
107			*
108			* @param array $data
109			*
110			* @return bool
111			*/
112			private function validateBatchData(array $data)
113			{
114			if (0 === count($data)) {
115			return false;
116			}
117
118			foreach ($data as $item) {
119			if (0 !== count(array_diff(array_keys($item), $this->validKeys))) {
120			return false;
121			}
122			}
123
124			return true;
125			}
126
127			/**
128			* Executes a subrequest.
129			*
130			* @param int $index
131			* @param string $path
132			* @param string $method
133			* @param array $headers
134			* @param string $body
135			*
136			* @return Response
137			*/
138			private function executeSubRequest(int $index, string $path, string $method, array $headers, string $body): Response
139			{
140			$subRequest = Request::create($path, $method, [], [], [], [], $body);
141			$subRequest->headers->replace($headers);
142
143			try {
144			return $this->kernel->handle($subRequest, HttpKernelInterface::SUB_REQUEST);
145			} catch (\Exception $e) {
146			return Response::create(sprintf('Batch element #%d failed, check the log files.', $index), 400);
147			}
148			}
149			}
150

api-platform / core

Pull Request — master (#1645)

BatchEndpointAction::validateBatchData() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like