Add basic functionality for running graphql requests (#182)

* WIP: enable automerge

* Test enableAutoMerge

* Add factory methods for configuring graphqlUrl

* javadoc...

* chores...

* Make generic graphql method in GithubClient instead

* Update src/main/java/com/spotify/github/v3/clients/GitHubClient.java

Co-authored-by: Abhishek Jain <[email protected]>

* Javadoc

---------

Co-authored-by: Abhishek Jain <[email protected]>

Author: dennisgranath

src/main/java/com/spotify/github/v3/clients/GitHubClient.java

@@ -118,6 +118,8 @@ public class GitHubClient {
   private static final int FORBIDDEN = 403;
 
   private final URI baseUrl;
+
+  private final Optional<URI> graphqlUrl;
   private final Json json = Json.create();
   private final OkHttpClient client;
   private final String token;
@@ -131,11 +133,13 @@ public class GitHubClient {
   private GitHubClient(
       final OkHttpClient client,
       final URI baseUrl,
+      final URI graphqlUrl,
       final String accessToken,
       final byte[] privateKey,
       final Integer appId,
       final Integer installationId) {
     this.baseUrl = baseUrl;
+    this.graphqlUrl = Optional.ofNullable(graphqlUrl);
     this.token = accessToken;
     this.client = client;
     this.privateKey = privateKey;
@@ -152,7 +156,11 @@ private GitHubClient(
    * @return github api client
    */
   public static GitHubClient create(final URI baseUrl, final String token) {
-    return new GitHubClient(new OkHttpClient(), baseUrl, token, null, null, null);
+    return new GitHubClient(new OkHttpClient(), baseUrl, null, token, null, null, null);
+  }
+
+  public static GitHubClient create(final URI baseUrl, final URI graphqlUri, final String token) {
+    return new GitHubClient(new OkHttpClient(), baseUrl, graphqlUri, token, null, null, null);
   }
 
   /**
@@ -164,7 +172,7 @@ public static GitHubClient create(final URI baseUrl, final String token) {
    * @return github api client
    */
   public static GitHubClient create(final URI baseUrl, final File privateKey, final Integer appId) {
-    return createOrThrow(new OkHttpClient(), baseUrl, privateKey, appId, null);
+    return createOrThrow(new OkHttpClient(), baseUrl, null, privateKey, appId, null);
   }
 
   /**
@@ -176,7 +184,7 @@ public static GitHubClient create(final URI baseUrl, final File privateKey, fina
    * @return github api client
    */
   public static GitHubClient create(final URI baseUrl, final byte[] privateKey, final Integer appId) {
-    return new GitHubClient(new OkHttpClient(), baseUrl, null, privateKey, appId, null);
+    return new GitHubClient(new OkHttpClient(), baseUrl, null, null, privateKey, appId, null);
   }
 
   /**
@@ -190,7 +198,7 @@ public static GitHubClient create(final URI baseUrl, final byte[] privateKey, fi
    */
   public static GitHubClient create(
       final URI baseUrl, final File privateKey, final Integer appId, final Integer installationId) {
-    return createOrThrow(new OkHttpClient(), baseUrl, privateKey, appId, installationId);
+    return createOrThrow(new OkHttpClient(), baseUrl, null, privateKey, appId, installationId);
   }
 
   /**
@@ -204,7 +212,7 @@ public static GitHubClient create(
    */
   public static GitHubClient create(
           final URI baseUrl, final byte[] privateKey, final Integer appId, final Integer installationId) {
-    return new GitHubClient(new OkHttpClient(), baseUrl, null, privateKey, appId, installationId);
+    return new GitHubClient(new OkHttpClient(), baseUrl, null, null, privateKey, appId, installationId);
   }
 
   /**
@@ -221,7 +229,25 @@ public static GitHubClient create(
       final URI baseUrl,
       final File privateKey,
       final Integer appId) {
-    return createOrThrow(httpClient, baseUrl, privateKey, appId, null);
+    return createOrThrow(httpClient, baseUrl, null, privateKey, appId, null);
+  }
+
+  /**
+   * Create a github api client with a given base URL and a path to a key.
+   *
+   * @param httpClient an instance of OkHttpClient
+   * @param baseUrl base URL
+   * @param privateKey the private key PEM file
+   * @param appId the github app ID
+   * @return github api client
+   */
+  public static GitHubClient create(
+          final OkHttpClient httpClient,
+          final URI baseUrl,
+          final URI graphqlUrl,
+          final File privateKey,
+          final Integer appId) {
+    return createOrThrow(httpClient, baseUrl, graphqlUrl, privateKey, appId, null);
   }
 
   /**
@@ -238,9 +264,11 @@ public static GitHubClient create(
           final URI baseUrl,
           final byte[] privateKey,
           final Integer appId) {
-    return new GitHubClient(httpClient, baseUrl, null, privateKey, appId, null);
+    return new GitHubClient(httpClient, baseUrl, null, null, privateKey, appId, null);
   }
 
+
+
   /**
    * Create a github api client with a given base URL and a path to a key.
    *
@@ -256,7 +284,7 @@ public static GitHubClient create(
       final File privateKey,
       final Integer appId,
       final Integer installationId) {
-    return createOrThrow(httpClient, baseUrl, privateKey, appId, installationId);
+    return createOrThrow(httpClient, baseUrl, null, privateKey, appId, installationId);
   }
 
   /**
@@ -274,7 +302,7 @@ public static GitHubClient create(
           final byte[] privateKey,
           final Integer appId,
           final Integer installationId) {
-    return new GitHubClient(httpClient, baseUrl, null, privateKey, appId, installationId);
+    return new GitHubClient(httpClient, baseUrl, null, null, privateKey, appId, installationId);
   }
 
   /**
@@ -287,7 +315,12 @@ public static GitHubClient create(
    */
   public static GitHubClient create(
       final OkHttpClient httpClient, final URI baseUrl, final String token) {
-    return new GitHubClient(httpClient, baseUrl, token, null, null, null);
+    return new GitHubClient(httpClient, baseUrl, null, token, null, null, null);
+  }
+
+  public static GitHubClient create(
+          final OkHttpClient httpClient, final URI baseUrl, final URI graphqlUrl, final String token) {
+    return new GitHubClient(httpClient, baseUrl, graphqlUrl, token, null, null, null);
   }
 
   /**
@@ -306,6 +339,7 @@ public static GitHubClient scopeForInstallationId(
         client.client,
         client.baseUrl,
         null,
+        null,
         client.getPrivateKey().get(),
         client.appId,
         installationId);
@@ -327,6 +361,7 @@ public GitHubClient withScopeForInstallationId(final int installationId) {
         client,
         baseUrl,
         null,
+        null,
         privateKey,
         appId,
         installationId);
@@ -565,6 +600,23 @@ <T> CompletableFuture<T> post(final String path, final String data, final Class<
             response -> json().fromJsonUncheckedNotNull(responseBodyUnchecked(response), clazz));
   }
 
+  /**
+   * Make a POST request to the graphql endpoint of Github
+   *
+   * @param data request body as stringified JSON
+   * @return response
+   *
+   * @see "https://docs.github.com/en/[email protected]/graphql/guides/forming-calls-with-graphql#communicating-with-graphql"
+   */
+  public CompletableFuture<Response> postGraphql(final String data) {
+    final Request request =
+        graphqlRequestBuilder()
+            .method("POST", RequestBody.create(parse(MediaType.APPLICATION_JSON), data))
+            .build();
+    log.info("Making POST request to {}", request.url());
+    return call(request);
+  }
+
   /**
    * Make an http PUT request for the given path with provided JSON body.
    *
@@ -698,6 +750,22 @@ private Request.Builder requestBuilder(final String path) {
     return builder;
   }
 
+  private Request.Builder graphqlRequestBuilder() {
+    URI url = graphqlUrl.orElseThrow(() -> new IllegalStateException("No graphql url set"));
+    final Request.Builder builder =
+            new Request.Builder()
+                    .url(url.toString())
+                    .addHeader(HttpHeaders.ACCEPT, MediaType.APPLICATION_JSON)
+                    .addHeader(HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_JSON);
+    builder.addHeader(HttpHeaders.AUTHORIZATION, getAuthorizationHeader("/graphql"));
+    return builder;
+  }
+
+  public boolean isGraphqlEnabled() {
+    return graphqlUrl.isPresent();
+  }
+
+
   /*
    Generates the Authentication header, given the API endpoint and the credentials provided.
 
@@ -870,9 +938,9 @@ CompletableFuture<Response> processPossibleRedirects(
   /**
    * Wrapper to Constructors that expose File object for the privateKey argument
    * */
-  private static GitHubClient createOrThrow(final OkHttpClient httpClient, final URI baseUrl, final File privateKey, final Integer appId, final Integer installationId) {
+  private static GitHubClient createOrThrow(final OkHttpClient httpClient, final URI baseUrl, final URI graphqlUrl, final File privateKey, final Integer appId, final Integer installationId) {
     try {
-      return new GitHubClient(httpClient, baseUrl, null, FileUtils.readFileToByteArray(privateKey), appId, installationId);
+      return new GitHubClient(httpClient, baseUrl, graphqlUrl, null, FileUtils.readFileToByteArray(privateKey), appId, installationId);
     } catch (IOException e) {
       throw new RuntimeException("There was an error generating JWT token", e);
     }

src/main/java/com/spotify/github/v3/clients/PullRequestClient.java

@@ -7,9 +7,9 @@
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
- * 
+ *
  *      http://www.apache.org/licenses/LICENSE-2.0
- * 
+ *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -269,5 +269,4 @@ private CompletableFuture<List<PullRequestItem>> list(final String parameterPath
     log.debug("Fetching pull requests from " + path);
     return github.request(path, LIST_PR_TYPE_REFERENCE);
   }
-
 }

src/main/java/com/spotify/github/v3/prs/PullRequest.java

@@ -38,6 +38,8 @@
 @JsonDeserialize(as = ImmutablePullRequest.class)
 public interface PullRequest extends PullRequestItem {
 
+  String nodeId();
+
   /** Is it merged. */
   @Nullable
   Boolean merged();

src/test/java/com/spotify/github/v3/clients/PullRequestClientTest.java

@@ -24,17 +24,15 @@
 import static java.nio.charset.Charset.defaultCharset;
 import static org.hamcrest.MatcherAssert.assertThat;
 import static org.hamcrest.core.Is.is;
-import static org.junit.jupiter.api.Assertions.assertEquals;
-import static org.junit.jupiter.api.Assertions.assertThrows;
+import static org.junit.jupiter.api.Assertions.*;
 import static org.mockito.ArgumentMatchers.any;
-import static org.mockito.Mockito.doNothing;
-import static org.mockito.Mockito.mock;
-import static org.mockito.Mockito.when;
+import static org.mockito.Mockito.*;
 
 import com.google.common.collect.ImmutableList;
 import com.google.common.io.Resources;
 import com.spotify.github.v3.exceptions.RequestNotOkException;
 import com.spotify.github.v3.prs.ImmutableRequestReviewParameters;
+import com.spotify.github.v3.prs.MergeMethod;
 import com.spotify.github.v3.prs.PullRequest;
 import com.spotify.github.v3.prs.ReviewRequests;
 import com.spotify.github.v3.prs.requests.ImmutablePullRequestCreate;
@@ -46,14 +44,9 @@
 import java.net.URI;
 import java.util.concurrent.CompletableFuture;
 import java.util.concurrent.ExecutionException;
-import okhttp3.Call;
-import okhttp3.Callback;
-import okhttp3.MediaType;
-import okhttp3.OkHttpClient;
-import okhttp3.Protocol;
-import okhttp3.Request;
-import okhttp3.Response;
-import okhttp3.ResponseBody;
+
+import okhttp3.*;
+import okio.Buffer;
 import org.apache.commons.io.IOUtils;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
@@ -71,7 +64,7 @@ private static String getFixture(String resource) throws IOException {
   @BeforeEach
   public void setUp() {
     client = mock(OkHttpClient.class);
-    github = GitHubClient.create(client, URI.create("http://bogus"), "token");
+    github = GitHubClient.create(client, URI.create("http://bogus"), URI.create("https://bogus/graphql"), "token");
   }
 
   @Test

src/test/java/com/spotify/github/v3/prs/PullRequestTest.java

@@ -38,6 +38,7 @@ public void testDeserializationPr() throws IOException {
     String fixture =
         Resources.toString(getResource(this.getClass(), "pull_request.json"), defaultCharset());
     final PullRequest pr = Json.create().fromJson(fixture, PullRequest.class);
+    assertThat(pr.nodeId(), is("MDExOlB1bGxSZXF1ZXN0NDI3NDI0Nw=="));
     assertThat(pr.mergeCommitSha().get(), is("e5bd3914e2e596debea16f433f57875b5b90bcd6"));
     assertThat(pr.merged(), is(false));
     assertThat(pr.mergeable().get(), is(true));

src/test/resources/com/spotify/github/v3/activity/events/fixtures/pull_request_event.json

@@ -4,6 +4,7 @@
   "pull_request": {
     "url": "https://api.github.com/repos/baxterthehacker/public-repo/pulls/1",
     "id": 34778301,
+    "node_id": "MDExOlB1bGxSZXF1ZXN0NDI3NDI0Nw==",
     "html_url": "https://github.com/baxterthehacker/public-repo/pull/1",
     "diff_url": "https://github.com/baxterthehacker/public-repo/pull/1.diff",
     "patch_url": "https://github.com/baxterthehacker/public-repo/pull/1.patch",

src/test/resources/com/spotify/github/v3/hooks/requests/pull-request-closed.json

@@ -4,6 +4,7 @@
   "pull_request": {
     "url": "https://github.com/api/v3/repos/abba/custom-abba-metric-web/pulls/1",
     "id": 320629,
+    "node_id": "MDExOlB1bGxSZXF1ZXN0NDI3NDI0Nw==",
     "html_url": "https://github.com/abba/custom-abba-metric-web/pull/1",
     "diff_url": "https://github.com/abba/custom-abba-metric-web/pull/1.diff",
     "patch_url": "https://github.com/abba/custom-abba-metric-web/pull/1.patch",

src/test/resources/com/spotify/github/v3/prs/pull_request.json

@@ -1,6 +1,7 @@
 {
   "id": 1,
   "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347",
+  "node_id": "MDExOlB1bGxSZXF1ZXN0NDI3NDI0Nw==",
   "html_url": "https://github.com/octocat/Hello-World/pull/1347",
   "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff",
   "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch",