Implement sorting of events via config file

.gitignore

@@ -77,3 +77,7 @@ venv.bak/
 pip-selfcheck.json
 
 # End of https://www.gitignore.io/api/venv,django,pycharm+all
+
+### Tests ###
+# Reports
+reports

README.rst

@@ -257,6 +257,31 @@ The default timezone for timestamps is ``UTC``. Timezone information can be chan
 the ``[howitz]``-section or setting the environment variable ``HOWITZ_TIMEZONE`` to ``LOCAL``. Timezone values other
 than ``LOCAL`` and ``UTC`` provided in config will be ignored and fall back to ``UTC``.
 
+Howitz uses caching. You can configure preferred caching type under the ``[caching]``-section.
+See `Flask-Caching's configuration docs <https://flask-caching.readthedocs.io/en/latest/#configuring-flask-caching>`_ for available configuration options.
+Default cache type is `SimpleCache <https://flask-caching.readthedocs.io/en/latest/#simplecache>`_
+
+
+Configuring order in which events are sorted
+--------------------------------------------
+
+Sorting method can be changed under the ``[howitz]``-section by adding::
+
+    sort_by = "<valid sorting method>"
+
+Valid sorting methods are:
+
+* *raw* - Unchanged order in which Zino server sends events (by ID ascending).
+* *lasttrans* - Newest transaction first, all IGNORED at the bottom. Default sorting in curitz.
+
+* *severity* - Events of same color grouped together. The most severe (red) at the top and ignored at the bottom. Existing method in Ritz TK, but it is called 'default' there.
+* *down-rev* - Shortest/none downtime first. Identical to an existing method in Ritz TK.
+* *down* - Longest downtime first. Identical to an existing method in Ritz TK.
+* *upd-rev* - Events with the most recent update date first. Identical to an existing method in Ritz TK.
+* *upd* - Events with the oldest update date first. Identical to an existing method in Ritz TK.
+* *age-rev* - Oldest events first. Identical to an existing method in Ritz TK.
+* *age* - Newest events first. Identical to an existing method in Ritz TK.
+
 
 Example config-file (for development)
 -------------------------------------

howitz.min.toml.example

@@ -10,6 +10,10 @@ timezone='LOCAL'
 [zino.connections.default]
 server =
 
+[caching]
+CACHE_TYPE = 'FileSystemCache'
+CACHE_DIR = './.howitz_cache'
+
 [logging]
 version = 1
 

howitz.toml.example

@@ -7,6 +7,7 @@ storage = "./howitz.sqlite3"
 devmode = true
 refresh_interval = 10
 timezone='LOCAL'
+sort_by="lasttrans"
 
 [zino.connections.default]
 server =
@@ -15,6 +16,10 @@ server =
 #[zino.connections.other]
 #server =
 
+[caching]
+CACHE_TYPE = 'FileSystemCache'
+CACHE_DIR = './.howitz_cache'
+
 [logging]
 version = 1
 

pyproject.toml

@@ -17,10 +17,11 @@ requires-python = ">=3.8"
 dynamic = ["version"]
 dependencies = [
     "flask",
+    "flask-caching",
     "flask_assets",
     "flask-login",
     "jinja2",
-    "zinolib>=1.1.1",
+    "zinolib>=1.2.0",
     "werkzeug<3",  # needed by flask-login
     "pydantic",
 ]

requirements-frozen.txt

@@ -8,15 +8,20 @@ annotated-types==0.6.0
     # via pydantic
 blinker==1.7.0
     # via flask
+cachelib==0.9.0
+    # via flask-caching
 click==8.1.7
     # via flask
 flask==2.3.3
     # via
     #   flask-assets
+    #   flask-caching
     #   flask-login
     #   howitz (pyproject.toml)
 flask-assets==2.1.0
     # via howitz (pyproject.toml)
+flask-caching==2.3.0
+    # via howitz (pyproject.toml)
 flask-login==0.6.3
     # via howitz (pyproject.toml)
 itsdangerous==2.1.2
@@ -49,5 +54,5 @@ werkzeug==2.3.8
     #   flask
     #   flask-login
     #   howitz (pyproject.toml)
-zinolib==1.1.1
+zinolib==1.2.0
     # via howitz (pyproject.toml)

src/howitz/__init__.py

@@ -2,6 +2,7 @@
 
 
 from logging.config import dictConfig
+from flask_caching import Cache
 
 from flask import Flask, g, redirect, url_for, current_app
 from flask.logging import default_handler
@@ -101,6 +102,18 @@ def unauthorized():
     assets.register("css", css)
     css.build()
 
+    caching_dict = app.config.get("CACHING", {})
+    if caching_dict:
+        cache = Cache(config=caching_dict)
+        cache.init_app(app)
+        app.cache = cache
+        app.logger.debug('Caching config -> %s', caching_dict)
+    else:
+        cache = Cache(config={'CACHE_TYPE': 'SimpleCache'})
+        cache.init_app(app)
+        app.cache = cache
+        app.logger.warn('Caching config not found, setting up simple caching')
+
     # import endpoints/urls
     from . import endpoints
     app.register_blueprint(endpoints.main)

src/howitz/config/cache.py

@@ -0,0 +1,2 @@
+def get_config_dict(config_dict):
+    return config_dict.get('caching', None)

src/howitz/config/defaults.py

@@ -0,0 +1,3 @@
+
+DEFAULT_STORAGE = "./howitz.sqlite3"
+DEFAULT_TIMEZONE = 'UTC'

src/howitz/config/models.py

@@ -3,9 +3,8 @@
 from pydantic import BaseModel
 from pydantic.networks import IPvAnyAddress
 
-
-DEFAULT_STORAGE = "./howitz.sqlite3"
-DEFAULT_TIMEZONE = 'UTC'
+from howitz.config.defaults import DEFAULT_TIMEZONE, DEFAULT_STORAGE
+from howitz.endpoints import EventSort
 
 
 class ServerConfig(BaseModel):
@@ -30,9 +29,11 @@ class HowitzConfig(ServerConfig, StorageConfig):
     devmode: bool = Literal[False]
     refresh_interval: int = 5
     timezone: str = DEFAULT_TIMEZONE
+    sort_by: str = EventSort.DEFAULT
 
 
 class DevHowitzConfig(DevServerConfig, DevStorageConfig):
     devmode: bool = Literal[True]
     refresh_interval: int = 5
     timezone: str = DEFAULT_TIMEZONE
+    sort_by: str = EventSort.DEFAULT

src/howitz/config/utils.py

@@ -1,4 +1,4 @@
-from howitz.config import flask, howitz, log, zino1
+from howitz.config import flask, howitz, log, zino1, cache
 from zinolib.config.toml import parse_toml_config
 
 
@@ -14,6 +14,9 @@ def make_flask_config_dict(raw_config_dict):
     log_dict = log.get_config_dict(raw_config_dict)
     config_dict['LOGGING'] = log_dict
 
+    cache_dict = cache.get_config_dict(raw_config_dict)
+    config_dict['CACHING'] = cache_dict
+
     zino_dict = zino1.get_config_dict(raw_config_dict)
     zino_dict.pop("username", None)
     zino_dict.pop("password", None)