Removing RESCOPED event, will trigger _FROM and _TO instead #37

* Also adding logging that shows event name together with from and to hashes.

Author: tomasbjerre

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 Changelog of Pull Request Notifier for Stash.
 
+## 1.15
+* Removing RESCOPED event, its confusing when to use it together with _FROM and _TO. RESCOPED was triggered when both _FROM and _TO changed at the exact same time. Now, just check _FROM if you only want to trigger when source branch changes, _TO if only target and both if you want to trigger for both.
+* Adding logging to make it easier to debug what events are triggered.
+
 ## 1.14
 * New variables with information about the user who issued the event
  * ${PULL_REQUEST_USER_DISPLAY_NAME} Example: Some User

README.md

@@ -26,7 +26,7 @@ The Pull Request Notifier for Stash can:
 * Send custom HTTP headers
 * Can optionally use proxy to connect
 
-If you only want to trigger on RESCOPED_FROM, or RESCOPED_TO, you will also need to trigger on RESCOPED. Stash will fire an event, RESCOPED, if target and/or source branch is changed. The plugin has its own implementation to create the RESCOPED_FROM and RESCOPED_TO events. RESCOPED is transformed to RESCOPED_FROM if only source branch changed, RESCOPED_TO if only target branch changed and kept as RESCOPED if both changed.
+The plugin has its own implementation to create the RESCOPED_FROM and RESCOPED_TO events. RESCOPED is transformed to RESCOPED_TO if target branch changed, RESCOPED_FROM if source branch, or both, changed.
 
 The filter text as well as the URL support variables. These are:
 

src/main/java/se/bjurr/prnfs/listener/PrnfsPullRequestAction.java

@@ -10,10 +10,13 @@
 import static com.atlassian.stash.pull.PullRequestAction.UNAPPROVED;
 import static com.atlassian.stash.pull.PullRequestAction.UPDATED;
 import static com.google.common.collect.Lists.newArrayList;
+import static java.lang.Boolean.FALSE;
 
 import java.util.List;
 import java.util.Map;
 
+import se.bjurr.prnfs.settings.PrnfsNotification;
+
 import com.atlassian.stash.event.pull.PullRequestEvent;
 import com.atlassian.stash.event.pull.PullRequestRescopedEvent;
 import com.google.common.collect.ImmutableMap;
