Merge pull request #1494 from rust-lang/gh-comment-auth-fix

Split GraphQL client from the REST API GitHub client and use proper authentication for it

Author: Mark-Simulacrum

site/src/github.rs

@@ -9,7 +9,6 @@ use serde::Deserialize;
 type BoxedError = Box<dyn std::error::Error + Send + Sync>;
 
 pub const RUST_REPO_GITHUB_API_URL: &str = "https://api.github.com/repos/rust-lang/rust";
-pub const RUST_REPO_GITHUB_GRAPH_URL: &str = "https://api.github.com/graphql";
 
 /// Comments that are temporary and do not add any value once there has been a new development
 /// (a rustc build or a perf. run was finished) are marked with this comment.

site/src/github/client.rs

@@ -1,10 +1,13 @@
 use anyhow::Context;
 use chrono::{DateTime, Utc};
+use http::header;
 use http::header::USER_AGENT;
 use serde::de::DeserializeOwned;
 
 use crate::{api::github::Issue, load::SiteCtxt};
 
+const BOT_USER_AGENT: &str = "perf-rust-lang-org-server";
+
 /// A client for interacting with the GitHub API
 pub struct Client {
     repository_url: String,
@@ -227,6 +230,49 @@ impl Client {
         }
     }
 
+    async fn send(
+        &self,
+        request: reqwest::RequestBuilder,
+    ) -> Result<reqwest::Response, reqwest::Error> {
+        request
+            .header(USER_AGENT, BOT_USER_AGENT)
+            .basic_auth("rust-timer", Some(&self.token))
+            .send()
+            .await
+    }
+}
+
+const GRAPHQL_API_BASE: &str = "https://api.github.com/graphql";
+
+/// A client for interacting with the GraphQL GitHub API.
+pub struct GraphQLClient {
+    inner: reqwest::Client,
+}
+
+impl GraphQLClient {
+    /// Create a GraphQL client from a `SiteCtxt`.
+    pub fn from_ctxt(ctxt: &SiteCtxt) -> Self {
+        let token = ctxt
+            .config
+            .keys
+            .github_api_token
+            .clone()
+            .expect("needs github API token");
+
+        let mut headers = header::HeaderMap::new();
+        headers.insert(USER_AGENT, header::HeaderValue::from_static(BOT_USER_AGENT));
+        headers.insert(
+            header::AUTHORIZATION,
+            header::HeaderValue::from_str(&format!("token {}", token)).unwrap(),
+        );
+
+        let client = reqwest::ClientBuilder::new()
+            .default_headers(headers)
+            .build()
+            .unwrap();
+        Self { inner: client }
+    }
+
     pub async fn get_comments(&self, pull_request: u32) -> anyhow::Result<Vec<ResponseComment>> {
         const QUERY: &str = "query($owner: String!, $repo: String!, $pr: Int!, $cursor: String) {
                 repository(owner: $owner, name: $repo) {
@@ -273,7 +319,7 @@ impl Client {
         let mut cursor = None;
         loop {
             let mut resp: Response = self
-                .graphql(
+                .send(
                     QUERY,
                     serde_json::json!({
                         "owner": owner,
@@ -303,7 +349,7 @@ impl Client {
             }
         }";
 
-        self.graphql::<Option<MinimizeData>, _>(
+        self.send::<Option<MinimizeData>, _>(
             MINIMIZE,
             serde_json::json!({
                 "node_id": comment_id,
@@ -314,7 +360,7 @@ impl Client {
         Ok(())
     }
 
-    async fn graphql<T: DeserializeOwned, V: serde::Serialize>(
+    async fn send<T: DeserializeOwned, V: serde::Serialize>(
         &self,
         query: &str,
         variables: V,
@@ -327,7 +373,7 @@ impl Client {
 
         let response: GraphResponse<T> = self
             .inner
-            .post(&self.repository_url)
+            .post(GRAPHQL_API_BASE)
             .json(&GraphPayload { query, variables })
             .send()
             .await?
@@ -344,17 +390,6 @@ impl Client {
             ))
         }
     }
-
-    async fn send(
-        &self,
-        request: reqwest::RequestBuilder,
-    ) -> Result<reqwest::Response, reqwest::Error> {
-        request
-            .header(USER_AGENT, "perf-rust-lang-org-server")
-            .basic_auth("rust-timer", Some(&self.token))
-            .send()
-            .await
-    }
 }
 
 #[derive(serde::Deserialize)]

site/src/github/comparison_summary.rs

@@ -6,7 +6,7 @@ use crate::load::SiteCtxt;
 
 use database::{ArtifactId, QueuedCommit};
 
-use crate::github::{COMMENT_MARK_TEMPORARY, RUST_REPO_GITHUB_API_URL, RUST_REPO_GITHUB_GRAPH_URL};
+use crate::github::{COMMENT_MARK_TEMPORARY, RUST_REPO_GITHUB_API_URL};
 use std::collections::HashSet;
 use std::fmt::Write;
 
@@ -83,8 +83,7 @@ async fn post_comparison_comment(
 
     client.post_comment(pr, body).await;
 
-    let graph_client =
-        super::client::Client::from_ctxt(ctxt, RUST_REPO_GITHUB_GRAPH_URL.to_owned());
+    let graph_client = super::client::GraphQLClient::from_ctxt(ctxt);
     for comment in graph_client.get_comments(pr).await? {
         // If this bot is the author of the comment, the comment is not yet minimized and it is
         // a temporary comment, minimize it.