Skip to content

Extract & refactor mysqli TypeMapping #262

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 7, 2022
Merged

Extract & refactor mysqli TypeMapping #262

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fa9515f
Extract & refactor mysqli TypeMapping
Feb 6, 2022
dfb1280
rename
Feb 7, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
225 changes: 19 additions & 206 deletions src/QueryReflection/MysqliQueryReflector.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,20 +8,13 @@
use mysqli_result;
use mysqli_sql_exception;
use PHPStan\ShouldNotHappenException;
use PHPStan\Type\Accessory\AccessoryNumericStringType;
use PHPStan\Type\Constant\ConstantArrayTypeBuilder;
use PHPStan\Type\Constant\ConstantIntegerType;
use PHPStan\Type\Constant\ConstantStringType;
use PHPStan\Type\FloatType;
use PHPStan\Type\IntegerType;
use PHPStan\Type\IntersectionType;
use PHPStan\Type\MixedType;
use PHPStan\Type\StringType;
use PHPStan\Type\Type;
use PHPStan\Type\TypeCombinator;
use PHPStan\Type\UnionType;
use staabm\PHPStanDba\Error;
use staabm\PHPStanDba\Types\MysqlIntegerRanges;
use staabm\PHPStanDba\TypeMapping\MysqliTypeMapper;
use staabm\PHPStanDba\TypeMapping\TypeMapper;

