The Unified and Autonomous Development Platform
feat: Customizable HTTP headers for webhooks (OD-2702)
Robin Sheneeafd5409b2f
diff --git a/server-core/src/main/java/io/onedev/server/data/migration/DataMigrator.java b/server-core/src/main/java/io/onedev/server/data/migration/DataMigrator.javaindex 4a08bf2505..8fbfc95fa4 100644--- a/server-core/src/main/java/io/onedev/server/data/migration/DataMigrator.java+++ b/server-core/src/main/java/io/onedev/server/data/migration/DataMigrator.java@@ -8524,8 +8524,12 @@ public class DataMigrator {for (File file : dataDir.listFiles()) {if (file.getName().startsWith("Projects.xml")) {VersionedXmlDoc dom = VersionedXmlDoc.fromFile(file);- for (Element element : dom.getRootElement().elements()) {- element.addElement("aiSetting");+ for (Element projectElement : dom.getRootElement().elements()) {+ projectElement.addElement("aiSetting");+ Element webHooksElement = projectElement.element("webHooks");+ for (Element webHookElement : webHooksElement.elements()) {+ webHookElement.addElement("headers");+ }}dom.writeToFile(file, false);}diff --git a/server-core/src/main/java/io/onedev/server/model/support/WebHook.java b/server-core/src/main/java/io/onedev/server/model/support/WebHook.javaindex ea20a9e11c..d0793deac2 100644--- a/server-core/src/main/java/io/onedev/server/model/support/WebHook.java+++ b/server-core/src/main/java/io/onedev/server/model/support/WebHook.java@@ -79,6 +79,8 @@ public class WebHook implements Serializable {private String secret = CryptoUtils.generateSecret();+ private List<WebHookHeader> headers = new ArrayList<>();+@Editable(order=100, description="The URL of the server endpoint that will receive the webhook POST requests")@NotEmptypublic String getPostUrl() {@@ -109,5 +111,15 @@ public class WebHook implements Serializable {public void setSecret(String secret) {this.secret = secret;}++ @Editable(order=400, name="Custom Headers", description="Optionally specify additional HTTP headers to include in "+ + "the webhook POST request, for example an Authorization header required by the receiving endpoint")+ public List<WebHookHeader> getHeaders() {+ return headers;+ }++ public void setHeaders(List<WebHookHeader> headers) {+ this.headers = headers;+ }}diff --git a/server-core/src/main/java/io/onedev/server/model/support/WebHookHeader.java b/server-core/src/main/java/io/onedev/server/model/support/WebHookHeader.javanew file mode 100644index 0000000000..7804b259c2--- /dev/null+++ b/server-core/src/main/java/io/onedev/server/model/support/WebHookHeader.java@@ -0,0 +1,38 @@+package io.onedev.server.model.support;++import java.io.Serializable;++import javax.validation.constraints.NotEmpty;++import io.onedev.server.annotation.Editable;++@Editable+public class WebHookHeader implements Serializable {++ private static final long serialVersionUID = 1L;++ private String name;++ private String value;++ @Editable(order=100, name="Header Name")+ @NotEmpty+ public String getName() {+ return name;+ }++ public void setName(String name) {+ this.name = name;+ }++ @Editable(order=200, name="Header Value")+ @NotEmpty+ public String getValue() {+ return value;+ }++ public void setValue(String value) {+ this.value = value;+ }++}diff --git a/server-core/src/main/java/io/onedev/server/notification/WebHookManager.java b/server-core/src/main/java/io/onedev/server/notification/WebHookManager.javaindex 0b073e7718..de0582aaa6 100644--- a/server-core/src/main/java/io/onedev/server/notification/WebHookManager.java+++ b/server-core/src/main/java/io/onedev/server/notification/WebHookManager.java@@ -63,6 +63,8 @@ public class WebHookManager {httpPost.setHeader(HttpHeaders.CONTENT_TYPE, APPLICATION_JSON);httpPost.setHeader(HttpHeaders.ACCEPT_CHARSET, UTF_8.name());httpPost.setHeader(SIGNATURE_HEAD, webHook.getSecret());+ for (var header : webHook.getHeaders())+ httpPost.setHeader(header.getName(), header.getValue());try (var response = client.execute(httpPost)) {HttpEntity responseEntity = response.getEntity();diff --git a/server-core/src/main/java/io/onedev/server/web/page/project/setting/webhook/WebHookEditPanel.html b/server-core/src/main/java/io/onedev/server/web/page/project/setting/webhook/WebHookEditPanel.htmlnew file mode 100644index 0000000000..45df2d0aed--- /dev/null+++ b/server-core/src/main/java/io/onedev/server/web/page/project/setting/webhook/WebHookEditPanel.html@@ -0,0 +1,15 @@+<wicket:panel>+ <form wicket:id="form" class="webhook-edit leave-confirm">+ <div class="modal-header">+ <h5 id="modal-title" class="modal-title"><wicket:t>Web Hook</wicket:t></h5>+ <button wicket:id="close" type="button" class="close"><wicket:svg href="times" class="icon"/></button>+ </div>+ <div class="modal-body">+ <div wicket:id="editor"></div>+ </div>+ <div class="modal-footer">+ <input wicket:id="save" type="submit" class="dirty-aware btn btn-primary" t:value="Save">+ <a wicket:id="cancel" class="btn btn-secondary"><wicket:t>Cancel</wicket:t></a>+ </div>+ </form>+</wicket:panel>diff --git a/server-core/src/main/java/io/onedev/server/web/page/project/setting/webhook/WebHookEditPanel.java b/server-core/src/main/java/io/onedev/server/web/page/project/setting/webhook/WebHookEditPanel.javanew file mode 100644index 0000000000..b1bdccc5d6--- /dev/null+++ b/server-core/src/main/java/io/onedev/server/web/page/project/setting/webhook/WebHookEditPanel.java@@ -0,0 +1,118 @@+package io.onedev.server.web.page.project.setting.webhook;++import org.apache.commons.lang3.SerializationUtils;+import org.apache.wicket.ajax.AjaxRequestTarget;+import org.apache.wicket.ajax.attributes.AjaxRequestAttributes;+import org.apache.wicket.ajax.markup.html.AjaxLink;+import org.apache.wicket.ajax.markup.html.form.AjaxButton;+import org.apache.wicket.markup.html.form.Form;+import org.apache.wicket.markup.html.panel.Panel;+import org.apache.wicket.request.cycle.RequestCycle;++import io.onedev.server.OneDev;+import io.onedev.server.data.migration.VersionedXmlDoc;+import io.onedev.server.model.Project;+import io.onedev.server.model.support.WebHook;+import io.onedev.server.service.AuditService;+import io.onedev.server.service.ProjectService;+import io.onedev.server.web.ajaxlistener.ConfirmLeaveListener;+import io.onedev.server.web.editable.BeanContext;++abstract class WebHookEditPanel extends Panel {++ private final int hookIndex;++ public WebHookEditPanel(String id, int hookIndex) {+ super(id);+ this.hookIndex = hookIndex;+ }++ @Override+ protected void onInitialize() {+ super.onInitialize();++ WebHook hook = hookIndex != -1+ ? SerializationUtils.clone(getProject().getWebHooks().get(hookIndex))+ : new WebHook();++ Form<?> form = new Form<Void>("form") {++ @Override+ protected void onError() {+ super.onError();+ RequestCycle.get().find(AjaxRequestTarget.class).add(this);+ }++ };++ form.add(new AjaxLink<Void>("close") {++ @Override+ protected void updateAjaxAttributes(AjaxRequestAttributes attributes) {+ super.updateAjaxAttributes(attributes);+ attributes.getAjaxCallListeners().add(new ConfirmLeaveListener(WebHookEditPanel.this));+ }++ @Override+ public void onClick(AjaxRequestTarget target) {+ onCancel(target);+ }++ });++ var editor = BeanContext.edit("editor", hook);+ form.add(editor);++ form.add(new AjaxButton("save") {++ @Override+ protected void onSubmit(AjaxRequestTarget target, Form<?> form) {+ super.onSubmit(target, form);+ if (editor.isValid()) {+ String oldAuditContent = null;+ String verb;+ if (hookIndex != -1) {+ oldAuditContent = VersionedXmlDoc.fromBean(getProject().getWebHooks().get(hookIndex)).toXML();+ getProject().getWebHooks().set(hookIndex, hook);+ verb = "changed";+ } else {+ getProject().getWebHooks().add(hook);+ verb = "added";+ }+ var newAuditContent = VersionedXmlDoc.fromBean(hook).toXML();+ OneDev.getInstance(ProjectService.class).update(getProject());+ OneDev.getInstance(AuditService.class).audit(getProject(), verb + " web hook \"" + hook.getPostUrl() + "\"", oldAuditContent, newAuditContent);+ onSave(target);+ } else {+ target.add(form);+ }+ }++ });++ form.add(new AjaxLink<Void>("cancel") {++ @Override+ protected void updateAjaxAttributes(AjaxRequestAttributes attributes) {+ super.updateAjaxAttributes(attributes);+ attributes.getAjaxCallListeners().add(new ConfirmLeaveListener(WebHookEditPanel.this));+ }++ @Override+ public void onClick(AjaxRequestTarget target) {+ onCancel(target);+ }++ });++ form.setOutputMarkupId(true);+ add(form);+ }++ protected abstract Project getProject();++ protected abstract void onSave(AjaxRequestTarget target);++ protected abstract void onCancel(AjaxRequestTarget target);++}diff --git a/server-core/src/main/java/io/onedev/server/web/page/project/setting/webhook/WebHooksBean.java b/server-core/src/main/java/io/onedev/server/web/page/project/setting/webhook/WebHooksBean.javadeleted file mode 100644index 5023fb92e9..0000000000--- a/server-core/src/main/java/io/onedev/server/web/page/project/setting/webhook/WebHooksBean.java+++ /dev/null@@ -1,25 +0,0 @@-package io.onedev.server.web.page.project.setting.webhook;--import java.io.Serializable;-import java.util.ArrayList;--import io.onedev.server.model.support.WebHook;-import io.onedev.server.annotation.Editable;--@Editable-public class WebHooksBean implements Serializable {-- private static final long serialVersionUID = 1L;-- private ArrayList<WebHook> webHooks = new ArrayList<>();-- @Editable- public ArrayList<WebHook> getWebHooks() {- return webHooks;- }-- public void setWebHooks(ArrayList<WebHook> webHooks) {- this.webHooks = webHooks;- }--}diff --git a/server-core/src/main/java/io/onedev/server/web/page/project/setting/webhook/WebHooksPage.html b/server-core/src/main/java/io/onedev/server/web/page/project/setting/webhook/WebHooksPage.htmlindex 8951b926d9..9a82c11dba 100644--- a/server-core/src/main/java/io/onedev/server/web/page/project/setting/webhook/WebHooksPage.html+++ b/server-core/src/main/java/io/onedev/server/web/page/project/setting/webhook/WebHooksPage.html@@ -1,16 +1,19 @@<wicket:extend>- <div class="alert alert-notice bg-white shadow mb-5 text-gray">- <wicket:svg href="bulb" class="icon mr-2"/>- <wicket:t>For web hooks defined here and in parent projects, OneDev will post event data in JSON format to- specified URLs when subscribed events happen</wicket:t>- </div><div class="card web-hooks"><div class="card-body">- <form wicket:id="form" class="leave-confirm">- <div wicket:id="feedback" class="mb-4"></div>- <div wicket:id="editor"></div>- <input type="submit" t:value="Save" class="dirty-aware btn btn-primary mt-4">- </form>+ <div class="text-muted mb-4">+ <wicket:svg href="bulb" class="icon"/> <wicket:t>For web hooks defined here and in parent projects, OneDev will post event data in JSON format to+ specified URLs when subscribed events happen</wicket:t>+ </div>+ <a wicket:id="addNew" class="btn btn-icon btn-primary mb-4" t:data-tippy-content="Add web hook"><wicket:svg href="plus" class="icon"></wicket:svg></a>+ <table wicket:id="webHooks" class="table table-hover"></table></div></div>-</wicket:extend>\ No newline at end of file+ <wicket:fragment wicket:id="urlColumnFrag">+ <a wicket:id="link"><span wicket:id="label"></span></a>+ </wicket:fragment>+ <wicket:fragment wicket:id="actionColumnFrag">+ <a wicket:id="edit" class="btn btn-xs btn-icon btn-light btn-hover-primary mr-1" t:data-tippy-content="Edit"><wicket:svg href="edit" class="icon"></wicket:svg></a>+ <a wicket:id="delete" class="btn btn-xs btn-icon btn-light btn-hover-danger" t:data-tippy-content="Delete"><wicket:svg href="trash" class="icon"></wicket:svg></a>+ </wicket:fragment>+</wicket:extend>diff --git a/server-core/src/main/java/io/onedev/server/web/page/project/setting/webhook/WebHooksPage.java b/server-core/src/main/java/io/onedev/server/web/page/project/setting/webhook/WebHooksPage.javaindex 610cf42f6e..3e66b371d4 100644--- a/server-core/src/main/java/io/onedev/server/web/page/project/setting/webhook/WebHooksPage.java+++ b/server-core/src/main/java/io/onedev/server/web/page/project/setting/webhook/WebHooksPage.java@@ -2,23 +2,50 @@ package io.onedev.server.web.page.project.setting.webhook;import static io.onedev.server.web.translation.Translation._T;-import java.io.Serializable;+import java.util.ArrayList;+import java.util.List;import org.apache.wicket.Component;-import org.apache.wicket.feedback.FencedFeedbackPanel;+import org.apache.wicket.ajax.AjaxRequestTarget;+import org.apache.wicket.ajax.attributes.AjaxRequestAttributes;+import org.apache.wicket.ajax.markup.html.AjaxLink;+import org.apache.wicket.extensions.markup.html.repeater.data.grid.ICellPopulator;+import org.apache.wicket.extensions.markup.html.repeater.data.table.AbstractColumn;+import org.apache.wicket.extensions.markup.html.repeater.data.table.DataTable;+import org.apache.wicket.extensions.markup.html.repeater.data.table.HeadersToolbar;+import org.apache.wicket.extensions.markup.html.repeater.data.table.IColumn;+import org.apache.wicket.extensions.markup.html.repeater.data.table.NoRecordsToolbar;+import org.apache.wicket.markup.ComponentTag;+import org.apache.wicket.markup.html.WebMarkupContainer;import org.apache.wicket.markup.html.basic.Label;-import org.apache.wicket.markup.html.form.Form;+import org.apache.wicket.markup.html.list.LoopItem;+import org.apache.wicket.markup.html.panel.Fragment;+import org.apache.wicket.markup.repeater.Item;+import org.apache.wicket.markup.repeater.data.IDataProvider;+import org.apache.wicket.markup.repeater.data.ListDataProvider;+import org.apache.wicket.model.IModel;+import org.apache.wicket.model.Model;import org.apache.wicket.request.mapper.parameter.PageParameters;import io.onedev.server.OneDev;import io.onedev.server.data.migration.VersionedXmlDoc;+import io.onedev.server.model.Project;+import io.onedev.server.model.support.WebHook;import io.onedev.server.service.ProjectService;-import io.onedev.server.web.editable.PropertyContext;-import io.onedev.server.web.editable.PropertyEditor;+import io.onedev.server.util.CollectionUtils;+import io.onedev.server.web.ajaxlistener.ConfirmClickListener;+import io.onedev.server.web.behavior.NoRecordsBehavior;+import io.onedev.server.web.behavior.sortable.SortBehavior;+import io.onedev.server.web.behavior.sortable.SortPosition;+import io.onedev.server.web.component.modal.ModalLink;+import io.onedev.server.web.component.modal.ModalPanel;+import io.onedev.server.web.component.svg.SpriteImage;import io.onedev.server.web.page.project.setting.ProjectSettingPage;public class WebHooksPage extends ProjectSettingPage {+ private DataTable<WebHook, Void> hooksTable;+public WebHooksPage(PageParameters params) {super(params);}@@ -27,29 +54,183 @@ public class WebHooksPage extends ProjectSettingPage {protected void onInitialize() {super.onInitialize();- WebHooksBean bean = new WebHooksBean();- bean.setWebHooks(getProject().getWebHooks());- var oldAuditContent = VersionedXmlDoc.fromBean(bean).toXML();+ add(new ModalLink("addNew") {++ @Override+ protected Component newContent(String id, ModalPanel modal) {+ return new WebHookEditPanel(id, -1) {++ @Override+ protected Project getProject() {+ return WebHooksPage.this.getProject();+ }++ @Override+ protected void onSave(AjaxRequestTarget target) {+ target.add(hooksTable);+ modal.close();+ }++ @Override+ protected void onCancel(AjaxRequestTarget target) {+ modal.close();+ }++ };+ }++ });++ List<IColumn<WebHook, Void>> columns = new ArrayList<>();++ columns.add(new AbstractColumn<WebHook, Void>(Model.of("")) {++ @Override+ public void populateItem(Item<ICellPopulator<WebHook>> cellItem, String componentId, IModel<WebHook> rowModel) {+ cellItem.add(new SpriteImage(componentId, "grip") {++ @Override+ protected void onComponentTag(ComponentTag tag) {+ super.onComponentTag(tag);+ tag.setName("svg");+ tag.put("class", "icon drag-indicator");+ }++ });+ }++ @Override+ public String getCssClass() {+ return "minimum actions";+ }++ });++ columns.add(new AbstractColumn<WebHook, Void>(Model.of(_T("Post URL"))) {++ @Override+ public void populateItem(Item<ICellPopulator<WebHook>> cellItem, String componentId, IModel<WebHook> rowModel) {+ int hookIndex = cellItem.findParent(LoopItem.class).getIndex();+ Fragment fragment = new Fragment(componentId, "urlColumnFrag", WebHooksPage.this);+ var link = newEditLink("link", hookIndex);+ link.add(new Label("label", rowModel.getObject().getPostUrl()));+ fragment.add(link);+ cellItem.add(fragment);+ }++ });++ columns.add(new AbstractColumn<WebHook, Void>(Model.of(_T("Events"))) {++ @Override+ public void populateItem(Item<ICellPopulator<WebHook>> cellItem, String componentId, IModel<WebHook> rowModel) {+ var eventTypes = rowModel.getObject().getEventTypes();+ cellItem.add(new Label(componentId, eventTypes.size()));+ }++ });++ columns.add(new AbstractColumn<WebHook, Void>(Model.of(_T("Custom Headers"))) {++ @Override+ public void populateItem(Item<ICellPopulator<WebHook>> cellItem, String componentId, IModel<WebHook> rowModel) {+ cellItem.add(new Label(componentId, rowModel.getObject().getHeaders().size()));+ }++ });++ columns.add(new AbstractColumn<WebHook, Void>(Model.of("")) {++ @Override+ public void populateItem(Item<ICellPopulator<WebHook>> cellItem, String componentId, IModel<WebHook> rowModel) {+ int hookIndex = cellItem.findParent(LoopItem.class).getIndex();+ Fragment fragment = new Fragment(componentId, "actionColumnFrag", WebHooksPage.this);+ fragment.add(newEditLink("edit", hookIndex));+ fragment.add(new AjaxLink<Void>("delete") {++ @Override+ protected void updateAjaxAttributes(AjaxRequestAttributes attributes) {+ super.updateAjaxAttributes(attributes);+ attributes.getAjaxCallListeners().add(new ConfirmClickListener(_T("Do you really want to delete this web hook?")));+ }++ @Override+ public void onClick(AjaxRequestTarget target) {+ var hook = getProject().getWebHooks().remove(hookIndex);+ var oldAuditContent = VersionedXmlDoc.fromBean(hook).toXML();+ OneDev.getInstance(ProjectService.class).update(getProject());+ auditService.audit(getProject(), "deleted web hook \"" + hook.getPostUrl() + "\"", oldAuditContent, null);+ target.add(hooksTable);+ }++ });+ cellItem.add(fragment);+ }++ @Override+ public String getCssClass() {+ return "actions text-nowrap";+ }++ });++ IDataProvider<WebHook> dataProvider = new ListDataProvider<WebHook>() {++ @Override+ protected List<WebHook> getData() {+ return getProject().getWebHooks();+ }++ };- PropertyEditor<Serializable> editor = PropertyContext.edit("editor", bean, "webHooks");-- Form<?> form = new Form<Void>("form") {+ add(hooksTable = new DataTable<WebHook, Void>("webHooks", columns, dataProvider, Integer.MAX_VALUE));+ hooksTable.addTopToolbar(new HeadersToolbar<Void>(hooksTable, null));+ hooksTable.addBottomToolbar(new NoRecordsToolbar(hooksTable));+ hooksTable.add(new NoRecordsBehavior());+ hooksTable.setOutputMarkupId(true);++ hooksTable.add(new SortBehavior() {@Override- protected void onSubmit() {- super.onSubmit();- var newAuditContent = VersionedXmlDoc.fromBean(bean).toXML();- getProject().setWebHooks(bean.getWebHooks());+ protected void onSort(AjaxRequestTarget target, SortPosition from, SortPosition to) {+ var oldAuditContent = VersionedXmlDoc.fromBean(getProject().getWebHooks()).toXML();+ CollectionUtils.move(getProject().getWebHooks(), from.getItemIndex(), to.getItemIndex());+ var newAuditContent = VersionedXmlDoc.fromBean(getProject().getWebHooks()).toXML();OneDev.getInstance(ProjectService.class).update(getProject());- auditService.audit(getProject(), "changed web hooks", oldAuditContent, newAuditContent);- setResponsePage(WebHooksPage.class, WebHooksPage.paramsOf(getProject()));- getSession().success(_T("Web hooks saved"));+ auditService.audit(getProject(), "changed order of web hooks", oldAuditContent, newAuditContent);+ target.add(hooksTable);+ }++ }.sortable("tbody"));+ }++ private WebMarkupContainer newEditLink(String componentId, int hookIndex) {+ return new ModalLink(componentId) {++ @Override+ protected Component newContent(String id, ModalPanel modal) {+ return new WebHookEditPanel(id, hookIndex) {++ @Override+ protected Project getProject() {+ return WebHooksPage.this.getProject();+ }++ @Override+ protected void onSave(AjaxRequestTarget target) {+ target.add(hooksTable);+ modal.close();+ }++ @Override+ protected void onCancel(AjaxRequestTarget target) {+ modal.close();+ }++ };}-+};- form.add(new FencedFeedbackPanel("feedback", form));- form.add(editor);- add(form);}@Override