Make caching conditional

admin/admin.py

@@ -30,7 +30,7 @@
 from werkzeug.utils import secure_filename
 
 import api
-from cache_config import clear_api_cache_keys, clear_view_cache_keys
+from cache_config import cache, clear_api_cache_keys, clear_view_cache_keys
 from util import get_theme_directories, length_check
 
 # Blueprint configuration
@@ -176,8 +176,9 @@ def save_settings(settings: Dict[str, Any], flash_msg: str) -> Response:
         # Load the theme template if the current theme is changed
         set_theme_loader(app, remove_cache=True)
 
-    clear_view_cache_keys(all_users=True)
-    clear_api_cache_keys("admin_save_settings")
+    if cache:
+        clear_view_cache_keys(all_users=True)
+        clear_api_cache_keys("admin_save_settings")
     flash(flash_msg, 'success')
 
     return redirect(url_for("admin_bp.index"))

api.py

@@ -75,9 +75,11 @@ def call(fn: str, data: Optional[Dict[str, Any]] = None) -> Dict[str, Any]:
     encoded_params = hashlib.shake_256(params.encode('utf-8')).hexdigest(20)
 
     # Clear API cache keys if the API function called impacts keys.
-    clear_api_cache_keys(fn)
+    timeout = 0
+    if cache:
+        clear_api_cache_keys(fn)
+        timeout = get_api_cache_timeout(fn)
 
-    timeout = get_api_cache_timeout(fn)
     cached_result = None
     if timeout > 0:
         cached_result = cache.get(make_key(f"{fn}-{encoded_params}"))

app.py

@@ -131,7 +131,8 @@ def load_admin_setting() -> Dict[str, Any]:
 Session(app)
 
 # Initialize the cache.
-cache.init_app(app)
+if cache:
+    cache.init_app(app)
 
 # Start monitoring thread for extracting tech support information
 # Monitor signal file can be set to empty to completely disable monitor thread

cache_config.py

@@ -6,7 +6,8 @@
 import hashlib
 import json
 from concurrent.futures import ThreadPoolExecutor
-from typing import List, Optional
+from functools import wraps
+from typing import Callable, List, Optional
 
 from flask import current_app as app, g, request, session
 from flask_caching import Cache
@@ -192,5 +193,18 @@ def populate_api_cache(fn: str, user: str, irods: str, session_id: str) -> None:
                 log_error(f"Error prepopulating cache {fn}: {e}", True)
 
 
-# Create a Cache instance.
+def cache_view() -> Callable:
+    """Custom decorator to conditionally apply caching to views."""
+    def decorator(f: Callable) -> Callable:
+        @wraps(f)
+        def wrapped(*args: str, **kwargs: int) -> Callable:
+            if cache:
+                return cache.cached(make_cache_key=make_key)(f)(*args, **kwargs)
+            else:
+                return f(*args, **kwargs)
+        return wrapped
+    return decorator
+
+
+# Call the function
 cache = Cache(config=config)

deposit/deposit.py

@@ -24,7 +24,7 @@
 
 import api
 import connman
