[FIXED JENKINS-41811] Expose event origin to listeners

pom.xml

@@ -99,7 +99,13 @@
         <dependency>
             <groupId>org.jenkins-ci.plugins</groupId>
             <artifactId>git</artifactId>
-            <version>2.4.0</version>
+            <version>2.4.0</version> <!-- should really be 2.6.4 to match scm-api but ok as git wass forward compat -->
+        </dependency>
+
+        <dependency>
+            <groupId>org.jenkins-ci.plugins</groupId>
+            <artifactId>scm-api</artifactId>
+            <version>2.0.3</version>
         </dependency>
 
         <dependency>

src/main/java/com/cloudbees/jenkins/GitHubPushTrigger.java

@@ -20,6 +20,7 @@
 import hudson.util.StreamTaskListener;
 import jenkins.model.Jenkins;
 import jenkins.model.ParameterizedJobMixIn;
+import jenkins.scm.api.SCMEvent;
 import jenkins.triggers.SCMTriggerItem.SCMTriggerItems;
 import org.apache.commons.jelly.XMLOutput;
 import org.jenkinsci.plugins.github.GitHubPlugin;
@@ -31,6 +32,7 @@
 import org.kohsuke.accmod.restrictions.NoExternalUse;
 import org.kohsuke.stapler.AncestorInPath;
 import org.kohsuke.stapler.DataBoundConstructor;
+import org.kohsuke.stapler.Stapler;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -57,7 +59,7 @@
  *
  * @author Kohsuke Kawaguchi
  */
