19.0 mig component #508

Sanazzzmi · 2025-10-11T17:52:26Z

In Odoo 19, the context has become read-only, so we had to modify the tests to handle the read-only behavior of the context.

The favorite lookup should be by 'usage' (kinda interface) and by model name ('components()' method). The lookup by component name should normally not be used as it reduces the flexibility. Using a different method for this lookup discourage its usage. Also, the lookup by component name completely ignores the current collection, which is bad or not bad depending of what you want to achieve.

when inheriting from multiple components, we might inadvertly override a value with None

Used for instance by the 'ecommerce' components

The mapping methods are now built by the component initialization when the "aggregated" class is built.

And remove automatic naming from class name, not explicit enough, especially when we have to inherit from one. We could take the total opposite and only use class names components: class MyComponent(Component): ... class MyComponentExtended(Component): _inherit = 'MyComponent' But it would be less close to the odoo's API.

============================================================================================================= test session starts ============================================================================================================= platform linux2 -- Python 2.7.9, pytest-3.0.7, py-1.4.33, pluggy-0.4.0 run-last-failure: run all (no recorded failures) rootdir: /opt/odoo, inifile: plugins: cov-2.5.1, odoo-0.2.2 collected 25 items odoo/external-src/connector/component/tests/test_build_component.py ......... odoo/external-src/connector/component/tests/test_component.py ........ odoo/external-src/connector/component/tests/test_lookup.py ...... odoo/external-src/connector/component/tests/test_work_on.py .. ---------- coverage: platform linux2, python 2.7.9-final-0 ----------- Name Stmts Miss Cover ----------------------------------------------------------------------------------------- odoo/external-src/connector/component/__init__.py 4 0 100% odoo/external-src/connector/component/__manifest__.py 1 1 0% odoo/external-src/connector/component/base_components.py 3 0 100% odoo/external-src/connector/component/builder.py 18 0 100% odoo/external-src/connector/component/core.py 155 6 96% odoo/external-src/connector/component/exception.py 3 0 100% odoo/external-src/connector/component/models/__init__.py 1 0 100% odoo/external-src/connector/component/models/collection.py 8 0 100% odoo/external-src/connector/component/tests/__init__.py 4 0 100% odoo/external-src/connector/component/tests/common.py 26 2 92% odoo/external-src/connector/component/tests/test_build_component.py 102 0 100% odoo/external-src/connector/component/tests/test_component.py 56 0 100% odoo/external-src/connector/component/tests/test_lookup.py 84 0 100% odoo/external-src/connector/component/tests/test_work_on.py 26 0 100% ----------------------------------------------------------------------------------------- TOTAL 491 9 98% ========================================================================================================== 25 passed in 0.76 seconds ==========================================================================================================

the 'components' method had 2 different return types depending of the 'multi' argument. Now we have 'component' or 'many_components' that return a Component instance or a list of Component instances.

Proposing a new API based on components for the events

Because they can have different addons

* Move the methods to get components from the components to the WorkContext, it should really be its responsibilities to get them. There are shorcuts on the components though. My first implementation was like that, then I moved the lookup methods on the components thinking that it would allow to customize them. But if we did that, we would have a different behavior from component to component which is bad, so if one really wanted to do that, better have to work with a different subclass of WorkContext, which would have its own behavior, consistently throughout all the work session. * Allow to switch the collection using work_on(), not only the model_name

Tests using odoo transactions must run post install, because during the install the registry is not ready, so the components aren't neither.

For consistency, this is where components should go (as for models, views, ...)

Checking that the odoo registry is ready is not working: in tests, the events are not working because they are run just before the odoo registry is set to ready.

(might be empty for EventWorkContext)

It allows to open/close objects on start/end of a synchro / work session. The base method does none of that, but this is a really common use case. Example: at the beginning of the work session, I open a webservice client that is available in our WorkContext for the duration of our work. At the end, I close the client to end the connection.

…ule is loaded with test-enable=True, the components of this module are not registerd by the call to the method _register_hook of the component.builder. Indeed the state of the module is still *to install*. This change allows to call the method *load_components* on the component.builder for a specific module by taking care to not reload the components of a module already loaded.

@lmignon

It the previous commit, @lmignon added the possibility to load all components of an addon in a Component Registry. This commit takes benefit of this feature to simplify the existing tests and to add a base test case for the Connector (that loads all components of 'component', 'component_event', 'connector'). It can be used in implementations using the connector.

