Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add advisory lock for registry cache db #1712

Merged
merged 1 commit into from
Nov 4, 2024
Merged

Add advisory lock for registry cache db #1712

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 16 additions & 9 deletions scarb/src/core/registry/client/cache.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ use crate::core::registry::index::{IndexRecord, IndexRecords};
#[allow(unused_imports)]
use crate::core::PackageName;
use crate::core::{Checksum, Config, ManifestDependency, PackageId, SourceId};
use crate::flock::{FileLockGuard, Filesystem};
use crate::flock::{AdvisoryLockGuard, FileLockGuard, Filesystem};
use crate::internal::fsx;

// FIXME(mkaput): Avoid creating database if inner client does not trigger cache writes.
Expand Down Expand Up @@ -180,11 +180,13 @@ impl<'c> RegistryClientCache<'c> {
.get_or_try_init(|| async {
let ui = self.config.ui();
let fs = self.config.dirs().registry_dir().into_child("cache");
let db_path = fs
.path_existent()?
.join(format!("{}.v1.redb", self.source_id.ident()));

CacheDatabase::create(&db_path, ui)
let filename = format!("{}.v1.redb", self.source_id.ident());
let db_path = fs.path_existent()?.join(filename.clone());
let lock = fs
.advisory_lock(format!("{filename}.lock"), "registry db cache", self.config)
.acquire_async()
.await?;
CacheDatabase::create(&db_path, lock, ui)
})
.await
}
Expand Down Expand Up @@ -259,11 +261,12 @@ impl<'c> RegistryClientCache<'c> {
struct CacheDatabase {
db: redb::Database,
ui: Ui,
_lock: AdvisoryLockGuard,
}

impl CacheDatabase {
#[tracing::instrument(level = "trace", skip(ui))]
fn create(path: &Utf8Path, ui: Ui) -> Result<Self> {
#[tracing::instrument(level = "trace", skip(ui, lock))]
fn create(path: &Utf8Path, lock: AdvisoryLockGuard, ui: Ui) -> Result<Self> {
fn create(path: &Utf8Path, ui: &Ui) -> Result<redb::Database> {
// We do need to repair the database in case of corruption, because this is just
// a cache, and we can always re-download the data from the registry.
Expand Down Expand Up @@ -298,7 +301,11 @@ impl CacheDatabase {
Ok(db)
})?;

Ok(Self { db, ui })
Ok(Self {
db,
ui,
_lock: lock,
})
}

#[tracing::instrument(level = "trace", skip_all)]
Expand Down
Loading