Bug #80895 [Fbk->Csd]: Unexpected XML due to memory optimization in SOAP

Edit report at https://bugs.php.net/bug.php?id=80895&edit=1 ID: 80895 User updated by: vasilevrvv at gmail dot com Reported by: vasilevrvv at gmail dot com Summary: Unexpected XML due to memory optimization in SOAP -Status: Feedback +Status: Closed Type: Bug Package: SOAP related Operating System: Linux PHP Version: 8.0.3 Assigned To: cmb Block user comment: N Private report: N New Comment: Hmm, in php5, the behavior is generally differen ti need to research Previous Comments: ------------------------------------------------------------------------ [2021-03-24 13:31:56] vasilevrvv at gmail dot com each pass of the foreach is the same zval, before trying to change it. and the soap library takes this as a reference, but it is not a reference. ------------------------------------------------------------------------ [2021-03-24 13:14:23] vasilevrvv at gmail dot com For example, let's change not the address, but another variable, this also helped. And add call xdebug_debug_zval before and after call: xdebug_debug_zval('returnAddressee'); $returnAddressee['person_name'] = $returnAddressee['person_name']; xdebug_debug_zval('returnAddressee'); Before: (refcount=4, is_ref=0) array (size=4) 'person_name' => (refcount=1, is_ref=0)string ',,,,,, Here refcount=4 Call: $returnAddressee['person_name'] = $returnAddressee['person_name']; After (refcount=1, is_ref=0) array (size=4) 'person_name' => (refcount=2, is_ref=0)string '..... Here refcount=1 When the array changes, it becomes another array, this is what causes the problem ------------------------------------------------------------------------ [2021-03-24 12:55:31] vasilevrvv at gmail dot com No, $returnAddressee do not contain references. Its just json_decode() result. Inside php since version 7.x, arrays are always stored by links, they are copied only when you try to change them. this is internal logic that is not visible to the end programmer The problem is solved by the fact that I just copy the same value into it. PHP inside takes this as an attempt to change and then copies the array in memory. Fix code: $returnAddressee['address'] = $returnAddressee['address']; Helps not only it, but any change in the array, of any other field. I think that after the release of these optimizations in PHP, this was simply not taken into account in the SOAP module var_dump: array(4) { ["person_name"]=> string(29) "NAME" ["phone"]=> string(11) "+372123123123" ["email"]=> string(16) "sales@testcompany.com" ["address"]=> array(4) { ["postcode"]=> string(5) "12312" ["deliverypoint"]=> string(5) "Narva" ["country"]=> string(2) "EE" ["street"]=> string(13) "Test 21" } } ------------------------------------------------------------------------ [2021-03-24 11:42:55] cmb@php.net Copy on write and references are different concepts. While the former is transparent (aka "magic"), the latter is not, and it seems to me that $returnAddressee contains references. You can verify that with var_dump($returnAddresse); Cf. <https://3v4l.org/iaqnA> ------------------------------------------------------------------------ [2021-03-22 18:28:48] vasilevrvv at gmail dot com Description: ------------ The problem is that when copying an array (not in pass by reference case), ref elements are created in XML. !!! This is due to memory optimization in PHP, since in fact the array is copied only when it changes !!! We get unexpected results: The problem is solved by adding the line $returnAddressee['address'] = $returnAddressee['address']; as first cycle line. At this point, the actual copying of the data took place. Reference was broken. After add we get correct result. This is unexpected behavior. Behavior should not depend on the internal "magic" of the PHP, it should be logical. Either always pass the same data by reference, or if the data would have been explicitly passed by reference (perfectably) Test script: --------------- private function test(Request\Shipment $shipment, array $returnAddressee): array { $items = []; foreach ($shipment->parcels as $k => $parcel) { $items[] = array( 'receiverAddressee' => $this->createReceiverAddressee($shipment->consignee), 'returnAddressee' => $returnAddressee ); } return $items; } Unfortunately, I cannot give a complete script for testing, since it depends on the WSDL service. Expected result: ---------------- <item_list> <item service="CA"> <receiverAddressee> <address postcode="13240" deliverypoint="La Solana" country="RU" street="Calle Empedrada 45" /> </receiverAddressee> <returnAddressee> <address postcode="123123" deliverypoint="Test" country="EE" street="Test 22" /> </returnAddressee> </item> <item service="CA"> <receiverAddressee> <address postcode="13240" deliverypoint="La Solana" country="RU" street="Calle Empedrada 45" /> </receiverAddressee> <returnAddressee> <address postcode="123123" deliverypoint="Test" country="EE" street="Test 22" /> </returnAddressee> </item> </item_list> Actual result: -------------- <item_list> <item service="CA"> <receiverAddressee> <address postcode="13240" deliverypoint="La Solana" country="RU" street="Calle Empedrada 45" /> </receiverAddressee> <returnAddressee> <address postcode="123123" deliverypoint="Test" country="EE" street="Test 22" id="ref1" /> </returnAddressee> </item> <item service="CA"> <receiverAddressee> <address postcode="13240" deliverypoint="La Solana" country="RU" street="Calle Empedrada 45" /> </receiverAddressee> <returnAddressee> <address href="#ref1" /> </returnAddressee> </item> </item_list> ------------------------------------------------------------------------ -- Edit this bug report at https://bugs.php.net/bug.php?id=80895&edit=1