Skip to content

Conversation

@MatejKafka
Copy link
Contributor

PR Summary

Fixes #15235.

PR Context

As described in the linked issue, the current implementation of symlink creation in the filesystem provider resolves relative symlink target paths relative to the working directory, instead of the location of the symlink. This PR fixes the issue by always resolving the path relative to the symlink. Additionally, since Path.Combine is used now, the path should be correctly resolved even if it does not start with ./ or .\, which is currently not the case.

It should be possible to add tests for this, but from a cursory look, there don't seem to by any tests of the filesystem provider touching the filesystem, so I did not add any.

PR Checklist

@pull-request-quantifier-deprecated

This PR has 5 quantified lines of changes. In general, a change size of upto 200 lines is ideal for the best PR experience!


Quantification details

Label      : Extra Small
Size       : +1 -4
Percentile : 2%

Total files changed: 1

Change summary by file extension:
.cs : +1 -4

Change counts above are quantified counts, based on the PullRequestQuantifier customizations.

Why proper sizing of changes matters

Optimal pull request sizes drive a better predictable PR flow as they strike a
balance between between PR complexity and PR review overhead. PRs within the
optimal size (typical small, or medium sized PRs) mean:

  • Fast and predictable releases to production:
    • Optimal size changes are more likely to be reviewed faster with fewer
      iterations.
    • Similarity in low PR complexity drives similar review times.
  • Review quality is likely higher as complexity is lower:
    • Bugs are more likely to be detected.
    • Code inconsistencies are more likely to be detected.
  • Knowledge sharing is improved within the participants:
    • Small portions can be assimilated better.
  • Better engineering practices are exercised:
    • Solving big problems by dividing them in well contained, smaller problems.
    • Exercising separation of concerns within the code changes.

