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

[18.0][mig] endpoint_route_handler #65

Open
wants to merge 51 commits into
base: 18.0
Choose a base branch
from

Conversation

samirGuesmi
Copy link
Member

Bonjour @simahawk, I would like to get your input here.

in Odoo 18: Adds a readonly parameter, allowing routes to use a read-only replica of the database when appropriate. This is beneficial for endpoints that only perform read operations, such as querying records, and it helps to improve performance by reducing the load on the primary database. While the readonly parameter is intended to be optional, test cases encountered failures due to a missing readonly key, as seen in the error:

site-packages/odoo/http.py", line 1888, in _serve_db
readonly = rule.endpoint.routing['readonly']
~~~~~~~~~~~~~~~~~~~~~^^^^^^^^^^^^
KeyError: 'readonly'

simahawk and others added 30 commits October 20, 2024 13:48
When an endpoint is archived it must be dropped.
When it's unarchive it must be restored.
Routing maps are generated **per env**
which means that every new env will have its own routing map
attached to `ir.http` registry class.

This is not desired (as per core Odoo comment)
but it's like this today :/

Hence, before this change, the routing map could be mis-aligned
across different envs leading to random responses for custom endpoints.

This refactoring simplifies a lot the handling of the rules
leaving to std `_generate_routing_rules` the duty to yield rules
and to `routing_map` to generate them for the new route map.

EndpointRegistry memory consumption is improved too
thanks to smaller data to store and to the usage of __slots__.
To avoid multiple invalidation of all envs on each edit or create
of persistent records, a new flag is introduced: 'registry_sync'.

This flag delays the sync of the rule registry till manual action
occurs. Records in the UI are decorated accordingly to notify users of
the need to reflect changes on ther registry to make them effective.

The sync happens in a post commit hook to ensure all values are in place
for the affected records.
Depending on your modules inheritance and upgrade order
when you introduce this mixin on an existing model
it might happen that
gets called before the model's table is ready
(eg: another odoo service loading the env before the upgrade happens).
Let if fail gracefully since the hook will be called again later.
As routes are registered automatically in the db after sync
there's no reason to look for non registered routes at boot.
Furthermore, this is causing access conflicts on the table
when multiple instances w/ multiple workers are spawned.
simahawk and others added 21 commits October 20, 2024 13:48
Currently translated at 100.0% (29 of 29 strings)

Translation: web-api-16.0/web-api-16.0-endpoint_route_handler
Translate-URL: https://translation.odoo-community.org/projects/web-api-16-0/web-api-16-0-endpoint_route_handler/it/
Updated by "Update PO files to match POT (msgmerge)" hook in Weblate.

Translation: web-api-17.0/web-api-17.0-endpoint_route_handler
Translate-URL: https://translation.odoo-community.org/projects/web-api-17-0/web-api-17-0-endpoint_route_handler/
@simahawk
Copy link
Contributor

@samirGuesmi thanks for your work and for the info. I'll have a look in the following days, merci :)

@simahawk simahawk changed the title 18.0 mig endpoint route handler [18.0][mig] endpoint_route_handler Oct 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants