[IMP] bus: enable websocket during tours #189859
Draft
+161
−52
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
|
tsm-odoo
force-pushed
the
master-mail-ws_for_test-tsm
branch
from
f0c3495 to
7772214
Compare
tsm-odoo
force-pushed
the
master-mail-ws_for_test-tsm
branch
25 times, most recently
from
ddc6b7b to
ea69a83
Compare
tsm-odoo
force-pushed
the
master-mail-ws_for_test-tsm
branch
2 times, most recently
from
9dd6c11 to
94fbc8b
Compare
tsm-odoo
force-pushed
the
master-mail-ws_for_test-tsm
branch
12 times, most recently
from
8f1a17f to
a5f7d5d
Compare
tsm-odoo
force-pushed
the
master-mail-ws_for_test-tsm
branch
3 times, most recently
from
f734131 to
9c92bce
Compare
tsm-odoo
force-pushed
the
master-mail-ws_for_test-tsm
branch
3 times, most recently
from
383e04e to
97144da
Compare
Julien00859
reviewed
Jan 14, 2025
tsm-odoo
force-pushed
the
master-mail-ws_for_test-tsm
branch
3 times, most recently
from
df40c3a to
aa3fa7e
Compare
Julien00859
reviewed
Jan 14, 2025
tsm-odoo
force-pushed
the
master-mail-ws_for_test-tsm
branch
2 times, most recently
from
e09df52 to
0f03647
Compare
Julien00859
approved these changes
Jan 14, 2025
There was a problem hiding this comment.
Reviewed websocket and python bus code.
disconnect() was a public API and was called from other threads, that method was directly writing on the underlying buffer. This can cause a serialization problem if the websocket (or other threads calling disconnect()) are writing on the socket at the same time.
The solution to that problem, implemented in the new close method: instead of writing directly on the buffer, it writes on a thread-safe queue which is consumed by the websocket thread to write on the socket. So there is only ever the websocket thread that writes on the socket, eliminating serialization errors.
There are critical sections around the usages of the _waiting_for_dispatch boolean. We made sure that "at worst" it would force the websocket to poll the bus one more time, than to loose some notifications.
I am not too sure about the precommit.call() and postcommit.call() inside the browser_js() method.
Previously, a socketpair was used to wake up the WebSocket event loop for notifications. This method is too restrictive, as it doesn't allow communication with the event loop in other scenarios. For example, the disconnect method is not thread-safe and should only be used in the WebSocket thread. However, situations like server shutdown or test cleanup require closing WebSockets from outside the event loop thread. This PR enhances communication with the WebSocket event loop: - The `socketpair` is replaced by a pollable queue that allows controlling the WebSocket instances from outside of the event loop. - Two control commands are available for now: `CLOSE` and `DISPATCH`. This approach allows for the future addition of more commands. - The `disconnect` method is removed from the public API: This method is not thread-safe and should only be called from internal code running in the WebSocket thread. - Expose the `close` method to the public API, which relies on the command queue to properly order disconnections from outside the WebSocket thread. task-3970199
This PR adapts the `Websocket` and `HttpCase` classes to enable WebSockets during tours. Modules such as point of sale or discuss cannot be properly tested without the bus. task-3970199
Enabling WebSockets during tour highlighted issues with some tours. This PR corrects those tours. task-3970199
tsm-odoo
force-pushed
the
master-mail-ws_for_test-tsm
branch
from
0f03647 to
ba18006
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR aims to enable WebSocket functionality during tours. Applications that rely heavily on the bus, such as Discuss or POS, require the bus connection to be active to write relevant tests.
1. Allow to close websockets from outside of the event loop
Previously, a socketpair was used to wake up the WebSocket event loop for notifications. This method is too restrictive, as it doesn't allow communication with the event loop in other scenarios. For example, the disconnect method is not thread-safe and should only be used in the WebSocket thread. However, situations like server shutdown or test
cleanup require closing WebSockets from outside the event loop thread.
This PR enhances communication with the WebSocket event loop:
socketpairis replaced by a pollable queue that allows controlling the WebSocket instances from outside of the event loop.CLOSEandDISPATCH. This approach allows for the future addition of more commands.disconnectmethod is removed from the public API: This method is not thread-safe and should only be called from internal code running in the WebSocket thread.closemethod to the public API, which relies on the command queue to properly order disconnections from outside the WebSocket thread.2. Enable WebSocket during tours
During Python tests, only one cursor is used. RPCs and WebSocket use the
TestCursorwrapper, which relies on a lock to prevent race conditions. WebSocket connections can be opened during tours, provided they are properly cleaned up afterward to avoid conflicts with the test cursor, which is not subject to any locking.This PR adapts the
WebsocketandHttpCaseclasses to enable WebSockets during tours.enterprise: https://github.com/odoo/enterprise/pull/75984