Merge pull request #15 from imrehg/jsonrpc

Switch to using JSON-RPC library for request creation and response parsing

Author: imrehg

.github/workflows/python.yaml

@@ -13,7 +13,7 @@ jobs:
     name: "Lint & test"
     strategy:
       matrix:
-        python-version: ['3.9', '3.10']
+        python-version: ['3.10']
     runs-on: ubuntu-latest
 
     steps:
@@ -61,10 +61,10 @@ jobs:
         with:
           fetch-depth: 0
 
-      - name: Set up Python 3.9
+      - name: Set up Python 3.10
         uses: actions/setup-python@v1
         with:
-          python-version: 3.9
+          python-version: 3.10
 
       - name: Publish
         run: |

.gitignore

@@ -1,6 +1,7 @@
-# Ignore various secret files
+# Ignore various secret & settings files
 .secrets.*
 .env
+settings.toml
 
 # Built packages
 dist/

Dockerfile

@@ -1,4 +1,4 @@
-FROM python:3.9
+FROM python:3.10
 
 ENV PYTHONUNBUFFERED=1 \
     # prevents python creating .pyc files

poetry.lock

@@ -18,6 +18,7 @@ prometheus-client = "^0.14.1"
 requests = "^2.27.1"
 dynaconf = "^3.1.8"
 types-requests = "^2.27.25"
+jsonrpcclient = "^4.0.2"
 
 [tool.poetry.dev-dependencies]
 pytest = "*"

pyproject.toml

@@ -1,7 +1,9 @@
 import logging
 import time
+from typing import Any
 
 import requests
+from jsonrpcclient import Error, Ok, parse, request_hex
 from prometheus_client import Gauge, Info, start_http_server
 
 from . import __version__
@@ -34,27 +36,6 @@ class RouterMetrics:
         "Total transferred data this month (bytes)",
     )
 
-    payload = {
-        "network_info": {
-            "id": "1",
-            "jsonrpc": "2.0",
-            "method": "GetNetworkInfo",
-            "params": {},
-        },
-        "system_status": {
-            "id": "1",
-            "jsonrpc": "2.0",
-            "method": "GetSystemStatus",
-            "params": {},
-        },
-        "usage_record": {
-            "id": "1",
-            "jsonrpc": "2.0",
-            "method": "GetUsageRecord",
-            "params": {},
-        },
-    }
-
     def __init__(
         self,
         request_key: str,
@@ -72,24 +53,36 @@ def __init__(
             "Referer": f"http://{self.box_addr}/index.html",
         }
 
-    def run_metrics_loop(self):
+    def run_metrics_loop(self) -> None:
         """Metrics fetching loop"""
 
         while True:
             logging.debug("Fetching metrics.")
-            # self.fetch()
-            self.fetch_new()
+            self.fetch_metrics()
             time.sleep(self.polling_interval_seconds)
 
-    def _box_api_request(self, json: dict) -> dict:
+    def _box_api_request(self, method: str) -> dict[str, Any]:
         response = requests.post(
-            self.url, json=json, headers=self.headers, timeout=self.timeout
+            self.url,
+            json=request_hex(method),
+            headers=self.headers,
+            timeout=self.timeout,
         )
-        logging.debug("Response JSON: %s", response.json())
-        return response.json().get("result", {})
+        logging.debug("Method: %s; response: %s", method, response.json())
+        match parse(response.json()):
+            case Ok(result, _):
+                return result
+            case Error(_, message, _, _):
+                logging.error(
+                    "API error: method: %s; message: %s", method, message
+                )
+                raise RuntimeError(message)
+            case _:
+                assert False, "Impossible parsed response received."
 
     def _read_network_info(self) -> None:
-        results = self._box_api_request(json=self.payload["network_info"])
+        """Requesting, parsing, and updating network info metrics."""
+        results = self._box_api_request("GetNetworkInfo")
         logging.debug("Network info: %s", results)
 
         # Set Prometheus metrics
@@ -114,15 +107,17 @@ def _read_network_info(self) -> None:
             )
 
     def _read_system_status(self) -> None:
-        results = self._box_api_request(json=self.payload["system_status"])
+        """Requesting, parsing, and updating system status metrics."""
+        results = self._box_api_request("GetSystemStatus")
         logging.debug("System status: %s", results)
 
         # Set Prometheus metrics
         if value := results.get("TotalConnNum"):
             self.connected_devices.set(value)
 
     def _read_usage_record(self) -> None:
-        results = self._box_api_request(json=self.payload["usage_record"])
+        """Requesting, parsing, and updating usage record metrics."""
+        results = self._box_api_request("GetUsageRecord")
         logging.debug("Usage record: %s", results)
 
         # Set Prometheus metrics
@@ -135,13 +130,14 @@ def _read_usage_record(self) -> None:
         if value := results.get("HUseData"):
             self.total_transfer_this_month.set(value)
 
-    def fetch_new(self):
+    def fetch_metrics(self) -> None:
+        """Fetch all relevant metrics."""
         self._read_network_info()
         self._read_system_status()
         self._read_usage_record()
 
 
-def main():
+def main() -> None:
     """Main entry point for the exporter"""
     logging.info("Linkhub Prometheus Exporter, version %s", __version__)
 

src/linkhub_prometheus_exporter/exporter.py

@@ -74,23 +74,23 @@ def matcher(pattern):
 
     requests_mock.post(
         box_api_url,
-        json={"result": NETWORK_INFO},
+        json={"jsonrpc": "2.0", "result": NETWORK_INFO, "id": "1"},
         additional_matcher=matcher("GetNetworkInfo"),
     )
     requests_mock.post(
         box_api_url,
-        json={"result": SYSTEM_STATUS},
+        json={"jsonrpc": "2.0", "result": SYSTEM_STATUS, "id": "2"},
         additional_matcher=matcher("GetSystemStatus"),
     )
     requests_mock.post(
         box_api_url,
-        json={"result": USAGE_RECORD},
+        json={"jsonrpc": "2.0", "result": USAGE_RECORD, "id": "3"},
         additional_matcher=matcher("GetUsageRecord"),
     )
 
     # Do a metrics update
     router_metrics = RouterMetrics("", box_addr, 10)
-    router_metrics.fetch_new()
+    router_metrics.fetch_metrics()
 
     # Compare with expectations
     assert REGISTRY.get_sample_value("sinr") == pytest.approx(