[16.0][MIG] sale_order_weight: Migration to 16.0 (from 12.0) #3414

legalsylvain · 2024-11-18T15:59:51Z

Migration of the module sale_order_weight from OCA/sale-workflow/12.0 to 16.0
Note another module with the same name exists with similar features (smaller scope) in OCA/sale-reporting/14.0. This PR includes the feature of the "other" module.

Description

Configuration

Go to “Sales > Configuration > Settings”

Display Order weight is checked by default.
The weight display at line level is hidden by default, to avoid burdening the PDF report.

Usage

Go to a sale order.

The ordered weights are displayed on each order lines and at order level.

Note: The weight are also available on the order tree view. (optional="hide" by default)

Print a sale order.

Change Log

[MIG] sale_order_weight: Migration to 16.0 (from 12.0)

[FIX] change weight on product now change automatically the weight of the sale orders.
So it is not necessary to 'recompute' the weight of the orders, and the value is always correct.
(Also the column 'Unit Weight' is removed at sale.order.line level)

[FIX] Now handle correctly conversion. Use Case :
- product.product (weight : 50kg ; Uom : Unit)
- sale.order.line (Qty : 10 ; UoM : dozen)
-> Before, the weight was 50 * 10 = 500 and was wrong.
-> Now the weight is 50 * 10 * 12 = 6000

[ADD] migration script to recompute correctly values that can be incorrect and obsolete (due to conversion errors)

[IMP] Display weight on sale order report.
Note: this code comes from the other OCA modules name sale_order_weight,
present in the OCA repo sale-reporting, in V14:
See: https://github.com/OCA/sale-reporting/tree/14.0/sale_order_weight

[IMP] add configuration to display the weight or not on the sale order report.
(configuration for the total order, and the order on each lines)

[REM] remove 'delivered' weight for the following reasons:
- The delivered quantity on sale order lines is a non stored field.
  So, the recompute of the field fails, and the field total_delivered_weight is not updated correctly.
- It is legit to want to have only Ordered weight and not Delivered Weight, and the addition of the delivered weight
  make the database bigger, and the process slower.
Better to create a dedicated module for delivered weight

Updated by "Update PO files to match POT (msgmerge)" hook in Weblate. Translation: sale-workflow-12.0/sale-workflow-12.0-sale_order_weight Translate-URL: https://translation.odoo-community.org/projects/sale-workflow-12-0/sale-workflow-12-0-sale_order_weight/

…e_weight. (by setting correct value in the creation of the sale order lines)

…sale.order.line. Otherwise, if stored field depends on non stored fields, too much recomputation are done. Also allow to make analysis at order lines level

…and accounting information (after taxes included)

… so that the user can see if a weight is missing on a product Also because user should have the possibility to change the unit weight if for some reason, a product has a different weight for a single order.

…e view for consistency reason. total_delivered_weight is also hidden. Also order total weight is enough for user

…t field. - fast precompute of total weights on sale.order.line and sale.order tables

…order form view

…t_weight field. - fast precompute of total weights on sale.order.line and sale.order tables

legalsylvain · 2024-11-19T17:02:48Z

/ocabot migration sale_order_weight

CC : @OCA/crm-sales-marketing-maintainers

OCA-git-bot · 2024-11-19T17:02:59Z

Sorry @legalsylvain you are not allowed to mark the addon tobe migrated.

To do so you must either have push permissions on the repository, or be a declared maintainer of all modified addons.

If you wish to adopt an addon and become it's maintainer, open a pull request to add your GitHub login to the maintainers key of its manifest.

rousseldenis · 2024-11-19T17:59:36Z

/ocabot migration sale_order_weight

simahawk

@legalsylvain for big refactoring I wouldn't be better to migrate the module 1st as not installable? I think that would ease the review of the changes. Not so big here... Not a blocker, just a suggestion.
One more thing... A reminder that we have commit msg guidelines and that the details of a change go to the description of the commit.

Example:

[FIX] sale_order_weight : store intermediate total_ordered_weight on sale.order.line. Otherwise, if stored field depends on non stored fields, too much recomputation are done.

