refactor: fold redis-common into redisctl and fix docs.rs

joshrotenberg · joshrotenberg · commit 4143f0b82870 · 2025-08-27T17:11:02.000-07:00
- Move redis-common modules (config, error, output) into redisctl/src
- Update all imports from redis_common:: to crate::
- Add lib.rs to redisctl with documentation for docs.rs
- Mark redis-common as publish=false since it's internal only
- Remove redis-common from workspace members
- Add dependencies from redis-common to redisctl Cargo.toml

This fixes the docs.rs issue where redisctl showed "not a library" and
simplifies the workspace structure since redis-common was only used by
the CLI, not the library crates.
diff --git a/Cargo.toml b/Cargo.toml
@@ -2,8 +2,7 @@
 resolver = "2"
 members = [
     "crates/redis-cloud",
-    "crates/redis-enterprise", 
-    "crates/redis-common",
+    "crates/redis-enterprise",
     "crates/redisctl",
 ]
 
@@ -59,7 +58,6 @@ pretty_assertions = "1.4"
 # Internal crates
 redis-cloud = { path = "crates/redis-cloud" }
 redis-enterprise = { path = "crates/redis-enterprise" }
-redis-common = { path = "crates/redis-common" }
 
 [profile.release]
 opt-level = 3
diff --git a/crates/redis-common/Cargo.toml b/crates/redis-common/Cargo.toml
@@ -9,6 +9,7 @@ homepage.workspace = true
 description = "Shared utilities for Redis CLI tools"
 keywords = ["redis", "cli", "common", "utilities"]
 categories = ["command-line-utilities", "api-bindings"]
+publish = false
 
 [dependencies]
 anyhow = { workspace = true }
diff --git a/crates/redisctl/Cargo.toml b/crates/redisctl/Cargo.toml
@@ -26,7 +26,6 @@ path = "src/enterprise_bin.rs"
 required-features = ["enterprise-only"]
 
 [dependencies]
-redis-common = { version = "0.1.0", path = "../redis-common" }
 redis-cloud = { version = "0.1.0", path = "../redis-cloud" }
 redis-enterprise = { version = "0.1.0", path = "../redis-enterprise" }
 
@@ -42,6 +41,15 @@ chrono = "0.4"
 rpassword = { workspace = true }
 urlencoding = "2.1"
 
+# Dependencies from redis-common
+thiserror = { workspace = true }
+serde_yaml = { workspace = true }
+comfy-table = { workspace = true }
+jmespath = { workspace = true }
+config = { workspace = true }
+toml = { workspace = true }
+directories = { workspace = true }
+
 # Conditional dependencies for feature-gated binaries
 [features]
 default = ["full"]
diff --git a/crates/redisctl/src/cli.rs b/crates/redisctl/src/cli.rs
@@ -1,6 +1,7 @@
 use crate::commands::api::ApiCommands;
+use crate::config::DeploymentType;
+use crate::output::OutputFormat;
 use clap::{Parser, Subcommand};
-use redis_common::{DeploymentType, OutputFormat};
 
 #[derive(Parser)]
 #[command(name = "redisctl")]
diff --git a/crates/redisctl/src/cloud_bin.rs b/crates/redisctl/src/cloud_bin.rs
@@ -1,13 +1,16 @@
 // Redis Cloud only binary
 // This binary only includes Cloud functionality to reduce size for Cloud-only deployments
 
+use crate::config::{Config, DeploymentType};
 use anyhow::Result;
 use clap::Parser;
-use redis_common::{Config, DeploymentType};
 use tracing::info;
 
 mod cli;
 mod commands;
+mod config;
+mod error;
+mod output;
 
 use cli::{Cli, Commands};
 use commands::{cloud, profile};
@@ -53,7 +56,7 @@ async fn main() -> Result<()> {
 fn get_cloud_profile<'a>(
     config: &'a Config,
     profile_name: &Option<String>,
-) -> Result<&'a redis_common::Profile> {
+) -> Result<&'a crate::config::Profile> {
     let env_profile = std::env::var("REDISCTL_PROFILE").ok();
     let profile_name = profile_name
         .as_deref()
diff --git a/crates/redisctl/src/commands/api.rs b/crates/redisctl/src/commands/api.rs
@@ -2,10 +2,10 @@
 
 #![allow(dead_code)]
 
+use crate::output::{OutputFormat, print_output};
 use anyhow::{Context, Result};
 use clap::Subcommand;
 use redis_cloud::CloudClient;
-use redis_common::{OutputFormat, print_output};
 use redis_enterprise::EnterpriseClient;
 use serde_json::Value;
 use std::fs;
