cim_summary/TESTING_DEPLOYMENT_GUIDE.md

# 🧪 **Firebase Testing Environment Deployment Guide**

*Complete guide for deploying Week 8 features to Firebase testing environment*

## **📋 Prerequisites**

Before deploying to the testing environment, ensure you have:

1. **Firebase CLI installed:**
   ```bash
   npm install -g firebase-tools
   ```

2. **Firebase account logged in:**
   ```bash
   firebase login
   ```

3. **Testing project created:**
   - Go to [Firebase Console](https://console.firebase.google.com/)
   - Create new project: `cim-summarizer-testing`
   - Enable required services (Authentication, Hosting, Functions, Storage)

4. **Testing Supabase project:**
   - Go to [Supabase Dashboard](https://supabase.com/dashboard)
   - Create new project: `cim-processor-testing`
   - Note the URL and API keys

5. **Testing GCP project:**
   - Go to [Google Cloud Console](https://console.cloud.google.com/)
   - Create new project: `cim-summarizer-testing`
   - Enable Document AI API
   - Create service account and download key

## **🚀 Quick Deployment**

### **Step 1: Setup Environment**

1. **Create testing environment file:**
   ```bash
   # Copy the template
   cp TESTING_ENV_TEMPLATE.md backend/.env.testing
   
   # Edit with your testing credentials
   nano backend/.env.testing
   ```

2. **Fill in your testing credentials:**
   - Firebase testing project details
   - Supabase testing instance credentials
   - Google Cloud testing project configuration
   - LLM API keys (same as production)
   - Email configuration for testing

### **Step 2: Run Deployment Script**

```bash
# Make script executable (if not already)
chmod +x deploy-testing.sh

# Run the deployment
./deploy-testing.sh
```

## **🔧 Manual Deployment Steps**

If you prefer to deploy manually, follow these steps:

### **Step 1: Install Dependencies**

```bash
# Backend dependencies
cd backend
npm install
npm run build

# Frontend dependencies
cd ../frontend
npm install
npm run build
cd ..
```

### **Step 2: Database Setup**

```bash
cd backend

# Set testing environment
export NODE_ENV=testing

# Run migrations
npm run db:migrate

cd ..
```

### **Step 3: Deploy to Firebase**

```bash
# Switch to testing project
firebase use cim-summarizer-testing

# Deploy functions
firebase deploy --only functions

# Deploy hosting
firebase deploy --only hosting

# Deploy storage rules
firebase deploy --only storage
```

## **🧪 Testing Week 8 Features**

### **1. Cost Monitoring System**

**Test Cost Tracking:**
```bash
# Upload a document and check cost tracking
curl -X GET "https://cim-summarizer-testing.web.app/api/cost/user-metrics" \
  -H "Authorization: Bearer YOUR_TOKEN"
```

**Expected Response:**
```json
{
  "success": true,
  "metrics": {
    "user_id": "user123",
    "daily_cost": 2.50,
    "monthly_cost": 15.75,
    "total_cost": 45.20,
    "document_count": 8,
    "average_cost_per_document": 5.65
  }
}
```

### **2. Document Analysis Caching**

**Test Cache Statistics:**
```bash
curl -X GET "https://cim-summarizer-testing.web.app/api/cache/stats" \
  -H "Authorization: Bearer YOUR_TOKEN"
```

**Expected Response:**
```json
{
  "success": true,
  "stats": {
    "total_cached": 15,
    "cache_hit_rate": 0.23,
    "total_cost_saved": 45.75,
    "average_similarity_score": 0.87
  }
}
```

### **3. Microservice Health**

**Test Microservice Health:**
```bash
curl -X GET "https://cim-summarizer-testing.web.app/api/processing/health" \
  -H "Authorization: Bearer YOUR_TOKEN"
```

**Expected Response:**
```json
{
  "success": true,
  "health": {
    "status": "healthy",
    "uptime": 3600,
    "active_jobs": 2,
    "queue_size": 5,
    "memory_usage": 512000000,
    "cpu_usage": 15000000
  }
}
```

## **📊 Monitoring & Verification**

### **Firebase Console Monitoring**

1. **Functions Logs:**
   ```bash
   firebase functions:log --project cim-summarizer-testing
   ```

2. **Hosting Analytics:**
   - Visit: https://console.firebase.google.com/project/cim-summarizer-testing/hosting
   - Check usage and performance metrics

3. **Authentication:**
   - Visit: https://console.firebase.google.com/project/cim-summarizer-testing/authentication
   - Monitor user sign-ups and activity

### **Supabase Dashboard**

1. **Database Tables:**
   - Check new tables: `cost_transactions`, `cost_alerts`, `document_analysis_cache`
   - Verify data is being populated

2. **Real-time Logs:**
   - Monitor database activity and performance

### **Cost Monitoring Dashboard**

1. **User Cost Metrics:**
   - Visit: https://cim-summarizer-testing.web.app/api/cost/user-metrics
   - Monitor real-time cost tracking

2. **System Cost Metrics:**
   - Visit: https://cim-summarizer-testing.web.app/api/cost/system-metrics
   - Check overall system costs

## **🔍 Troubleshooting**

### **Common Issues**

1. **Environment Configuration:**
   ```bash
   # Check if testing environment is loaded
   cd backend
   node -e "console.log(process.env.NODE_ENV)"
   ```

2. **Database Connection:**
   ```bash
   # Test database connection
   cd backend
   npm run db:test
   ```

3. **Firebase Functions:**
   ```bash
   # Check function logs
   firebase functions:log --project cim-summarizer-testing --only api
   ```

4. **Authentication Issues:**
   ```bash
   # Verify Firebase Auth configuration
   firebase auth:export --project cim-summarizer-testing
   ```

### **Debug Mode**

Enable debug logging for testing:

```bash
# Set debug environment
export LOG_LEVEL=debug
export AGENTIC_RAG_DETAILED_LOGGING=true

# Restart functions
firebase functions:restart --project cim-summarizer-testing
```

## **📈 Performance Testing**

### **Load Testing**

1. **Upload Multiple Documents:**
   ```bash
   # Test concurrent uploads
   for i in {1..10}; do
     curl -X POST "https://cim-summarizer-testing.web.app/documents/upload" \
       -F "file=@test-document-$i.pdf" \
       -H "Authorization: Bearer YOUR_TOKEN" &
   done
   ```

2. **Monitor Cache Performance:**
   - Upload similar documents and check cache hit rates
   - Monitor processing speed improvements

3. **Cost Optimization Testing:**
   - Upload documents and monitor cost tracking
   - Verify cost alerts are triggered appropriately

## **🔄 Rollback Plan**

If issues arise, you can rollback:

```bash
# Rollback to previous version
firebase functions:rollback --project cim-summarizer-testing

# Or redeploy specific functions
firebase deploy --only functions:api --project cim-summarizer-testing
```

## **✅ Success Criteria**

Deployment is successful when:

1. **✅ All endpoints respond correctly**
2. **✅ Cost monitoring tracks expenses**
3. **✅ Caching system improves performance**
4. **✅ Microservice handles jobs properly**
5. **✅ Database migrations completed**
6. **✅ No critical errors in logs**
7. **✅ Authentication works correctly**
8. **✅ File uploads process successfully**

## **📞 Support**

If you encounter issues:

1. **Check logs:** `firebase functions:log --project cim-summarizer-testing`
2. **Review configuration:** Verify `.env.testing` settings
3. **Test locally:** `firebase emulators:start --project cim-summarizer-testing`
4. **Check documentation:** Review `FIREBASE_TESTING_ENVIRONMENT_SETUP.md`

---

**🎉 Ready to deploy! Run `./deploy-testing.sh` to get started.**