@@ -30,7 +33,7 @@ public class PrnfsPullRequestAction {
    .put(MERGED.name(), new PrnfsPullRequestAction(MERGED.name())) //
    .put(OPENED.name(), new PrnfsPullRequestAction(OPENED.name())) //
    .put(REOPENED.name(), new PrnfsPullRequestAction(REOPENED.name())) //
-   .put(RESCOPED.name(), new PrnfsPullRequestAction(RESCOPED.name())) //
+   .put(RESCOPED.name(), new PrnfsPullRequestAction(RESCOPED_FROM)) //
    .put(RESCOPED_FROM, new PrnfsPullRequestAction(RESCOPED_FROM)) //
    .put(RESCOPED_TO, new PrnfsPullRequestAction(RESCOPED_TO)) //
    .put(UNAPPROVED.name(), new PrnfsPullRequestAction(UNAPPROVED.name())) //
@@ -62,8 +65,7 @@ public static List<PrnfsPullRequestAction> values() {
   return newArrayList(values.values());
  }
 
- @SuppressWarnings("deprecation")
- public static PrnfsPullRequestAction fromPullRequestEvent(PullRequestEvent event) {
+ public static PrnfsPullRequestAction fromPullRequestEvent(PullRequestEvent event, PrnfsNotification notification) {
   if (event instanceof PullRequestRescopedEvent) {
    PullRequestRescopedEvent rescopedEvent = (PullRequestRescopedEvent) event;
    boolean toChanged = !rescopedEvent.getPreviousToHash().equals(
@@ -74,8 +76,22 @@ public static PrnfsPullRequestAction fromPullRequestEvent(PullRequestEvent event
     return PrnfsPullRequestAction.valueOf(RESCOPED_FROM);
    } else if (toChanged && !fromChanged) {
     return PrnfsPullRequestAction.valueOf(RESCOPED_TO);
+   } else {
+    if (notification.getTriggers().contains(values.get(RESCOPED_FROM))) {
+     return PrnfsPullRequestAction.valueOf(RESCOPED_FROM);
+    } else if (notification.getTriggers().contains(values.get(RESCOPED_TO))) {
+     return PrnfsPullRequestAction.valueOf(RESCOPED_TO);
+    }
    }
   }
   return PrnfsPullRequestAction.valueOf(event.getAction().name());
  }
+
+ @Override
+ public boolean equals(Object obj) {
+  if (obj instanceof PrnfsPullRequestAction) {
+   return getName().equals(((PrnfsPullRequestAction) obj).getName());
+  }
+  return FALSE;
+ }
 }

src/main/java/se/bjurr/prnfs/listener/PrnfsPullRequestEventListener.java

@@ -29,6 +29,7 @@
 import com.atlassian.stash.event.pull.PullRequestRescopedEvent;
 import com.atlassian.stash.event.pull.PullRequestUnapprovedEvent;
 import com.atlassian.stash.event.pull.PullRequestUpdatedEvent;
+import com.atlassian.stash.pull.PullRequest;
 import com.atlassian.stash.repository.RepositoryService;
 import com.google.common.annotations.VisibleForTesting;
 import com.google.common.base.Optional;
@@ -62,55 +63,57 @@ public PrnfsPullRequestEventListener(PluginSettingsFactory pluginSettingsFactory
 
  @EventListener
  public void onEvent(PullRequestApprovedEvent e) {
-  handleEvent(e, fromPullRequestEvent(e));
+  handleEvent(e);
  }
 
  @EventListener
  public void onEvent(PullRequestCommentAddedEvent e) {
-  handleEvent(e, fromPullRequestEvent(e));
+  handleEvent(e);
  }
 
  @EventListener
  public void onEvent(PullRequestDeclinedEvent e) {
-  handleEvent(e, fromPullRequestEvent(e));
+  handleEvent(e);
  }
 
  @EventListener
  public void onEvent(PullRequestMergedEvent e) {
-  handleEvent(e, fromPullRequestEvent(e));
+  handleEvent(e);
  }
 
  @EventListener
  public void onEvent(PullRequestOpenedEvent e) {
-  handleEvent(e, fromPullRequestEvent(e));
+  handleEvent(e);
  }
 
  @EventListener
  public void onEvent(PullRequestReopenedEvent e) {
-  handleEvent(e, fromPullRequestEvent(e));
+  handleEvent(e);
  }
 
  @EventListener
  public void onEvent(final PullRequestRescopedEvent e) {
-  handleEvent(e, fromPullRequestEvent(e));
+  handleEvent(e);
  }
 
  @EventListener
  public void onEvent(PullRequestUnapprovedEvent e) {
-  handleEvent(e, fromPullRequestEvent(e));
+  handleEvent(e);
  }
 
  @EventListener
  public void onEvent(PullRequestUpdatedEvent e) {
-  handleEvent(e, fromPullRequestEvent(e));
+  handleEvent(e);
  }
 
  @VisibleForTesting
- public void handleEvent(PullRequestEvent pullRequestEvent, PrnfsPullRequestAction action) {
-  final PrnfsRenderer renderer = new PrnfsRenderer(pullRequestEvent, repositoryService);
+ public void handleEvent(PullRequestEvent pullRequestEvent) {
   try {
    final PrnfsSettings settings = getPrnfsSettings(pluginSettingsFactory.createGlobalSettings());
    for (final PrnfsNotification notification : settings.getNotifications()) {
+    final PrnfsRenderer renderer = new PrnfsRenderer(pullRequestEvent, repositoryService, notification);
+    PrnfsPullRequestAction action = fromPullRequestEvent(pullRequestEvent, notification);
+    PullRequest pr = pullRequestEvent.getPullRequest();
     if (notification.getFilterRegexp().isPresent()
       && notification.getFilterString().isPresent()
       && !compile(notification.getFilterRegexp().get()).matcher(renderer.render(notification.getFilterString().get()))
@@ -122,8 +125,13 @@ public void handleEvent(PullRequestEvent pullRequestEvent, PrnfsPullRequestActio
      if (notification.getPostContent().isPresent()) {
       postContent = Optional.of(renderer.render(notification.getPostContent().get()));
      }
-     UrlInvoker urlInvoker = urlInvoker().withUrlParam(renderer.render(notification.getUrl()))
-       .withMethod(notification.getMethod()).withPostContent(postContent);
+     String renderedUrl = renderer.render(notification.getUrl());
+     logger.info(action.getName() + " "//
+       + pr.getFromRef().getId() + "(" + pr.getFromRef().getLatestChangeset() + ") -> " //
+       + pr.getToRef().getId() + "(" + pr.getToRef().getLatestChangeset() + ")" + " " //
+       + renderedUrl);
+     UrlInvoker urlInvoker = urlInvoker().withUrlParam(renderedUrl).withMethod(notification.getMethod())
+       .withPostContent(postContent);
      if (notification.getUser().isPresent() && notification.getPassword().isPresent()) {
       final String userpass = notification.getUser().get() + ":" + notification.getPassword().get();
       final String basicAuth = "Basic " + new String(printBase64Binary(userpass.getBytes(UTF_8)));