buster/api/prds/active/api_chats_sharing_update.md

API Chats Sharing - Update Endpoint PRD ✅

Problem Statement

Users need the ability to update sharing permissions for chats through a REST API endpoint.

Technical Design ✅

Endpoint Specification

• Method: PUT
• Path: /chats/:id/sharing
• Description: Updates sharing permissions for a chat
• Authentication: Required
• Authorization: User must have Owner or FullAccess permission for the chat

Request Structure

// Array of recipients to share with
pub type ShareRequest = Vec<ShareRecipient>;

#[derive(Debug, Deserialize)]
pub struct ShareRecipient {
    pub email: String,
    pub role: AssetPermissionRole,
}

Response Structure

// Success response is a simple message
// Error responses include appropriate status codes and error messages

Implementation Details

New Files

1. /src/routes/rest/routes/chats/sharing/update_sharing.rs - REST handler for updating sharing permissions
2. /libs/handlers/src/chats/sharing/update_sharing_handler.rs - Business logic for updating sharing permissions

REST Handler Implementation

// update_sharing.rs
pub async fn update_chat_sharing_rest_handler(
    Extension(user): Extension<AuthenticatedUser>,
    Path(id): Path<Uuid>,
    Json(request): Json<Vec<ShareRecipient>>,
) -> Result<ApiResponse<String>, (StatusCode, String)> {
    tracing::info!("Processing PUT request for chat sharing with ID: {}, user_id: {}", id, user.id);

    // Convert request to a list of (email, role) pairs
    let emails_and_roles: Vec<(String, AssetPermissionRole)> = request
        .into_iter()
        .map(|recipient| (recipient.email, recipient.role))
        .collect();

    match update_chat_sharing_handler(&id, &user.id, emails_and_roles).await {
        Ok(_) => Ok(ApiResponse::JsonData("Sharing permissions updated successfully".to_string())),
        Err(e) => {
            tracing::error!("Error updating sharing permissions: {}", e);
            
            // Map specific errors to appropriate status codes
            let error_message = e.to_string();
            
            if error_message.contains("not found") {
                return Err((StatusCode::NOT_FOUND, format!("Chat not found: {}", e)));
            } else if error_message.contains("permission") {
                return Err((StatusCode::FORBIDDEN, format!("Insufficient permissions: {}", e)));
            } else if error_message.contains("Invalid email") {
                return Err((StatusCode::BAD_REQUEST, format!("Invalid email: {}", e)));
            }
            
            Err((StatusCode::INTERNAL_SERVER_ERROR, format!("Failed to update sharing permissions: {}", e)))
        }
    }
}

Handler Implementation

// update_sharing_handler.rs
pub async fn update_chat_sharing_handler(
    chat_id: &Uuid,
    user_id: &Uuid,
    emails_and_roles: Vec<(String, AssetPermissionRole)>,
) -> Result<()> {
    // 1. Validate the chat exists
    let chat = match get_chat_by_id(chat_id).await {
        Ok(Some(chat)) => chat,
        Ok(None) => return Err(anyhow!("Chat not found")),
        Err(e) => return Err(anyhow!("Error fetching chat: {}", e)),
    };

    // 2. Check if user has permission to update sharing for the chat (Owner or FullAccess)
    let has_permission = has_permission(
        *chat_id,
        AssetType::Chat,
        *user_id,
        IdentityType::User,
        AssetPermissionRole::FullAccess, // Owner role implicitly has FullAccess permissions
    ).await?;

    if !has_permission {
        return Err(anyhow!("User does not have permission to update sharing for this chat"));
    }

    // 3. Process each email and update sharing permissions
    for (email, role) in emails_and_roles {
        match create_share_by_email(
            &email,
            *chat_id,
            AssetType::Chat,
            role,
            *user_id,
        ).await {
            Ok(_) => {
                tracing::info!("Updated sharing permission for email: {} on chat: {} with role: {:?}", email, chat_id, role);
            },
            Err(e) => {
                tracing::error!("Failed to update sharing for email {}: {}", email, e);
                return Err(anyhow!("Failed to update sharing for email {}: {}", email, e));
            }
        }
    }

    Ok(())
}

Sharing Library Integration

This endpoint leverages the following functions from the sharing library:

1. has_permission from @[api/libs/sharing/src]/check_asset_permission.rs:

pub async fn has_permission(
    asset_id: Uuid,
    asset_type: AssetType,
    identity_id: Uuid,
    identity_type: IdentityType,
    required_role: AssetPermissionRole,
) -> Result<bool>

This function checks if a user has the required permission level for an asset. It's used to verify that the user has Owner or FullAccess permission to update sharing for the chat.

2. create_share_by_email from @[api/libs/sharing/src]/create_asset_permission.rs:

pub async fn create_share_by_email(
    email: &str,
    asset_id: Uuid,
    asset_type: AssetType,
    role: AssetPermissionRole,
    created_by: Uuid,
) -> Result<()>

This function is used for both creating and updating permissions. It performs an upsert operation in the database.

Key Differences from Create Endpoint

While the update endpoint uses the same create_share_by_email function as the create endpoint, there are some key differences in its usage:

1. The update endpoint is intended to modify existing permissions, while the create endpoint is for establishing new permissions.
2. The update endpoint uses a PUT HTTP method, following REST conventions for updates.
3. The update endpoint should be used when changing the role of an existing permission.

Error Handling

The handler will return appropriate error responses:

• 404 Not Found - If the chat doesn't exist
• 403 Forbidden - If the user doesn't have permission to update sharing for the chat
• 400 Bad Request - For invalid email addresses
• 500 Internal Server Error - For database errors or other unexpected issues

Input Validation

• Email addresses must be properly formatted (contains '@')
• The chat ID must be a valid UUID
• The role must be a valid AssetPermissionRole (ReadOnly, ReadWrite, FullAccess)

Testing Strategy

Unit Tests

• Test permission validation logic
• Test error handling for non-existent chats
• Test error handling for unauthorized users
• Test error handling for invalid emails
• Test successful sharing updates

Integration Tests

• Test PUT /chats/:id/sharing with valid ID, authorized user, and valid emails
• Test PUT /chats/:id/sharing with valid ID, unauthorized user
• Test PUT /chats/:id/sharing with non-existent chat ID
• Test PUT /chats/:id/sharing with invalid email formats
• Test PUT /chats/:id/sharing with non-existent user emails

Test Cases

1. Should update sharing permissions for valid emails with specified roles
2. Should return 403 when user doesn't have Owner or FullAccess permission
3. Should return 404 when chat doesn't exist
4. Should return 400 when email is invalid
5. Should handle gracefully when trying to update sharing for a user that doesn't have access

Performance Considerations

• For bulk updates with many emails, consider implementing a background job for processing
• Monitor database performance for large batches of update operations

Security Considerations

• Ensure that only users with Owner or FullAccess permission can update sharing
• Validate email addresses to prevent injection attacks
• Implement rate limiting to prevent abuse
• Consider implementing notifications for users whose permissions have changed

Monitoring

• Log all requests with appropriate context
• Track performance metrics for the endpoint
• Monitor error rates and types
• Track sharing update operations by user for audit purposes