gg
Browse files- DEPLOYMENT_VERIFICATION_CHECKLIST.md +165 -0
- backend/app.py +1 -1
DEPLOYMENT_VERIFICATION_CHECKLIST.md
ADDED
|
@@ -0,0 +1,165 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Deployment Verification Checklist
|
| 2 |
+
|
| 3 |
+
## Authentication Fix for Hugging Face Spaces
|
| 4 |
+
|
| 5 |
+
This checklist will help you verify that the authentication fixes work correctly in your Hugging Face Space deployment.
|
| 6 |
+
|
| 7 |
+
### β
Pre-Deployment Checks
|
| 8 |
+
|
| 9 |
+
#### 1. Frontend Configuration
|
| 10 |
+
- [ ] `.env.production` file has correct API URL: `https://zelyanoth-lin-cbfcff2.hf.space/api`
|
| 11 |
+
- [ ] `VITE_NODE_ENV=production` is set in `.env.production`
|
| 12 |
+
- [ ] Frontend has been built with `npm run build`
|
| 13 |
+
- [ ] `dist/` folder exists and contains built files
|
| 14 |
+
|
| 15 |
+
#### 2. Backend Configuration
|
| 16 |
+
- [ ] `backend/app.py` imports `request` from Flask
|
| 17 |
+
- [ ] CORS origins include `https://zelyanoth-lin-cbfcff2.hf.space`
|
| 18 |
+
- [ ] Cookie service uses `sameSite: 'Lax'` for production
|
| 19 |
+
- [ ] JWT secret key is properly configured
|
| 20 |
+
|
| 21 |
+
#### 3. Cookie Security Settings
|
| 22 |
+
- [ ] Production cookies use `sameSite: 'Lax'` (not 'Strict')
|
| 23 |
+
- [ ] Production cookies use `secure: true`
|
| 24 |
+
- [ ] All cookies have `httpOnly: true`
|
| 25 |
+
- [ ] CORS allows credentials (`supports_credentials: true`)
|
| 26 |
+
|
| 27 |
+
### β
Deployment Steps
|
| 28 |
+
|
| 29 |
+
#### 1. Build Frontend
|
| 30 |
+
```bash
|
| 31 |
+
cd frontend
|
| 32 |
+
npm run build
|
| 33 |
+
cd ..
|
| 34 |
+
```
|
| 35 |
+
|
| 36 |
+
#### 2. Commit Changes
|
| 37 |
+
```bash
|
| 38 |
+
git add .
|
| 39 |
+
git commit -m "fix: authentication fixes for Hugging Face Spaces deployment"
|
| 40 |
+
git push origin main
|
| 41 |
+
```
|
| 42 |
+
|
| 43 |
+
#### 3. Monitor Hugging Face Build
|
| 44 |
+
- [ ] Check build logs in Hugging Face Space dashboard
|
| 45 |
+
- [ ] Verify no errors during build process
|
| 46 |
+
- [ ] Confirm deployment completes successfully
|
| 47 |
+
|
| 48 |
+
### β
Post-Deployment Testing
|
| 49 |
+
|
| 50 |
+
#### 1. Basic Functionality Tests
|
| 51 |
+
- [ ] Application loads at `https://zelyanoth-lin-cbfcff2.hf.space`
|
| 52 |
+
- [ ] Health check endpoint works: `https://zelyanoth-lin-cbfcff2.hf.space/health`
|
| 53 |
+
- [ ] API health check works: `https://zelyanoth-lin-cbfcff2.hf.space/api/health`
|
| 54 |
+
|
| 55 |
+
#### 2. Authentication Flow Tests
|
| 56 |
+
- [ ] **Login Page**: Access `/login` page
|
| 57 |
+
- [ ] **Login Attempt**: Try to login with valid credentials
|
| 58 |
+
- [ ] **Login Success**: Verify successful login redirects to dashboard
|
| 59 |
+
- [ ] **Cookie Storage**: Check that cookies are set (use browser dev tools)
|
| 60 |
+
- [ ] **Page Reload**: Refresh the page while logged in
|
| 61 |
+
- [ ] **Session Persistence**: Verify you remain logged in after reload
|
| 62 |
+
- [ ] **Protected Routes**: Access `/dashboard`, `/accounts`, etc. while logged in
|
| 63 |
+
- [ ] **Logout**: Test logout functionality
|
| 64 |
+
- [ ] **Post-Logout**: Verify redirect to login page after logout
|
| 65 |
+
|
| 66 |
+
#### 3. Cookie Security Verification
|
| 67 |
+
- [ ] **Cookie Attributes**: Check browser cookies for:
|
| 68 |
+
- `SameSite=Lax` (production setting)
|
| 69 |
+
- `Secure` flag (for HTTPS)
|
| 70 |
+
- `HttpOnly` flag (prevents JavaScript access)
|
| 71 |
+
- [ ] **Cross-Origin Requests**: Verify CORS headers are present in API responses
|
| 72 |
+
- [ ] **Token Validation**: JWT tokens are properly validated on server side
|
| 73 |
+
|
| 74 |
+
#### 4. Error Handling Tests
|
| 75 |
+
- [ ] **Invalid Credentials**: Try login with wrong password
|
| 76 |
+
- [ ] **Expired Token**: Wait for token to expire (1 hour) and test reload
|
| 77 |
+
- [ ] **Network Issues**: Test with network disabled then reconnected
|
| 78 |
+
- [ ] **Browser Cache**: Clear browser cache and test authentication
|
| 79 |
+
|
| 80 |
+
#### 5. Browser Compatibility
|
| 81 |
+
- [ ] **Chrome**: Test all functionality
|
| 82 |
+
- [ ] **Firefox**: Test all functionality
|
| 83 |
+
- [ ] **Safari**: Test all functionality
|
| 84 |
+
- [ ] **Mobile Chrome**: Test on mobile device
|
| 85 |
+
- [ ] **Mobile Safari**: Test on mobile device
|
| 86 |
+
|
| 87 |
+
### β
Monitoring and Logging
|
| 88 |
+
|
| 89 |
+
#### 1. Browser Console
|
| 90 |
+
- [ ] No JavaScript errors on page load
|
| 91 |
+
- [ ] API requests show correct status codes
|
| 92 |
+
- [ ] Authentication requests show proper headers
|
| 93 |
+
|
| 94 |
+
#### 2. Network Tab
|
| 95 |
+
- [ ] API requests include Authorization header when logged in
|
| 96 |
+
- [ ] CORS requests show correct `Access-Control-Allow-*` headers
|
| 97 |
+
- [ ] No failed authentication requests
|
| 98 |
+
|
| 99 |
+
#### 3. Server Logs (Hugging Face Dashboard)
|
| 100 |
+
- [ ] No Flask application errors
|
| 101 |
+
- [ ] Successful health checks
|
| 102 |
+
- [ ] Authentication requests logged properly
|
| 103 |
+
- [ ] CORS headers applied correctly
|
| 104 |
+
|
| 105 |
+
### β
Performance Tests
|
| 106 |
+
|
| 107 |
+
#### 1. Load Time
|
| 108 |
+
- [ ] Page loads within 3 seconds
|
| 109 |
+
- [ ] API responses under 1 second
|
| 110 |
+
- [ ] Login process completes within 2 seconds
|
| 111 |
+
|
| 112 |
+
#### 2. Resource Usage
|
| 113 |
+
- [ ] Memory usage is reasonable
|
| 114 |
+
- [ ] No memory leaks detected
|
| 115 |
+
- [ ] CPU usage normal for traffic level
|
| 116 |
+
|
| 117 |
+
### β
Security Verification
|
| 118 |
+
|
| 119 |
+
#### 1. Cookie Security
|
| 120 |
+
- [ ] No sensitive data in localStorage (should use cookies only)
|
| 121 |
+
- [ ] CSRF protection working (via SameSite policy)
|
| 122 |
+
- [ ] XSS protection (HttpOnly cookies)
|
| 123 |
+
|
| 124 |
+
#### 2. API Security
|
| 125 |
+
- [ ] Unauthenticated requests to protected routes return 401
|
| 126 |
+
- [ ] JWT tokens properly validated
|
| 127 |
+
- [ ] No exposed sensitive data in API responses
|
| 128 |
+
|
| 129 |
+
### π¨ Troubleshooting Guide
|
| 130 |
+
|
| 131 |
+
#### Common Issues and Solutions
|
| 132 |
+
|
| 133 |
+
**Issue: "NameError: name 'request' is not defined"**
|
| 134 |
+
- β
Fixed: Added `from flask import request` to `backend/app.py`
|
| 135 |
+
|
| 136 |
+
**Issue: Authentication fails after page reload**
|
| 137 |
+
- β
Fixed: Changed cookie `sameSite` from 'Strict' to 'Lax' for production
|
| 138 |
+
- β
Fixed: Updated API client to use production URL
|
| 139 |
+
|
| 140 |
+
**Issue: CORS errors in browser console**
|
| 141 |
+
- β
Fixed: Added Hugging Face Space URL to CORS origins
|
| 142 |
+
- β
Fixed: Ensured CORS headers include necessary fields
|
| 143 |
+
|
| 144 |
+
**Issue: Cookies not being set**
|
| 145 |
+
- β
Verify: `secure` flag matches HTTPS environment
|
| 146 |
+
- β
Verify: `sameSite` policy is appropriate for deployment
|
| 147 |
+
- β
Verify: CORS allows credentials
|
| 148 |
+
|
| 149 |
+
### π Final Verification
|
| 150 |
+
|
| 151 |
+
#### Success Criteria
|
| 152 |
+
- [ ] User can login successfully
|
| 153 |
+
- [ ] User remains logged in after page reload
|
| 154 |
+
- [ ] Protected routes are accessible only when authenticated
|
| 155 |
+
- [ ] Logout functionality works correctly
|
| 156 |
+
- [ ] No console errors or warnings
|
| 157 |
+
- [ ] All security headers are present
|
| 158 |
+
- [ ] Application works across different browsers
|
| 159 |
+
|
| 160 |
+
#### Deployment Complete When:
|
| 161 |
+
All checkboxes above are marked as complete β
|
| 162 |
+
|
| 163 |
+
---
|
| 164 |
+
|
| 165 |
+
**Note**: If any test fails, refer to the troubleshooting guide above and ensure all fixes have been applied before redeploying.
|
backend/app.py
CHANGED
|
@@ -1,7 +1,7 @@
|
|
| 1 |
import os
|
| 2 |
import sys
|
| 3 |
import locale
|
| 4 |
-
from flask import Flask, send_from_directory
|
| 5 |
from flask_cors import CORS
|
| 6 |
from flask_jwt_extended import JWTManager
|
| 7 |
# Import for job handling
|
|
|
|
| 1 |
import os
|
| 2 |
import sys
|
| 3 |
import locale
|
| 4 |
+
from flask import Flask, send_from_directory, request
|
| 5 |
from flask_cors import CORS
|
| 6 |
from flask_jwt_extended import JWTManager
|
| 7 |
# Import for job handling
|