mirror of
https://github.com/bringout/oca-technical.git
synced 2026-04-18 10:52:03 +02:00
Initial commit: OCA Technical packages (595 packages)
This commit is contained in:
Ernad Husremovic
commit
2cc02aac6e
24950 changed files with 2318079 additions and 0 deletions
|
|
@ -0,0 +1,93 @@
|
|||
====================
|
||||
Store sessions in DB
|
||||
====================
|
||||
|
||||
..
|
||||
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||||
!! This file is generated by oca-gen-addon-readme !!
|
||||
!! changes will be overwritten. !!
|
||||
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||||
!! source digest: sha256:59a43b0f19a6177d8866b3524a34ec9f9b380f29765d4d9647254dba9248b2f1
|
||||
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||||
|
||||
.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
|
||||
:target: https://odoo-community.org/page/development-status
|
||||
:alt: Beta
|
||||
.. |badge2| image:: https://img.shields.io/badge/licence-LGPL--3-blue.png
|
||||
:target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html
|
||||
:alt: License: LGPL-3
|
||||
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--tools-lightgray.png?logo=github
|
||||
:target: https://github.com/OCA/server-tools/tree/16.0/session_db
|
||||
:alt: OCA/server-tools
|
||||
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
|
||||
:target: https://translation.odoo-community.org/projects/server-tools-16-0/server-tools-16-0-session_db
|
||||
:alt: Translate me on Weblate
|
||||
.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
|
||||
:target: https://runboat.odoo-community.org/builds?repo=OCA/server-tools&target_branch=16.0
|
||||
:alt: Try me on Runboat
|
||||
|
||||
|badge1| |badge2| |badge3| |badge4| |badge5|
|
||||
|
||||
Store sessions in a database instead of the filesystem. This simplifies the
|
||||
configuration of horizontally scalable deployments, by avoiding the need for a
|
||||
distributed filesystem to store the Odoo sessions.
|
||||
|
||||
**Table of contents**
|
||||
|
||||
.. contents::
|
||||
:local:
|
||||
|
||||
Usage
|
||||
=====
|
||||
|
||||
Set this module in the server wide modules.
|
||||
|
||||
Set a ``SESSION_DB_URI`` environment variable as a full postgresql connection string,
|
||||
like ``postgres://user:passwd@server/db`` or ``db``.
|
||||
|
||||
It is recommended to use a dedicated database for this module, and possibly a dedicated
|
||||
postgres user for additional security.
|
||||
|
||||
Bug Tracker
|
||||
===========
|
||||
|
||||
Bugs are tracked on `GitHub Issues <https://github.com/OCA/server-tools/issues>`_.
|
||||
In case of trouble, please check there if your issue has already been reported.
|
||||
If you spotted it first, help us to smash it by providing a detailed and welcomed
|
||||
`feedback <https://github.com/OCA/server-tools/issues/new?body=module:%20session_db%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
|
||||
|
||||
Do not contact contributors directly about support or help with technical issues.
|
||||
|
||||
Credits
|
||||
=======
|
||||
|
||||
Authors
|
||||
~~~~~~~
|
||||
|
||||
* Odoo SA
|
||||
* ACSONE SA/NV
|
||||
|
||||
Maintainers
|
||||
~~~~~~~~~~~
|
||||
|
||||
This module is maintained by the OCA.
|
||||
|
||||
.. image:: https://odoo-community.org/logo.png
|
||||
:alt: Odoo Community Association
|
||||
:target: https://odoo-community.org
|
||||
|
||||
OCA, or the Odoo Community Association, is a nonprofit organization whose
|
||||
mission is to support the collaborative development of Odoo features and
|
||||
promote its widespread use.
|
||||
|
||||
.. |maintainer-sbidoul| image:: https://github.com/sbidoul.png?size=40px
|
||||
:target: https://github.com/sbidoul
|
||||
:alt: sbidoul
|
||||
|
||||
Current `maintainer <https://odoo-community.org/page/maintainer-role>`__:
|
||||
|
||||
|maintainer-sbidoul|
|
||||
|
||||
This module is part of the `OCA/server-tools <https://github.com/OCA/server-tools/tree/16.0/session_db>`_ project on GitHub.
|
||||
|
||||
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
|
||||
|
|
@ -0,0 +1 @@
|
|||
from . import pg_session_store
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
{
|
||||
"name": "Store sessions in DB",
|
||||
"version": "16.0.1.0.7",
|
||||
"author": "Odoo SA,ACSONE SA/NV,Odoo Community Association (OCA)",
|
||||
"license": "LGPL-3",
|
||||
"website": "https://github.com/OCA/server-tools",
|
||||
"maintainers": ["sbidoul"],
|
||||
}
|
||||
|
|
@ -0,0 +1,14 @@
|
|||
# Translation of Odoo Server.
|
||||
# This file contains the translation of the following modules:
|
||||
#
|
||||
msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: Odoo Server 16.0\n"
|
||||
"Report-Msgid-Bugs-To: \n"
|
||||
"Last-Translator: Automatically generated\n"
|
||||
"Language-Team: none\n"
|
||||
"Language: it\n"
|
||||
"MIME-Version: 1.0\n"
|
||||
"Content-Type: text/plain; charset=UTF-8\n"
|
||||
"Content-Transfer-Encoding: \n"
|
||||
"Plural-Forms: nplurals=2; plural=n != 1;\n"
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
# Translation of Odoo Server.
|
||||
# This file contains the translation of the following modules:
|
||||
#
|
||||
msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: Odoo Server 16.0\n"
|
||||
"Report-Msgid-Bugs-To: \n"
|
||||
"Last-Translator: \n"
|
||||
"Language-Team: \n"
|
||||
"MIME-Version: 1.0\n"
|
||||
"Content-Type: text/plain; charset=UTF-8\n"
|
||||
"Content-Transfer-Encoding: \n"
|
||||
"Plural-Forms: \n"
|
||||
|
|
@ -0,0 +1,169 @@
|
|||
# Copyright (c) Odoo SA 2017
|
||||
# @author Nicolas Seinlet
|
||||
# Copyright (c) ACSONE SA 2022
|
||||
# @author Stéphane Bidoul
|
||||
import json
|
||||
import logging
|
||||
import os
|
||||
|
||||
import psycopg2
|
||||
|
||||
import odoo
|
||||
from odoo import http
|
||||
from odoo.tools._vendor import sessions
|
||||
from odoo.tools.func import lazy_property
|
||||
|
||||
_logger = logging.getLogger(__name__)
|
||||
|
||||
lock = None
|
||||
if odoo.evented:
|
||||
import gevent.lock
|
||||
|
||||
lock = gevent.lock.RLock()
|
||||
elif odoo.tools.config["workers"] == 0:
|
||||
import threading
|
||||
|
||||
lock = threading.RLock()
|
||||
|
||||
|
||||
def with_lock(func):
|
||||
def wrapper(*args, **kwargs):
|
||||
try:
|
||||
if lock is not None:
|
||||
lock.acquire()
|
||||
return func(*args, **kwargs)
|
||||
finally:
|
||||
if lock is not None:
|
||||
lock.release()
|
||||
|
||||
return wrapper
|
||||
|
||||
|
||||
def with_cursor(func):
|
||||
def wrapper(self, *args, **kwargs):
|
||||
tries = 0
|
||||
while True:
|
||||
tries += 1
|
||||
try:
|
||||
self._ensure_connection()
|
||||
return func(self, *args, **kwargs)
|
||||
except (psycopg2.InterfaceError, psycopg2.OperationalError):
|
||||
self._close_connection()
|
||||
if tries > 4:
|
||||
_logger.warning(
|
||||
"session_db operation try %s/5 failed, aborting", tries
|
||||
)
|
||||
raise
|
||||
_logger.info("session_db operation try %s/5 failed, retrying", tries)
|
||||
|
||||
return wrapper
|
||||
|
||||
|
||||
class PGSessionStore(sessions.SessionStore):
|
||||
def __init__(self, uri, session_class=None):
|
||||
super().__init__(session_class)
|
||||
self._uri = uri
|
||||
self._cr = None
|
||||
self._open_connection()
|
||||
self._setup_db()
|
||||
|
||||
def __del__(self):
|
||||
self._close_connection()
|
||||
|
||||
@with_lock
|
||||
def _ensure_connection(self):
|
||||
if self._cr is None:
|
||||
self._open_connection()
|
||||
|
||||
@with_lock
|
||||
def _open_connection(self):
|
||||
self._close_connection()
|
||||
cnx = odoo.sql_db.db_connect(self._uri, allow_uri=True)
|
||||
self._cr = cnx.cursor()
|
||||
self._cr._cnx.autocommit = True
|
||||
|
||||
@with_lock
|
||||
def _close_connection(self):
|
||||
"""Return cursor to the pool."""
|
||||
if self._cr is not None:
|
||||
try:
|
||||
self._cr.close()
|
||||
except Exception: # pylint: disable=except-pass
|
||||
pass
|
||||
self._cr = None
|
||||
|
||||
@with_lock
|
||||
@with_cursor
|
||||
def _setup_db(self):
|
||||
self._cr.execute(
|
||||
"""
|
||||
CREATE TABLE IF NOT EXISTS http_sessions (
|
||||
sid varchar PRIMARY KEY,
|
||||
write_date timestamp without time zone NOT NULL,
|
||||
payload text NOT NULL
|
||||
)
|
||||
"""
|
||||
)
|
||||
|
||||
@with_lock
|
||||
@with_cursor
|
||||
def save(self, session):
|
||||
payload = json.dumps(dict(session))
|
||||
self._cr.execute(
|
||||
"""
|
||||
INSERT INTO http_sessions(sid, write_date, payload)
|
||||
VALUES (%(sid)s, now() at time zone 'UTC', %(payload)s)
|
||||
ON CONFLICT (sid)
|
||||
DO UPDATE SET payload = %(payload)s,
|
||||
write_date = now() at time zone 'UTC'
|
||||
""",
|
||||
dict(sid=session.sid, payload=payload),
|
||||
)
|
||||
|
||||
@with_lock
|
||||
@with_cursor
|
||||
def delete(self, session):
|
||||
self._cr.execute("DELETE FROM http_sessions WHERE sid=%s", (session.sid,))
|
||||
|
||||
@with_lock
|
||||
@with_cursor
|
||||
def get(self, sid):
|
||||
self._cr.execute("SELECT payload FROM http_sessions WHERE sid=%s", (sid,))
|
||||
try:
|
||||
data = json.loads(self._cr.fetchone()[0])
|
||||
except Exception:
|
||||
return self.new()
|
||||
|
||||
return self.session_class(data, sid, False)
|
||||
|
||||
# This method is not part of the Session interface but is called nevertheless,
|
||||
# so let's get it from FilesystemSessionStore.
|
||||
rotate = http.FilesystemSessionStore.rotate
|
||||
|
||||
@with_lock
|
||||
@with_cursor
|
||||
def vacuum(self, max_lifetime=http.SESSION_LIFETIME):
|
||||
self._cr.execute(
|
||||
"DELETE FROM http_sessions "
|
||||
"WHERE now() at time zone 'UTC' - write_date > %s",
|
||||
(f"{max_lifetime} seconds",),
|
||||
)
|
||||
|
||||
|
||||
_original_session_store = http.root.__class__.session_store
|
||||
|
||||
|
||||
@lazy_property
|
||||
def session_store(self):
|
||||
session_db_uri = os.environ.get("SESSION_DB_URI")
|
||||
if session_db_uri:
|
||||
_logger.debug("HTTP sessions stored in: db")
|
||||
return PGSessionStore(session_db_uri, session_class=http.Session)
|
||||
return _original_session_store.__get__(self, self.__class__)
|
||||
|
||||
|
||||
# Monkey patch of standard methods
|
||||
_logger.debug("Monkey patching session store")
|
||||
http.root.__class__.session_store = session_store
|
||||
# Reset the lazy property cache
|
||||
vars(http.root).pop("session_store", None)
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
Store sessions in a database instead of the filesystem. This simplifies the
|
||||
configuration of horizontally scalable deployments, by avoiding the need for a
|
||||
distributed filesystem to store the Odoo sessions.
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
Set this module in the server wide modules.
|
||||
|
||||
Set a ``SESSION_DB_URI`` environment variable as a full postgresql connection string,
|
||||
like ``postgres://user:passwd@server/db`` or ``db``.
|
||||
|
||||
It is recommended to use a dedicated database for this module, and possibly a dedicated
|
||||
postgres user for additional security.
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 9.2 KiB |
|
|
@ -0,0 +1,430 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta name="generator" content="Docutils: https://docutils.sourceforge.io/" />
|
||||
<title>Store sessions in DB</title>
|
||||
<style type="text/css">
|
||||
|
||||
/*
|
||||
:Author: David Goodger (goodger@python.org)
|
||||
:Id: $Id: html4css1.css 9511 2024-01-13 09:50:07Z milde $
|
||||
:Copyright: This stylesheet has been placed in the public domain.
|
||||
|
||||
Default cascading style sheet for the HTML output of Docutils.
|
||||
Despite the name, some widely supported CSS2 features are used.
|
||||
|
||||
See https://docutils.sourceforge.io/docs/howto/html-stylesheets.html for how to
|
||||
customize this style sheet.
|
||||
*/
|
||||
|
||||
/* used to remove borders from tables and images */
|
||||
.borderless, table.borderless td, table.borderless th {
|
||||
border: 0 }
|
||||
|
||||
table.borderless td, table.borderless th {
|
||||
/* Override padding for "table.docutils td" with "! important".
|
||||
The right padding separates the table cells. */
|
||||
padding: 0 0.5em 0 0 ! important }
|
||||
|
||||
.first {
|
||||
/* Override more specific margin styles with "! important". */
|
||||
margin-top: 0 ! important }
|
||||
|
||||
.last, .with-subtitle {
|
||||
margin-bottom: 0 ! important }
|
||||
|
||||
.hidden {
|
||||
display: none }
|
||||
|
||||
.subscript {
|
||||
vertical-align: sub;
|
||||
font-size: smaller }
|
||||
|
||||
.superscript {
|
||||
vertical-align: super;
|
||||
font-size: smaller }
|
||||
|
||||
a.toc-backref {
|
||||
text-decoration: none ;
|
||||
color: black }
|
||||
|
||||
blockquote.epigraph {
|
||||
margin: 2em 5em ; }
|
||||
|
||||
dl.docutils dd {
|
||||
margin-bottom: 0.5em }
|
||||
|
||||
object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
|
||||
overflow: hidden;
|
||||
}
|
||||
|
||||
/* Uncomment (and remove this text!) to get bold-faced definition list terms
|
||||
dl.docutils dt {
|
||||
font-weight: bold }
|
||||
*/
|
||||
|
||||
div.abstract {
|
||||
margin: 2em 5em }
|
||||
|
||||
div.abstract p.topic-title {
|
||||
font-weight: bold ;
|
||||
text-align: center }
|
||||
|
||||
div.admonition, div.attention, div.caution, div.danger, div.error,
|
||||
div.hint, div.important, div.note, div.tip, div.warning {
|
||||
margin: 2em ;
|
||||
border: medium outset ;
|
||||
padding: 1em }
|
||||
|
||||
div.admonition p.admonition-title, div.hint p.admonition-title,
|
||||
div.important p.admonition-title, div.note p.admonition-title,
|
||||
div.tip p.admonition-title {
|
||||
font-weight: bold ;
|
||||
font-family: sans-serif }
|
||||
|
||||
div.attention p.admonition-title, div.caution p.admonition-title,
|
||||
div.danger p.admonition-title, div.error p.admonition-title,
|
||||
div.warning p.admonition-title, .code .error {
|
||||
color: red ;
|
||||
font-weight: bold ;
|
||||
font-family: sans-serif }
|
||||
|
||||
/* Uncomment (and remove this text!) to get reduced vertical space in
|
||||
compound paragraphs.
|
||||
div.compound .compound-first, div.compound .compound-middle {
|
||||
margin-bottom: 0.5em }
|
||||
|
||||
div.compound .compound-last, div.compound .compound-middle {
|
||||
margin-top: 0.5em }
|
||||
*/
|
||||
|
||||
div.dedication {
|
||||
margin: 2em 5em ;
|
||||
text-align: center ;
|
||||
font-style: italic }
|
||||
|
||||
div.dedication p.topic-title {
|
||||
font-weight: bold ;
|
||||
font-style: normal }
|
||||
|
||||
div.figure {
|
||||
margin-left: 2em ;
|
||||
margin-right: 2em }
|
||||
|
||||
div.footer, div.header {
|
||||
clear: both;
|
||||
font-size: smaller }
|
||||
|
||||
div.line-block {
|
||||
display: block ;
|
||||
margin-top: 1em ;
|
||||
margin-bottom: 1em }
|
||||
|
||||
div.line-block div.line-block {
|
||||
margin-top: 0 ;
|
||||
margin-bottom: 0 ;
|
||||
margin-left: 1.5em }
|
||||
|
||||
div.sidebar {
|
||||
margin: 0 0 0.5em 1em ;
|
||||
border: medium outset ;
|
||||
padding: 1em ;
|
||||
background-color: #ffffee ;
|
||||
width: 40% ;
|
||||
float: right ;
|
||||
clear: right }
|
||||
|
||||
div.sidebar p.rubric {
|
||||
font-family: sans-serif ;
|
||||
font-size: medium }
|
||||
|
||||
div.system-messages {
|
||||
margin: 5em }
|
||||
|
||||
div.system-messages h1 {
|
||||
color: red }
|
||||
|
||||
div.system-message {
|
||||
border: medium outset ;
|
||||
padding: 1em }
|
||||
|
||||
div.system-message p.system-message-title {
|
||||
color: red ;
|
||||
font-weight: bold }
|
||||
|
||||
div.topic {
|
||||
margin: 2em }
|
||||
|
||||
h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
|
||||
h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
|
||||
margin-top: 0.4em }
|
||||
|
||||
h1.title {
|
||||
text-align: center }
|
||||
|
||||
h2.subtitle {
|
||||
text-align: center }
|
||||
|
||||
hr.docutils {
|
||||
width: 75% }
|
||||
|
||||
img.align-left, .figure.align-left, object.align-left, table.align-left {
|
||||
clear: left ;
|
||||
float: left ;
|
||||
margin-right: 1em }
|
||||
|
||||
img.align-right, .figure.align-right, object.align-right, table.align-right {
|
||||
clear: right ;
|
||||
float: right ;
|
||||
margin-left: 1em }
|
||||
|
||||
img.align-center, .figure.align-center, object.align-center {
|
||||
display: block;
|
||||
margin-left: auto;
|
||||
margin-right: auto;
|
||||
}
|
||||
|
||||
table.align-center {
|
||||
margin-left: auto;
|
||||
margin-right: auto;
|
||||
}
|
||||
|
||||
.align-left {
|
||||
text-align: left }
|
||||
|
||||
.align-center {
|
||||
clear: both ;
|
||||
text-align: center }
|
||||
|
||||
.align-right {
|
||||
text-align: right }
|
||||
|
||||
/* reset inner alignment in figures */
|
||||
div.align-right {
|
||||
text-align: inherit }
|
||||
|
||||
/* div.align-center * { */
|
||||
/* text-align: left } */
|
||||
|
||||
.align-top {
|
||||
vertical-align: top }
|
||||
|
||||
.align-middle {
|
||||
vertical-align: middle }
|
||||
|
||||
.align-bottom {
|
||||
vertical-align: bottom }
|
||||
|
||||
ol.simple, ul.simple {
|
||||
margin-bottom: 1em }
|
||||
|
||||
ol.arabic {
|
||||
list-style: decimal }
|
||||
|
||||
ol.loweralpha {
|
||||
list-style: lower-alpha }
|
||||
|
||||
ol.upperalpha {
|
||||
list-style: upper-alpha }
|
||||
|
||||
ol.lowerroman {
|
||||
list-style: lower-roman }
|
||||
|
||||
ol.upperroman {
|
||||
list-style: upper-roman }
|
||||
|
||||
p.attribution {
|
||||
text-align: right ;
|
||||
margin-left: 50% }
|
||||
|
||||
p.caption {
|
||||
font-style: italic }
|
||||
|
||||
p.credits {
|
||||
font-style: italic ;
|
||||
font-size: smaller }
|
||||
|
||||
p.label {
|
||||
white-space: nowrap }
|
||||
|
||||
p.rubric {
|
||||
font-weight: bold ;
|
||||
font-size: larger ;
|
||||
color: maroon ;
|
||||
text-align: center }
|
||||
|
||||
p.sidebar-title {
|
||||
font-family: sans-serif ;
|
||||
font-weight: bold ;
|
||||
font-size: larger }
|
||||
|
||||
p.sidebar-subtitle {
|
||||
font-family: sans-serif ;
|
||||
font-weight: bold }
|
||||
|
||||
p.topic-title {
|
||||
font-weight: bold }
|
||||
|
||||
pre.address {
|
||||
margin-bottom: 0 ;
|
||||
margin-top: 0 ;
|
||||
font: inherit }
|
||||
|
||||
pre.literal-block, pre.doctest-block, pre.math, pre.code {
|
||||
margin-left: 2em ;
|
||||
margin-right: 2em }
|
||||
|
||||
pre.code .ln { color: gray; } /* line numbers */
|
||||
pre.code, code { background-color: #eeeeee }
|
||||
pre.code .comment, code .comment { color: #5C6576 }
|
||||
pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
|
||||
pre.code .literal.string, code .literal.string { color: #0C5404 }
|
||||
pre.code .name.builtin, code .name.builtin { color: #352B84 }
|
||||
pre.code .deleted, code .deleted { background-color: #DEB0A1}
|
||||
pre.code .inserted, code .inserted { background-color: #A3D289}
|
||||
|
||||
span.classifier {
|
||||
font-family: sans-serif ;
|
||||
font-style: oblique }
|
||||
|
||||
span.classifier-delimiter {
|
||||
font-family: sans-serif ;
|
||||
font-weight: bold }
|
||||
|
||||
span.interpreted {
|
||||
font-family: sans-serif }
|
||||
|
||||
span.option {
|
||||
white-space: nowrap }
|
||||
|
||||
span.pre {
|
||||
white-space: pre }
|
||||
|
||||
span.problematic, pre.problematic {
|
||||
color: red }
|
||||
|
||||
span.section-subtitle {
|
||||
/* font-size relative to parent (h1..h6 element) */
|
||||
font-size: 80% }
|
||||
|
||||
table.citation {
|
||||
border-left: solid 1px gray;
|
||||
margin-left: 1px }
|
||||
|
||||
table.docinfo {
|
||||
margin: 2em 4em }
|
||||
|
||||
table.docutils {
|
||||
margin-top: 0.5em ;
|
||||
margin-bottom: 0.5em }
|
||||
|
||||
table.footnote {
|
||||
border-left: solid 1px black;
|
||||
margin-left: 1px }
|
||||
|
||||
table.docutils td, table.docutils th,
|
||||
table.docinfo td, table.docinfo th {
|
||||
padding-left: 0.5em ;
|
||||
padding-right: 0.5em ;
|
||||
vertical-align: top }
|
||||
|
||||
table.docutils th.field-name, table.docinfo th.docinfo-name {
|
||||
font-weight: bold ;
|
||||
text-align: left ;
|
||||
white-space: nowrap ;
|
||||
padding-left: 0 }
|
||||
|
||||
/* "booktabs" style (no vertical lines) */
|
||||
table.docutils.booktabs {
|
||||
border: 0px;
|
||||
border-top: 2px solid;
|
||||
border-bottom: 2px solid;
|
||||
border-collapse: collapse;
|
||||
}
|
||||
table.docutils.booktabs * {
|
||||
border: 0px;
|
||||
}
|
||||
table.docutils.booktabs th {
|
||||
border-bottom: thin solid;
|
||||
text-align: left;
|
||||
}
|
||||
|
||||
h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
|
||||
h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
|
||||
font-size: 100% }
|
||||
|
||||
ul.auto-toc {
|
||||
list-style-type: none }
|
||||
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<div class="document" id="store-sessions-in-db">
|
||||
<h1 class="title">Store sessions in DB</h1>
|
||||
|
||||
<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||||
!! This file is generated by oca-gen-addon-readme !!
|
||||
!! changes will be overwritten. !!
|
||||
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||||
!! source digest: sha256:59a43b0f19a6177d8866b3524a34ec9f9b380f29765d4d9647254dba9248b2f1
|
||||
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
|
||||
<p><a class="reference external image-reference" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external image-reference" href="http://www.gnu.org/licenses/lgpl-3.0-standalone.html"><img alt="License: LGPL-3" src="https://img.shields.io/badge/licence-LGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/OCA/server-tools/tree/16.0/session_db"><img alt="OCA/server-tools" src="https://img.shields.io/badge/github-OCA%2Fserver--tools-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/server-tools-16-0/server-tools-16-0-session_db"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external image-reference" href="https://runboat.odoo-community.org/builds?repo=OCA/server-tools&target_branch=16.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
|
||||
<p>Store sessions in a database instead of the filesystem. This simplifies the
|
||||
configuration of horizontally scalable deployments, by avoiding the need for a
|
||||
distributed filesystem to store the Odoo sessions.</p>
|
||||
<p><strong>Table of contents</strong></p>
|
||||
<div class="contents local topic" id="contents">
|
||||
<ul class="simple">
|
||||
<li><a class="reference internal" href="#usage" id="toc-entry-1">Usage</a></li>
|
||||
<li><a class="reference internal" href="#bug-tracker" id="toc-entry-2">Bug Tracker</a></li>
|
||||
<li><a class="reference internal" href="#credits" id="toc-entry-3">Credits</a><ul>
|
||||
<li><a class="reference internal" href="#authors" id="toc-entry-4">Authors</a></li>
|
||||
<li><a class="reference internal" href="#maintainers" id="toc-entry-5">Maintainers</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="usage">
|
||||
<h1><a class="toc-backref" href="#toc-entry-1">Usage</a></h1>
|
||||
<p>Set this module in the server wide modules.</p>
|
||||
<p>Set a <tt class="docutils literal">SESSION_DB_URI</tt> environment variable as a full postgresql connection string,
|
||||
like <tt class="docutils literal"><span class="pre">postgres://user:passwd@server/db</span></tt> or <tt class="docutils literal">db</tt>.</p>
|
||||
<p>It is recommended to use a dedicated database for this module, and possibly a dedicated
|
||||
postgres user for additional security.</p>
|
||||
</div>
|
||||
<div class="section" id="bug-tracker">
|
||||
<h1><a class="toc-backref" href="#toc-entry-2">Bug Tracker</a></h1>
|
||||
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/server-tools/issues">GitHub Issues</a>.
|
||||
In case of trouble, please check there if your issue has already been reported.
|
||||
If you spotted it first, help us to smash it by providing a detailed and welcomed
|
||||
<a class="reference external" href="https://github.com/OCA/server-tools/issues/new?body=module:%20session_db%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
|
||||
<p>Do not contact contributors directly about support or help with technical issues.</p>
|
||||
</div>
|
||||
<div class="section" id="credits">
|
||||
<h1><a class="toc-backref" href="#toc-entry-3">Credits</a></h1>
|
||||
<div class="section" id="authors">
|
||||
<h2><a class="toc-backref" href="#toc-entry-4">Authors</a></h2>
|
||||
<ul class="simple">
|
||||
<li>Odoo SA</li>
|
||||
<li>ACSONE SA/NV</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="maintainers">
|
||||
<h2><a class="toc-backref" href="#toc-entry-5">Maintainers</a></h2>
|
||||
<p>This module is maintained by the OCA.</p>
|
||||
<a class="reference external image-reference" href="https://odoo-community.org">
|
||||
<img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" />
|
||||
</a>
|
||||
<p>OCA, or the Odoo Community Association, is a nonprofit organization whose
|
||||
mission is to support the collaborative development of Odoo features and
|
||||
promote its widespread use.</p>
|
||||
<p>Current <a class="reference external" href="https://odoo-community.org/page/maintainer-role">maintainer</a>:</p>
|
||||
<p><a class="reference external image-reference" href="https://github.com/sbidoul"><img alt="sbidoul" src="https://github.com/sbidoul.png?size=40px" /></a></p>
|
||||
<p>This module is part of the <a class="reference external" href="https://github.com/OCA/server-tools/tree/16.0/session_db">OCA/server-tools</a> project on GitHub.</p>
|
||||
<p>You are welcome to contribute. To learn how please visit <a class="reference external" href="https://odoo-community.org/page/Contribute">https://odoo-community.org/page/Contribute</a>.</p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -0,0 +1 @@
|
|||
from . import test_pg_session_store
|
||||
|
|
@ -0,0 +1,94 @@
|
|||
from unittest import mock
|
||||
|
||||
import psycopg2
|
||||
|
||||
from odoo import http
|
||||
from odoo.sql_db import connection_info_for
|
||||
from odoo.tests.common import TransactionCase
|
||||
from odoo.tools import config
|
||||
|
||||
from odoo.addons.session_db.pg_session_store import PGSessionStore
|
||||
|
||||
|
||||
def _make_postgres_uri(
|
||||
user=None, password=None, host=None, port=None, database=None, **kwargs
|
||||
):
|
||||
uri = ["postgres://"]
|
||||
if user:
|
||||
uri.append(user)
|
||||
if password:
|
||||
uri.append(f":{password}")
|
||||
uri.append("@")
|
||||
if host:
|
||||
uri.append(host)
|
||||
if port:
|
||||
uri.append(f":{port}")
|
||||
uri.append("/")
|
||||
if database:
|
||||
uri.append(database)
|
||||
return "".join(uri)
|
||||
|
||||
|
||||
class TestPGSessionStore(TransactionCase):
|
||||
def setUp(self):
|
||||
super().setUp()
|
||||
_, connection_info = connection_info_for(config["db_name"])
|
||||
self.session_store = PGSessionStore(
|
||||
_make_postgres_uri(**connection_info), session_class=http.Session
|
||||
)
|
||||
|
||||
def test_session_crud(self):
|
||||
session = self.session_store.new()
|
||||
session["test"] = "test"
|
||||
self.session_store.save(session)
|
||||
assert session.sid is not None
|
||||
assert self.session_store.get(session.sid)["test"] == "test"
|
||||
self.session_store.delete(session)
|
||||
assert self.session_store.get(session.sid).get("test") is None
|
||||
|
||||
def test_retry(self):
|
||||
"""Test that session operations are retried before failing"""
|
||||
with mock.patch("odoo.sql_db.Cursor.execute") as mock_execute:
|
||||
mock_execute.side_effect = psycopg2.OperationalError()
|
||||
try:
|
||||
self.session_store.get("abc")
|
||||
except psycopg2.OperationalError: # pylint: disable=except-pass
|
||||
pass
|
||||
else:
|
||||
# We don't use self.assertRaises because Odoo is overriding
|
||||
# in a way that interferes with the Cursor.execute mock
|
||||
raise AssertionError("expected psycopg2.OperationalError")
|
||||
assert mock_execute.call_count == 5
|
||||
# when the error is resolved, it works again
|
||||
self.session_store.get("abc")
|
||||
|
||||
def test_retry_connect_fail(self):
|
||||
with mock.patch("odoo.sql_db.Cursor.execute") as mock_execute, mock.patch(
|
||||
"odoo.sql_db.db_connect"
|
||||
) as mock_db_connect:
|
||||
mock_execute.side_effect = psycopg2.OperationalError()
|
||||
mock_db_connect.side_effect = RuntimeError("connection failed")
|
||||
# get fails, and a RuntimeError is raised when trying to reconnect
|
||||
try:
|
||||
self.session_store.get("abc")
|
||||
except RuntimeError: # pylint: disable=except-pass
|
||||
pass
|
||||
else:
|
||||
# We don't use self.assertRaises because Odoo is overriding
|
||||
# in a way that interferes with the Cursor.execute mock
|
||||
raise AssertionError("expected RuntimeError")
|
||||
assert mock_execute.call_count == 1
|
||||
# when the error is resolved, it works again
|
||||
self.session_store.get("abc")
|
||||
|
||||
def test_make_postgres_uri(self):
|
||||
connection_info = {
|
||||
"host": "localhost",
|
||||
"port": 5432,
|
||||
"database": "test",
|
||||
"user": "test",
|
||||
"password": "PASSWORD",
|
||||
}
|
||||
assert "postgres://test:PASSWORD@localhost:5432/test" == _make_postgres_uri(
|
||||
**connection_info
|
||||
)
|
||||
Loading…
Add table
Add a link
Reference in a new issue