What can I do to optimize my changes

  • Use the PullRequestQuantifier to quantify your PR accurately
    • Create a context profile for your repo using the context generator
    • Exclude files that are not necessary to be reviewed or do not increase the review complexity. Example: Autogenerated code, docs, project IDE setting files, binaries, etc. Check out the Excluded section from your prquantifier.yaml context profile.
    • Understand your typical change complexity, drive towards the desired complexity by adjusting the label mapping in your prquantifier.yaml context profile.
    • Only use the labels that matter to you, see context specification to customize your prquantifier.yaml context profile.
  • Change your engineering behaviors
    • For PRs that fall outside of the desired spectrum, review the details and check if:
      • Your PR could be split in smaller, self-contained PRs instead
      • Your PR only solves one particular issue. (For example, don't refactor and code new features in the same PR).

How to interpret the change counts in git diff output

  • One line was added: +1 -0
  • One line was deleted: +0 -1
  • One line was modified: +1 -1 (git diff doesn't know about modified, it will
    interpret that line like one addition plus one deletion)
  • Change percentiles: Change characteristics (addition, deletion, modification)
    of this PR in relation to all other PRs within the repository.


Was this comment helpful? 👍  :ok_hand:  :thumbsdown: (Email)
Customize PullRequestQuantifier for this repository.

@microsoft-github-policy-service microsoft-github-policy-service bot added the Review - Needed The PR is being reviewed label Dec 25, 2023
@MatejKafka
Copy link
Contributor Author

MatejKafka commented Apr 6, 2024

So, um, is there a chance of anyone looking at this PR? It's been almost 4 months now without any response.

@MatejKafka MatejKafka force-pushed the symlink-resolution branch from 18a2e31 to c6b9cea Compare April 8, 2024 16:07
@MatejKafka
Copy link
Contributor Author

@SteveL-MSFT Apologies for pinging, but since @anmenaga, who is assigned, did not review the PR during the past 4 months, do you think you could review it instead?

@MatejKafka MatejKafka force-pushed the symlink-resolution branch from c6b9cea to f6697ba Compare May 13, 2024 14:07
@SteveL-MSFT
Copy link
Member

@MatejKafka sorry, I'm reviewing this now

@microsoft-github-policy-service microsoft-github-policy-service bot removed the Review - Needed The PR is being reviewed label May 13, 2024
Copy link
Member

@SteveL-MSFT SteveL-MSFT left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@microsoft-github-policy-service microsoft-github-policy-service bot added Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept and removed Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept labels May 13, 2024
@MatejKafka
Copy link
Contributor Author

@SteveL-MSFT Done.

@MatejKafka MatejKafka requested a review from SteveL-MSFT May 18, 2024 12:35
@microsoft-github-policy-service microsoft-github-policy-service bot added the Review - Needed The PR is being reviewed label May 25, 2024
@JordanPavlic
Copy link

@SteveL-MSFT @anmenaga - can someone please review this? This has been an issue for years and I ran into this issue today.

@microsoft-github-policy-service microsoft-github-policy-service bot added Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept and removed Review - Needed The PR is being reviewed Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept labels Nov 22, 2024
Copy link
Member

@SteveL-MSFT SteveL-MSFT left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Comment on lines 2261 to 2267
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When the user specified target path is like ./dir or .\dir, the value returned from Path.Combine would be like <sym-dir-path>{directory-separator}./dir or <sym-dir-path>{directory-separator}.\dir. This may not be a problem on Windows (which I'm not certain), but on Unix platform, a path like /home/user-a/.\temp cannot be resolved to /home/user-a/temp.

image

So, I think we should still remove the .\ or ./ prefix for a relative path.

Also, do we want to normalize directory separators used in the -Target? I mean, if user specifies .\subdir\dir on Linux, shall we normalize that to be ./subdir/dir?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, do we want to normalize directory separators used in the -Target? I mean, if user specifies .\subdir\dir on Linux, shall we normalize that to be ./subdir/dir?

There are already issues with path normalization on Unix since \ is valid char there. I think we shouldn't add one more.

Copy link
Contributor Author

@MatejKafka MatejKafka Nov 26, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the review, these are both good observations.

Just writing down my thoughts for the implementation:

  • The path to the symlink is passed already resolved and pre-processed, but the -Target/-Value is passed as-is, since the previous layers don't know how it's used.
  • PowerShell supports both \ and / as directory separators on all platforms. Therefore, we should convert separators for the value that we store in the symlink target to match what rest of the shell does. This will prevent the user from symlinking to paths that contain \ on Linux/Mac, but imo that ship has sailed when PowerShell Core went with emulating \ and consistency with the rest of PowerShell is now more important than allowing the user to create symlinks to files that they cannot create through PowerShell anyway.
  • Personally, I wouldn't do any other processing on -Target. Don't see any reason to remove .//.\, since they should work fine as long as the separators are correct.
  • Since the file/directory distinction for symlinks is not a thing on Linux/Mac, we could just remove the whole logic around looking up the target and only use it on Windows. However, we return either FileInfo or DirectoryInfo from the command, so we need to know the type of the target anyway.
  • While looking at the implementation, I noticed that when creating a hardlink, we make -Target relative to the current working directory. With the change implemented in this PR, this will be inconsistent with symlinks. Is that a problem? Shouldn't we also change hardlink creation to be consistent?

What needs to be implemented:

  • unify slashes in -Target to the correct platform-specific separator before resolving the target

@daxian-dbw Do you agree?

Copy link
Contributor

@God-damnit-all God-damnit-all Nov 26, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • Personally, I wouldn't do any other processing on -Target. Don't see any reason to remove .//.\, since they should work fine as long as the separators are correct.

That's actually always annoyed the hell out of me to the point I manually remove them. I use ln.exe, which exposes the target via GUI.

I'd really appreciate if those were removed.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@God-damnit-all In that case, just don't pass paths with ./ as -Target. Other people may have the opposite preference, and since both options behave identically in practice, I don't see any reason to force one or the other.

@microsoft-github-policy-service microsoft-github-policy-service bot added Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept and removed Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept labels Nov 23, 2024
@MatejKafka
Copy link
Contributor Author

@daxian-dbw Fixed in latest commit. Please re-review.

Copy link
Member

@daxian-dbw daxian-dbw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me. Thanks @MatejKafka!

@daxian-dbw daxian-dbw merged commit b18eaca into PowerShell:master Dec 3, 2024
37 checks passed
@daxian-dbw daxian-dbw added the CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log label Dec 3, 2024
@MatejKafka MatejKafka deleted the symlink-resolution branch December 3, 2024 23:11
@jshigetomi jshigetomi mentioned this pull request Dec 12, 2024
21 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log Extra Small

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Target type detection (file/directory) for relative symlinks is still broken, even on Windows

6 participants