Adding FileLock #361
Adding FileLock #361
Conversation
roulpriya
force-pushed
the
implement-filelock
branch
from
e3cc983 to
e55967c
Compare
roulpriya
force-pushed
the
implement-filelock
branch
from
1ad88a3 to
e5a6c8b
Compare
roulpriya
requested review from
shahmishal,
justice-adams-apple and
etcwilde
as code owners
|
@swift-ci test macOS |
roulpriya
force-pushed
the
implement-filelock
branch
from
48e6ef7 to
b410967
Compare
Sources/SwiftlyCore/FileLock.swift
Outdated
| self.filePath = path | ||
| do { | ||
| let fileURL = URL(fileURLWithPath: self.filePath.string) | ||
| let contents = getpid().description.data(using: .utf8) ?? Data() |
There was a problem hiding this comment.
Can you use https://developer.apple.com/documentation/foundation/processinfo/processidentifier instead of getpid()? One fewer obstacle towards getting swiftly to work on Windows.
There was a problem hiding this comment.
Refactored @jakepetroules
roulpriya
force-pushed
the
implement-filelock
branch
from
b410967 to
689434a
Compare
|
@swift-ci test macOS |
roulpriya
force-pushed
the
implement-filelock
branch
from
ea8e37a to
858ec90
Compare
|
@swift-ci test macOS |
roulpriya
force-pushed
the
implement-filelock
branch
3 times, most recently
from
4359607 to
4ff4945
Compare
|
@swift-ci test macOS |
Sources/SwiftlyCore/FileLock.swift
Outdated
| var localizedDescription: String { | ||
| switch self { | ||
| case let .cannotAcquireLock(path): | ||
| return "Cannot acquire lock at \(path). Another process may be holding the lock." |
There was a problem hiding this comment.
suggestion (non-blocking): You can turn this into an actionable error by indicating that the user can remove the file if they are sure that there are no other processes running with the lock.
roulpriya
force-pushed
the
implement-filelock
branch
2 times, most recently
from
acb796a to
f4c28a4
Compare
|
@swift-ci test macOS |
| var errorDescription: String? { | ||
| switch self { | ||
| case let .cannotAcquireLock(path): | ||
| return "Cannot acquire lock at \(path). Another process may be holding the lock. If you are sure no other processes are running, you can manually remove the lock file at \(path)." |
There was a problem hiding this comment.
nitpick: The path is mentioned twice in the error message when it is probably only needed once.
Sources/SwiftlyCore/FileLock.swift
Outdated
| } | ||
| } | ||
|
|
||
| // Timeout reached, throw an error |
There was a problem hiding this comment.
thought: This check to reconstruct the error may not be needed if you keep the last error, or use the Swift Result I linked above. It's fine as it is though.
|
|
||
| @Suite struct FileLockTests { | ||
| @Test("FileLock creation writes process ID to lock file") | ||
| func testFileLockCreation() async throws { |
There was a problem hiding this comment.
praise: These are really good unit tests: simple, and reliable. Sometimes lock testing tries to simulate race conditions, which can sacrifice reliability of the test.
roulpriya
force-pushed
the
implement-filelock
branch
from
f4c28a4 to
20d1898
Compare
roulpriya
force-pushed
the
implement-filelock
branch
from
20d1898 to
cdf027a
Compare
|
@swift-ci test macOS |
Fixes Issue #142
Serialize concurrent swiftly install commands with a simple file lock.
Adds a lightweight FileLock (using
Data.write(to: fileURL, options: .withoutOverwriting)) and wraps the install routine so only one process installs at a time