cleanup and move the ids to be optional

Author: Max Wang

src/PowerPlatform/Dataverse/core/errors.py

@@ -141,11 +141,11 @@ class HttpError(DataverseError):
     :type subcode: :class:`str` | None
     :param service_error_code: Optional Dataverse-specific error code from the API response.
     :type service_error_code: :class:`str` | None
-    :param correlation_id: Client-generated Correlation ID for tracking requests within a SDK call.
+    :param correlation_id: Optional client-generated correlation ID for tracking requests within an SDK call.
     :type correlation_id: :class:`str` | None
-    :param client_request_id: Client-generated request ID injected into outbound headers.
+    :param client_request_id: Optional client-generated request ID injected into outbound headers.
     :type client_request_id: :class:`str` | None
-    :param service_request_id: ``x-ms-service-request-id`` returned by Dataverse servers.
+    :param service_request_id: Optional ``x-ms-service-request-id`` value returned by Dataverse servers.
     :type service_request_id: :class:`str` | None
     :param traceparent: Optional W3C trace context for distributed tracing.
     :type traceparent: :class:`str` | None
@@ -161,12 +161,12 @@ def __init__(
         self,
         message: str,
         status_code: int,
-        correlation_id: Optional[str],
-        client_request_id: Optional[str],
-        service_request_id: Optional[str],
         is_transient: bool = False,
         subcode: Optional[str] = None,
         service_error_code: Optional[str] = None,
+        correlation_id: Optional[str] = None,
+        client_request_id: Optional[str] = None,
+        service_request_id: Optional[str] = None,
         traceparent: Optional[str] = None,
         body_excerpt: Optional[str] = None,
         retry_after: Optional[int] = None,

src/PowerPlatform/Dataverse/data/_odata.py

@@ -205,11 +205,11 @@ def _request(self, method: str, url: str, *, expected: tuple[int, ...] = (200, 2
         raise HttpError(
             msg,
             status_code=sc,
+            subcode=subcode,
+            service_error_code=svc_code,
             correlation_id=merged_headers.get("x-ms-correlation-request-id"),
             client_request_id=merged_headers.get("x-ms-client-request-id"),
             service_request_id=request_id,
-            subcode=subcode,
-            service_error_code=svc_code,
             traceparent=traceparent,
             body_excerpt=body_excerpt,
             retry_after=retry_after,

tests/unit/core/test_http_errors.py

@@ -157,7 +157,12 @@ def test_correlation_id_diff_without_scope():
     assert len(recorder.recorded_headers) == 2
     h1, h2 = recorder.recorded_headers
     assert h1["x-ms-client-request-id"] != h2["x-ms-client-request-id"]
-    assert h1["x-ms-correlation-request-id"] != h2["x-ms-correlation-request-id"]
+    cid1 = h1.get("x-ms-correlation-request-id")
+    cid2 = h2.get("x-ms-correlation-request-id")
+    if cid1 is not None and cid2 is not None:
+        assert cid1 != cid2
+    else:
+        assert cid1 is cid2 is None
 
 
 def test_correlation_id_shared_inside_call_scope():