[FIX] stock: fix text product label reports with special characters #152657

robinengels · 2024-02-05T10:16:21Z

Current behavior:
When printing products ZPL Labels, special characters are not printed correctly. e.g. quotes become '

Steps to reproduce:

Modify a product name with special characters
Print a product label
Select ZPL Labels

As the report is only rendered as text, the special characters are not dangerous and can be printed as is.

opw-3684870

I confirm I have signed the CLA and read the PR guidelines at www.odoo.com/submit-pr

robodoo · 2024-02-05T10:16:47Z

Pull request status dashboard.

robinengels · 2024-02-05T10:18:19Z

@xmo-odoo Hello I'll need an security override here, this is the same pr as this one (#151859) that you already validated but it's for the correct version.

xmo-odoo · 2024-02-05T10:39:23Z

@robodoo override=ci/security

ticodoo · 2024-02-05T13:34:56Z

@robinengels Ok for me, I can't override the runbot warning though (as far as I know at least). You will probably have to contact the runbot guys for that.

@robodoo r+

robodoo · 2024-02-05T13:35:35Z

@ticodoo you may want to rebuild or fix this PR as it has failed CI.

ticodoo · 2024-02-05T13:39:07Z

@robinengels also based on looking at the pictures the customer posted, it looks like they're also trying to print unicode (e.g. "è", "ç", etc. since it's in French) characters which aren't fixed by your PR. You probably just need to add ^CI28 at the beginning of the report to print it correctly: https://labelary.com/faq.html#i18n (note that you can test the label rendering here: https://labelary.com/viewer.html)

robinengels · 2024-02-06T10:07:51Z

@odoo/rd-runbot Hello, do I need to write an upgrade script because I added report.stock.label_lot_template_view ?

d-fence · 2024-02-07T14:59:26Z

Upgrade exception #302 added.

Waiting the forward-port of this pr, the exception will be applied on all builds, and create an inconsistent state for migrations.
Please forward port this asap up to master without change. Exception should be forward-ported before the end of the week.

If you need to apply any change before it reaches master, please notify runbot team.

Details:

model:report.stock.label_lot_template_view

cc @KangOl @nseinlet

robinengels · 2024-02-07T16:03:46Z

@ticodoo you might need to r+ it again

ticodoo · 2024-02-08T09:22:22Z

@robinengels your current fix is no longer correct. Please consider the case where more than 1 product is having its label printed

robinengels · 2024-02-08T14:54:49Z

@ticodoo This should be good now

clesgow

Hello! I still found some issues:

You forgot about the custom_barcodes section (used for printing made from a picking). They're still 2-tuple, so in the template it will crash as you're trying to access [2].
A similar change needs to be applied to default_code as well, otherwise it could still display the same oddities as in the name.

Make sure to properly test the different use-cases as those labels can be generated in different places. 😉

robinengels · 2024-02-09T15:30:24Z

@clesgow @ticodoo I changed the way we pass information to the report so that it is more readable. Does it look ok to you now ?

clesgow

I'm afraid not. 🙁
Please, take the time to properly test your solution.

clesgow · 2024-02-09T15:56:08Z

addons/stock/report/product_label_report.py

+    def _get_markup_default_code(self, product):
+        if product.default_code and len(product.default_code) > 15:
+            return (markupsafe.Markup(product.default_code[:15]), markupsafe.Markup(product.default_code[15:30]))
+        else:
+            return (markupsafe.Markup(product.default_code or ''))


Is there any good reason to go through that hassle instead of just splitting it in the label like it was done before? Given that you still need to proceed in two separate ways anyway once in the template.

We need to mark it as markup safe before putting it in the template. So I thought it would be cleaner to do it like this.

I agree about the markup part. What I meant was to do the conversion like it is done with display_name_markup and then splice it in the template directly. Little less code for the same end result.

clesgow · 2024-02-09T15:57:23Z

addons/stock/report/product_label_report.py

+                    'display_name_markup': markupsafe.Markup(product.display_name),
+                    'default_code': self._get_markup_default_code(product)
+                }
+                quantity_by_product[product] += (barcodes_qtys)


