pyrelukko 0.2.0__py3-none-any.whl → 0.4.0__py3-none-any.whl

pyrelukko/pyrelukko.py

@@ -33,9 +33,18 @@ RETRY_KWARGS = [
     'delay',
     'backoff',
     'max_delay',
-    'exceptions'
+    'exceptions',
 ]
 
+OWN_KWARGS = [
+    'acquire_wait_for_timeout',
+    'acquire_modulo',
+    'ws_ping_interval',
+    'ws_ping_timeout',
+    'ws_wait_for_timeout',
+]
+OWN_KWARGS.extend(RETRY_KWARGS)
+
 logger = logging.getLogger(__name__)
 
 
@@ -66,7 +75,12 @@ class RelukkoClient:
         )
         self._setup_session(api_key, **kwargs)
         self._setup_http_adapters_retry(**kwargs)
-        self._setup_pyrelukko_retry(**kwargs)
+        self.ws_wait_for_timeout = 2
+        self.ws_ping_interval = 60
+        self.ws_ping_timeout = 20
+        self.acquire_wait_for_timeout = 2
+        self.acquire_modulo = 100
+        self._setup_pyrelukko_kwargs(**kwargs)
 
         self.base_url = self._setup_base_url(base_url)
         self.ws_url = self._setup_ws_url(str(self.base_url))
@@ -90,10 +104,10 @@ class RelukkoClient:
         self.base_url = self._setup_base_url(base_url or self.base_url)
         self.ws_url = self._setup_ws_url(str(self.base_url))
         self._setup_ssl_ctx(**kwargs)
-        self._setup_pyrelukko_retry(**kwargs)
+        self._setup_pyrelukko_kwargs(**kwargs)
 
-    def _setup_pyrelukko_retry(self, **kwargs):
-        for kwarg in RETRY_KWARGS:
+    def _setup_pyrelukko_kwargs(self, **kwargs):
+        for kwarg in OWN_KWARGS:
             setattr(
                 self,
                 kwarg,
@@ -151,7 +165,7 @@ class RelukkoClient:
 
     def _setup_ws_url(self, ws_url: str) -> Url:
         url = ws_url.replace("http", "ws", 1)
-        return parse_url(f"{url}/deletions")
+        return parse_url(f"{url}/ws/broadcast")
 
     def _setup_base_url(self, base_url: Union[Url, str]) -> Url:
         if isinstance(base_url, str):
@@ -174,14 +188,17 @@ class RelukkoClient:
             additional_headers=additional_headers,
             ssl=self.ssl_ctx,
             logger=logger,
+            ping_interval=self.ws_ping_interval,
+            ping_timeout=self.ws_ping_timeout,
         ) as websocket:
             while self.ws_running.is_set():
                 try:
-                    ws_message = await asyncio.wait_for(websocket.recv(), timeout=2)
+                    ws_message = await asyncio.wait_for(
+                        websocket.recv(), timeout=self.ws_wait_for_timeout)
                     if ws_message:
                         logger.debug("Received message: '%s'", ws_message)
                         msg: Dict = json.loads(ws_message)
-                        if msg.get('deletions'):
+                        if msg.get('deleted'):
                             # Signal the HTTP thread to wake up
                             self.message_received.set()
                 except TimeoutError:
