RequestBodyParamConverter::throwException() - Code Metrics - Inspection of "Deprecate the maxDepth context attribute in favor..." - FriendsOfSymfony/FOSRestBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#1506)

by Guilh

created 2016-06-17 14:54 UTC

RequestBodyParamConverter::throwException() A

↳ Parent: RequestBodyParamConverter

Complexity

Conditions	2
Paths	2

Size

Total Lines	8
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	8
ccs	4
cts	4
cp	1
rs	9.4285
cc	2
eloc	4
nc	2
nop	2
crap	2

<?php

/*
 * This file is part of the FOSRestBundle package.
 *
 * (c) FriendsOfSymfony <http://friendsofsymfony.github.com/>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace FOS\RestBundle\Request;

use FOS\RestBundle\Context\Context;
use FOS\RestBundle\Serializer\Serializer;
use JMS\Serializer\Exception\Exception as JMSSerializerException;
use JMS\Serializer\Exception\UnsupportedFormatException;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\ParamConverter;
use Sensio\Bundle\FrameworkExtraBundle\Request\ParamConverter\ParamConverterInterface;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
use Symfony\Component\HttpKernel\Exception\UnsupportedMediaTypeHttpException;
use Symfony\Component\OptionsResolver\OptionsResolver;
use Symfony\Component\Serializer\Exception\ExceptionInterface as SymfonySerializerException;
use Symfony\Component\Validator\Validator\ValidatorInterface;

/**
 * @author Tyler Stroud <[email protected]>
 */
class RequestBodyParamConverter implements ParamConverterInterface
{
    private $serializer;
    private $context = [];
    private $validator;

    /**
     * The name of the argument on which the ConstraintViolationList will be set.
     *
     * @var null|string
     */
    private $validationErrorsArgument;

    /**
     * @param Serializer         $serializer
     * @param array|null         $groups                   An array of groups to be used in the serialization context
     * @param string|null        $version                  A version string to be used in the serialization context
     * @param ValidatorInterface $validator
     * @param string|null        $validationErrorsArgument
     *
     * @throws \InvalidArgumentException
     */
    public function __construct(
        Serializer $serializer,
        $groups = null,
        $version = null,
        ValidatorInterface $validator = null,
        $validationErrorsArgument = null
    ) {
        $this->serializer = $serializer;

        if (!empty($groups)) {
            $this->context['groups'] = (array) $groups;
        }

        if (!empty($version)) {
            $this->context['version'] = $version;
        }

        if (null !== $validator && null === $validationErrorsArgument) {
            throw new \InvalidArgumentException('"$validationErrorsArgument" cannot be null when using the validator');
        }

        $this->validator = $validator;
        $this->validationErrorsArgument = $validationErrorsArgument;
    }