This method can be used to filter out some components. It is executed on every candidate component returned by a lookup for a collection/usage/model so must be kept light to execute if possible. A use case can be for instance to have more than one kind of export in a connector for a model. Say that you have a different way to export customers and suppliers: with self.work_on('res.partner', kind='customer') as work: exporter = work.component(usage='record.exporter) exporter.run() with self.work_on('res.partner', kind='supplier') as work: exporter = work.component(usage='record.exporter) exporter.run() You can declare your components as: class CustomerExporter(Component): _name = 'customer.exporter' _inherit = ['base.exporter'] _usage = 'record.exporter' _apply_on = ['res.partner'] @classmethod def _component_match(cls, work): return work.kind == 'customer' def run(self): # export customer class SupplierExporter(Component): _name = 'supplier.exporter' _inherit = ['base.exporter'] _usage = 'record.exporter' _apply_on = ['res.partner'] @classmethod def _component_match(cls, work): return work.kind == 'supplier' def run(self): # export supplier

When we want to test the implementation of a connector, it must be simple. Add 2 new test cases for TransactionCase and SavepointCase which load all the components of the dependencies addons on the tested addons. Only the components of the addons in state 'installed' are loaded, so we don't load components of addons that depend on the tested addon. The tests must call _init_global_registry and build_registry instead of _register_hook, so the registry is not set to ready. If the global registry is set to ready during tests, the event will trigger during the installation of addons which is not what we want. The existing test case is meant only to be used when one has to manipulate components in a custom registry. See discussion on guewen@447b22f#commitcomment-22851711

Handy function to allow depending modules to check for registry readyness w/o exposing internals.

Contributing and maitaining since a while... ;)

Currently translated at 100.0% (2 of 2 strings) Translation: connector-16.0/connector-16.0-component Translate-URL: https://translation.odoo-community.org/projects/connector-16-0/connector-16-0-component/es/

Before this fix, tests could hang forever as the new test suite runner could not close tests suites using a ComponentRegistryCase

Currently translated at 100.0% (2 of 2 strings) Translation: connector-17.0/connector-17.0-component Translate-URL: https://translation.odoo-community.org/projects/connector-17-0/connector-17-0-component/it/

Updated by "Update PO files to match POT (msgmerge)" hook in Weblate. Translation: connector-18.0/connector-18.0-component Translate-URL: https://translation.odoo-community.org/projects/connector-18-0/connector-18-0-component/

fardinmardani

I tested this code and it works correctly — I ran it myself.

kamyar2099

code tested

adelghaedi

The code has been tested and works correctly.
Thank you!

Sanazzzmi · 2025-10-12T07:17:18Z

@OCA-git-bot
@guewen
Please confirm. Thank you.

Sanazzzmi · 2025-10-13T09:36:26Z

@OCA-git-bot
@guewen

Please confirm so we can update other modules.

oerp-odoo · 2025-10-22T06:37:29Z

any update on this? Would be nice to merge it.

mkoeck

Hi, I think there are two more places, where the context is replaced in the old way which will fail due to the context being read only.

mkoeck · 2025-11-26T21:26:07Z

component/tests/common.py

