Add http/2 capabilities

* added http/2 protocol capability for sync/async clients
* modified github workflow to generate cert
* modified test code to work with generated certificate

Author: 07pepa

.github/workflows/testing.yaml

@@ -7,7 +7,7 @@ on:
   pull_request:
 env:
   UV_CACHE_DIR: /tmp/.uv-cache
-  PYTHON_VERSION: "3.9"
+  PYTHON_VERSION: "3.10"
 jobs:
   linting:
     runs-on: ubuntu-latest
@@ -63,7 +63,15 @@ jobs:
       - name: Install Dependencies
         run: just install
       - name: Test with pytest
-        run: just test-parallel-ci
+        run: |
+          sudo apt-get update && \
+          sudo apt-get install -y libnss3-tools build-essential gcc && \
+          /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" && \
+          eval "$(/home/linuxbrew/.linuxbrew/bin/brew shellenv)" && \
+          brew install mkcert && \
+          mkcert -install && \
+          mkcert -key-file meilisearch.key -cert-file meilisearch.crt localhost 127.0.0.1 ::1 && \
+          just test-parallel-ci
       - name: Upload coverage
         uses: codecov/codecov-action@v4
         with:
@@ -99,7 +107,15 @@ jobs:
       - name: Install Dependencies
         run: just install
       - name: Test with pytest
-        run: just test-no-parallel-ci
+        run: |
+          sudo apt-get update && \
+          sudo apt-get install -y libnss3-tools build-essential gcc && \
+          /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" && \
+          eval "$(/home/linuxbrew/.linuxbrew/bin/brew shellenv)" && \
+          brew install mkcert && \
+          mkcert -install && \
+          mkcert -key-file meilisearch.key -cert-file meilisearch.crt localhost 127.0.0.1 ::1 && \
+          just test-no-parallel-ci
       - name: Upload coverage
         uses: codecov/codecov-action@v4
         with:

.gitignore

@@ -1,3 +1,5 @@
+meilisearch.crt
+meilisearch.key
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]

benchmark/run_benchmark.py