@@ -199,19 +216,25 @@ class RelukkoClient:
         """
 
         start_time = time.time()
-
+        loop_counter = 0
+        got_message = False
+        res = None
         while True:
             elapsed_time = time.time() - start_time
             if elapsed_time > max_run_time:
                 self.ws_running.clear()
                 _thread_store.insert(0, None)
                 return
-
-            res = self._make_request(
-                url=url, method="POST", payload=payload)
+            # If self.message_recieved is True try to get lock ASAP!
+            # Otherwise only in every Xth run in case websocket broke.
+            if got_message or loop_counter % self.acquire_modulo == 0:
+                res = self._make_request(
+                    url=url, method="POST", payload=payload)
+            loop_counter += 1
             if res is None:
                 # Conflict 409
-                self.message_received.wait(timeout=30)
+                got_message = self.message_received.wait(
+                    timeout=self.acquire_wait_for_timeout)
                 self.message_received.clear()
             else:
                 _thread_store.insert(0, res)
@@ -277,7 +300,8 @@ class RelukkoClient:
 
         thread_store = []
         http_thread = threading.Thread(
-            target=self._acquire_relukko, args=(url, max_run_time, payload, thread_store))
+            target=self._acquire_relukko,
+            args=(url, max_run_time, payload, thread_store))
         http_thread.start()
         http_thread.join()
         self.ws_listener.join()

pyrelukko/testcontainers.py

@@ -0,0 +1,86 @@
+# pylint: skip-file
+"""
+Testcontainers to be used in PyTests, for a fixture see tests/conftest.py
+(relukko_backend):
+
+@pytest.fixture(scope="session")
+def relukko_backend():
+    with Network() as rl_net:
+        with RelukkoDbContainer(net=rl_net,
+            image="postgres:16", hostname="relukkodb") as _db:
+            db_url = "postgresql://relukko:relukko@relukkodb/relukko"
+            with RelukkoContainer(rl_net, db_url=db_url) as backend:
+                relukko = RelukkoClient(
+                    base_url=backend.get_api_url(), api_key="somekey")
+                yield relukko, backend
+"""
+import socket
+
+from testcontainers.core.network import Network
+from testcontainers.core.waiting_utils import wait_container_is_ready
+from testcontainers.generic import ServerContainer
+from testcontainers.postgres import PostgresContainer
+
+
+class RelukkoContainer(ServerContainer):
+    def __init__(self, net: Network,
+                 image="registry.gitlab.com/relukko/relukko:latest", db_url=None):
+        self.db_url = db_url
+        self.net = net
+        super(RelukkoContainer, self).__init__(image=image, port=3000)
+
+    def _configure(self):
+        self.with_env("DATABASE_URL", self.db_url)
+        self.with_env("RELUKKO_API_KEY", "somekey")
+        self.with_env("RELUKKO_USER", "relukko")
+        self.with_env("RELUKKO_PASSWORD", "relukko")
+        self.with_env("RELUKKO_BIND_ADDR", "0.0.0.0")
+        self.with_network(self.net)
+
+    def get_api_url(self) -> str:
+        return f"http://localhost:{self.get_exposed_port(3000)}"
+
+    def _create_connection_url(self) -> str:
+        return f"{self.get_api_url()}/healthchecker"
+
+
+class RelukkoDbContainer(PostgresContainer):
+    def __init__(
+            self, net: Network,
+            image: str = "postgres:latest",
+            port: int = 5432,
+            username: str | None = None,
+            password: str | None = None,
+            dbname: str | None = None,
+            driver: str | None = "psycopg2",
+            **kwargs) -> None:
+        self.net = net
+        super().__init__(image, port, username, password, dbname, driver, **kwargs)
+
+    def _configure(self) -> None:
+        self.with_env("POSTGRES_USER", "relukko")
+        self.with_env("POSTGRES_PASSWORD", "relukko")
+        self.with_env("POSTGRES_DB", "relukko")
+        self.with_network(self.net)
+
+    @wait_container_is_ready()
+    def _connect(self) -> None:
+        packet = bytes([
+            0x00, 0x00, 0x00, 0x52, 0x00, 0x03, 0x00, 0x00, 
+            0x75, 0x73, 0x65, 0x72, 0x00, 0x72, 0x65, 0x6c, 
+            0x75, 0x6b, 0x6b, 0x6f, 0x00, 0x64, 0x61, 0x74, 
+            0x61, 0x62, 0x61, 0x73, 0x65, 0x00, 0x72, 0x65, 
+            0x6c, 0x75, 0x6b, 0x6b, 0x6f, 0x00, 0x61, 0x70, 
+            0x70, 0x6c, 0x69, 0x63, 0x61, 0x74, 0x69, 0x6f, 
+            0x6e, 0x5f, 0x6e, 0x61, 0x6d, 0x65, 0x00, 0x70, 
+            0x73, 0x71, 0x6c, 0x00, 0x63, 0x6c, 0x69, 0x65, 
+            0x6e, 0x74, 0x5f, 0x65, 0x6e, 0x63, 0x6f, 0x64, 
+            0x69, 0x6e, 0x67, 0x00, 0x55, 0x54, 0x46, 0x38, 
+            0x00, 0x00
+        ])
+        port = self.get_exposed_port(self.port)
+        with socket.create_connection(("localhost", port)) as sock:
+            sock.send(packet)
+            buf = sock.recv(40)
+            if len(buf) == 0 and "SCRAM-SHA" not in buf:
+                raise ConnectionError

pyrelukko/version.py

@@ -1,2 +1,2 @@
 # pylint: disable=all
-__version__ = "0.2.0"
+__version__ = "0.4.0"

{pyrelukko-0.2.0.dist-info → pyrelukko-0.4.0.dist-info}/METADATA

@@ -1,16 +1,21 @@
 Metadata-Version: 2.3
 Name: pyrelukko
-Version: 0.2.0
+Version: 0.4.0
 Summary: Relukko client.
 Author-email: Reto Zingg <g.d0b3rm4n@gmail.com>
-Requires-Python: >=3.12
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 Classifier: Development Status :: 3 - Alpha
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Topic :: Internet :: WWW/HTTP
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Requires-Dist: requests >=2.32.3
+Requires-Dist: websockets >= 13.1
 Project-URL: Homepage, https://gitlab.com/relukko/pyrelukko
 Project-URL: Issues, https://gitlab.com/relukko/pyrelukko/-/issues
 

pyrelukko-0.4.0.dist-info/RECORD

@@ -0,0 +1,9 @@
+pyrelukko/__init__.py,sha256=n-mTJV7AOfr4bljtDxok3E3gXIBRk-kFa2_Ql3S8Ht0,61
+pyrelukko/pyrelukko.py,sha256=8ea0t-qoQqoP7K1BZ6iaDk2ZSsBxuY3J_Z24P8PdJdY,12335
+pyrelukko/retry.py,sha256=XeCc0trPhAggdEnu2nwtpFderlHaDQFTXH_O1dLeiGQ,1587
+pyrelukko/testcontainers.py,sha256=mSUfnyBFVmt9N9LoI_EwXG4EomY8pQCvHzff2ESio-8,3354
+pyrelukko/version.py,sha256=pIAXZHS0AKfM9TgvQfXXvE9frJxGVMYpEYyLdg5iaGQ,44
+pyrelukko-0.4.0.dist-info/LICENSE,sha256=aEI4dThWmRUiEPch0-KaZQmHZgTyuz88Edmp25H6tAw,1089
+pyrelukko-0.4.0.dist-info/WHEEL,sha256=CpUCUxeHQbRN5UGRQHYRJorO5Af-Qy_fHMctcQ8DSGI,82
+pyrelukko-0.4.0.dist-info/METADATA,sha256=DwdoXKmelYcvpI7OFwvl2tRvPdzXIhFiM5VxlptyBxw,939
+pyrelukko-0.4.0.dist-info/RECORD,,

pyrelukko-0.2.0.dist-info/RECORD

@@ -1,8 +0,0 @@
-pyrelukko/__init__.py,sha256=n-mTJV7AOfr4bljtDxok3E3gXIBRk-kFa2_Ql3S8Ht0,61
-pyrelukko/pyrelukko.py,sha256=5bDqueUMxbMSxbuSOE9L7aHpAP3bax4DHQqATeuHs1s,11435
-pyrelukko/retry.py,sha256=XeCc0trPhAggdEnu2nwtpFderlHaDQFTXH_O1dLeiGQ,1587
-pyrelukko/version.py,sha256=5ajVDlNTAW-Ykqh9HwJkug5LWeNtanZQhZox4hNtxio,44
-pyrelukko-0.2.0.dist-info/LICENSE,sha256=aEI4dThWmRUiEPch0-KaZQmHZgTyuz88Edmp25H6tAw,1089
-pyrelukko-0.2.0.dist-info/WHEEL,sha256=CpUCUxeHQbRN5UGRQHYRJorO5Af-Qy_fHMctcQ8DSGI,82
-pyrelukko-0.2.0.dist-info/METADATA,sha256=0tOto4sHXUD_sFAfTvC6EhV2l4NER-gNyYE66ori8TQ,701
-pyrelukko-0.2.0.dist-info/RECORD,,