Move force overwrite lockfile v4 to v3 flag into cargo-gpu

Author: tuguzT

crates/cargo-gpu-build/src/build.rs

@@ -28,6 +28,28 @@ pub struct ShaderCrateBuilderParams<W, T, C, O, E> {
     pub build: SpirvBuilder,
     /// Parameters of the codegen backend installation for the shader crate.
     pub install: InstallParams,
+    /// There is a tricky situation where a shader crate that depends on workspace config can have
+    /// a different `Cargo.lock` lockfile version from the the workspace's `Cargo.lock`. This can
+    /// prevent builds when an old Rust toolchain doesn't recognise the newer lockfile version.
+    ///
+    /// The ideal way to resolve this would be to match the shader crate's toolchain with the
+    /// workspace's toolchain. However, that is not always possible. Another solution is to
+    /// `exclude = [...]` the problematic shader crate from the workspace. This also may not be a
+    /// suitable solution if there are a number of shader crates all sharing similar config and
+    /// you don't want to have to copy/paste and maintain that config across all the shaders.
+    ///
+    /// So a somewhat hacky workaround is to overwrite lockfile versions. Enabling this flag
+    /// will only come into effect if there are a mix of v3/v4 lockfiles. It will also
+    /// only overwrite versions for the duration of a build. It will attempt to return the versions
+    /// to their original values once the build is finished. However, of course, unexpected errors
+    /// can occur and the overwritten values can remain. Hence why this behaviour is not enabled by
+    /// default.
+    ///
+    /// This hack is possible because the change from v3 to v4 only involves a minor change to the
+    /// way source URLs are encoded. See these PRs for more details:
+    ///   * <https://github.com/rust-lang/cargo/pull/12280>
+    ///   * <https://github.com/rust-lang/cargo/pull/14595>
+    pub force_overwrite_lockfiles_v4_to_v3: bool,
     /// Writer of user output.
     pub writer: W,
     /// Callbacks to halt toolchain installation.
@@ -51,13 +73,27 @@ impl<W, T, C, O, E> ShaderCrateBuilderParams<W, T, C, O, E> {
         Self { install, ..self }
     }
 
+    /// Sets whether to force overwriting lockfiles from v4 to v3.
+    #[inline]
+    #[must_use]
+    pub fn force_overwrite_lockfiles_v4_to_v3(
+        self,
+        force_overwrite_lockfiles_v4_to_v3: bool,
+    ) -> Self {
+        Self {
+            force_overwrite_lockfiles_v4_to_v3,
+            ..self
+        }
+    }
+
     /// Replaces the writer of user output.
     #[inline]
     #[must_use]
     pub fn writer<NW>(self, writer: NW) -> ShaderCrateBuilderParams<NW, T, C, O, E> {
         ShaderCrateBuilderParams {
             build: self.build,
             install: self.install,
+            force_overwrite_lockfiles_v4_to_v3: self.force_overwrite_lockfiles_v4_to_v3,
             writer,
             halt: self.halt,
             stdio_cfg: self.stdio_cfg,
@@ -74,6 +110,7 @@ impl<W, T, C, O, E> ShaderCrateBuilderParams<W, T, C, O, E> {
         ShaderCrateBuilderParams {
             build: self.build,
             install: self.install,
+            force_overwrite_lockfiles_v4_to_v3: self.force_overwrite_lockfiles_v4_to_v3,
             writer: self.writer,
             halt,
             stdio_cfg: self.stdio_cfg,
@@ -90,6 +127,7 @@ impl<W, T, C, O, E> ShaderCrateBuilderParams<W, T, C, O, E> {
         ShaderCrateBuilderParams {
             build: self.build,
             install: self.install,
+            force_overwrite_lockfiles_v4_to_v3: self.force_overwrite_lockfiles_v4_to_v3,
             writer: self.writer,
             halt: self.halt,
             stdio_cfg,
@@ -122,6 +160,7 @@ impl Default for DefaultShaderCrateBuilderParams {
         Self {
             build: SpirvBuilder::default(),
             install: InstallParams::default(),
+            force_overwrite_lockfiles_v4_to_v3: false,
             writer: io::stdout(),
             halt: HaltToolchainInstallation::noop(),
             stdio_cfg: StdioCfg::inherit(),
@@ -172,6 +211,7 @@ where
         let ShaderCrateBuilderParams {
             mut build,
             install,
+            force_overwrite_lockfiles_v4_to_v3,
             mut writer,
             halt,
             mut stdio_cfg,
@@ -202,7 +242,7 @@ where
         let lockfile_mismatch_handler = LockfileMismatchHandler::new(
             &backend_to_install.shader_crate,
             &backend.toolchain_channel,
-            backend_to_install.params.force_overwrite_lockfiles_v4_to_v3,
+            force_overwrite_lockfiles_v4_to_v3,
         )?;
 
         #[expect(clippy::unreachable, reason = "target was already set")]

crates/cargo-gpu-build/src/lockfile.rs

@@ -69,7 +69,7 @@ impl LockfileMismatchHandler {
         })
     }
 
-    /// See docs for [`force_overwrite_lockfiles_v4_to_v3`](crate::cache::install::InstallParams::force_overwrite_lockfiles_v4_to_v3)
+    /// See docs for [`force_overwrite_lockfiles_v4_to_v3`](field@crate::build::ShaderCrateBuilderParams::force_overwrite_lockfiles_v4_to_v3)
     /// flag for why we do this.
     fn ensure_workspace_rust_version_does_not_conflict_with_shader(
         shader_crate_path: &Path,
@@ -97,7 +97,7 @@ impl LockfileMismatchHandler {
         }
     }
 
-    /// See docs for [`force_overwrite_lockfiles_v4_to_v3`](crate::cache::install::InstallParams::force_overwrite_lockfiles_v4_to_v3)
+    /// See docs for [`force_overwrite_lockfiles_v4_to_v3`](field@crate::build::ShaderCrateBuilderParams::force_overwrite_lockfiles_v4_to_v3)
     /// flag for why we do this.
     fn ensure_shader_rust_version_does_not_conflict_with_any_cargo_locks(
         shader_crate_path: &Path,
@@ -335,7 +335,7 @@ pub enum LockfileMismatchError {
     /// Conflicting lockfile manifest versions detected, with advice on how to resolve them
     /// by setting the [`force_overwrite_lockfiles_v4_to_v3`] flag.
     ///
-    /// [`force_overwrite_lockfiles_v4_to_v3`]: crate::spirv_cache::backend::InstallParams::force_overwrite_lockfiles_v4_to_v3
+    /// [`force_overwrite_lockfiles_v4_to_v3`]: field@crate::build::ShaderCrateBuilderParams::force_overwrite_lockfiles_v4_to_v3
     #[error(
         r#"conflicting `Cargo.lock` versions detected ⚠️
 

crates/cargo-gpu/src/build.rs

@@ -56,6 +56,30 @@ pub struct InstallArgs {
     #[serde(flatten)]
     pub backend: Install,
 
+    /// There is a tricky situation where a shader crate that depends on workspace config can have
+    /// a different `Cargo.lock` lockfile version from the the workspace's `Cargo.lock`. This can
+    /// prevent builds when an old Rust toolchain doesn't recognise the newer lockfile version.
+    ///
+    /// The ideal way to resolve this would be to match the shader crate's toolchain with the
+    /// workspace's toolchain. However, that is not always possible. Another solution is to
+    /// `exclude = [...]` the problematic shader crate from the workspace. This also may not be a
+    /// suitable solution if there are a number of shader crates all sharing similar config and
+    /// you don't want to have to copy/paste and maintain that config across all the shaders.
+    ///
+    /// So a somewhat hacky workaround is to overwrite lockfile versions. Enabling this flag
+    /// will only come into effect if there are a mix of v3/v4 lockfiles. It will also
+    /// only overwrite versions for the duration of a build. It will attempt to return the versions
+    /// to their original values once the build is finished. However, of course, unexpected errors
+    /// can occur and the overwritten values can remain. Hence why this behaviour is not enabled by
+    /// default.
+    ///
+    /// This hack is possible because the change from v3 to v4 only involves a minor change to the
+    /// way source URLs are encoded. See these PRs for more details:
+    ///   * <https://github.com/rust-lang/cargo/pull/12280>
+    ///   * <https://github.com/rust-lang/cargo/pull/14595>
+    #[clap(long, action, verbatim_doc_comment)]
+    pub force_overwrite_lockfiles_v4_to_v3: bool,
+
     /// Assume "yes" to "Install Rust toolchain: [y/n]" prompt.
     #[clap(long, action)]
     pub auto_install_rust_toolchain: bool,
@@ -87,6 +111,7 @@ impl Build {
         let halt = ask_for_user_consent(self.install.auto_install_rust_toolchain);
         let crate_builder_params = ShaderCrateBuilderParams::from(self.build.spirv_builder.clone())
             .install(self.install.backend.params.clone())
+            .force_overwrite_lockfiles_v4_to_v3(self.install.force_overwrite_lockfiles_v4_to_v3)
             .halt(halt);
         let crate_builder = ShaderCrateBuilder::new(crate_builder_params)?;
 

crates/rustc_codegen_spirv-cache/src/backend.rs

@@ -143,30 +143,6 @@ pub struct InstallParams {
     /// saves about 200MiB of disk space.
     #[cfg_attr(feature = "clap", clap(long = "no-clear-target", default_value = "true", action = clap::ArgAction::SetFalse))]
     pub clear_target: bool,
-
-    /// There is a tricky situation where a shader crate that depends on workspace config can have
-    /// a different `Cargo.lock` lockfile version from the the workspace's `Cargo.lock`. This can
-    /// prevent builds when an old Rust toolchain doesn't recognise the newer lockfile version.
-    ///
-    /// The ideal way to resolve this would be to match the shader crate's toolchain with the
-    /// workspace's toolchain. However, that is not always possible. Another solution is to
-    /// `exclude = [...]` the problematic shader crate from the workspace. This also may not be a
-    /// suitable solution if there are a number of shader crates all sharing similar config and
-    /// you don't want to have to copy/paste and maintain that config across all the shaders.
-    ///
-    /// So a somewhat hacky workaround is to overwrite lockfile versions. Enabling this flag
-    /// will only come into effect if there are a mix of v3/v4 lockfiles. It will also
-    /// only overwrite versions for the duration of a build. It will attempt to return the versions
-    /// to their original values once the build is finished. However, of course, unexpected errors
-    /// can occur and the overwritten values can remain. Hence why this behaviour is not enabled by
-    /// default.
-    ///
-    /// This hack is possible because the change from v3 to v4 only involves a minor change to the
-    /// way source URLs are encoded. See these PRs for more details:
-    ///   * <https://github.com/rust-lang/cargo/pull/12280>
-    ///   * <https://github.com/rust-lang/cargo/pull/14595>
-    #[cfg_attr(feature = "clap", clap(long, action, verbatim_doc_comment))]
-    pub force_overwrite_lockfiles_v4_to_v3: bool,
 }
 
 impl Default for InstallParams {
@@ -177,7 +153,6 @@ impl Default for InstallParams {
             spirv_builder_version: None,
             rebuild_codegen: false,
             clear_target: true,
-            force_overwrite_lockfiles_v4_to_v3: false,
         }
     }
 }