Why is it still in a tuple since above you append a dict?
Edit: Woops, only meant to select line 49.

clesgow · 2024-02-09T16:00:05Z

addons/stock/report/product_label_report.py

+                barcodes_qtys[0] = {
+                    'barcode': barcodes_qtys[0][0],
+                    'quantity': barcodes_qtys[0][1],
+                    'display_name_markup': markupsafe.Markup(product.display_name),
+                    'default_code': self._get_markup_default_code(product)
+                }


As hinted by the plural form of barcodes_qtys, it is a list. Meaning that there could be more than a single lot in there. 😉

robinengels · 2024-02-12T10:51:37Z

@clesgow I hope it's good now, I tested printing labels of a delivery with multiple products and different lots for each products. I also tested printing labels directly on product page and same for lots. Did I miss a place where we could print labels ?

robinengels · 2024-02-16T14:37:16Z

@clesgow I added some test, let me know if I should add some more cases.

clesgow

Last thing and we're good to go:
Since the ZPL code is not very easy to understand from a simple look, could you add a little description of what your tests are supposed to test ? Since the error tests The rendering is not good isn't really explicit on what went wrong / what was actually checked.

clesgow · 2024-02-23T09:56:45Z

addons/stock/tests/test_report.py

+    def test_product_label_custom_barcode_reports(self):
+        report = self.env.ref('stock.label_product_product')
+        target = b'\n\t\t\n\n\n\n\n\n^XA^CI28\n^FT100,80^A0N,40,30^FD[C4181234""154654654654]Mellohi"^FS\n\n^FT100,115^A0N,30,24^FDC4181234""15465^FS\n^FT100,150^A0N,30,24^FD4654654^FS\n\n\n\n^FO100,160^BY3\n^BCN,100,Y,N,N\n^FDscan""me^FS\n\n^XZ\n\n\n\n^XA^CI28\n^FT100,80^A0N,40,30^FD[C4181234""154654654654]Mellohi"^FS\n\n^FT100,115^A0N,30,24^FDC4181234""15465^FS\n^FT100,150^A0N,30,24^FD4654654^FS\n\n\n\n^FO100,160^BY3\n^BCN,100,Y,N,N\n^FDscan""me^FS\n\n^XZ\n\n\n\n\n\n\n^XA^CI28\n^FT100,80^A0N,40,30^FD[C4181234""154654654654]Mellohi"^FS\n\n^FT100,115^A0N,30,24^FDC4181234""15465^FS\n^FT100,150^A0N,30,24^FD4654654^FS\n\n\n\n^FO100,160^BY3\n^BCN,100,Y,N,N\n^FD123barcode^FS\n\n^XZ\n\n\n\n^XA^CI28\n^FT100,80^A0N,40,30^FD[C4181234""154654654654]Mellohi"^FS\n\n^FT100,115^A0N,30,24^FDC4181234""15465^FS\n^FT100,150^A0N,30,24^FD4654654^FS\n\n\n\n^FO100,160^BY3\n^BCN,100,Y,N,N\n^FD123barcode^FS\n\n^XZ\n\n\n\n\n'
+        rendering, qweb_type = report._render_qweb_text(self.product1.product_tmpl_id.id, {'custom_barcodes': {self.product1.product_tmpl_id.id: [("123barcode", 2)]}, 'quantity_by_product': {self.product1.product_tmpl_id.id: 2}, 'active_model': 'product.template'})


Nitpick: Would be nice to try it with at least two custom_barcodes, as it was this case that broke before.

clesgow · 2024-02-23T10:03:54Z

addons/stock/tests/test_report.py

+        self.assertEqual(target, rendering.replace(b' ', b''), 'The rendering is not good')
+        self.assertEqual(qweb_type, 'text', 'the report type is not good')
+
+    def test_product_label_without_default_code_reports(self):


Not sure I understand the purpose of this test ? Is it solely to check:
https://github.com/odoo/odoo/blob/61c0965d1de8d185a7c7115a36433ce3a3b455fd/addons/stock/report/product_label_report.py#L26
Because if that's the case, not sure it warrants a test. 🙂

