| Availability |
Odoo Online
Odoo.sh
On Premise
|
| Odoo Apps Dependencies |
Discuss (mail)
|
| Community Apps Dependencies | Show |
| Lines of code | 54413 |
| Technical Name |
bk_fast_api_server |
| License | OPL-1 |
| Website | https://bytekol.com |
| Versions | 17.0 18.0 19.0 |
| Availability |
Odoo Online
Odoo.sh
On Premise
|
| Odoo Apps Dependencies |
Discuss (mail)
|
| Community Apps Dependencies | Show |
| Lines of code | 54413 |
| Technical Name |
bk_fast_api_server |
| License | OPL-1 |
| Website | https://bytekol.com |
| Versions | 17.0 18.0 19.0 |
FastAPI Server for Odoo
High-Performance WebSocket for Function History
This module provides a new, high-performance WebSocket implementation for function history real-time notifications using FastAPI instead of Odoo's built-in bus system.
Key Features
- High Performance: Real-time notifications without database commits for each update
- Fast Delivery: Significantly faster than Odoo's bus system, especially for high-frequency updates
- Easy to Use: Automatically replaces Odoo bus when enabled, transparent to existing code
- Backup Mechanism: Logs are backed up to files to prevent data loss on server restart
- Easy Rollback: Can be disabled via system parameter if issues occur
- Backward Compatible: Falls back to Odoo bus if WebSocket is unavailable
Configuration
The feature can be enabled/disabled via system parameter:
bk_fast_api_server.use_fastapi_websocket_for_func_history
Set to
True
(default) to enable FastAPI WebSocket, or
False
to use Odoo bus.
How It Works
When enabled, function history updates are sent via FastAPI WebSocket connections instead of Odoo's bus system. This eliminates the need for database commits on each notification, resulting in much faster real-time updates.
Logs are automatically backed up to temporary files to ensure data persistence even if the server restarts unexpectedly. The backup files are cleaned up automatically when function histories are completed.
Technical Details
The module overrides the following components:
-
function.history._notify_func_history()- Uses FastAPI WebSocket for notifications -
function.history._update_function_history()- Adds backup mechanism -
function_history.js- Uses new WebSocket service -
PublicCheckFuncHistoriesRunningOWL- Uses new WebSocket service
WSS configuration
Example nginx configuration:
server {
listen 80;
server_name example.com;
add_header Strict-Transport-Security max-age=15768000 always;
location / {
return 301 https://$server_name$request_uri;
}
}
server {
listen 443 ssl http2;
server_name example.com;
ssl_certificate ...;
ssl_certificate_key ...;
ssl_protocols TLSv1.2 TLSv1.3;
# ssl config ....
proxy_buffers 16 80k;
proxy_buffer_size 148k;
client_max_body_size 10G;
keepalive_timeout 500s;
proxy_read_timeout 500s;
proxy_set_header Host $host;
location / {
proxy_connect_timeout 10s;
proxy_read_timeout 6h;
proxy_buffering on;
proxy_redirect off;
proxy_intercept_errors on;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection $connection_upgrade;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Proto $scheme;
proxy_pass http://localhost:8069;
}
location /bk_fastapi/ {
proxy_pass http://localhost:7890/;
proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "upgrade";
proxy_set_header Host $host;
proxy_redirect off;
}
}
Odoo Proprietary License v1.0 This software and associated files (the "Software") may only be used (executed, modified, executed after modifications) if you have purchased a valid license from the authors, typically via Odoo Apps, or if you have received a written agreement from the authors of the Software (see the COPYRIGHT file). You may develop Odoo modules that use the Software as a library (typically by depending on it, importing it and using its resources), but without copying any source code or material from the Software. You may distribute those modules under the license of your choice, provided that this license is compatible with the terms of the Odoo Proprietary License (For example: LGPL, MIT, or proprietary licenses similar to this one). It is forbidden to publish, distribute, sublicense, or sell copies of the Software or modified copies of the Software. The above copyright notice and this permission notice must be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Please log in to comment on this module