fix: list relations should not swallow errors

Author: evansims

CHANGELOG.md

@@ -1,9 +1,10 @@
 # Changelog
 
-## [Unreleased](https://github.com/openfga/python-sdk/compare/v0.9.2...HEAD)
+## [Unreleased](https://github.com/openfga/python-sdk/compare/v0.9.3...HEAD)
 
 ### [0.9.3](https://github.com/openfga/python-sdk/compare/v0.9.2...v0.9.3) (2025-03-26)
 
+- fix: ListRelations should not swallow errors (#183)
 - feat: feat: support List Stores name filter (#181)
 - fix: urllib3 compatibility < v2 (#179)
 

openfga_sdk/client/client.py

@@ -144,6 +144,13 @@ def options_to_transaction_info(
     return WriteTransactionOpts()
 
 
+def _check_errored(response: ClientBatchCheckClientResponse):
+    """
+    Helper function to return whether the response is errored
+    """
+    return response.error is not None
+
+
 def _check_allowed(response: ClientBatchCheckClientResponse):
     """
     Helper function to return whether the response is check is allowed
@@ -972,6 +979,13 @@ async def list_relations(
             for i in body.relations
         ]
         result = await self.client_batch_check(request_body, options)
+
+        # filter out any errored responses and raise the first error
+        errored_result_iterator = filter(_check_errored, result)
+        errored_result_list = list(errored_result_iterator)
+        if len(errored_result_list) > 0:
+            raise errored_result_list[0].error
+
         # need to filter with the allowed response
         result_iterator = filter(_check_allowed, result)
         result_list = list(result_iterator)

openfga_sdk/sync/client/client.py

@@ -145,6 +145,13 @@ def options_to_transaction_info(
     return WriteTransactionOpts()
 
 
+def _check_errored(response: ClientBatchCheckClientResponse):
+    """
+    Helper function to return whether the response is errored
+    """
+    return response.error is not None
+
+
 def _check_allowed(response: ClientBatchCheckClientResponse):
     """
     Helper function to return whether the response is check is allowed
@@ -971,6 +978,13 @@ def list_relations(
             for i in body.relations
         ]
         result = self.client_batch_check(request_body, options)
+
+        # filter out any errored responses and raise the first error
+        errored_result_iterator = filter(_check_errored, result)
+        errored_result_list = list(errored_result_iterator)
+        if len(errored_result_list) > 0:
+            raise errored_result_list[0].error
+
         # need to filter with the allowed response
         result_iterator = filter(_check_allowed, result)
         result_list = list(result_iterator)

test/client/client_test.py

@@ -2875,6 +2875,27 @@ async def test_list_relations_unauthorized(self, mock_request):
             mock_request.assert_called()
             await api_client.close()
 
+    @patch.object(rest.RESTClientObject, "request")
+    async def test_list_relations_errored(self, mock_request):
+        """Test case for list relations with undefined exception"""
+
+        mock_request.side_effect = ValueError()
+        configuration = self.configuration
+        configuration.store_id = store_id
+        async with OpenFgaClient(configuration) as api_client:
+            with self.assertRaises(ValueError):
+                await api_client.list_relations(
+                    body=ClientListRelationsRequest(
+                        user="user:81684243-9356-4421-8fbf-a4f8d36aa31b",
+                        relations=["reader", "owner", "viewer"],
+                        object="document:2021-budget",
+                    ),
+                    options={"authorization_model_id": "01GXSA8YR785C4FYS3C0RTG7B1"},
+                )
+
+            mock_request.assert_called()
+            await api_client.close()
+
     @patch.object(rest.RESTClientObject, "request")
     async def test_list_users(self, mock_request):
         """

test/sync/client/client_test.py

@@ -2878,6 +2878,27 @@ def test_list_relations_unauthorized(self, mock_request):
             mock_request.assert_called()
             api_client.close()
 
+    @patch.object(rest.RESTClientObject, "request")
+    def test_list_relations_errored(self, mock_request):
+        """Test case for list relations with undefined exception"""
+
+        mock_request.side_effect = ValueError()
+        configuration = self.configuration
+        configuration.store_id = store_id
+        with OpenFgaClient(configuration) as api_client:
+            with self.assertRaises(ValueError):
+                api_client.list_relations(
+                    body=ClientListRelationsRequest(
+                        user="user:81684243-9356-4421-8fbf-a4f8d36aa31b",
+                        relations=["reader", "owner", "viewer"],
+                        object="document:2021-budget",
+                    ),
+                    options={"authorization_model_id": "01GXSA8YR785C4FYS3C0RTG7B1"},
+                )
+
+            mock_request.assert_called()
+            api_client.close()
+
     @patch.object(rest.RESTClientObject, "request")
     def test_list_users(self, mock_request):
         """