Enhancement: Add order note to display held stock inventory. #29132

[Abdalsalaam]

Submission Review Guidelines:

• I have followed the WooCommerce Contributing Guidelines and the WordPress Coding Standards.
• I have checked to ensure there aren't other open Pull Requests for the same update/change.
• I have reviewed my code for security best practices.
• Following the above guidelines will result in quick merges and clear and detailed feedback when appropriate.

Changes proposed in this Pull Request:

Closes #29132 .

How to test the changes in this Pull Request:

Using the WooCommerce Testing Instructions Guide, include your detailed testing instructions:

1. Create a new order without completing the payment process or with "Direct bank transfer" payment method.
2. Check the order notes.
3. 

[jorgeatorres]

Hi @Abdalsalaam!

Thank you for your contribution and for participating on this special day 🥇. Overall, the code looks good to me and works correctly. I left a couple of tiny suggestions, but nothing huge.

While testing, however, I noticed that depending on the product names involved, the message can look a bit confusing, especially when variable products are added to the mix, as those can output commas (,) as part of their names. For example:

The use of colons to indicate IDs might also be confusing given colons are also used before the product names list.

I was wondering if, for simplicity's sake, we should only list the product IDs for which we're holding stock (no names) or just a generic message with no specific IDs or names.

@vedanshujain: as the author of the original issue, did you have any specific formatting in mind? Do you think a message with just product IDs or a generic message work here?

If not, we would need to be a bit more clever on how to separate the product names to prevent any confusion (or notes that are too large).

@Abdalsalaam: code-wise this looks good to me (with the few exceptions mentioned in the review), but I'd like to hear from @vedanshujain first. If you have some ideas on how to change the presentation to make things clearer, by all means please share those too!

Once again, thanks for all your hard work on this.

[Abdalsalaam]

Thank you @jorgeatorres ! I did the changes, for the note I think its good to have the product name in the note, I suggest to use / instead of commas to separate products, also we can use X for the quantity, it will be like this :

Stock held for 10080 minutes for payment: Product (ID: #6293), Color: Green, Attribute: Red x 1 / Import Product - Variable - Yellow (ID: #5953) x 1"

Or something like :

what do you think?

[jorgeatorres]

Hi @Abdalsalaam!

I particularly like the last idea, with the dash/bullet list. I think that looks much clearer.
Maybe we can rephrase the message a little so that it's clear that the list of items/products comes after. Something like "Stock hold of X minutes applied to: <list of items/quantities>".
If you can think of a different better phrasing, feel free to propose that instead.

I also think we should limit the number of products that are listed. If the order contains tons of items, the note could end up being too large. Maybe we should only apply it to the first 5 products and if there are more, we just add something like "- ... and N more items." That's obviously less useful, but also less noisy. What are your thoughts on that? Definitely not a blocker, but worth discussing now that we're working on this.

Looking forward to hearing back from you!

[Abdalsalaam]

I like your Idea, i think we should it it now yes. let me an edit for it.

[Abdalsalaam]

@jorgeatorres

What do you think?

[jorgeatorres]

Hi @Abdalsalaam,

Thanks for making the changes. I think it looks really great. I'll go through a re-review as soon as possible!

Fixed.

[jorgeatorres]

@Abdalsalaam:

Thanks again for your contribution and all the work you put into this 🥇. I pushed a couple of commits with some small adjustments to the code (we were missing a couple of translatable strings, etc.) but overall, this works and looks great.

As such, I'm approving now. It's been a pleasure working with you in this PR and hope we'll be seeing more contributions from you, not only on Contributor Day 😸

Thanks!

[rodelgc]

Steps to test

1. Create a new order with less than 5 products, without completing the payment process or with "Direct bank transfer" payment method.
2. Verify that an order note that says "Stock hold of 5 minutes is applied to:" and a list of products in the order were shown.
3. Repeat the steps above with more than 5 products.
4. Verify that the order note now says "...and X more items" after the 5th item. See screenshot in Enhancement: Add order note to display held stock inventory. #29132 #37833 (comment)