Merge branch 'main' into hmg/tag

Author: talboren

.github/workflows/test-pr-integrations.yml

@@ -5,9 +5,11 @@ on:
       - main
     paths:
       - "keep/**"
+      - "tests/**"
   pull_request:
     paths:
       - "keep/**"
+      - "tests/**"
   workflow_dispatch:
 
 permissions:

.github/workflows/test-pr-ut.yml

@@ -5,9 +5,11 @@ on:
       - main
     paths:
       - "keep/**"
+      - "tests/**"
   pull_request:
     paths:
       - "keep/**"
+      - "tests/**"
   workflow_dispatch:
 
 permissions:

.gitignore

@@ -218,6 +218,7 @@ scripts/keep_slack_bot.py
 providers_cache.json
 
 tests/provision/*
+!tests/provision/workflows*
 grafana/*
 !grafana/provisioning/
 !grafana/dashboards/

docs/providers/documentation/teams-provider.mdx

@@ -83,6 +83,7 @@ When using Adaptive Cards (`typeCard="message"`):
 - `themeColor` is ignored for Adaptive Cards
 - If no sections are provided, the message will be displayed as a simple text block
 - Both `sections` and `attachments` can be provided as JSON strings or arrays
+- You can mention users in your Adaptive Cards using the `mentions` parameter
 
 ### Workflow Example
 
@@ -112,8 +113,12 @@ actions:
         message: ""
         sections: '[{"type": "TextBlock", "text": "{{alert.name}}"}, {"type": "TextBlock", "text": "Tal from Keep"}]'
         typeCard: message
+        # Optional: Add mentions to notify specific users
+        # mentions: '[{"id": "user@example.com", "name": "User Name"}]'
 ```
 
+You can also find an example with user mentions in our [examples](https://github.com/keephq/keep/tree/main/examples/workflows/keep-teams-adaptive-cards-with-mentions.yaml) folder.
+
 <Note>
     The sections parameter is a JSON string that follows the Adaptive Cards schema, but can also be an object.
     If it's a string, it will be parsed as a JSON string.
@@ -159,6 +164,71 @@ provider.notify(
 )
 ```
 
+### Using User Mentions in Adaptive Cards
+
+You can mention users in your Adaptive Cards using the `mentions` parameter. The text in your card should include the mention in the format `<at>User Name</at>`, and you need to provide the user's ID and name in the `mentions` parameter.
+
+Teams supports three types of user IDs for mentions:
+- Teams User ID (format: `29:1234...`)
+- Microsoft Entra Object ID (format: `49c4641c-ab91-4248-aebb-6a7de286397b`)
+- User Principal Name (UPN) (format: `user@example.com`)
+
+```python
+provider.notify(
+    typeCard="message",
+    sections=[
+        {
+            "type": "TextBlock",
+            "text": "Hello <at>John Doe</at>, please review this alert!"
+        }
+    ],
+    mentions=[
+        {
+            "id": "john.doe@example.com",  # Can be UPN, Microsoft Entra Object ID, or Teams User ID
+            "name": "John Doe"
+        }
+    ]
+)
+```
+
+You can also mention multiple users in a single card:
+
+```python
+provider.notify(
+    typeCard="message",
+    sections=[
+        {
+            "type": "TextBlock",
+            "text": "Hello <at>John Doe</at> and <at>Jane Smith</at>, please review this alert!"
+        }
+    ],
+    mentions=[
+        {
+            "id": "john.doe@example.com",
+            "name": "John Doe"
+        },
+        {
+            "id": "49c4641c-ab91-4248-aebb-6a7de286397b",  # Microsoft Entra Object ID
+            "name": "Jane Smith"
+        }
+    ]
+)
+```
+
+In YAML workflows, you can provide the mentions as a JSON string:
+
+```yaml
+actions:
+  - name: teams-action
+    provider:
+      config: "{{ providers.teams }}"
+      type: teams
+      with:
+        typeCard: message
+        sections: '[{"type": "TextBlock", "text": "Hello <at>John Doe</at>, please review this alert!"}]'
+        mentions: '[{"id": "john.doe@example.com", "name": "John Doe"}]'
+```
+
 ## Useful Links
 
 - https://learn.microsoft.com/pt-br/microsoftteams/platform/webhooks-and-connectors/how-to/add-incoming-webhook

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

@@ -1,4 +1,4 @@
-{/* This snippet is automatically generated using scripts/docs_render_provider_snippets.py 
+{/* This snippet is automatically generated using scripts/docs_render_provider_snippets.py
 Do not edit it manually, as it will be overwritten */}
 
 ## Authentication
