Merge pull request #58 from phlowdotdev/payload-fixs

codephi · web-flow · commit 5f00978c7275 · 2026-01-21T10:13:43.000-03:00
Payload fixs
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -22,7 +22,7 @@ members = [
 ]
 resolver = "2"
 [workspace.package]
-version = "0.3.2"
+version = "0.3.3"
 edition = "2024"
 rust-version = "1.90.0"
 authors = ["Philippe Assis <codephilippe@gmail.com>"]
diff --git a/example.json b/example.json
@@ -0,0 +1,65 @@
+{
+  "steps": [
+    {
+      "payload": "{{ main }}"
+    },
+    {
+      "assert": "{{ payload > 1 }}",
+      "then": [
+        {
+          "payload": "{{ payload + 1 }}"
+        },
+        {
+          "assert": "{{ payload == 3 }}",
+          "then": {
+            "steps": [
+              {
+                "payload": "{{ payload + 1 }}"
+              }
+            ]
+          },
+          "else": {
+            "assert": "{{ payload == 6 }}",
+            "then": [
+              {
+                "log.info": "{{ `Finished with payload 6` }}"
+              },
+              {
+                "return": 100
+              }
+            ]
+          }
+        }
+      ]
+    },
+    {
+      "id": "final_step",
+      "payload": "{{ payload ?? main + 10 }}"
+    },
+    {
+      "log.info": "{{ `Final payload is ${payload}` }}"
+    }
+  ],
+  "tests": [
+    {
+      "describe": "Complex 1",
+      "main": 1,
+      "assert_eq": 11
+    },
+    {
+      "describe": "Complex 2",
+      "main": 2,
+      "assert_eq": 14
+    },
+    {
+      "describe": "Complex 3",
+      "main": 4,
+      "assert_eq": 15
+    },
+    {
+      "describe": "Complex 4",
+      "main": 5,
+      "assert_eq": 100
+    }
+  ]
+}
diff --git a/phlow-runtime/src/runtime.rs b/phlow-runtime/src/runtime.rs
@@ -37,6 +37,19 @@ impl Display for RuntimeError {
     }
 }
 
