Prevent Persistable implementations to return PackedArray instances

Author: alcaeus

src/BSON/Persistable.stub.php

@@ -9,4 +9,11 @@
 
 interface Persistable extends Serializable, Unserializable
 {
+#if PHP_VERSION_ID >= 80000
+    /** @tentative-return-type */
+    public function bsonSerialize(): array|\stdClass|Document;
+#else
+    /** @return array|\stdClass|Document */
+    public function bsonSerialize();
+#endif
 }

src/BSON/Persistable_arginfo.h

@@ -1,10 +1,30 @@
 /* This is a generated file, edit the .stub.php file instead.
- * Stub hash: babd07f95f47c3b66228ef23b66ab0446cd5c308 */
+ * Stub hash: e61c06a90093af5468c6c29f6cbf16c5db8d54d1 */
 
+#if PHP_VERSION_ID >= 80000
+ZEND_BEGIN_ARG_WITH_TENTATIVE_RETURN_OBJ_TYPE_MASK_EX(arginfo_class_MongoDB_BSON_Persistable_bsonSerialize, 0, 0, stdClass|MongoDB\\BSON\\Document, MAY_BE_ARRAY)
+ZEND_END_ARG_INFO()
+#endif
 
+#if !(PHP_VERSION_ID >= 80000)
+ZEND_BEGIN_ARG_INFO_EX(arginfo_class_MongoDB_BSON_Persistable_bsonSerialize, 0, 0, 0)
+ZEND_END_ARG_INFO()
+#endif
+
+
+#if PHP_VERSION_ID >= 80000
+#endif
+#if !(PHP_VERSION_ID >= 80000)
+#endif
 
 
 static const zend_function_entry class_MongoDB_BSON_Persistable_methods[] = {
+#if PHP_VERSION_ID >= 80000
+	ZEND_ABSTRACT_ME_WITH_FLAGS(MongoDB_BSON_Persistable, bsonSerialize, arginfo_class_MongoDB_BSON_Persistable_bsonSerialize, ZEND_ACC_PUBLIC|ZEND_ACC_ABSTRACT)
+#endif
+#if !(PHP_VERSION_ID >= 80000)
+	ZEND_ABSTRACT_ME_WITH_FLAGS(MongoDB_BSON_Persistable, bsonSerialize, arginfo_class_MongoDB_BSON_Persistable_bsonSerialize, ZEND_ACC_PUBLIC|ZEND_ACC_ABSTRACT)
+#endif
 	ZEND_FE_END
 };
 

src/phongo_bson_encode.c

@@ -135,7 +135,20 @@ static void php_phongo_bson_append_object(bson_t* bson, php_phongo_field_path* f
 			}
 
 			// TODO PHP_VERSION_ID < 80000: obsolete once the tentative return type of bsonSerialize() is enforced
