Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[17.0][MIG] component_event: Migration to 17.0 #475

Merged
merged 75 commits into from
Dec 9, 2023

Conversation

nguyenminhchien
Copy link

@nguyenminhchien nguyenminhchien commented Nov 24, 2023

@nguyenminhchien nguyenminhchien force-pushed the 17.0-mig-component_event branch 3 times, most recently from 67f003f to 20fca31 Compare November 24, 2023 03:52
@nguyenminhchien nguyenminhchien marked this pull request as ready for review November 24, 2023 03:55
@simahawk
Copy link
Contributor

/ocabot migration component_event

@OCA-git-bot OCA-git-bot added this to the 17.0 milestone Nov 27, 2023
Copy link
Contributor

@simahawk simahawk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LG

@gurneyalex
Copy link
Member

@nguyenminhchien I'm merging #474 -> you should be able to rebase and remove the unreleased dependency, and then I'll merge this one.

guewen and others added 19 commits December 8, 2023 14:40
Proposing a new API based on components for the events
Because they can have different addons
So we don't need to iterate on the listeners to find the events each
time the event is triggered.

* rename producer -> collecter, which is more accurate regarding what it does
* rename the trigger function 'fire' -> 'notify', just a matter of
  preference here :)
* add a CollectedEvents class so we don't modify the state of the
collecter and we don't mix responsibilities
* Add documentation
* Add a few more test cases
* Prevent using component lookup methods from an EventWorkContext when
  there is no collection, but allow to switch to a WorkContext with
  collection
* Increase cache size (should be measured at some point...)
* Fix a few issues with collection being an empty model being False-ish,
  so added comparisons with None
* Add abstract Component with the base events (on_record_create,
  on_record_write, on_record_unlink)
We return an empty list of events so nothing is triggered
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.
I'm not sure it is good actually. If you inherit from it for only one of
the method, the other methods will listen be executed for doing nothing,
but that's still a useless call of method...
It's not really usable: if we inherit from it and implement only one
method, the others will be called without effect, waste of resources
It takes a condition which skip the event when evaluated to True.
A new base listener for the connector adds a default condition based on
self.env.context.get('connector_no_export'). Every export event listener
should be decorated with:

    @skip_if(lambda self, *args, **kwargs: self.no_connector_export)
Otherwise we can't read the record
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.
It is unused, and depends on the model on which we call it
The cache entries for events were including instance of the components,
hence, they included the work instance / odoo environment.

Only the component class and the events it provides are new cached, the
instances of components being instanciated when needed.

Reported on:
OCA/connector-magento#255 (comment)
* Document the events that have already been implemented to BaseModel
@nguyenminhchien nguyenminhchien force-pushed the 17.0-mig-component_event branch from 20fca31 to 4f7836d Compare December 8, 2023 07:40
@nguyenminhchien
Copy link
Author

nguyenminhchien commented Dec 8, 2023

@nguyenminhchien I'm merging #474 -> you should be able to rebase and remove the unreleased dependency, and then I'll merge this one.

@gurneyalex i have rebase, thanks.

@gurneyalex
Copy link
Member

/ocabot merge nobump

@OCA-git-bot
Copy link
Contributor

What a great day to merge this nice PR. Let's do it!
Prepared branch 17.0-ocabot-merge-pr-475-by-gurneyalex-bump-nobump, awaiting test results.

@OCA-git-bot OCA-git-bot merged commit ee71986 into OCA:17.0 Dec 9, 2023
4 of 6 checks passed
@OCA-git-bot
Copy link
Contributor

Congratulations, your PR was merged at 100e651. Thanks a lot for contributing to OCA. ❤️

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.