Fix SQL query quoting/casting when type is passed to where function

[tmotyl]

Framework/DB/Select where function doesn't handle the "type" correctly.

Description (*)

The $type variable can be both string or int, so before comparing it to
'TYPE_CONDITION' string it has to be casted to avoid comparing integer zero
with string (0 == 'TYPE_CONDITION') which will wrongly return true,
and remove the information about type.

Pass type provided to where function down the chain to allow automatic
casting of arrays of values e.g. to int.

This fixes following cases:
1)
$select-->where('attr_table.store_id IN (?)', $storeIds, Zend_Db::INT_TYPE);
2)
$select-->where('attr_table.store_id = ?', $storeId, Zend_Db::INT_TYPE);
In both cases now passed value is correctly casted to int
(either single value, or each value from array)

Related Pull Requests

Fixed Issues (if relevant)

1. magento/magento2#<issue_number>: Issue title

Manual testing scenarios (*)

1. Make custom select like
   $select->from(['catalog_product_entity'], '*')->where('entity_id in (?)', ['1', 2, 3], \Zend_Db::INT_TYPE);
2. Check sql
   $select->__toString()

Expected result (*)

SELECT catalog_product_entity.* FROM catalog_product_entity WHERE (entity_id in (1, 2, 3));

Actual result (*)

SELECT catalog_product_entity.* FROM catalog_product_entity WHERE (entity_id in ('1', 2, 3));

Questions or comments

Contribution checklist (*)

• Pull request has a meaningful description of its purpose
• All commits are accompanied by meaningful commit messages
• All new or changed code is covered with unit/integration tests (if applicable)
• All automated tests passed successfully (all builds are green)

Resolved issues:

1. resolves [Issue] Fix SQL query quoting/casting when type is passed to where function #29590: Fix SQL query quoting/casting when type is passed to where function

[m2-assistant]

Hi @tmotyl. Thank you for your contribution
Here is some useful tips how you can test your changes using Magento test environment.
Add the comment under your pull request to deploy test or vanilla Magento instance:

• @magento give me test instance - deploy test instance based on PR changes
• @magento give me 2.4-develop instance - deploy vanilla Magento instance

For more details, please, review the Magento Contributor Guide documentation.

[tmotyl]

The test failures are unrelated to the change "MySQL server has gone away". Can somebody restart the tests?

[ihor-sviziev]

Related to #27129 as it also partically doing the same.

[ihor-sviziev]

@magento run all tests

[tmotyl]

Related to #27129 as it also partically doing the same.

yes, I believe this patch is prerequisite to the other, as without it types for array are not interpreted correctly

[ihor-sviziev]

@magento run all tests

[tmotyl]

hmm these test failures look unrelated to the change

[ihor-sviziev]

Hi @tmotyl,
Please fix static tests. All others are passing now

[tmotyl]

@ihor-sviziev thanks for the review. The static tests are failing that the line

     * @param array|null|int|string|float|\Magento\Framework\DB\Sql\Expression|\Magento\Framework\DB\Select|\DateTimeInterface $value The value to quote.

is too long.
I can either add a use statement on top of the file and shorter the types in doc comment, or add //phpcs:ignore
Whatever your prefer.

[ihor-sviziev]

@tmotyl I think mixed there will be just more suitable, as potentially any object with '__toString()" method could be passed there. Is it make sense?

[tmotyl]

I can put mixed as it was before.
I just think mixed is not helpful neither for humans nor for static code analysis tools.
All these types have special handling somewhere in the function (or parent function) this is why
I think its beneficial to have them specified explicitly.
Otherwise developer who want to pass value to ->where don't know what type can be passed into and have to dig through multiple levels of code until he finds it.

Please make the decision, I will follow it. I do not want to spend too much time on secondary topic in this patch.

[ihor-sviziev]

@tmotyl ok, make sense. Could you try to import Expression and Select classes? I think it should fit the limit. If it will not fit - please use phpcs:ignore for specific lines

[tmotyl]

thanks, done

[ihor-sviziev]

@magento run Static Tests

[engcom-Charlie]

✔️ QA Passed
Checked by the following steps, the results are the same:

1. Make custom select like
   $select->from(['catalog_product_entity'], '*')->where('entity_id in (?)', ['1', 2, 3], \Zend_Db::INT_TYPE);
2. Check sql
   $select->__toString()

before ✖️:
SELECT catalog_product_entity.* FROM catalog_product_entity WHERE (entity_id in ('1', 2, 3));

after ✔️:
SELECT catalog_product_entity.* FROM catalog_product_entity WHERE (entity_id in (1, 2, 3));

[ihor-sviziev]

Would like to add that basically the same changes were already added as part of #27129, so this PR will introduce phpdoc cleanup only.

[engcom-Charlie]

@magento run all tests

[engcom-Charlie]

@magento run all tests

[m2-assistant]

Hi @tmotyl, thank you for your contribution!
Please, complete Contribution Survey, it will take less than a minute.
Your feedback will help us to improve contribution process.