vault-link/sync-server/src/server/create_document.rs

use axum::{
    Extension, Json,
    extract::{Path, State},
};
use axum_extra::TypedHeader;
use axum_typed_multipart::TypedMultipart;
use log::{debug, info};
use serde::Deserialize;

use super::{device_id_header::DeviceIdHeader, requests::CreateDocumentVersion};
use crate::{
    app_state::{
        AppState,
        database::{
            InsertBroadcast,
            models::{StoredDocumentVersion, VaultId},
        },
    },
    config::user_config::User,
    errors::{SyncServerError, client_error, server_error, write_transaction_error},
    server::{responses::DocumentUpdateResponse, update_document},
    utils::{
        find_first_available_path::find_first_available_path, is_binary::is_binary,
        is_file_type_mergable::is_file_type_mergable, normalize::normalize,
        sanitize_path::sanitize_path,
    },
};

#[derive(Deserialize)]
pub struct CreateDocumentPathParams {
    #[serde(deserialize_with = "normalize")]
    vault_id: VaultId,
}

/// Create a new document in case a document with the same doesn't exist
/// already. If a document with the same path exists, a new version is created
/// with their content merged.
///
/// Text content must be UTF-8 encoded. Clients are responsible for
/// transcoding other encodings (e.g. UTF-16) to UTF-8 before sending.
#[axum::debug_handler]
#[allow(clippy::too_many_lines)]
pub async fn create_document(
    Path(CreateDocumentPathParams { vault_id }): Path<CreateDocumentPathParams>,
    Extension(user): Extension<User>,
    TypedHeader(device_id): TypedHeader<DeviceIdHeader>,
    State(state): State<AppState>,
    TypedMultipart(request): TypedMultipart<CreateDocumentVersion>,
) -> Result<Json<DocumentUpdateResponse>, SyncServerError> {
    debug!("Creating document in vault `{vault_id}`");

    let mut transaction = state
        .database
        .create_write_transaction(&vault_id)
        .await
        .map_err(write_transaction_error)?;

    let sanitized_relative_path = sanitize_path(&request.relative_path).map_err(client_error)?;
    let new_content = request.content.contents.to_vec();

    let latest_version = state
        .database
        .get_latest_non_deleted_document_by_path(
            &vault_id,
            &sanitized_relative_path,
            Some(&mut *transaction),
        )
        .await
        .map_err(server_error)?;

    if let Some(latest_version) = latest_version {
        // Only merge with an existing document the client couldn't have
        // known about: its creation is newer than the client's last seen
        // vault update to avoid creating cycles by merging two documents into one.
        // This could happen if both clients know of document A at path P1,
        // but client 2 moves it to P2 while client 1 creates a new document at P2,
        // then client 1 would merge its new document with the moved version of A at P2
        // that client 2 resulting in two files (P1 and P2) with the same doc id (A).
        if latest_version.creation_vault_update_id > request.last_seen_vault_update_id {
            let is_mergeable_text = is_file_type_mergable(
                &sanitized_relative_path,
                &state.config.server.mergeable_file_extensions,
            ) && !is_binary(&latest_version.content)
                && !is_binary(&new_content);

            if is_mergeable_text || new_content == latest_version.content {
                return update_document::update_document(
                    &sanitized_relative_path,
                    Vec::new(),
                    vault_id,
                    latest_version.document_id,
                    &request.relative_path,
                    new_content,
                    user,
                    device_id,
                    state,
                    transaction,
                )
                .await;
            }

            // For non-mergeable (binary) files with different content, don't
            // merge, create a separate document at a deconflicted path so
            // neither client's data is silently overwritten.
        }
    }

    let document_id = uuid::Uuid::new_v4();

    let last_update_id = state
        .database
        .get_max_update_id_in_vault(&vault_id, Some(&mut *transaction))
        .await
        .map_err(server_error)?;

    let deduped_path = find_first_available_path(
        &vault_id,
        &sanitized_relative_path,
        &state.database,
        &mut transaction,
    )
    .await
    .map_err(server_error)?;

    if deduped_path != sanitized_relative_path {
        info!(
            "Document already exists at new location: `{sanitized_relative_path}` when trying to create it in vault `{vault_id}`, deconflicting by creating at `{deduped_path}`"
        );
    }

    let path_changed = deduped_path != sanitized_relative_path;

    let new_vault_update_id = last_update_id + 1;
    let new_version = StoredDocumentVersion {
        vault_update_id: new_vault_update_id,
        creation_vault_update_id: new_vault_update_id,
        document_id,
        relative_path: deduped_path,
        content: new_content,
        updated_date: chrono::Utc::now(),
        is_deleted: false,
        user_id: user.name,
        device_id: device_id.0,
        has_been_merged: false,
    };

    state
        .database
        .insert_document_version(
            &vault_id,
            &new_version,
            transaction,
            InsertBroadcast {
                // A brand-new document is always a content change for peers.
                content_changed: true,
                // Origin needs to know if the server deduped its requested path.
                path_changed,
            },
        )
        .await
        .map_err(server_error)?;

    Ok(Json(DocumentUpdateResponse::FastForwardUpdate(
        new_version.into(),
    )))
}