foxhunt/docs/archive/api/API_GATEWAY_FIX_GUIDE.md

API Gateway Compilation Fix Guide

Issue: api_gateway fails to compile due to secrecy crate API changes Errors: 20 compilation errors Estimated Fix Time: 30 minutes

---

Root Cause

The secrecy crate changed its API:

• Old API: SecretString::new(String)
• New API: SecretString::new(Box<str>)

This affects the MFA/TOTP implementation in the API Gateway.

---

Files to Fix

Primary File

• services/api_gateway/src/auth/mfa/totp.rs

Error Locations

Error 1 (Line 36):

// BEFORE (broken)
secret: SecretString::new(String::new()),

// AFTER (fixed)
secret: SecretString::new(String::new().into()),

Error 2 (Line 84):

// BEFORE (broken)
Ok(SecretString::new(secret_base32))

// AFTER (fixed)
Ok(SecretString::new(secret_base32.into()))

---

Quick Fix Commands

Option 1: Manual Fix (Recommended)

1. Open the file:

   vim services/api_gateway/src/auth/mfa/totp.rs
   

2. Find and replace pattern:

   Find:    SecretString::new(
   Replace: SecretString::new(.into())
   

3. Verify all 20 instances are fixed

4. Rebuild:

   cargo build -p api_gateway
   

Option 2: Automated Fix (Fast)

# Create a sed script to fix all instances
sed -i 's/SecretString::new(\([^)]*\))/SecretString::new(\1.into())/g' \
    services/api_gateway/src/auth/mfa/totp.rs

# Rebuild
cargo build -p api_gateway

---

Expected Compilation Output (After Fix)

   Compiling api_gateway v1.0.0 (/home/jgrusewski/Work/foxhunt/services/api_gateway)
warning: unused import: std::io::Write
  --> ...

Finished dev [unoptimized + debuginfo] target(s) in 2m 15s

Success Indicators:

• ✅ No errors
• ✅ Only warnings (acceptable)
• ✅ Binary created: target/debug/api_gateway

---

Verification Tests

After fixing compilation:

Test 1: Binary Execution

target/debug/api_gateway --help

Expected: Shows help menu OR graceful database connection error

Test 2: Configuration Validation

target/debug/api_gateway --validate-config 2>&1 || true

Expected: Config validation attempt (may fail without infrastructure)

Test 3: Binary Size Check

ls -lh target/debug/api_gateway

Expected: ~250-300MB (similar to other services)

---

Alternative Approaches

If API is Fundamentally Different

If .into() doesn't work, try:

// Option 1: Box::from()
SecretString::new(Box::from(String::new()))

// Option 2: String::into_boxed_str()
SecretString::new(secret_base32.into_boxed_str())

// Option 3: Explicit Box creation
SecretString::new(Box::from(secret_base32.as_str()))

---

Dependencies Check

Verify the secrecy crate version:

grep -A2 "secrecy" services/api_gateway/Cargo.toml

Expected Output:

secrecy.workspace = true
zeroize.workspace = true

Check workspace version:

grep "secrecy" Cargo.toml

If version mismatch, update to compatible version:

secrecy = "0.10"  # or latest compatible

---

Common Pitfalls

❌ Don't Do This

// This won't compile
SecretString::new(String::new())

// This creates a double-box
SecretString::new(Box::new(String::new()))

✅ Do This

// Correct: converts String -> Box<str>
SecretString::new(String::new().into())

// Also correct: explicit conversion
SecretString::new(secret.into_boxed_str())

---

Rollback Plan

If fixes break functionality:

1. Check git history:

   git log --oneline services/api_gateway/src/auth/mfa/totp.rs
   

2. Revert to last working version:

   git checkout HEAD~1 -- services/api_gateway/src/auth/mfa/totp.rs
   

3. Downgrade secrecy crate:

   # In Cargo.toml
   secrecy = "0.9"  # or previous compatible version
   

---

Success Criteria

✅ api_gateway compiles without errors ✅ Binary created (~250-300MB) ✅ Binary executes (may show DB connection errors - that's OK) ✅ MFA/TOTP tests pass (if tests exist) ✅ All 4 services now operational

---

Additional Notes

Why This Happened

The secrecy crate updated to use Box<str> instead of String for better memory efficiency and to prevent accidental cloning of sensitive data.

Long-Term Fix

Consider creating a wrapper function:

// In a common module
fn create_secret_string(s: String) -> SecretString {
    SecretString::new(s.into())
}

// Usage
let secret = create_secret_string(secret_base32);

This centralizes the conversion and makes future API changes easier to handle.

---

Fix Priority: HIGH (blocks 1/4 services) Fix Difficulty: LOW (straightforward API adaptation) Testing Required: Minimal (compilation is the test)