Current behavior: When printing products ZPL Labels, special characters are not printed correctly. e.g. quotes become ' Steps to reproduce: - Modify a product name with special characters - Print a product label - Select ZPL Labels As the report is only rendered as text, the special characters are not dangerous and can be printed as is. opw-3684870

clesgow · 2024-02-29T09:27:45Z

@robodoo r+

Current behavior: When printing products ZPL Labels, special characters are not printed correctly. e.g. quotes become ' Steps to reproduce: - Modify a product name with special characters - Print a product label - Select ZPL Labels As the report is only rendered as text, the special characters are not dangerous and can be printed as is. opw-3684870 closes #152657 Signed-off-by: Quentin Wolfs (quwo) <quwo@odoo.com>

fw-bot · 2024-03-04T05:55:06Z

@robinengels @clesgow this pull request has forward-port PRs awaiting action (not merged or closed):

[FW][FIX] stock: fix text product label reports with special characters #155853

fw-bot · 2024-03-05T05:55:07Z

@robinengels @clesgow this pull request has forward-port PRs awaiting action (not merged or closed):

[FW][FIX] stock: fix text product label reports with special characters #155853

Xavier-Do · 2024-03-05T07:38:39Z

Upgrade exception #302 added.

Waiting the forward-port of this pr, the exception will be applied on all builds, and create an inconsistent state for migrations. Please forward port this asap up to master without change. Exception should be forward-ported before the end of the week.

Hello @clesgow

Can you please forwardport this asap? ;)

Edit: just noticed that the forwarport pr was active nevermind

fw-bot · 2024-03-06T05:54:50Z

@robinengels @clesgow this pull request has forward-port PRs awaiting action (not merged or closed):

fw-bot · 2024-03-07T05:53:58Z

@robinengels @clesgow this pull request has forward-port PRs awaiting action (not merged or closed):

fw-bot · 2024-03-08T05:53:55Z

@robinengels @clesgow this pull request has forward-port PRs awaiting action (not merged or closed):

[FW][FIX] stock: fix text product label reports with special characters #156814

robinengels mentioned this pull request Feb 5, 2024

[FIX] stock: fix text product label reports with special characters #151859

Closed

C3POdoo requested a review from a team February 5, 2024 10:21

C3POdoo added the OE the report is linked to a support ticket (opw-...) label Feb 5, 2024

robinengels requested a review from ticodoo February 5, 2024 11:57

robinengels force-pushed the 15.0-opw-3684870-zebra_printer_special_chars-roen branch 4 times, most recently from 93160c5 to 1dc197b Compare February 5, 2024 15:48

robinengels requested a review from a team February 7, 2024 12:32

robinengels force-pushed the 15.0-opw-3684870-zebra_printer_special_chars-roen branch 2 times, most recently from bcebc02 to 93bf6f6 Compare February 8, 2024 12:21

clesgow reviewed Feb 9, 2024

View reviewed changes

robinengels force-pushed the 15.0-opw-3684870-zebra_printer_special_chars-roen branch from 93bf6f6 to 8ef9a9d Compare February 9, 2024 15:29

robinengels force-pushed the 15.0-opw-3684870-zebra_printer_special_chars-roen branch from 8ef9a9d to 215ecf0 Compare February 9, 2024 15:48

clesgow reviewed Feb 9, 2024

View reviewed changes

robinengels force-pushed the 15.0-opw-3684870-zebra_printer_special_chars-roen branch 2 times, most recently from 714ab1b to dd8689d Compare February 12, 2024 10:49

robinengels force-pushed the 15.0-opw-3684870-zebra_printer_special_chars-roen branch 2 times, most recently from c36f27a to 61c0965 Compare February 20, 2024 11:54

robinengels requested a review from clesgow February 21, 2024 10:06

clesgow reviewed Feb 23, 2024

View reviewed changes

robinengels force-pushed the 15.0-opw-3684870-zebra_printer_special_chars-roen branch from 61c0965 to 5d3ed1b Compare February 23, 2024 11:37

