feat(enterprise): Phase 1 - Binary download support for debuginfo/support packages (#339)

* feat(enterprise): Phase 1 - Add binary download support for debuginfo

- Add get_binary() method to REST client for downloading tar.gz files
- Update debuginfo handler with new API endpoints (cluster/debuginfo, nodes/debuginfo, etc.)
- Add deprecated binary methods for backward compatibility
- Update CLI commands to save support packages as files with --file flag
- Add default filename generation with timestamps when --file not specified
- Add progress spinners during package generation using indicatif
- Show file size and location after successful download
- Enable auto-initialization in docker-compose now that v0.5.1 is available

Part of #334 - Support package workflow
Implements #335 - Phase 1

* test: add comprehensive tests for binary debuginfo endpoints

- Add tests for all new binary download methods
- Add tests for deprecated binary endpoints for backward compatibility
- Use realistic gzip mock responses with proper headers
- Test cluster, nodes, and database-specific endpoints
- Ensure 100% test coverage for new binary functionality

* fix(enterprise): use get_binary() for debuginfo download endpoint

- Fix download() method to use get_binary() instead of get()
- The /v1/debuginfo/{id}/download endpoint returns binary tar.gz data
- Add .env.example with correct credentials for local testing
- Document proper environment variable usage

Author: joshrotenberg

.env.example

@@ -1,14 +1,14 @@
-# Docker Compose environment variables for Redis Enterprise
+# Docker environment for local development (used by docker-compose)
+REDIS_ENTERPRISE_IMAGE=kurtfm/rs-arm:latest
+REDIS_ENTERPRISE_PLATFORM=linux/arm64
 
-# Redis Enterprise Docker image
-# Default: redislabs/redis:latest
-REDIS_ENTERPRISE_IMAGE=redislabs/redis:latest
+# Redis Enterprise connection settings
+REDIS_ENTERPRISE_URL=https://localhost:9443
+REDIS_ENTERPRISE_USER=[email protected]
+REDIS_ENTERPRISE_PASSWORD=Redis123!
+REDIS_ENTERPRISE_INSECURE=true
 
-# Docker platform
-# Default: linux/amd64
-# For ARM64 (Apple Silicon): linux/arm64
-REDIS_ENTERPRISE_PLATFORM=linux/amd64
-
-# Note: For ARM64 systems (Apple Silicon Macs), you'll need to:
-# 1. Use an ARM64-compatible Redis Enterprise image
-# 2. Set REDIS_ENTERPRISE_PLATFORM=linux/arm64
+# Redis Cloud credentials (replace with your actual values)
+REDIS_CLOUD_API_KEY=your_api_key_here
+REDIS_CLOUD_API_SECRET=your_api_secret_here
+# REDIS_CLOUD_API_URL=https://api.redislabs.com/v1  # Optional, uses default if not set

.gitignore

@@ -39,3 +39,4 @@ tmp/
 
 # mdBook build output
 docs/book/
+support-package-*.tar.gz

crates/redis-enterprise/src/client.rs

@@ -110,6 +110,11 @@ impl EnterpriseClient {
         EnterpriseClientBuilder::new()
     }
 
+    /// Get a reference to the underlying client (for use with handlers)
+    pub fn client(&self) -> Arc<Client> {
+        self.client.clone()
+    }
+
     /// Normalize URL path concatenation to avoid double slashes
     fn normalize_url(&self, path: &str) -> String {
         let base = self.base_url.trim_end_matches('/');
@@ -197,6 +202,44 @@ impl EnterpriseClient {
         }
     }
 
+    /// Make a GET request for binary content (e.g., tar.gz files)
+    pub async fn get_binary(&self, path: &str) -> Result<Vec<u8>> {
+        let url = self.normalize_url(path);
+        debug!("GET {} (binary)", url);
+
+        let response = self
+            .client
+            .get(&url)
+            .basic_auth(&self.username, Some(&self.password))
+            .send()
+            .await
+            .map_err(|e| self.map_reqwest_error(e, &url))?;
+
+        trace!("Response status: {}", response.status());
+        trace!(
+            "Response content-type: {:?}",
+            response.headers().get("content-type")
+        );
+
+        if response.status().is_success() {
+            let bytes = response
+                .bytes()
+                .await
+                .map_err(crate::error::RestError::RequestFailed)?;
+            Ok(bytes.to_vec())
+        } else {
+            let status = response.status();
+            let error_text = response
+                .text()
+                .await
+                .unwrap_or_else(|_| "Unknown error".to_string());
+            Err(crate::error::RestError::ApiError {
+                code: status.as_u16(),
+                message: error_text,
+            })
+        }
+    }
+
     /// Make a POST request
     pub async fn post<B: Serialize, T: DeserializeOwned>(&self, path: &str, body: &B) -> Result<T> {
         let url = self.normalize_url(path);

crates/redis-enterprise/src/debuginfo.rs

@@ -98,7 +98,7 @@ impl DebugInfoHandler {
     /// Download debug info package
     pub async fn download(&self, task_id: &str) -> Result<Vec<u8>> {
         self.client
-            .get(&format!("/v1/debuginfo/{}/download", task_id))
+            .get_binary(&format!("/v1/debuginfo/{}/download", task_id))
             .await
     }
 
@@ -109,27 +109,97 @@ impl DebugInfoHandler {
             .await
     }
 
-    /// Get all debug info across nodes - GET /v1/debuginfo/all
+    /// Get all debug info across nodes - GET /v1/debuginfo/all (DEPRECATED)
+    /// Use cluster_debuginfo_binary() for the new endpoint
     pub async fn all(&self) -> Result<Value> {
         self.client.get("/v1/debuginfo/all").await
     }
 
-    /// Get all debug info for a specific database - GET /v1/debuginfo/all/bdb/{uid}
+    /// Get all debug info for a specific database - GET /v1/debuginfo/all/bdb/{uid} (DEPRECATED)
+    /// Use database_debuginfo_binary() for the new endpoint
     pub async fn all_bdb(&self, bdb_uid: u32) -> Result<Value> {
         self.client
             .get(&format!("/v1/debuginfo/all/bdb/{}", bdb_uid))
             .await
     }
 
-    /// Get node debug info - GET /v1/debuginfo/node
+    /// Get node debug info - GET /v1/debuginfo/node (DEPRECATED)
+    /// Use nodes_debuginfo_binary() for the new endpoint
     pub async fn node(&self) -> Result<Value> {
         self.client.get("/v1/debuginfo/node").await
     }
 
-    /// Get node debug info for a specific database - GET /v1/debuginfo/node/bdb/{uid}
+    /// Get node debug info for a specific database - GET /v1/debuginfo/node/bdb/{uid} (DEPRECATED)
+    /// Use database_debuginfo_binary() for the new endpoint
     pub async fn node_bdb(&self, bdb_uid: u32) -> Result<Value> {
         self.client
             .get(&format!("/v1/debuginfo/node/bdb/{}", bdb_uid))
             .await
     }
+
+    // New binary endpoints (current API)
+
+    /// Get cluster debug info package as binary - GET /v1/cluster/debuginfo
+    /// Returns a tar.gz file containing all cluster debug information
+    pub async fn cluster_debuginfo_binary(&self) -> Result<Vec<u8>> {
+        self.client.get_binary("/v1/cluster/debuginfo").await
+    }
+
+    /// Get all nodes debug info package as binary - GET /v1/nodes/debuginfo
+    /// Returns a tar.gz file containing debug information from all nodes
+    pub async fn nodes_debuginfo_binary(&self) -> Result<Vec<u8>> {
+        self.client.get_binary("/v1/nodes/debuginfo").await
+    }
+
+    /// Get specific node debug info package as binary - GET /v1/nodes/{uid}/debuginfo
+    /// Returns a tar.gz file containing debug information from a specific node
+    pub async fn node_debuginfo_binary(&self, node_uid: u32) -> Result<Vec<u8>> {
+        self.client
+            .get_binary(&format!("/v1/nodes/{}/debuginfo", node_uid))
+            .await
+    }
+
+    /// Get all databases debug info package as binary - GET /v1/bdbs/debuginfo
+    /// Returns a tar.gz file containing debug information from all databases
+    pub async fn databases_debuginfo_binary(&self) -> Result<Vec<u8>> {
+        self.client.get_binary("/v1/bdbs/debuginfo").await
+    }
+
+    /// Get specific database debug info package as binary - GET /v1/bdbs/{uid}/debuginfo
+    /// Returns a tar.gz file containing debug information from a specific database
+    pub async fn database_debuginfo_binary(&self, bdb_uid: u32) -> Result<Vec<u8>> {
+        self.client
+            .get_binary(&format!("/v1/bdbs/{}/debuginfo", bdb_uid))
+            .await
+    }
+
+    // Deprecated binary endpoints (for backward compatibility)
+
+    /// Get all debug info as binary - GET /v1/debuginfo/all (DEPRECATED)
+    /// Returns a tar.gz file - Use cluster_debuginfo_binary() instead
+    pub async fn all_binary(&self) -> Result<Vec<u8>> {
+        self.client.get_binary("/v1/debuginfo/all").await
+    }
+
+    /// Get all debug info for a specific database as binary - GET /v1/debuginfo/all/bdb/{uid} (DEPRECATED)
+    /// Returns a tar.gz file - Use database_debuginfo_binary() instead
+    pub async fn all_bdb_binary(&self, bdb_uid: u32) -> Result<Vec<u8>> {
+        self.client
+            .get_binary(&format!("/v1/debuginfo/all/bdb/{}", bdb_uid))
+            .await
+    }
+
+    /// Get node debug info as binary - GET /v1/debuginfo/node (DEPRECATED)
+    /// Returns a tar.gz file - Use nodes_debuginfo_binary() instead
+    pub async fn node_binary(&self) -> Result<Vec<u8>> {
+        self.client.get_binary("/v1/debuginfo/node").await
+    }
+
+    /// Get node debug info for a specific database as binary - GET /v1/debuginfo/node/bdb/{uid} (DEPRECATED)
+    /// Returns a tar.gz file - Use database_debuginfo_binary() instead
+    pub async fn node_bdb_binary(&self, bdb_uid: u32) -> Result<Vec<u8>> {
+        self.client
+            .get_binary(&format!("/v1/debuginfo/node/bdb/{}", bdb_uid))
+            .await
+    }
 }