Rework refresh policy

And allow to force refresh of only the failures list.

Author: mbriand

swattool/main.py

@@ -18,7 +18,7 @@
 from . import swatbuild
 from . import userdata
 from . import utils
-from .webrequests import RefreshPolicy, Session
+from .webrequests import Session
 
 logger = logging.getLogger(__name__)
 
@@ -85,7 +85,7 @@ def login(user: str, password: str):
                                    case_sensitive=False),
                  help="Specify sort order"),
     click.option('--refresh', '-r',
-                 type=click.Choice([p.name for p in RefreshPolicy],
+                 type=click.Choice([p.name for p in swatbotrest.RefreshPolicy],
                                    case_sensitive=False),
                  default="auto",
                  help="Fetch data from server instead of using cache"),
@@ -153,7 +153,7 @@ def show_pending_failures(refresh: str, open_url: str,
                           limit: int, sort: list[str],
                           **kwargs):
     """Show all failures waiting for triage."""
-    Session().set_refresh_policy(RefreshPolicy[refresh.upper()])
+    swatbotrest.RefreshManager().set_policy_by_name(refresh)
 
     filters = parse_filters(kwargs)
     builds, userinfos = swatbot.get_failure_infos(limit=limit, sort=sort,
@@ -209,7 +209,7 @@ def review_pending_failures(refresh: str, open_autobuilder_url: bool,
     """Review failures waiting for triage."""
     # pylint: disable=too-many-arguments,too-many-positional-arguments
 
-    Session().set_refresh_policy(RefreshPolicy[refresh.upper()])
+    swatbotrest.RefreshManager().set_policy_by_name(refresh)
 
     filters = parse_filters(kwargs)
     builds, userinfos = swatbot.get_failure_infos(limit=limit, sort=sort,

swattool/review.py

@@ -15,7 +15,6 @@
 from .bugzilla import Bugzilla
 from . import utils
 from . import userdata
-from .webrequests import RefreshPolicy
 
 logger = logging.getLogger(__name__)
 
@@ -340,7 +339,7 @@ def get_new_reviews() -> dict[tuple[swatbotrest.TriageStatus, Any],
                     continue
 
                 def is_pending(failure_id):
-                    r = RefreshPolicy.FORCE
+                    r = swatbotrest.RefreshPolicy.FORCE
                     failure = swatbotrest.get_stepfailure(failure_id,
                                                           refresh_override=r)
                     return failure['attributes']['triage'] == 0

swattool/swatbotrest.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python3
 
-"""Interraction with the swatbot Django server."""
+"""Interaction with the swatbot Django server."""
 
 import enum
 import json
@@ -10,7 +10,7 @@
 import requests
 
 from . import utils
-from .webrequests import RefreshPolicy, Session
+from .webrequests import Session
 
 logger = logging.getLogger(__name__)
 
@@ -19,6 +19,67 @@
 REST_BASE_URL = f"{BASE_URL}/rest"
 
 
+class RefreshPolicy(enum.Enum):
+    """A swatbot cache refresh policy."""
+
+    NO = enum.auto()
+    FORCE = enum.auto()
+    FORCE_FAILURES = enum.auto()
+    AUTO = enum.auto()
+
+
+class RefreshManager:
+    """A refresh manager for the swatbot REST API."""
+
+    _instance = None
+
+    FAILURES_AUTO_REFRESH_S = 60 * 60 * 4
+    AUTO_REFRESH_S = 60 * 60 * 24 * 30
+
+    # pylint: disable=duplicate-code
+    # pylint complains because of duplicate code in singleton init. We might do
+    # better, but keep it that way for now.
+    def __new__(cls, *args, **kwargs):
+        if not isinstance(cls._instance, cls):
+            cls._instance = super().__new__(cls, *args, **kwargs)
+            cls._instance.initialized = False
+        return cls._instance
+
+    def __init__(self):
+        if self._instance.initialized:
+            return
+
+        self.refresh_policy = RefreshPolicy.AUTO
+
+        self._instance.initialized = True
+
+    def set_policy(self, policy: RefreshPolicy):
+        """Set the global refresh policy."""
+        self.refresh_policy = policy
+
+    def set_policy_by_name(self, policy_name: str):
+        """Set the global refresh policy from policy name."""
+        self.set_policy(RefreshPolicy[policy_name.upper()])
+
+    def get_refresh_max_age(self,
+                            refresh_override: Optional[RefreshPolicy] = None,
+                            failures: bool = False
+                            ) -> int:
+        """Get the maximum age before refresh for a given policy."""
+        policy = refresh_override if refresh_override else self.refresh_policy
+        if policy == RefreshPolicy.FORCE_FAILURES:
+            policy = RefreshPolicy.FORCE if failures else RefreshPolicy.AUTO
+
+        if policy == RefreshPolicy.FORCE:
+            return 0
+        if policy == RefreshPolicy.NO:
+            return -1
+
+        if failures:
+            return self.FAILURES_AUTO_REFRESH_S
+        return self.AUTO_REFRESH_S
+
+
 class TriageStatus(enum.IntEnum):
     """A status to set on a failure."""
 
@@ -35,10 +96,6 @@ def from_str(status: str) -> 'TriageStatus':
     CANCELLED = 5
 
 
-FAILURES_AUTO_REFRESH_S = 60 * 60 * 4
-AUTO_REFRESH_S = 60 * 60 * 24 * 30
-
-
 def _get_csrftoken() -> str:
     return Session().session.cookies['csrftoken']
 
@@ -83,15 +140,14 @@ def _get_json(path: str, max_cache_age: int = -1):
 
 def get_build(buildid: int, refresh_override: Optional[RefreshPolicy] = None):
     """Get info on a given build."""
-    maxage = Session().refresh_policy_max_age(AUTO_REFRESH_S, refresh_override)
+    maxage = RefreshManager().get_refresh_max_age(refresh_override)
     return _get_json(f"/build/{buildid}/", maxage)['data']
 
 
 def get_build_collection(collectionid: int, refresh_override:
                          Optional[RefreshPolicy] = None):
     """Get info on a given build collection."""
-    maxage = Session().refresh_policy_max_age(AUTO_REFRESH_S,
-                                              refresh_override)
+    maxage = RefreshManager().get_refresh_max_age(refresh_override)
     return _get_json(f"/buildcollection/{collectionid}/", maxage)['data']
 
 
@@ -106,16 +162,15 @@ def invalidate_stepfailures_cache():
 
 def get_stepfailures(refresh_override: Optional[RefreshPolicy] = None):
     """Get info on all failures."""
-    maxage = Session().refresh_policy_max_age(FAILURES_AUTO_REFRESH_S,
-                                              refresh_override)
+    maxage = RefreshManager().get_refresh_max_age(refresh_override,
+                                                     failures=True)
     return _get_json("/stepfailure/", maxage)['data']
 
 
 def get_stepfailure(failureid: int,
                     refresh_override: Optional[RefreshPolicy] = None):
     """Get info on a given failure."""
-    maxage = Session().refresh_policy_max_age(FAILURES_AUTO_REFRESH_S,
-                                              refresh_override)
+    maxage = RefreshManager().get_refresh_max_age(refresh_override)
     return _get_json(f"/stepfailure/{failureid}/", maxage)['data']
 
 

swattool/webrequests.py

@@ -2,13 +2,12 @@
 
 """Wrapper for requests module with cookies persistence and basic cache."""
 
-import enum
 import hashlib
 import logging
 import pathlib
 import pickle
 import time
-from typing import Any, Optional
+from typing import Any
 
 import requests
 
@@ -19,14 +18,6 @@
 COOKIESFILE = utils.DATADIR / 'cookies'
 
 
-class RefreshPolicy(enum.Enum):
-    """A cache refresh policy."""
-
-    NO = enum.auto()
-    FORCE = enum.auto()
-    AUTO = enum.auto()
-
-
 class Session:
     """A session with persistent cookies."""
 
@@ -43,29 +34,13 @@ def __init__(self):
             return
 
         self.session = requests.Session()
-        self.refresh_policy = RefreshPolicy.AUTO
 
         if COOKIESFILE.exists():
             with COOKIESFILE.open('rb') as file:
                 self.session.cookies.update(pickle.load(file))
 
         self._instance.initialized = True
 
-    def set_refresh_policy(self, policy: RefreshPolicy):
-        """Set the global refresh policy."""
-        self.refresh_policy = policy
-
-    def refresh_policy_max_age(self, auto: int,
-                               refresh_override: Optional[RefreshPolicy] = None
-                               ) -> int:
-        """Get the maximum age before refresh for a given policy."""
-        policy = refresh_override if refresh_override else self.refresh_policy
-        if policy == RefreshPolicy.FORCE:
-            return 0
-        if policy == RefreshPolicy.NO:
-            return -1
-        return auto
-
     def save_cookies(self):
         """Save cookies so they can be used for later sessions."""
         COOKIESFILE.parent.mkdir(parents=True, exist_ok=True)