Merge pull request #505 from DrDroidLab/global_variable_dict

adds dict/list of dicts to global variable set

Author: droid-mohit

executor/playbook_source_manager.py

@@ -1,3 +1,4 @@
+import json
 from typing import Dict
 
 from google.protobuf.struct_pb2 import Struct
@@ -27,6 +28,45 @@ def apply_result_transformer(result_dict, lambda_function: Lambda.Function) -> D
     return transformer_result
 
 
+def flatten_dict(prefix: str, d: dict) -> dict:
+    items = {}
+    for k, v in d.items():
+        new_key = f"{prefix}.{k}"
+        if isinstance(v, dict):
+            items.update(flatten_dict(new_key, v))
+        elif isinstance(v, str):
+            items[new_key] = v.strip(" ")
+        else:
+            items[new_key] = v
+    return items
+
+
+def get_flat_global_variables(global_variable_set: dict):
+    flat_globals = {}
+    for gk, gv in global_variable_set.items():
+        parsed = None
+        # If gv is already a dict, use it directly.
+        if isinstance(gv, dict):
+            parsed = gv
+        else:
+            try:
+                parsed = json.loads(gv)
+            except Exception:
+                parsed = None
+        if parsed is not None and isinstance(parsed, dict):
+            # Flatten the dict with gk as the prefix.
+            flat_from_obj = flatten_dict(gk, parsed)
+            # Merge: only add if the key doesn't already exist.
+            for fk, fv in flat_from_obj.items():
+                if fk not in flat_globals:
+                    flat_globals[fk] = fv
+        else:
+            # Only add the direct key if it's not a dict.
+            flat_globals[gk] = gv
+
+    return flat_globals
+
+
 def resolve_global_variables(form_fields: [FormField], global_variable_set: Struct,
                              source_type_task_def: Dict) -> (Dict, Dict):
     all_string_fields = [ff.key_name.value for ff in form_fields if ff.data_type == LiteralType.STRING]
