Merge pull request #392 from cloudflare/alewis/feat-create-namespace

feat create namespace

Cargo.toml

@@ -13,6 +13,7 @@ build = "build.rs"
 atty = "0.2.11"
 binary-install = "0.0.3-alpha"
 clap = "2.32.0"
+cloudflare = { git = "https://github.com/cloudflare/cloudflare-rs.git" }
 config = "0.9.2"
 console = "0.7.5"
 dirs = "1.0.5"

README.md

@@ -95,6 +95,9 @@ cargo install wrangler
     wrangler preview get // this is the default
     ```
 
+  - ### 🗂️ `kv`
+    Interact with your Cloudflare Workers KV store. [Check out the docs.](./docs/content/kv)
+
 
 ## 🔩 Configuration
 

docs/content/kv_commands.md

@@ -0,0 +1,27 @@
+# 🗂️ `kv`
+
+## Overview
+
+The `kv` subcommand allows you to store application data in the Cloudflare network to be accessed from Workers. KV operations are scoped to your account, so in order to use any of these commands, you need to:
+
+* have a Wrangler project set up with your `account_id` configured in the `wrangler.toml`
+* call commands from within a Wrangler project directory.
+
+<!-- TODO: add gif of `wrangler generate` through `wrangler kv create` -->
+
+## Commands
+
+### ✨ `create <namespace-title>`
+
+Creates a new namespace.
+
+#### Usage
+
+``` sh
+$ wrangler kv create "new kv namespace"
+🌀  Creating namespace with title "new kv namespace" 🌀 
+✨  Success: WorkersKVNamespace {
+    id: "f7b02e7fc70443149ac906dd81ec1791",
+    title: "new kv namespace",
+}
+```

src/commands/kv/create_namespace.rs

@@ -0,0 +1,25 @@
+use cloudflare::apiclient::APIClient;
+
+use cloudflare::workerskv::create_namespace::CreateNamespace;
+use cloudflare::workerskv::create_namespace::CreateNamespaceParams;
+
+use crate::terminal::message;
+
+pub fn create_namespace(title: &str) -> Result<(), failure::Error> {
+    let client = super::api_client()?;
+    let account_id = super::account_id()?;
+
+    let msg = format!("Creating namespace with title \"{}\"", title);
+    message::working(&msg);
+
+    let response = client.request(&CreateNamespace {
+        account_identifier: &account_id,
+        params: CreateNamespaceParams {
+            title: title.to_string(),
+        },
+    });
+
+    super::print_response(response);
+
+    Ok(())
+}

src/commands/kv/mod.rs

@@ -0,0 +1,66 @@
+use cloudflare::auth::Credentials;
+use cloudflare::response::APIFailure;
+use cloudflare::response::APIResponse;
+use cloudflare::response::APIResult;
+use cloudflare::HTTPAPIClient;
+
+use crate::settings;
+use crate::terminal::message;
+
+mod create_namespace;
+
+pub use create_namespace::create_namespace;
+
+fn api_client() -> Result<HTTPAPIClient, failure::Error> {
+    let user = settings::global_user::GlobalUser::new()?;
+
+    Ok(HTTPAPIClient::new(Credentials::from(user)))
+}
+
+fn account_id() -> Result<String, failure::Error> {
+    let project = settings::project::Project::new()?;
+    // we need to be certain that account id is present to make kv calls
+    if project.account_id.is_empty() {
+        panic!("Your wrangler.toml is missing the account_id field which is required to create KV namespaces!");
+    }
+    Ok(project.account_id)
+}
+
+fn print_response<T: APIResult>(response: APIResponse<T>) {
+    match response {
+        Ok(success) => message::success(&format!("Success: {:#?}", success.result)),
+        Err(e) => match e {
+            APIFailure::Error(_status, errors) => {
+                for error in errors {
+                    message::warn(&format!("Error {}: {}", error.code, error.message,));
+
+                    let suggestion = help(error.code);
+                    if !suggestion.is_empty() {
+                        message::help(suggestion);
+                    }
+                }
+            }
+            APIFailure::Invalid(reqwest_err) => message::warn(&format!("Error: {}", reqwest_err)),
+        },
+    }
+}
+
+fn help(error_code: u16) -> &'static str {
+    // https://api.cloudflare.com/#workers-kv-namespace-errors
+    match error_code {
+        // namespace errors
+        10010 | 10011 | 10012 | 10013 | 10014 | 10018 => {
+            "Run `wrangler kv list` to see your existing namespaces with IDs"
+        }
+        10009 => "Run `wrangler kv list <namespaceID>` to see your existing keys", // key errors
+        // TODO: link to more info
+        // limit errors
+        10022 | 10024 | 10030 => "See documentation",
+        // TODO: link to tool for this?
+        // legacy namespace errors
+        10021 | 10035 | 10038 => "Consider moving this namespace",
+        // cloudflare account errors
+        10017 | 10026 => "Check your account settings in the Cloudflare dashboard",
+        _ => "",
+    }
+}

src/commands/mod.rs

@@ -6,6 +6,7 @@ pub mod build;
 pub mod config;
 pub mod generate;
 pub mod init;
+pub mod kv;
 pub mod publish;
 pub mod subdomain;
 pub mod whoami;

src/main.rs

@@ -21,6 +21,7 @@ mod terminal;
 use crate::settings::project::ProjectType;
 use exitfailure::ExitFailure;
 use terminal::emoji;
+use terminal::message;
 
 fn main() -> Result<(), ExitFailure> {
     env_logger::init();
@@ -45,6 +46,19 @@ fn run() -> Result<(), failure::Error> {
         .author("ashley g williams <[email protected]>")
         .setting(AppSettings::ArgRequiredElseHelp)
         .setting(AppSettings::DeriveDisplayOrder)
+        .subcommand(
+            SubCommand::with_name("kv")
+                .about(&*format!(
+                    "{} Interact with your Workers KV Store",
+                    emoji::KV
+                ))
+                .subcommand(
+                    SubCommand::with_name("create")
+                        .arg(
+                            Arg::with_name("title")
+                        )
+                )
+        )
         .subcommand(
             SubCommand::with_name("generate")
                 .about(&*format!(
@@ -233,6 +247,15 @@ fn run() -> Result<(), failure::Error> {
             .expect("The subdomain name you are requesting must be provided.");
 
         commands::subdomain(name, &user, &project)?;
+    } else if let Some(kv_matches) = matches.subcommand_matches("kv") {
+        match kv_matches.subcommand() {
+            ("create", Some(create_matches)) => {
+                let title = create_matches.value_of("title").unwrap();
+                commands::kv::create_namespace(title)?;
+            }
+            ("", None) => message::warn("kv expects a subcommand"),
+            _ => unreachable!(),
+        }
     }
     Ok(())
 }

src/settings/global_user.rs

@@ -1,6 +1,7 @@
 use std::env;
 use std::path::{Path, PathBuf};
 
+use cloudflare::auth::Credentials;
 use log::info;
 use serde::{Deserialize, Serialize};
 
@@ -19,6 +20,15 @@ impl GlobalUser {
     }
 }
 
+impl From<GlobalUser> for Credentials {
+    fn from(user: GlobalUser) -> Credentials {
+        Credentials::User {
+            key: user.api_key,
+            email: user.email,
+        }
+    }
+}
+
 fn get_global_config() -> Result<GlobalUser, failure::Error> {
     let mut s = Config::new();
 

src/terminal/emoji.rs

@@ -18,10 +18,11 @@ pub static DANCERS: Emoji = Emoji("👯 ", "");
 pub static EYES: Emoji = Emoji("👀 ", "");
 pub static INBOX: Emoji = Emoji("📥 ", "");
 pub static INFO: Emoji = Emoji("💁‍ ", "");
+pub static KV: Emoji = Emoji("🗂️ ", "");
 pub static MICROSCOPE: Emoji = Emoji("🔬 ", "");
 pub static SHEEP: Emoji = Emoji("🐑 ", "");
-pub static SLEUTH: Emoji = Emoji("🕵️‍♂️", "");
-pub static SPARKLES: Emoji = Emoji("✨  ", "");
+pub static SLEUTH: Emoji = Emoji("🕵️‍♂️ ", "");
+pub static SPARKLES: Emoji = Emoji("✨ ", "");
 pub static SWIRL: Emoji = Emoji("🌀 ", "");
 pub static UP: Emoji = Emoji("🆙 ", "");
 pub static WARN: Emoji = Emoji("⚠️ ", "");