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.

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

[Turbopack] move git version info to top-level crate to fix caching issues #74015

Merged
merged 3 commits into from
Dec 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
15 changes: 0 additions & 15 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions crates/napi/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -135,8 +135,8 @@ tokio = { workspace = true, features = ["full"] }

[build-dependencies]
napi-build = "2"
serde = "1"
serde_json = "1"
serde = { workspace = true }
serde_json = { workspace = true }
# It is not a mistake this dependency is specified in dep / build-dep both.
shadow-rs = { workspace = true }

Expand Down
21 changes: 20 additions & 1 deletion crates/napi/src/next_api/utils.rs
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,25 @@
memory_limit: usize,
) -> Result<NextTurboTasks> {
Ok(if persistent_caching {
let dirty_suffix = if crate::build::GIT_CLEAN || !env!("CI").is_empty() {

Check failure on line 130 in crates/napi/src/next_api/utils.rs

View workflow job for this annotation

GitHub Actions / stable - x86_64-unknown-linux-gnu - node@16

environment variable `CI` not defined at compile time
""
} else {
"-dirty"
};
#[allow(
clippy::const_is_empty,
reason = "LAST_TAG might be empty if the tag can't be determined"
)]
let version_info = if crate::build::LAST_TAG.is_empty() {
mischnic marked this conversation as resolved.
Show resolved Hide resolved
format!("{}{}", crate::build::SHORT_COMMIT, dirty_suffix)
} else {
format!(
"{}-{}{}",
crate::build::LAST_TAG,
crate::build::SHORT_COMMIT,
dirty_suffix
)
};
NextTurboTasks::PersistentCaching(TurboTasks::new(
turbo_tasks_backend::TurboTasksBackend::new(
turbo_tasks_backend::BackendOptions {
Expand All @@ -137,7 +156,7 @@
}),
..Default::default()
},
default_backing_storage(&output_path.join("cache/turbopack"))?,
default_backing_storage(&output_path.join("cache/turbopack"), &version_info)?,
),
))
} else {
Expand Down
2 changes: 0 additions & 2 deletions turbopack/crates/turbo-tasks-backend/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -55,9 +55,7 @@ turbo-tasks-testing = { workspace = true }
criterion = { workspace = true, features = ["async_tokio"] }

[build-dependencies]
anyhow = { workspace = true }
turbo-tasks-build = { workspace = true }
vergen-gitcl = { version = "1.0.1" }

[[bench]]
name = "mod"
Expand Down
11 changes: 0 additions & 11 deletions turbopack/crates/turbo-tasks-backend/build.rs
Original file line number Diff line number Diff line change
@@ -1,16 +1,5 @@
use anyhow::Result;
use turbo_tasks_build::generate_register;
use vergen_gitcl::{Emitter, GitclBuilder};

fn generate_version_info() -> Result<()> {
let git = GitclBuilder::default()
.describe(false, option_env!("CI").is_none(), None)
.build()?;
Emitter::default().add_instructions(&git)?.emit()?;
Ok(())
}

fn main() {
generate_register();
generate_version_info().unwrap();
}
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,13 @@ use anyhow::Result;
/// the current one and two older/newer ones.
const MAX_OTHER_DB_VERSIONS: usize = 2;

pub fn handle_db_versioning(base_path: &Path) -> Result<PathBuf> {
pub fn handle_db_versioning(base_path: &Path, version_info: &str) -> Result<PathBuf> {
if let Ok(version) = env::var("TURBO_ENGINE_VERSION") {
return Ok(base_path.join(version));
}
// Database versioning. Pass `TURBO_ENGINE_IGNORE_DIRTY` at runtime to ignore a
// dirty git repository. Pass `TURBO_ENGINE_DISABLE_VERSIONING` at runtime to disable
// versioning and always use the same database.
let version_info = env!("VERGEN_GIT_DESCRIBE");
let (version_info, git_dirty) = if let Some(version_info) = version_info.strip_suffix("-dirty")
{
(version_info, true)
Expand Down
16 changes: 8 additions & 8 deletions turbopack/crates/turbo-tasks-backend/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -33,14 +33,14 @@ pub type LmdbBackingStorage = KeyValueDatabaseBackingStorage<
>;

#[cfg(feature = "lmdb")]
pub fn lmdb_backing_storage(path: &Path) -> Result<LmdbBackingStorage> {
pub fn lmdb_backing_storage(path: &Path, version_info: &str) -> Result<LmdbBackingStorage> {
use crate::database::{
fresh_db_optimization::{is_fresh, FreshDbOptimization},
read_transaction_cache::ReadTransactionCache,
startup_cache::StartupCacheLayer,
};

let path = handle_db_versioning(path)?;
let path = handle_db_versioning(path, version_info)?;
let fresh_db = is_fresh(&path);
let database = crate::database::lmdb::LmbdKeyValueDatabase::new(&path)?;
let database = FreshDbOptimization::new(database, fresh_db);
Expand All @@ -51,8 +51,8 @@ pub fn lmdb_backing_storage(path: &Path) -> Result<LmdbBackingStorage> {

pub type TurboBackingStorage = KeyValueDatabaseBackingStorage<TurboKeyValueDatabase>;

pub fn turbo_backing_storage(path: &Path) -> Result<TurboBackingStorage> {
let path = handle_db_versioning(path)?;
pub fn turbo_backing_storage(path: &Path, version_info: &str) -> Result<TurboBackingStorage> {
let path = handle_db_versioning(path, version_info)?;
let database = TurboKeyValueDatabase::new(path)?;
Ok(KeyValueDatabaseBackingStorage::new(database))
}
Expand All @@ -67,14 +67,14 @@ pub fn noop_backing_storage() -> NoopBackingStorage {
pub type DefaultBackingStorage = LmdbBackingStorage;

#[cfg(feature = "lmdb")]
pub fn default_backing_storage(path: &Path) -> Result<DefaultBackingStorage> {
lmdb_backing_storage(path)
pub fn default_backing_storage(path: &Path, version_info: &str) -> Result<DefaultBackingStorage> {
lmdb_backing_storage(path, version_info)
}

#[cfg(not(feature = "lmdb"))]
pub type DefaultBackingStorage = TurboBackingStorage;

#[cfg(not(feature = "lmdb"))]
pub fn default_backing_storage(path: &Path) -> Result<DefaultBackingStorage> {
turbo_backing_storage(path)
pub fn default_backing_storage(path: &Path, version_info: &str) -> Result<DefaultBackingStorage> {
turbo_backing_storage(path, version_info)
}
3 changes: 2 additions & 1 deletion turbopack/crates/turbo-tasks-backend/tests/test_config.trs
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@
turbo_tasks_backend::TurboTasksBackend::new(
turbo_tasks_backend::BackendOptions::default(),
turbo_tasks_backend::default_backing_storage(
path.as_path()
path.as_path(),
"test"
).unwrap()
)
)
Expand Down
Loading