[MIG] session_db from 18 to 19

Author: sbidoul

session_db/README.rst

@@ -1,3 +1,7 @@
+.. image:: https://odoo-community.org/readme-banner-image
+   :target: https://odoo-community.org/get-involved?utm_source=readme
+   :alt: Odoo Community Association
+
 ====================
 Store sessions in DB
 ====================
@@ -13,17 +17,17 @@ Store sessions in DB
 .. |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
+.. |badge2| image:: https://img.shields.io/badge/license-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/18.0/session_db
+    :target: https://github.com/OCA/server-tools/tree/19.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-18-0/server-tools-18-0-session_db
+    :target: https://translation.odoo-community.org/projects/server-tools-19-0/server-tools-19-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=18.0
+    :target: https://runboat.odoo-community.org/builds?repo=OCA/server-tools&target_branch=19.0
     :alt: Try me on Runboat
 
 |badge1| |badge2| |badge3| |badge4| |badge5|
@@ -54,7 +58,7 @@ 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:%2018.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
+`feedback <https://github.com/OCA/server-tools/issues/new?body=module:%20session_db%0Aversion:%2019.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.
 
@@ -88,6 +92,6 @@ 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/18.0/session_db>`_ project on GitHub.
+This module is part of the `OCA/server-tools <https://github.com/OCA/server-tools/tree/19.0/session_db>`_ project on GitHub.
 
 You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

session_db/__manifest__.py

@@ -1,6 +1,6 @@
 {
     "name": "Store sessions in DB",
-    "version": "18.0.1.0.0",
+    "version": "19.0.1.0.0",
     "author": "Odoo SA,ACSONE SA/NV,Odoo Community Association (OCA)",
     "license": "LGPL-3",
     "website": "https://github.com/OCA/server-tools",

session_db/pg_session_store.py

@@ -2,6 +2,7 @@
 # @author Nicolas Seinlet
 # Copyright (c) ACSONE SA 2022
 # @author Stéphane Bidoul
+import functools
 import json
 import logging
 import os
@@ -11,7 +12,6 @@
 import odoo
 from odoo import http
 from odoo.tools._vendor import sessions
-from odoo.tools.func import lazy_property
 
 _logger = logging.getLogger(__name__)
 
@@ -136,9 +136,12 @@ def get(self, sid):
 
         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.
+    # Odoo's FileSystemSessionStore has a few additional methods that are independent
+    # of the actual storage backend. We reuse them here.
     rotate = http.FilesystemSessionStore.rotate
+    generate_key = http.FilesystemSessionStore.generate_key
+    is_valid_key = http.FilesystemSessionStore.is_valid_key
+    delete_old_sessions = http.FilesystemSessionStore.delete_old_sessions
 
     @with_lock
     @with_cursor
@@ -149,11 +152,54 @@ def vacuum(self, max_lifetime=http.SESSION_LIFETIME):
             (f"{max_lifetime} seconds",),
         )
 
+    @with_lock
+    @with_cursor
+    def get_missing_session_identifiers(self, identifiers: list[str]) -> set[str]:
+        """
+        :param identifiers: session identifiers whose file existence must be checked
+                            identifiers are a part session sid (first 42 chars)
+        :type identifiers: iterable
+        :return: the identifiers which are not present on the filesystem
+        :rtype: set
+
+        Note 1:
+        Working with identifiers 42 characters long means that
+        we don't have to work with the entire sid session,
+        while maintaining sufficient entropy to avoid collisions.
+        See details in ``generate_key``.
+
+        Note 2:
+        Scans the session store for inactive (GC'd) sessions.
+        Performance is acceptable for an infrequent background job.
+        """
+        missing_identifiers = set()
+        for identifier in identifiers:
+            self._cr.execute(
+                "SELECT sid FROM http_sessions WHERE sid LIKE %s||'%%' LIMIT 1",
+                (identifier,),
+            )
+            if self._cr.rowcount == 0:
+                missing_identifiers.add(identifier)
+        return missing_identifiers
+
+    @with_lock
+    @with_cursor
+    def delete_from_identifiers(self, identifiers: list[str]) -> None:
+        for identifier in identifiers:
+            if not http._session_identifier_re.match(identifier):
+                raise ValueError(
+                    "Identifier format incorrect, "
+                    "did you pass in a string instead of a list?"
+                )
+            self._cr.execute(
+                "DELETE FROM http_sessions WHERE sid LIKE %s||'%%'", (identifier,)
+            )
+
 
 _original_session_store = http.root.__class__.session_store
 
 
-@lazy_property
+@functools.cached_property
 def session_store(self):
     session_db_uri = os.environ.get("SESSION_DB_URI")
     if session_db_uri:
@@ -165,5 +211,6 @@ def session_store(self):
 # Monkey patch of standard methods
 _logger.debug("Monkey patching session store")
 http.root.__class__.session_store = session_store
+http.root.__class__.session_store.__set_name__(http.root.__class__, "session_store")
 # Reset the lazy property cache
 vars(http.root).pop("session_store", None)

session_db/static/description/index.html

@@ -3,7 +3,7 @@
 <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>
