[18.0][MIG] website_sale_affiliate migration from 16.0 to 18.0 by jans23 · Pull Request #1228 · OCA/e-commerce

jans23 · 2026-05-29T18:59:40Z

No description provided.

jans23 · 2026-05-29T20:52:31Z

@fcayre please review.

jans23 · 2026-05-29T20:54:28Z

@pilarvargas-tecnativa could you review this please?

pilarvargas-tecnativa

Hello,
Thank you for your contribution. Please check the commit history as it is incomplete.
Regards!

KDRdev · 2026-06-02T11:23:53Z

Hello, Thank you for your contribution. Please check the commit history as it is incomplete. Regards!

@pilarvargas-tecnativa thank you for the review. Could you please check if the current PR version has been prepared as expected? Thanks!

jans23 · 2026-06-02T11:55:07Z

@pilarvargas-tecnativa Updated accordingly. Please check.

pilarvargas-tecnativa · 2026-06-02T14:34:13Z

-        compute='_compute_sales_per_request',
-        help='Sale count / Request count',
+        compute="_compute_sales_per_request",
+        help="Sale count / Request count",


Changing ' to " doesn't help with the migration; it just makes the diff bigger

According to the OCA module migration technical guidelines (https://github.com/OCA/maintainer-tools/wiki/Migration-to-version-18.0#technical-method-to-migrate-a-module-from-170-to-180-branch), pre-commit needs to be run during migration. Running pre-commits causes these changes, so I think it's correct.

In any case, it is advisable to run pre-commit and save any changes you make in a separate commit, rather than including them in the migration commit. This ensures that the functional changes made by the migration are clearly separated from the automatic formatting adjustments, making it easier to review and track the commit history.

pre-commit run -a git add -A git commit -m "[IMP] affiliate: pre-commit auto fixes" --no-verify

@KDRdev following strictly the migration guide you have referred, that changes are isolated in its own commit, not on the migration commit.

Ok, so migration itself (syntactic, Odoo-standard business logic-dependent changes) should be a separate commit, pre-commit should be a separate commit, correct?. If there are some extra changes/additional functions, each should be a separate commit, but can still be included in this PR, right?

Just follow the guide...

pilarvargas-tecnativa · 2026-06-02T14:36:27Z

+                "valid_hours": 24,
+                "valid_sales": 1,
+            }
+        )


This change doesn't make any difference either

Caused by pre-commit, which is recommended during module migration according to OCA

Moved to a separate commit from migration commit.

pilarvargas-tecnativa · 2026-06-02T14:36:51Z

        """Returns existing affiliate request record matching aff_key
        from kwargs when match already exists"""
-        kwargs = {'aff_key': self.demo_request.name}
+        kwargs = {"aff_key": self.demo_request.name}


Caused by pre-commit, which is recommended during module migration according to OCA

Moved to a separate commit from migration commit.

pilarvargas-tecnativa · 2026-06-02T14:37:33Z


+from odoo.addons.website_sale.controllers.main import WebsiteSale as Base
+
+_logger = logging.getLogger(__name__)


Is it necessary?

No, it's not needed. Thanks!

pilarvargas-tecnativa · 2026-06-02T14:38:29Z

-            request.session['affiliate_request'] = affiliate_request.id
-        except (AttributeError, ValueError):
-            pass
+        affiliate = request.env["sale.affiliate"].sudo().find_from_kwargs(**kwargs)


This change doesn't help with the migration either; it just adds noise to the diff

Probably appeared after running pre-commit, which is expected during module migration.

I understand that pre-commit may have changed the formatting, but this diff does not look like a pure formatting change to me.

It removes the try/except block and the assignment to request.session["affiliate_request"], so it seems to change the behavior, not just the style. Could you please check whether this change was intentional and, if so, explain why it is needed for the migration?