+fn parse_cli_value(flag: &str, value: &str) -> Result<Value, RuntimeError> {
+    match Value::json_to_value(value) {
+        Ok(parsed) => Ok(parsed),
+        Err(err) => {
+            error!("Failed to parse --{} value '{}': {:?}", flag, value, err);
+            Err(RuntimeError::FlowExecutionError(format!(
+                "Failed to parse --{} value: {:?}",
+                flag, err
+            )))
+        }
+    }
+}
+
 pub struct Runtime {}
 
 impl Runtime {
@@ -244,6 +257,16 @@ impl Runtime {
         // -------------------------
         let (tx_main_package, rx_main_package) = channel::unbounded::<Package>();
 
+        let var_payload_value = match &settings.var_payload {
+            Some(var_payload_str) => Some(parse_cli_value("var-payload", var_payload_str)?),
+            None => None,
+        };
+        let default_context = var_payload_value.as_ref().map(|payload| {
+            let mut context = Context::new();
+            context.add_step_payload(Some(payload.clone()));
+            context
+        });
+
         let no_main = loader.main == -1 || settings.var_main.is_some();
         let steps = loader.get_steps();
         let modules = Self::load_modules(
@@ -266,19 +289,7 @@ impl Runtime {
             // Se --var-main foi especificado, processar o valor usando valu3
             let request_data = if let Some(var_main_str) = &settings.var_main {
                 // Usar valu3 para processar o valor da mesma forma que outros valores
-                match Value::json_to_value(var_main_str) {
-                    Ok(value) => Some(value),
-                    Err(err) => {
-                        error!(
-                            "Failed to parse --var-main value '{}': {:?}",
-                            var_main_str, err
-                        );
-                        return Err(RuntimeError::FlowExecutionError(format!(
-                            "Failed to parse --var-main value: {:?}",
-                            err
-                        )));
-                    }
-                }
+                Some(parse_cli_value("var-main", var_main_str)?)
             } else {
                 None
             };
@@ -323,7 +334,7 @@ impl Runtime {
         // -------------------------
         // Create the phlow
         // -------------------------
-        Self::listener(rx_main_package, steps, modules, settings, None)
+        Self::listener(rx_main_package, steps, modules, settings, default_context)
             .await
             .map_err(|err| {
                 error!("Runtime Error: {:?}", err);
@@ -342,6 +353,12 @@ impl Runtime {
         context: Context,
     ) -> Result<(), RuntimeError> {
         let steps = loader.get_steps();
+        let context = if let Some(var_payload_str) = &settings.var_payload {
+            let payload = parse_cli_value("var-payload", var_payload_str)?;
+            context.clone_with_output(payload)
+        } else {
+            context
+        };
 
         let modules = Self::load_modules(
             loader,
diff --git a/phlow-runtime/src/settings/cli.rs b/phlow-runtime/src/settings/cli.rs
@@ -27,6 +27,7 @@ pub struct Cli {
     pub test: bool,
     pub test_filter: Option<String>,
     pub var_main: Option<String>,
+    pub var_payload: Option<String>,
     pub start_step: Option<String>,
     // analyzer options
     pub analyzer: bool,
@@ -107,6 +108,7 @@ impl Cli {
             .arg(
                 Arg::new("print_output")
                     .long("output")
+                    .short('o')
                     .help("Output format for --print (yaml|json)")
                     .value_name("FORMAT")
                     .value_parser(["yaml", "json"])
@@ -134,6 +136,12 @@ impl Cli {
                     .help("Set the main variable value")
                     .value_name("VALUE"),
             )
+            .arg(
+                Arg::new("var_payload")
+                    .long("var-payload")
+                    .help("Set the initial payload value")
+                    .value_name("VALUE"),
+            )
             .arg(
                 Arg::new("var_pre")
                     .long("var-pre")
@@ -244,6 +252,9 @@ impl Cli {
             .map(|s| s.to_string());
 
         let var_main = matches.get_one::<String>("var_main").map(|s| s.to_string());
+        let var_payload = matches
+            .get_one::<String>("var_payload")
+            .map(|s| s.to_string());
         let start_step = matches
             .get_one::<String>("start_step")
             .map(|s| s.to_string());
@@ -270,6 +281,7 @@ impl Cli {
             test,
             test_filter,
             var_main,
+            var_payload,
             start_step,
             analyzer,
             analyzer_files,
diff --git a/phlow-runtime/src/settings/mod.rs b/phlow-runtime/src/settings/mod.rs
@@ -19,6 +19,7 @@ pub struct Settings {
     pub test: bool,
     pub test_filter: Option<String>,
     pub var_main: Option<String>,
+    pub var_payload: Option<String>,
     pub start_step: Option<String>,
     // analyzer
     pub analyzer: bool,
@@ -88,6 +89,7 @@ impl Settings {
             test: cli.test,
             test_filter: cli.test_filter,
             var_main: cli.var_main,
+            var_payload: cli.var_payload,
             start_step: cli.start_step,
         };
 
diff --git a/phlow-runtime/src/test_runner.rs b/phlow-runtime/src/test_runner.rs
@@ -465,27 +465,31 @@ async fn run_single_test(
     let main_value = {
         let data = test_case.get("main").cloned().unwrap_or(Value::Undefined);
 
-        match Script::try_build(engine.clone(), &Value::from(data)) {
-            Ok(script) => match script.evaluate(&context) {
-                Ok(val) => val.to_value(),
+        if data.is_undefined() {
+            Value::Undefined
+        } else {
+            match Script::try_build(engine.clone(), &data) {
+                Ok(script) => match script.evaluate(&context) {
+                    Ok(val) => val.to_value(),
+                    Err(e) => {
+                        return SingleTestReport {
+                            ok: false,
+                            message: format!("Failed to evaluate main script: {}", e),
+                            main: Value::Undefined,
+                            initial_payload: Value::Undefined,
+                            result: Value::Undefined,
+                        };
+                    }
+                },
                 Err(e) => {
                     return SingleTestReport {
                         ok: false,
-                        message: format!("Failed to evaluate main script: {}", e),
+                        message: format!("Failed to build main script: {}", e),
                         main: Value::Undefined,
                         initial_payload: Value::Undefined,
                         result: Value::Undefined,
                     };
                 }
-            },
-            Err(e) => {
-                return SingleTestReport {
-                    ok: false,
-                    message: format!("Failed to build main script: {}", e),
-                    main: Value::Undefined,
-                    initial_payload: Value::Undefined,
-                    result: Value::Undefined,
-                };
             }
         }
     };
@@ -529,7 +533,9 @@ async fn run_single_test(
         main_value, initial_payload
     );
 
-    context = context.clone_with_main(main_value.clone());
+    if !main_value.is_undefined() {
+        context = context.clone_with_main(main_value.clone());
+    }
 
     // Set initial payload if provided
     if !initial_payload.is_undefined() {
diff --git a/site/docs/advanced/var-payload.md b/site/docs/advanced/var-payload.md
@@ -0,0 +1,68 @@
+---
+sidebar_position: 2
+title: Initial Payload (--var-payload)
+---
+
+# Initial Payload
+
+The `--var-payload` parameter sets the initial `payload` value before the first step runs. This is useful when you want to start a flow with a known payload without adding a setup step.
+
+## Usage
+
+```bash
+phlow --var-payload VALUE [file]
+```
+
+The `VALUE` must be valid JSON and will be parsed using the same mechanism as other values in Phlow.
+
+## How it Works
+
+When `--var-payload` is specified:
+
+1. **The value becomes available as `payload` in the first step**
+2. **Main modules still run normally** (unless `--var-main` is also used)
+3. **Subsequent steps overwrite `payload` as usual**
+
+## Examples
+
+### Simple Values
+
+```bash
+# String value
+phlow flow.phlow --var-payload '"hello world"'
+
+# Number value
+phlow flow.phlow --var-payload '42'
+
+# Object value
+phlow flow.phlow --var-payload '{"user_id": 123, "name": "John"}'
+```
+
+### Flow Example
+
+```phlow
+steps:
+  - payload: !phs payload ?? 0
+  - payload: !phs payload + 5
+  - return: !phs payload
+```
+
+```bash
+phlow flow.phlow --var-payload 10
+# Output: 15
+```
+
+### Combine with --var-main
+
+```bash
+phlow flow.phlow --var-main '{"total": 2}' --var-payload 10
+```
+
+## Error Handling
+
+If the JSON value is invalid, Phlow will show an error:
+
+```bash
+phlow flow.phlow --var-payload '{"invalid": json}'
+# Error: Failed to parse --var-payload value: expected `,` or `}` at line 1 column 18
+```
diff --git a/tests/complex_test.phlow b/tests/complex_test.phlow

Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@ members = [`
`22`	`22`	`]`
`23`	`23`	`resolver = "2"`
`24`	`24`	`[workspace.package]`
`25`		`-version = "0.3.2"`
	`25`	`+version = "0.3.3"`
`26`	`26`	`edition = "2024"`
`27`	`27`	`rust-version = "1.90.0"`
`28`	`28`	`authors = ["Philippe Assis <codephilippe@gmail.com>"]`