Changeset ac64833 in rattail

Timestamp:

08/03/2022 03:14:45 PM (6 months ago)

Author:

Lance Edgar <lance@…>

Branches:

master

Children:

de40a21

Parents:

68b3011

Message:

Add initial support for Beaker caching of config values from DB

refs #8

Files:

• rattail/app.py (modified) (2 diffs)
• rattail/config.py (modified) (4 diffs)
• rattail/data/config/web-complete.conf.mako (modified) (1 diff)
• rattail/data/config/web.conf (modified) (1 diff)
• rattail/data/config/webapi.conf (modified) (1 diff)
• setup.py (modified) (1 diff)

rattail/app.py

@@ -239 +239 @@
         setting.value = value
 
+        # invalidate beaker config cache for this setting, if applicable
+        self.config.beaker_invalidate_setting(name)
+
     def delete_setting(self, session, name, **kwargs):
         model = self.model
@@ -882 +885 @@
 
         folders = [
+            'cache',
             'data',
             os.path.join('data', 'uploads'),
             'log',
+            # TODO: deprecate / remove this
             'sessions',
             'work',

rattail/config.py

@@ -143 +143 @@
         self.versioning_has_been_enabled = False
 
+        # should we use beaker caching?
+        self.beaker_caching = self.getbool('rattail.config', 'beaker_cache.enabled',
+                                           usedb=False, default=False)
+        if self.beaker_caching:
+            from beaker.cache import CacheManager
+            from beaker.util import parse_cache_config_options
+
+            options = {
+                'cache.type': self.get(
+                    'rattail.config', 'beaker_cache.type',
+                    usedb=False,
+                    default='file'),
+                'cache.data_dir': self.get(
+                    'rattail.config', 'beaker_cache.data_dir',
+                    usedb=False,
+                    default=os.path.join(self.appdir(), 'cache', 'config', 'data')),
+                'cache.lock_dir': self.get(
+                    'rattail.config', 'beaker_cache.lock_dir',
+                    usedb=False,
+                    default=os.path.join(self.appdir(), 'cache', 'config', 'lock')),
+            }
+
+            self.beaker_cache_manager = CacheManager(
+                **parse_cache_config_options(options))
+
+            self.beaker_config_cache = self.beaker_cache_manager.get_cache(
+                'rattail.config',
+                type='file',    # TODO: (why) must we declare this?
+                expire=3600)
+
     def read_file(self, path, recurse=True, require=False):
         """
@@ -297 +327 @@
         app = self.get_app()
         name = '{}.{}'.format(section, option)
-        now = app.localtime(tzinfo=False)
+
+        if self.beaker_caching:
+            return self._getdb_beaker(section, option)
 
         close = False
@@ -311 +343 @@
 
         return value
+
+    def _getdb_beaker(self, section, option):
+        """
+        Retrieve a config value from database settings table.
+        """
+        app = self.get_app()
+        name = '{}.{}'.format(section, option)
+
+        def get_value():
+            # nb. avoid continuum user lookup
+            session = app.make_session(continuum_user=None)
+            value = app.get_setting(session, name)
+            session.close()
+            return value
+
+        return self.beaker_config_cache.get(key=name, createfunc=get_value)
+
+    def beaker_invalidate_setting(self, name):
+        if not self.beaker_caching:
+            return
+
+        # tell beaker to remove the cached value for this setting
+        self.beaker_config_cache.remove_value(key=name)
 
     def setdb(self, section, option, value, session=None):
@@ -487 +542 @@
         """
         get = self.require if require else self.get
+        kwargs.setdefault('usedb', False)
         return get('rattail', 'appdir', **kwargs)
 

rattail/data/config/web-complete.conf.mako

@@ -30 +30 @@
 
 beaker.session.type = file
-beaker.session.data_dir = %(here)s/sessions/data
-beaker.session.lock_dir = %(here)s/sessions/lock
+beaker.session.data_dir = %(here)s/cache/sessions/data
+beaker.session.lock_dir = %(here)s/cache/sessions/lock
 beaker.session.secret = ${beaker_secret}
 beaker.session.key = ${beaker_key}

rattail/data/config/web.conf

@@ -33 +33 @@
 
 beaker.session.type = file
-beaker.session.data_dir = %(here)s/sessions/data
-beaker.session.lock_dir = %(here)s/sessions/lock
+beaker.session.data_dir = %(here)s/cache/sessions/data
+beaker.session.lock_dir = %(here)s/cache/sessions/lock
 # TODO: you should change this
 beaker.session.secret = e:VHDVstO=H1%h1bV><&

rattail/data/config/webapi.conf

@@ -28 +28 @@
 
 beaker.session.type = file
-beaker.session.data_dir = %(here)s/sessions/data
-beaker.session.lock_dir = %(here)s/sessions/lock
+beaker.session.data_dir = %(here)s/cache/sessions/data
+beaker.session.lock_dir = %(here)s/cache/sessions/lock
 # TODO: you should change this
 beaker.session.secret = e:VHDVstO=H1%h1bV><&

setup.py

@@ -124 +124 @@
         # Support for multiple migration bases was added in Alembic 0.7.
         'alembic>=0.7.0',               #                       0.7.4
-
+        'beaker',                       # 1.11.0
         # TODO: add support for 1.4.x and later
         'SQLAlchemy<1.4',               # 0.7.6                 1.3.23