Make FileSlice a copy of the entire source file, with line_offset…

… set to 0. Update tests to account for this, made them more specific while I was at it.
temporalio · cretz · Jun 18, 2024 · May 31, 2024 · May 31, 2024 · Jun 3, 2024
commit 393ca3755e4825403c7fcd7c84a1dded0436ea38
@@ -1812,46 +1812,47 @@ def _enhanced_stack_trace(self) -> temporalio.api.sdk.v1.EnhancedStackTrace:
             name="sdk-python", version=__version__
         )
 
-        sources = dict()
-        stacks = []
-
-        for task in list(self._tasks):
-            locations = []
-            for frame in task.get_stack():
-                filename = frame.f_code.co_filename
-                line_number = frame.f_lineno
-                func_name = frame.f_code.co_name
-
-                try:
-                    source = inspect.getsourcelines(frame)
-                    code = "".join(source[0])
-                    line_number = int(source[1])
-                except OSError as ose:
-                    code = f"Cannot access code.\n---\n{ose.strerror}"
-                    # TODO possibly include sentinel/property for success of src scrape? work out with ui
-                except Exception:
-                    code = f"Generic Error.\n\n{traceback.format_exc()}"
-
-                file_slice = temporalio.api.sdk.v1.StackTraceFileSlice(
-                    line_offset=line_number, content=code
-                )
-                file_location = temporalio.api.sdk.v1.StackTraceFileLocation(
-                    file_path=filename,
-                    line=line_number,
-                    column=-1,
-                    function_name=func_name,
-                    internal_code=False,
-                )
+        # this is to use `open`
+        with temporalio.workflow.unsafe.sandbox_unrestricted():
+            sources = dict()
+            stacks = []
+
+            for task in list(self._tasks):
+                locations = []
+                for frame in task.get_stack():
+                    filename = frame.f_code.co_filename
+                    line_number = frame.f_lineno
+                    func_name = frame.f_code.co_name
+
+                    try:
+                        with open(filename, "r") as f:
+                            code = f.read()
+                    except OSError as ose:
+                        code = f"Cannot access code.\n---\n{ose.strerror}"
+                        # TODO possibly include sentinel/property for success of src scrape? work out with ui
+                    except Exception:
+                        code = f"Generic Error.\n\n{traceback.format_exc()}"
+
+                    file_slice = temporalio.api.sdk.v1.StackTraceFileSlice(
+                        line_offset=0, content=code
+                    )
+                    file_location = temporalio.api.sdk.v1.StackTraceFileLocation(
+                        file_path=filename,
+                        line=line_number,
+                        column=-1,
+                        function_name=func_name,
+                        internal_code=False,
+                    )
 
-                sources[f"{filename} {line_number}"] = file_slice
-                locations.append(file_location)
+                    sources[filename] = file_slice
+                    locations.append(file_location)
 
-            stacks.append(temporalio.api.sdk.v1.StackTrace(locations=locations))
+                stacks.append(temporalio.api.sdk.v1.StackTrace(locations=locations))
 
-        est = temporalio.api.sdk.v1.EnhancedStackTrace(
-            sdk=sdk, sources=sources, stacks=stacks
-        )
-        return est
+            est = temporalio.api.sdk.v1.EnhancedStackTrace(
+                sdk=sdk, sources=sources, stacks=stacks
+            )
+            return est
 
     #### asyncio.AbstractEventLoop function impls ####
     # These are in the order defined in CPython's impl of the base class. Many

@@ -2131,9 +2131,16 @@ async def status() -> str:
         ]
 
         # first line of never_completing_coroutine
-        assert 'self._status = "waiting"' in str(
-            [fileslice.content for fileslice in trace.sources.values()]
-        )
+        cur_source = None
+        for source in trace.sources.keys():
+            if source.endswith("test_workflow.py"):
+                cur_source = source
+
+        # make sure the source exists
+        assert cur_source is not None
+
+        # make sure the line is present in the source
+        assert 'self._status = "waiting"' in trace.sources[cur_source].content
         assert trace.sdk.version == __version__
 
 
@@ -2158,61 +2165,25 @@ async def status() -> str:
 
         # test that a coroutine only has the source as its stack
 
+        assert type(trace) == EnhancedStackTrace
+
         assert "never_completing_coroutine" in [
             loc.function_name for stack in trace.stacks for loc in stack.locations
         ]
 
         fn = None
         for source in trace.sources.keys():
-            if source.endswith("external_coroutine.py 10"):
+            if source.endswith("external_coroutine.py"):
                 fn = source
 
-        assert fn != None
-        assert 'status[0] = "waiting"  # external coroutine test' in str(
-            [fileslice.content for fileslice in trace.sources.values()]
+        assert fn is not None
+        assert (
+            'status[0] = "waiting"  # external coroutine test'
+            in trace.sources[fn].content
         )
         assert trace.sdk.version == __version__
 
 
-async def test_workflow_external_multifile_enhanced_stack_trace(client: Client):
-    async with new_worker(
-        client, MultiFileStackTraceWorkflow, activities=[]
-    ) as multifile_worker:
-        mf_handle = await client.start_workflow(
-            MultiFileStackTraceWorkflow.run_multifile_workflow,
-            id=f"workflow-{uuid.uuid4()}",
-            task_queue=multifile_worker.task_queue,
-        )
-
-        async def mf_status() -> str:
-            return await mf_handle.query(MultiFileStackTraceWorkflow.status)
-
-        await assert_eq_eventually("waiting", mf_status)
-
-        mf_trace = await mf_handle.query("__enhanced_stack_trace")
-
-        assert "wait_on_timer" in [
-            loc.function_name for stack in mf_trace.stacks for loc in stack.locations
-        ]
-
-        filenames = [None, None]
-        for source in mf_trace.sources.keys():
-            if source.endswith("external_coroutine.py 15"):
-                filenames[1] = source
-            if source.endswith("external_stack_trace.py 49"):
-                filenames[0] = source
-
-        assert filenames[0] is not None and filenames[1] is not None
-        assert 'status[0] = "waiting"  # multifile test' in str(
-            [fileslice.content for fileslice in mf_trace.sources.values()]
-        )
-
-        assert "await wait_on_timer(self._status)" in str(
-            [fileslice.content for fileslice in mf_trace.sources.values()]
-        )
-        assert mf_trace.sdk.version == __version__
-
-
 @dataclass
 class MyDataClass:
     field1: str