Skip to content

PHPC-1162: Add reference to currentDocument in debug info #811

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 1 commit into from
Apr 18, 2018
Merged

PHPC-1162: Add reference to currentDocument in debug info #811

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion src/MongoDB/Cursor.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -509,7 +509,7 @@ static HashTable *php_phongo_cursor_get_debug_info(zval *object, int *is_temp TS
if (!Z_ISUNDEF(intern->visitor_data.zchild)) {
#if PHP_VERSION_ID >= 70000
ADD_ASSOC_ZVAL_EX(&retval, "currentDocument", &intern->visitor_data.zchild);
/*Z_ADDREF(intern->visitor_data.zchild);*/
Z_ADDREF(intern->visitor_data.zchild);
Copy link
Contributor

Choose a reason for hiding this comment

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

Where are you removing this reference again? And why is this different for PHP 7+ and PHP 7- ?

Copy link
Member Author

Choose a reason for hiding this comment

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

If you look at the original commit (78839bd#diff-d11812fede193d119daadf3b31af5049R344), I think this was just over oversight. This change makes PHP 7+ consistent with 5.x (and other zvals in the debug output on all PHP versions) by always adding a reference.

Is it necessary to free the reference in debug info? My understanding is that it's essentially a return value and the root array (or HashTable) will get freed by the caller.

Copy link
Member Author

Choose a reason for hiding this comment

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

Is there a concern that we're only adding a pointer to the current document here instead of copying the zval and it could change later if the user were to hold a reference to it (not with var_dump() but presumably some other method).

I'll note that php_phongo_cursor_free_current() is going to zval_ptr_dtor() and ZVAL_UNDEF() at each step of iteration.

#else
ADD_ASSOC_ZVAL_EX(&retval, "currentDocument", intern->visitor_data.zchild);
Z_ADDREF_P(intern->visitor_data.zchild);
Expand Down
43 changes: 43 additions & 0 deletions tests/cursor/bug1162-001.phpt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
--TEST--
MongoDB\Driver\Cursor segfault dumping cursor while iterating with IteratorIterator
--SKIPIF--
<?php require __DIR__ . "/" ."../utils/basic-skipif.inc"; ?>
<?php NEEDS('STANDALONE'); ?>
<?php CLEANUP(STANDALONE); ?>
--FILE--
<?php
require_once __DIR__ . "/../utils/basic.inc";

$manager = new MongoDB\Driver\Manager(STANDALONE);

$bulk = new MongoDB\Driver\BulkWrite;
$bulk->insert(['_id' => 1]);
$bulk->insert(['_id' => 2]);
$bulk->insert(['_id' => 3]);
$manager->executeBulkWrite(NS, $bulk);

$query = new MongoDB\Driver\Query([], ['batchSize' => 2]);

$cursor = $manager->executeQuery(NS, $query);

$iterator = new IteratorIterator($cursor);
$iterator->rewind();
var_dump($cursor);

$iterator->next();
var_dump($cursor);

$iterator->next();
var_dump($cursor);

?>
===DONE===
<?php exit(0); ?>
--EXPECTF--
object(MongoDB\Driver\Cursor)#%d (%d) {%A
}
object(MongoDB\Driver\Cursor)#%d (%d) {%A
}
object(MongoDB\Driver\Cursor)#%d (%d) {%A
}
===DONE===