Skip to content

PHPC-2457 Fix modifiers and other Query options by reference #1694

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.

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

Closed
wants to merge 2 commits into from

Conversation

GromNaN
Copy link
Member

@GromNaN GromNaN commented Sep 24, 2024

Fix PHPC-2457

Similar to #1683.

@GromNaN GromNaN requested a review from alcaeus September 24, 2024 21:37
@@ -333,6 +334,7 @@ bool phongo_query_init(zval* return_value, zval* filter, zval* options)
if (php_array_existsc(options, "modifiers")) {
modifiers = php_array_fetchc(options, "modifiers");

ZVAL_DEREF(modifiers);
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be done by php_array_fetchc?

Comment on lines 190 to +196
zval *php_array_fetch(zval *zarr, const char *key) {
return php_array_fetchl(zarr, key, strlen(key));
zval *ret = php_array_fetchl(zarr, key, strlen(key));
if (ret) {
ZVAL_DEREF(ret);
}

return ret;
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is used to read options in Query, BulkWrite and phongo_lient.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note that there are a whole family of php_array_fetch functions, so even this change might be incomplete (in terms of fixing the general issue and not just the regression tests).

In this Slack thread, @alcaeus suggested a new method that conditionally applies ZVAL_DEREF(). That sounded reasonable, along with leaving this as-is and just adding our own ZVAL_DEREF() calls as needed.

As for the php_array_zval_to_<type> family of functions, I think those are easy candidates for automatic dereferencing, as @alcaeus did in previous PRs.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Created #1697 to update php_array_api and fix the deref issue in remaining places.

--FILE--
<?php

$modifiers = ['$orderby' => ['x' => 1]];
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You noted the following error in PHPC-2457:

PHP Fatal error: Uncaught MongoDB\Driver\Exception\InvalidArgumentException: Expected "$orderby" modifier to be array or object, bool given

The exception originates from php_phongo_query_opts_append_document(), but I'm not sure how that's possible as the code calls PHONGO_ZVAL_CLASS_OR_TYPE_NAME_P(value). That macro delegates to zend_get_type_by_const(). IS_REFERENCE isn't even included in that function, and I can't imagine why the type would match for the function returning "bool".

Comment on lines 190 to +196
zval *php_array_fetch(zval *zarr, const char *key) {
return php_array_fetchl(zarr, key, strlen(key));
zval *ret = php_array_fetchl(zarr, key, strlen(key));
if (ret) {
ZVAL_DEREF(ret);
}

return ret;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note that there are a whole family of php_array_fetch functions, so even this change might be incomplete (in terms of fixing the general issue and not just the regression tests).

In this Slack thread, @alcaeus suggested a new method that conditionally applies ZVAL_DEREF(). That sounded reasonable, along with leaving this as-is and just adding our own ZVAL_DEREF() calls as needed.

As for the php_array_zval_to_<type> family of functions, I think those are easy candidates for automatic dereferencing, as @alcaeus did in previous PRs.

@GromNaN
Copy link
Member Author

GromNaN commented Sep 27, 2024

Replaced by #1697

@GromNaN GromNaN closed this Sep 27, 2024
@GromNaN GromNaN deleted the PHPC-2457 branch September 27, 2024 07:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants