refactor(toml): Move params to params.inline

Author: tomasol

crates/testing/test-programs/js/activity/fetch.js

@@ -1,6 +1,6 @@
-async function fetch_get(params) {
-    console.info("Fetching " + params[0]);
-    const resp = await fetch(params[0]);
+async function fetch_get(url) {
+    console.info("Fetching " + url);
+    const resp = await fetch(url);
     const text = await resp.text();
     return text;
 }

obelisk-testing-sqlite-local.toml

@@ -110,6 +110,7 @@ backtrace.ignore_component_digest = true
 # name = "activity_js_fetch_get"
 # location = "${OBELISK_TOML_DIR}/crates/testing/test-programs/js/activity/fetch.js"
 # ffqn = "test:pkg/ifc.fetch-get"
+# params.inline = ["string"]
 # max_retries = 0
 # [[activity_js.allowed_host]]
 # pattern = "http://localhost:5005" # all https is allowed

src/config/toml.rs

@@ -1050,9 +1050,9 @@ pub(crate) struct ActivityJsComponentConfigToml {
     pub(crate) ffqn: String,
     /// Custom parameters for the JS function.
     /// Each entry has a `name` and a WIT `type` (e.g. `string`, `u32`, `list<string>`).
-    /// If omitted, defaults to a single `params: list<string>` parameter.
+    /// If omitted, defaults to a single `(params: list<string>)` parameter.
     #[serde(default)]
-    pub(crate) params: Vec<JsParamToml>,
+    pub(crate) params: ParamsSpec,
     #[serde(default)]
     pub(crate) exec: ExecConfigToml,
     #[serde(default = "default_max_retries")]
@@ -1070,6 +1070,15 @@ pub(crate) struct ActivityJsComponentConfigToml {
     pub(crate) allowed_host: Vec<AllowedHostToml>,
 }
 
+#[derive(Debug, Default, Deserialize, JsonSchema, Clone)]
+#[serde(rename_all = "snake_case")]
+pub(crate) enum ParamsSpec {
+    #[default]
+    Default, // `(params: list<string>)`
+    Inline(Vec<JsParamToml>),
+    // TODO: Add a WIT folder location later
+}
+
 /// A parameter declaration for a JS activity function.
 #[derive(Debug, Deserialize, JsonSchema, Clone)]
 #[serde(deny_unknown_fields)]
@@ -1113,16 +1122,17 @@ impl ActivityJsComponentConfigToml {
             .map_err(|e| anyhow!("invalid ffqn `{}`: {e}", self.ffqn))?;
 
         // Parse custom params or default to `params: list<string>`
-        let parsed_params = if self.params.is_empty() {
-            vec![concepts::ParameterType {
-                type_wrapper: val_json::type_wrapper::TypeWrapper::List(Box::new(
-                    val_json::type_wrapper::TypeWrapper::String,
-                )),
-                name: StrVariant::Static("params"),
-                wit_type: StrVariant::Static("list<string>"),
-            }]
-        } else {
-            self.params
+        let parsed_params = match self.params {
+            ParamsSpec::Default => {
+                vec![concepts::ParameterType {
+                    type_wrapper: val_json::type_wrapper::TypeWrapper::List(Box::new(
+                        val_json::type_wrapper::TypeWrapper::String,
+                    )),
+                    name: StrVariant::Static("params"),
+                    wit_type: StrVariant::Static("list<string>"),
+                }]
+            }
+            ParamsSpec::Inline(params) => params
                 .iter()
                 .map(|p| {
                     let tw = val_json::type_wrapper::parse_wit_type(&p.wit_type)
@@ -1133,7 +1143,7 @@ impl ActivityJsComponentConfigToml {
                         wit_type: StrVariant::from(p.wit_type.clone()),
                     })
                 })
-                .collect::<Result<Vec<_>, anyhow::Error>>()?
+                .collect::<Result<Vec<_>, anyhow::Error>>()?,
         };
 
         let js_source = self

toml/schema.json

@@ -220,6 +220,10 @@
         "name": {
           "$ref": "#/$defs/ConfigName"
         },
+        "params": {
+          "description": "Custom parameters for the JS function.\nEach entry has a `name` and a WIT `type` (e.g. `string`, `u32`, `list<string>`).\nIf omitted, defaults to a single `(params: list<string>)` parameter.",
+          "$ref": "#/$defs/ParamsSpec"
+        },
         "retry_exp_backoff": {
           "$ref": "#/$defs/DurationConfig"
         }
@@ -784,6 +788,25 @@
       "description": "Location of a JavaScript source file for JS activities.\nSupports local file paths and `gh://` GitHub release references.\nOCI references are not supported.",
       "type": "string"
     },
+    "JsParamToml": {
+      "description": "A parameter declaration for a JS activity function.",
+      "type": "object",
+      "properties": {
+        "name": {
+          "description": "Parameter name (used in WIT metadata).",
+          "type": "string"
+        },
+        "type": {
+          "description": "WIT type string, e.g. `string`, `u32`, `list<string>`, `option<u64>`.",
+          "type": "string"
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "name",
+        "type"
+      ]
+    },
     "LockingStrategy": {
       "type": "string",
       "enum": [
@@ -852,6 +875,31 @@
         "enabled"
       ]
     },
+    "ParamsSpec": {
+      "oneOf": [
+        {
+          "type": "string",
+          "enum": [
+            "default"
+          ]
+        },
+        {
+          "type": "object",
+          "properties": {
+            "inline": {
+              "type": "array",
+              "items": {
+                "$ref": "#/$defs/JsParamToml"
+              }
+            }
+          },
+          "additionalProperties": false,
+          "required": [
+            "inline"
+          ]
+        }
+      ]
+    },
     "PostgresConfigToml": {
       "type": "object",
       "properties": {