@@ -25,11 +25,14 @@ actions:
         sections: {value}  # For MessageCard: Array of custom information sections. For Adaptive Cards: Array of card elements following the Adaptive Card schema. Can be provided as a JSON string or array.
         schema: {value}  # Schema URL for Adaptive Cards. Default is "http://adaptivecards.io/schemas/adaptive-card.json"
         attachments: {value}  # Custom attachments array for Adaptive Cards (overrides default attachment structure). Can be provided as a JSON string or array.
+        mentions: {value}  # List of user mentions to include in the Adaptive Card. Each mention should be a dict with 'id' (user ID, Microsoft Entra Object ID, or UPN) and 'name' (display name) keys.
+Example: [{"id": "user-id-123", "name": "John Doe"}, {"id": "john.doe@example.com", "name": "John Doe"}]
 ```
 
 
 
 
 Check the following workflow examples:
 - [create_jira_ticket_upon_alerts.yml](https://github.com/keephq/keep/blob/main/examples/workflows/create_jira_ticket_upon_alerts.yml)
+- [keep-teams-adaptive-cards-with-mentions.yaml](https://github.com/keephq/keep/blob/main/examples/workflows/keep-teams-adaptive-cards-with-mentions.yaml)
 - [keep-teams-adaptive-cards.yaml](https://github.com/keephq/keep/blob/main/examples/workflows/keep-teams-adaptive-cards.yaml)

docs/workflows/syntax/functions.mdx

@@ -38,6 +38,37 @@ steps:
 ```
 ---
 
+### `capitalize`
+
+**Description:** Capitalizes the first character of a string.
+**Example:**
+
+```yaml
+steps:
+  - name: example-step
+    provider:
+      type: mock
+      with:
+        message: keep.capitalize("hello world") # Output: "Hello world"
+```
+
+---
+
+### `title`
+
+**Description:** Converts a string to title case (capitalizes each word).
+**Example:**
+
+```yaml
+steps:
+  - name: example-step
+    provider:
+      type: mock
+      with:
+        message: keep.title("hello world") # Output: "Hello World"
+```
+---
+
 ### `split`
 
 **Description:** Splits a string into a list using a delimiter.
@@ -389,7 +420,7 @@ steps:
 
 ## Utility Functions
 
-### `is_first_time`
+### `get_firing_time`
 
 **Description:** Calculates the firing duration of an alert in specified time units.
 **Example:**
@@ -406,7 +437,7 @@ steps:
 
 ---
 
-### `is_first_time`
+### `add_time_to_date`
 
 **Description:** Adds time to a date string based on specified time units.
 **Example:**