diff --git a/crates/redisctl/src/commands/cloud.rs b/crates/redisctl/src/commands/cloud.rs
@@ -1,6 +1,7 @@
+use crate::config::{Profile, ProfileCredentials};
+use crate::output::{OutputFormat, print_output};
 use anyhow::Result;
 use redis_cloud::CloudClient;
-use redis_common::{OutputFormat, Profile, ProfileCredentials, print_output};
 
 use crate::cli::{
     AccountCommands, AclCommands, ApiKeyCommands, BackupCommands, CloudAccountCommands,
diff --git a/crates/redisctl/src/commands/cloud_billing.rs b/crates/redisctl/src/commands/cloud_billing.rs
@@ -1,6 +1,6 @@
+use crate::output::{OutputFormat, print_output};
 use anyhow::Result;
 use redis_cloud::{CloudBillingHandler, CloudClient};
-use redis_common::{OutputFormat, print_output};
 
 use crate::cli::BillingCommands;
 
diff --git a/crates/redisctl/src/commands/enterprise.rs b/crates/redisctl/src/commands/enterprise.rs
@@ -1,5 +1,6 @@
+use crate::config::{Profile, ProfileCredentials};
+use crate::output::{OutputFormat, print_output};
 use anyhow::Result;
-use redis_common::{OutputFormat, Profile, ProfileCredentials, print_output};
 use redis_enterprise::EnterpriseClient;
 use std::io::Write;
 
diff --git a/crates/redisctl/src/commands/profile.rs b/crates/redisctl/src/commands/profile.rs
@@ -1,7 +1,6 @@
+use crate::config::{Config, DeploymentType, Profile, ProfileCredentials};
+use crate::output::{OutputFormat, print_output};
 use anyhow::Result;
-use redis_common::{
-    Config, DeploymentType, OutputFormat, Profile, ProfileCredentials, print_output,
-};
 
 use crate::cli::ProfileCommands;
 
diff --git a/crates/redisctl/src/config.rs b/crates/redisctl/src/config.rs
@@ -0,0 +1,123 @@
+#![allow(dead_code)]
+
+use anyhow::{Context, Result};
+use directories::ProjectDirs;
+use serde::{Deserialize, Serialize};
+use std::collections::HashMap;
+use std::fs;
+use std::path::PathBuf;
+
+#[derive(Debug, Serialize, Deserialize, Default, Clone)]
+pub struct Config {
+    #[serde(default)]
+    pub default: Option<String>, // Name of the default profile
+    #[serde(default)]
+    pub profiles: HashMap<String, Profile>,
+}
+
+#[derive(Debug, Serialize, Deserialize, Clone)]
+pub struct Profile {
+    pub deployment_type: DeploymentType,
+    #[serde(flatten)]
+    pub credentials: ProfileCredentials,
+}
+
+#[derive(Debug, Serialize, Deserialize, Clone, Copy, PartialEq, clap::ValueEnum)]
+pub enum DeploymentType {
+    Cloud,
+    Enterprise,
+}
+
+#[derive(Debug, Serialize, Deserialize, Clone)]
+#[serde(untagged)]
+pub enum ProfileCredentials {
+    Cloud {
+        api_key: String,
+        api_secret: String,
+        #[serde(default = "default_cloud_url")]
+        api_url: String,
+    },
+    Enterprise {
+        url: String,
+        username: String,
+        password: Option<String>, // Optional for prompting
+        #[serde(default)]
+        insecure: bool,
+    },
+}
+
+fn default_cloud_url() -> String {
+    "https://api.redislabs.com/v1".to_string()
+}
+
+impl ProfileCredentials {
+    pub fn has_password(&self) -> bool {
+        match self {
+            ProfileCredentials::Enterprise { password, .. } => password.is_some(),
+            _ => false,
+        }
+    }
+}
+
+impl Config {
+    pub fn load() -> Result<Self> {
+        let config_path = Self::config_path()?;
+
+        if !config_path.exists() {
+            return Ok(Config::default());
+        }
+
+        let content = fs::read_to_string(&config_path)
+            .with_context(|| format!("Failed to read config from {:?}", config_path))?;
+
+        toml::from_str(&content)
+            .with_context(|| format!("Failed to parse config from {:?}", config_path))
+    }
+
+    pub fn save(&self) -> Result<()> {
+        let config_path = Self::config_path()?;
+
+        // Create parent directories if they don't exist
+        if let Some(parent) = config_path.parent() {
+            fs::create_dir_all(parent)
+                .with_context(|| format!("Failed to create config directory {:?}", parent))?;
+        }
+
+        let content = toml::to_string_pretty(self).context("Failed to serialize config")?;
+
+        fs::write(&config_path, content)
+            .with_context(|| format!("Failed to write config to {:?}", config_path))?;
+
+        Ok(())
+    }
+
+    pub fn get_profile(&self, name: Option<&str>) -> Option<&Profile> {
+        let env_profile = std::env::var("REDISCTL_PROFILE").ok();
+        let profile_name = name
+            .or(self.default.as_deref())
+            .or(env_profile.as_deref())?;
+
+        self.profiles.get(profile_name)
+    }
+
+    pub fn set_profile(&mut self, name: String, profile: Profile) {
+        self.profiles.insert(name, profile);
+    }
+
+    pub fn remove_profile(&mut self, name: &str) -> Option<Profile> {
+        self.profiles.remove(name)
+    }
+
+    pub fn list_profiles(&self) -> Vec<(&String, &Profile)> {
+        let mut profiles: Vec<_> = self.profiles.iter().collect();
+        profiles.sort_by_key(|(name, _)| *name);
+        profiles
+    }
+
+    fn config_path() -> Result<PathBuf> {
+        let proj_dirs = ProjectDirs::from("com", "redis", "redisctl")
+            .context("Failed to determine config directory")?;
+
+        Ok(proj_dirs.config_dir().join("config.toml"))
+    }
+}
diff --git a/crates/redisctl/src/enterprise_bin.rs b/crates/redisctl/src/enterprise_bin.rs
@@ -1,13 +1,16 @@
 // Redis Enterprise only binary
 // This binary only includes Enterprise functionality to reduce size for Enterprise-only deployments
 
+use crate::config::{Config, DeploymentType};
 use anyhow::Result;
 use clap::Parser;
-use redis_common::{Config, DeploymentType};
 use tracing::info;
 
 mod cli;
 mod commands;
+mod config;
+mod error;
+mod output;
 
 use cli::{Cli, Commands};
 use commands::{enterprise, profile};
@@ -62,7 +65,7 @@ async fn main() -> Result<()> {
 fn get_enterprise_profile<'a>(
     config: &'a Config,
     profile_name: &Option<String>,
-) -> Result<&'a redis_common::Profile> {
+) -> Result<&'a crate::config::Profile> {
     let env_profile = std::env::var("REDISCTL_PROFILE").ok();
     let profile_name = profile_name
         .as_deref()