+<title>README.rst</title>
 <style type="text/css">
 
 /*
@@ -360,16 +360,21 @@
 </style>
 </head>
 <body>
-<div class="document" id="store-sessions-in-db">
-<h1 class="title">Store sessions in DB</h1>
+<div class="document">
 
+
+<a class="reference external image-reference" href="https://odoo-community.org/get-involved?utm_source=readme">
+<img alt="Odoo Community Association" src="https://odoo-community.org/readme-banner-image" />
+</a>
+<div class="section" id="store-sessions-in-db">
+<h1>Store sessions in DB</h1>
 <!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
 !! This file is generated by oca-gen-addon-readme !!
 !! changes will be overwritten.                   !!
 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
 !! source digest: sha256:1f019db79d78ab20a204e51d1750ed8b2e7c22dd3d585569f97579c339bc34c7
 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
-<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/18.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-18-0/server-tools-18-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&amp;target_branch=18.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
+<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/license-LGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/OCA/server-tools/tree/19.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-19-0/server-tools-19-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&amp;target_branch=19.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>
@@ -386,32 +391,32 @@ <h1 class="title">Store sessions in DB</h1>
 </ul>
 </div>
 <div class="section" id="usage">
-<h1><a class="toc-backref" href="#toc-entry-1">Usage</a></h1>
+<h2><a class="toc-backref" href="#toc-entry-1">Usage</a></h2>
 <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&#64;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>
+<h2><a class="toc-backref" href="#toc-entry-2">Bug Tracker</a></h2>
 <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:%2018.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
+<a class="reference external" href="https://github.com/OCA/server-tools/issues/new?body=module:%20session_db%0Aversion:%2019.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>
+<h2><a class="toc-backref" href="#toc-entry-3">Credits</a></h2>
 <div class="section" id="authors">
-<h2><a class="toc-backref" href="#toc-entry-4">Authors</a></h2>
+<h3><a class="toc-backref" href="#toc-entry-4">Authors</a></h3>
 <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>
+<h3><a class="toc-backref" href="#toc-entry-5">Maintainers</a></h3>
 <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" />
@@ -421,10 +426,11 @@ <h2><a class="toc-backref" href="#toc-entry-5">Maintainers</a></h2>
 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/18.0/session_db">OCA/server-tools</a> project on GitHub.</p>
+<p>This module is part of the <a class="reference external" href="https://github.com/OCA/server-tools/tree/19.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>
+</div>
 </body>
 </html>

session_db/tests/test_pg_session_store.py

@@ -5,7 +5,7 @@
 
 from odoo import http
 from odoo.sql_db import connection_info_for
-from odoo.tests.common import TransactionCase
+from odoo.tests import TransactionCase
 from odoo.tools import config
 
 from odoo.addons.session_db.pg_session_store import PGSessionStore
@@ -33,7 +33,7 @@ def _make_postgres_uri(
 class TestPGSessionStore(TransactionCase):
     def setUp(self):
         super().setUp()
-        _, connection_info = connection_info_for(config["db_name"])
+        _, connection_info = connection_info_for(config["db_name"][0])
         self.session_store = PGSessionStore(
             _make_postgres_uri(**connection_info), session_class=http.Session
         )
@@ -79,8 +79,8 @@ def test_retry_connect_fail(self):
             # get fails, and a RuntimeError is raised when trying to reconnect
             try:
                 self.session_store.get("abc")
-            except RuntimeError:  # pylint: disable=except-pass
-                pass
+            except RuntimeError as e:  # pylint: disable=except-pass
+                assert str(e) == "connection failed"
             else:
                 # We don't use self.assertRaises because Odoo is overriding
                 # in a way that interferes with the Cursor.execute mock
@@ -100,3 +100,31 @@ def test_make_postgres_uri(self):
         assert "postgres://test:PASSWORD@localhost:5432/test" == _make_postgres_uri(
             **connection_info
         )
+
+    def test_get_missing_session_identifiers(self):
+        session1 = self.session_store.new()
+        session2 = self.session_store.new()
+        self.session_store.save(session1)
+        self.session_store.save(session2)
+        missing = self.session_store.get_missing_session_identifiers(
+            [session1.sid[:42], session2.sid[:42], "nonexistentsessionid"]
+        )
+        self.assertEqual(missing, {"nonexistentsessionid"})
+        self.session_store.delete(session1)
+        missing = self.session_store.get_missing_session_identifiers(
+            [session1.sid[:42], session2.sid[:42], "nonexistentsessionid"]
+        )
+        self.assertEqual(missing, {session1.sid[:42], "nonexistentsessionid"})
+
+    def test_delete_from_identifiers(self):
+        session1 = self.session_store.new()
+        session2 = self.session_store.new()
+        self.session_store.save(session1)
+        self.session_store.save(session2)
+        self.session_store.delete_from_identifiers([session1.sid[:42], "f" * 42])
+        self.assertNotEqual(self.session_store.get(session1.sid).sid, session1.sid)
+        self.assertEqual(self.session_store.get(session2.sid).sid, session2.sid)
+
+    def test_delete_from_identifiers_invalid_format(self):
+        with self.assertRaises(ValueError):
+            self.session_store.delete_from_identifiers("xxx")