fix: validation for secrets and consts (#4525)

Author: talboren

docs/snippets/providers/http-snippet-autogenerated.mdx

@@ -21,6 +21,7 @@ steps:
         params: {value}
         proxies: {value}
         fail_on_error: {value}
+        verify: {value}
 ```
 
 
@@ -37,6 +38,7 @@ actions:
         body: {value}
         params: {value}
         proxies: {value}
+        verify: {value}
 ```
 
 

keep-ui/entities/workflows/lib/validate-yaml.ts

@@ -295,6 +295,20 @@ export const validateMustacheVariableNameForYAML = (
     }
     return null;
   }
+  if (parts[0] === "consts") {
+    const constName = parts[1];
+    if (!constName) {
+      return [
+        `Variable: ${cleanedVariableName} - To access a constant, you need to specify the constant name.`,
+      ];
+    }
+    if (!definition.consts?.[constName]) {
+      return [
+        `Variable: ${cleanedVariableName} - Constant "${constName}" not found.`,
+        "error",
+      ];
+    }
+  }
   if (parts[0] === "steps") {
     const stepName = parts[1];
     if (!stepName) {

keep-ui/entities/workflows/lib/validation.ts

@@ -48,6 +48,15 @@ export const validateMustacheVariableName = (
     }
     return null;
   }
+  if (parts[0] === "consts") {
+    const constName = parts[1];
+    if (!constName) {
+      return `Variable: '${variableName}' - To access a constant, you need to specify the constant name.`;
+    }
+    if (!definition.properties.consts?.[constName]) {
+      return `Variable: '${variableName}' - Constant '${constName}' not found.`;
+    }
+  }
   if (parts[0] === "steps") {
     const stepName = parts[1];
     if (!stepName) {

keep-ui/entities/workflows/model/schema.ts

@@ -199,7 +199,7 @@ export const WorkflowPropertiesSchema = z.object({
   description: z.string().min(1),
   disabled: z.boolean(),
   isLocked: z.boolean(),
-  consts: z.record(z.string(), z.string()),
+  consts: z.record(z.string(), z.string()).optional(),
   alert: AlertTriggerValueSchema.optional(),
   interval: IntervalTriggerValueSchema.optional(),
   incident: IncidentTriggerValueSchema.optional(),

keep-ui/shared/ui/WorkflowYAMLEditor/lib/useYamlValidation.ts

@@ -20,7 +20,8 @@ export interface UseYamlValidationResult {
   validationErrors: YamlValidationError[] | null;
   validateMustacheExpressions: (
     model: editor.ITextModel | null,
-    monaco: typeof import("monaco-editor") | null
+    monaco: typeof import("monaco-editor") | null,
+    secrets: Record<string, string>
   ) => void;
   handleMarkersChanged: (
     editor: editor.IStandaloneCodeEditor,
@@ -92,7 +93,8 @@ export function useYamlValidation({
   const validateMustacheExpressions = useCallback(
     (
       model: editor.ITextModel | null,
-      monaco: typeof import("monaco-editor") | null
+      monaco: typeof import("monaco-editor") | null,
+      secrets: Record<string, string> = {}
     ) => {
       if (!model || !monaco) {
         return;
@@ -113,8 +115,6 @@ export function useYamlValidation({
         const mustacheRegex = /\{\{([^}]+)\}\}/g;
         // Collect markers to add to the model
         const markers: editor.IMarkerData[] = [];
-        // Use an empty secrets object for now - could be passed as a prop in the future
-        const secrets: Record<string, string> = {};
 
         let match;
         while ((match = mustacheRegex.exec(text)) !== null) {
@@ -159,7 +159,7 @@ export function useYamlValidation({
                 currentStep,
                 currentStepType,
                 workflowDefinition.workflow,
-                secrets,
+                secrets ?? {},
                 providers ?? null,
                 installedProviders ?? null
               );

keep-ui/shared/ui/WorkflowYAMLEditor/ui/WorkflowYAMLEditor.tsx

@@ -18,6 +18,7 @@ import { YamlValidationError } from "../model/types";
 import { useYamlValidation } from "../lib/useYamlValidation";
 import { WorkflowYAMLEditorToolbar } from "./WorkflowYAMLEditorToolbar";
 import { navigateToErrorPosition } from "../lib/utils";
+import { useWorkflowSecrets } from "@/utils/hooks/useWorkflowSecrets";
 
 const KeepSchemaPath = "file:///workflow-schema.json";
 
@@ -51,6 +52,8 @@ export const WorkflowYAMLEditor = ({
 }: WorkflowYAMLEditorProps) => {
   const monacoRef = useRef<typeof import("monaco-editor") | null>(null);
   const editorRef = useRef<editor.IStandaloneCodeEditor | null>(null);
+  const { getSecrets } = useWorkflowSecrets(workflowId);
+  const { data: secrets } = getSecrets;
 
   const {
     validationErrors,
@@ -81,7 +84,8 @@ export const WorkflowYAMLEditor = ({
       if (editorRef.current && monacoRef.current) {
         validateMustacheExpressions(
           editorRef.current.getModel(),
-          monacoRef.current
+          monacoRef.current,
+          secrets ?? {}
         );
       }
     },
@@ -117,7 +121,8 @@ export const WorkflowYAMLEditor = ({
     if (isEditorMounted && editorRef.current && monacoRef.current) {
       validateMustacheExpressions(
         editorRef.current.getModel(),
-        monacoRef.current
+        monacoRef.current,
+        secrets ?? {}
       );
     }
   }, [validateMustacheExpressions, isEditorMounted]);

keep-ui/utils/hooks/useWorkflowSecrets.ts

@@ -2,7 +2,7 @@ import { useState } from "react";
 import { useApi } from "@/shared/lib/hooks/useApi";
 import useSWR from "swr";
 
-export function useWorkflowSecrets(workflowId: string | null) {
+export function useWorkflowSecrets(workflowId: string | null | undefined) {
   const api = useApi();
   const [error, setError] = useState<string>("");
 

keep/providers/http_provider/http_provider.py

@@ -56,6 +56,7 @@ def _notify(
         body: dict = None,
         params: dict = None,
         proxies: dict = None,
+        verify: bool = True,
         **kwargs,
     ):
         """
@@ -68,6 +69,7 @@ def _notify(
             body=body,
             params=params,
             proxies=proxies,
+            verify=verify,
             **kwargs,
         )
 
@@ -80,6 +82,7 @@ def _query(
         params: dict = None,
         proxies: dict = None,
         fail_on_error: bool = True,
+        verify: bool = True,
         **kwargs: dict,
     ) -> dict:
         """
@@ -107,19 +110,39 @@ def _query(
         )
         if method == "GET":
             response = requests.get(
-                url, headers=headers, params=params, proxies=proxies, **kwargs
+                url,
+                headers=headers,
+                params=params,
+                proxies=proxies,
+                verify=verify,
+                **kwargs,
             )
         elif method == "POST":
             response = requests.post(
-                url, headers=headers, json=body, proxies=proxies, **kwargs
+                url,
+                headers=headers,
+                json=body,
+                proxies=proxies,
+                verify=verify,
+                **kwargs,
             )
         elif method == "PUT":
             response = requests.put(
-                url, headers=headers, json=body, proxies=proxies, **kwargs
+                url,
+                headers=headers,
+                json=body,
+                proxies=proxies,
+                verify=verify,
+                **kwargs,
             )
         elif method == "DELETE":
             response = requests.delete(
-                url, headers=headers, json=body, proxies=proxies, **kwargs
+                url,
+                headers=headers,
+                json=body,
+                proxies=proxies,
+                verify=verify,
+                **kwargs,
             )
         else:
             raise Exception(f"Unsupported HTTP method: {method}")

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "keep"
-version = "0.41.18"
+version = "0.41.19"
 description = "Alerting. for developers, by developers."
 authors = ["Keep Alerting LTD"]
 packages = [{include = "keep"}]