Add optional Redirect URL to button configuration (#308)

tomasbjerre · Nov 13, 2018 · 6f6964c · 6f6964c
1 parent 201547e
commit 6f6964c
Show file tree

Hide file tree

Showing 10 changed files with 86 additions and 20 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,12 @@
 
 Changelog of Pull Request Notifier for Bitbucket.
 
+## Unreleased
+### GitHub [#308](https://github.com/tomasbjerre/pull-request-notifier-for-bitbucket/pull/308) Add optional Redirect URL to button configuration
+  Add optional Redirect URL to button configuration ()
+
+  [792a9b6f754a5d0](https://github.com/tomasbjerre/pull-request-notifier-for-bitbucket/commit/792a9b6f754a5d0) Trent Rand *2018-11-13 18:11:42*
+
 ## 3.23
 ### GitHub [#303](https://github.com/tomasbjerre/pull-request-notifier-for-bitbucket/issues/303) Post content encoding issue for single quote 
   Adding option to encode variables for JSON

diff --git a/src/main/java/se/bjurr/prnfb/presentation/ButtonServlet.java b/src/main/java/se/bjurr/prnfb/presentation/ButtonServlet.java
@@ -150,9 +150,9 @@ public Response get(
     final List<PrnfbButton> buttons = buttonsService.getButtons(repositoryId, pullRequestId);
     final List<ButtonDTO> dtos = toButtonDtoList(buttons);
     Collections.sort(dtos);
-
-    populateButtonFormDtoList(repositoryId, pullRequestId, dtos);
-
+    for (final ButtonDTO dto : dtos) {
+      renderButtonDtoList(repositoryId, pullRequestId, dto);
+    }
     return ok(dtos, APPLICATION_JSON).build();
   }
 
@@ -179,22 +179,26 @@ public Response press(
     return ok(dto, APPLICATION_JSON).build();
   }
 
-  private void populateButtonFormDtoList(
-      Integer repositoryId, Long pullRequestId, List<ButtonDTO> dtos) {
-    for (final ButtonDTO dto : dtos) {
-      final PrnfbRendererWrapper renderer =
-          buttonsService.getRenderer(repositoryId, pullRequestId, dto.getUuid());
-      final List<ButtonFormElementDTO> buttonFormDtoList = dto.getButtonFormList();
-      if (buttonFormDtoList != null) {
-        for (final ButtonFormElementDTO buttonFormElementDto : buttonFormDtoList) {
-          final String defaultValue = buttonFormElementDto.getDefaultValue();
-          if (!isNullOrEmpty(defaultValue)) {
-            final String defaultValueRendered = renderer.render(defaultValue, ENCODE_FOR.NONE);
-            buttonFormElementDto.setDefaultValue(defaultValueRendered);
-          }
+  private void renderButtonDtoList(Integer repositoryId, Long pullRequestId, ButtonDTO dto) {
+    final PrnfbRendererWrapper renderer =
+        buttonsService.getRenderer(repositoryId, pullRequestId, dto.getUuid());
+
+    final List<ButtonFormElementDTO> buttonFormDtoList = dto.getButtonFormList();
+    if (buttonFormDtoList != null) {
+      for (final ButtonFormElementDTO buttonFormElementDto : buttonFormDtoList) {
+        final String defaultValue = buttonFormElementDto.getDefaultValue();
+        if (!isNullOrEmpty(defaultValue)) {
+          final String defaultValueRendered = renderer.render(defaultValue, ENCODE_FOR.NONE);
+          buttonFormElementDto.setDefaultValue(defaultValueRendered);
         }
-        dto.setButtonFormList(buttonFormDtoList);
       }
+      dto.setButtonFormList(buttonFormDtoList);
+    }
+
+    final String redirectUrl = dto.getRedirectUrl();
+    if (!isNullOrEmpty(redirectUrl)) {
+      final String redirectUrlRendered = renderer.render(redirectUrl, ENCODE_FOR.HTML);
+      dto.setRedirectUrl(redirectUrlRendered);
     }
   }
 }
diff --git a/src/main/java/se/bjurr/prnfb/presentation/dto/ButtonDTO.java b/src/main/java/se/bjurr/prnfb/presentation/dto/ButtonDTO.java
@@ -34,6 +34,7 @@ public class ButtonDTO implements Comparable<ButtonDTO>, Restricted {
   private USER_LEVEL userLevel;
   private UUID uuid;
   private String confirmationText;
+  private String redirectUrl;
 
   public void setConfirmationText(String confirmationText) {
     this.confirmationText = confirmationText;
@@ -115,6 +116,13 @@ public boolean equals(Object obj) {
     } else if (!uuid.equals(other.uuid)) {
       return false;
     }
+    if (redirectUrl == null) {
+      if (other.redirectUrl != null) {
+        return false;
+      }
+    } else if (!redirectUrl.equals(other.redirectUrl)) {
+      return false;
+    }
     return true;
   }
 
@@ -152,6 +160,10 @@ public UUID getUUID() {
     return this.uuid;
   }
 
+  public String getRedirectUrl() {
+    return this.redirectUrl;
+  }
+
   @Override
   public int hashCode() {
     final int prime = 31;
@@ -165,6 +177,7 @@ public int hashCode() {
     result = prime * result + (repositorySlug == null ? 0 : repositorySlug.hashCode());
     result = prime * result + (userLevel == null ? 0 : userLevel.hashCode());
     result = prime * result + (uuid == null ? 0 : uuid.hashCode());
+    result = prime * result + (redirectUrl == null ? 0 : redirectUrl.hashCode());
     return result;
   }
 
@@ -204,6 +217,10 @@ public void setUuid(UUID uuid) {
     this.uuid = uuid;
   }
 
+  public void setRedirectUrl(String redirectUrl) {
+    this.redirectUrl = redirectUrl;
+  }
+
   @Override
   public String toString() {
     return "ButtonDTO [buttonFormList="
@@ -224,6 +241,8 @@ public String toString() {
         + uuid
         + ", confirmationText="
         + confirmationText
+        + ", redirectUrl="
+        + redirectUrl
         + "]";
   }
 }
diff --git a/src/main/java/se/bjurr/prnfb/settings/PrnfbButton.java b/src/main/java/se/bjurr/prnfb/settings/PrnfbButton.java
@@ -21,6 +21,7 @@ public class PrnfbButton implements HasUuid, Restricted {
   private final USER_LEVEL userLevel;
   private final UUID uuid;
   private final String confirmationText;
+  private final String redirectUrl;
 
   public PrnfbButton(
       UUID uuid,
@@ -30,6 +31,7 @@ public PrnfbButton(
       String projectKey,
       String repositorySlug,
       String confirmationText,
+      String redirectUrl,
       List<PrnfbButtonFormElement> buttonFormElementList) {
     this.uuid = firstNonNull(uuid, randomUUID());
     this.name = name;
@@ -38,6 +40,7 @@ public PrnfbButton(
     this.repositorySlug = emptyToNull(repositorySlug);
     this.projectKey = emptyToNull(projectKey);
     this.confirmationText = emptyToNull(confirmationText);
+    this.redirectUrl = emptyToNull(redirectUrl);
     this.buttonFormElementList =
         firstNonNull(buttonFormElementList, new ArrayList<PrnfbButtonFormElement>());
   }
@@ -77,6 +80,10 @@ public UUID getUuid() {
     return this.uuid;
   }
 
+  public String getRedirectUrl() {
+    return redirectUrl;
+  }
+
   @Override
   public boolean equals(Object obj) {
     if (this == obj) {
@@ -137,6 +144,13 @@ public boolean equals(Object obj) {
     } else if (!uuid.equals(other.uuid)) {
       return false;
     }
+    if (redirectUrl == null) {
+      if (other.redirectUrl != null) {
+        return false;
+      }
+    } else if (!redirectUrl.equals(other.redirectUrl)) {
+      return false;
+    }
     return true;
   }
 
@@ -153,6 +167,7 @@ public int hashCode() {
     result = prime * result + (repositorySlug == null ? 0 : repositorySlug.hashCode());
     result = prime * result + (userLevel == null ? 0 : userLevel.hashCode());
     result = prime * result + (uuid == null ? 0 : uuid.hashCode());
+    result = prime * result + (redirectUrl == null ? 0 : redirectUrl.hashCode());
     return result;
   }
 
@@ -174,6 +189,8 @@ public String toString() {
         + uuid
         + ", confirmationText="
         + confirmationText
+        + ", redirectUrl="
+        + redirectUrl
         + "]";
   }
 }
diff --git a/src/main/java/se/bjurr/prnfb/transformer/ButtonTransformer.java b/src/main/java/se/bjurr/prnfb/transformer/ButtonTransformer.java
@@ -34,6 +34,7 @@ public static ButtonDTO toButtonDto(PrnfbButton from) {
     to.setName(from.getName());
     to.setUserLevel(from.getUserLevel());
     to.setUuid(from.getUuid());
+    to.setRedirectUrl(from.getRedirectUrl());
     to.setProjectKey(from.getProjectKey().orNull());
     to.setRepositorySlug(from.getRepositorySlug().orNull());
     to.setConfirmation(from.getConfirmation());
@@ -110,6 +111,7 @@ public static PrnfbButton toPrnfbButton(ButtonDTO buttonDto) {
         buttonDto.getProjectKey().orNull(), //
         buttonDto.getRepositorySlug().orNull(), //
         buttonDto.getConfirmationText(), //
+        buttonDto.getRedirectUrl(), //
         buttonFormElement); //
   }
 

diff --git a/src/main/resources/admin.vm b/src/main/resources/admin.vm
@@ -292,6 +292,12 @@
      <div class="description">Optional. If not empty, a form will be rendered from this JSON. This is documented <a href="https://github.com/tomasbjerre/pull-request-notifier-for-bitbucket" target="_blank">here</a>.</div>
     </div>
 
+    <div class="field-group">
+     <label>Redirect URL</label>
+     <input class="text long-field" type="text" name="redirectUrl"></input>
+     <div class="description">Optional. If not empty, a redirect will be performed after the notification's URL invocation has resolved.</div>
+    </div>
+
     <div class="aui-buttons">
      <button class="aui-button aui-button-primary">Save</button>
      <button class="aui-button aui-button" name="delete">Delete</button>
@@ -647,7 +653,6 @@
     <button class="aui-button aui-button-primary">Save</button>
     <button class="aui-button aui-button" name="delete">Delete</button>
    </div>
-   </fieldset>
   </form>
  </div>
 

diff --git a/src/main/resources/pr-triggerbutton.js b/src/main/resources/pr-triggerbutton.js
@@ -249,8 +249,17 @@ define('plugin/prnfb/pr-triggerbutton', [
         });
        }
       });
+
+      if (item.redirectUrl) {
+        redirect();
+      }
      };
 
+     var redirect = function() {
+       disableButton();
+       window.location.replace(item.redirectUrl);
+     }
+
      if (item.confirmationText || item.buttonFormList && item.buttonFormList.length > 0) {
       // Create the form and dialog     
       var confirmationText = confirmationTextTemplate(item.confirmationText);

diff --git a/src/test/java/se/bjurr/prnfb/presentation/ButtonServletTest.java b/src/test/java/se/bjurr/prnfb/presentation/ButtonServletTest.java
@@ -92,6 +92,7 @@ private ButtonDTO createButton() {
     button.setConfirmation(ON_OR_OFF.off);
     button.setProjectKey("p1");
     button.setRepositorySlug("r1");
+    button.setRedirectUrl("http://www.example.com/");
     return button;
   }
 
@@ -105,6 +106,7 @@ private PrnfbButton createPrnfbButton(ButtonDTO button) {
             "p1",
             "r1",
             button.getConfirmationText(),
+            button.getRedirectUrl(),
             new ArrayList<>());
     return prnfbButton;
   }

diff --git a/src/test/java/se/bjurr/prnfb/service/ButtonsServiceTest.java b/src/test/java/se/bjurr/prnfb/service/ButtonsServiceTest.java
@@ -321,6 +321,7 @@ private void testVisibilityOnRepository(
             buttonProjectKey,
             buttonRepositorySlug,
             "confirmationText",
+            null,
             null);
     when(this.repository.getProject()).thenReturn(this.project);
     when(this.repository.getProject().getKey()) //

diff --git a/src/test/java/se/bjurr/prnfb/service/SettingsServiceTest.java b/src/test/java/se/bjurr/prnfb/service/SettingsServiceTest.java
@@ -71,7 +71,7 @@ public <T> T execute(TransactionCallback<T> action) {
   public void testThatButtonCanBeAddedUpdatedAndDeleted() {
     final PrnfbButton button1 =
         new PrnfbButton(
-            null, "title", EVERYONE, ON_OR_OFF.off, "p1", "r1", "confirmationText", null);
+            null, "title", EVERYONE, ON_OR_OFF.off, "p1", "r1", "confirmationText", null, null);
     assertThat(this.sut.getButtons()) //
         .isEmpty();
 
@@ -81,7 +81,7 @@ public void testThatButtonCanBeAddedUpdatedAndDeleted() {
 
     final PrnfbButton button2 =
         new PrnfbButton(
-            null, "title", EVERYONE, ON_OR_OFF.off, "p1", "r1", "confirmationText", null);
+            null, "title", EVERYONE, ON_OR_OFF.off, "p1", "r1", "confirmationText", null, null);
     this.sut.addOrUpdateButton(button2);
     assertThat(this.sut.getButtons()) //
         .containsExactly(button1, button2);
@@ -95,6 +95,7 @@ public void testThatButtonCanBeAddedUpdatedAndDeleted() {
             "p1",
             "r1",
             "confirmationText",
+            null,
             null);
     this.sut.addOrUpdateButton(updated);
     assertThat(this.sut.getButtons()) //