store lock files in temporary directory #273
Merged
Conversation
This file contains hidden or 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
motivation: local file system store lock files next to the file being locked and never cleans them up changes: * add a tempDirectory to FileSystem protocol * update determineTempDirectory to use tempDirectory from localFileSystem * move logic to handle local file system locks to FileLock and call it from localFileSystem * expose an API on FileLock to create local file system locks, which by default uses the temp directory to store lock files, using the file-to-lock path and name to construct the lock file name * move local file system lock logic to use the new FileLock API * add tests rdar://86644116
tomerd
requested review from
abertelrud,
aciidgh,
friedbunny and
neonichu
as code owners
|
swiftlang/swift-package-manager#3962 @swift-ci please test |
jakepetroules
approved these changes
Dec 22, 2021
tomerd
added
the
ready
abertelrud
approved these changes
Dec 22, 2021
abertelrud
reviewed
Dec 22, 2021
| throw FileSystemError(.notDirectory, lockFilesDirectory) | ||
| } | ||
| // use the parent path to generate unique filename in temp | ||
| var lockFileName = (resolveSymlinks(fileToLock.parentDirectory).appending(component: fileToLock.basename)).components.joined(separator: "_") |
There was a problem hiding this comment.
There's somewhat of a risk of overflow here since most operating systems / file systems have a much shorter file name limit than path limit. I don't know if that will be an issue in practice — an alternate approach to consider here might be to hash all the but the last n components of the path, which should still be indicative of what the lock file refers to.
There was a problem hiding this comment.
we can also re-root the path into temp a potential solution. would that be better than what we have here now?
tomerd
added a commit
to tomerd/swift-tools-support-core
that referenced
this pull request
Dec 23, 2021
motivation: local file system store lock files next to the file being locked and never cleans them up changes: * add a tempDirectory to FileSystem protocol * update determineTempDirectory to use tempDirectory from localFileSystem * move logic to handle local file system locks to FileLock and call it from localFileSystem * expose an API on FileLock to create local file system locks, which by default uses the temp directory to store lock files, using the file-to-lock path and name to construct the lock file name * move local file system lock logic to use the new FileLock API * add tests rdar://86644116
tomerd
added a commit
that referenced
this pull request
Dec 23, 2021
motivation: local file system store lock files next to the file being locked and never cleans them up changes: * add a tempDirectory to FileSystem protocol * update determineTempDirectory to use tempDirectory from localFileSystem * move logic to handle local file system locks to FileLock and call it from localFileSystem * expose an API on FileLock to create local file system locks, which by default uses the temp directory to store lock files, using the file-to-lock path and name to construct the lock file name * move local file system lock logic to use the new FileLock API * add tests rdar://86644116
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.
motivation: local file system store lock files next to the file being locked and never cleans them up
changes:
rdar://86644116