add get_version endpoint (#249)

* add get_version endpoint * fix most tests * format * fix client api mocking * change version for mat clients --------- Co-authored-by: Ben Pedigo <benjamindpedigo@gmail.com>
CAVEconnectome · Oct 15, 2024 · f2924e5 · f2924e5
1 parent cc1d9cf
commit f2924e5
Show file tree

Hide file tree

Showing 5 changed files with 45 additions and 28 deletions.
diff --git a/caveclient/endpoints.py b/caveclient/endpoints.py
@@ -32,7 +32,8 @@
 # -------------------------------
 
 materialization_common = {
-    "get_api_versions": "{me_server_address}/materialize/api/versions"
+    "get_api_versions": "{me_server_address}/materialize/api/versions",
+    "get_version": "{me_server_address}/materialize/version",
 }
 mat_v2_api = "{me_server_address}/materialize/api/v2"
 mat_v3_api = "{me_server_address}/materialize/api/v3"

diff --git a/caveclient/materializationengine.py b/caveclient/materializationengine.py
@@ -630,10 +630,10 @@ def _resolve_merge_reference(
 
     @_check_version_compatibility(
         kwarg_use_constraints={
-            "filter_greater_dict": ">=4.34.0",
-            "filter_less_dict": ">=4.34.0",
-            "filter_greater_equal_dict": ">=4.34.0",
-            "filter_less_equal_dict": ">=4.34.0",
+            "filter_greater_dict": ">=4.34.3",
+            "filter_less_dict": ">=4.34.3",
+            "filter_greater_equal_dict": ">=4.34.3",
+            "filter_less_equal_dict": ">=4.34.3",
         }
     )
     def query_table(
@@ -866,10 +866,10 @@ def query_table(
 
     @_check_version_compatibility(
         kwarg_use_constraints={
-            "filter_greater_dict": ">=4.34.0",
-            "filter_less_dict": ">=4.34.0",
-            "filter_greater_equal_dict": ">=4.34.0",
-            "filter_less_equal_dict": ">=4.34.0",
+            "filter_greater_dict": ">=4.34.3",
+            "filter_less_dict": ">=4.34.3",
+            "filter_greater_equal_dict": ">=4.34.3",
+            "filter_less_equal_dict": ">=4.34.3",
         }
     )
     def join_query(
@@ -1279,10 +1279,10 @@ def lookup_supervoxel_ids(
 
     @_check_version_compatibility(
         kwarg_use_constraints={
-            "filter_greater_dict": ">=4.34.0",
-            "filter_less_dict": ">=4.34.0",
-            "filter_greater_equal_dict": ">=4.34.0",
-            "filter_less_equal_dict": ">=4.34.0",
+            "filter_greater_dict": ">=4.34.3",
+            "filter_less_dict": ">=4.34.3",
+            "filter_greater_equal_dict": ">=4.34.3",
+            "filter_less_equal_dict": ">=4.34.3",
         }
     )
     def live_query(
@@ -1901,10 +1901,10 @@ def get_tables_metadata(
 
     @_check_version_compatibility(
         kwarg_use_constraints={
-            "filter_greater_dict": ">=4.34.0",
-            "filter_less_dict": ">=4.34.0",
-            "filter_greater_equal_dict": ">=4.34.0",
-            "filter_less_equal_dict": ">=4.34.0",
+            "filter_greater_dict": ">=4.34.3",
+            "filter_less_dict": ">=4.34.3",
+            "filter_greater_equal_dict": ">=4.34.3",
+            "filter_less_equal_dict": ">=4.34.3",
         },
         kwarg_use_api_constraints={
             "filter_regex_dict": ">=3.0.0",
@@ -2347,10 +2347,10 @@ def get_view_schemas(
     @_check_version_compatibility(
         method_api_constraint=">=3.0.0",
         kwarg_use_constraints={
-            "filter_greater_dict": ">=4.34.0",
-            "filter_less_dict": ">=4.34.0",
-            "filter_greater_equal_dict": ">=4.34.0",
-            "filter_less_equal_dict": ">=4.34.0",
+            "filter_greater_dict": ">=4.34.3",
+            "filter_less_dict": ">=4.34.3",
+            "filter_greater_equal_dict": ">=4.34.3",
+            "filter_less_equal_dict": ">=4.34.3",
         },
     )
     def query_view(

diff --git a/tests/conftest.py b/tests/conftest.py
@@ -46,9 +46,12 @@ def myclient():
     # narrowly scoped to this function
     version_url = f"{TEST_LOCAL_SERVER}/segmentation/api/version"
     responses.add(responses.GET, version_url, json="2.15.0", status=200)
-
     client.chunkedgraph  # this will trigger the version check
 
+    mat_version_url = f"{TEST_LOCAL_SERVER}/materialize/version"
+    responses.add(responses.GET, mat_version_url, json="4.30.1", status=200)
+    client.materialize
+
     return client
 
 

diff --git a/tests/test_framework.py b/tests/test_framework.py
@@ -47,16 +47,20 @@ def test_create_versioned_client(self):
         endpoint_mapping = self.default_mapping
         endpoint_mapping["emas_server_address"] = TEST_GLOBAL_SERVER
 
-        print(endpoints.chunkedgraph_endpoints_common.keys())
         api_versions_url = endpoints.chunkedgraph_endpoints_common[
             "get_api_versions"
         ].format_map(endpoint_mapping)
         responses.add(responses.GET, url=api_versions_url, json=[0, 1], status=200)
 
-        version_url = endpoints.chunkedgraph_endpoints_common["get_version"].format_map(
+        cg_version_url = endpoints.chunkedgraph_endpoints_common[
+            "get_version"
+        ].format_map(endpoint_mapping)
+        responses.add(responses.GET, cg_version_url, json="2.15.0", status=200)
+
+        mat_version_url = endpoints.materialization_common["get_version"].format_map(
             endpoint_mapping
         )
-        responses.add(responses.GET, version_url, json="2.15.0", status=200)
+        responses.add(responses.GET, mat_version_url, json="4.30.1", status=200)
 
         responses.add(
             responses.GET,

diff --git a/tests/test_materialization.py b/tests/test_materialization.py
@@ -320,9 +320,15 @@ class TestMatclient:
     @responses.activate
     def test_matclient_v3_tableinterface(self, myclient, mocker):
         myclient = copy.deepcopy(myclient)
+        myclient._materialize = None
         endpoint_mapping = self.default_mapping
         endpoint_mapping["emas_server_address"] = TEST_GLOBAL_SERVER
 
+        mat_version_url = materialization_common["get_version"].format_map(
+            endpoint_mapping
+        )
+        responses.add(responses.GET, mat_version_url, json="4.30.1", status=200)
+
         api_versions_url = chunkedgraph_endpoints_common["get_api_versions"].format_map(
             endpoint_mapping
         )
@@ -333,6 +339,7 @@ def test_matclient_v3_tableinterface(self, myclient, mocker):
             json=[3],
             status=200,
         )
+        myclient.materialize  # done here to trigger version check
 
         versionurl = materialization_endpoints_v3["versions"].format_map(
             endpoint_mapping
@@ -379,7 +386,7 @@ def test_matclient_v3_tableinterface(self, myclient, mocker):
         responses.add(
             responses.GET, url=get_views_schema_url, json=self.views_schema, status=200
         )
-
+        print(len(myclient.materialize.tables))
         assert len(myclient.materialize.tables) == 2
         qry = myclient.materialize.tables.allen_column_mtypes_v2(
             pt_root_id=[123, 456], target_id=271700
@@ -800,8 +807,10 @@ def mock_get_root_timestamps(self, root_ids):
         new_xyz = np.vstack(df.ctr_pt_position.values)
         assert np.all(new_xyz == orig_xyz * [4, 4, 40])
 
-        myclient._materialize = None
-        myclient.desired_resolution = [1, 1, 1]
+        # NOTE: this messed up the mock on the version endpoint
+        # myclient._materialize = None
+        # myclient.desired_resolution = [1, 1, 1]
+        myclient._materialize.desired_resolution = [1, 1, 1]
         df = myclient.materialize.query_table(
             test_info["synapse_table"],
             filter_in_dict={"pre_pt_root_id": [500]},