Merge pull request #816 from dtolnay-contrib/token

Author: shepmaster

ui/README.md

@@ -6,15 +6,15 @@ disk in this directory.
 In production, these should be set according to your deployment method
 of choice.
 
-| Key                        | Required   | Default Value     | Description                                                               |
-| -------------------------- | ---------- | ----------------- | ------------------------------------------------------------------------- |
-| `PLAYGROUND_UI_ROOT`       | **Yes**    |                   | The path to the HTML, CSS, and Javascript files                           |
-| `PLAYGROUND_GITHUB_TOKEN`  | **Yes**    |                   | The [GitHub API token][gist] to read and write Gists                      |
-| `PLAYGROUND_UI_ADDRESS`    | No         | 127.0.0.1         | The address to listen on                                                  |
-| `PLAYGROUND_UI_PORT`       | No         | 5000              | The port to listen on                                                     |
-| `PLAYGROUND_METRICS_TOKEN` | No         |                   | If set, will require authentication for the metrics endpoint              |
-| `PLAYGROUND_CORS_ENABLED`  | No         |                   | If set, will enable CORS support                                          |
-| `TMPDIR`                   | No         | system-provided   | Where compilation artifacts will be saved. Must be accessible to Docker   |
+| Key                        | Required   | Default Value     | Description                                                                                                                 |
+| -------------------------- | ---------- | ----------------- | --------------------------------------------------------------------------------------------------------------------------- |
+| `PLAYGROUND_UI_ROOT`       | **Yes**    |                   | The path to the HTML, CSS, and Javascript files; for local testing probably you'll use: `PLAYGROUND_UI_ROOT=frontend/build` |
+| `PLAYGROUND_GITHUB_TOKEN`  | No         |                   | The [GitHub API token][gist] to read and write Gists                                                                        |
+| `PLAYGROUND_UI_ADDRESS`    | No         | 127.0.0.1         | The address to listen on                                                                                                    |
+| `PLAYGROUND_UI_PORT`       | No         | 5000              | The port to listen on                                                                                                       |
+| `PLAYGROUND_METRICS_TOKEN` | No         |                   | If set, will require authentication for the metrics endpoint                                                                |
+| `PLAYGROUND_CORS_ENABLED`  | No         |                   | If set, will enable CORS support                                                                                            |
+| `TMPDIR`                   | No         | system-provided   | Where compilation artifacts will be saved. Must be accessible to Docker                                                     |
 
 [dotenv]: https://crates.io/crates/dotenv
 [gist]: https://developer.github.com/v3/gists/#authentication

ui/src/env.rs

@@ -0,0 +1,3 @@
+pub use std::env::*;
+
+pub const PLAYGROUND_GITHUB_TOKEN: &str = "PLAYGROUND_GITHUB_TOKEN";

ui/src/main.rs

@@ -1,10 +1,10 @@
 #![deny(rust_2018_idioms)]
 
+use crate::env::PLAYGROUND_GITHUB_TOKEN;
 use serde::{Deserialize, Serialize};
-use snafu::Snafu;
+use snafu::prelude::*;
 use std::{
     convert::TryFrom,
-    env,
     net::SocketAddr,
     path::{Path, PathBuf},
     sync::Arc,
@@ -14,6 +14,7 @@ const DEFAULT_ADDRESS: &str = "127.0.0.1";
 const DEFAULT_PORT: u16 = 5000;
 
 mod asm_cleanup;
+mod env;
 mod gist;
 mod metrics;
 mod sandbox;
@@ -23,7 +24,10 @@ fn main() {
     // Dotenv may be unable to load environment variables, but that's ok in production
     let _ = dotenv::dotenv();
     openssl_probe::init_ssl_cert_env_vars();
-    env_logger::init();
+
+    // Enable warn-level logging by default. env_logger's default is error only.
+    let env_logger_config = env_logger::Env::default().default_filter_or("warn");
+    env_logger::Builder::from_env(env_logger_config).init();
 
     let config = Config::from_env();
     server_axum::serve(config);
@@ -32,7 +36,7 @@ fn main() {
 struct Config {
     address: String,
     cors_enabled: bool,
-    gh_token: String,
+    gh_token: Option<String>,
     metrics_token: Option<String>,
     port: u16,
     root: PathBuf,
@@ -51,8 +55,11 @@ impl Config {
             .and_then(|p| p.parse().ok())
             .unwrap_or(DEFAULT_PORT);
 
-        let gh_token =
-            env::var("PLAYGROUND_GITHUB_TOKEN").expect("Must specify PLAYGROUND_GITHUB_TOKEN");
+        let gh_token = env::var(PLAYGROUND_GITHUB_TOKEN).ok();
+        if gh_token.is_none() {
+            log::warn!("Environment variable {} is not set, so reading and writing GitHub gists will not work", PLAYGROUND_GITHUB_TOKEN);
+        }
+
         let metrics_token = env::var("PLAYGROUND_METRICS_TOKEN").ok();
 
         let cors_enabled = env::var_os("PLAYGROUND_CORS_ENABLED").is_some();
@@ -94,11 +101,18 @@ impl Config {
 }
 
 #[derive(Debug, Clone)]
-struct GhToken(Arc<String>);
+struct GhToken(Option<Arc<String>>);
 
 impl GhToken {
-    fn new(token: impl Into<String>) -> Self {
-        GhToken(Arc::new(token.into()))
+    fn new(token: &Option<String>) -> Self {
+        GhToken(token.clone().map(Arc::new))
+    }
+
+    fn must_get(&self) -> Result<String> {
+        self.0
+            .as_ref()
+            .map(|s| String::clone(s))
+            .context(NoGithubTokenSnafu)
     }
 }
 
@@ -135,6 +149,8 @@ pub enum Error {
     GistCreation { source: octocrab::Error },
     #[snafu(display("Gist loading failed: {}", source))]
     GistLoading { source: octocrab::Error },
+    #[snafu(display("{PLAYGROUND_GITHUB_TOKEN} not set up for reading/writing gists"))]
+    NoGithubToken,
     #[snafu(display("Unable to serialize response: {}", source))]
     Serialization { source: serde_json::Error },
     #[snafu(display("The value {:?} is not a valid target", value))]

ui/src/server_axum.rs

@@ -353,7 +353,7 @@ async fn meta_gist_create(
     Extension(token): Extension<GhToken>,
     Json(req): Json<MetaGistCreateRequest>,
 ) -> Result<Json<MetaGistResponse>> {
-    let token = String::clone(&token.0);
+    let token = token.must_get()?;
     gist::create_future(token, req.code)
         .await
         .map(Into::into)
@@ -365,7 +365,7 @@ async fn meta_gist_get(
     Extension(token): Extension<GhToken>,
     Path(id): Path<String>,
 ) -> Result<Json<MetaGistResponse>> {
-    let token = String::clone(&token.0);
+    let token = token.must_get()?;
     gist::load_future(token, &id)
         .await
         .map(Into::into)