@@ -422,3 +453,48 @@ steps:
 ```
 
 ---
+
+### `timestamp_delta`
+
+**Description:** Adds or subtracts a time delta to/from a datetime. Use negative values to subtract time.
+**Example:**
+
+```yaml
+steps:
+  - name: example-step
+    provider:
+      type: mock
+      with:
+        # Add 2 hours to the current time
+        add_hours: keep.timestamp_delta(keep.utcnow(), 2, "hours")
+
+        # Subtract 30 minutes from a specific datetime
+        subtract_minutes: keep.timestamp_delta("2024-01-01T12:00:00Z", -30, "minutes") # Output: 2024-01-01T11:30:00Z
+
+        # Add 1 week to a datetime
+        add_week: keep.timestamp_delta("2024-01-01T00:00:00Z", 1, "weeks") # Output: 2024-01-08T00:00:00Z
+
+```
+
+---
+
+### `is_first_time`
+
+**Description:** Checks if an alert with a given fingerprint is firing for the first time or first time within a specified period.
+**Example:**
+
+```yaml
+steps:
+  - name: example-step
+    provider:
+      type: mock
+      with:
+        # Check if this is the first time the alert is firing
+        first_time: keep.is_first_time(alert.fingerprint, tenant_id="tenant-id")
+
+        # Check if this is the first time the alert is firing in the last 24 hours
+        first_time_24h: keep.is_first_time(alert.fingerprint, "24h", tenant_id="tenant-id")
+
+```
+
+---

examples/workflows/keep-teams-adaptive-cards-with-mentions.yaml

@@ -0,0 +1,24 @@
+workflow:
+  id: teams-adaptive-card-with-mentions
+  name: Teams Adaptive Card With Mentions
+  description: Sends Microsoft Teams notifications using Adaptive Cards with user mentions to notify specific team members.
+  disabled: false
+  triggers:
+    - type: manual
+    - filters:
+        - key: source
+          value: r".*"
+      type: alert
+  consts: {}
+  owners: []
+  services: []
+  steps: []
+  actions:
+    - name: teams-action
+      provider:
+        config: "{{ providers.teams }}"
+        type: teams
+        with:
+          typeCard: message
+          sections: '[{"type": "TextBlock", "text": "Alert: {{alert.name}}"}, {"type": "TextBlock", "text": "Hello <at>John Doe</at>, please review this alert!"}, {"type": "TextBlock", "text": "Severity: {{alert.severity}}"}]'
+          mentions: '[{"id": "john.doe@example.com", "name": "John Doe"}]'

examples/workflows/keep-teams-adaptive-cards.yaml

@@ -2,23 +2,23 @@ workflow:
   id: teams-adaptive-card-notifier
   name: Teams Adaptive Card Notifier
   description: Sends customized Microsoft Teams notifications using Adaptive Cards with dynamic alert information and formatted sections.
-disabled: false
-triggers:
-  - type: manual
-  - filters:
-      - key: source
-        value: r".*"
-    type: alert
-consts: {}
-owners: []
-services: []
-steps: []
-actions:
-  - name: teams-action
-    provider:
-      config: "{{ providers.teams }}"
-      type: teams
-      with:
-        message: ""
-        sections: '[{"type": "TextBlock", "text": "{{alert.name}}"}, {"type": "TextBlock", "text": "Tal from Keep"}]'
-        typeCard: message
+  disabled: false
+  triggers:
+    - type: manual
+    - filters:
+        - key: source
+          value: r".*"
+      type: alert
+  consts: {}
+  owners: []
+  services: []
+  steps: []
+  actions:
+    - name: teams-action
+      provider:
+        config: "{{ providers.teams }}"
+        type: teams
+        with:
+          message: ""
+          sections: '[{"type": "TextBlock", "text": "{{alert.name}}"}, {"type": "TextBlock", "text": "Tal from Keep"}]'
+          typeCard: message

keep-ui/features/cel-input/cel-input.tsx

@@ -12,6 +12,7 @@ interface CelInputProps {
   onClearValue?: () => void;
   onKeyDown?: (e: KeyboardEvent) => void;
   onFocus?: () => void;
+  onIsValidChange?: (isValid: boolean) => void;
   placeholder?: string;
   disabled?: boolean;
 }
@@ -21,6 +22,7 @@ const CelInput: FC<CelInputProps> = ({
   value = "",
   fieldsForSuggestions = [],
   onValueChange,
+  onIsValidChange,
   onClearValue,
   onKeyDown,
   onFocus,
@@ -35,6 +37,7 @@ const CelInput: FC<CelInputProps> = ({
         value={value}
         fieldsForSuggestions={fieldsForSuggestions}
         onValueChange={onValueChange || ((value: string) => {})}
+        onIsValidChange={onIsValidChange}
         onKeyDown={onKeyDown}
         onFocus={onFocus}
       />

keep-ui/features/presets/presets-manager/ui/alerts-rules-builder.tsx

@@ -320,25 +320,6 @@ export const AlertsRulesBuilder = ({
   const handleKeyDown = (e: KeyboardEvent) => {
     if (e.key === "Enter") {
       e.preventDefault(); // Prevents the default action of Enter key in a form
-      // You can now use `target` which is asserted to be an HTMLTextAreaElement
-
-      // check if the CEL is valid by comparing the parsed query with the original CEL
-      // remove spaces so that "a && b" is the same as "a&&b"
-      const celQuery = formatQuery(parsedCELRulesToQuery, "cel");
-      /*
-      SHAHAR: this is the old way of checking if the CEL is valid
-              I think its over complicated so let's just check if the query is "1 == 1" (which is parse error)
-              I'll leave the old code here for reference
-
-      const isValidCEL =
-        celQuery.replace(/\s+/g, "") === celRules.replace(/\s+/g, "") ||
-        celRules === "";
-      */
-
-      // SHAHAR: new way of checking if the CEL is valid
-      const isValidCEL = celRules == "" || celQuery !== "1 == 1";
-      setIsValidCEL(isValidCEL);
-
       // close the menu
       setShowSuggestions(false);
       if (isValidCEL) {
@@ -464,6 +445,7 @@ export const AlertsRulesBuilder = ({
                   value={celRules}
                   fieldsForSuggestions={alertFields}
                   onValueChange={onValueChange}
+                  onIsValidChange={setIsValidCEL}
                   onClearValue={handleClearInput}
                   onKeyDown={handleKeyDown}
                   onFocus={() => setShowSuggestions(true)}

keep-ui/features/workflows/test-run/ui/workflow-test-run-button.tsx

@@ -38,6 +38,10 @@ export function WorkflowTestRunButton({
     const workflow = getYamlWorkflowDefinition(definition.value);
     // NOTE: prevent the workflow from being disabled, so test run doesn't fail
     workflow.disabled = false;
+    if (workflowId) {
+      // if existing workflow, use it's real id for test run
+      workflow.id = workflowId;
+    }
     const body = getBodyFromStringOrDefinitionOrObject({
       workflow,
     });