Merge pull request #631 from ryandens/ryandens/configurable-route-path

Allow the webhook listener path to be configurable

Author: gsmet

docs/modules/ROOT/pages/includes/attributes.adoc

@@ -1,4 +1,4 @@
-:quarkus-version: 3.9.2
+:quarkus-version: 3.11.2
 :quarkus-github-app-version: 2.5.1
 
 :github-api-javadoc-root-url: https://github-api.kohsuke.org/apidocs/org/kohsuke/github

docs/modules/ROOT/pages/includes/quarkus-github-app.adoc

@@ -85,6 +85,25 @@ endif::add-copy-button-to-env-var[]
 |
 
 
+a| [[quarkus-github-app_quarkus-github-app-webhook-url-path]]`link:#quarkus-github-app_quarkus-github-app-webhook-url-path[quarkus.github-app.webhook-url-path]`
+
+
+[.description]
+--
+The webhook URL path on which the GitHub App route is mounted.
+
+It defaults to the root `/` but it can be configured to another path such as `/github-events` to enable deployment alongside other HTTP routes.
+
+ifdef::add-copy-button-to-env-var[]
+Environment variable: env_var_with_copy_button:+++QUARKUS_GITHUB_APP_WEBHOOK_URL_PATH+++[]
+endif::add-copy-button-to-env-var[]
+ifndef::add-copy-button-to-env-var[]
+Environment variable: `+++QUARKUS_GITHUB_APP_WEBHOOK_URL_PATH+++`
+endif::add-copy-button-to-env-var[]
+--|string 
+|`/`
+
+
 a| [[quarkus-github-app_quarkus-github-app-webhook-secret]]`link:#quarkus-github-app_quarkus-github-app-webhook-secret[quarkus.github-app.webhook-secret]`
 
 

runtime/src/main/java/io/quarkiverse/githubapp/runtime/Routes.java

@@ -28,14 +28,13 @@
 import io.quarkus.runtime.LaunchMode;
 import io.quarkus.runtime.StartupEvent;
 import io.quarkus.vertx.http.runtime.HttpConfiguration;
-import io.quarkus.vertx.web.Header;
-import io.quarkus.vertx.web.Route;
-import io.quarkus.vertx.web.Route.HandlerType;
-import io.quarkus.vertx.web.Route.HttpMethod;
 import io.quarkus.vertx.web.RoutingExchange;
+import io.quarkus.vertx.web.runtime.RoutingExchangeImpl;
 import io.vertx.core.json.Json;
 import io.vertx.core.json.JsonObject;
+import io.vertx.ext.web.Router;
 import io.vertx.ext.web.RoutingContext;
+import io.vertx.ext.web.handler.BodyHandler;
 
 @Singleton
 public class Routes {
@@ -72,14 +71,28 @@ public void init(@Observes StartupEvent startupEvent) throws IOException {
         }
     }
 