diff --git a/crates/redisctl/src/error.rs b/crates/redisctl/src/error.rs
@@ -0,0 +1,59 @@
+#![allow(dead_code)]
+
+use thiserror::Error;
+
+#[derive(Error, Debug)]
+pub enum RedisCtlError {
+    #[error("Configuration error: {0}")]
+    Config(#[from] ConfigError),
+
+    #[error("Profile error: {0}")]
+    Profile(#[from] ProfileError),
+
+    #[error("Command routing error: {0}")]
+    Routing(#[from] RoutingError),
+}
+
+#[derive(Error, Debug)]
+pub enum ConfigError {
+    #[error("Profile '{name}' not found")]
+    ProfileNotFound { name: String },
+
+    #[error("No default profile set")]
+    NoDefaultProfile,
+
+    #[error("Config file error: {message}")]
+    FileError { message: String },
+}
+
+#[derive(Error, Debug)]
+pub enum ProfileError {
+    #[error("Profile '{name}' is type '{actual_type}' but command requires '{expected_type}'")]
+    TypeMismatch {
+        name: String,
+        actual_type: String,
+        expected_type: String,
+    },
+
+    #[error("Missing credentials for profile '{name}'")]
+    MissingCredentials { name: String },
+}
+
+#[derive(Error, Debug)]
+pub enum RoutingError {
+    #[error(
+        "Command '{command}' exists in both cloud and enterprise. Use 'redisctl cloud {command}' or 'redisctl enterprise {command}'"
+    )]
+    AmbiguousCommand { command: String },
+
+    #[error("Command '{command}' not found in {deployment_type}")]
+    CommandNotFound {
+        command: String,
+        deployment_type: String,
+    },
+
+    #[error(
+        "No profile specified and no default profile set. Use --profile or set REDISCTL_PROFILE"
+    )]
+    NoProfileSpecified,
+}
diff --git a/crates/redisctl/src/lib.rs b/crates/redisctl/src/lib.rs
diff --git a/crates/redisctl/src/main.rs b/crates/redisctl/src/main.rs
diff --git a/crates/redisctl/src/output.rs b/crates/redisctl/src/output.rs
diff --git a/crates/redisctl/src/router.rs b/crates/redisctl/src/router.rs