final class MysqliQueryReflector implements QueryReflector
{
Expand All @@ -35,24 +28,12 @@ final class MysqliQueryReflector implements QueryReflector

private const MAX_CACHE_SIZE = 50;

/**
* @var mysqli
*/
private $db;
private mysqli $db;

/**
* @var array<string, mysqli_sql_exception|list<object>|null>
*/
private $cache = [];
/** @var array<string, mysqli_sql_exception|list<object>|null> */
private array $cache = [];

/**
* @var array<int, string>
*/
private $nativeTypes;
/**
* @var array<int, string>
*/
private $nativeFlags;
private TypeMapper $typeMapper;

public function __construct(mysqli $mysqli)
{
Expand All @@ -62,29 +43,7 @@ public function __construct(mysqli $mysqli)
// enable exception throwing on php <8.1
mysqli_report(\MYSQLI_REPORT_ERROR | \MYSQLI_REPORT_STRICT);

$this->nativeTypes = [];
$this->nativeFlags = [];

$constants = get_defined_constants(true);
foreach ($constants['mysqli'] as $c => $n) {
if (!\is_int($n)) {
// skip bool constants like MYSQLI_IS_MARIADB
continue;
}
if (preg_match('/^MYSQLI_TYPE_(.*)/', $c, $m)) {
if (!\is_string($m[1])) {
throw new ShouldNotHappenException();
}
$this->nativeTypes[$n] = $m[1];
} elseif (preg_match('/MYSQLI_(.*)_FLAG$/', $c, $m)) {
if (!\is_string($m[1])) {
throw new ShouldNotHappenException();
}
if (!\array_key_exists($n, $this->nativeFlags)) {
$this->nativeFlags[$n] = $m[1];
}
}
}
$this->typeMapper = new MysqliTypeMapper();
}

public function validateQueryString(string $queryString): ?Error
Expand All @@ -103,7 +62,10 @@ public function validateQueryString(string $queryString): ?Error
$message = str_replace(' MariaDB server', ' MySQL/MariaDB server', $message);

// to ease debugging, print the error we simulated
if (self::MYSQL_SYNTAX_ERROR_CODE === $e->getCode() && QueryReflection::getRuntimeConfiguration()->isDebugEnabled()) {
if (
self::MYSQL_SYNTAX_ERROR_CODE === $e->getCode()
&& QueryReflection::getRuntimeConfiguration()->isDebugEnabled()
) {
$simulatedQuery = QuerySimulation::simulate($queryString);
$message = $message."\n\nSimulated query: ".$simulatedQuery;
}
Expand All @@ -128,20 +90,25 @@ public function getResultType(string $queryString, int $fetchType): ?Type

$i = 0;
foreach ($result as $val) {
if (!property_exists($val, 'name') || !property_exists($val, 'type') || !property_exists($val, 'flags') || !property_exists($val, 'length')) {
if (
!property_exists($val, 'name')
|| !property_exists($val, 'type')
|| !property_exists($val, 'flags')
|| !property_exists($val, 'length')
) {
throw new ShouldNotHappenException();
}

if (self::FETCH_TYPE_ASSOC === $fetchType || self::FETCH_TYPE_BOTH === $fetchType) {
$arrayBuilder->setOffsetValueType(
new ConstantStringType($val->name),
$this->mapMysqlToPHPStanType($val->type, $val->flags, $val->length)
$this->typeMapper->mapToPHPStanType($val->type, $val->flags, $val->length)
);
}
if (self::FETCH_TYPE_NUMERIC === $fetchType || self::FETCH_TYPE_BOTH === $fetchType) {
$arrayBuilder->setOffsetValueType(
new ConstantIntegerType($i),
$this->mapMysqlToPHPStanType($val->type, $val->flags, $val->length)
$this->typeMapper->mapToPHPStanType($val->type, $val->flags, $val->length)
);
}
++$i;
Expand Down Expand Up @@ -184,158 +151,4 @@ private function simulateQuery(string $queryString)
return $this->cache[$queryString] = $e;
}
}

private function mapMysqlToPHPStanType(int $mysqlType, int $mysqlFlags, int $length): Type
{
$numeric = false;
$notNull = false;
$unsigned = false;
$autoIncrement = false;

foreach ($this->flags2txt($mysqlFlags) as $flag) {
switch ($flag) {
case 'NUM':
$numeric = true;
break;

case 'NOT_NULL':
$notNull = true;
break;

case 'AUTO_INCREMENT':
$autoIncrement = true;
break;

case 'UNSIGNED':
$unsigned = true;
break;

// ???
case 'PRI_KEY':
case 'PART_KEY':
case 'MULTIPLE_KEY':
case 'NO_DEFAULT_VALUE':
}
}

$phpstanType = null;
$mysqlIntegerRanges = new MysqlIntegerRanges();

if ($numeric) {
if ($unsigned) {
if (3 === $length) { // bool aka tinyint(1)
$phpstanType = $mysqlIntegerRanges->unsignedTinyInt();
}
if (4 === $length) {
$phpstanType = $mysqlIntegerRanges->unsignedTinyInt();
}
if (5 === $length) {
$phpstanType = $mysqlIntegerRanges->unsignedSmallInt();
}
if (8 === $length) {
$phpstanType = $mysqlIntegerRanges->unsignedMediumInt();
}
if (10 === $length) {
$phpstanType = $mysqlIntegerRanges->unsignedInt();
}
if (20 === $length) {
$phpstanType = $mysqlIntegerRanges->unsignedBigInt();
}
} else {
if (1 == $length) {
$phpstanType = $mysqlIntegerRanges->signedTinyInt();
}
if (4 === $length) {
$phpstanType = $mysqlIntegerRanges->signedTinyInt();
}
if (6 === $length) {
$phpstanType = $mysqlIntegerRanges->signedSmallInt();
}
if (9 === $length) {
$phpstanType = $mysqlIntegerRanges->signedMediumInt();
}
if (11 === $length) {
$phpstanType = $mysqlIntegerRanges->signedInt();
}
if (20 === $length) {
$phpstanType = $mysqlIntegerRanges->signedBigInt();
}
if (22 === $length) {
$phpstanType = $mysqlIntegerRanges->signedBigInt();
}
}
}

if ($autoIncrement) {
$phpstanType = $mysqlIntegerRanges->unsignedInt();
}

if (null === $phpstanType) {
switch ($this->type2txt($mysqlType)) {
case 'DOUBLE':
case 'NEWDECIMAL':
$phpstanType = new FloatType();
break;
case 'LONGLONG':
case 'LONG':
case 'SHORT':
case 'YEAR':
case 'BIT':
case 'INT24':
$phpstanType = new IntegerType();
break;
case 'BLOB':
case 'CHAR':
case 'STRING':
case 'VAR_STRING':
case 'JSON':
case 'DATE':
case 'TIME':
case 'DATETIME':
case 'TIMESTAMP':
$phpstanType = new StringType();
break;
default:
$phpstanType = new MixedType();
}
}

if (QueryReflection::getRuntimeConfiguration()->isStringifyTypes()) {
$numberType = new UnionType([new IntegerType(), new FloatType()]);
$isNumber = $numberType->isSuperTypeOf($phpstanType)->yes();

if ($isNumber) {
$phpstanType = new IntersectionType([
new StringType(),
new AccessoryNumericStringType(),
]);
}
}

if (false === $notNull) {
$phpstanType = TypeCombinator::addNull($phpstanType);
}

return $phpstanType;
}

private function type2txt(int $typeId): ?string
{
return \array_key_exists($typeId, $this->nativeTypes) ? $this->nativeTypes[$typeId] : null;
}

/**
* @return list<string>
*/
private function flags2txt(int $flagId): array
{
$result = [];
foreach ($this->nativeFlags as $n => $t) {
if ($flagId & $n) {
$result[] = $t;
}
}

return $result;
}
}
Loading