ci: upgrade typesense version to v30 on ci

Author: tharropoulos

.github/workflows/test-and-lint.yml

@@ -12,22 +12,24 @@ jobs:
     strategy:
       matrix:
         python-version: ["3.9", "3.10", "3.11", "3.12"]
-    services:
-      typesense:
-        image: typesense/typesense:28.0
-        ports:
-          - 8108:8108
-        volumes:
-          - /tmp/typesense-data:/data
-          - /tmp/typesense-analytics:/analytics
-        env:
-          TYPESENSE_API_KEY: xyz
-          TYPESENSE_DATA_DIR: /data
-          TYPESENSE_ENABLE_CORS: true
-          TYPESENSE_ANALYTICS_DIR: /analytics
-          TYPESENSE_ENABLE_SEARCH_ANALYTICS: true
 
     steps:
+    - name: Start Typesense
+      run: |
+        docker run -d \
+        -p 8108:8108 \
+        --name typesense \
+        -v /tmp/typesense-data:/data \
+        -v /tmp/typesense-analytics-data:/analytics-data \
+        typesense/typesense:30.0.alpha1 \
+        --api-key=xyz \
+        --data-dir=/data \
+        --enable-search-analytics=true \
+        --analytics-dir=/analytics-data \
+        --analytics-flush-interval=60 \
+        --analytics-minute-rate-limit=50 \
+        --enable-cors
+
     - name: Wait for Typesense
       run: |
         timeout 20 bash -c 'while [[ "$(curl -s -o /dev/null -w ''%{http_code}'' localhost:8108/health)" != "200" ]]; do sleep 1; done' || false

tests/analytics_events_test.py

@@ -1,27 +1,33 @@
 """Tests for Analytics events endpoints (client.analytics.events)."""
+
 from __future__ import annotations
 
 import pytest
+import requests_mock
 
 from tests.utils.version import is_v30_or_above
 from typesense.client import Client
-import requests_mock
-
 from typesense.types.analytics import AnalyticsEvent
 
-
 pytestmark = pytest.mark.skipif(
     not is_v30_or_above(
-        Client({
-            "api_key": "xyz",
-            "nodes": [{"host": "localhost", "port": 8108, "protocol": "http"}],
-        })
+        Client(
+            {
+                "api_key": "xyz",
+                "nodes": [{"host": "localhost", "port": 8108, "protocol": "http"}],
+            }
+        )
     ),
     reason="Run analytics events tests only on v30+",
 )
 
 