Also allow to make analysis at order lines level

to

[FIX] sale_order_weight: improve total_ordered_weight compute perf

Store intermediate total_ordered_weight on sale.order.line.
Otherwise, if stored field depends on non stored fields, too many re-computations are done.
It also allow to make analysis at order lines level.

simahawk · 2024-11-20T06:47:33Z

sale_order_weight/models/sale_order.py

+
+    @api.depends("order_line.total_ordered_weight")
+    def _compute_total_ordered_weight(self):
+        for order in self:


this field can be used in tree views too. It would be better to use a read_group + sum function

Hi. It is a stored field. so the function will not be called by a tree view displaying 10000 sale.order.line. (for exemple).
or did I missed something ?

simahawk · 2024-11-20T06:48:51Z

sale_order_weight/models/sale_order_line.py

+        "product_id.weight", "product_id.uom_id", "product_uom", "product_uom_qty"
+    )
+    def _compute_total_ordered_weight(self):
+        for line in self.filtered(lambda x: x.product_id):


pre-filtering in such cases causes to loop twice on the same records. As you have a loop, just filter inside it:

for line in self: if not line.product_id: continue [...]

BTW... can you have a line w/o product?

pre-filtering in such cases causes to loop twice on the same records. As you have a loop, just filter inside it:

Even though I've been working with odoo for a few years now, I still find it hard to understand certain optimisations for using ORM. I need to study again the odoo experience talks!

Thanks for your review. Fixed !

BTW... can you have a line w/o product?

Yes, in sale.order.line model, you have 3 "type" of lines. "product", "section", and "note". section and note doesn't have a product_id defined.

Although it's true that technically there are 2 loops, the performance penalty is insignificant - as the first loop caches data, and then it's only passes again through cached data - while writing 3 lines of code instead of 1 makes the code uglier to read.

@pedrobaeza : thanks for your extra explanation.

@simahawk Are you agree with @pedrobaeza remarks ? what is the definive syntax to use ?

Thanks !

simahawk · 2024-11-20T06:50:28Z

sale_order_weight/reports/report_sale_order.xml

+        <xpath expr="//t[@t-set='address']" position="after">
+            <t
+                t-set="weight_uom_name"
+                t-value="doc.env['product.template']._get_weight_uom_name_from_ir_config_parameter()"


I would delegate these lookups to a method on sale_order _get_report_weight_params or smth similar.
Eg: weight_uom_name, weight_precision = doc._get_report_weight_params()

Hi.

It's a copy past of the existing V14 module https://github.com/OCA/sale-reporting/blob/14.0/sale_order_weight/views/sale_report.xml#L15-L22

_get_weight_uom_name_from_ir_config_parameter is a native odoo function that is called always that way.

./odoo/addons/delivery/models/stock_picking.py: return self.env['product.template']._get_weight_uom_name_from_ir_config_parameter() ./odoo/addons/delivery/models/stock_picking.py: package.weight_uom_name = self.env['product.template']._get_weight_uom_name_from_ir_config_parameter() ./odoo/addons/delivery/models/stock_picking.py: return self.env['product.template']._get_weight_uom_name_from_ir_config_parameter() ./odoo/addons/delivery/models/stock_picking.py: package.weight_uom_name = self.env['product.template']._get_weight_uom_name_from_ir_config_parameter() ./odoo/addons/delivery/models/delivery_carrier.py: weight_uom_name = self.env['product.template']._get_weight_uom_name_from_ir_config_parameter() ./odoo/addons/stock/models/stock_package_type.py: return self.env['product.template']._get_weight_uom_name_from_ir_config_parameter() ./odoo/addons/stock/models/stock_package_type.py: package_type.weight_uom_name = self.env['product.template']._get_weight_uom_name_from_ir_config_parameter() ./odoo/addons/stock/models/stock_storage_category.py: self.weight_uom_name = self.env['product.template']._get_weight_uom_name_from_ir_config_parameter() ./odoo/addons/delivery_stock_picking_batch/models/stock_picking.py: return self.env['product.template']._get_weight_uom_name_from_ir_config_parameter() ./odoo/addons/delivery_stock_picking_batch/models/stock_picking.py: picking_type.weight_uom_name = self.env['product.template']._get_weight_uom_name_from_ir_config_parameter()