+            current_addon = _get_addon_name(cls.__module__)
+            env["component.builder"].load_components(current_addon)
+            if hasattr(cls, "env"):
+                cls.env.context = dict(


I think here the context is still replaced in the old way which will fail, because the context is readonly

mkoeck · 2025-11-26T21:27:13Z

component/tests/common.py

+        common.TransactionCase.setUp(self)
+        ComponentMixin.setUp(self)
+        # There's no env on setUpClass of TransactionCase, must do it here.
+        self.env.context = dict(


I think here the context is still replaced in the old way which will fail, because the context is readonly

Guewen Baconnier and others added 30 commits October 11, 2025 18:50

Extract 'components' into an individual addon

5bfbb47

Add test_component

1fed850

Various fixes in component

c695668

Add AbstractComponent

013455e

Remove overrides of attributes

19fa6d9

when inheriting from multiple components, we might inadvertly override a value with None

Allow to share some components across collections

4c306e5

Used for instance by the 'ecommerce' components

Instanciate the component returned by name

83a9972

Get rid of MetaMapper

01bd871

The mapping methods are now built by the component initialization when the "aggregated" class is built.

Fix pep8

7aad830

Use 2 different methods for single/many lookup

714c7c6

the 'components' method had 2 different return types depending of the 'multi' argument. Now we have 'component' or 'many_components' that return a Component instance or a list of Component instances.

Document component

7ea9953

Fix error messages

d2e8d95

Update documentation

15d4e7f

Draft new component_event addon

ffa64f0

Proposing a new API based on components for the events

Hold a component registry per database

f9425db

Because they can have different addons

Add a cache on the components lookups

8e55fce

Continue the migration guide

2df9400

Fix test: post_install

d490c4b

Tests using odoo transactions must run post install, because during the install the registry is not ready, so the components aren't neither.

Move base component in a components directory

7ab88f8

For consistency, this is where components should go (as for models, views, ...)

Check that component registry is ready for events

df912b6

Checking that the odoo registry is ready is not working: in tests, the events are not working because they are run just before the odoo registry is set to ready.

Use self.work.env, in case self.collection is empty

edc0106

(might be empty for EventWorkContext)

simahawk and others added 17 commits October 11, 2025 18:50

component: add is_component_registry_ready

94f84cc

Handy function to allow depending modules to check for registry readyness w/o exposing internals.

component: update contributors

b4f0ad4

Contributing and maitaining since a while... ;)

[UPD] README.rst

ba53fe8

component 16.0.1.1.0

1eb5ac5

Translated using Weblate (Spanish)

b96a0b0

Currently translated at 100.0% (2 of 2 strings) Translation: connector-16.0/connector-16.0-component Translate-URL: https://translation.odoo-community.org/projects/connector-16-0/connector-16-0-component/es/

component: fix ComponentRegistryCase + TransactionComponentRegistryCase

11922dc

Before this fix, tests could hang forever as the new test suite runner could not close tests suites using a ComponentRegistryCase

component 16.0.1.1.1

0f3e636

[UPD] README.rst

5c65a97

[IMP] component: pre-commit auto fixes

36765a0

[MIG] component: Migration to 17.0

a37c0ce

[UPD] Update component.pot

ba655f4

[BOT] post-merge updates

838a4ed

Translated using Weblate (Italian)

a77cee7

Currently translated at 100.0% (2 of 2 strings) Translation: connector-17.0/connector-17.0-component Translate-URL: https://translation.odoo-community.org/projects/connector-17-0/connector-17-0-component/it/

[MIG] component: Migration to 18.0

9945306

[UPD] Update component.pot

13ad653

[BOT] post-merge updates

d9c5a06

Update translation files

eb20623

Updated by "Update PO files to match POT (msgmerge)" hook in Weblate. Translation: connector-18.0/connector-18.0-component Translate-URL: https://translation.odoo-community.org/projects/connector-18-0/connector-18-0-component/

fardinmardani approved these changes Oct 12, 2025

View reviewed changes

kamyar2099 approved these changes Oct 12, 2025

View reviewed changes

OCA-git-bot added the approved label Oct 12, 2025

adelghaedi approved these changes Oct 12, 2025

View reviewed changes

Sanazzzmi force-pushed the 19.0-mig-component branch 2 times, most recently from 23a5289 to 8f32cac Compare October 12, 2025 07:08

[MIG] component: Migration to 19.0

d5707aa

Sanazzzmi force-pushed the 19.0-mig-component branch from 8f32cac to d5707aa Compare October 12, 2025 07:10

mkoeck suggested changes Nov 26, 2025

View reviewed changes

OCA-git-bot removed the approved label Nov 26, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

19.0 mig component #508

19.0 mig component #508

Uh oh!

Sanazzzmi commented Oct 11, 2025

Uh oh!

fardinmardani left a comment

Uh oh!

kamyar2099 left a comment

Uh oh!

adelghaedi left a comment

Uh oh!

Sanazzzmi commented Oct 12, 2025

Uh oh!

Sanazzzmi commented Oct 13, 2025

Uh oh!

oerp-odoo commented Oct 22, 2025

Uh oh!

mkoeck left a comment

Uh oh!

mkoeck Nov 26, 2025

Uh oh!

mkoeck Nov 26, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

20 participants

Uh oh!

19.0 mig component #508

Are you sure you want to change the base?

19.0 mig component #508

Uh oh!

Conversation

Sanazzzmi commented Oct 11, 2025

Uh oh!

fardinmardani left a comment

Choose a reason for hiding this comment

Uh oh!

kamyar2099 left a comment

Choose a reason for hiding this comment

Uh oh!

adelghaedi left a comment

Choose a reason for hiding this comment

Uh oh!

Sanazzzmi commented Oct 12, 2025

Uh oh!

Sanazzzmi commented Oct 13, 2025

Uh oh!

oerp-odoo commented Oct 22, 2025

Uh oh!

mkoeck left a comment

Choose a reason for hiding this comment

Uh oh!

mkoeck Nov 26, 2025

Choose a reason for hiding this comment

Uh oh!

mkoeck Nov 26, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

20 participants