-    @Route(path = "/", type = HandlerType.BLOCKING, methods = HttpMethod.POST, consumes = "application/json", produces = "application/json")
-    public void handleRequest(RoutingContext routingContext,
+    public void init(@Observes Router router) {
+        router.post(checkedConfigProvider.webhookUrlPath())
+                .handler(BodyHandler.create()) // this is required so that the body to be read by subsequent handlers
+                .blockingHandler(routingContext -> {
+                    handleRequest(
+                            routingContext,
+                            new RoutingExchangeImpl(routingContext),
+                            routingContext.request().getHeader(X_REQUEST_ID),
+                            routingContext.request().getHeader(X_HUB_SIGNATURE_256),
+                            routingContext.request().getHeader(X_GITHUB_DELIVERY),
+                            routingContext.request().getHeader(X_GITHUB_EVENT),
+                            routingContext.request().getHeader(X_QUARKIVERSE_GITHUB_APP_REPLAYED));
+                });
+    }
+
+    private void handleRequest(RoutingContext routingContext,
             RoutingExchange routingExchange,
-            @Header(X_REQUEST_ID) String requestId,
-            @Header(X_HUB_SIGNATURE_256) String hubSignature,
-            @Header(X_GITHUB_DELIVERY) String deliveryId,
-            @Header(X_GITHUB_EVENT) String event,
-            @Header(X_QUARKIVERSE_GITHUB_APP_REPLAYED) String replayed) throws IOException {
+            String requestId,
+            String hubSignature,
+            String deliveryId,
+            String event,
+            String replayed) {
 
         if (!launchMode.isDevOrTest() && (isBlank(deliveryId) || isBlank(hubSignature))) {
             routingExchange.response().setStatusCode(400).end();
@@ -118,7 +131,12 @@ public void handleRequest(RoutingContext routingContext,
         if (!isBlank(deliveryId) && checkedConfigProvider.debug().payloadDirectory.isPresent()) {
             String fileName = DATE_TIME_FORMATTER.format(LocalDateTime.now()) + "-" + event + "-"
                     + (!isBlank(action) ? action + "-" : "") + deliveryId + ".json";
-            Files.write(checkedConfigProvider.debug().payloadDirectory.get().resolve(fileName), bodyBytes);
+            Path path = checkedConfigProvider.debug().payloadDirectory.get().resolve(fileName);
+            try {
+                Files.write(path, bodyBytes);
+            } catch (Exception e) {
+                LOG.warnf(e, "Unable to write debug payload: %s", path);
+            }
         }
 
         Long installationId = extractInstallationId(payloadObject);

runtime/src/main/java/io/quarkiverse/githubapp/runtime/config/CheckedConfigProvider.java

@@ -33,6 +33,7 @@ public class CheckedConfigProvider {
 
     private final Optional<PrivateKey> privateKey;
     private final Optional<String> webhookSecret;
+    private final String webhookUrlPath;
 
     private final Set<String> missingPropertyKeys = new TreeSet<>();
 
@@ -54,6 +55,8 @@ public class CheckedConfigProvider {
         } else {
             this.webhookSecret = gitHubAppRuntimeConfig.webhookSecret;
         }
+        this.webhookUrlPath = gitHubAppRuntimeConfig.webhookUrlPath.startsWith("/") ? gitHubAppRuntimeConfig.webhookUrlPath
+                : "/" + gitHubAppRuntimeConfig.webhookUrlPath;
 
         if (gitHubAppRuntimeConfig.appId.isEmpty()) {
             missingPropertyKeys.add("quarkus.github-app.app-id (.env: QUARKUS_GITHUB_APP_APP_ID)");
@@ -108,6 +111,10 @@ public String restApiEndpoint() {
         return gitHubAppRuntimeConfig.restApiEndpoint;
     }
 
+    public String webhookUrlPath() {
+        return webhookUrlPath;
+    }
+
     public String graphqlApiEndpoint() {
         return gitHubAppRuntimeConfig.graphqlApiEndpoint;
     }

runtime/src/main/java/io/quarkiverse/githubapp/runtime/config/GitHubAppRuntimeConfig.java

@@ -21,6 +21,7 @@ public class GitHubAppRuntimeConfig {
      * Optional for tests, but mandatory in production and dev mode.
      */
     @ConfigItem
+    @ConvertWith(TrimmedStringConverter.class)
     Optional<String> appId;
 
     /**
@@ -29,6 +30,7 @@ public class GitHubAppRuntimeConfig {
      * Optional, only used for improving the user experience.
      */
     @ConfigItem
+    @ConvertWith(TrimmedStringConverter.class)
     Optional<String> appName;
 
     /**
@@ -46,6 +48,16 @@ public class GitHubAppRuntimeConfig {
     @ConvertWith(PrivateKeyConverter.class)
     Optional<PrivateKey> privateKey;
 
+    /**
+     * The webhook URL path on which the GitHub App route is mounted.
+     * <p>
+     * It defaults to the root {@code /} but it can be configured to another path such as {@code /github-events} to enable
+     * deployment alongside other HTTP routes.
+     */
+    @ConfigItem(defaultValue = "/")
+    @ConvertWith(TrimmedStringConverter.class)
+    String webhookUrlPath;
+
     /**
      * The webhook secret if defined in the GitHub UI.
      */
@@ -80,6 +92,7 @@ public class GitHubAppRuntimeConfig {
      * The Smee.io proxy URL used when testing locally.
      */
     @ConfigItem
+    @ConvertWith(TrimmedStringConverter.class)
     Optional<String> webhookProxyUrl;
 
     /**
@@ -88,6 +101,7 @@ public class GitHubAppRuntimeConfig {
      * Defaults to the public github.com instance.
      */
     @ConfigItem(defaultValue = "https://api.github.com")
+    @ConvertWith(TrimmedStringConverter.class)
     String instanceEndpoint;
 
     /**
@@ -96,6 +110,7 @@ public class GitHubAppRuntimeConfig {
      * Defaults to the public github.com instance REST API endpoint.
      */
     @ConfigItem(defaultValue = "${quarkus.github-app.instance-endpoint}")
+    @ConvertWith(TrimmedStringConverter.class)
     String restApiEndpoint;
 
     /**
@@ -104,6 +119,7 @@ public class GitHubAppRuntimeConfig {
      * Defaults to the public github.com instance GraphQL endpoint.
      */
     @ConfigItem(defaultValue = "${quarkus.github-app.instance-endpoint}/graphql")
+    @ConvertWith(TrimmedStringConverter.class)
     String graphqlApiEndpoint;
 
     /**
@@ -119,6 +135,7 @@ public static class Debug {
          * A directory in which the payloads are saved.
          */
         @ConfigItem
+        @ConvertWith(TrimmedStringConverter.class)
         public Optional<Path> payloadDirectory;
     }
 }

runtime/src/main/java/io/quarkiverse/githubapp/runtime/smee/SmeeIoForwarder.java

@@ -2,6 +2,7 @@
 
 import static io.quarkiverse.githubapp.runtime.Headers.FORWARDED_HEADERS;
 
+import java.io.IOException;
 import java.net.URI;
 import java.net.http.HttpClient;
 import java.net.http.HttpRequest;
@@ -50,7 +51,8 @@ public class SmeeIoForwarder {
 
         LOG.info("Listening to events coming from " + checkedConfigProvider.webhookProxyUrl().get());
 
-        URI localUrl = URI.create("http://" + httpConfiguration.host + ":" + httpConfiguration.port + "/");
+        URI localUrl = URI.create(
+                "http://" + httpConfiguration.host + ":" + httpConfiguration.port + checkedConfigProvider.webhookUrlPath());
 
         this.replayEventStreamAdapter = new ReplayEventStreamAdapter(checkedConfigProvider.webhookProxyUrl().get(), localUrl,
                 objectMapper);
@@ -123,6 +125,12 @@ public void onEvent(HttpEventStreamClient client, Event event) {
 
                     forwardingHttpClient.send(requestBuilder.build(), BodyHandlers.discarding());
                 }
+            } catch (IOException e) {
+                if (e.getMessage().contains("GOAWAY received")) {
+                    // ignore
+                } else {
+                    LOG.error("An error occurred while forwarding a payload to the local application running in dev mode", e);
+                }
             } catch (Exception e) {
                 LOG.error("An error occurred while forwarding a payload to the local application running in dev mode", e);
             }