I don't see the interest to define a new function in python code. I see it more verbose. Could you elaborate ?
Thanks !

[FIX] the weight on sale.order.line is now always correct. Change weight on product now change automatically the weight of the sale orders. So it is not necessary to 'recompute' the weight of the orders, and the value is always correct. (Also the column 'Unit Weight' is removed at sale.order.line level) [FIX] Handle correctly UoM conversion. Use Case : - product.product (weight : 50kg ; Uom : Unit) - sale.order.line (Qty : 10 ; UoM : dozen) -> Before, the weight was 50 * 10 = 500 and was wrong. -> Now the weight is 50 * 10 * 12 = 6000 [MIG] Add script to fix incorrect weight values The values can be incorrect (due to conversion errors), or obsolet (if user didn't click on 'recompute weight') [IMP] Display weight on sale order report. Note: this code comes from the other OCA modules name sale_order_weight, present in the OCA repo sale-reporting, in V14: See: https://github.com/OCA/sale-reporting/tree/14.0/sale_order_weight [IMP] Configuration to display the weight or not on the sale order report. Configuration is available for the total order, and the order on each lines. [REM] remove 'delivered' weight for the following reasons: - The delivered quantity on sale order lines is a non stored field. So, the recompute of the field fails, and the field total_delivered_weight is not updated correctly. - It is legit to want to have only Ordered weight and not Delivered Weight, and the addition of the delivered weight make the database bigger, and the process slower. It is so Better to create a dedicated module for delivered weight

legalsylvain · 2024-11-20T09:28:05Z

Hi @simahawk. thanks a lot for your complete review !

for big refactoring I wouldn't be better to migrate the module 1st as not installable? I think that would ease the review of the changes. Not so big here... Not a blocker, just a suggestion.

Well, in fact, I planned to "simply" migrate this module,but as I worked on it, I realised that there were lots of things to fix and refactor, and the migration commit got bigger and bigger!

I'm sorry if the review is a bit complicated.

One more thing... A reminder that we have commit msg guidelines and that the details of a change go to the description of the commit.

I have rewrote the commit message. Hope it is ok now.

Let me know if there are remaining things to do.

manuelcalerosolis and others added 21 commits November 18, 2024 16:58

[ADD] sale_order_weight: New module to 12.0

7279887

Add button to recalculate weight

984c7a1

[UPD] Update sale_order_weight.pot

5196c79

[UPD] README.rst

847da2a

sale_order_weight 12.0.1.0.1

f49722e

[12.0][IMP] copier

5ebfb22

sale_order_weight 12.0.1.0.2

298b338

[UPD] README.rst

d1c7b8c

Update translation files

d2af346

Updated by "Update PO files to match POT (msgmerge)" hook in Weblate. Translation: sale-workflow-12.0/sale-workflow-12.0-sale_order_weight Translate-URL: https://translation.odoo-community.org/projects/sale-workflow-12-0/sale-workflow-12-0-sale_order_weight/

[REF] sale_order_weight : simplify test code. Remove call of _onchang…

db86c7f

…e_weight. (by setting correct value in the creation of the sale order lines)

[FIX] sale_order_weight : store intermediate total_ordered_weight on …

13f3204

…sale.order.line. Otherwise, if stored field depends on non stored fields, too much recomputation are done. Also allow to make analysis at order lines level

[IMP] sale_order_weight : display weight information after all order …

db0c97b

…and accounting information (after taxes included)

[IMP] sale_order_weight : display unit_weight in sale order form view…

95afc22

… so that the user can see if a weight is missing on a product Also because user should have the possibility to change the unit weight if for some reason, a product has a different weight for a single order.

[REF] sale_order_weight : hide total_ordered_weight in order line tre…

9130763

…e view for consistency reason. total_delivered_weight is also hidden. Also order total weight is enough for user

[REF] sale_order_weight : module adopted

126a324

[IMP] sale_order_weight : fast prepopulate sale_order_line.unit_weigh…

1959c43

…t field. - fast precompute of total weights on sale.order.line and sale.order tables

[FIX] sale_order_weight : display also total_delivery_weight on sale_…

a746bdb

…order form view

[ADD] sale_order_weight : french translation

44eca4c

fixup! [IMP] sale_order_weight : fast prepopulate sale_order_line.uni…

50ae5d9

…t_weight field. - fast precompute of total weights on sale.order.line and sale.order tables

[BOT] post-merge updates

99b37e9

[IMP] sale_order_weight: pre-commit stuff

ee705d1

legalsylvain force-pushed the 16.0-mig-sale_order_weight branch 2 times, most recently from 09b050c to 5587baf Compare November 19, 2024 17:00

legalsylvain marked this pull request as ready for review November 19, 2024 17:01

OCA-git-bot added this to the 16.0 milestone Nov 19, 2024

rousseldenis added needs review migration labels Nov 19, 2024

OCA-git-bot mentioned this pull request Nov 19, 2024

Migration to version 16.0 #2215

Open

99 tasks

simahawk requested changes Nov 20, 2024

View reviewed changes

legalsylvain force-pushed the 16.0-mig-sale_order_weight branch from 5587baf to d5d53e1 Compare November 20, 2024 09:15

legalsylvain force-pushed the 16.0-mig-sale_order_weight branch from d5d53e1 to 0aa0b89 Compare November 20, 2024 09:23

legalsylvain requested a review from simahawk November 26, 2024 20:27

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[16.0][MIG] sale_order_weight: Migration to 16.0 (from 12.0) #3414

[16.0][MIG] sale_order_weight: Migration to 16.0 (from 12.0) #3414

legalsylvain commented Nov 18, 2024 •

edited

Loading

legalsylvain commented Nov 19, 2024

OCA-git-bot commented Nov 19, 2024

rousseldenis commented Nov 19, 2024

simahawk left a comment •

edited

Loading

simahawk Nov 20, 2024

legalsylvain Nov 20, 2024 •

edited

Loading

simahawk Nov 20, 2024

legalsylvain Nov 20, 2024 •

edited

Loading

pedrobaeza Nov 20, 2024

legalsylvain Nov 20, 2024

simahawk Nov 20, 2024

legalsylvain Nov 20, 2024 •

edited

Loading

legalsylvain commented Nov 20, 2024

[16.0][MIG] sale_order_weight: Migration to 16.0 (from 12.0) #3414

Are you sure you want to change the base?

[16.0][MIG] sale_order_weight: Migration to 16.0 (from 12.0) #3414

Conversation

legalsylvain commented Nov 18, 2024 • edited Loading

Description

Configuration

Usage

Change Log

legalsylvain commented Nov 19, 2024

OCA-git-bot commented Nov 19, 2024

rousseldenis commented Nov 19, 2024

simahawk left a comment • edited Loading

Choose a reason for hiding this comment

simahawk Nov 20, 2024

Choose a reason for hiding this comment

legalsylvain Nov 20, 2024 • edited Loading

Choose a reason for hiding this comment

simahawk Nov 20, 2024

Choose a reason for hiding this comment

legalsylvain Nov 20, 2024 • edited Loading

Choose a reason for hiding this comment

pedrobaeza Nov 20, 2024

Choose a reason for hiding this comment

legalsylvain Nov 20, 2024

Choose a reason for hiding this comment

simahawk Nov 20, 2024

Choose a reason for hiding this comment

legalsylvain Nov 20, 2024 • edited Loading

Choose a reason for hiding this comment

legalsylvain commented Nov 20, 2024

legalsylvain commented Nov 18, 2024 •

edited

Loading

simahawk left a comment •

edited

Loading

legalsylvain Nov 20, 2024 •

edited

Loading

legalsylvain Nov 20, 2024 •

edited

Loading

legalsylvain Nov 20, 2024 •

edited

Loading