[16.0][IMP] shopinvader_api_sale_loyalty: do not update rewards when reading a sale

[QuocDuong1306]

The issue:

• [16.0] shopinvader_api_sale_loyalty: wrong write on GET /sales #1538

Context:

• sale.order:_update_programs_and_rewards() must be called at least once to create reward lines

• In odoo native, it is done when clicking on button PROMOTIONS and on sale.order:action_confirm()

• In oca, we have module sale_loyalty_auto_refresh ([16.0][MIG] sale_loyalty_auto_refresh: Migration to 16.0 OCA/sale-promotion#208) to do it whenever the sale order is updated

• So in shopinvader_api_sale_loyalty, sale.order:_update_programs_and_rewards() was explicitly called on GET /sales to make sure reward lines are created before returning the requested sale orders data

• But sale.order:_update_programs_and_rewards() implementation calls write() through _reset_loyalty() which is not what we expect from a GET endpoint (should be read-only); one direct consequence is that GET /sales endpoint can fail when called for locked orders

• This PR fixes it by calling sale.order:_update_programs_and_rewards() only when strictly needed (when no reward line exists), and of course only if not locked.

Improvements:

• it's not necessary to update the reward every time we call the information on sale object. The method is already called when updating the cart: https://github.com/shopinvader/odoo-shopinvader/blob/16.0/shopinvader_api_sale_loyalty/routers/cart.py#L203

[simahawk]

• Would it be a good addition to add a new POST route in the module to explicitly call sale.order:_update_programs_and_rewards()?

I think so. Yet, if you install sale_loyalty_auto_refresh this won't be needed AFAIU. If yes, we should simply mention this in the readme.

[QuocDuong1306]

I updated the PR

[sebastienbeau]

After think twice, I think we can simply remove the call to _update_programs_and_rewards

I just test it with this PR : #1552 and the test are green

[QuocDuong1306]

Thank @sebastienbeau for your work, I have included them into this PR (code, description, title). Could you close this PR to make sure all improvements are in one place

[cyrilmanuel]

@QuocDuong1306 can you make the modification ?

[QuocDuong1306]

This PR has been updated including changes in this PR @simahawk @cyrilmanuel

[shopinvader-git-bot]

This PR has the approved label and has been created more than 5 days ago. It should therefore be ready to merge by a maintainer (or a PSC member if the concerned addon has no declared maintainer). 🤖

[shopinvader-git-bot]

This PR has the approved label and has been created more than 5 days ago. It should therefore be ready to merge by a maintainer (or a PSC member if the concerned addon has no declared maintainer). 🤖

[sebastienbeau]

/ocabot merge patch

[sebastienbeau]

/ocabot merge patch

[shopinvader-git-bot]

On my way to merge this fine PR!
Prepared branch 16.0-ocabot-merge-pr-1543-by-sebastienbeau-bump-patch, awaiting test results.

[shopinvader-git-bot]

Hey, thanks for contributing! Proceeding to merge this for you.
Prepared branch 16.0-ocabot-merge-pr-1543-by-sebastienbeau-bump-patch, awaiting test results.

[shopinvader-git-bot]

@sebastienbeau your merge command was aborted due to failed check(s), which you can inspect on this commit of 16.0-ocabot-merge-pr-1543-by-sebastienbeau-bump-patch.

After fixing the problem, you can re-issue a merge command. Please refrain from merging manually as it will most probably make the target branch red.