new: Allows to never expire a monitoring

Author: Rafiot

webmonitoring/webmonitoring.py

@@ -44,6 +44,7 @@ class NotificationSettings(TypedDict, total=False):
 class MonitorSettings(TypedDict, total=False):
     capture_settings: CaptureSettings
     frequency: str
+    never_expire: bool
     expire_at: Optional[Union[str, datetime, float]]
     collection: Optional[str]
     compare_settings: Optional[CompareSettings]
@@ -176,6 +177,8 @@ def get_monitor_settings(self, monitor_uuid: str) -> MonitorSettings:
                 to_return['expire_at'] = expire_at
         if collection := self.redis.get(f'{monitor_uuid}:collection'):
             to_return['collection'] = collection
+        if never_expire := self.redis.exists(f'{monitor_uuid}:ever_expire'):
+            to_return['never_expire'] = never_expire
         if compare_settings := self.get_compare_settings(monitor_uuid):
             to_return['compare_settings'] = compare_settings
         if notification := self.redis.hgetall(f'{monitor_uuid}:notification'):
@@ -213,7 +216,9 @@ def monitor(self, *, capture_settings: CaptureSettings, frequency: str,
     def monitor(self, *, monitor_uuid: str, capture_settings: Optional[CaptureSettings]=None,
                 frequency: Optional[str]=None,
                 expire_at: Optional[Union[datetime, str, int, float]]=None,
-                collection: Optional[str]=None, compare_settings: Optional[CompareSettings]=None,
+                collection: Optional[str]=None,
+                never_expire: bool=False,
+                compare_settings: Optional[CompareSettings]=None,
                 notification: Optional[NotificationSettings]=None) -> str:
         """Update an existing monitoring with individual parameters"""
         ...
@@ -222,6 +227,7 @@ def monitor(self, *, capture_settings: Optional[CaptureSettings]=None,
                 frequency: Optional[str]=None,
                 expire_at: Optional[Union[datetime, str, int, float]]=None,
                 collection: Optional[str]=None,
+                never_expire: bool=False,
                 compare_settings: Optional[CompareSettings]=None,
                 notification: Optional[NotificationSettings]=None,
                 monitor_settings: Optional[MonitorSettings]=None,
@@ -241,6 +247,7 @@ def monitor(self, *, capture_settings: Optional[CaptureSettings]=None,
             frequency = monitor_settings.get('frequency')
             expire_at = monitor_settings.get('expire_at')
             collection = monitor_settings.get('collection')
+            never_expire = monitor_settings.get('never_expire', False)
             compare_settings = monitor_settings.get('compare_settings')
             notification = monitor_settings.get('notification')
 
@@ -257,6 +264,9 @@ def monitor(self, *, capture_settings: Optional[CaptureSettings]=None,
         if frequency:
             p.set(f'{monitor_uuid}:frequency', frequency.lower())
 
+        if never_expire:
+            p.set(f'{monitor_uuid}:never_expire', 1)
+
         if collection:
             p.set(f'{monitor_uuid}:collection', collection)
             p.sadd('collections', collection)
@@ -386,7 +396,9 @@ def update_monitoring_queue(self):
                     nb_restarts = 1
                 else:
                     nb_restarts = int(_nb_restarts) + 1
-                if self.redis.zcard(f'{monitor_uuid}:captures') > self.max_captures * nb_restarts:
+                # if the capture is marked as "never_expire" (admin only), skip that.
+                if (not self.redis.exists(f'{monitor_uuid}:never_expire')
+                        and self.redis.zcard(f'{monitor_uuid}:captures') > self.max_captures * nb_restarts):
                     # Force expire monitoring
                     self.redis.smove('monitored', 'expired', monitor_uuid)
                     logger.info('Maximum amount of captures reached, expire..')

website/web/__init__.py

@@ -143,6 +143,7 @@ class CompareSettingsForm(Form):
     ressources_ignore_regexes = FieldList(StringField('Regex'), label="Regexes in URLs to ignore in comparison", min_entries=5)
     ignore_ips = BooleanField(label='Ignore IPs in comparison', description='Avoid flagging two captures are different when served on CDNs.')
     skip_failed_captures = BooleanField(label='Skip failed captures', description='Avoid attempting to compare two captures when one of them failed.')
+    never_expire = BooleanField(label='Never expire', description='Do not auto-expire the monitoring.')
 
 
 class NotificationForm(Form):
@@ -171,7 +172,7 @@ def changes_tracking(monitor_uuid: str):
                     if values := form.compare_settings.data[k]:
                         # Empty list is fine, it is how we remove all entries
                         compare_settings[k] = [x for x in set(values) if x != '']  # type: ignore
-                elif k in ['ignore_ips', 'skip_failed_captures']:
+                elif k in ['ignore_ips', 'skip_failed_captures', 'never_expire']:
                     compare_settings[k] = bool(form.compare_settings.data[k])  # type: ignore
 
             notification: NotificationSettings = {}
@@ -279,7 +280,8 @@ def get(self):
     'ressources_ignore_domains': fields.List(fields.String(description="A domain to ignore")),
     'ressources_ignore_regexes': fields.List(fields.String(description="A regex to match anything in a URL")),
     'ignore_ips': fields.Boolean(False, description='Ignore IPs when comparing nodes. Avoid flagging two captures are different when served on CDNs.'),
-    'skip_failed_captures': fields.Boolean(False, description='Skip failed captures. Avoid attempting to compare two captures when one of them failed.')
+    'skip_failed_captures': fields.Boolean(False, description='Skip failed captures. Avoid attempting to compare two captures when one of them failed.'),
+    'never_expire': fields.Boolean(label='Never expire the monitoring', description='Allows to keep the monitoring going forever.')
 })
 
 notification_mapping = api.model('NotificationSettings', {

website/web/templates/changes_tracking.html

@@ -75,6 +75,10 @@
         {{ monitoring_form.compare_settings.skip_failed_captures.label(class="form-label") }}
         {{ monitoring_form.compare_settings.skip_failed_captures(class="form-check-input") }}
       </div>
+      <div class="mb-3">
+        {{ monitoring_form.compare_settings.never_expire.label(class="form-label") }}
+        {{ monitoring_form.compare_settings.never_expire(class="form-check-input") }}
+      </div>
 
       {% if current_user.is_authenticated %}
       <div class="mb-3">