-
Notifications
You must be signed in to change notification settings - Fork 430
/
JsonThrowOnErrorDynamicReturnTypeExtension.php
202 lines (171 loc) · 5.75 KB
/
JsonThrowOnErrorDynamicReturnTypeExtension.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
<?php declare(strict_types = 1);
namespace PHPStan\Type\Php;
<<<<<<< HEAD
<<<<<<< HEAD
<<<<<<< HEAD
=======
use PhpParser\Node\Arg;
=======
=======
use PhpParser\ConstExprEvaluationException;
>>>>>>> decopule type resolution to static
use PhpParser\ConstExprEvaluator;
>>>>>>> check for JSON_OBJECT_AS_ARRAY, in case of null and array
use PhpParser\Node\Expr;
use PhpParser\Node\Expr\BinaryOp\BitwiseOr;
use PhpParser\Node\Expr\ConstFetch;
>>>>>>> Extend JsonThrowOnErrorDynamicReturnTypeExtension to detect knonw type from contssant string value
use PhpParser\Node\Expr\FuncCall;
use PhpParser\Node\Name\FullyQualified;
use PHPStan\Analyser\Scope;
use PHPStan\Reflection\FunctionReflection;
use PHPStan\Reflection\ParametersAcceptorSelector;
use PHPStan\Reflection\ReflectionProvider;
<<<<<<< HEAD
<<<<<<< HEAD
use PHPStan\Type\BitwiseFlagHelper;
use PHPStan\Type\Constant\ConstantBooleanType;
=======
use PHPStan\Type\ArrayType;
use PHPStan\Type\BooleanType;
=======
>>>>>>> return mixed type
use PHPStan\Type\Constant\ConstantBooleanType;
use PHPStan\Type\Constant\ConstantIntegerType;
use PHPStan\Type\Constant\ConstantStringType;
use PHPStan\Type\ConstantTypeHelper;
>>>>>>> Extend JsonThrowOnErrorDynamicReturnTypeExtension to detect knonw type from contssant string value
use PHPStan\Type\DynamicFunctionReturnTypeExtension;
use PHPStan\Type\MixedType;
use PHPStan\Type\ObjectType;
use PHPStan\Type\Type;
use PHPStan\Type\TypeCombinator;
use stdClass;
use function constant;
use function is_bool;
use function json_decode;
use const JSON_OBJECT_AS_ARRAY;
class JsonThrowOnErrorDynamicReturnTypeExtension implements DynamicFunctionReturnTypeExtension
{
private const UNABLE_TO_RESOLVE = '__UNABLE_TO_RESOLVE__';
/** @var array<string, int> */
private array $argumentPositions = [
'json_encode' => 1,
'json_decode' => 3,
];
<<<<<<< HEAD
public function __construct(
private ReflectionProvider $reflectionProvider,
private BitwiseFlagHelper $bitwiseFlagAnalyser,
)
=======
private ConstExprEvaluator $constExprEvaluator;
public function __construct(private ReflectionProvider $reflectionProvider)
>>>>>>> decopule type resolution to static
{
$this->constExprEvaluator = new ConstExprEvaluator(static function (Expr $expr) {
if ($expr instanceof ConstFetch) {
return constant($expr->name->toString());
}
return null;
});
}
public function isFunctionSupported(
FunctionReflection $functionReflection,
): bool
{
if ($functionReflection->getName() === 'json_decode') {
return true;
}
return $this->reflectionProvider->hasConstant(new FullyQualified('JSON_THROW_ON_ERROR'), null) && $functionReflection->getName() === 'json_encode';
}
public function getTypeFromFunctionCall(
FunctionReflection $functionReflection,
FuncCall $functionCall,
Scope $scope,
): Type
{
// update type based on JSON_THROW_ON_ERROR
$argumentPosition = $this->argumentPositions[$functionReflection->getName()];
$defaultReturnType = ParametersAcceptorSelector::selectSingle($functionReflection->getVariants())->getReturnType();
// narrow type for json_decode()
if ($functionReflection->getName() === 'json_decode') {
$defaultReturnType = $this->narrowTypeForJsonDecode($functionCall, $scope);
}
if (!isset($functionCall->getArgs()[$argumentPosition])) {
return $defaultReturnType;
}
$optionsExpr = $functionCall->getArgs()[$argumentPosition]->value;
$constrictedReturnType = TypeCombinator::remove($defaultReturnType, new ConstantBooleanType(false));
if ($this->bitwiseFlagAnalyser->bitwiseOrContainsConstant($optionsExpr, $scope, 'JSON_THROW_ON_ERROR')->yes()) {
return $constrictedReturnType;
}
return $defaultReturnType;
}
private function narrowTypeForJsonDecode(FuncCall $funcCall, Scope $scope): Type
{
$args = $funcCall->getArgs();
$isArrayWithoutStdClass = $this->isForceArrayWithoutStdClass($funcCall, $scope);
$firstArgValue = $args[0]->value;
$firstValueType = $scope->getType($firstArgValue);
if ($firstValueType instanceof ConstantStringType) {
return $this->resolveConstantStringType($firstValueType, $isArrayWithoutStdClass);
}
// fallback type
if ($isArrayWithoutStdClass === true) {
return new MixedType(true, new ObjectType(stdClass::class));
}
return new MixedType(true);
}
/**
* Is "json_decode(..., true)"?
*/
private function isForceArrayWithoutStdClass(FuncCall $funcCall, Scope $scope): bool
{
$args = $funcCall->getArgs();
if (isset($args[1])) {
$secondArgValue = $this->resolveMaskValue($args[1]->value, $scope);
if ($secondArgValue === self::UNABLE_TO_RESOLVE) {
return false;
}
if (is_bool($secondArgValue)) {
return $secondArgValue;
}
// depends on used constants
if ($secondArgValue === null) {
if (! isset($args[3])) {
return false;
}
// @see https://www.php.net/manual/en/json.constants.php#constant.json-object-as-array
$thirdArgValue = $args[3]->value;
$resolvedThirdArgValue = $this->resolveMaskValue($thirdArgValue, $scope);
if (($resolvedThirdArgValue & JSON_OBJECT_AS_ARRAY) !== 0) {
return true;
}
}
}
return false;
}
private function resolveConstantStringType(ConstantStringType $constantStringType, bool $isForceArray): Type
{
$decodedValue = json_decode($constantStringType->getValue(), $isForceArray);
return ConstantTypeHelper::getTypeFromValue($decodedValue);
}
/**
* @return mixed
*/
private function resolveMaskValue(Expr $expr, Scope $scope)
{
$thirdArgValueType = $scope->getType($expr);
if ($thirdArgValueType instanceof ConstantIntegerType) {
return $thirdArgValueType->getValue();
}
// fallback to value resolver
try {
return $this->constExprEvaluator->evaluateSilently($expr);
} catch (ConstExprEvaluationException) {
// unable to resolve
return self::UNABLE_TO_RESOLVE;
}
}
}