    /**
     * {@inheritdoc}
     */
    public function apply(Request $request, ParamConverter $configuration)
    {
        $options = (array) $configuration->getOptions();

        if (isset($options['deserializationContext']) && is_array($options['deserializationContext'])) {
            $arrayContext = array_merge($this->context, $options['deserializationContext']);
        } else {
            $arrayContext = $this->context;
        }
        $this->configureContext($context = new Context(), $arrayContext);

        try {
            $object = $this->serializer->deserialize(
                $request->getContent(),

                $configuration->getClass(),
                $request->getContentType(),
                $context
            );
        } catch (UnsupportedFormatException $e) {
            return $this->throwException(new UnsupportedMediaTypeHttpException($e->getMessage(), $e), $configuration);
        } catch (JMSSerializerException $e) {
            return $this->throwException(new BadRequestHttpException($e->getMessage(), $e), $configuration);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        } catch (SymfonySerializerException $e) {
            return $this->throwException(new BadRequestHttpException($e->getMessage(), $e), $configuration);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

        $request->attributes->set($configuration->getName(), $object);

        if (null !== $this->validator) {
            $validatorOptions = $this->getValidatorOptions($options);

            $errors = $this->validator->validate($object, null, $validatorOptions['groups']);

            $request->attributes->set(
                $this->validationErrorsArgument,
                $errors
            );
        }

        return true;
    }

    /**
     * {@inheritdoc}
     */
    public function supports(ParamConverter $configuration)
    {
        return null !== $configuration->getClass();
    }

    /**
     * @param Context $context
     * @param array   $options
     */
    protected function configureContext(Context $context, array $options)
    {
        foreach ($options as $key => $value) {
            if ($key === 'groups') {
                $context->addGroups($options['groups']);
            } elseif ($key === 'version') {
                $context->setVersion($options['version']);
            } elseif ($key === 'maxDepth') {
                @trigger_error('Context attribute "maxDepth" is deprecated since version 2.1 and will be removed in 3.0. Use "enable_max_depth" instead.', E_USER_DEPRECATED);
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
                $context->setMaxDepth($options['maxDepth']);

            } elseif ($key === 'enableMaxDepth') {
                $context->enableMaxDepth($options['enableMaxDepth']);
            } elseif ($key === 'serializeNull') {
                $context->setSerializeNull($options['serializeNull']);
            } else {
                $context->setAttribute($key, $value);
            }
        }
    }

    /**
     * Throws an exception or return false if a ParamConverter is optional.
     */
    private function throwException(\Exception $exception, ParamConverter $configuration)
    {
        if ($configuration->isOptional()) {
            return false;
        }

        throw $exception;
    }

    /**
     * @param array $options
     *
     * @return array
     */
    private function getValidatorOptions(array $options)
    {
        $resolver = new OptionsResolver();
        $resolver->setDefaults([
            'groups' => null,
            'traverse' => false,
            'deep' => false,
        ]);

        return $resolver->resolve(isset($options['validator']) ? $options['validator'] : []);
    }
}


1		<?php
2
3		/*
4		* This file is part of the FOSRestBundle package.
5		*
6		* (c) FriendsOfSymfony <http://friendsofsymfony.github.com/>
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		namespace FOS\RestBundle\Request;
13
14		use FOS\RestBundle\Context\Context;
15		use FOS\RestBundle\Serializer\Serializer;
16		use JMS\Serializer\Exception\Exception as JMSSerializerException;
17		use JMS\Serializer\Exception\UnsupportedFormatException;
18		use Sensio\Bundle\FrameworkExtraBundle\Configuration\ParamConverter;
19		use Sensio\Bundle\FrameworkExtraBundle\Request\ParamConverter\ParamConverterInterface;
20		use Symfony\Component\HttpFoundation\Request;
21		use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
22		use Symfony\Component\HttpKernel\Exception\UnsupportedMediaTypeHttpException;
23		use Symfony\Component\OptionsResolver\OptionsResolver;
24		use Symfony\Component\Serializer\Exception\ExceptionInterface as SymfonySerializerException;
25		use Symfony\Component\Validator\Validator\ValidatorInterface;
26
27		/**
28		* @author Tyler Stroud <[email protected]>
29		*/
30		class RequestBodyParamConverter implements ParamConverterInterface
31		{
32		private $serializer;
33		private $context = [];
34		private $validator;
35
36		/**
37		* The name of the argument on which the ConstraintViolationList will be set.
38		*
39		* @var null\|string
40		*/
41		private $validationErrorsArgument;
42
43		/**
44		* @param Serializer $serializer
45		* @param array\|null $groups An array of groups to be used in the serialization context
46		* @param string\|null $version A version string to be used in the serialization context
47		* @param ValidatorInterface $validator
48		* @param string\|null $validationErrorsArgument
49		*
50		* @throws \InvalidArgumentException
51		*/
52	16	public function __construct(
53		Serializer $serializer,
54		$groups = null,
55		$version = null,
56		ValidatorInterface $validator = null,
57		$validationErrorsArgument = null
58		) {
59	16	$this->serializer = $serializer;
60
61	16	if (!empty($groups)) {
62	1	$this->context['groups'] = (array) $groups;
63	1	}
64
65	16	if (!empty($version)) {
66	1	$this->context['version'] = $version;
67	1	}
68
69	16	if (null !== $validator && null === $validationErrorsArgument) {
70		throw new \InvalidArgumentException('"$validationErrorsArgument" cannot be null when using the validator');
71		}
72
73	16	$this->validator = $validator;
74	16	$this->validationErrorsArgument = $validationErrorsArgument;
75	16	}
76
77		/**
78		* {@inheritdoc}
79		*/
80	9	public function apply(Request $request, ParamConverter $configuration)
81		{
82	9	$options = (array) $configuration->getOptions();
83
84	9	if (isset($options['deserializationContext']) && is_array($options['deserializationContext'])) {
85	1	$arrayContext = array_merge($this->context, $options['deserializationContext']);
86	1	} else {
87	8	$arrayContext = $this->context;
88		}
89	9	$this->configureContext($context = new Context(), $arrayContext);
90
91		try {
92	9	$object = $this->serializer->deserialize(
93	9	$request->getContent(),
		0 ignored issues – show Bug introduced 2015-11-26 22:08 UTC by Report Bug Copy Issue Report It seems like `$request->getContent()` targeting `Symfony\Component\HttpFo...n\Request::getContent()` can also be of type `resource`; however, `FOS\RestBundle\Serialize...rializer::deserialize()` does only seem to accept `string`, maybe add an additional type check? This check looks at variables that are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
94	9	$configuration->getClass(),
95	9	$request->getContentType(),
96		$context
97	9	);
98	9	} catch (UnsupportedFormatException $e) {
99		return $this->throwException(new UnsupportedMediaTypeHttpException($e->getMessage(), $e), $configuration);
100	4	} catch (JMSSerializerException $e) {
101	1	return $this->throwException(new BadRequestHttpException($e->getMessage(), $e), $configuration);
		0 ignored issues – show Documentation introduced 2015-11-21 09:45 UTC by Report Bug Copy Issue Report `$e` is of type `object<JMS\Serializer\Exception\Exception>`, but the function expects a `null\|object<Exception>`. 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...
102	3	} catch (SymfonySerializerException $e) {
103	2	return $this->throwException(new BadRequestHttpException($e->getMessage(), $e), $configuration);
		0 ignored issues – show Documentation introduced 2015-11-21 09:45 UTC by Report Bug Copy Issue Report `$e` is of type `object<Symfony\Component...ion\ExceptionInterface>`, but the function expects a `null\|object<Exception>`. 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...
104		}
105
106	5	$request->attributes->set($configuration->getName(), $object);
107
108	5	if (null !== $this->validator) {
109	1	$validatorOptions = $this->getValidatorOptions($options);
110
111	1	$errors = $this->validator->validate($object, null, $validatorOptions['groups']);
112
113	1	$request->attributes->set(
114	1	$this->validationErrorsArgument,
115		$errors
116	1	);
117	1	}
118
119	5	return true;
120		}
121
122		/**
123		* {@inheritdoc}
124		*/
125	4	public function supports(ParamConverter $configuration)
126		{
127	4	return null !== $configuration->getClass();
128		}
129
130		/**
131		* @param Context $context
132		* @param array $options
133		*/
134	10	protected function configureContext(Context $context, array $options)
135		{
136	10	foreach ($options as $key => $value) {
137	2	if ($key === 'groups') {
138	1	$context->addGroups($options['groups']);
139	2	} elseif ($key === 'version') {
140	1	$context->setVersion($options['version']);
141	2	} elseif ($key === 'maxDepth') {
142	1	@trigger_error('Context attribute "maxDepth" is deprecated since version 2.1 and will be removed in 3.0. Use "enable_max_depth" instead.', E_USER_DEPRECATED);
		0 ignored issues – show Security Best Practice introduced 2016-05-31 17:20 UTC by Report Bug Copy Issue Report It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended. If you suppress an error, we recommend checking for the error condition explicitly: // For example instead of @mkdir($dir); // Better use if (@mkdir($dir) === false) { throw new \RuntimeException('The directory '.$dir.' could not be created.'); } Loading history...
143	1	$context->setMaxDepth($options['maxDepth']);
		0 ignored issues – show Deprecated Code introduced 2016-05-31 17:20 UTC by Report Bug Copy Issue Report The method `FOS\RestBundle\Context\Context::setMaxDepth()` has been deprecated with message: since 2.1, to be removed in 3.0. Use {@link self::enableMaxDepth()} instead. This method has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead. Loading history...
144	2	} elseif ($key === 'enableMaxDepth') {
145	1	$context->enableMaxDepth($options['enableMaxDepth']);
146	1	} elseif ($key === 'serializeNull') {
147	1	$context->setSerializeNull($options['serializeNull']);
148	1	} else {
149	1	$context->setAttribute($key, $value);
150		}
151	10	}
152	10	}
153
154		/**
155		* Throws an exception or return false if a ParamConverter is optional.
156		*/
157	3	private function throwException(\Exception $exception, ParamConverter $configuration)
158		{
159	3	if ($configuration->isOptional()) {
160	1	return false;
161		}
162
163	2	throw $exception;
164		}
165
166		/**
167		* @param array $options
168		*
169		* @return array
170		*/
171	2	private function getValidatorOptions(array $options)
172		{
173	2	$resolver = new OptionsResolver();
174	2	$resolver->setDefaults([
175	2	'groups' => null,
176	2	'traverse' => false,
177	2	'deep' => false,
178	2	]);
179
180	2	return $resolver->resolve(isset($options['validator']) ? $options['validator'] : []);
181		}
182		}
183

FriendsOfSymfony / FOSRestBundle

Pull Request — master (#1506)

RequestBodyParamConverter::throwException() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like