-public class GitHubPushTrigger extends Trigger<Job<?, ?>> implements GitHubTrigger {
+public class GitHubPushTrigger extends Trigger<Job<?, ?>> implements GitHubTrigger2 {
 
     @DataBoundConstructor
     public GitHubPushTrigger() {
@@ -75,6 +77,13 @@ public void onPost() {
      * Called when a POST is made.
      */
     public void onPost(String triggeredByUser) {
+        onPost(SCMEvent.originOf(Stapler.getCurrentRequest()), triggeredByUser);
+    }
+
+    /**
+     * Called when a POST is made.
+     */
+    public void onPost(final String origin, String triggeredByUser) {
         final String pushBy = triggeredByUser;
         DescriptorImpl d = getDescriptor();
         d.checkThreadPoolSizeAndUpdateIfNecessary();
@@ -87,6 +96,9 @@ private boolean runPolling() {
                         PrintStream logger = listener.getLogger();
                         long start = System.currentTimeMillis();
                         logger.println("Started on " + DateFormat.getDateTimeInstance().format(new Date()));
+                        if (origin != null) {
+                            logger.println("Started by event from " + origin);
+                        }
                         boolean result = SCMTriggerItems.asSCMTriggerItem(job).poll(listener).hasChanges();
                         logger.println("Done. Took " + Util.getTimeSpanString(System.currentTimeMillis() - start));
                         if (result) {

src/main/java/com/cloudbees/jenkins/GitHubTrigger.java

@@ -15,6 +15,7 @@
  * and triggers a build.
  *
  * @author aaronwalker
+ * @deprecated extend {@link GitHubTrigger2} instead
  */
 public interface GitHubTrigger {
 

src/main/java/com/cloudbees/jenkins/GitHubTrigger2.java

@@ -0,0 +1,15 @@
+package com.cloudbees.jenkins;
+
+import hudson.triggers.Trigger;
+
+/**
+ * Optional interface that can be implemented by {@link Trigger} that watches out for a change in GitHub
+ * and triggers a build.
+ *
+ * @author aaronwalker
+ */
+public interface GitHubTrigger2 extends GitHubTrigger {
+
+    // TODO: document me
+    void onPost(String origin, String triggeredByUser);
+}

src/main/java/com/cloudbees/jenkins/GitHubWebHook.java

@@ -9,14 +9,18 @@
 import hudson.model.UnprotectedRootAction;
 import hudson.util.SequentialExecutionQueue;
 import jenkins.model.Jenkins;
+import jenkins.scm.api.SCMEvent;
 import org.apache.commons.lang3.Validate;
 import org.jenkinsci.plugins.github.GitHubPlugin;
 import org.jenkinsci.plugins.github.extension.GHEventsSubscriber;
 import org.jenkinsci.plugins.github.internal.GHPluginConfigException;
 import org.jenkinsci.plugins.github.webhook.GHEventHeader;
 import org.jenkinsci.plugins.github.webhook.GHEventPayload;
 import org.jenkinsci.plugins.github.webhook.RequirePostWithGHHookPayload;
+import org.kohsuke.accmod.Restricted;
+import org.kohsuke.accmod.restrictions.NoExternalUse;
 import org.kohsuke.github.GHEvent;
+import org.kohsuke.stapler.Stapler;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -114,7 +118,7 @@ public List<Item> reRegisterAllHooks() {
     public void doIndex(@Nonnull @GHEventHeader GHEvent event, @Nonnull @GHEventPayload String payload) {
         from(GHEventsSubscriber.all())
                 .filter(isInterestedIn(event))
-                .transform(processEvent(event, payload)).toList();
+                .transform(processEvent(SCMEvent.originOf(Stapler.getCurrentRequest()), event, payload)).toList();
     }
 
     private <T extends Item> Function<T, T> reRegisterHookForJob() {
@@ -153,7 +157,11 @@ public static Jenkins getJenkinsInstance() throws IllegalStateException {
      * Other plugins may be interested in listening for these updates.
      *
      * @since 1.8
+     * @deprecated working theory is that this API is not required any more with the {@link SCMEvent} based API,
+     * if wrong, please raise a JIRA
      */
+    @Deprecated
+    @Restricted(NoExternalUse.class)
     public abstract static class Listener implements ExtensionPoint {
 
         /**

src/main/java/org/jenkinsci/plugins/github/extension/GHEventsSubscriber.java

@@ -10,9 +10,11 @@
 import java.lang.reflect.Modifier;
 import javax.annotation.CheckForNull;
 import jenkins.model.Jenkins;
+import jenkins.scm.api.SCMEvent;
 import org.jenkinsci.plugins.github.util.misc.NullSafeFunction;
 import org.jenkinsci.plugins.github.util.misc.NullSafePredicate;
 import org.kohsuke.github.GHEvent;
+import org.kohsuke.stapler.StaplerRequest;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -115,15 +117,32 @@ private boolean checkIsApplicableItem() {
      * This method called when root action receives webhook from GH and this extension is interested in such
      * events (provided by {@link #events()} method). By default do nothing and can be overrided to implement any
      * parse logic
-     * Don't call it directly, use {@link #processEvent(GHEvent, String)} static function
+     * Don't call it directly, use {@link #processEvent(String, GHEvent, String)} static function
      *
      * @param event   gh-event (as of PUSH, ISSUE...). One of returned by {@link #events()} method. Never null.
      * @param payload payload of gh-event. Never blank. Can be parsed with help of GitHub#parseEventPayload
+     * @deprecated override {@link #onEvent(String, GHEvent, String)} instead.
      */
+    @Deprecated
     protected void onEvent(GHEvent event, String payload) {
         // do nothing by default
     }
 
+    /**
+     * This method called when root action receives webhook from GH and this extension is interested in such
+     * events (provided by {@link #events()} method). By default do nothing and can be overrided to implement any
+     * parse logic
+     * Don't call it directly, use {@link #processEvent(String, GHEvent, String)} static function
+     *
+     * @param origin the origin of the event (or {@code null})
+     * @param event   gh-event (as of PUSH, ISSUE...). One of returned by {@link #events()} method. Never null.
+     * @param payload payload of gh-event. Never blank. Can be parsed with help of GitHub#parseEventPayload
+     * @since TODO
+     */
+    protected void onEvent(String origin, GHEvent event, String payload) {
+        onEvent(event, payload);
+    }
+
     /**
      * @return All subscriber extensions
      */
@@ -200,13 +219,31 @@ protected boolean applyNullSafe(@Nonnull GHEventsSubscriber subscriber) {
      * @param payload string content of hook from GH. Never blank
      *
      * @return function to process {@link GHEventsSubscriber} list. Returns null on apply.
+     * @deprecated use {@link #processEvent(String, GHEvent, String)}
      */
+    @Deprecated
     public static Function<GHEventsSubscriber, Void> processEvent(final GHEvent event, final String payload) {
+        return processEvent(null, event, payload);
+    }
+
+    /**
+     * Function which calls {@link #onEvent(GHEvent, String)} for every subscriber on apply
+     *
+     * @param origin  the origin of the event or {@code null} if the origin is unknown,
+     *                {@link SCMEvent#originOf(StaplerRequest)} is usually the best way to generate the origin.
+     * @param event   from hook. Applied only with event from {@link #events()} set
+     * @param payload string content of hook from GH. Never blank
+     *
+     * @return function to process {@link GHEventsSubscriber} list. Returns null on apply.
+     * @since TODO
+     */
+    public static Function<GHEventsSubscriber, Void> processEvent(final String origin, final GHEvent event,
+                                                                  final String payload) {
         return new NullSafeFunction<GHEventsSubscriber, Void>() {
             @Override
             protected Void applyNullSafe(@Nonnull GHEventsSubscriber subscriber) {
                 try {
-                    subscriber.onEvent(event, payload);
+                    subscriber.onEvent(origin, event, payload);
                 } catch (Throwable t) {
                     LOGGER.error("Subscriber {} failed to process {} hook, skipping...",
                             subscriber.getClass().getName(), event, t);

src/main/java/org/jenkinsci/plugins/github/webhook/subscriber/DefaultPushGHEventSubscriber.java

@@ -3,9 +3,9 @@
 import com.cloudbees.jenkins.GitHubPushTrigger;
 import com.cloudbees.jenkins.GitHubRepositoryName;
 import com.cloudbees.jenkins.GitHubRepositoryNameContributor;
-import com.cloudbees.jenkins.GitHubTrigger;
 import com.cloudbees.jenkins.GitHubWebHook;
 import hudson.Extension;
+import hudson.ExtensionList;
 import hudson.model.Item;
 import hudson.security.ACL;
 import java.io.IOException;
@@ -64,7 +64,7 @@ protected Set<GHEvent> events() {
      * @param payload payload of gh-event. Never blank
      */
     @Override
-    protected void onEvent(GHEvent event, String payload) {
+    protected void onEvent(final String origin, GHEvent event, String payload) {
         GHEventPayload.Push push;
         try {
             push = GitHub.offline().parseEventPayload(new StringReader(payload), GHEventPayload.Push.class);
@@ -74,7 +74,7 @@ protected void onEvent(GHEvent event, String payload) {
         }
         URL repoUrl = push.getRepository().getUrl();
         final String pusherName = push.getPusher().getName();
-        LOGGER.info("Received PushEvent for {}", repoUrl);
+        LOGGER.info("Received PushEvent for {} from {}", repoUrl, origin);
         final GitHubRepositoryName changedRepository = GitHubRepositoryName.create(repoUrl.toExternalForm());
 
         if (changedRepository != null) {
@@ -85,14 +85,14 @@ protected void onEvent(GHEvent event, String payload) {
                 @Override
                 public void run() {
                     for (Item job : Jenkins.getInstance().getAllItems(Item.class)) {
-                        GitHubTrigger trigger = triggerFrom(job, GitHubPushTrigger.class);
+                        GitHubPushTrigger trigger = triggerFrom(job, GitHubPushTrigger.class);
                         if (trigger != null) {
                             String fullDisplayName = job.getFullDisplayName();
                             LOGGER.debug("Considering to poke {}", fullDisplayName);
                             if (GitHubRepositoryNameContributor.parseAssociatedNames(job)
                                     .contains(changedRepository)) {
                                 LOGGER.info("Poked {}", fullDisplayName);
-                                trigger.onPost(pusherName);
+                                trigger.onPost(origin, pusherName);
                             } else {
                                 LOGGER.debug("Skipped {} because it doesn't have a matching repository.",
                                         fullDisplayName);
@@ -102,8 +102,7 @@ public void run() {
                 }
             });
 
-            for (GitHubWebHook.Listener listener : Jenkins.getInstance()
-                    .getExtensionList(GitHubWebHook.Listener.class)) {
+            for (GitHubWebHook.Listener listener : ExtensionList.lookup(GitHubWebHook.Listener.class)) {
                 listener.onPushRepositoryChanged(pusherName, changedRepository);
             }
 

src/test/java/org/jenkinsci/plugins/github/admin/GitHubHookRegisterProblemMonitorTest.java

@@ -166,7 +166,7 @@ public void shouldReportAboutHookProblemOnUnregister() {
     public void shouldResolveOnPingHook() {
         monitor.registerProblem(REPO_FROM_PING_PAYLOAD, new IOException());
 
-        GHEventsSubscriber.processEvent(GHEvent.PING, classpath("payloads/ping.json")).apply(pingSubscr);
+        GHEventsSubscriber.processEvent(null, GHEvent.PING, classpath("payloads/ping.json")).apply(pingSubscr);
 
         assertThat("ping resolves problem", monitor.isProblemWith(REPO_FROM_PING_PAYLOAD), is(false));
     }

src/test/java/org/jenkinsci/plugins/github/webhook/subscriber/DefaultPushGHEventListenerTest.java

@@ -51,9 +51,9 @@ public void shouldParsePushPayload() throws Exception {
         prj.setScm(GIT_SCM_FROM_RESOURCE);
 
         new DefaultPushGHEventSubscriber()
-                .onEvent(GHEvent.PUSH, classpath("payloads/push.json"));
+                .onEvent("shouldParsePushPayload", GHEvent.PUSH, classpath("payloads/push.json"));
 
-        verify(trigger).onPost(TRIGGERED_BY_USER_FROM_RESOURCE);
+        verify(trigger).onPost("shouldParsePushPayload", TRIGGERED_BY_USER_FROM_RESOURCE);
     }
 
     @Test
@@ -68,9 +68,9 @@ public void shouldReceivePushHookOnWorkflow() throws Exception {
         jenkins.assertBuildStatusSuccess(job.scheduleBuild2(0));
 
         new DefaultPushGHEventSubscriber()
-                .onEvent(GHEvent.PUSH, classpath("payloads/push.json"));
+                .onEvent("shouldReceivePushHookOnWorkflow", GHEvent.PUSH, classpath("payloads/push.json"));
 
-        verify(trigger).onPost(TRIGGERED_BY_USER_FROM_RESOURCE);
+        verify(trigger).onPost("shouldReceivePushHookOnWorkflow", TRIGGERED_BY_USER_FROM_RESOURCE);
     }
 
     @Test
@@ -83,8 +83,8 @@ public void shouldNotReceivePushHookOnWorkflowWithNoBuilds() throws Exception {
         job.setDefinition(new CpsFlowDefinition(classpath(getClass(), "workflow-definition.groovy")));
 
         new DefaultPushGHEventSubscriber()
-                .onEvent(GHEvent.PUSH, classpath("payloads/push.json"));
+                .onEvent("shouldNotReceivePushHookOnWorkflowWithNoBuilds", GHEvent.PUSH, classpath("payloads/push.json"));
 
-        verify(trigger, never()).onPost(TRIGGERED_BY_USER_FROM_RESOURCE);
+        verify(trigger, never()).onPost("shouldNotReceivePushHookOnWorkflowWithNoBuilds", TRIGGERED_BY_USER_FROM_RESOURCE);
     }
 }