-			if (
+			if (instanceof_function(Z_OBJCE_P(object), php_phongo_persistable_ce)) {
+				if (
+					Z_TYPE(obj_data) != IS_ARRAY && !(Z_TYPE(obj_data) == IS_OBJECT && (instanceof_function(Z_OBJCE(obj_data), zend_standard_class_def) || instanceof_function(Z_OBJCE(obj_data), php_phongo_document_ce)))) {
+					phongo_throw_exception(PHONGO_ERROR_UNEXPECTED_VALUE,
+										   "Expected %s::%s() to return an array, stdClass, or %s, %s given",
+										   ZSTR_VAL(Z_OBJCE_P(object)->name),
+										   BSON_SERIALIZE_FUNC_NAME,
+										   ZSTR_VAL(php_phongo_document_ce->name),
+										   PHONGO_ZVAL_CLASS_OR_TYPE_NAME(obj_data));
+					zval_ptr_dtor(&obj_data);
+
+					return;
+				}
+			} else if (
 				Z_TYPE(obj_data) != IS_ARRAY && !(Z_TYPE(obj_data) == IS_OBJECT && (instanceof_function(Z_OBJCE(obj_data), zend_standard_class_def) || instanceof_function(Z_OBJCE(obj_data), php_phongo_document_ce) || instanceof_function(Z_OBJCE(obj_data), php_phongo_packedarray_ce)))) {
 				phongo_throw_exception(PHONGO_ERROR_UNEXPECTED_VALUE,
 									   "Expected %s::%s() to return an array, stdClass, %s, or %s, %s given",
@@ -462,6 +475,18 @@ static void php_phongo_zval_to_bson_internal(zval* data, php_phongo_field_path*
 				}
 
 				if (instanceof_function(Z_OBJCE_P(data), php_phongo_persistable_ce)) {
+					if (Z_TYPE(obj_data) == IS_OBJECT && instanceof_function(Z_OBJCE(obj_data), php_phongo_packedarray_ce)) {
+						phongo_throw_exception(
+							PHONGO_ERROR_UNEXPECTED_VALUE,
+							"Expected %s::%s() to return an array, stdClass, or %s, %s given",
+							ZSTR_VAL(Z_OBJCE_P(data)->name),
+							BSON_SERIALIZE_FUNC_NAME,
+							ZSTR_VAL(php_phongo_document_ce->name),
+							PHONGO_ZVAL_CLASS_OR_TYPE_NAME(obj_data));
+
+						goto cleanup;
+					}
+
 					bson_append_binary(bson, PHONGO_ODM_FIELD_NAME, -1, 0x80, (const uint8_t*) Z_OBJCE_P(data)->name->val, Z_OBJCE_P(data)->name->len);
 					/* Ensure that we ignore an existing key with the same name
 					 * if one exists in the bsonSerialize() return value. */

tests/bson/bson-fromPHP-001.phpt

@@ -34,6 +34,7 @@ $tests = array(
     array('foo' => 'bar'),
     (object) array(1, 2, 3),
     (object) array('foo' => 'bar'),
+    # The PackedArray check will fail for instances of Persistable
     MongoDB\BSON\PackedArray::fromPHP([1, 2, 3]),
     MongoDB\BSON\Document::fromPHP(['foo' => 'bar']),
 );
@@ -74,7 +75,7 @@ Testing top-level objects
 { "foo" : "bar" }
 { "__pclass" : { "$binary" : "TXlQZXJzaXN0YWJsZURvY3VtZW50", "$type" : "80" }, "foo" : "bar" }
 { "0" : 1, "1" : 2, "2" : 3 }
-{ "__pclass" : { "$binary" : "TXlQZXJzaXN0YWJsZURvY3VtZW50", "$type" : "80" }, "0" : 1, "1" : 2, "2" : 3 }
+Expected MyPersistableDocument::bsonSerialize() to return an array, stdClass, or MongoDB\BSON\Document, MongoDB\BSON\PackedArray given
 { "foo" : "bar" }
 { "__pclass" : { "$binary" : "TXlQZXJzaXN0YWJsZURvY3VtZW50", "$type" : "80" }, "foo" : "bar" }
 
@@ -88,7 +89,7 @@ Testing nested objects
 { "nested" : { "foo" : "bar" } }
 { "nested" : { "__pclass" : { "$binary" : "TXlQZXJzaXN0YWJsZURvY3VtZW50", "$type" : "80" }, "foo" : "bar" } }
 { "nested" : [ 1, 2, 3 ] }
-{ "nested" : { "__pclass" : { "$binary" : "TXlQZXJzaXN0YWJsZURvY3VtZW50", "$type" : "80" }, "0" : 1, "1" : 2, "2" : 3 } }
+Expected MyPersistableDocument::bsonSerialize() to return an array, stdClass, or MongoDB\BSON\Document, MongoDB\BSON\PackedArray given
 { "nested" : { "foo" : "bar" } }
 { "nested" : { "__pclass" : { "$binary" : "TXlQZXJzaXN0YWJsZURvY3VtZW50", "$type" : "80" }, "foo" : "bar" } }
 ===DONE===