-def test_actual_create_event(actual_client: Client, delete_all: None, create_collection: None, delete_all_analytics_rules: None) -> None:
+def test_actual_create_event(
+    actual_client: Client,
+    delete_all: None,
+    create_collection: None,
+    delete_all_analytics_rules: None,
+) -> None:
     actual_client.analytics.rules.create(
         {
             "name": "company_analytics_rule",
@@ -61,7 +67,9 @@ def test_status(actual_client: Client, delete_all: None) -> None:
     assert isinstance(status, dict)
 
 
-def test_retrieve_events(actual_client: Client, delete_all: None, delete_all_analytics_rules: None) -> None:
+def test_retrieve_events(
+    actual_client: Client, delete_all: None, delete_all_analytics_rules: None
+) -> None:
     actual_client.analytics.rules.create(
         {
             "name": "company_analytics_rule",
@@ -89,19 +97,12 @@ def test_retrieve_events(actual_client: Client, delete_all: None, delete_all_ana
     assert "events" in result
 
 
-
-def test_retrieve_events(fake_client: Client) -> None:
-    with requests_mock.Mocker() as mock:
-        mock.get(
-            "http://nearest:8108/analytics/events",
-            json={"events": [{"name": "company_analytics_rule"}]},
-        )
-        result = fake_client.analytics.events.retrieve(
-            user_id="user-1", name="company_analytics_rule", n=10
-        )
-        assert "events" in result
-
-def test_acutal_retrieve_events(actual_client: Client, delete_all: None, create_collection: None, delete_all_analytics_rules: None) -> None:
+def test_acutal_retrieve_events(
+    actual_client: Client,
+    delete_all: None,
+    create_collection: None,
+    delete_all_analytics_rules: None,
+) -> None:
     actual_client.analytics.rules.create(
         {
             "name": "company_analytics_rule",
@@ -126,6 +127,7 @@ def test_acutal_retrieve_events(actual_client: Client, delete_all: None, create_
     )
     assert "events" in result
 
+
 def test_acutal_flush(actual_client: Client, delete_all: None) -> None:
     resp = actual_client.analytics.events.flush()
     assert resp["ok"] in [True, False]
@@ -136,5 +138,3 @@ def test_flush(fake_client: Client) -> None:
         mock.post("http://nearest:8108/analytics/flush", json={"ok": True})
         resp = fake_client.analytics.events.flush()
         assert resp["ok"] is True
-
-

tests/analytics_rule_test.py

@@ -1,4 +1,5 @@
 """Unit tests for per-rule AnalyticsRule operations."""
+
 from __future__ import annotations
 
 import pytest
@@ -12,10 +13,12 @@
 
 pytestmark = pytest.mark.skipif(
     not is_v30_or_above(
-        Client({
-            "api_key": "xyz",
-            "nodes": [{"host": "localhost", "port": 8108, "protocol": "http"}],
-        })
+        Client(
+            {
+                "api_key": "xyz",
+                "nodes": [{"host": "localhost", "port": 8108, "protocol": "http"}],
+            }
+        )
     ),
     reason="Run analytics tests only on v30+",
 )
@@ -63,5 +66,3 @@ def test_actual_rule_delete(
 ) -> None:
     resp = actual_analytics_rules["company_analytics_rule"].delete()
     assert resp["name"] == "company_analytics_rule"
-
-

tests/analytics_rule_v1_test.py

@@ -1,4 +1,5 @@
 """Tests for the AnalyticsRuleV1 class."""
+
 from __future__ import annotations
 
 import pytest
@@ -14,14 +15,17 @@
 
 pytestmark = pytest.mark.skipif(
     is_v30_or_above(
-        Client({
-            "api_key": "xyz",
-            "nodes": [{"host": "localhost", "port": 8108, "protocol": "http"}],
-        })
+        Client(
+            {
+                "api_key": "xyz",
+                "nodes": [{"host": "localhost", "port": 8108, "protocol": "http"}],
+            }
+        )
     ),
-    reason="Skip AnalyticsV1 tests on v30+"
+    reason="Skip AnalyticsV1 tests on v30+",
 )
 
+
 def test_init(fake_api_call: ApiCall) -> None:
     """Test that the AnalyticsRuleV1 object is initialized correctly."""
     analytics_rule = AnalyticsRuleV1(fake_api_call, "company_analytics_rule")
@@ -42,7 +46,6 @@ def test_init(fake_api_call: ApiCall) -> None:
     )
 
 
-
 def test_retrieve(fake_analytics_rule: AnalyticsRuleV1) -> None:
     """Test that the AnalyticsRuleV1 object can retrieve an analytics_rule."""
     json_response: RuleSchemaForQueries = {
@@ -73,7 +76,6 @@ def test_retrieve(fake_analytics_rule: AnalyticsRuleV1) -> None:
         assert response == json_response
 
 
-
 def test_delete(fake_analytics_rule: AnalyticsRuleV1) -> None:
     """Test that the AnalyticsRuleV1 object can delete an analytics_rule."""
     json_response: RuleDeleteSchema = {
@@ -96,7 +98,6 @@ def test_delete(fake_analytics_rule: AnalyticsRuleV1) -> None:
         assert response == json_response
 
 
-
 def test_actual_retrieve(
     actual_analytics_rules: AnalyticsRulesV1,
     delete_all: None,
@@ -119,7 +120,6 @@ def test_actual_retrieve(
     assert response == expected
 
 
-
 def test_actual_delete(
     actual_analytics_rules: AnalyticsRulesV1,
     delete_all: None,
@@ -133,5 +133,3 @@ def test_actual_delete(
         "name": "company_analytics_rule",
     }
     assert response == expected
-
-

tests/analytics_rules_test.py

@@ -1,4 +1,5 @@
 """Tests for v30 Analytics Rules endpoints (client.analytics.rules)."""
+
 from __future__ import annotations
 
 import pytest
@@ -13,10 +14,12 @@
 
 pytestmark = pytest.mark.skipif(
     not is_v30_or_above(
-        Client({
-            "api_key": "xyz",
-            "nodes": [{"host": "localhost", "port": 8108, "protocol": "http"}],
-        })
+        Client(
+            {
+                "api_key": "xyz",
+                "nodes": [{"host": "localhost", "port": 8108, "protocol": "http"}],
+            }
+        )
     ),
     reason="Run v30 analytics tests only on v30+",
 )
@@ -130,5 +133,3 @@ def test_actual_retrieve(
     rules = actual_analytics_rules.retrieve()
     assert isinstance(rules, list)
     assert any(r.get("name") == "company_analytics_rule" for r in rules)
-
-

tests/analytics_rules_v1_test.py

@@ -1,4 +1,5 @@
 """Tests for the AnalyticsRulesV1 class."""
+
 from __future__ import annotations
 
 import pytest
@@ -17,14 +18,17 @@
 
 pytestmark = pytest.mark.skipif(
     is_v30_or_above(
-        Client({
-            "api_key": "xyz",
-            "nodes": [{"host": "localhost", "port": 8108, "protocol": "http"}],
-        })
+        Client(
+            {
+                "api_key": "xyz",
+                "nodes": [{"host": "localhost", "port": 8108, "protocol": "http"}],
+            }
+        )
     ),
-    reason="Skip AnalyticsV1 tests on v30+"
+    reason="Skip AnalyticsV1 tests on v30+",
 )
 
+
 def test_init(fake_api_call: ApiCall) -> None:
     """Test that the AnalyticsRulesV1 object is initialized correctly."""
     analytics_rules = AnalyticsRulesV1(fake_api_call)
@@ -150,7 +154,6 @@ def test_create(fake_analytics_rules: AnalyticsRulesV1) -> None:
         }
 
 
-
 def test_actual_create(
     actual_analytics_rules: AnalyticsRulesV1,
     delete_all: None,
@@ -182,7 +185,6 @@ def test_actual_create(
     }
 
 
-
 def test_actual_update(
     actual_analytics_rules: AnalyticsRulesV1,
     delete_all: None,
@@ -213,7 +215,6 @@ def test_actual_update(
     }
 
 
-
 def test_actual_retrieve(
     actual_analytics_rules: AnalyticsRulesV1,
     delete_all: None,
@@ -235,5 +236,3 @@ def test_actual_retrieve(
             "type": "nohits_queries",
         },
     )
-
-

tests/analytics_test.py

@@ -1,4 +1,5 @@
 """Tests for the AnalyticsV1 class."""
+
 import pytest
 from tests.utils.version import is_v30_or_above
 from typesense.client import Client
@@ -7,7 +8,17 @@
 from typesense.api_call import ApiCall
 
 
-@pytest.mark.skipif(not is_v30_or_above(Client({"api_key": "xyz", "nodes": [{"host": "localhost", "port": 8108, "protocol": "http"}]})), reason="Skip AnalyticsV1 tests on v30+")
+@pytest.mark.skipif(
+    not is_v30_or_above(
+        Client(
+            {
+                "api_key": "xyz",
+                "nodes": [{"host": "localhost", "port": 8108, "protocol": "http"}],
+            }
+        )
+    ),
+    reason="Skip AnalyticsV1 tests on v30+",
+)
 def test_init(fake_api_call: ApiCall) -> None:
     """Test that the AnalyticsV1 object is initialized correctly."""
     analytics = Analytics(fake_api_call)

tests/analytics_v1_test.py

@@ -1,4 +1,5 @@
 """Tests for the AnalyticsV1 class."""
+
 import pytest
 from tests.utils.version import is_v30_or_above
 from typesense.client import Client
@@ -7,7 +8,17 @@
 from typesense.api_call import ApiCall
 
 
-@pytest.mark.skipif(is_v30_or_above(Client({"api_key": "xyz", "nodes": [{"host": "localhost", "port": 8108, "protocol": "http"}]})), reason="Skip AnalyticsV1 tests on v30+")
+@pytest.mark.skipif(
+    is_v30_or_above(
+        Client(
+            {
+                "api_key": "xyz",
+                "nodes": [{"host": "localhost", "port": 8108, "protocol": "http"}],
+            }
+        )
+    ),
+    reason="Skip AnalyticsV1 tests on v30+",
+)
 def test_init(fake_api_call: ApiCall) -> None:
     """Test that the AnalyticsV1 object is initialized correctly."""
     analytics = AnalyticsV1(fake_api_call)
@@ -23,5 +34,3 @@ def test_init(fake_api_call: ApiCall) -> None:
     )
 
     assert not analytics.rules.rules
-
-