chore: manage mutagen daemon lifecycle #98
Conversation
This stack of pull requests is managed by Graphite. Learn more about stacking. |
ethanndickson
force-pushed
the
ethan/mutagen-lifecycle
branch
from
6f638fd to
e9fa904
Compare
| import NetworkExtension | ||
| import SwiftUI | ||
|
|
||
| @MainActor |
There was a problem hiding this comment.
drive-by fix: I believe this is implicit in the ObservableObject conformance, but can't hurt to make it explicit.
| } | ||
|
|
||
| @MainActor | ||
| class MutagenDaemon: FileSyncDaemon { |
There was a problem hiding this comment.
Open to suggestions on how to test this. We can easily mock the gRPC calls, but mocking the child process is ???.
I've just done a good amount of manual testing for now.
| // Stop an orphaned daemon, if there is one | ||
| try? await connect() | ||
| try? await stop() |
There was a problem hiding this comment.
For context, mutagen daemon run acquires a file lock in the MUTAGEN_DATA_DIRECTORY. Multiple instances of the daemon will fail to start, so we need to make sure one isn't running before we start ours. If, for whatever reason, we were unable to kill the daemon, the new one will immediately fail and change the DaemonState.
| @@ -0,0 +1,11 @@ | |||
| syntax = "proto3"; | |||
There was a problem hiding this comment.
QQ: Haven't seen a discussion before, but have we considered using the edition2023 version instead of proto3?
ethanndickson
force-pushed
the
ethan/mutagen-lifecycle
branch
from
a013cde to
3384471
Compare
ethanndickson
force-pushed
the
ethan/mutagen-lifecycle
branch
from
3384471 to
7f92c54
Compare
ethanndickson
requested review from
ThomasK33 and
spikecurtis
and removed request for
deansheather
ethanndickson
force-pushed
the
ethan/mutagen-lifecycle
branch
from
1d0a6e1 to
ad1b24d
Compare
This makes a few improvements to #98: - The mutagen path & data directory can be now be configured on the MutagenDaemon, to support overriding it in tests (coming soon). - A mutagen daemon failure now kills the process, such that can it be restarted (TBC). - Makes start & stop transitions mutually exclusive via a semaphore, to account for actor re-entrancy. - The start operation now waits for the daemon to respond to a version request before completing. - The daemon is always started on launch, but then immediately stopped if it doesn't manage any file sync sessions, as to not run in the background unncessarily.
2 participants
Closes coder/internal#381.
VPNfolder.Resourcesfolder whose contents are copied into the bundle at build time.MutagenDaemonabstraction for managing the mutagen daemon lifecycle, this class:mutagen daemon run, with aMUTAGEN_DATA_DIRECTORYinApplication Support/Coder Desktop/Mutagen, to avoid collisions with a system mutagen using~/.mutagen.gRPCconnection to the daemon socket.gRPCmutagen daemon runprocess if one exists.This PR does not embed the mutagen binaries within the bundle, it just handles the case where they're present.
Why is the file sync code in VPNLib?
When I had the FileSync code (namely protobuf definitions) in either:
FSLibframework targetEither the network extension crashed (in the first case) or the app crashed (in the second case) on launch.
The crash was super obtuse:
especially considering
SwiftProtobufdoesn't have a stable ABI and shouldn't be compiled as a framework.At least one other person has ran into this issue when importing
SwiftProtobufmultiple times:apple/swift-protobuf#1506 (comment)
Curiously, this also wasn't happening on local development builds (building and running via the XCode GUI), only when exporting via our build script.
Solution
We're just going to overload
VPNLibas the source of all our SwiftProtobuf & GRPC code. Since it's pretty big, and we don't want to embed it twice, we'll embed it once within the System Extension, and then have the app look for it in that bundle, seeLD_RUNPATH_SEARCH_PATHS. It's not exactly ideal, but I don't think it's worth going to war with XCode over.TODO
Processwith https://github.com/jamf/Subprocess