[RHCLOUD-28663] Add a query parameter to links in Events emitted by Notifications

connector-pagerduty/src/main/java/com/redhat/cloud/notifications/connector/pagerduty/PagerDutyTransformer.java

@@ -33,7 +33,6 @@ public class PagerDutyTransformer implements Processor {
     public static final String CONTEXT = "context";
     public static final String CUSTOM_DETAILS = "custom_details";
     public static final String DISPLAY_NAME = "display_name";
-    public static final String ENVIRONMENT_URL = "environment_url";
     public static final String EVENT_ACTION = "event_action";
     public static final String EVENT_TYPE = "event_type";
     public static final String EVENTS = "events";
@@ -58,7 +57,6 @@ public void process(Exchange exchange) {
 
         JsonObject message = new JsonObject();
         message.put(EVENT_ACTION, PagerDutyEventAction.TRIGGER);
-        message.mergeIn(getClientLink(cloudEventPayload, cloudEventPayload.getString(ENVIRONMENT_URL)));
         message.mergeIn(getClientLinks(cloudEventPayload));
 
         JsonObject messagePayload = new JsonObject();
@@ -125,45 +123,6 @@ private void validatePayload(final JsonObject cloudEventPayload) {
         }
     }
 
-    /**
-     * Adapted from CamelProcessor template for Teams, with some changes to more gracefully handle missing fields
-     * <br>
-     * TODO update to work more consistently and with other platforms
-     *
-     * @return {@link #CLIENT} and {@link #CLIENT_URL}
-     */
-    private JsonObject getClientLink(final JsonObject cloudEventPayload, String environmentUrl) {
-        JsonObject clientLink = new JsonObject();
-
-        String contextName = cloudEventPayload.containsKey(CONTEXT)
-                ? cloudEventPayload.getJsonObject(CONTEXT).getString(DISPLAY_NAME)
-                : null;
-
-        if (contextName != null) {
-            clientLink.put(CLIENT, contextName);
-
-            String inventoryId = cloudEventPayload.getJsonObject(CONTEXT).getString("inventory_id");
-            if (environmentUrl != null && !environmentUrl.isEmpty() && inventoryId != null && !inventoryId.isEmpty()) {
-                clientLink.put(CLIENT_URL, String.format("%s/insights/inventory/%s",
-                        environmentUrl,
-                        cloudEventPayload.getJsonObject(CONTEXT).getString("inventory_id")
-                ));
-            }
-        } else {
-            if (environmentUrl != null && !environmentUrl.isEmpty()) {
-                clientLink.put(CLIENT, String.format("Open %s", cloudEventPayload.getString(APPLICATION)));
-                clientLink.put(CLIENT_URL, String.format("%s/insights/%s",
-                        environmentUrl,
-                        cloudEventPayload.getString(APPLICATION)
-                ));
-            } else {
-                clientLink.put(CLIENT, cloudEventPayload.getString(APPLICATION));
-            }
-        }
-
-        return clientLink;
-    }
-
     /**
      * Performs the following link conversions:
      * <ul>

connector-pagerduty/src/test/java/com/redhat/cloud/notifications/connector/pagerduty/PagerDutyTestUtils.java

@@ -14,12 +14,9 @@
 import static com.redhat.cloud.notifications.connector.pagerduty.PagerDutyTransformer.APPLICATION;
 import static com.redhat.cloud.notifications.connector.pagerduty.PagerDutyTransformer.APPLICATION_URL;
 import static com.redhat.cloud.notifications.connector.pagerduty.PagerDutyTransformer.BUNDLE;
-import static com.redhat.cloud.notifications.connector.pagerduty.PagerDutyTransformer.CLIENT;
-import static com.redhat.cloud.notifications.connector.pagerduty.PagerDutyTransformer.CLIENT_URL;
 import static com.redhat.cloud.notifications.connector.pagerduty.PagerDutyTransformer.CONTEXT;
 import static com.redhat.cloud.notifications.connector.pagerduty.PagerDutyTransformer.CUSTOM_DETAILS;
 import static com.redhat.cloud.notifications.connector.pagerduty.PagerDutyTransformer.DISPLAY_NAME;
-import static com.redhat.cloud.notifications.connector.pagerduty.PagerDutyTransformer.ENVIRONMENT_URL;
 import static com.redhat.cloud.notifications.connector.pagerduty.PagerDutyTransformer.EVENTS;
 import static com.redhat.cloud.notifications.connector.pagerduty.PagerDutyTransformer.EVENT_ACTION;
 import static com.redhat.cloud.notifications.connector.pagerduty.PagerDutyTransformer.EVENT_TYPE;
@@ -86,9 +83,8 @@ static JsonObject createIncomingPayload(JsonObject cloudEventData) {
         );
 
         payload.put(SOURCE, source);
-        payload.put(ENVIRONMENT_URL, "https://console.redhat.com");
-        payload.put(INVENTORY_URL, "https://console.redhat.com/insights/inventory/8a4a4f75-5319-4255-9eb5-1ee5a92efd7f");
-        payload.put(APPLICATION_URL, "https://console.redhat.com/insights/default-application");
+        payload.put(INVENTORY_URL, "https://console.redhat.com/insights/inventory/8a4a4f75-5319-4255-9eb5-1ee5a92efd7f?from=notification_pagerduty");
+        payload.put(APPLICATION_URL, "https://console.redhat.com/insights/default-application?from=notification_pagerduty");
         payload.put(SEVERITY, PagerDutySeverity.WARNING);
         cloudEventData.put(PAYLOAD, payload);
 
@@ -102,7 +98,6 @@ static JsonObject buildExpectedOutgoingPayload(final JsonObject incoming) {
 
         JsonObject oldInnerPayload = expected.getJsonObject(PAYLOAD);
         expected.put(EVENT_ACTION, PagerDutyEventAction.TRIGGER);
-        expected.mergeIn(getClientLink(oldInnerPayload, oldInnerPayload.getString(ENVIRONMENT_URL)));
         expected.mergeIn(getClientLinks(oldInnerPayload));
 
         JsonObject newInnerPayload = new JsonObject();
@@ -140,36 +135,4 @@ static JsonObject buildExpectedOutgoingPayload(final JsonObject incoming) {
         expected.put(PAYLOAD, newInnerPayload);
         return expected;
     }
-
-    private static JsonObject getClientLink(final JsonObject oldInnerPayload, String environmentUrl) {
-        JsonObject clientLink = new JsonObject();
-
-        String contextName = oldInnerPayload.containsKey(CONTEXT)
-                ? oldInnerPayload.getJsonObject(CONTEXT).getString(DISPLAY_NAME)
-                : null;
-
-        if (contextName != null) {
-            clientLink.put(CLIENT, contextName);
-
-            String inventoryId = oldInnerPayload.getJsonObject(CONTEXT).getString("inventory_id");
-            if (environmentUrl != null && !environmentUrl.isEmpty() && inventoryId != null && !inventoryId.isEmpty()) {
-                clientLink.put(CLIENT_URL, String.format("%s/insights/inventory/%s",
-                        environmentUrl,
-                        oldInnerPayload.getJsonObject(CONTEXT).getString("inventory_id")
-                ));
-            }
-        } else {
-            if (environmentUrl != null && !environmentUrl.isEmpty()) {
-                clientLink.put(CLIENT, String.format("Open %s", oldInnerPayload.getString(APPLICATION)));
-                clientLink.put(CLIENT_URL, String.format("%s/insights/%s",
-                        environmentUrl,
-                        oldInnerPayload.getString(APPLICATION)
-                ));
-            } else {
-                clientLink.put(CLIENT, oldInnerPayload.getString(APPLICATION));
-            }
-        }
-
-        return clientLink;
-    }
 }

connector-pagerduty/src/test/java/com/redhat/cloud/notifications/connector/pagerduty/PagerDutyTransformerTest.java

@@ -17,7 +17,6 @@
 import static com.redhat.cloud.notifications.connector.pagerduty.PagerDutyTransformer.APPLICATION;
 import static com.redhat.cloud.notifications.connector.pagerduty.PagerDutyTransformer.CONTEXT;
 import static com.redhat.cloud.notifications.connector.pagerduty.PagerDutyTransformer.DISPLAY_NAME;
-import static com.redhat.cloud.notifications.connector.pagerduty.PagerDutyTransformer.ENVIRONMENT_URL;
 import static com.redhat.cloud.notifications.connector.pagerduty.PagerDutyTransformer.EVENTS;
 import static com.redhat.cloud.notifications.connector.pagerduty.PagerDutyTransformer.EVENT_TYPE;
 import static com.redhat.cloud.notifications.connector.pagerduty.PagerDutyTransformer.INVENTORY_URL;
@@ -112,9 +111,8 @@ void testSuccessfulTestMessage() {
                 )
         );
         cloudEventPayload.put("recipients", JsonArray.of());
-        cloudEventPayload.put("environment_url", "https://console.redhat.com");
         // No inventory_url generated
-        cloudEventPayload.put("application_url", "https://console.redhat.com/settings/integrations");
+        cloudEventPayload.put("application_url", "https://console.redhat.com/settings/integrations?from=notification_pagerduty");
         cloudEventPayload.put("severity", "warning");
         cloudEventData.put(PAYLOAD, cloudEventPayload);
 
@@ -208,20 +206,6 @@ void testMissingEvents() {
         validatePayloadTransform(cloudEventData, expectedPayload);
     }
 
-    @Test
-    void testWithClientDisplayName() {
-        JsonObject cloudEventData = createIncomingPayload(TEST_URL);
-        JsonObject cloudPayload = cloudEventData.getJsonObject(PAYLOAD);
-        cloudPayload.put(CONTEXT, JsonObject.of(
-                DISPLAY_NAME, "console",
-                "inventory_id", "8a4a4f75-5319-4255-9eb5-1ee5a92efd7f"
-        ));
-        cloudEventData.put(PAYLOAD, cloudPayload);
-
-        JsonObject expectedPayload = buildExpectedOutgoingPayload(cloudEventData);
-        validatePayloadTransform(cloudEventData, expectedPayload);
-    }
-
     @Test
     void testWithHostUrl() {
         JsonObject cloudEventData = createIncomingPayload(TEST_URL);
@@ -244,17 +228,6 @@ void testWithMissingClientDisplayName() {
         validatePayloadTransform(cloudEventData, expectedPayload);
     }
 
-    @Test
-    void testWithClientDisplayNameAndInventoryId() {
-        JsonObject cloudEventData = createIncomingPayload(TEST_URL);
-        JsonObject cloudPayload = cloudEventData.getJsonObject(PAYLOAD);
-        cloudPayload.put(CONTEXT, JsonObject.of(
-                DISPLAY_NAME, "console",
-                "inventory_id", "8a4a4f75-5319-4255-9eb5-1ee5a92efd7f"
-        ));
-        cloudEventData.put(PAYLOAD, cloudPayload);
-    }
-
     @Test
     void testWithMissingInventoryId() {
         JsonObject cloudEventData = createIncomingPayload(TEST_URL);
@@ -266,16 +239,6 @@ void testWithMissingInventoryId() {
         validatePayloadTransform(cloudEventData, expectedPayload);
     }
 
-    @Test
-    void testMissingEnvironmentUrl() {
-        JsonObject cloudEventData = createIncomingPayload(TEST_URL);
-        JsonObject cloudPayload = cloudEventData.getJsonObject(PAYLOAD);
-        cloudPayload.remove(ENVIRONMENT_URL);
-
-        JsonObject expectedPayload = buildExpectedOutgoingPayload(cloudEventData);
-        validatePayloadTransform(cloudEventData, expectedPayload);
-    }
-
     @Test
     void testMissingInventoryUrl() {
         JsonObject cloudEventData = createIncomingPayload(TEST_URL);

database/src/main/resources/db/migration/V1.111.0__RHCLOUD-22813_update_template_host_app_urls.sql

@@ -0,0 +1,11 @@
+UPDATE template
+SET data = '{#if data.context.display_name??}<{data.inventory_url}|{data.context.display_name}> triggered {data.events.size()} event{#if data.events.size() > 1}s{/if}{#else}{data.events.size()} event{#if data.events.size() > 1}s{/if} triggered{/if} from {data.source.application.display_name} - {data.source.bundle.display_name}. <{data.application_url}|Open {data.source.application.display_name}>'
+WHERE name = 'generic-slack';
+
+UPDATE template
+SET data = '{"text":"{#if data.context.display_name??}[{data.context.display_name}]({data.inventory_url}) triggered {data.events.size()} event{#if data.events.size() > 1}s{/if}{#else}{data.events.size()} event{#if data.events.size() > 1}s{/if} triggered{/if} from {data.source.application.display_name} - {data.source.bundle.display_name}. [Open {data.source.application.display_name}]({data.application_url})"}'
+WHERE name = 'generic-teams';
+
+UPDATE template
+SET data = '{"text":"{#if data.context.display_name??}<{data.inventory_url}|{data.context.display_name}> triggered {data.events.size()} event{#if data.events.size() > 1}s{/if}{#else}{data.events.size()} event{#if data.events.size() > 1}s{/if} triggered{/if} from {data.source.application.display_name} - {data.source.bundle.display_name}. <{data.application_url}|Open {data.source.application.display_name}>"}'
+WHERE name = 'generic-google-chat';

engine/src/main/java/com/redhat/cloud/notifications/processors/InsightsUrlsBuilder.java

@@ -8,6 +8,7 @@
 import jakarta.inject.Inject;
 
 import java.util.ArrayList;
+import java.util.List;
 import java.util.Optional;
 
 @ApplicationScoped
@@ -32,11 +33,13 @@ public class InsightsUrlsBuilder {
      *
      * @param data a payload converted by
      *             {@link com.redhat.cloud.notifications.transformers.BaseTransformer#toJsonObject(Event) BaseTransformer#toJsonObject(Event)}
+     * @param integration_type a string used to construct the source query param. Inputs will be converted to lowercase,
+     *                         and spaces replaced with underscores. For example, {@code "Google Chat"} becomes {@code from=notification_google_chat}.
      * @return URL to the generating inventory item, if required fields are present
      */
-    public Optional<String> buildInventoryUrl(JsonObject data) {
+    public Optional<String> buildInventoryUrl(JsonObject data, String integration_type) {
         String path;
-        ArrayList<String> queryParamParts = new ArrayList<>();
+        ArrayList<String> queryParamParts = new ArrayList<>(List.of("from=notification_" + integration_type.replace(' ', '_').toLowerCase()));
         JsonObject context = data.getJsonObject("context");
         if (context == null) {
             return Optional.empty();
@@ -45,7 +48,7 @@ public Optional<String> buildInventoryUrl(JsonObject data) {
         // A provided host url does not need to be modified
         String host_url = context.getString("host_url", "");
         if (!host_url.isBlank()) {
-            return Optional.of(host_url);
+            return Optional.of(host_url + "?" + String.join("&", queryParamParts));
         }
 
         String environmentUrl = environment.url();
@@ -68,12 +71,7 @@ public Optional<String> buildInventoryUrl(JsonObject data) {
             return Optional.empty();
         }
 
-        if (!queryParamParts.isEmpty()) {
-            String queryParams = "?" + String.join("&", queryParamParts);
-            path += queryParams;
-        }
-
-        return Optional.of(environmentUrl + path);
+        return Optional.of(environmentUrl + path + "?" + String.join("&", queryParamParts));
     }
 
     /**
@@ -84,10 +82,12 @@ public Optional<String> buildInventoryUrl(JsonObject data) {
      *
      * @param data a payload converted by
      *             {@link com.redhat.cloud.notifications.transformers.BaseTransformer#toJsonObject(Event) BaseTransformer#toJsonObject(Event)}
+     * @param integration_type a string used to construct the source query param (ex. {@code from=notification_instant_email})
      * @return URL to the generating application
      */
-    public String buildApplicationUrl(JsonObject data) {
+    public String buildApplicationUrl(JsonObject data, String integration_type) {
         String path = "";
+        ArrayList<String> queryParamParts = new ArrayList<>(List.of("from=notification_" + integration_type));
 
         String environmentUrl = environment.url();
         String bundle = data.getString("bundle", "");
@@ -104,6 +104,10 @@ public String buildApplicationUrl(JsonObject data) {
         }
 
         path += application;
+        if (!queryParamParts.isEmpty()) {
+            String queryParams = "?" + String.join("&", queryParamParts);
+            path += queryParams;
+        }
 
         return String.format("%s/%s", environmentUrl, path);
     }

engine/src/main/java/com/redhat/cloud/notifications/processors/camel/CamelProcessor.java

@@ -7,7 +7,6 @@
 import com.redhat.cloud.notifications.db.repositories.TemplateRepository;
 import com.redhat.cloud.notifications.models.CamelProperties;
 import com.redhat.cloud.notifications.models.Endpoint;
-import com.redhat.cloud.notifications.models.Environment;
 import com.redhat.cloud.notifications.models.Event;
 import com.redhat.cloud.notifications.models.IntegrationTemplate;
 import com.redhat.cloud.notifications.processors.ConnectorSender;
@@ -34,9 +33,6 @@ public abstract class CamelProcessor extends EndpointTypeProcessor {
     @Inject
     BaseTransformer baseTransformer;
 
-    @Inject
-    Environment environment;
-
     @Inject
     InsightsUrlsBuilder insightsUrlsBuilder;
 
@@ -79,9 +75,8 @@ private void process(Event event, Endpoint endpoint) {
 
     protected String buildNotificationMessage(Event event) {
         JsonObject data = baseTransformer.toJsonObject(event);
-        data.put("environment_url", environment.url());
-        insightsUrlsBuilder.buildInventoryUrl(data).ifPresent(url -> data.put("inventory_url", url));
-        data.put("application_url", insightsUrlsBuilder.buildApplicationUrl(data));
+        insightsUrlsBuilder.buildInventoryUrl(data, getIntegrationType()).ifPresent(url -> data.put("inventory_url", url));
+        data.put("application_url", insightsUrlsBuilder.buildApplicationUrl(data, getIntegrationType()));
 
         Map<Object, Object> dataAsMap;
         try {

engine/src/main/java/com/redhat/cloud/notifications/processors/eventing/EventingProcessor.java

@@ -7,6 +7,7 @@
 import com.redhat.cloud.notifications.models.Event;
 import com.redhat.cloud.notifications.processors.ConnectorSender;
 import com.redhat.cloud.notifications.processors.EndpointTypeProcessor;
+import com.redhat.cloud.notifications.processors.InsightsUrlsBuilder;
 import com.redhat.cloud.notifications.transformers.BaseTransformer;
 import io.micrometer.core.instrument.MeterRegistry;
 import io.quarkus.logging.Log;
@@ -31,6 +32,9 @@ public class EventingProcessor extends EndpointTypeProcessor {
     @Inject
     BaseTransformer baseTransformer;
 
+    @Inject
+    InsightsUrlsBuilder insightsUrlsBuilder;
+
     @Inject
     MeterRegistry registry;
 
@@ -79,6 +83,8 @@ private JsonObject buildPayload(Event event, Endpoint endpoint) {
         }
 
         final JsonObject payload = baseTransformer.toJsonObject(event);
+        insightsUrlsBuilder.buildInventoryUrl(payload, endpoint.getType().name()).ifPresent(url -> payload.put("inventory_url", url));
+        payload.put("application_url", insightsUrlsBuilder.buildApplicationUrl(payload, endpoint.getType().name()));
         payload.put(NOTIF_METADATA_KEY, metaData);
 
         return payload;

engine/src/main/java/com/redhat/cloud/notifications/processors/pagerduty/PagerDutyProcessor.java

@@ -3,7 +3,6 @@
 import com.redhat.cloud.notifications.DelayedThrower;
 import com.redhat.cloud.notifications.config.EngineConfig;
 import com.redhat.cloud.notifications.models.Endpoint;
-import com.redhat.cloud.notifications.models.Environment;
 import com.redhat.cloud.notifications.models.Event;
 import com.redhat.cloud.notifications.models.PagerDutyProperties;
 import com.redhat.cloud.notifications.processors.ConnectorSender;
@@ -35,9 +34,6 @@ public class PagerDutyProcessor extends EndpointTypeProcessor {
     @Inject
     EngineConfig engineConfig;
 
-    @Inject
-    Environment environment;
-
     @Inject
     InsightsUrlsBuilder insightsUrlsBuilder;
 
@@ -77,9 +73,8 @@ private void process(Event event, Endpoint endpoint) {
 
         JsonObject connectorData = new JsonObject();
         JsonObject transformedEvent = transformer.toJsonObject(event);
-        transformedEvent.put("environment_url", environment.url());
-        insightsUrlsBuilder.buildInventoryUrl(transformedEvent).ifPresent(url -> transformedEvent.put("inventory_url", url));
-        transformedEvent.put("application_url", insightsUrlsBuilder.buildApplicationUrl(transformedEvent));
+        insightsUrlsBuilder.buildInventoryUrl(transformedEvent, endpoint.getType().name().toLowerCase()).ifPresent(url -> transformedEvent.put("inventory_url", url));
+        transformedEvent.put("application_url", insightsUrlsBuilder.buildApplicationUrl(transformedEvent, endpoint.getType().name().toLowerCase()));
         transformedEvent.put("severity", properties.getSeverity());
 
         connectorData.put(PAYLOAD, transformedEvent);