Finally, this change does not appear to stem from a pre-commit or an automatic version update. The flow of _store_affiliate_info is being modified, removing the original try/except block and changing how cases without an affiliate or without an affiliate_request are handled. That may be correct, but it should then be justified as a functional change and covered by tests. If it is not strictly necessary for the migration, it would be better to revert it to reduce noise and risk.

@pilarvargas-tecnativa the flow has been modified to fix pylint error [W8138(except-pass), WebsiteSale._store_affiliate_info] pass into block except. If you really need to use the pass consider logging that exception. Current execution fixes this error and doesn't change the functionality and doesn't remove original session header assignment. I think it's better than just logging the error as per pylint suggestion. It's covered by tests in 'test_website_sale.py' and is a very minor change that doesn't produce extra noise. I hope this explanation justifies the change and it can be included in the migrated module.

@pilarvargas-tecnativa I've reconsidered my opinion and removed the change as it may have caused some tests to fail. I've added a fix for pylint error as per linter suggestion.

pilarvargas-tecnativa · 2026-06-02T14:39:51Z

+        affiliate = request.env["sale.affiliate"].sudo().find_from_kwargs(**kwargs)
+        if not affiliate:
+            return
+


It is best to avoid leaving spaces between lines of code

In this case I'd argue that this change can stay since we're separating different logical blocks (line 16 is a return statement).

pilarvargas-tecnativa · 2026-06-02T14:43:26Z

-        self._store_affiliate_info(**kwargs)
+    def product(self, *args, **post):
+        res = super().product(*args, **post)
+        self._store_affiliate_info(**post)


It's added to allow generating affiliate links with '/shop/product...'. Then we can track if order source used affiliate links by checking the field affiliate_request_idon sale order.

I understand the purpose, but this is a functional change, not a migration one.

If /shop affiliate links were not supported before, adding support for them should not be part of the migration commit. For a 16.0 to 18.0 migration, we should keep the existing behavior working in 18.0 and avoid introducing new tracking flows unless they are required by a framework/API change.

Could you please move this to a separate commit/PR, or explain which 18.0 change makes it necessary for the migration?

This change has been removed.

pilarvargas-tecnativa · 2026-06-02T14:43:38Z

-        res = super(WebsiteSale, self).shop(page, category,
-                                            search, ppg, **post)
+    def shop(self, *args, **post):
+        res = super().shop(*args, **post)


It's added to allow generating affiliate links with '/shop/...'. Then we can track if order source uses affiliate links by checking the field affiliate_request_idon sale order.

This is now changed only due to change in Odoo standard /shop endpoint changes and to make sure unit tests pass

KDRdev · 2026-06-10T15:41:33Z

@pilarvargas-tecnativa I've replied to your comments, could you please have a look. Thank you!

* [ADD] website_sale_affiliate: Create module * Add sale.affiliate and sale.affiliate.request models * Override WebsiteSale controller shop method to store affiliate id & key kwargs of shop urls in session * Override sale order create method to store affiliate request * Add affiliate and request views, links in Sales/Affiliates * Add affiliate_request_id to sale.order form view * Add request sequence record, make default for new affiliates * Add access rights to sales users/managers * Add tests * Add readme instructions * [IMP] website_sale_affiliate: Make requested changes * Update readme * Add controller override to catch product urls * Remove redundant return None * Replace if statements with try/except when appropriate * Change api decorator on sale.affiliate.find_from_session method from model -> model_cr_context * Add check to avoid unnecessary db search in find_from_session if no affiliate_id * Fix tests * Add new tests * [IMP] website_sale_affiliate: Make requested changes * Un-nest try/except statements for readability * Rename kwargs: ref, key -> aff_ref, aff_key * Improve request search speed for large recordsets * Document similarly-named methods for clarity * Tweak tests as needed * Add additional test * Add roadmap to readme * [REM] website_sale_affiliate: Remove affiliate request IP-matching * [IMP] website_sale_affiliate: Change affiliate request creation * Create affiliate requests regardless of whether a sale occurs * Add basic conversion/sales stats to affiliate model and views * Update tests * Add demo data * Clean up views * Remove line used for debugging * Add field string for clarity * [FIX] website_sale_affiliate: Fix compatibility issues, tests * Fix controller method overrides to avoid conflicts * Match assertAlmostEqual decimal places to amount used in fields * Remove/replace tests with unneeded url_open calls * Rename files, variables for clarity * Clean up demo/test data * [IMP] website_sale_affiliate: Clarify affiliate request name * Add help to name field on affiliate request model

