|
| 1 | +package org.jenkinsci.plugins.github.admin; |
| 2 | + |
| 3 | +import java.time.Duration; |
| 4 | +import java.time.Instant; |
| 5 | +import java.util.Set; |
| 6 | +import java.util.logging.Logger; |
| 7 | +import java.util.stream.Collectors; |
| 8 | + |
| 9 | +import com.github.benmanes.caffeine.cache.Cache; |
| 10 | +import com.github.benmanes.caffeine.cache.Caffeine; |
| 11 | +import com.github.benmanes.caffeine.cache.Ticker; |
| 12 | +import com.google.common.annotations.VisibleForTesting; |
| 13 | + |
| 14 | +import hudson.Extension; |
| 15 | +import hudson.ExtensionList; |
| 16 | +import hudson.model.AdministrativeMonitor; |
| 17 | +import hudson.model.Item; |
| 18 | +import jenkins.model.Jenkins; |
| 19 | +import org.jenkinsci.plugins.github.Messages; |
| 20 | +import org.jenkinsci.plugins.github.extension.GHEventsSubscriber; |
| 21 | +import org.jenkinsci.plugins.github.extension.GHSubscriberEvent; |
| 22 | +import org.kohsuke.accmod.Restricted; |
| 23 | +import org.kohsuke.accmod.restrictions.NoExternalUse; |
| 24 | +import org.kohsuke.github.GHEvent; |
| 25 | +import org.kohsuke.stapler.HttpResponse; |
| 26 | +import org.kohsuke.stapler.WebMethod; |
| 27 | +import org.kohsuke.stapler.json.JsonHttpResponse; |
| 28 | +import org.kohsuke.stapler.verb.GET; |
| 29 | +import edu.umd.cs.findbugs.annotations.Nullable; |
| 30 | +import net.sf.json.JSONObject; |
| 31 | + |
| 32 | +@SuppressWarnings("unused") |
| 33 | +@Extension |
| 34 | +public class GitHubDuplicateEventsMonitor extends AdministrativeMonitor { |
| 35 | + |
| 36 | + @VisibleForTesting |
| 37 | + static final String LAST_DUPLICATE_CLICK_HERE_ANCHOR_ID = GitHubDuplicateEventsMonitor.class.getName() |
| 38 | + + ".last-duplicate"; |
| 39 | + |
| 40 | + @Override |
| 41 | + public String getDisplayName() { |
| 42 | + return Messages.duplicate_events_administrative_monitor_displayname(); |
| 43 | + } |
| 44 | + |
| 45 | + public String getDescription() { |
| 46 | + return Messages.duplicate_events_administrative_monitor_description(); |
| 47 | + } |
| 48 | + |
| 49 | + public String getBlurb() { |
| 50 | + return Messages.duplicate_events_administrative_monitor_blurb( |
| 51 | + LAST_DUPLICATE_CLICK_HERE_ANCHOR_ID, this.getLastDuplicateUrl()); |
| 52 | + } |
| 53 | + |
| 54 | + @VisibleForTesting |
| 55 | + String getLastDuplicateUrl() { |
| 56 | + return this.getUrl() + "/" + "last-duplicate.json"; |
| 57 | + } |
| 58 | + |
| 59 | + @Override |
| 60 | + public boolean isActivated() { |
| 61 | + return ExtensionList.lookupSingleton(DuplicateEventsSubscriber.class).isDuplicateEventSeen(); |
| 62 | + } |
| 63 | + |
| 64 | + @Override |
| 65 | + public boolean hasRequiredPermission() { |
| 66 | + return Jenkins.get().hasPermission(Jenkins.SYSTEM_READ); |
| 67 | + } |
| 68 | + |
| 69 | + @Override |
| 70 | + public void checkRequiredPermission() { |
| 71 | + Jenkins.get().checkPermission(Jenkins.SYSTEM_READ); |
| 72 | + } |
| 73 | + |
| 74 | + @GET |
| 75 | + @WebMethod(name = "last-duplicate.json") |
| 76 | + public HttpResponse doGetLastDuplicatePayload() { |
| 77 | + Jenkins.get().checkPermission(Jenkins.SYSTEM_READ); |
| 78 | + JSONObject data; |
| 79 | + var lastDuplicate = ExtensionList.lookupSingleton(DuplicateEventsSubscriber.class).getLastDuplicate(); |
| 80 | + if (lastDuplicate != null) { |
| 81 | + data = JSONObject.fromObject(lastDuplicate.ghSubscriberEvent().getPayload()); |
| 82 | + } else { |
| 83 | + data = getLastDuplicateNoEventPayload(); |
| 84 | + } |
| 85 | + return new JsonHttpResponse(data, 200); |
| 86 | + } |
| 87 | + |
| 88 | + @VisibleForTesting |
| 89 | + static JSONObject getLastDuplicateNoEventPayload() { |
| 90 | + return new JSONObject().accumulate("payload", "No duplicate events seen yet"); |
| 91 | + } |
| 92 | + |
| 93 | + /** |
| 94 | + * Tracks duplicate {@link GHEvent} triggering actions in Jenkins. |
| 95 | + * Events are tracked for 10 minutes, with the last detected duplicate reference retained for up to 24 hours |
| 96 | + * (see {@link #isDuplicateEventSeen}). |
| 97 | + * <p> |
| 98 | + * Duplicates are stored in-memory only, so a controller restart clears all entries as if none existed. |
| 99 | + * Persistent storage is omitted for simplicity, since webhook misconfigurations would likely cause new duplicates. |
| 100 | + */ |
| 101 | + @Extension |
| 102 | + public static final class DuplicateEventsSubscriber extends GHEventsSubscriber { |
| 103 | + |
| 104 | + private static final Logger LOGGER = Logger.getLogger(DuplicateEventsSubscriber.class.getName()); |
| 105 | + |
| 106 | + private Ticker ticker = Ticker.systemTicker(); |
| 107 | + /** |
| 108 | + * Caches GitHub event GUIDs for 10 minutes to track recent events to detect duplicates. |
| 109 | + * <p> |
| 110 | + * Only the keys (event GUIDs) are relevant, as Caffeine automatically handles expiration based |
| 111 | + * on insertion time; the value is irrelevant, we put {@link #DUMMY}, as Caffeine doesn't provide any |
| 112 | + * Set structures. |
| 113 | + * <p> |
| 114 | + * Maximum cache size is set to 24k so it doesn't grow unbound (approx. 1MB). Each key takes 36 bytes, and |
| 115 | + * timestamp (assuming caffeine internally keeps long) takes 8 bytes; total of 44 bytes |
| 116 | + * per entry. So the maximum memory consumed by this cache is 24k * 44 = 1056k = 1.056 MB. |
| 117 | + */ |
| 118 | + private final Cache<String, Object> eventTracker = Caffeine.newBuilder() |
| 119 | + .maximumSize(24_000L) |
| 120 | + .expireAfterWrite(Duration.ofMinutes(10)) |
| 121 | + .ticker(() -> ticker.read()) |
| 122 | + .build(); |
| 123 | + private static final Object DUMMY = new Object(); |
| 124 | + |
| 125 | + private volatile TrackedDuplicateEvent lastDuplicate; |
| 126 | + public record TrackedDuplicateEvent( |
| 127 | + String eventGuid, Instant lastUpdated, GHSubscriberEvent ghSubscriberEvent) { } |
| 128 | + private static final Duration TWENTY_FOUR_HOURS = Duration.ofHours(24); |
| 129 | + |
| 130 | + @VisibleForTesting |
| 131 | + @Restricted(NoExternalUse.class) |
| 132 | + void setTicker(Ticker testTicker) { |
| 133 | + ticker = testTicker; |
| 134 | + } |
| 135 | + |
| 136 | + /** |
| 137 | + * This subscriber is not applicable to any item |
| 138 | + * |
| 139 | + * @param item ignored |
| 140 | + * @return always false |
| 141 | + */ |
| 142 | + @Override |
| 143 | + protected boolean isApplicable(@Nullable Item item) { |
| 144 | + return false; |
| 145 | + } |
| 146 | + |
| 147 | + /** |
| 148 | + * {@inheritDoc} |
| 149 | + * <p> |
| 150 | + * Subscribes to events that trigger actions in Jenkins, such as repository scans or builds. |
| 151 | + * <p> |
| 152 | + * The {@link GHEvent} enum defines about 63 events, but not all are relevant to Jenkins. |
| 153 | + * Tracking unnecessary events increases memory usage, and they occur more frequently than those triggering any |
| 154 | + * work. |
| 155 | + * <p> |
| 156 | + * <a href="https://docs.github.com/en/webhooks/webhook-events-and-payloads"> |
| 157 | + * Documentation reference (also referenced in {@link GHEvent})</a> |
| 158 | + */ |
| 159 | + @Override |
| 160 | + protected Set<GHEvent> events() { |
| 161 | + return Set.of( |
| 162 | + GHEvent.CHECK_RUN, // associated with GitHub action Re-run button to trigger build |
| 163 | + GHEvent.CHECK_SUITE, // associated with GitHub action Re-run button to trigger build |
| 164 | + GHEvent.CREATE, // branch or tag creation |
| 165 | + GHEvent.DELETE, // branch or tag deletion |
| 166 | + GHEvent.PULL_REQUEST, // PR creation (also PR close or merge) |
| 167 | + GHEvent.PUSH // commit push |
| 168 | + ); |
| 169 | + } |
| 170 | + |
| 171 | + @Override |
| 172 | + protected void onEvent(final GHSubscriberEvent event) { |
| 173 | + String eventGuid = event.getEventGuid(); |
| 174 | + LOGGER.fine(() -> "Received event with GUID: " + eventGuid); |
| 175 | + if (eventGuid == null) { |
| 176 | + return; |
| 177 | + } |
| 178 | + if (eventTracker.getIfPresent(eventGuid) != null) { |
| 179 | + lastDuplicate = new TrackedDuplicateEvent(eventGuid, getNow(), event); |
| 180 | + } |
| 181 | + eventTracker.put(eventGuid, DUMMY); |
| 182 | + } |
| 183 | + |
| 184 | + /** |
| 185 | + * Checks if a duplicate event was recorded in the past 24 hours. |
| 186 | + * <p> |
| 187 | + * Events are not stored for 24 hours—only the most recent duplicate is checked within this timeframe. |
| 188 | + * |
| 189 | + * @return {@code true} if a duplicate was seen in the last 24 hours, {@code false} otherwise. |
| 190 | + */ |
| 191 | + public boolean isDuplicateEventSeen() { |
| 192 | + return lastDuplicate != null |
| 193 | + && Duration.between(lastDuplicate.lastUpdated(), getNow()).compareTo(TWENTY_FOUR_HOURS) < 0; |
| 194 | + } |
| 195 | + |
| 196 | + private Instant getNow() { |
| 197 | + return Instant.ofEpochSecond(0L, ticker.read()); |
| 198 | + } |
| 199 | + |
| 200 | + public TrackedDuplicateEvent getLastDuplicate() { |
| 201 | + return lastDuplicate; |
| 202 | + } |
| 203 | + |
| 204 | + /** |
| 205 | + * Caffeine expired keys are not removed immediately. Method returns the non-expired keys; |
| 206 | + * required for the tests. |
| 207 | + */ |
| 208 | + @VisibleForTesting |
| 209 | + @Restricted(NoExternalUse.class) |
| 210 | + Set<String> getPresentEventKeys() { |
| 211 | + return eventTracker.asMap().keySet().stream() |
| 212 | + .filter(key -> eventTracker.getIfPresent(key) != null) |
| 213 | + .collect(Collectors.toSet()); |
| 214 | + } |
| 215 | + } |
| 216 | +} |
0 commit comments