@@ -36,20 +76,23 @@ def resolve_global_variables(form_fields: [FormField], global_variable_set: Stru
         if ff.is_composite:
             all_composite_fields[ff.key_name.value] = ff.composite_fields
 
+    global_variable_set_dict = proto_to_dict(global_variable_set) if global_variable_set else {}
+    global_variable_set = get_flat_global_variables(global_variable_set_dict)
+
     task_local_variable_map = {}
     for gk, gv in global_variable_set.items():
         for tk, tv in source_type_task_def.items():
             if tk in all_string_fields:
                 if gv is None:
                     raise Exception(f"Global variable {gk} is None")
-                source_type_task_def[tk] = tv.replace(gk, gv)
+                source_type_task_def[tk] = tv.replace(gk, str(gv))
                 if gk in tv:
                     task_local_variable_map[gk] = gv
             elif tk in all_string_array_fields:
                 for item in source_type_task_def[tk]:
                     if gv is None:
                         raise Exception(f"Global variable {gk} is None")
-                    source_type_task_def[tk] = item.replace(gk, gv)
+                    source_type_task_def[tk] = item.replace(gk, str(gv))
                 if gk in tv:
                     task_local_variable_map[gk] = gv
             elif tk in all_composite_fields:
@@ -59,7 +102,7 @@ def resolve_global_variables(form_fields: [FormField], global_variable_set: Stru
                         if cf.data_type == LiteralType.STRING:
                             if gv is None:
                                 raise Exception(f"Global variable {gk} is None")
-                            item[cf.key_name.value] = item[cf.key_name.value].replace(gk, gv)
+                            item[cf.key_name.value] = item[cf.key_name.value].replace(gk, str(gv))
                 if gk in tv:
                     task_local_variable_map[gk] = gv
     return source_type_task_def, task_local_variable_map

executor/views.py

@@ -183,7 +183,16 @@ def bulk_task_run(request_message: RunPlaybookTaskRequestV3) -> Union[RunBulkPla
                                            message=Message(title="Invalid Request",
                                                            description="Bulk execution variable not found in global variables"))
 
-    bulk_execution_var_values = execution_global_variable_set[bulk_task_var].split(',')
+    bulk_value = execution_global_variable_set[bulk_task_var]
+    try:
+        parsed = json.loads(bulk_value)
+        if isinstance(parsed, list):
+            bulk_execution_var_values = parsed
+        else:
+            bulk_execution_var_values = bulk_value.split(',')
+    except Exception:
+        bulk_execution_var_values = bulk_value.split(',')
+    
     if not bulk_execution_var_values:
         return RunBulkPlaybookTaskResponse(meta=get_meta(tr=time_range), success=BoolValue(value=False),
                                            message=Message(title="Invalid Request",

web/src/components/common/GlobalVariable/AddVariableOverlay.tsx

@@ -64,9 +64,15 @@ const AddVariableOverlay = ({ isOpen, close }) => {
               placeholder={"Enter variable value"}
             />
           </div>
-          <p className="text-xs mt-2 text-gray-500 italic">
-            To enter an array variable, just enter the values with commas
-          </p>
+          <div>
+            <p className="text-xs mt-2 text-gray-500 italic">
+              To enter an array variable, just enter the values with commas
+            </p>
+            <p className="text-xs mt-2 text-gray-500 italic">
+              To enter a list of objects(dicts) in a variable, just write the
+              list (eg. {`[{ "key1": "value1" }, { "key2": "value1" }]`})
+            </p>
+          </div>
           <div className="flex items-center gap-2 mt-10">
             <CustomButton onClick={() => close()}>Cancel</CustomButton>
             <CustomButton onClick={handleSubmit}>Add</CustomButton>

web/src/components/common/GlobalVariable/index.tsx

@@ -6,12 +6,13 @@ import {
   updateGlobalVariable,
 } from "../../../store/features/playbook/playbookSlice.ts";
 import AddVariableOverlay from "./AddVariableOverlay.js";
-import { Add, CloseRounded } from "@mui/icons-material";
+import { Add, CloseRounded, DescriptionRounded } from "@mui/icons-material";
 import useIsPrefetched from "../../../hooks/playbooks/useIsPrefetched.ts";
 import CustomButton from "../CustomButton/index.tsx";
 import CustomInput from "../../Inputs/CustomInput.tsx";
 import { InputTypes } from "../../../types/inputs/inputTypes.ts";
 import { Tooltip } from "@mui/material";
+import { checkIfJSON } from "../../../utils/common/checkIfJSON.ts";
 
 function GlobalVariables() {
   const [isAddVariableOpen, setIsAddVariableOpen] = useState(false);
@@ -61,15 +62,36 @@ function GlobalVariables() {
                 </Tooltip>
               </div>
               <div className="flex gap-2 items-center">
-                <CustomInput
-                  inputType={InputTypes.TEXT}
-                  value={variables[key]}
-                  placeholder={"Enter variable value"}
-                  className="!w-[200px]"
-                  handleChange={(val) => {
-                    dispatch(updateGlobalVariable({ name: key, value: val }));
-                  }}
-                />
+                <div className="relative flex items-center gap-1">
+                  <CustomInput
+                    inputType={InputTypes.TEXT}
+                    value={variables[key]}
+                    placeholder={"Enter variable value"}
+                    className="!w-[200px]"
+                    handleChange={(val) => {
+                      dispatch(updateGlobalVariable({ name: key, value: val }));
+                    }}
+                  />
+                  <div className="absolute right-2">
+                    {checkIfJSON(variables[key]) && (
+                      <Tooltip
+                        title={
+                          <pre style={{ margin: 0 }}>
+                            {JSON.stringify(
+                              JSON.parse(variables[key]),
+                              null,
+                              2,
+                            )}
+                          </pre>
+                        }>
+                        <DescriptionRounded
+                          className="text-gray-500 bg-white cursor-pointer"
+                          fontSize="small"
+                        />
+                      </Tooltip>
+                    )}
+                  </div>
+                </div>
                 {!isPrefetched && (
                   <CloseRounded
                     onClick={() => handleDelete(key)}

web/src/utils/common/checkIfJSON.ts

@@ -0,0 +1,8 @@
+export const checkIfJSON = (str: string) => {
+  try {
+    JSON.parse(str);
+  } catch (e) {
+    return false;
+  }
+  return true;
+};