* Handle the case of no web session, which will raise a `RuntimeError('object unbound')` when attempting to access it. This happens during XML record creations, but likely other places such as in the shell

KDRdev · 2026-06-12T09:17:30Z

@pilarvargas-tecnativa I've made changes as per your suggestions, could you please have another look? Thanks!

KDRdev · 2026-06-24T07:21:55Z

@pilarvargas-tecnativa just a friendly reminder for you. Thanks!

OCA-git-bot added series:18.0 mod:website_sale_affiliate Module website_sale_affiliate labels May 29, 2026

jans23 force-pushed the 18.0-mig-website_sale_affiliate branch from 08325cd to 1f5d6ec Compare May 29, 2026 19:40

jans23 force-pushed the 18.0-mig-website_sale_affiliate branch from fe0825f to 3c41315 Compare May 29, 2026 21:40

pilarvargas-tecnativa suggested changes Jun 1, 2026

View reviewed changes

KDRdev force-pushed the 18.0-mig-website_sale_affiliate branch from 26aed71 to cb183c3 Compare June 2, 2026 11:19

pilarvargas-tecnativa suggested changes Jun 2, 2026

View reviewed changes

KDRdev force-pushed the 18.0-mig-website_sale_affiliate branch from cb183c3 to e357fc7 Compare June 10, 2026 15:40

KDRdev force-pushed the 18.0-mig-website_sale_affiliate branch from e357fc7 to c2c9f95 Compare June 11, 2026 13:47

hughesbm and others added 6 commits June 11, 2026 15:51

[FIX] website_sale_affiliate: Handle case of no session

5df5f06

* Handle the case of no web session, which will raise a `RuntimeError('object unbound')` when attempting to access it. This happens during XML record creations, but likely other places such as in the shell

OCA Transbot updated translations from Transifex

32cff00

[UPD] Update website_sale_affiliate.pot

8594e6e

[ADD] icon.png

2b6efd6

[IMP] website_sale_affiliate: pre-commit auto-fixes

e1063b8

KDRdev force-pushed the 18.0-mig-website_sale_affiliate branch 4 times, most recently from a5795f7 to 69a9eac Compare June 12, 2026 06:38

KDRdev added 2 commits June 12, 2026 11:09

[MIG] website_sale_affiliate: migration to 18.0

bcb44fc

[FIX] website_sale_affiliate: fix unit tests

7e7ae03

KDRdev force-pushed the 18.0-mig-website_sale_affiliate branch from 1e2c380 to 7e7ae03 Compare June 12, 2026 09:10


		from odoo.addons.website_sale.controllers.main import WebsiteSale as Base

		_logger = logging.getLogger(__name__)

Uh oh!

Uh oh!

Conversation

jans23 commented May 29, 2026

Uh oh!

jans23 commented May 29, 2026

Uh oh!

jans23 commented May 29, 2026

Uh oh!

pilarvargas-tecnativa left a comment

Choose a reason for hiding this comment

Uh oh!

KDRdev commented Jun 2, 2026

Uh oh!

jans23 commented Jun 2, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

KDRdev Jun 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

KDRdev Jun 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

KDRdev Jun 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

KDRdev Jun 12, 2026 •

edited

Loading

KDRdev Jun 12, 2026 •

edited

Loading

KDRdev Jun 12, 2026 •

edited

Loading