Add flag to set symlink following behavior for uploading directory #591
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
go/pkg/tool/embeddedtool.go
Outdated
| @@ -119,7 +121,7 @@ var RemoteToolOperations = map[OpType]func(ctx context.Context, c *Client){ | |||
| } | |||
| }, | |||
| uploadDir: func(ctx context.Context, c *Client) { | |||
| us, err := c.UploadDirectory(ctx, getPathFlag()) | |||
| us, err := c.UploadDirectory(ctx, getPathFlag(), getSymlinkBehaviorType()) | |||
There was a problem hiding this comment.
nit: use the function you added to Command to parse the string as enum.
There was a problem hiding this comment.
Is it okay to add the dependency on command here? I didn't want to introduce a new dep unnecessarily and potentially break some boundaries. Will do!
ola-rozenfeld
approved these changes
Aug 7, 2024
mrahs
reviewed
Aug 8, 2024
go/pkg/command/command.go
Outdated
| @@ -71,6 +71,17 @@ func (s SymlinkBehaviorType) String() string { | |||
| return fmt.Sprintf("InvalidSymlinkBehaviorType(%d)", s) | |||
| } | |||
|
|
|||
| func SymlinkBehavior(s string) SymlinkBehaviorType { | |||
There was a problem hiding this comment.
Nit: the name sounds more like a type. I'd use ParseSymlinkBehavior which is akin to strconv.ParseInt. SymlinkBahaviorFromString is another reasonable name which is akin to uuid.FromString.
There was a problem hiding this comment.
Ah, I've just noticed there is already a symlinkBehaviorFromProto in this file.
|
Thank you for the PR and thank you @ola-rozenfeld for the review. |
mrahs
approved these changes
Sep 10, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
We would like to be able to use
upload_dirin a situation that makes heavy use of symlinks. However, the previous implementation did not respect symlinks and instead resulted in resolving the symlink to the actual path. This is problematic because it means that duplicated data was going to be recreated on a download.This is solved by introducing a
symlink_behaviorargument that acceptsunspecified(default),preserve, andresolvewhich map to theSymlinkBehaviorTypeenum. This allows the caller to specify how to handle symlinks and ensure that later downloads match exactly what the upload was. This also appears to reduce the data uploaded.Test