refactor: rename variable, improve duplicate id error message

Author: ewanharris

openfga_sdk/client/client.py

@@ -707,18 +707,20 @@ async def batch_check(self, body: ClientBatchCheckRequest, options=None):
             elif isinstance(options["max_batch_size"], int):
                 max_batch_size = options["max_batch_size"]
 
-        check_to_id: dict[str, ClientBatchCheckItem] = {}
+        id_to_check: dict[str, ClientBatchCheckItem] = {}
 
         def track_and_transform(checks):
             transformed = []
             for check in checks:
                 if check.correlation_id is None:
                     check.correlation_id = str(uuid.uuid4())
 
-                if check.correlation_id in check_to_id:
-                    raise FgaValidationException("Duplicate correlation_id provided")
+                if check.correlation_id in id_to_check:
+                    raise FgaValidationException(
+                        f"Duplicate correlation_id ({check.correlation_id}) provided"
+                    )
 
-                check_to_id[check.correlation_id] = check
+                id_to_check[check.correlation_id] = check
 
                 transformed.append(construct_batch_item(check))
             return transformed
@@ -734,7 +736,7 @@ def track_and_transform(checks):
         sem = asyncio.Semaphore(max_parallel_requests)
 
         def map_response(id, result):
-            check = check_to_id[id]
+            check = id_to_check[id]
             return ClientBatchCheckSingleResponse(
                 allowed=result.allowed,
                 request=check,

openfga_sdk/sync/client/client.py

@@ -693,18 +693,20 @@ def batch_check(self, body: ClientBatchCheckRequest, options=None):
             elif isinstance(options["max_batch_size"], int):
                 max_batch_size = options["max_batch_size"]
 
-        check_to_id: dict[str, ClientBatchCheckItem] = {}
+        id_to_check: dict[str, ClientBatchCheckItem] = {}
 
         def track_and_transform(checks):
             transformed = []
             for check in checks:
                 if check.correlation_id is None:
                     check.correlation_id = str(uuid.uuid4())
 
-                if check.correlation_id in check_to_id:
-                    raise FgaValidationException("Duplicate correlation_id provided")
+                if check.correlation_id in id_to_check:
+                    raise FgaValidationException(
+                        f"Duplicate correlation_id ({check.correlation_id}) provided"
+                    )
 
-                check_to_id[check.correlation_id] = check
+                id_to_check[check.correlation_id] = check
 
                 transformed.append(construct_batch_item(check))
             return transformed
@@ -717,7 +719,7 @@ def track_and_transform(checks):
         ]
 
         def map_response(id, result):
-            check = check_to_id[id]
+            check = id_to_check[id]
             return ClientBatchCheckSingleResponse(
                 allowed=result.allowed,
                 request=check,

test/client/client_test.py

@@ -2415,11 +2415,14 @@ async def test_batch_check_errors_dupe_cor_id(self):
         configuration = self.configuration
         configuration.store_id = store_id
         async with OpenFgaClient(configuration) as api_client:
-            with self.assertRaises(FgaValidationException):
+            with self.assertRaises(FgaValidationException) as error:
                 await api_client.batch_check(
                     body=body,
                     options={"authorization_model_id": "01GXSA8YR785C4FYS3C0RTG7B1"},
                 )
+            self.assertEqual(
+                "Duplicate correlation_id (1) provided", str(error.exception)
+            )
             await api_client.close()
 
     @patch.object(rest.RESTClientObject, "request")

test/sync/client/client_test.py

@@ -2417,11 +2417,14 @@ def test_batch_check_errors_dupe_cor_id(self):
         configuration = self.configuration
         configuration.store_id = store_id
         with OpenFgaClient(configuration) as api_client:
-            with self.assertRaises(FgaValidationException):
+            with self.assertRaises(FgaValidationException) as error:
                 api_client.batch_check(
                     body=body,
                     options={"authorization_model_id": "01GXSA8YR785C4FYS3C0RTG7B1"},
                 )
+            self.assertEqual(
+                "Duplicate correlation_id (1) provided", str(error.exception)
+            )
             api_client.close()
 
     @patch.object(rest.RESTClientObject, "request")