Merge pull request #134 from UiPath/feat/return-middleware-result

pass input and output file to runtime executor

Author: radu-mocanu

pyproject.toml

@@ -1,11 +1,11 @@
 [project]
 name = "uipath-langchain"
-version = "0.0.119"
+version = "0.0.120"
 description = "UiPath Langchain"
 readme = { file = "README.md", content-type = "text/markdown" }
 requires-python = ">=3.10"
 dependencies = [
-    "uipath>=2.0.79, <2.1.0",
+    "uipath>=2.1.0, <2.2.0",
     "langgraph>=0.2.70",
     "langchain-core>=0.3.34",
     "langgraph-checkpoint-sqlite>=2.0.3",

src/uipath_langchain/_cli/cli_run.py

@@ -15,7 +15,7 @@
 
 
 def langgraph_run_middleware(
-    entrypoint: Optional[str], input: Optional[str], resume: bool
+    entrypoint: Optional[str], input: Optional[str], resume: bool, **kwargs
 ) -> MiddlewareResult:
     """Middleware to handle langgraph execution"""
     config = LangGraphConfig()
@@ -38,10 +38,13 @@ async def execute():
             context.input = input
             context.resume = resume
             context.langgraph_config = config
+            context.debug = kwargs.get("debug", False)
             context.logs_min_level = env.get("LOG_LEVEL", "INFO")
             context.job_id = env.get("UIPATH_JOB_KEY")
             context.trace_id = env.get("UIPATH_TRACE_ID")
             context.tracing_enabled = tracing
+            context.input_file = kwargs.get("input_file", None)
+            context.execution_output_file = kwargs.get("execution_output_file", None)
             context.trace_context = UiPathTraceContext(
                 enabled=tracing,
                 trace_id=env.get("UIPATH_TRACE_ID"),
@@ -64,7 +67,10 @@ async def execute():
 
         asyncio.run(execute())
 
-        return MiddlewareResult(should_continue=False, error_message=None)
+        return MiddlewareResult(
+            should_continue=False,
+            error_message=None,
+        )
 
     except LangGraphRuntimeError as e:
         return MiddlewareResult(

tests/cli/conftest.py

@@ -0,0 +1,9 @@
+import pytest
+
+
+@pytest.fixture
+def mock_env_vars():
+    return {
+        "UIPATH_URL": "http://example.com",
+        "UIPATH_ACCESS_TOKEN": "***",
+    }

tests/cli/mocks/langgraph.json

@@ -0,0 +1,7 @@
+{
+    "dependencies": ["."],
+    "graphs": {
+      "agent": "./main.py:graph"
+    },
+    "env": ".env"
+  }

tests/cli/mocks/simple_agent.py

@@ -0,0 +1,24 @@
+from langgraph.graph import END, START, StateGraph
+from pydantic import BaseModel
+
+
+class GraphState(BaseModel):
+    topic: str
+
+
+class GraphOutput(BaseModel):
+    report: str
+
+
+async def generate_report(state: GraphState) -> GraphOutput:
+    return GraphOutput(report=f" This is mock report for {state.topic}")
+
+
+builder = StateGraph(GraphState, output_schema=GraphOutput)
+
+builder.add_node("generate_report", generate_report)
+
+builder.add_edge(START, "generate_report")
+builder.add_edge("generate_report", END)
+
+graph = builder.compile()

tests/cli/mocks/uipath.json

@@ -0,0 +1,36 @@
+{
+    "entryPoints": [
+        {
+            "filePath": "agent",
+            "uniqueId": "3bbc70ec-e5b3-4c2a-ac2c-98e499a2c351",
+            "type": "agent",
+            "input": {
+                "type": "object",
+                "properties": {
+                    "topic": {
+                        "title": "Topic",
+                        "type": "string"
+                    }
+                },
+                "required": [
+                    "topic"
+                ]
+            },
+            "output": {
+                "type": "object",
+                "properties": {
+                    "report": {
+                        "default": null,
+                        "title": "Report",
+                        "type": "string"
+                    }
+                },
+                "required": []
+            }
+        }
+    ],
+    "bindings": {
+        "version": "2.0",
+        "resources": []
+    }
+}

tests/cli/test_run.py

@@ -0,0 +1,95 @@
+import json
+import os
+import tempfile
+
+import pytest
+
+from uipath_langchain._cli.cli_run import langgraph_run_middleware
+
+
+@pytest.fixture
+def simple_agent() -> str:
+    if os.path.isfile("mocks/simple_agent.py"):
+        with open("mocks/simple_agent.py", "r") as file:
+            data = file.read()
+    else:
+        with open("tests/cli/mocks/simple_agent.py", "r") as file:
+            data = file.read()
+    return data
+
+
+@pytest.fixture
+def uipath_json() -> str:
+    if os.path.isfile("mocks/uipath.json"):
+        with open("mocks/uipath.json", "r") as file:
+            data = file.read()
+    else:
+        with open("tests/cli/mocks/uipath.json", "r") as file:
+            data = file.read()
+    return data
+
+
+@pytest.fixture
+def langgraph_json() -> str:
+    if os.path.isfile("mocks/langgraph.json"):
+        with open("mocks/langgraph.json", "r") as file:
+            data = file.read()
+    else:
+        with open("tests/cli/mocks/langgraph.json", "r") as file:
+            data = file.read()
+    return data
+
+
+class TestRun:
+    def test_successful_execution(
+        self,
+        langgraph_json: str,
+        uipath_json: str,
+        simple_agent: str,
+        mock_env_vars: dict[str, str],
+    ):
+        os.environ.clear()
+        os.environ.update(mock_env_vars)
+        input_file_name = "input.json"
+        output_file_name = "output.json"
+        agent_file_name = "main.py"
+        input_json_content = {"topic": "UiPath"}
+        with tempfile.TemporaryDirectory() as temp_dir:
+            current_dir = os.getcwd()
+            os.chdir(temp_dir)
+            # Create input and output files
+            input_file_path = os.path.join(temp_dir, input_file_name)
+            output_file_path = os.path.join(temp_dir, output_file_name)
+
+            with open(input_file_path, "w") as f:
+                f.write(json.dumps(input_json_content))
+
+            # Create test script
+            script_file_path = os.path.join(temp_dir, agent_file_name)
+            with open(script_file_path, "w") as f:
+                f.write(simple_agent)
+
+            # create uipath.json
+            uipath_json_file_path = os.path.join(temp_dir, "uipath.json")
+            with open(uipath_json_file_path, "w") as f:
+                f.write(uipath_json)
+
+            # Create langgraph.json
+            langgraph_json_file_path = os.path.join(temp_dir, "langgraph.json")
+            with open(langgraph_json_file_path, "w") as f:
+                f.write(langgraph_json)
+
+            result = langgraph_run_middleware(
+                entrypoint="agent",
+                input=None,
+                resume=False,
+                input_file=input_file_path,
+                execution_output_file=output_file_path,
+            )
+            assert result.should_continue is False
+            assert os.path.exists(output_file_path)
+            with open(output_file_path, "r") as f:
+                output = f.read()
+                assert "This is mock report for" in output
+
+            os.chdir(current_dir)