feat: add runbooks support for file upload (#1230)

* feat: add runbooks support for file upload

* redact runbook parameter file to display parameters when fetching a runbook session

* refactor: remove duplicated import

---------

Co-authored-by: Sandro <sandromll@gmail.com>

Author: luanlorenzo

common/runbooks/git.go

@@ -20,10 +20,11 @@ import (
 const maxTemplateSize = 1_000_000 // 1MB
 
 type File struct {
-	Name      string
-	EnvVars   map[string]string
-	InputFile []byte
-	CommitSHA string
+	Name               string
+	EnvVars            map[string]string
+	TemplateAttributes map[string]any
+	InputFile          []byte
+	CommitSHA          string
 }
 
 type Repository struct {
@@ -91,10 +92,11 @@ func (r *Repository) ReadFile(fileName string, parameters map[string]string) (*F
 		return nil, err
 	}
 	return &File{
-		Name:      f.Name,
-		InputFile: parsedTemplate.Bytes(),
-		EnvVars:   t.EnvVars(),
-		CommitSHA: f.Hash.String(),
+		Name:               f.Name,
+		InputFile:          parsedTemplate.Bytes(),
+		TemplateAttributes: t.Attributes(),
+		EnvVars:            t.EnvVars(),
+		CommitSHA:          f.Hash.String(),
 	}, nil
 }
 

common/runbooks/template_funcs.go

@@ -7,7 +7,7 @@ import (
 	ttemplate "text/template"
 )
 
-var defaultInputTypes = []string{"text", "number", "tel", "time", "date", "url", "email", "select", "textarea", "password"}
+var defaultInputTypes = []string{"text", "number", "tel", "time", "date", "url", "email", "select", "textarea", "password", "file"}
 
 type templateFnHandler struct {
 	items map[string]string

gateway/api/runbooks/runbooksV2.go

@@ -440,7 +440,7 @@ func RunbookExec(c *gin.Context) {
 		runbook.EnvVars[key] = val
 	}
 
-	runbookParamsJson, _ := json.Marshal(req.Parameters)
+	runbookParamsJson := encodeRequestParams(req.Parameters, runbook)
 	sessionLabels := openapi.SessionLabelsType{
 		"runbookRepository": config.GetNormalizedGitURL(),
 		"runbookFile":       req.FileName,
@@ -608,3 +608,25 @@ func validateGitURL(urlStr string) error {
 
 	return nil
 }
+
+func encodeRequestParams(params map[string]string, runbook *runbooks.File) []byte {
+	newParams := map[string]string{}
+	for key, val := range params {
+		newParams[key] = val
+		if runbook.TemplateAttributes != nil {
+			attrObj, ok := runbook.TemplateAttributes[key]
+			if !ok {
+				continue
+			}
+			attr, ok := attrObj.(map[string]any)
+			if !ok {
+				continue
+			}
+			if attrType, _ := attr["type"].(string); attrType == "file" {
+				newParams[key] = fmt.Sprintf("[param redacted. type = file, size = %v byte(s)]", len(val))
+			}
+		}
+	}
+	encoded, _ := json.Marshal(newParams)
+	return encoded
+}

webapp/src/webapp/components/forms.cljs

@@ -1,7 +1,7 @@
 (ns webapp.components.forms
   (:require
-   ["@radix-ui/themes" :refer [Select Tooltip Text]]
-   ["lucide-react" :refer [Eye EyeOff HelpCircle]]
+   ["@radix-ui/themes" :refer [Box Button Flex IconButton Select Text Tooltip]]
+   ["lucide-react" :refer [Eye EyeOff HelpCircle Upload X]]
    [clojure.string :as cs]
    [reagent.core :as r]))
 
@@ -215,3 +215,64 @@
     [:> Select.Content {:position "popper"
                         :color "indigo"}
      (map #(option % selected) options)]]])
+
+
+(defn file
+  "File input component with base64 encoding support"
+  [_]
+  (let [file-input-ref (r/atom nil)
+        file-name (r/atom nil)]
+    (fn [{:keys [label on-change value helper-text required]}]
+      (let [handle-file-change (fn [event]
+                                 (when-let [file (-> event .-target .-files (aget 0))]
+                                   (reset! file-name (.-name file))
+                                   (let [reader (js/FileReader.)]
+                                     (set! (.-onload reader)
+                                           (fn [e]
+                                             (when-let [base64 (second (cs/split (-> e .-target .-result) #"," 2))]
+                                               (on-change base64))))
+                                     (.readAsDataURL reader file))))
+            handle-button-click (fn []
+                                  (when @file-input-ref
+                                    (.click @file-input-ref)))
+            handle-clear (fn []
+                           (reset! file-name nil)
+                           (when @file-input-ref
+                             (set! (.-value @file-input-ref) ""))
+                           (on-change ""))]
+        [:> Box {:class "text-sm mb-regular"}
+         [:> Flex {:class "items-center gap-2 mb-1"}
+          (when label
+            [:> Text {:size "1" :as "label" :weight "bold" :class "text-gray-12"}
+             label])
+          (when (not (cs/blank? helper-text))
+            [:> Tooltip {:content helper-text}
+             [:> HelpCircle {:size 14}]])]
+         [:> Flex {:class "items-center gap-2"}
+          [:input
+           {:type "file"
+            :ref (fn [el] (reset! file-input-ref el))
+            :on-change handle-file-change
+            :required (and
+                       (not= required "false")
+                       (or required (nil? required)))
+            :style {:display "none"}}]
+          [:> Button
+           {:variant "soft"
+            :size "2"
+            :type "button"
+            :on-click handle-button-click}
+           [:> Flex {:align "center" :gap "2"}
+            [:> Upload {:size 16}]
+            "Upload File"]]
+          (when (not (cs/blank? value))
+            [:> Flex {:align "center" :gap "2"}
+             [:> Text {:size "1" :class "text-gray-11"}
+              (or @file-name "File uploaded")]
+             [:> IconButton
+              {:variant "ghost"
+               :color "gray"
+               :size "1"
+               :type "button"
+               :on-click handle-clear}
+              [:> X {:size 14}]]])]]))))

webapp/src/webapp/features/runbooks/runner/views/form.cljs

@@ -51,6 +51,11 @@
                                           (not= required "false")
                                           (or required (nil? required)))
                                      {:required true}))]
+       "file" [forms/file {:label label
+                           :on-change on-change
+                           :value value
+                           :helper-text helper-text
+                           :required required}]
        [forms/input (merge
                      {:label label
                       :placeholder (or placeholder (str "Define a value for " label))
@@ -183,7 +188,7 @@
                                             :value (get @state param "")
                                             :type (:type metadata)
                                             :required (:required metadata)
-                                            :on-change (if (= "select" (:type metadata))
+                                            :on-change (if (contains? #{"select" "file"} (:type metadata))
                                                          #(update-state param %)
                                                          #(update-state param (-> % .-target .-value)))
                                             :helper-text (:description metadata)