fix(package): check dirtiness of symlinks source files #14981

weihanglo · 2024-12-24T20:16:54Z

What does this PR try to resolve?

This adds a special case for checking source files are symlinks
and have been modified when under a VCS control

This is required because those paths may link to a file outside the
current package root, but still under the git workdir, affecting the
final packaged .crate file.

How should we test and review this PR?

Pretty similar to #14966, as a part of #14967.

This may have potential performance issue. If a package contains thousands of symlinks, Cargo will fire git status for each of them. Not sure if we want to do anything proactively now.

The introduction of the PathEntry struct gives us more room for storing file metadata to satisfiy use cases in the future. For instances,

Knowing a source file is a symlink and resolving it when packaging on Windows
- cargo package / publish don't handle symlink correctly on Windows #5664
- cargo vendor is not consistent about paths and symbolic links on Windows vs. other platforms #14965
Knowing more about a file's metadata (e.g. permission bits from Git)
- cargo package should warn binary files by default #4413
- Publish bundled binary on Windows loses execution permission #8006
Provide richer information for cargo package --list, for example JSON output mode

rustbot · 2024-12-24T20:16:59Z

r? @ehuss

rustbot has assigned @ehuss.
They will have a look at your PR within the next two weeks and either review your PR or reassign to another reviewer.

Use r? to explicitly pick a reviewer

weihanglo · 2024-12-24T20:18:06Z

src/cargo/ops/cargo_package.rs

+            // TODO: Should we warn users if there are like thousands of symlinks,
+            // which may hurt the performance?
+            if repo.status_file(&rel_path)? != git2::Status::CURRENT {
+                dirty_symlinks.insert(workdir.join(rel_path));


We could potentially cache git status for each repo then. That leaves to future improvement if this one has got merged.

See #14985.

### What does this PR try to resolve? Do nothing but move code around * `cargo_package.rs` -> `cargo_package/mod.rs` * Extract vcs info helpers to `cargo_package/vcs.rs` * Extract verification helpers to `cargo_package/verify.rs` Doing so because I realized how big `cargo_package.rs` has grown. Like, the vcs helpers will continue growing with #14981 and potentially other optimizations. ### How should we test and review this PR? All tests pass.

It may not be worthy for the majority. Single file `git status` is generally fast. On some slow file systems or lower-end machines, skipping file system access might be helpful. However, slow file system access usually happen on Window. And we'll only have large amount of `git status` when rust-lang#14981 merges and the repo contains lots of symlinks. Given symlink handling story is crazy in real world Windows, I doubt anybody will hit the performance issue without this.

weihanglo · 2024-12-29T16:10:26Z

This doesn't handle symlink directories correctly with git. Fixing…

This has been fixed.

src/cargo/sources/path.rs

src/cargo/ops/cargo_package/vcs.rs

### What does this PR try to resolve? `cargo package` will warn users when git `core.symlinks` is `false` and some symlinks were checked out as plain files during packaging. Git config [`core.symlinks`] defaults to true when unset. In git-for-windows (and git as well), the config should be set to false explicitly when the repo was created, if symlink support wasn't detected [^1]. We assume the config was always set at creation time and never changed. So, if it is true, we don't bother users with any warning. [^1]: https://github.com/git-for-windows/git/blob/f1241afcc7956918d5da33ef74abd9cbba369247/setup.c#L2394-L2403 [`core.symlinks`]: https://git-scm.com/docs/git-config#Documentation/git-config.txt-coresymlinks ### How should we test and review this PR? CI passes. This shares two commits 42dc4ef and c8c8223 with #14981. I didn't commit to fix all symlink issues all at once. This PR demonstrates how we could leverage metadata in `PathEntry`. Maybe later we can really follow plain-text symlinks and resolve the issue. ### Additional information cc #5664

So `path` and `base` are able to accept different types

`abs_path` and `workdir.join(rel_path)` are the same at that point.

This is helpful for VCS status check. Paths emitted by PathSource are always under package root, We lose the track of file type info of paths under symlink dirs, so we need this extra bit of information.

This show that a regular file under a symlink directory is also not tarcked by the current vcs dirtiness check.

This adds a special case for checking source files are symlinks and have been modified when under a VCS control This is required because those paths may link to a file outside the current package root, but still under the git workdir, affecting the final packaged `.crate` file. This may have potential performance issue. If a package contains thousands of symlinks, Cargo will fire `git status` for each of them.

metdata path fields may point to a dirty symlilnk and cause duplicate report. This commit combines `dirty_metadata_paths` and `dirty_symlinks` into one so is able to de-duplicate them.

It may not be worthy for the majority. Single file `git status` is generally fast. On some slow file systems or lower-end machines, skipping file system access might be helpful. However, slow file system access usually happen on Window. And we'll only have large amount of `git status` when rust-lang#14981 merges and the repo contains lots of symlinks. Given symlink handling story is crazy in real world Windows, I doubt anybody will hit the performance issue without this.

rustbot assigned ehuss Dec 24, 2024

rustbot added Command-package Command-vendor S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Dec 24, 2024

weihanglo commented Dec 24, 2024

View reviewed changes

weihanglo mentioned this pull request Dec 25, 2024

refactor(package): split cargo_package to modules #14982

Merged

weihanglo force-pushed the package-symlink branch from 767408a to 451c06d Compare December 25, 2024 04:00

rustbot added the A-git Area: anything dealing with git label Dec 25, 2024

weihanglo mentioned this pull request Dec 26, 2024

feat(package): implement vcs status cache #14985

Closed

weihanglo marked this pull request as draft December 27, 2024 02:20

This comment was marked as resolved.

Sign in to view

weihanglo force-pushed the package-symlink branch from 451c06d to 19acb93 Compare December 29, 2024 06:52

weihanglo marked this pull request as ready for review December 29, 2024 16:10

weihanglo force-pushed the package-symlink branch from 19acb93 to 6baf1f5 Compare December 30, 2024 16:17

weihanglo mentioned this pull request Dec 31, 2024

fix(package): warn if symlinks checked out as plain text files #14994

Merged