robinengels force-pushed the 15.0-opw-3684870-zebra_printer_special_chars-roen branch from 5d3ed1b to c600728 Compare February 23, 2024 15:44

robinengels requested a review from clesgow February 27, 2024 09:47

robodoo temporarily deployed to merge February 29, 2024 10:55 Inactive

robodoo closed this Feb 29, 2024

fw-bot mentioned this pull request Feb 29, 2024

[FW][FIX] stock: fix text product label reports with special characters #155853

Closed

This was referenced Mar 6, 2024

[FW][FIX] stock: fix text product label reports with special characters #156803

Closed

[FW][FIX] stock: fix text product label reports with special characters #156814

Closed

fw-bot deleted the 15.0-opw-3684870-zebra_printer_special_chars-roen branch March 14, 2024 11:46

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[FIX] stock: fix text product label reports with special characters #152657

[FIX] stock: fix text product label reports with special characters #152657

robinengels commented Feb 5, 2024

robodoo commented Feb 5, 2024

robinengels commented Feb 5, 2024

xmo-odoo commented Feb 5, 2024

ticodoo commented Feb 5, 2024

robodoo commented Feb 5, 2024

ticodoo commented Feb 5, 2024

robinengels commented Feb 6, 2024

d-fence commented Feb 7, 2024

robinengels commented Feb 7, 2024

ticodoo commented Feb 8, 2024

robinengels commented Feb 8, 2024

clesgow left a comment •

edited

robinengels commented Feb 9, 2024

clesgow left a comment

clesgow Feb 9, 2024

robinengels Feb 12, 2024

clesgow Feb 15, 2024

clesgow Feb 9, 2024 •

edited

clesgow Feb 9, 2024

robinengels commented Feb 12, 2024

robinengels commented Feb 16, 2024

clesgow left a comment

clesgow Feb 23, 2024

clesgow Feb 23, 2024

clesgow commented Feb 29, 2024

fw-bot commented Mar 4, 2024

fw-bot commented Mar 5, 2024

Xavier-Do commented Mar 5, 2024 •

edited

fw-bot commented Mar 6, 2024

fw-bot commented Mar 7, 2024

fw-bot commented Mar 8, 2024

[FIX] stock: fix text product label reports with special characters #152657

[FIX] stock: fix text product label reports with special characters #152657

Conversation

robinengels commented Feb 5, 2024

opw-3684870

robodoo commented Feb 5, 2024

robinengels commented Feb 5, 2024

xmo-odoo commented Feb 5, 2024

ticodoo commented Feb 5, 2024

robodoo commented Feb 5, 2024

ticodoo commented Feb 5, 2024

robinengels commented Feb 6, 2024

d-fence commented Feb 7, 2024

robinengels commented Feb 7, 2024

ticodoo commented Feb 8, 2024

robinengels commented Feb 8, 2024

clesgow left a comment • edited

Choose a reason for hiding this comment

robinengels commented Feb 9, 2024

clesgow left a comment

Choose a reason for hiding this comment

clesgow Feb 9, 2024

Choose a reason for hiding this comment

robinengels Feb 12, 2024

Choose a reason for hiding this comment

clesgow Feb 15, 2024

Choose a reason for hiding this comment

clesgow Feb 9, 2024 • edited

Choose a reason for hiding this comment

clesgow Feb 9, 2024

Choose a reason for hiding this comment

robinengels commented Feb 12, 2024

robinengels commented Feb 16, 2024

clesgow left a comment

Choose a reason for hiding this comment

clesgow Feb 23, 2024

Choose a reason for hiding this comment

clesgow Feb 23, 2024

Choose a reason for hiding this comment

clesgow commented Feb 29, 2024

fw-bot commented Mar 4, 2024

fw-bot commented Mar 5, 2024

Xavier-Do commented Mar 5, 2024 • edited

fw-bot commented Mar 6, 2024

fw-bot commented Mar 7, 2024

fw-bot commented Mar 8, 2024

clesgow left a comment •

edited

clesgow Feb 9, 2024 •

edited

Xavier-Do commented Mar 5, 2024 •

edited