File size: 18,209 Bytes
d90101d | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 | use std::path::PathBuf;
use std::sync::Arc;
use anyhow::{Context, Result};
use forge_app::{FileReaderInfra, SyncProgressCounter, WorkspaceStatus, compute_hash};
use forge_domain::{ApiKey, FileHash, SyncProgress, UserId, WorkspaceId, WorkspaceIndexRepository};
use futures::FutureExt;
use futures::stream::{Stream, StreamExt};
use tracing::{info, warn};
use crate::fd::{FileDiscovery, discover_sync_file_paths};
/// Error type for a single file that could not be read during workspace
/// operations, carrying the file path for downstream reporting.
#[derive(Debug, thiserror::Error)]
#[error("Failed to read file '{path}': {source}")]
struct FileReadError {
path: PathBuf,
#[source]
source: anyhow::Error,
}
/// Canonicalizes `path`, attaching a context message that includes the original
/// path on failure.
pub fn canonicalize_path(path: PathBuf) -> Result<PathBuf> {
path.canonicalize()
.with_context(|| format!("Failed to resolve path: {}", path.display()))
}
/// Extracts [`forge_domain::FileStatus`] entries with
/// [`forge_domain::SyncStatus::Failed`] from a slice of file-read results by
/// downcasting errors to [`FileReadError`].
fn extract_failed_statuses<T>(results: &[Result<T>]) -> Vec<forge_domain::FileStatus> {
results
.iter()
.filter_map(|r| r.as_ref().err())
.filter_map(|e| e.downcast_ref::<FileReadError>())
.map(|e| {
forge_domain::FileStatus::new(
e.path.to_string_lossy().into_owned(),
forge_domain::SyncStatus::Failed,
)
})
.collect()
}
/// Handles all sync operations for a workspace.
///
/// `F` provides infrastructure capabilities (file I/O, workspace index) and
/// `D` is the file-discovery strategy used to enumerate workspace files.
pub struct WorkspaceSyncEngine<F, D> {
infra: Arc<F>,
discovery: Arc<D>,
workspace_root: PathBuf,
workspace_id: WorkspaceId,
user_id: UserId,
token: ApiKey,
batch_size: usize,
}
impl<F, D> WorkspaceSyncEngine<F, D> {
/// Creates a new workspace sync engine with the provided infrastructure,
/// file-discovery strategy, and workspace context shared by all operations.
pub fn new(
infra: Arc<F>,
discovery: Arc<D>,
workspace_root: PathBuf,
workspace_id: WorkspaceId,
user_id: UserId,
token: ApiKey,
batch_size: usize,
) -> Self {
Self {
infra,
discovery,
workspace_root,
workspace_id,
user_id,
token,
batch_size,
}
}
}
impl<F: 'static + WorkspaceIndexRepository + FileReaderInfra, D: FileDiscovery + 'static>
WorkspaceSyncEngine<F, D>
{
/// Executes the full workspace sync, emitting progress events via `emit`.
///
/// Reads local file hashes, compares them against remote, then deletes
/// stale files and uploads new or modified ones.
pub async fn run<E, Fut>(&self, emit: E) -> Result<()>
where
E: Fn(SyncProgress) -> Fut + Send + Sync,
Fut: std::future::Future<Output = ()> + Send,
{
emit(SyncProgress::DiscoveringFiles {
path: self.workspace_root.clone(),
workspace_id: self.workspace_id.clone(),
})
.await;
// Pass 1: stream files and collect only hashes — content is discarded
// immediately after hashing so peak memory is bounded to one batch
// of file content rather than the entire workspace.
let results: Vec<Result<FileHash>> = self.read_hashes().collect().await;
let failed_statuses = extract_failed_statuses(&results);
let local_hashes: Vec<FileHash> = results.into_iter().flatten().collect();
let total_file_count = local_hashes.len() + failed_statuses.len();
emit(SyncProgress::FilesDiscovered { count: total_file_count }).await;
let remote_files = self.fetch_remote_hashes().await?;
emit(SyncProgress::ComparingFiles {
remote_files: remote_files.len(),
local_files: total_file_count,
})
.await;
let plan = WorkspaceStatus::new(self.workspace_root.clone(), remote_files);
let mut statuses = plan.file_statuses(local_hashes.clone());
statuses.extend(failed_statuses);
// Compute counts from statuses
let added = statuses
.iter()
.filter(|s| s.status == forge_domain::SyncStatus::New)
.count();
let deleted = statuses
.iter()
.filter(|s| s.status == forge_domain::SyncStatus::Deleted)
.count();
let modified = statuses
.iter()
.filter(|s| s.status == forge_domain::SyncStatus::Modified)
.count();
let mut failed_files = statuses
.iter()
.filter(|s| s.status == forge_domain::SyncStatus::Failed)
.count();
// Compute total number of affected files
let total_file_changes = added + deleted + modified;
// Only emit diff computed event if there are actual changes
if total_file_changes > 0 {
emit(SyncProgress::DiffComputed { added, deleted, modified }).await;
}
// Derive the exact paths to delete/upload — no file content required
let sync_paths = plan.get_sync_paths(local_hashes);
let total_operations = sync_paths.delete.len() + sync_paths.upload.len();
let mut counter = SyncProgressCounter::new(total_file_changes, total_operations);
emit(counter.sync_progress()).await;
// Delete all files in a single batched call
match self.delete_files(sync_paths.delete.clone()).await {
Ok(deleted_count) => {
counter.complete(deleted_count);
emit(counter.sync_progress()).await;
}
Err(e) => {
warn!(workspace_id = %self.workspace_id, error = ?e, "Failed to delete files during sync");
failed_files += sync_paths.delete.len();
}
}
// Pass 2: upload files — files are grouped into batches of `batch_size`
// and each batch is sent in a single HTTP request, sequentially.
let mut upload_stream = Box::pin(self.upload_files(sync_paths.upload));
// Process uploads as they complete, updating progress incrementally
while let Some((attempted, result)) = upload_stream.next().await {
match result {
Ok(()) => {
counter.complete(attempted);
emit(counter.sync_progress()).await;
}
Err(e) => {
warn!(workspace_id = %self.workspace_id, error = ?e, "Failed to upload file during sync");
failed_files += attempted;
// Continue processing remaining uploads
}
}
}
info!(
workspace_id = %self.workspace_id,
total_files = total_file_count,
"Sync completed successfully"
);
emit(SyncProgress::Completed {
total_files: total_file_count,
uploaded_files: total_file_changes,
failed_files,
})
.await;
// Fail if there were any failed files
if failed_files > 0 {
Err(forge_domain::Error::sync_failed(failed_files).into())
} else {
Ok(())
}
}
/// Computes the current sync status for all files in the workspace.
///
/// Reads local file hashes and compares them against the remote server to
/// produce a per-file status report.
pub async fn compute_status(&self) -> Result<Vec<forge_domain::FileStatus>> {
let results: Vec<Result<FileHash>> = self.read_hashes().collect().await;
let mut failed_statuses = extract_failed_statuses(&results);
let local_hashes: Vec<FileHash> = results.into_iter().flatten().collect();
let remote_files = self.fetch_remote_hashes().await?;
let plan = WorkspaceStatus::new(self.workspace_root.clone(), remote_files);
let mut statuses = plan.file_statuses(local_hashes);
statuses.append(&mut failed_statuses);
Ok(statuses)
}
/// Fetches remote file hashes from the server.
async fn fetch_remote_hashes(&self) -> anyhow::Result<Vec<FileHash>> {
info!(workspace_id = %self.workspace_id, "Fetching existing file hashes from server to detect changes...");
let workspace_files =
forge_domain::CodeBase::new(self.user_id.clone(), self.workspace_id.clone(), ());
self.infra
.list_workspace_files(&workspace_files, &self.token)
.await
}
/// Deletes files from the workspace.
///
/// Returns the number of files that were successfully deleted.
async fn delete_files(&self, files_to_delete: Vec<PathBuf>) -> Result<usize> {
if files_to_delete.is_empty() {
return Ok(0);
}
let paths: Vec<String> = files_to_delete
.iter()
.map(|p| p.to_string_lossy().into_owned())
.collect();
let deletion =
forge_domain::CodeBase::new(self.user_id.clone(), self.workspace_id.clone(), paths);
self.infra
.delete_files(&deletion, &self.token)
.await
.context("Failed to delete files")?;
for path in &files_to_delete {
info!(workspace_id = %self.workspace_id, path = %path.display(), "File deleted successfully");
}
Ok(files_to_delete.len())
}
/// Uploads files in batches, sending one HTTP request per batch of
/// `batch_size` files.
///
/// Files within each batch are read from disk, collected into a single
/// [`forge_domain::FileUpload`] payload, and uploaded in one request.
/// Batches are processed sequentially — only one HTTP request is in-flight
/// at a time — which keeps both memory usage and server concurrency
/// bounded. The stream yields the number of files attempted per batch
/// along with whether the batch upload succeeded.
fn upload_files(
&self,
paths: Vec<PathBuf>,
) -> impl Stream<Item = (usize, Result<(), anyhow::Error>)> + Send {
let user_id = self.user_id.clone();
let workspace_id = self.workspace_id.clone();
let token = self.token.clone();
let infra = self.infra.clone();
let batch_size = self.batch_size;
futures::stream::iter(paths)
.chunks(batch_size)
.then(move |batch| {
let user_id = user_id.clone();
let workspace_id = workspace_id.clone();
let token = token.clone();
let infra = infra.clone();
let attempted = batch.len();
async move {
let mut files = Vec::with_capacity(batch.len());
for file_path in &batch {
let content = infra.read_utf8(file_path).await.with_context(|| {
format!("Failed to read file '{}' for upload", file_path.display())
})?;
files.push(forge_domain::FileRead::new(
file_path.to_string_lossy().into_owned(),
content,
));
}
let upload =
forge_domain::CodeBase::new(user_id.clone(), workspace_id.clone(), files);
infra
.upload_files(&upload, &token)
.await
.context("Failed to upload files")?;
Ok::<_, anyhow::Error>(())
}
.map(move |result| (attempted, result))
})
}
/// Discovers workspace files and streams their hashes without retaining
/// file content in memory.
///
/// Each file is read in batches for concurrency, but the content is
/// discarded immediately after the hash is computed so that only one
/// batch of file content occupies memory at a time.
fn read_hashes(&self) -> impl Stream<Item = Result<FileHash>> + Send {
let dir_path = self.workspace_root.clone();
let infra = self.infra.clone();
let discovery = self.discovery.clone();
let workspace_id = self.workspace_id.clone();
let batch_size = self.batch_size;
async_stream::stream! {
let file_paths: Vec<PathBuf> = match discover_sync_file_paths(
discovery.as_ref(),
&dir_path,
&workspace_id,
).await {
Ok(file_paths) => file_paths,
Err(err) => {
yield Err(err);
return;
}
};
let stream = infra.read_batch_utf8(batch_size, file_paths);
futures::pin_mut!(stream);
while let Some((absolute_path, result)) = stream.next().await {
match result {
Ok(content) => {
let hash = compute_hash(&content);
// content is dropped here — only the hash is retained
let path_str = absolute_path.to_string_lossy().to_string();
yield Ok(FileHash { path: path_str, hash });
}
Err(e) => {
warn!(path = %absolute_path.display(), error = ?e, "Skipping unreadable file during sync");
yield Err(FileReadError { path: absolute_path, source: e }.into());
}
}
}
}
}
}
#[cfg(test)]
mod tests {
use std::path::Path;
use async_trait::async_trait;
use forge_app::FileReaderInfra;
use forge_domain::{
ApiKey, FileDeletion, FileHash, FileInfo, FileUpload, FileUploadInfo, Node, UserId,
WorkspaceAuth, WorkspaceFiles, WorkspaceId, WorkspaceIndexRepository, WorkspaceInfo,
};
use futures::StreamExt;
use pretty_assertions::assert_eq;
use super::*;
/// Minimal infra for `upload_files`: only `read_utf8` + `upload_files`
/// are exercised; everything else is intentionally unreachable.
struct MockInfra {
fail_upload: bool,
}
#[async_trait]
#[rustfmt::skip]
impl FileReaderInfra for MockInfra {
async fn read_utf8(&self, _path: &Path) -> anyhow::Result<String> { Ok(String::new()) }
fn read_batch_utf8(&self, _: usize, _: Vec<PathBuf>) -> impl futures::Stream<Item = (PathBuf, anyhow::Result<String>)> + Send { futures::stream::empty() }
async fn read(&self, _: &Path) -> anyhow::Result<Vec<u8>> { unreachable!() }
async fn range_read_utf8(&self, _: &Path, _: u64, _: u64) -> anyhow::Result<(String, FileInfo)> { unreachable!() }
}
#[async_trait]
#[rustfmt::skip]
impl WorkspaceIndexRepository for MockInfra {
async fn upload_files(&self, _: &FileUpload, _: &ApiKey) -> anyhow::Result<FileUploadInfo> {
if self.fail_upload { Err(anyhow::anyhow!("boom")) } else { Ok(FileUploadInfo::default()) }
}
async fn authenticate(&self) -> anyhow::Result<WorkspaceAuth> { unreachable!() }
async fn create_workspace(&self, _: &Path, _: &ApiKey) -> anyhow::Result<WorkspaceId> { unreachable!() }
async fn search(&self, _: &forge_domain::CodeSearchQuery<'_>, _: &ApiKey) -> anyhow::Result<Vec<Node>> { unreachable!() }
async fn list_workspaces(&self, _: &ApiKey) -> anyhow::Result<Vec<WorkspaceInfo>> { unreachable!() }
async fn get_workspace(&self, _: &WorkspaceId, _: &ApiKey) -> anyhow::Result<Option<WorkspaceInfo>> { unreachable!() }
async fn list_workspace_files(&self, _: &WorkspaceFiles, _: &ApiKey) -> anyhow::Result<Vec<FileHash>> { unreachable!() }
async fn delete_files(&self, _: &FileDeletion, _: &ApiKey) -> anyhow::Result<()> { unreachable!() }
async fn delete_workspace(&self, _: &WorkspaceId, _: &ApiKey) -> anyhow::Result<()> { unreachable!() }
}
/// Discovery is not invoked by `upload_files`; a no-op satisfies the bound.
struct NoDiscovery;
#[async_trait]
impl FileDiscovery for NoDiscovery {
async fn discover(&self, _: &Path) -> anyhow::Result<Vec<PathBuf>> {
Ok(vec![])
}
}
fn fixture(fail_upload: bool) -> WorkspaceSyncEngine<MockInfra, NoDiscovery> {
WorkspaceSyncEngine::new(
Arc::new(MockInfra { fail_upload }),
Arc::new(NoDiscovery),
PathBuf::new(),
WorkspaceId::generate(),
UserId::generate(),
ApiKey::from(String::new()),
3, // batch_size
)
}
/// Regression test for the bug where a failed batch counted as 1 failure
/// instead of N. With batch_size=3 and 5 files, batches are [3, 2] and
/// each must report its full size on failure.
#[tokio::test]
async fn test_failed_batch_reports_full_batch_size() {
let engine = fixture(true);
let paths: Vec<PathBuf> = (0..5).map(|i| PathBuf::from(format!("f{i}"))).collect();
let actual: Vec<(usize, bool)> = engine
.upload_files(paths)
.map(|(n, r)| (n, r.is_ok()))
.collect()
.await;
let expected = vec![(3, false), (2, false)];
assert_eq!(actual, expected);
}
/// Successful batches must also yield their full size so the progress
/// counter advances correctly.
#[tokio::test]
async fn test_successful_batch_reports_full_batch_size() {
let engine = fixture(false);
let paths: Vec<PathBuf> = (0..5).map(|i| PathBuf::from(format!("f{i}"))).collect();
let actual: Vec<(usize, bool)> = engine
.upload_files(paths)
.map(|(n, r)| (n, r.is_ok()))
.collect()
.await;
let expected = vec![(3, true), (2, true)];
assert_eq!(actual, expected);
}
}
|