@@ -103,7 +103,7 @@ def benchmark_meili_add_documents_in_batches(
 async def run_async_batch_add_benchmark(data: Sequence[JsonMapping]) -> list[float]:
     times = []
     for _ in track(range(10), description="Running async add in batches benchmark..."):
-        async with AsyncClient("http://127.0.0.1:7700", "masterKey") as client:
+        async with AsyncClient("https://127.0.0.1:7700", "masterKey", verify=False) as client:
             index = client.index("movies")
             _, time_taken = await benchmark_async_add_document_in_batches(client, data)
             times.append(time_taken)
@@ -118,7 +118,7 @@ async def run_async_batch_add_benchmark(data: Sequence[JsonMapping]) -> list[flo
 async def run_async_search_benchmark(movies_sampled: list[str]) -> list[float]:
     times = []
     for _ in track(range(10), description="Running async multi search benchmark..."):
-        async with AsyncClient("http://127.0.0.1:7700", "masterKey") as client:
+        async with AsyncClient("https://127.0.0.1:7700", "masterKey") as client:
             index = client.index("movies")
             searches = []
             for movie in movies_sampled:
@@ -145,7 +145,7 @@ async def setup_index(data: Sequence[JsonMapping]) -> None:
 def run_sync_batch_add_benchmark(data: Sequence[JsonMapping]) -> list[float]:
     times = []
     for _ in track(range(10), description="Running sync add in batches benchmark..."):
-        client = Client("http://127.0.0.1:7700", "masterKey")
+        client = Client("https://127.0.0.1:7700", "masterKey", verify=False)
         index = client.index("movies")
         _, time_taken = benchmark_sync_add_document_in_batches(client, data)
         times.append(time_taken)
@@ -158,7 +158,7 @@ def run_sync_batch_add_benchmark(data: Sequence[JsonMapping]) -> list[float]:
 
 
 def run_sync_search_benchmark(movies_sampled: list[str]) -> list[float]:
-    client = Client("http://127.0.0.1:7700", "masterKey")
+    client = Client("https://127.0.0.1:7700", "masterKey")
     index = client.index("movies")
     times = []
     for _ in track(range(10), description="Running sync multi search benchmark..."):
@@ -174,7 +174,7 @@ def run_sync_search_benchmark(movies_sampled: list[str]) -> list[float]:
 def run_meili_batch_add_benchmark(data: Sequence[JsonMapping]) -> list[float]:
     times = []
     for _ in track(range(10), description="Running meili add in batches benchmark..."):
-        client = MeilisearchClient("http://127.0.0.1:7700", "masterKey")
+        client = MeilisearchClient("https://127.0.0.1:7700", "masterKey")
         index = client.index("movies")
         _, time_taken = benchmark_meili_add_documents_in_batches(client, data)
         times.append(time_taken)
@@ -187,7 +187,7 @@ def run_meili_batch_add_benchmark(data: Sequence[JsonMapping]) -> list[float]:
 
 
 def run_meili_search_benchmark(movies_sampled: list[str]) -> list[float]:
-    client = MeilisearchClient("http://127.0.0.1:7700", "masterKey")
+    client = MeilisearchClient("https://127.0.0.1:7700", "masterKey")
     index = client.index("movies")
     times = []
     for _ in track(range(10), description="Running meili multi search benchmark..."):

docker-compose.yml

@@ -6,3 +6,7 @@ services:
     environment:
       - MEILI_MASTER_KEY=masterKey
       - MEILI_NO_ANALYTICS=true
+    volumes:
+      - ./meilisearch.key:/meilisearch.key
+      - ./meilisearch.crt:/meilisearch.crt
+    command: ["meilisearch", "--ssl-cert-path", "/meilisearch.crt", "--ssl-key-path", "/meilisearch.key"]

examples/add_documents_decorator.py

@@ -9,7 +9,7 @@
 
 @add_documents(
     index_name="movies",
-    connection_info=ConnectionInfo(url="http://127.0.0.1:7700", api_key="masterKey"),
+    connection_info=ConnectionInfo(url="https://127.0.0.1:7700", api_key="masterKey"),
 )
 def load_documents() -> list[dict[str, Any]]:
     with open("../datasets/small_movies.json") as f:

justfile

@@ -50,6 +50,7 @@
 
 @install:
   uv sync --frozen --all-extras
+  uv pip install truststore || true # truststore is not available for Python 3.9
 
 @benchmark: start-meilisearch-detached && stop-meilisearch
   -uv run benchmark/run_benchmark.py

meilisearch_python_sdk/_client.py

@@ -150,6 +150,7 @@ def __init__(
         verify: str | bool | SSLContext = True,
         custom_headers: dict[str, str] | None = None,
         json_handler: BuiltinHandler | OrjsonHandler | UjsonHandler | None = None,
+        http2: bool = False,
     ) -> None:
         """Class initializer.
 
@@ -168,11 +169,12 @@ def __init__(
                 (uses the json module from the standard library), OrjsonHandler (uses orjson), or
                 UjsonHandler (uses ujson). Note that in order use orjson or ujson the corresponding
                 extra needs to be included. Default: BuiltinHandler.
+            http2: Whether or not to use HTTP/2. Defaults to False.
         """
         super().__init__(api_key, custom_headers, json_handler)
 
         self.http_client = HttpxAsyncClient(
-            base_url=url, timeout=timeout, headers=self._headers, verify=verify
+            base_url=url, timeout=timeout, headers=self._headers, verify=verify, http2=http2
         )
         self._http_requests = AsyncHttpRequests(self.http_client, json_handler=self.json_handler)
 
@@ -1073,6 +1075,7 @@ def __init__(
         verify: str | bool | SSLContext = True,
         custom_headers: dict[str, str] | None = None,
         json_handler: BuiltinHandler | OrjsonHandler | UjsonHandler | None = None,
+        http2: bool = False,
     ) -> None:
         """Class initializer.
 
@@ -1091,12 +1094,14 @@ def __init__(
                 (uses the json module from the standard library), OrjsonHandler (uses orjson), or
                 UjsonHandler (uses ujson). Note that in order use orjson or ujson the corresponding
                 extra needs to be included. Default: BuiltinHandler.
+            http2: If set to True, the client will use HTTP/2. Defaults to False.
         """
         super().__init__(api_key, custom_headers, json_handler)
 
         self.http_client = HttpxClient(
-            base_url=url, timeout=timeout, headers=self._headers, verify=verify
+            base_url=url, timeout=timeout, headers=self._headers, verify=verify, http2=http2
         )
+
         self._http_requests = HttpRequests(self.http_client, json_handler=self.json_handler)
 
     def create_dump(self) -> TaskInfo:

meilisearch_python_sdk/decorators.py

@@ -26,6 +26,7 @@ def async_add_documents(
     batch_size: int | None = None,
     primary_key: str | None = None,
     wait_for_task: bool = False,
+    verify: bool = True,
 ) -> Callable:
     """Decorator that takes the returned documents from a function and asyncronously adds them to Meilisearch.
 
@@ -42,6 +43,7 @@ def async_add_documents(
             Defaults to None.
         wait_for_task: If set to `True` the decorator will wait for the document addition to finish
             indexing before returning, otherwise it will return right away. Default = False.
+        verify: If set to `False` the decorator will not verify the SSL certificate of the server.
 
     Returns:
 
@@ -89,7 +91,9 @@ async def wrapper(*args: Any, **kwargs: Any) -> Any:
                 )
                 return result
 
-            async with AsyncClient(connection_info.url, connection_info.api_key) as client:
+            async with AsyncClient(
+                connection_info.url, connection_info.api_key, verify=verify
+            ) as client:
                 await _async_add_documents(
                     client, index_name, result, batch_size, primary_key, wait_for_task
                 )
@@ -108,6 +112,7 @@ def add_documents(
     batch_size: int | None = None,
     primary_key: str | None = None,
     wait_for_task: bool = False,
+    verify: bool = True,
 ) -> Callable:
     """Decorator that takes the returned documents from a function and adds them to Meilisearch.
 
@@ -124,6 +129,7 @@ def add_documents(
             Defaults to None.
         wait_for_task: If set to `True` the decorator will wait for the document addition to finish
             indexing before returning, otherwise it will return right away. Default = False.
+        verify: If set to `False` the decorator will not verify the SSL certificate of the server.
 
     Returns:
 
@@ -171,7 +177,9 @@ def wrapper(*args: Any, **kwargs: Any) -> Any:
                 )
                 return result
 
-            decorator_client = Client(url=connection_info.url, api_key=connection_info.api_key)
+            decorator_client = Client(
+                url=connection_info.url, api_key=connection_info.api_key, verify=verify
+            )
             _add_documents(
                 decorator_client,
                 index_name,

pyproject.toml

@@ -27,7 +27,7 @@ dependencies = [
   "camel-converter>=1.0.0",
   # allows pydantic to use pipe instead of Union
   "eval-type-backport>=0.2.0; python_version < '3.10'",
-  "httpx>=0.17",
+  "httpx[http2]>=0.17",
   "pydantic>=2.0.0",
   "PyJWT>=2.3.0",
 ]

tests/conftest.py

@@ -1,10 +1,24 @@
 import asyncio
 import csv
 import json
+import ssl
+import sys
+from logging import warning
 from pathlib import Path
 from uuid import uuid4
 
 import pytest
+
+try:
+    import truststore
+
+    has_truststore = True
+except ImportError:
+    if sys.version_info > (3, 10):
+        warning(
+            "truststore is not installed, SSL verification will not work. run pip install truststore"
+        )
+    has_truststore = True
 from httpx import AsyncClient as HttpxAsyncClient
 
 from meilisearch_python_sdk import AsyncClient, Client
@@ -22,49 +36,62 @@
 )
 
 MASTER_KEY = "masterKey"
-BASE_URL = "http://127.0.0.1:7700"
+BASE_URL = "https://127.0.0.1:7700"
 
 ROOT_PATH = Path().absolute()
 SMALL_MOVIES_PATH = ROOT_PATH / "datasets" / "small_movies.json"
 
+_SSL_VERIFY: ssl.SSLContext | bool = (
+    truststore.SSLContext(ssl.PROTOCOL_TLS_CLIENT) if has_truststore else False
+)
+
+
+@pytest.fixture(scope="session")
+async def ssl_verify():
+    yield _SSL_VERIFY
+
 
 @pytest.fixture
 async def async_client():
-    async with AsyncClient(BASE_URL, MASTER_KEY) as client:
+    async with AsyncClient(BASE_URL, MASTER_KEY, verify=_SSL_VERIFY) as client:
         yield client
 
 
 @pytest.fixture
 async def async_client_orjson_handler():
-    async with AsyncClient(BASE_URL, MASTER_KEY, json_handler=OrjsonHandler()) as client:
+    async with AsyncClient(
+        BASE_URL, MASTER_KEY, json_handler=OrjsonHandler(), verify=_SSL_VERIFY
+    ) as client:
         yield client
 
 
 @pytest.fixture
 async def async_client_ujson_handler():
-    async with AsyncClient(BASE_URL, MASTER_KEY, json_handler=UjsonHandler()) as client:
+    async with AsyncClient(
+        BASE_URL, MASTER_KEY, json_handler=UjsonHandler(), verify=_SSL_VERIFY
+    ) as client:
         yield client
 
 
 @pytest.fixture
 async def async_client_with_plugins():
-    async with AsyncClient(BASE_URL, MASTER_KEY) as client:
+    async with AsyncClient(BASE_URL, MASTER_KEY, verify=_SSL_VERIFY) as client:
         yield client
 
 
 @pytest.fixture
 def client():
-    yield Client(BASE_URL, MASTER_KEY)
+    yield Client(BASE_URL, MASTER_KEY, verify=_SSL_VERIFY)
 
 
 @pytest.fixture
 def client_orjson_handler():
-    yield Client(BASE_URL, MASTER_KEY, json_handler=OrjsonHandler())
+    yield Client(BASE_URL, MASTER_KEY, json_handler=OrjsonHandler(), verify=_SSL_VERIFY)
 
 
 @pytest.fixture
 def client_ujson_handler():
-    yield Client(BASE_URL, MASTER_KEY, json_handler=UjsonHandler())
+    yield Client(BASE_URL, MASTER_KEY, json_handler=UjsonHandler(), verify=_SSL_VERIFY)
 
 
 @pytest.fixture(autouse=True)
@@ -254,7 +281,7 @@ async def default_search_key(async_client):
 @pytest.fixture(scope="session", autouse=True)
 async def enable_vector_search():
     async with HttpxAsyncClient(
-        base_url=BASE_URL, headers={"Authorization": f"Bearer {MASTER_KEY}"}
+        base_url=BASE_URL, headers={"Authorization": f"Bearer {MASTER_KEY}"}, verify=_SSL_VERIFY
     ) as client:
         await client.patch("/experimental-features", json={"vectorStore": True})
         yield
@@ -263,7 +290,7 @@ async def enable_vector_search():
 @pytest.fixture(scope="session", autouse=True)
 async def enable_edit_by_function():
     async with HttpxAsyncClient(
-        base_url=BASE_URL, headers={"Authorization": f"Bearer {MASTER_KEY}"}
+        base_url=BASE_URL, headers={"Authorization": f"Bearer {MASTER_KEY}"}, verify=_SSL_VERIFY
     ) as client:
         await client.patch("/experimental-features", json={"editDocumentsByFunction": True})
         yield