Merge pull request #57 from tharropoulos/fix/node-initialization

fix: node initialization using a url string

Author: kishorenc

pytest.ini

@@ -0,0 +1,2 @@
+[pytest]
+pythonpath = src

requirements.txt

@@ -1 +1,13 @@
-requests==2.22.0
+certifi==2024.7.4
+chardet==3.0.4
+charset-normalizer==3.3.2
+idna==2.8
+iniconfig==2.0.0
+mypy==1.11.0
+mypy-extensions==1.0.0
+packaging==24.1
+pluggy==1.5.0
+pytest==8.3.2
+requests==2.32.3
+typing_extensions==4.12.2
+urllib3==2.2.2

src/typesense/configuration.py

@@ -1,19 +1,17 @@
+from typing import Literal
 from .exceptions import ConfigError
 from .logger import logger
 from urllib.parse import urlparse
 
-class Node(object):
-    def __init__(self, url):
-        parsed = urlparse(url);
-        if not parsed.hostname:
-            raise ConfigError('Node URL does not contain the host name.')
-        if not parsed.port:
-            raise ConfigError('Node URL does not contain the port.')
-        if not parsed.scheme:
-            raise ConfigError('Node URL does not contain the protocol.')
-        self.__init__(parsed.hostname, parsed.port, parsed.path, parsed.scheme)
 
-    def __init__(self, host, port, path, protocol):
+class Node(object):
+    def __init__(
+        self,
+        host: str,
+        port: str | int,
+        path: str,
+        protocol: Literal['http', 'https'] | str,
+    ):
         self.host = host
         self.port = port
         self.path = path
@@ -22,6 +20,18 @@ def __init__(self, host, port, path, protocol):
         # Used to skip bad hosts
         self.healthy = True
 
+    @classmethod
+    def from_url(cls, url: str) -> 'Node':
+        parsed = urlparse(url)
+        if not parsed.hostname:
+            raise ConfigError('Node URL does not contain the host name.')
+        if not parsed.port:
+            raise ConfigError('Node URL does not contain the port.')
+        if not parsed.scheme:
+            raise ConfigError('Node URL does not contain the protocol.')
+
+        return cls(parsed.hostname, parsed.port, parsed.path, parsed.scheme)
+
     def url(self):
         return '{0}://{1}:{2}{3}'.format(self.protocol, self.host, self.port, self.path)
 
@@ -34,7 +44,7 @@ def __init__(self, config_dict):
         self.nodes = []
         for node_config in config_dict.get('nodes', []):
             if isinstance(node_config, str):
-                node = Node(node_config)
+                node = Node.from_url(node_config)
             else:
                 node = Node(node_config['host'], node_config['port'], node_config.get('path', ''), node_config['protocol'])
             self.nodes.append(node)
@@ -43,7 +53,7 @@ def __init__(self, config_dict):
         if not nearest_node:
             self.nearest_node = None
         elif isinstance(nearest_node, str):
-            self.nearest_node = Node(nearest_node)
+            self.nearest_node = Node.from_url(nearest_node)
         else:
             self.nearest_node = Node(nearest_node['host'], nearest_node['port'], nearest_node.get('path', ''), nearest_node['protocol'])
 

tests/__init__.py

@@ -0,0 +1,41 @@
+import pytest
+
+from src.typesense.configuration import Node
+from src.typesense.exceptions import ConfigError
+
+
+def test_node_initialization():
+    node = Node(host="localhost", port=8108, path="/path", protocol="http")
+    assert node.host == "localhost"
+    assert node.port == 8108
+    assert node.path == "/path"
+    assert node.protocol == "http"
+    assert node.healthy is True
+
+
+def test_node_from_url():
+    node = Node.from_url("http://localhost:8108/path")
+    assert node.host == "localhost"
+    assert node.port == 8108
+    assert node.path == "/path"
+    assert node.protocol == "http"
+
+
+def test_node_from_url_missing_hostname():
+    with pytest.raises(ConfigError, match="Node URL does not contain the host name."):
+        Node.from_url("http://:8108/path")
+
+
+def test_node_from_url_missing_port():
+    with pytest.raises(ConfigError, match="Node URL does not contain the port."):
+        Node.from_url("http://localhost:/path")
+
+
+def test_node_from_url_missing_scheme():
+    with pytest.raises(ConfigError, match="Node URL does not contain the protocol."):
+        Node.from_url("//localhost:8108/path")
+
+
+def test_node_url():
+    node = Node(host="localhost", port=8108, path="/path", protocol="http")
+    assert node.url() == "http://localhost:8108/path"