-from cache_config import cache, make_key
+from cache_config import cache_view
 
 deposit_bp = Blueprint('deposit_bp', __name__,
                        template_folder='templates',
@@ -42,7 +42,7 @@
 
 @deposit_bp.route('/')
 @deposit_bp.route('/browse')
-@cache.cached(make_cache_key=make_key)
+@cache_view()
 def index() -> Response:
     """Deposit overview"""
     return render_template('deposit/overview.html',
@@ -168,7 +168,7 @@ def submit() -> Response:
 
 
 @deposit_bp.route('/thank-you')
-@cache.cached(make_cache_key=make_key)
+@cache_view()
 def thankyou() -> Response:
     """Step 4: Thank you"""
     return render_template('deposit/thank-you.html')

general/general.py

@@ -6,7 +6,7 @@
 from flask import Blueprint, redirect, render_template, Response, url_for
 from flask_wtf.csrf import CSRFError
 
-from cache_config import cache, make_key
+from cache_config import cache_view
 
 general_bp = Blueprint('general_bp', __name__,
                        template_folder='templates/general',
@@ -15,7 +15,7 @@
 
 
 @general_bp.route('/')
-@cache.cached(make_cache_key=make_key)
+@cache_view()
 def index() -> Response:
     return render_template('index.html')
 

group_manager/group_manager.py

@@ -6,7 +6,7 @@
 from flask import Blueprint, make_response, render_template, request, Response
 
 import api
-from cache_config import cache, make_key
+from cache_config import cache_view
 
 group_manager_bp = Blueprint('group_manager_bp', __name__,
                              template_folder='templates',
@@ -68,7 +68,7 @@ def get_subcategories() -> Response:
 
 
 @group_manager_bp.route('/get_schemas', methods=['POST'])
-@cache.cached(make_cache_key=make_key)
+@cache_view()
 def get_schemas() -> Response:
     response = api.call('schema_get_schemas', data={})
 

research/research.py

@@ -32,7 +32,7 @@
 
 import api
 import connman
-from cache_config import cache, make_key
+from cache_config import cache_view
 from util import log_error, unicode_secure_filename
 
 research_bp = Blueprint('research_bp', __name__,
@@ -89,7 +89,7 @@ def irods_writer() -> None:
 
 @research_bp.route('/')
 @research_bp.route('/browse')
-@cache.cached(make_cache_key=make_key)
+@cache_view()
 def index() -> Response:
     return render_template('research/browse.html')
 

stats/stats.py

@@ -6,7 +6,7 @@
 from flask import Blueprint, make_response, render_template, Response
 
 import api
-from cache_config import cache, make_key
+from cache_config import cache_view
 
 stats_bp = Blueprint('stats_bp', __name__,
                      template_folder='templates',
@@ -15,7 +15,7 @@
 
 
 @stats_bp.route('/')
-@cache.cached(make_cache_key=make_key)
+@cache_view()
 def index() -> Response:
     category_response = api.call('resource_category_stats', data={})
 
@@ -25,7 +25,7 @@ def index() -> Response:
 
 
 @stats_bp.route('/export')
-@cache.cached(make_cache_key=make_key)
+@cache_view()
 def export() -> Response:
     response = api.call('resource_monthly_category_stats', data={})
 

user/user.py

@@ -35,7 +35,7 @@
 
 import api
 import connman
-from cache_config import cache, clear_view_cache_keys, executor, get_api_cache_functions, make_key, populate_api_cache
+from cache_config import cache, cache_view, clear_view_cache_keys, executor, get_api_cache_functions, populate_api_cache
 from util import is_email_in_domains, is_relative_url, log_error
 
 # Blueprint creation
@@ -154,7 +154,8 @@ def logout() -> Response:
     """Logout user and redirect to index."""
 
     # Clear view cache keys for user.
-    clear_view_cache_keys()
+    if cache:
+        clear_view_cache_keys()
 
     connman.clean(session.sid)
     session.clear()
@@ -190,14 +191,14 @@ def settings() -> Response:
 
 
 @user_bp.route('/notifications')
-@cache.cached(make_cache_key=make_key)
+@cache_view()
 def notifications() -> Response:
     """Notifications page."""
     return render_template('user/notifications.html')
 
 
 @user_bp.route('/data_access')
-@cache.cached(make_cache_key=make_key)
+@cache_view()
 def data_access() -> Response:
     """Data Access Passwords overview"""
     token_lifetime = app.config.get('TOKEN_LIFETIME')
@@ -206,7 +207,7 @@ def data_access() -> Response:
 
 
 @user_bp.route('/data_transfer')
-@cache.cached(make_cache_key=make_key)
+@cache_view()
 def data_transfer() -> Response:
     """Data Transfer page."""
     return render_template('user/data_transfer.html')
@@ -527,7 +528,7 @@ def populate_api_cache_thread(fn: str, user: str, irods: str, session_id: str) -
                         populate_api_cache(fn, user, irods, session_id)
 
                 # Submit the task to the global thread executor.
-                if should_populate_api_cache():
+                if cache and should_populate_api_cache():
                     for fn in get_api_cache_functions():
                         executor.submit(populate_api_cache_thread, fn, g.user, g.irods, session.sid)
 

vault/vault.py

@@ -23,7 +23,7 @@
 
 import api
 import connman
-from cache_config import cache, make_key
+from cache_config import cache_view
 
 vault_bp = Blueprint('vault_bp', __name__,
                      template_folder='templates',
@@ -33,7 +33,7 @@
 
 @vault_bp.route('/')
 @vault_bp.route('/browse')
-@cache.cached(make_cache_key=make_key)
+@cache_view()
 def index() -> Response:
     return render_template('vault/browse.html')