Allow ignoring updates by specific users

Author: marko-bekhta

src/main/java/org/hibernate/infra/replicate/jira/JiraConfig.java

@@ -366,6 +366,14 @@ interface UserValueMapping extends ValueMapping {
 		 * {@link #mapping() mapping}.
 		 */
 		Optional<String> profileUrl();
+
+		/**
+		 * It may be helpful in some cases to ignore webhook events triggered by some
+		 * users. E.g. the sync user that applies updates upstream can be listed here to
+		 * prevent infinite update loop.
+		 */
+		@WithDefault("not-a-user")
+		Set<String> ignoredUpstreamUsers();
 	}
 
 	/**

src/main/java/org/hibernate/infra/replicate/jira/resource/JiraWebHookListenerResource.java

@@ -12,6 +12,7 @@
 import jakarta.ws.rs.Consumes;
 import jakarta.ws.rs.POST;
 import jakarta.ws.rs.Path;
+import jakarta.ws.rs.QueryParam;
 import jakarta.ws.rs.core.MediaType;
 
 @Path("/jira/webhooks")
@@ -24,9 +25,9 @@ public class JiraWebHookListenerResource {
 	@Path("/{project}")
 	@Consumes(MediaType.APPLICATION_JSON)
 	public String somethingHappenedUpstream(@RestPath @NotNull @ConfiguredProject String project,
-			JiraWebHookEvent event) {
+			@QueryParam("triggeredByUser") String triggeredByUser, JiraWebHookEvent event) {
 		Log.infof("Received a notification about %s project: %.200s...", project, event);
-		jiraService.acknowledge(project, event);
+		jiraService.acknowledge(project, event, triggeredByUser);
 		return "ack";
 	}
 }

src/main/java/org/hibernate/infra/replicate/jira/service/jira/HandlerProjectContext.java

@@ -347,4 +347,8 @@ private static boolean versionNeedsUpdate(JiraVersion upstreamVersion, JiraVersi
 				|| upstreamVersion.released != downstreamVersion.released
 				|| !Objects.equals(upstreamVersion.releaseDate, downstreamVersion.releaseDate);
 	}
+
+	public boolean isUserIgnored(String triggeredByUser) {
+		return projectGroupContext.projectGroup().users().ignoredUpstreamUsers().contains(triggeredByUser);
+	}
 }

src/main/java/org/hibernate/infra/replicate/jira/service/jira/JiraService.java

@@ -46,6 +46,8 @@
 @ApplicationScoped
 public class JiraService {
 
+	private static final String SYSTEM_USER = "94KJcxFzgxZlXyTss4oR0rDNqtjwjhIiZLzYNx0Mwuc=";
+
 	private final ReportingConfig reportingConfig;
 	private final Map<String, HandlerProjectContext> contextPerProject;
 	private final JiraConfig jiraConfig;
@@ -297,8 +299,10 @@ public void registerManagementRoutes(@Observes ManagementInterface mi) {
 	 *            {@link JiraConfig.JiraProjectGroup#projects()}
 	 * @param event
 	 *            The body of the event posted by the webhook.
+	 * @param triggeredByUser
+	 *            The ID of the Jira user that triggered the webhook event.
 	 */
-	public void acknowledge(String project, JiraWebHookEvent event) {
+	public void acknowledge(String project, JiraWebHookEvent event, String triggeredByUser) {
 		event.eventType().ifPresentOrElse(eventType -> {
 			var context = contextPerProject.get(project);
 			if (context == null) {
@@ -309,6 +313,11 @@ public void acknowledge(String project, JiraWebHookEvent event) {
 				throw new ConstraintViolationException("Project " + project + " is not configured.", Set.of());
 			}
 
+			if (context.isUserIgnored(triggeredByUser)) {
+				Log.infof("Event was triggered by %s user that is in the ignore list.", triggeredByUser);
+				return;
+			}
+
 			for (Runnable handler : eventType.handlers(reportingConfig, event, context)) {
 				context.submitTask(handler);
 			}
@@ -381,7 +390,7 @@ private void triggerSyncEvent(JiraIssue jiraIssue, HandlerProjectContext context
 		event.issue = issue;
 
 		String projectKey = Objects.toString(jiraIssue.fields.project.properties().get("key"));
-		acknowledge(projectKey, event);
+		acknowledge(projectKey, event, SYSTEM_USER);
 
 		// now sync comments:
 		if (jiraIssue.fields.comment != null && jiraIssue.fields.comment.comments != null) {
@@ -401,7 +410,7 @@ private void triggerSyncEvent(JiraIssue jiraIssue, HandlerProjectContext context
 				event.issueLink = new JiraWebHookIssueLink();
 				event.issueLink.id = Long.parseLong(link.id);
 
-				acknowledge(projectKey, event);
+				acknowledge(projectKey, event, SYSTEM_USER);
 			}
 		}
 	}
@@ -413,7 +422,7 @@ private void triggerCommentSyncEvents(String projectKey, JiraWebHookIssue issue,
 			event.comment.id = Long.parseLong(comment.id);
 			event.issue = issue;
 			event.webhookEvent = JiraWebhookEventType.COMMENT_UPDATED.getName();
-			acknowledge(projectKey, event);
+			acknowledge(projectKey, event, SYSTEM_USER);
 		}
 	}
 }