Add InterviewId param to EfspConnection and ProxyConnection classes

Automatically get it from the docassemble context, if that's present.

Author: BryceStevenWilley

docassemble/EFSPIntegration/efm_client.py

@@ -18,6 +18,7 @@
     DADateTime,
     as_datetime,
     reconsider,
+    current_context,
 )
 from docassemble.AssemblyLine.al_document import ALDocumentBundle
 from docassemble.AssemblyLine.al_general import ALIndividual
@@ -183,10 +184,15 @@ def __init__(
 
         self.credentials_code_block = credentials_code_block
 
+        interview_id = current_context().package + current_context().filename
+        interview_id = (
+            interview_id.replace(".", "-").replace(":", "-").replace("/", "-")[:72]
+        )
         super().__init__(
             url=url,
             api_key=api_key,
             default_jurisdiction=default_jurisdiction,
+            interview_id=interview_id,
             logger=DALogger(logging.getLogger("docassemble")),
         )
 

docassemble/EFSPIntegration/py_efsp_client.py

@@ -113,7 +113,13 @@ class EfspConnection:
     """A python client that communicates with the E-file proxy server."""
 
     def __init__(
-        self, *, url: str, api_key: str, default_jurisdiction: str = None, logger=None
+        self,
+        *,
+        url: str,
+        api_key: str,
+        default_jurisdiction: str = None,
+        interview_id: str = None,
+        logger=None,
     ):
         """
         Args:
@@ -133,6 +139,7 @@ def __init__(
         self.active_token = None
         # Keep one uuid for the whole of this class's life, i.e. the session
         self.session_id = str(uuid4())
+        self.interview_id = interview_id
         if logger is None:
             logger = logging.getLogger()
         self.logger = LoggerWithContext(logger, {"session_id": self.session_id})
@@ -170,6 +177,7 @@ def _send(self, to_send: Request, *, req_id: Optional[UUID] = None) -> ApiRespon
             req_id = uuid4()
         to_send.headers["efsp-request-id"] = str(req_id)
         to_send.headers["efsp-session-id"] = self.get_session_id()
+        to_send.headers["efsp-interview-id"] = self.get_interview_id()
         self.get_logger().info(
             f"Calling {to_send.method} on {to_send.url}", extra={"req-id": str(req_id)}
         )
@@ -181,6 +189,13 @@ def get_session_id(self):
             self.session_id = str(uuid4())
         return self.session_id
 
+    def get_interview_id(self):
+        if hasattr(self, "interview_id"):
+            # Migration from older interviews, to start passing observability headers
+            return self.interview_id
+        else:
+            return None
+
     def get_logger(self):
         if not hasattr(self, "logger"):
             self.logger = LoggerWithContext(