Allow to define a personal access token and inject TokenGitHubClients

While in mosts cases, you shouldn't need it, it could be useful when
receiving webhook events not containing an installation id.

Note that when defined, we try our best to push it in the injection when
the installation is not present.

Author: gsmet

deployment/src/main/java/io/quarkiverse/githubapp/deployment/GitHubAppProcessor.java

@@ -58,6 +58,7 @@
 
 import io.quarkiverse.githubapp.ConfigFile;
 import io.quarkiverse.githubapp.GitHubEvent;
+import io.quarkiverse.githubapp.TokenGitHubClients;
 import io.quarkiverse.githubapp.deployment.DispatchingConfiguration.EventAnnotation;
 import io.quarkiverse.githubapp.deployment.DispatchingConfiguration.EventAnnotationLiteral;
 import io.quarkiverse.githubapp.deployment.DispatchingConfiguration.EventDispatchingConfiguration;
@@ -223,7 +224,8 @@ void additionalBeans(CombinedIndexBuildItem index, BuildProducer<AdditionalBeanB
                 DefaultErrorHandler.class,
                 GitHubFileDownloader.class,
                 GitHubConfigFileProviderImpl.class,
-                CheckedConfigProvider.class)
+                CheckedConfigProvider.class,
+                TokenGitHubClients.class)
                 .setUnremovable();
 
         for (ClassInfo errorHandler : index.getIndex().getAllKnownImplementors(GitHubAppDotNames.ERROR_HANDLER)) {
@@ -582,11 +584,20 @@ private static void generateDispatcher(ClassOutput beanClassOutput,
         }
         BytecodeCreator installationIdNull = testInstallationId.falseBranch();
         installationIdNull.assign(gitHubRh, installationIdNull.invokeVirtualMethod(
-                MethodDescriptor.ofMethod(GitHubService.class, "getApplicationClient", GitHub.class),
+                MethodDescriptor.ofMethod(GitHubService.class, "getTokenOrApplicationClient", GitHub.class),
                 installationIdNull.readInstanceField(
                         FieldDescriptor.of(dispatcherClassCreator.getClassName(), GITHUB_SERVICE_FIELD, GitHubService.class),
                         installationIdNull.getThis())));
-        installationIdNull.assign(gitHubGraphQLClientRh, installationIdNull.loadNull());
+        if (dispatchingConfiguration.requiresGraphQLClient()) {
+            installationIdNull.assign(gitHubGraphQLClientRh, installationIdNull.invokeVirtualMethod(
+                    MethodDescriptor.ofMethod(GitHubService.class, "getTokenGraphQLClientOrNull", DynamicGraphQLClient.class),
+                    installationIdNull.readInstanceField(
+                            FieldDescriptor.of(dispatcherClassCreator.getClassName(), GITHUB_SERVICE_FIELD,
+                                    GitHubService.class),
+                            installationIdNull.getThis())));
+        } else {
+            installationIdNull.assign(gitHubGraphQLClientRh, installationIdNull.loadNull());
+        }
 
         for (EventDispatchingConfiguration eventDispatchingConfiguration : dispatchingConfiguration.getEventConfigurations()
                 .values()) {

deployment/src/test/java/io/quarkiverse/githubapp/deployment/TokenGitHubClientsInjectionTest.java

@@ -0,0 +1,41 @@
+package io.quarkiverse.githubapp.deployment;
+
+import jakarta.inject.Inject;
+
+import org.jboss.shrinkwrap.api.ShrinkWrap;
+import org.jboss.shrinkwrap.api.spec.JavaArchive;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.RegisterExtension;
+import org.kohsuke.github.GHEventPayload;
+
+import io.quarkiverse.githubapp.TokenGitHubClients;
+import io.quarkiverse.githubapp.event.Label;
+import io.quarkus.test.QuarkusUnitTest;
+
+public class TokenGitHubClientsInjectionTest {
+
+    @RegisterExtension
+    static final QuarkusUnitTest config = new QuarkusUnitTest()
+            .setArchiveProducer(() -> ShrinkWrap.create(JavaArchive.class)
+                    .addClass(ListeningClass.class).addClass(ListeningClass2.class))
+            .withConfigurationResource("application-token.properties");
+
+    @Test
+    public void testGitHubGraphQLClientInjection() {
+    }
+
+    static class ListeningClass {
+
+        @Inject
+        TokenGitHubClients tokenGitHubClients;
+
+        void createLabel(@Label.Created GHEventPayload.Label labelPayload) {
+        }
+    }
+
+    static class ListeningClass2 {
+
+        void createLabel(@Label.Created GHEventPayload.Label labelPayload, TokenGitHubClients tokenGitHubClients) {
+        }
+    }
+}

deployment/src/test/resources/application-token.properties

@@ -0,0 +1,2 @@
+quarkus.github-app.app-name=quarkus-github-app-test
+quarkus.github-app.personal-access-token=ghp_mytoken

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

@@ -241,6 +241,29 @@ endif::add-copy-button-to-env-var[]
 |`${quarkus.github-app.instance-endpoint}/graphql`
 
 
+a| [[quarkus-github-app_quarkus-github-app-personal-access-token]]`link:#quarkus-github-app_quarkus-github-app-personal-access-token[quarkus.github-app.personal-access-token]`
+
+
+[.description]
+--
+A personal access token for use with `TokenGitHubClients`.
+
+For standard use cases, you will use the installation client which comes with the installation permissions. It can be injected directly in your method.
+
+However, if your payload comes from a webhook and doesn't have an installation id, it's handy to be able to use a client authenticated with a personal access token as the application client permissions are very limited.
+
+This token will be used to authenticate the clients provided by `TokenGitHubClients`.
+
+ifdef::add-copy-button-to-env-var[]
+Environment variable: env_var_with_copy_button:+++QUARKUS_GITHUB_APP_PERSONAL_ACCESS_TOKEN+++[]
+endif::add-copy-button-to-env-var[]
+ifndef::add-copy-button-to-env-var[]
+Environment variable: `+++QUARKUS_GITHUB_APP_PERSONAL_ACCESS_TOKEN+++`
+endif::add-copy-button-to-env-var[]
+--|string 
+|
+
+
 a| [[quarkus-github-app_quarkus-github-app-debug-payload-directory]]`link:#quarkus-github-app_quarkus-github-app-debug-payload-directory[quarkus.github-app.debug.payload-directory]`
 
 

integration-tests/app/src/main/java/io/quarkiverse/githubapp/it/app/RawEventListener.java

@@ -36,8 +36,8 @@ void testRawEventCatchAllAction(@RawEvent(event = "issues") GitHubEvent gitHubEv
     }
 
     void testRawEventCatchAllEventAction(@RawEvent GitHubEvent gitHubEvent, GitHub gitHub) throws IOException {
-        assert gitHubEvent.getEvent().equals("issues");
-        assert gitHubEvent.getAction().equals("opened");
+        assert gitHubEvent.getEvent() != null;
+        assert gitHubEvent.getAction() != null;
 
         gitHub.getRepository("test/test").getIssue(1).addLabels("testRawEventCatchAllEventAction");
     }

integration-tests/app/src/main/java/io/quarkiverse/githubapp/it/app/RawEventListenerWithoutInstallation.java

@@ -0,0 +1,26 @@
+package io.quarkiverse.githubapp.it.app;
+
+import java.io.IOException;
+
+import org.kohsuke.github.GitHub;
+
+import io.quarkiverse.githubapp.GitHubEvent;
+import io.quarkiverse.githubapp.event.RawEvent;
+import io.smallrye.graphql.client.dynamic.api.DynamicGraphQLClient;
+
+public class RawEventListenerWithoutInstallation {
+
+    public static final String EVENT_TYPE = "sponsor";
+
+    void testRawEventListenerWithoutInstallation(@RawEvent(event = EVENT_TYPE, action = "sponsored") GitHubEvent gitHubEvent,
+            GitHub gitHub,
+            DynamicGraphQLClient graphQLClient) throws IOException {
+        assert gitHubEvent.getEvent().equals(EVENT_TYPE);
+        assert gitHubEvent.getAction().equals("sponsored");
+
+        assert graphQLClient != null;
+        assert gitHub != null;
+
+        gitHub.getRepository("test/test").getIssue(1).addLabels("testRawEventListenerWithoutInstallation");
+    }
+}

integration-tests/app/src/main/resources/application.properties

@@ -28,3 +28,4 @@ E0/FAoGATJvuAfgy9uiKR7za7MigYVacE0u4aD1sF7v6D4AFqBOGquPQQhePSdz9\
 G/UUwySoo+AQ+rd2EPhyexjqXBhRGe+EDGFVFivaQzTT8/5bt/VddbTcw2IpmXYj\
 LW6V8BbcP5MRhd2JQSRh16nWwSQJ2BdpUZFwayEEQ6UcrMfqvA0=\
 -----END RSA PRIVATE KEY-----
+%test.quarkus.github-app.personal-access-token=ghp_mytoken

integration-tests/app/src/test/java/io/quarkiverse/githubapp/it/app/RawEventWithoutInstallationTest.java

@@ -0,0 +1,33 @@
+package io.quarkiverse.githubapp.it.app;
+
+import static io.quarkiverse.githubapp.testing.GitHubAppTesting.given;
+import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.when;
+
+import java.io.IOException;
+
+import org.junit.jupiter.api.Test;
+
+import io.quarkiverse.githubapp.testing.GitHubAppTest;
+import io.quarkus.test.junit.QuarkusTest;
+
+@QuarkusTest
+@GitHubAppTest
+public class RawEventWithoutInstallationTest {
+
+    @Test
+    void testRawEventWithoutInstallation() throws IOException {
+        given().github(mocks -> {
+            when(mocks.repository("test/test").getIssue(1))
+                    .thenReturn(mocks.issue(1L));
+        })
+                .when().payloadFromClasspath("/event-without-installation.json")
+                .rawEvent(RawEventListenerWithoutInstallation.EVENT_TYPE)
+                .then().github(mocks -> {
+                    verify(mocks.issue(1))
+                            .addLabels("testRawEventListenerWithoutInstallation");
+                    verify(mocks.issue(1))
+                            .addLabels("testRawEventCatchAllEventAction");
+                });
+    }
+}

integration-tests/app/src/test/resources/event-without-installation.json

@@ -0,0 +1,23 @@
+{
+  "action": "sponsored",
+  "sender": {
+    "login": "yrodiere",
+    "id": 412878,
+    "node_id": "MDQ6VXNlcjQxMjg3OA==",
+    "avatar_url": "https://avatars1.githubusercontent.com/u/412878?v=4",
+    "gravatar_id": "",
+    "url": "https://api.github.com/users/yrodiere",
+    "html_url": "https://github.com/yrodiere",
+    "followers_url": "https://api.github.com/users/yrodiere/followers",
+    "following_url": "https://api.github.com/users/yrodiere/following{/other_user}",
+    "gists_url": "https://api.github.com/users/yrodiere/gists{/gist_id}",
+    "starred_url": "https://api.github.com/users/yrodiere/starred{/owner}{/repo}",
+    "subscriptions_url": "https://api.github.com/users/yrodiere/subscriptions",
+    "organizations_url": "https://api.github.com/users/yrodiere/orgs",
+    "repos_url": "https://api.github.com/users/yrodiere/repos",
+    "events_url": "https://api.github.com/users/yrodiere/events{/privacy}",
+    "received_events_url": "https://api.github.com/users/yrodiere/received_events",
+    "type": "User",
+    "site_admin": false
+  }
+}

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

@@ -0,0 +1,26 @@
+package io.quarkiverse.githubapp;
+
+import jakarta.inject.Singleton;
+
+import org.kohsuke.github.GitHub;
+
+import io.quarkiverse.githubapp.runtime.github.GitHubService;
+import io.smallrye.graphql.client.dynamic.api.DynamicGraphQLClient;
+
+@Singleton
+public class TokenGitHubClients {
+
+    private final GitHubService gitHubService;
+
+    TokenGitHubClients(GitHubService gitHubService) {
+        this.gitHubService = gitHubService;
+    }
+
+    public GitHub getRestClient() {
+        return gitHubService.getTokenRestClient();
+    }
+
+    public DynamicGraphQLClient getGraphQLClient() {
+        return gitHubService.getTokenGraphQLClient();
+    }
+}