feat: set x-request-id as error trace

Author: ricellis

ibmcloudant/cloudant_base_service.py

@@ -160,7 +160,10 @@ def _error_response_hook(response:Response, *args, **kwargs) -> Optional[Respons
                             error_json['errors'] = [error_model]
                             send_augmented_response = True
                     if 'errors' in error_json:
-                        trace = response.headers.get('x-couch-request-id')
+                        # Get the x-request-id header if available
+                        # otherwise try the x-couch-request-id header
+                        trace = response.headers.get('x-request-id',
+                                    response.headers.get('x-couch-request-id'))
                         if trace is not None:
                             # Augment trace if there was a value
                             error_json['trace'] = trace

test/unit/test_cloudant_base_error_augment.py

@@ -231,6 +231,31 @@ def test_augment_error_reason_with_trace(self):
             }
         )
 
+    def test_augment_error_reason_with_trace_request_id(self):
+        self._run_test(
+            mock_response={
+                'body': self._error_reason_body,
+                'headers': self._content_type_header | {'x-request-id': self._req_id},
+                'status': 444
+            },
+            expected_response={
+                'body': self._error_reason_body | self._errors_error_reason | self._trace
+            }
+        )
+
+    def test_augment_error_reason_with_trace_request_id_preferred(self):
+        expected_req_id = 'preferred_req_id'
+        self._run_test(
+            mock_response={
+                'body': self._error_reason_body,
+                'headers': self._default_mock_headers | {'x-request-id': expected_req_id},
+                'status': 444
+            },
+            expected_response={
+                'body': self._error_reason_body | self._errors_error_reason | {'trace': expected_req_id}
+            }
+        )
+
     def test_augment_error_reason_stream(self):
         self._run_test(
             mock_response={