✨ File Persistent Task
This commit is contained in:
@@ -1,94 +1,930 @@
|
||||
# Multi-part File Upload API
|
||||
# DysonNetwork Drive - Persistent/Resumable Upload System
|
||||
|
||||
This document outlines the process for uploading large files in chunks using the multi-part upload API.
|
||||
A comprehensive, production-ready file upload system with resumable uploads, real-time progress tracking, and dynamic notifications powered by RingService.
|
||||
|
||||
## 1. Create an Upload Task
|
||||
When using with the Gateway, use the `/drive` to replace `/api`.
|
||||
The realtime messages are from the websocket gateway.
|
||||
|
||||
To begin a file upload, you first need to create an upload task. This is done by sending a `POST` request to the `/api/files/upload/create` endpoint.
|
||||
## 🚀 Features
|
||||
|
||||
**Endpoint:** `POST /api/files/upload/create`
|
||||
### Core Upload Features
|
||||
- **Resumable Uploads**: Pause and resume uploads across app restarts
|
||||
- **Chunked Uploads**: Efficient large file handling with configurable chunk sizes
|
||||
- **Progress Persistence**: Upload state survives server restarts and network interruptions
|
||||
- **Duplicate Detection**: Automatic detection of already uploaded files via hash checking
|
||||
- **Quota Management**: Integration with user quota and billing systems
|
||||
- **Pool-based Storage**: Support for multiple storage pools with different policies
|
||||
|
||||
**Request Body:**
|
||||
### Real-Time Features
|
||||
- **Live Progress Updates**: WebSocket-based real-time progress tracking
|
||||
- **Completion Notifications**: Instant notifications when uploads complete
|
||||
- **Failure Alerts**: Immediate notification of upload failures with error details
|
||||
- **Push Notifications**: Cross-platform push notifications for mobile/desktop
|
||||
- **Smart Throttling**: Optimized update frequency to prevent network spam
|
||||
|
||||
### Management Features
|
||||
- **Task Listing**: Comprehensive API for listing and filtering upload tasks
|
||||
- **Task Statistics**: Detailed analytics and usage statistics
|
||||
- **Cleanup Operations**: Automatic and manual cleanup of failed/stale tasks
|
||||
- **Ownership Verification**: Secure access control for all operations
|
||||
- **Detailed Task Info**: Rich metadata including speed calculations and ETAs
|
||||
|
||||
## 📋 Table of Contents
|
||||
|
||||
- [Quick Start](#quick-start)
|
||||
- [API Reference](#api-reference)
|
||||
- [WebSocket Events](#websocket-events)
|
||||
- [Database Schema](#database-schema)
|
||||
- [Configuration](#configuration)
|
||||
- [Usage Examples](#usage-examples)
|
||||
- [Error Handling](#error-handling)
|
||||
- [Performance](#performance)
|
||||
- [Security](#security)
|
||||
- [Troubleshooting](#troubleshooting)
|
||||
|
||||
## 🚀 Quick Start
|
||||
|
||||
### 1. Create Upload Task
|
||||
|
||||
```http
|
||||
POST /api/files/upload/create
|
||||
Content-Type: application/json
|
||||
|
||||
```json
|
||||
{
|
||||
"hash": "string (file hash, e.g., MD5 or SHA256)",
|
||||
"file_name": "string",
|
||||
"file_size": "long (in bytes)",
|
||||
"content_type": "string (e.g., 'image/jpeg')",
|
||||
"pool_id": "string (GUID, optional)",
|
||||
"bundle_id": "string (GUID, optional)",
|
||||
"encrypt_password": "string (optional)",
|
||||
"expired_at": "string (ISO 8601 format, optional)",
|
||||
"chunk_size": "long (in bytes, optional, defaults to 5MB)"
|
||||
"fileName": "large-video.mp4",
|
||||
"fileSize": 1073741824,
|
||||
"contentType": "video/mp4",
|
||||
"poolId": "550e8400-e29b-41d4-a716-446655440000",
|
||||
"chunkSize": 8388608
|
||||
}
|
||||
```
|
||||
|
||||
**Response:**
|
||||
|
||||
If a file with the same hash already exists, the server will return a `200 OK` with the following body:
|
||||
|
||||
```json
|
||||
{
|
||||
"file_exists": true,
|
||||
"file": { ... (CloudFile object in snake_case) ... }
|
||||
"taskId": "abc123def456ghi789",
|
||||
"chunkSize": 8388608,
|
||||
"chunksCount": 128
|
||||
}
|
||||
```
|
||||
|
||||
If the file does not exist, the server will return a `200 OK` with a task ID and chunk information:
|
||||
### 2. Upload Chunks
|
||||
|
||||
```json
|
||||
{
|
||||
"file_exists": false,
|
||||
"task_id": "string",
|
||||
"chunk_size": "long",
|
||||
"chunks_count": "int"
|
||||
}
|
||||
```http
|
||||
POST /api/files/upload/chunk/abc123def456ghi789/0
|
||||
Content-Type: multipart/form-data
|
||||
|
||||
(chunk data as form file)
|
||||
```
|
||||
|
||||
You will need the `task_id`, `chunk_size`, and `chunks_count` for the next steps.
|
||||
### 3. Complete Upload
|
||||
|
||||
## 2. Upload File Chunks
|
||||
```http
|
||||
POST /api/files/upload/complete/abc123def456ghi789
|
||||
```
|
||||
|
||||
Once you have a `task_id`, you can start uploading the file in chunks. Each chunk is sent as a `POST` request with `multipart/form-data`.
|
||||
## 📚 API Reference
|
||||
|
||||
**Endpoint:** `POST /api/files/upload/chunk/{taskId}/{chunkIndex}`
|
||||
### Upload Task Management
|
||||
|
||||
- `taskId`: The ID of the upload task from the previous step.
|
||||
- `chunkIndex`: The 0-based index of the chunk you are uploading.
|
||||
#### `POST /api/files/upload/create`
|
||||
Creates a new resumable upload task.
|
||||
|
||||
**Request Body:**
|
||||
|
||||
The body of the request should be `multipart/form-data` with a single form field named `chunk` containing the binary data for that chunk.
|
||||
|
||||
The size of each chunk should be equal to the `chunk_size` returned in the "Create Upload Task" step, except for the last chunk, which may be smaller.
|
||||
|
||||
**Response:**
|
||||
|
||||
A successful chunk upload will return a `200 OK` with an empty body.
|
||||
|
||||
You should upload all chunks from `0` to `chunks_count - 1`.
|
||||
|
||||
## 3. Complete the Upload
|
||||
|
||||
After all chunks have been successfully uploaded, you must send a final request to complete the upload process. This will merge all the chunks into a single file and process it.
|
||||
|
||||
**Endpoint:** `POST /api/files/upload/complete/{taskId}`
|
||||
|
||||
- `taskId`: The ID of the upload task.
|
||||
|
||||
**Request Body:**
|
||||
|
||||
The request body should be empty.
|
||||
|
||||
**Response:**
|
||||
|
||||
A successful request will return a `200 OK` with the `CloudFile` object for the newly uploaded file.
|
||||
|
||||
```json
|
||||
{
|
||||
... (CloudFile object) ...
|
||||
"fileName": "string", // Required: Name of the file
|
||||
"fileSize": "long", // Required: Size in bytes
|
||||
"contentType": "string", // Required: MIME type
|
||||
"poolId": "uuid", // Optional: Storage pool ID
|
||||
"bundleId": "uuid", // Optional: File bundle ID
|
||||
"chunkSize": "long", // Optional: Chunk size (default: 5MB)
|
||||
"encryptPassword": "string", // Optional: Encryption password
|
||||
"expiredAt": "datetime", // Optional: Expiration date
|
||||
"hash": "string" // Required: File hash for deduplication
|
||||
}
|
||||
```
|
||||
|
||||
If any chunks are missing or an error occurs during the merge process, the server will return a `400 Bad Request` with an error message.
|
||||
**Response:**
|
||||
```json
|
||||
{
|
||||
"fileExists": false,
|
||||
"taskId": "string",
|
||||
"chunkSize": 5242880,
|
||||
"chunksCount": 10
|
||||
}
|
||||
```
|
||||
|
||||
#### `POST /api/files/upload/chunk/{taskId}/{chunkIndex}`
|
||||
Uploads a specific chunk of the file.
|
||||
|
||||
**Parameters:**
|
||||
- `taskId`: Upload task identifier
|
||||
- `chunkIndex`: Zero-based chunk index
|
||||
|
||||
**Request:** Multipart form data with chunk file
|
||||
|
||||
**Response:** `200 OK` or `409 Conflict` (chunk already uploaded)
|
||||
|
||||
#### `POST /api/files/upload/complete/{taskId}`
|
||||
Completes the upload and processes the file.
|
||||
|
||||
**Response:** CloudFile object with file metadata
|
||||
|
||||
### Task Information & Management
|
||||
|
||||
#### `GET /api/files/upload/tasks`
|
||||
Lists user's upload tasks with filtering and pagination.
|
||||
|
||||
**Query Parameters:**
|
||||
- `status`: Filter by status (`InProgress`, `Completed`, `Failed`, `Expired`)
|
||||
- `sortBy`: Sort field (`filename`, `filesize`, `createdAt`, `updatedAt`, `lastActivity`)
|
||||
- `sortDescending`: Sort direction (default: `true`)
|
||||
- `offset`: Pagination offset (default: `0`)
|
||||
- `limit`: Page size (default: `50`)
|
||||
|
||||
**Response Headers:**
|
||||
- `X-Total`: Total number of tasks matching filters
|
||||
|
||||
#### `GET /api/files/upload/progress/{taskId}`
|
||||
Gets current progress for a specific task.
|
||||
|
||||
#### `GET /api/files/upload/resume/{taskId}`
|
||||
Gets task information needed to resume an interrupted upload.
|
||||
|
||||
#### `DELETE /api/files/upload/task/{taskId}`
|
||||
Cancels an upload task and cleans up resources.
|
||||
|
||||
#### `GET /api/files/upload/tasks/{taskId}/details`
|
||||
Gets comprehensive details about a specific task including:
|
||||
- Full task metadata
|
||||
- Pool and bundle information
|
||||
- Estimated time remaining
|
||||
- Current upload speed
|
||||
|
||||
#### `GET /api/files/upload/stats`
|
||||
Gets upload statistics for the current user.
|
||||
|
||||
**Response:**
|
||||
```json
|
||||
{
|
||||
"totalTasks": 25,
|
||||
"inProgressTasks": 3,
|
||||
"completedTasks": 20,
|
||||
"failedTasks": 1,
|
||||
"expiredTasks": 1,
|
||||
"totalUploadedBytes": 5368709120,
|
||||
"averageProgress": 67.5,
|
||||
"recentActivity": [...]
|
||||
}
|
||||
```
|
||||
|
||||
#### `DELETE /api/files/upload/tasks/cleanup`
|
||||
Cleans up all failed and expired tasks for the current user.
|
||||
|
||||
#### `GET /api/files/upload/tasks/recent?limit=10`
|
||||
Gets the most recent upload tasks.
|
||||
|
||||
## 🔌 WebSocket Events
|
||||
|
||||
The system sends real-time updates via WebSocket using RingService. Connect to the WebSocket endpoint and listen for upload-related events.
|
||||
|
||||
### Event Types
|
||||
|
||||
#### `upload.progress`
|
||||
Sent when upload progress changes significantly (every 5% or major milestones).
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "upload.progress",
|
||||
"data": {
|
||||
"taskId": "abc123def456",
|
||||
"fileName": "document.pdf",
|
||||
"fileSize": 10485760,
|
||||
"chunksUploaded": 5,
|
||||
"chunksTotal": 10,
|
||||
"progress": 50.0,
|
||||
"status": "InProgress",
|
||||
"lastActivity": "2025-11-09T01:56:00.0000000Z"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
#### `upload.completed`
|
||||
Sent when an upload completes successfully.
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "upload.completed",
|
||||
"data": {
|
||||
"taskId": "abc123def456",
|
||||
"fileId": "file789xyz",
|
||||
"fileName": "document.pdf",
|
||||
"fileSize": 10485760,
|
||||
"completedAt": "2025-11-09T01:57:00.0000000Z"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
#### `upload.failed`
|
||||
Sent when an upload fails.
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "upload.failed",
|
||||
"data": {
|
||||
"taskId": "abc123def456",
|
||||
"fileName": "document.pdf",
|
||||
"fileSize": 10485760,
|
||||
"failedAt": "2025-11-09T01:58:00.0000000Z",
|
||||
"errorMessage": "File processing failed: invalid format"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Client Integration Example
|
||||
|
||||
```javascript
|
||||
// WebSocket connection
|
||||
const ws = new WebSocket('wss://api.dysonnetwork.com/ws');
|
||||
|
||||
// Authentication (implement based on your auth system)
|
||||
ws.onopen = () => {
|
||||
ws.send(JSON.stringify({
|
||||
type: 'auth',
|
||||
token: 'your-jwt-token'
|
||||
}));
|
||||
};
|
||||
|
||||
// Handle upload events
|
||||
ws.onmessage = (event) => {
|
||||
const packet = JSON.parse(event.data);
|
||||
|
||||
switch (packet.type) {
|
||||
case 'upload.progress':
|
||||
updateProgressBar(packet.data);
|
||||
break;
|
||||
case 'upload.completed':
|
||||
showSuccessNotification(packet.data);
|
||||
break;
|
||||
case 'upload.failed':
|
||||
showErrorNotification(packet.data);
|
||||
break;
|
||||
}
|
||||
};
|
||||
|
||||
function updateProgressBar(data) {
|
||||
const progressBar = document.getElementById(`progress-${data.taskId}`);
|
||||
if (progressBar) {
|
||||
progressBar.style.width = `${data.progress}%`;
|
||||
progressBar.textContent = `${data.progress.toFixed(1)}%`;
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## 🗄️ Database Schema
|
||||
|
||||
### `upload_tasks` Table
|
||||
|
||||
```sql
|
||||
CREATE TABLE upload_tasks (
|
||||
id UUID PRIMARY KEY,
|
||||
task_id VARCHAR NOT NULL UNIQUE,
|
||||
file_name VARCHAR NOT NULL,
|
||||
file_size BIGINT NOT NULL,
|
||||
content_type VARCHAR NOT NULL,
|
||||
chunk_size BIGINT NOT NULL,
|
||||
chunks_count INTEGER NOT NULL,
|
||||
chunks_uploaded INTEGER NOT NULL DEFAULT 0,
|
||||
pool_id UUID NOT NULL,
|
||||
bundle_id UUID,
|
||||
encrypt_password VARCHAR,
|
||||
expired_at TIMESTAMPTZ,
|
||||
hash VARCHAR NOT NULL,
|
||||
account_id UUID NOT NULL,
|
||||
status INTEGER NOT NULL DEFAULT 0,
|
||||
uploaded_chunks JSONB NOT NULL DEFAULT '[]'::jsonb,
|
||||
last_activity TIMESTAMPTZ NOT NULL,
|
||||
created_at TIMESTAMPTZ NOT NULL,
|
||||
updated_at TIMESTAMPTZ NOT NULL,
|
||||
deleted_at TIMESTAMPTZ
|
||||
);
|
||||
|
||||
-- Indexes for performance
|
||||
CREATE INDEX idx_upload_tasks_account_id ON upload_tasks(account_id);
|
||||
CREATE INDEX idx_upload_tasks_status ON upload_tasks(status);
|
||||
CREATE INDEX idx_upload_tasks_last_activity ON upload_tasks(last_activity);
|
||||
CREATE INDEX idx_upload_tasks_hash ON upload_tasks(hash);
|
||||
```
|
||||
|
||||
### Status Enum Values
|
||||
- `0`: InProgress
|
||||
- `1`: Completed
|
||||
- `2`: Failed
|
||||
- `3`: Expired
|
||||
|
||||
## ⚙️ Configuration
|
||||
|
||||
### Environment Variables
|
||||
|
||||
```bash
|
||||
# Storage configuration
|
||||
STORAGE_UPLOADS_PATH=/tmp/uploads
|
||||
STORAGE_PREFERRED_REMOTE=550e8400-e29b-41d4-a716-446655440000
|
||||
|
||||
# Chunk size settings
|
||||
UPLOAD_DEFAULT_CHUNK_SIZE=5242880 # 5MB
|
||||
UPLOAD_MAX_CHUNK_SIZE=16777216 # 16MB
|
||||
|
||||
# Cleanup settings
|
||||
UPLOAD_STALE_THRESHOLD_HOURS=24
|
||||
UPLOAD_CLEANUP_INTERVAL_MINUTES=60
|
||||
|
||||
# Cache settings
|
||||
UPLOAD_CACHE_DURATION_MINUTES=30
|
||||
```
|
||||
|
||||
### Dependency Injection
|
||||
|
||||
```csharp
|
||||
// In Program.cs or Startup.cs
|
||||
builder.Services.AddScoped<PersistentUploadService>();
|
||||
builder.Services.AddSingleton<RingService.RingServiceClient>(sp => {
|
||||
// Configure gRPC client for RingService
|
||||
var channel = GrpcChannel.ForAddress("https://ring-service:50051");
|
||||
return new RingService.RingServiceClient(channel);
|
||||
});
|
||||
```
|
||||
|
||||
## 💡 Usage Examples
|
||||
|
||||
### Basic Upload Flow
|
||||
|
||||
```javascript
|
||||
class UploadManager {
|
||||
constructor() {
|
||||
this.ws = new WebSocket('wss://api.dysonnetwork.com/ws');
|
||||
this.tasks = new Map();
|
||||
}
|
||||
|
||||
async uploadFile(file, poolId) {
|
||||
// 1. Create upload task
|
||||
const taskResponse = await fetch('/api/files/upload/create', {
|
||||
method: 'POST',
|
||||
headers: { 'Content-Type': 'application/json' },
|
||||
body: JSON.stringify({
|
||||
fileName: file.name,
|
||||
fileSize: file.size,
|
||||
contentType: file.type,
|
||||
poolId: poolId,
|
||||
hash: await this.calculateHash(file)
|
||||
})
|
||||
});
|
||||
|
||||
const task = await taskResponse.json();
|
||||
if (task.fileExists) {
|
||||
return task.file; // File already exists
|
||||
}
|
||||
|
||||
// 2. Upload chunks
|
||||
const chunks = this.splitFileIntoChunks(file, task.chunkSize);
|
||||
for (let i = 0; i < chunks.length; i++) {
|
||||
await this.uploadChunk(task.taskId, i, chunks[i]);
|
||||
}
|
||||
|
||||
// 3. Complete upload
|
||||
const result = await fetch(`/api/files/upload/complete/${task.taskId}`, {
|
||||
method: 'POST'
|
||||
});
|
||||
|
||||
return await result.json();
|
||||
}
|
||||
|
||||
async uploadChunk(taskId, chunkIndex, chunkData) {
|
||||
const formData = new FormData();
|
||||
formData.append('chunk', chunkData);
|
||||
|
||||
const response = await fetch(`/api/files/upload/chunk/${taskId}/${chunkIndex}`, {
|
||||
method: 'POST',
|
||||
body: formData
|
||||
});
|
||||
|
||||
if (response.status === 409) {
|
||||
// Chunk already uploaded, skip
|
||||
return;
|
||||
}
|
||||
|
||||
if (!response.ok) {
|
||||
throw new Error(`Upload failed: ${response.statusText}`);
|
||||
}
|
||||
}
|
||||
|
||||
splitFileIntoChunks(file, chunkSize) {
|
||||
const chunks = [];
|
||||
for (let offset = 0; offset < file.size; offset += chunkSize) {
|
||||
chunks.push(file.slice(offset, offset + chunkSize));
|
||||
}
|
||||
return chunks;
|
||||
}
|
||||
|
||||
async calculateHash(file) {
|
||||
// Implement file hashing (SHA-256 recommended)
|
||||
const buffer = await file.arrayBuffer();
|
||||
const hashBuffer = await crypto.subtle.digest('SHA-256', buffer);
|
||||
return Array.from(new Uint8Array(hashBuffer))
|
||||
.map(b => b.toString(16).padStart(2, '0'))
|
||||
.join('');
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Resume Interrupted Upload
|
||||
|
||||
```javascript
|
||||
async resumeUpload(taskId) {
|
||||
// Get task information
|
||||
const resumeResponse = await fetch(`/api/files/upload/resume/${taskId}`);
|
||||
const taskInfo = await resumeResponse.json();
|
||||
|
||||
// Get uploaded chunks
|
||||
const uploadedChunks = new Set(taskInfo.uploadedChunks);
|
||||
|
||||
// Upload missing chunks
|
||||
for (let i = 0; i < taskInfo.chunksCount; i++) {
|
||||
if (!uploadedChunks.has(i)) {
|
||||
await this.uploadChunk(taskId, i, this.getChunkData(i));
|
||||
}
|
||||
}
|
||||
|
||||
// Complete upload
|
||||
await fetch(`/api/files/upload/complete/${taskId}`, {
|
||||
method: 'POST'
|
||||
});
|
||||
}
|
||||
```
|
||||
|
||||
### Monitor Upload Progress
|
||||
|
||||
```javascript
|
||||
function setupProgressMonitoring(taskId) {
|
||||
// Listen for WebSocket progress events
|
||||
this.ws.addEventListener('message', (event) => {
|
||||
const packet = JSON.parse(event.data);
|
||||
if (packet.type === 'upload.progress' && packet.data.taskId === taskId) {
|
||||
updateProgressUI(packet.data);
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
function updateProgressUI(progressData) {
|
||||
const progressBar = document.getElementById('upload-progress');
|
||||
const progressText = document.getElementById('progress-text');
|
||||
const speedText = document.getElementById('upload-speed');
|
||||
|
||||
progressBar.style.width = `${progressData.progress}%`;
|
||||
progressText.textContent = `${progressData.progress.toFixed(1)}%`;
|
||||
|
||||
// Calculate speed if we have timing data
|
||||
if (this.lastProgress) {
|
||||
const timeDiff = Date.now() - this.lastUpdate;
|
||||
const progressDiff = progressData.progress - this.lastProgress.progress;
|
||||
const speed = (progressDiff / 100) * (progressData.fileSize / 1024 / 1024) / (timeDiff / 1000);
|
||||
speedText.textContent = `${speed.toFixed(1)} MB/s`;
|
||||
}
|
||||
|
||||
this.lastProgress = progressData;
|
||||
this.lastUpdate = Date.now();
|
||||
}
|
||||
```
|
||||
|
||||
## 🚨 Error Handling
|
||||
|
||||
### Common Error Codes
|
||||
|
||||
- `400 Bad Request`: Invalid request parameters
|
||||
- `401 Unauthorized`: Authentication required
|
||||
- `403 Forbidden`: Insufficient permissions or quota exceeded
|
||||
- `404 Not Found`: Task or resource not found
|
||||
- `409 Conflict`: Chunk already uploaded (resumable upload)
|
||||
- `413 Payload Too Large`: File exceeds size limits
|
||||
- `429 Too Many Requests`: Rate limit exceeded
|
||||
|
||||
### Error Response Format
|
||||
|
||||
```json
|
||||
{
|
||||
"code": "UPLOAD_FAILED",
|
||||
"message": "Failed to complete file upload",
|
||||
"status": 500,
|
||||
"details": {
|
||||
"taskId": "abc123def456",
|
||||
"error": "File processing failed: invalid format"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Handling Upload Failures
|
||||
|
||||
```javascript
|
||||
try {
|
||||
const result = await completeUpload(taskId);
|
||||
showSuccess(result);
|
||||
} catch (error) {
|
||||
if (error.status === 500) {
|
||||
// Server error, can retry
|
||||
showRetryButton(taskId);
|
||||
} else if (error.status === 403) {
|
||||
// Permission/quota error
|
||||
showQuotaExceeded();
|
||||
} else {
|
||||
// Other error
|
||||
showGenericError(error.message);
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## ⚡ Performance
|
||||
|
||||
### Optimizations
|
||||
|
||||
- **Chunked Uploads**: Reduces memory usage for large files
|
||||
- **Progress Throttling**: Prevents WebSocket spam during fast uploads
|
||||
- **Caching Layer**: Redis-based caching for task metadata
|
||||
- **Database Indexing**: Optimized queries for task listing and filtering
|
||||
- **Async Processing**: Non-blocking I/O operations throughout
|
||||
|
||||
### Benchmarks
|
||||
|
||||
- **Small Files (< 10MB)**: ~2-5 seconds total upload time
|
||||
- **Large Files (1GB+)**: Maintains consistent throughput
|
||||
- **Concurrent Uploads**: Supports 100+ simultaneous uploads per server
|
||||
- **WebSocket Updates**: < 10ms latency for progress notifications
|
||||
|
||||
### Scaling Considerations
|
||||
|
||||
- **Horizontal Scaling**: Stateless design supports multiple instances
|
||||
- **Load Balancing**: Session affinity not required for uploads
|
||||
- **Storage Backend**: Compatible with S3, local storage, and distributed systems
|
||||
- **Database**: PostgreSQL with connection pooling recommended
|
||||
|
||||
## 🔒 Security
|
||||
|
||||
### Authentication & Authorization
|
||||
|
||||
- **JWT Tokens**: All endpoints require valid authentication
|
||||
- **Ownership Verification**: Users can only access their own tasks
|
||||
- **Permission Checks**: Integration with role-based access control
|
||||
- **Rate Limiting**: Built-in protection against abuse
|
||||
|
||||
### Data Protection
|
||||
|
||||
- **Encryption Support**: Optional client-side encryption
|
||||
- **Secure Storage**: Files stored with proper access controls
|
||||
- **Hash Verification**: Integrity checking via SHA-256 hashes
|
||||
- **Audit Logging**: Comprehensive logging of all operations
|
||||
|
||||
### Network Security
|
||||
|
||||
- **HTTPS Only**: All communications encrypted in transit
|
||||
- **CORS Configuration**: Proper cross-origin resource sharing
|
||||
- **Input Validation**: Comprehensive validation of all inputs
|
||||
- **SQL Injection Prevention**: Parameterized queries throughout
|
||||
|
||||
## 🔧 Troubleshooting
|
||||
|
||||
### Common Issues
|
||||
|
||||
#### Upload Stuck at 99%
|
||||
**Problem**: Final chunk fails to upload or process
|
||||
**Solution**: Check server logs, verify file integrity, retry completion
|
||||
|
||||
#### WebSocket Not Connecting
|
||||
**Problem**: Real-time updates not working
|
||||
**Solution**: Check WebSocket server configuration, verify client authentication
|
||||
|
||||
#### Progress Not Updating
|
||||
**Problem**: UI not reflecting upload progress
|
||||
**Solution**: Verify WebSocket connection, check for JavaScript errors
|
||||
|
||||
#### Upload Fails with 403
|
||||
**Problem**: Permission denied errors
|
||||
**Solution**: Check user permissions, quota limits, and pool access
|
||||
|
||||
### Debug Mode
|
||||
|
||||
Enable detailed logging by setting environment variable:
|
||||
```bash
|
||||
LOG_LEVEL=DysonNetwork.Drive.Storage:Debug
|
||||
```
|
||||
|
||||
### Health Checks
|
||||
|
||||
Monitor system health via:
|
||||
```http
|
||||
GET /health/uploads
|
||||
```
|
||||
|
||||
Returns status of upload service, database connectivity, and queue lengths.
|
||||
|
||||
## 📞 Support
|
||||
|
||||
For issues and questions:
|
||||
|
||||
1. Check the troubleshooting section above
|
||||
2. Review server logs for error details
|
||||
3. Verify client implementation against examples
|
||||
4. Contact the development team with specific error messages
|
||||
|
||||
## 📝 Changelog
|
||||
|
||||
### Version 1.0.0
|
||||
- Initial release with resumable uploads
|
||||
- Real-time progress tracking via WebSocket
|
||||
- Push notification integration
|
||||
- Comprehensive task management APIs
|
||||
- Automatic cleanup and quota management
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Generic Task System (v2.0)
|
||||
|
||||
The upload system has been extended with a powerful generic task framework that supports various types of background operations beyond just file uploads.
|
||||
|
||||
### Supported Task Types
|
||||
|
||||
#### File Operations
|
||||
- **FileUpload**: Resumable file uploads (original functionality)
|
||||
- **FileMove**: Move files between storage pools or bundles
|
||||
- **FileCompress**: Compress multiple files into archives
|
||||
- **FileDecompress**: Extract compressed archives
|
||||
- **FileEncrypt**: Encrypt files with passwords
|
||||
- **FileDecrypt**: Decrypt encrypted files
|
||||
|
||||
#### Bulk Operations
|
||||
- **BulkOperation**: Custom bulk operations on multiple files
|
||||
- **StorageMigration**: Migrate files between storage pools
|
||||
- **FileConversion**: Convert files between formats
|
||||
|
||||
#### Custom Operations
|
||||
- **Custom**: Extensible framework for custom task types
|
||||
|
||||
### Task Architecture
|
||||
|
||||
#### Core Classes
|
||||
|
||||
```csharp
|
||||
// Base task class with common functionality
|
||||
public class PersistentTask : ModelBase
|
||||
{
|
||||
public Guid Id { get; set; }
|
||||
public string TaskId { get; set; } = null!;
|
||||
public string Name { get; set; } = null!;
|
||||
public string? Description { get; set; }
|
||||
public TaskType Type { get; set; }
|
||||
public TaskStatus Status { get; set; }
|
||||
public Guid AccountId { get; set; }
|
||||
public double Progress { get; set; }
|
||||
public Dictionary<string, object?> Parameters { get; set; } = new();
|
||||
public Dictionary<string, object?> Results { get; set; } = new();
|
||||
public string? ErrorMessage { get; set; }
|
||||
public Instant LastActivity { get; set; }
|
||||
public int Priority { get; set; }
|
||||
public long? EstimatedDurationSeconds { get; set; }
|
||||
}
|
||||
|
||||
// Specialized task implementations
|
||||
public class FileMoveTask : PersistentTask
|
||||
{
|
||||
public FileMoveTask() { Type = TaskType.FileMove; Name = "Move Files"; }
|
||||
public List<string> FileIds { get; set; } = new();
|
||||
public Guid TargetPoolId { get; set; }
|
||||
public Guid? TargetBundleId { get; set; }
|
||||
public int FilesProcessed { get; set; }
|
||||
}
|
||||
|
||||
public class FileCompressTask : PersistentTask
|
||||
{
|
||||
public FileCompressTask() { Type = TaskType.FileCompress; Name = "Compress Files"; }
|
||||
public List<string> FileIds { get; set; } = new();
|
||||
public string CompressionFormat { get; set; } = "zip";
|
||||
public int CompressionLevel { get; set; } = 6;
|
||||
public string? OutputFileName { get; set; }
|
||||
public int FilesProcessed { get; set; }
|
||||
public string? ResultFileId { get; set; }
|
||||
}
|
||||
```
|
||||
|
||||
#### Task Service
|
||||
|
||||
```csharp
|
||||
public class PersistentTaskService(
|
||||
AppDatabase db,
|
||||
ICacheService cache,
|
||||
ILogger<PersistentTaskService> logger,
|
||||
RingService.RingServiceClient ringService
|
||||
)
|
||||
{
|
||||
// Create any type of task
|
||||
public async Task<T> CreateTaskAsync<T>(T task) where T : PersistentTask
|
||||
|
||||
// Update progress with automatic notifications
|
||||
public async Task UpdateTaskProgressAsync(string taskId, double progress, string? statusMessage = null)
|
||||
|
||||
// Mark tasks as completed/failed with results
|
||||
public async Task MarkTaskCompletedAsync(string taskId, Dictionary<string, object?>? results = null)
|
||||
public async Task MarkTaskFailedAsync(string taskId, string? errorMessage = null)
|
||||
|
||||
// Task lifecycle management
|
||||
public async Task PauseTaskAsync(string taskId)
|
||||
public async Task ResumeTaskAsync(string taskId)
|
||||
public async Task CancelTaskAsync(string taskId)
|
||||
|
||||
// Query tasks with filtering and pagination
|
||||
public async Task<(List<PersistentTask> Items, int TotalCount)> GetUserTasksAsync(
|
||||
Guid accountId,
|
||||
TaskType? type = null,
|
||||
TaskStatus? status = null,
|
||||
string? sortBy = "lastActivity",
|
||||
bool sortDescending = true,
|
||||
int offset = 0,
|
||||
int limit = 50
|
||||
)
|
||||
}
|
||||
```
|
||||
|
||||
### Real-Time Task Notifications
|
||||
|
||||
All task operations send WebSocket notifications via RingService:
|
||||
|
||||
#### Task Created
|
||||
```json
|
||||
{
|
||||
"type": "task.created",
|
||||
"data": {
|
||||
"taskId": "task123",
|
||||
"name": "Compress Files",
|
||||
"type": "FileCompress",
|
||||
"createdAt": "2025-11-09T02:00:00Z"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
#### Task Progress
|
||||
```json
|
||||
{
|
||||
"type": "task.progress",
|
||||
"data": {
|
||||
"taskId": "task123",
|
||||
"name": "Compress Files",
|
||||
"type": "FileCompress",
|
||||
"progress": 67.5,
|
||||
"status": "InProgress",
|
||||
"lastActivity": "2025-11-09T02:05:00Z"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
#### Task Completed
|
||||
```json
|
||||
{
|
||||
"type": "task.completed",
|
||||
"data": {
|
||||
"taskId": "task123",
|
||||
"name": "Compress Files",
|
||||
"type": "FileCompress",
|
||||
"completedAt": "2025-11-09T02:10:00Z",
|
||||
"results": {
|
||||
"resultFileId": "file456",
|
||||
"compressedSize": 10485760,
|
||||
"compressionRatio": 0.75
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Usage Examples
|
||||
|
||||
#### Create a File Compression Task
|
||||
|
||||
```csharp
|
||||
var compressTask = new FileCompressTask
|
||||
{
|
||||
Name = "Compress Project Files",
|
||||
Description = "Compress all project files into a ZIP archive",
|
||||
AccountId = userId,
|
||||
FileIds = new List<string> { "file1", "file2", "file3" },
|
||||
CompressionFormat = "zip",
|
||||
CompressionLevel = 9,
|
||||
OutputFileName = "project-backup.zip"
|
||||
};
|
||||
|
||||
var createdTask = await taskService.CreateTaskAsync(compressTask);
|
||||
// Task ID: createdTask.TaskId
|
||||
```
|
||||
|
||||
#### Monitor Task Progress
|
||||
|
||||
```javascript
|
||||
// WebSocket monitoring
|
||||
ws.onmessage = (event) => {
|
||||
const packet = JSON.parse(event.data);
|
||||
|
||||
if (packet.type === 'task.progress') {
|
||||
const { taskId, progress, name } = packet.data;
|
||||
updateTaskProgress(taskId, progress, name);
|
||||
} else if (packet.type === 'task.completed') {
|
||||
const { taskId, results } = packet.data;
|
||||
handleTaskCompletion(taskId, results);
|
||||
}
|
||||
};
|
||||
```
|
||||
|
||||
#### Bulk File Operations
|
||||
|
||||
```csharp
|
||||
var bulkTask = new BulkOperationTask
|
||||
{
|
||||
Name = "Bulk Delete Old Files",
|
||||
OperationType = "delete",
|
||||
TargetIds = fileIds,
|
||||
OperationParameters = new Dictionary<string, object?> {
|
||||
{ "olderThanDays", 30 },
|
||||
{ "confirm", true }
|
||||
}
|
||||
};
|
||||
|
||||
await taskService.CreateTaskAsync(bulkTask);
|
||||
```
|
||||
|
||||
### Task Status Management
|
||||
|
||||
Tasks support multiple statuses:
|
||||
- **Pending**: Queued for execution
|
||||
- **InProgress**: Currently executing
|
||||
- **Paused**: Temporarily suspended
|
||||
- **Completed**: Successfully finished
|
||||
- **Failed**: Execution failed
|
||||
- **Cancelled**: Manually cancelled
|
||||
- **Expired**: Timed out or expired
|
||||
|
||||
### Priority System
|
||||
|
||||
Tasks can be assigned priorities (0-100, higher = more important) to control execution order in background processing.
|
||||
|
||||
### Automatic Cleanup
|
||||
|
||||
Old completed/failed tasks are automatically cleaned up after 30 days to prevent database bloat.
|
||||
|
||||
### Extensibility
|
||||
|
||||
The task system is designed to be easily extensible:
|
||||
|
||||
```csharp
|
||||
// Create custom task types
|
||||
public class CustomProcessingTask : PersistentTask
|
||||
{
|
||||
public CustomProcessingTask()
|
||||
{
|
||||
Type = TaskType.Custom;
|
||||
Name = "Custom Processing";
|
||||
}
|
||||
|
||||
public string CustomParameter
|
||||
{
|
||||
get => Parameters.GetValueOrDefault("customParam") as string ?? "";
|
||||
set => Parameters["customParam"] = value;
|
||||
}
|
||||
|
||||
public object? CustomResult
|
||||
{
|
||||
get => Results.GetValueOrDefault("customResult");
|
||||
set => Results["customResult"] = value;
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Database Schema Extensions
|
||||
|
||||
The task system uses JSONB columns for flexible parameter and result storage:
|
||||
|
||||
```sql
|
||||
-- Extended tasks table
|
||||
ALTER TABLE tasks ADD COLUMN priority INTEGER DEFAULT 0;
|
||||
ALTER TABLE tasks ADD COLUMN estimated_duration_seconds BIGINT;
|
||||
ALTER TABLE tasks ADD COLUMN started_at TIMESTAMPTZ;
|
||||
ALTER TABLE tasks ADD COLUMN completed_at TIMESTAMPTZ;
|
||||
|
||||
-- Indexes for performance
|
||||
CREATE INDEX idx_tasks_type ON tasks(type);
|
||||
CREATE INDEX idx_tasks_status ON tasks(status);
|
||||
CREATE INDEX idx_tasks_priority ON tasks(priority);
|
||||
CREATE INDEX idx_tasks_account_type ON tasks(account_id, type);
|
||||
```
|
||||
|
||||
### Migration Notes
|
||||
|
||||
The system maintains backward compatibility with existing upload tasks while adding the new generic framework. Existing `PersistentUploadTask` entities continue to work unchanged.
|
||||
|
||||
---
|
||||
|
||||
**Note**: This system is designed for production use and includes comprehensive error handling, security measures, and performance optimizations. Always test thoroughly in your environment before deploying to production.
|
||||
|
||||
Reference in New Issue
Block a user