Spaces:
Sleeping
Sleeping
Vu Minh Chien commited on
Commit Β·
70af2a1
1
Parent(s): 8896972
Add deployment summary for HF Dataset integration
Browse files- DEPLOYMENT-SUMMARY.md +146 -0
DEPLOYMENT-SUMMARY.md
ADDED
|
@@ -0,0 +1,146 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# π― Deployment Summary: HF Dataset Integration
|
| 2 |
+
|
| 3 |
+
## β
What Changed
|
| 4 |
+
|
| 5 |
+
### π Major Update: File Storage β HF Dataset
|
| 6 |
+
|
| 7 |
+
**Before:**
|
| 8 |
+
- Used local `devices.json` file
|
| 9 |
+
- Data lost on Space restart
|
| 10 |
+
- Permission issues in Docker container
|
| 11 |
+
|
| 12 |
+
**After:**
|
| 13 |
+
- Uses **Hugging Face Dataset** for persistent storage
|
| 14 |
+
- Data survives Space restarts
|
| 15 |
+
- No file permission issues
|
| 16 |
+
- Automatic fallback to in-memory storage
|
| 17 |
+
|
| 18 |
+
## π New Files Added
|
| 19 |
+
|
| 20 |
+
1. **`hf-dataset.js`** - HF Dataset manager class
|
| 21 |
+
2. **`HF-DATASET-SETUP.md`** - Setup documentation
|
| 22 |
+
3. **`DEPLOYMENT-SUMMARY.md`** - This summary
|
| 23 |
+
|
| 24 |
+
## π§ Configuration Required
|
| 25 |
+
|
| 26 |
+
### Required Secrets in HF Space:
|
| 27 |
+
|
| 28 |
+
```
|
| 29 |
+
FIREBASE_SERVICE_ACCOUNT = {your firebase config JSON}
|
| 30 |
+
HF_TOKEN = hf_your_write_token_here
|
| 31 |
+
```
|
| 32 |
+
|
| 33 |
+
### Optional Secrets:
|
| 34 |
+
|
| 35 |
+
```
|
| 36 |
+
HF_DATASET_ID = Detomo/houzou-devices
|
| 37 |
+
```
|
| 38 |
+
|
| 39 |
+
## π How to Configure
|
| 40 |
+
|
| 41 |
+
### 1. Generate HF Token
|
| 42 |
+
1. Go to https://huggingface.co/settings/tokens
|
| 43 |
+
2. Create new token with **Write** permissions
|
| 44 |
+
3. Copy the token
|
| 45 |
+
|
| 46 |
+
### 2. Add to Space Secrets
|
| 47 |
+
1. Go to Space Settings β Secrets and variables
|
| 48 |
+
2. Add `HF_TOKEN` with your token value
|
| 49 |
+
|
| 50 |
+
### 3. Deploy
|
| 51 |
+
- Changes are already pushed
|
| 52 |
+
- Space will rebuild automatically
|
| 53 |
+
- Dataset will be created automatically
|
| 54 |
+
|
| 55 |
+
## π Features
|
| 56 |
+
|
| 57 |
+
### β
Automatic Dataset Management
|
| 58 |
+
- Creates `Detomo/houzou-devices` dataset if not exists
|
| 59 |
+
- Handles permissions automatically
|
| 60 |
+
- Stores device tokens in `devices.json`
|
| 61 |
+
|
| 62 |
+
### β
Robust Error Handling
|
| 63 |
+
- Graceful fallback to in-memory storage
|
| 64 |
+
- Detailed logging for troubleshooting
|
| 65 |
+
- Continues operation even if HF API fails
|
| 66 |
+
|
| 67 |
+
### β
Persistent Storage
|
| 68 |
+
- Device tokens survive Space restarts
|
| 69 |
+
- Automatic backup to HF dataset
|
| 70 |
+
- Version control for device data
|
| 71 |
+
|
| 72 |
+
## π Verification Steps
|
| 73 |
+
|
| 74 |
+
### 1. Check Space Status
|
| 75 |
+
```bash
|
| 76 |
+
curl https://detomo-houzou-notification-server.hf.space/
|
| 77 |
+
```
|
| 78 |
+
|
| 79 |
+
Should show:
|
| 80 |
+
```json
|
| 81 |
+
{
|
| 82 |
+
"hfDataset": {
|
| 83 |
+
"enabled": true,
|
| 84 |
+
"datasetId": "Detomo/houzou-devices",
|
| 85 |
+
"hasToken": true
|
| 86 |
+
}
|
| 87 |
+
}
|
| 88 |
+
```
|
| 89 |
+
|
| 90 |
+
### 2. Check Dataset
|
| 91 |
+
- Go to: https://huggingface.co/datasets/Detomo/houzou-devices
|
| 92 |
+
- Should see `devices.json` with your device data
|
| 93 |
+
|
| 94 |
+
### 3. Test Device Registration
|
| 95 |
+
```bash
|
| 96 |
+
curl -X POST https://detomo-houzou-notification-server.hf.space/register-token \
|
| 97 |
+
-H "Content-Type: application/json" \
|
| 98 |
+
-d '{
|
| 99 |
+
"token": "test-token",
|
| 100 |
+
"deviceId": "test-device",
|
| 101 |
+
"platform": "test"
|
| 102 |
+
}'
|
| 103 |
+
```
|
| 104 |
+
|
| 105 |
+
## π Troubleshooting
|
| 106 |
+
|
| 107 |
+
### Dataset Not Working?
|
| 108 |
+
1. Check `HF_TOKEN` is set correctly
|
| 109 |
+
2. Verify token has **Write** permissions
|
| 110 |
+
3. Check Space logs for errors
|
| 111 |
+
4. Server will fall back to in-memory storage
|
| 112 |
+
|
| 113 |
+
### Common Issues:
|
| 114 |
+
|
| 115 |
+
**403 Forbidden**: Token lacks write permissions
|
| 116 |
+
**404 Not Found**: Dataset will be auto-created
|
| 117 |
+
**Rate Limiting**: HF API limits, server will retry
|
| 118 |
+
|
| 119 |
+
## π― Benefits
|
| 120 |
+
|
| 121 |
+
- **β
Persistent**: Data survives restarts
|
| 122 |
+
- **β
Reliable**: Automatic fallback mechanisms
|
| 123 |
+
- **β
Scalable**: No file permission issues
|
| 124 |
+
- **β
Traceable**: Version history in dataset
|
| 125 |
+
- **β
Secure**: Tokens stored in HF infrastructure
|
| 126 |
+
|
| 127 |
+
## π Migration Status
|
| 128 |
+
|
| 129 |
+
- β
Code updated to use HF Dataset
|
| 130 |
+
- β
Automatic dataset creation
|
| 131 |
+
- β
Error handling implemented
|
| 132 |
+
- β
Documentation provided
|
| 133 |
+
- β
Changes deployed to Space
|
| 134 |
+
|
| 135 |
+
## π Next Steps
|
| 136 |
+
|
| 137 |
+
1. **Configure HF Token** (required)
|
| 138 |
+
2. **Verify deployment** works
|
| 139 |
+
3. **Test device registration** from Flutter app
|
| 140 |
+
4. **Monitor dataset** for device data
|
| 141 |
+
|
| 142 |
+
---
|
| 143 |
+
|
| 144 |
+
**Status: Ready for production!** π
|
| 145 |
+
|
| 146 |
+
The server now uses HF Dataset for persistent storage and will automatically handle device tokens across Space restarts.
|