Order & Order Line Custom Property Editing from Backoffice

[john-kehelly-granite]

Which component is this issue related to?

Umbraco Commerce (Core)

Which Umbraco Commerce version are you using? (Please write the exact version, example: 10.1.0)

15.3.11

Bug summary

When trying to edit custom properties from the backoffice you cant always unset a value. The editor will look like the value has been changed correctly but after saving the order and reloading it, the values will have returned.

There seems to be a difference between a cart and a completed order in when this happens. I've only tested on textbox and toggle fields, there may also be issues on other field types but I've not had the opportunity to test those.

Specifics

On a cart, I'm unable to clear text values or toggles at the cart level. I can clear the text field and set the toggle to false but on saving the record they immediately reset.

On a completed order, at order level I can clear a text value but not a toggle. Again I can edit the field on screen but after saving the record the text field remains clear but the toggle immediately resets to true.

On Order Lines, text values will not allow you to empty them, toggle values wont allow you to set them to false. The editor itself does allow the field to be changed but on clearing the text and/or setting the toggle to false then clicking update on the overlay, if you open the property editor again the values will be as before.

Video showing editing cart level values
https://github.com/user-attachments/assets/df6a5bee-fb4f-4b38-8804-beadc0644ef9

Video showing editing order level values
https://github.com/user-attachments/assets/6a70c35d-cf3a-4e38-a498-bb3ad228f2cc

Steps to reproduce

I've attached a test package json I'm using to define some test values - a textbox and a toggle on both the main order and the individual order lines.

Open any cart and set a value in the text field, set the toggle to true. Save the cart. Reload the screen fully, as expected the values are set. Now clear the text box and set the toggle to false. Save the cart. The the text will have returned and the toggle will have reset to true. A video above shows this.

Open any completed order and set a value in the text field, set the toggle to true. Save the order. Reload the screen fully, as expected the values are set. Now clear the text box and set the toggle to false. Save the order. The the text will remain empty but the toggle will have reset to true. A video above shows this.

On any order line item (either cart or completed order), open the custom properties overlay then set a value in the text field and set the toggle to true. Click the update button to return to the order. Reopen the overlay for the order line item, as expected the text & toggle are set. Clear the text field and set the toggle to false, click update to return to the order. Reopen the overlay and the text field will have populated again and the toggle will have reset to true. Saving the order between these steps does not change the outcome.

umbraco-package.json

Expected result / actual result

Expected result is that I can clear or edit the custom fields to any value they support. Actual result is some values cannot be unset.

Dependencies

No response

---

This item has been added to our backlog AB#56167

[mattbrailsford]

Thanks @johnk-granite for a really thorough explanation and for providing the umbraco-package.json for us to test against. I'll get this reviewed and see if we get to the bottom of it. My initial thought is that we may be merging the property values rather than explicitly replacing them so it may see the empty/false values as unset and so doesn't update them, but I'll investigate further to see if I can confirm this.

[mattbrailsford]

Ok, I think I've gotten to the bottom of this.

So the main problem was that when a property value was empty, we wouldn't send that value back to the server in the post model, but from the server side then it just saw this as the value missing, rather than it being explicitly removed and so it would leave the previous value.

I've now updated the client side code to ALWAYS send back value for properties defined via order property manifests whether it has a value or not. This way the back end now knows that the value is explicitly empty.

There is a secondary issue which I won't be able to fix (but I can provide a workaround) and this is with the use of Umb.PropertyEditorUi.Toggle. The issue with using this is that it expects the value to be explicitly boolean, but Umbraco Commerce has to store all it's values as strings and so when the string value "false" is bound to the property editor, it is just seen as true.

The workaround we have for this is to instead use the Umbraco Commerce Uc.PropertyEditorUi.Toggle property editor which allows you to pass config to say what string values to use as the true/false values

"editorUiAlias": "Uc.PropertyEditorUi.Toggle",
"editorConfig": [
  {
    "alias": "trueValue",
    "value": "true"
  },
  {
    "alias": "falseValue",
    "value": "false"
  }
]

If you don't provide a editorConfig it will just use "1" and "0" string values.

[mattbrailsford]

I've pushed a 15.3.12--preview.11 to our nightly feed if you want to give that a try

[john-kehelly-granite]

Thanks @mattbrailsford I've tried the nightly now and its partially working - for the string value, it will now allow me to clear an order property, but not an order line item property. The order line item property still preserves the old value when you try to clear it.

Using the Uc.PropertyEditorUi.Toggle is working alright both against 15.3.11 and 15.3.12--preview.11.g0b2d153

Video of line item edit showing property preserved when running 15.3.12--preview.11.g0b2d153
https://github.com/user-attachments/assets/f56c285d-4096-43f4-8678-e91afb732642

Updated package.json with toggle field
umbraco-package.json

[mattbrailsford]

Ok, great. At least we are getting close. Let me review the order properties again 👍

[mattbrailsford]

Hmm, It seems to be working fine for me. Did you clear your browser cache to make sure JS updates took effect?

[john-kehelly-granite]

thanks @mattbrailsford , must have been some cache issue alright as its working for me now on both order level properties and order line item properties.

[mattbrailsford]

Excellent. Thanks for confirming. I'll close this issue and get that update rolled out by the end of the week.