- Notifications
You must be signed in to change notification settings - Fork5
chore: manage mutagen daemon lifecycle#98
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
Uh oh!
There was an error while loading.Please reload this page.
Merged
Changes fromall commits
Commits
Show all changes
18 commits Select commitHold shift + click to select a range
0f362f8 chore: manage mutagen daemon lifecycle
ethanndickson513ccd8 handle missing mutagen
ethanndickson3291e73 fixup
ethanndickson9be6173 gitkeep resources
ethanndicksonb0cbab8 fixup
ethanndicksonebcadbe only import swiftprotobuf in vpnlib to debug runtime crash
ethanndickson5ed3893 extract to seperate lib
ethanndicksonc1947aa move back to vpnlib
ethanndicksonb13a44f remove duplicate framework
ethanndicksonc9cba6d logging
ethanndickson2b673b8 review
ethanndickson76abed5 error handling
ethanndicksonf2fc365 log privacy
ethanndickson21bb169 fixup
ethanndickson2bf41aa fixup
ethanndickson16a7263 process -> subprocess package
ethanndickson382fd9b use async let
ethanndicksonad1b24d fixup
ethanndicksonFile filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
4 changes: 4 additions & 0 deletions.swiftlint.yml
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| # TODO: Remove this once the grpc-swift-protobuf generator adds a lint disable comment | ||
| excluded: | ||
| - "**/*.pb.swift" | ||
| - "**/*.grpc.swift" |
2 changes: 1 addition & 1 deletionCoder Desktop/.swiftformat
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,3 @@ | ||
| --selfrequired log,info,error,debug,critical,fault | ||
| --exclude **.pb.swift,**.grpc.swift | ||
| --condassignment always |
16 changes: 14 additions & 2 deletionsCoder Desktop/Coder Desktop/Coder_DesktopApp.swift
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
1 change: 1 addition & 0 deletionsCoder Desktop/Coder Desktop/State.swift
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -4,6 +4,7 @@ import KeychainAccess | ||
| import NetworkExtension | ||
| import SwiftUI | ||
| @MainActor | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. drive-by fix: I believe this is implicit in the | ||
| class AppState: ObservableObject { | ||
| let appId = Bundle.main.bundleIdentifier! | ||
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Empty file addedCoder Desktop/Resources/.gitkeep
Empty file.
225 changes: 225 additions & 0 deletionsCoder Desktop/VPNLib/FileSync/FileSyncDaemon.swift
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,225 @@ | ||
| import Foundation | ||
| import GRPC | ||
| import NIO | ||
| import os | ||
| import Subprocess | ||
| @MainActor | ||
| publicprotocolFileSyncDaemon:ObservableObject{ | ||
| varstate:DaemonState{get} | ||
| func start()async | ||
| func stop()async | ||
| } | ||
| @MainActor | ||
| publicclassMutagenDaemon:FileSyncDaemon{ | ||
| privateletlogger=Logger(subsystem:Bundle.main.bundleIdentifier!, category:"mutagen") | ||
| @Publishedpublicvarstate:DaemonState=.stopped{ | ||
| didSet{ | ||
| logger.info("daemon state changed:\(self.state.description, privacy:.public)") | ||
| } | ||
| } | ||
| privatevarmutagenProcess:Subprocess? | ||
| privateletmutagenPath:URL! | ||
| privateletmutagenDataDirectory:URL | ||
| privateletmutagenDaemonSocket:URL | ||
| privatevargroup:MultiThreadedEventLoopGroup? | ||
| privatevarchannel:GRPCChannel? | ||
| privatevarclient:Daemon_DaemonAsyncClient? | ||
| publicinit(){ | ||
| #if arch(arm64) | ||
| mutagenPath=Bundle.main.url(forResource:"mutagen-darwin-arm64", withExtension:nil) | ||
| #elseif arch(x86_64) | ||
| mutagenPath=Bundle.main.url(forResource:"mutagen-darwin-amd64", withExtension:nil) | ||
| #else | ||
| fatalError("unknown architecture") | ||
| #endif | ||
| mutagenDataDirectory=FileManager.default.urls( | ||
| for:.applicationSupportDirectory, | ||
| in:.userDomainMask | ||
| ).first!.appending(path:"Coder Desktop").appending(path:"Mutagen") | ||
| mutagenDaemonSocket= mutagenDataDirectory.appending(path:"daemon").appending(path:"daemon.sock") | ||
| // It shouldn't be fatal if the app was built without Mutagen embedded, | ||
| // but file sync will be unavailable. | ||
| if mutagenPath==nil{ | ||
| logger.warning("Mutagen not embedded in app, file sync will be unavailable") | ||
| state=.unavailable | ||
| } | ||
| } | ||
| publicfunc start()async{ | ||
| if case.unavailable= state{return} | ||
ThomasK33 marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| // Stop an orphaned daemon, if there is one | ||
| try?awaitconnect() | ||
| awaitstop() | ||
| mutagenProcess=createMutagenProcess() | ||
| // swiftlint:disable:next large_tuple | ||
| let(standardOutput, standardError, waitForExit):(Pipe.AsyncBytes,Pipe.AsyncBytes,@Sendable()async->Void) | ||
| do{ | ||
| (standardOutput, standardError, waitForExit)=try mutagenProcess!.run() | ||
| }catch{ | ||
| state=.failed(DaemonError.daemonStartFailure(error)) | ||
| return | ||
| } | ||
| Task{ | ||
| awaitstreamHandler(io: standardOutput) | ||
| logger.info("standard output stream closed") | ||
| } | ||
| Task{ | ||
| awaitstreamHandler(io: standardError) | ||
| logger.info("standard error stream closed") | ||
| } | ||
| Task{ | ||
| awaitterminationHandler(waitForExit: waitForExit) | ||
| } | ||
| do{ | ||
| tryawaitconnect() | ||
| }catch{ | ||
| state=.failed(DaemonError.daemonStartFailure(error)) | ||
| return | ||
| } | ||
| state=.running | ||
| logger.info( | ||
| """ | ||
| mutagen daemon started, pid: | ||
| \(self.mutagenProcess?.pid.description??"unknown", privacy:.public) | ||
| """ | ||
| ) | ||
| } | ||
| privatefunc connect()asyncthrows(DaemonError){ | ||
| guard client==nilelse{ | ||
| // Already connected | ||
| return | ||
| } | ||
| group=MultiThreadedEventLoopGroup(numberOfThreads:1) | ||
| do{ | ||
| channel=tryGRPCChannelPool.with( | ||
| target:.unixDomainSocket(mutagenDaemonSocket.path), | ||
| transportSecurity:.plaintext, | ||
| eventLoopGroup: group! | ||
| ) | ||
| client=Daemon_DaemonAsyncClient(channel: channel!) | ||
| logger.info( | ||
| "Successfully connected to mutagen daemon, socket:\(self.mutagenDaemonSocket.path, privacy:.public)" | ||
| ) | ||
| }catch{ | ||
| logger.error("Failed to connect to gRPC:\(error)") | ||
| try?awaitcleanupGRPC() | ||
| throwDaemonError.connectionFailure(error) | ||
| } | ||
| } | ||
| privatefunc cleanupGRPC()asyncthrows{ | ||
| try?await channel?.close().get() | ||
| try?await group?.shutdownGracefully() | ||
| client=nil | ||
| channel=nil | ||
| group=nil | ||
| } | ||
| publicfunc stop()async{ | ||
| if case.unavailable= state{return} | ||
| state=.stopped | ||
| guardFileManager.default.fileExists(atPath: mutagenDaemonSocket.path)else{ | ||
| // Already stopped | ||
| return | ||
| } | ||
| // "We don't check the response or error, because the daemon | ||
| // may terminate before it has a chance to send the response." | ||
| _=try?await client?.terminate( | ||
| Daemon_TerminateRequest(), | ||
| callOptions:.init(timeLimit:.timeout(.milliseconds(500))) | ||
| ) | ||
| try?awaitcleanupGRPC() | ||
| mutagenProcess?.kill() | ||
| mutagenProcess=nil | ||
| logger.info("Daemon stopped and gRPC connection closed") | ||
| } | ||
| privatefunc createMutagenProcess()->Subprocess{ | ||
| letprocess=Subprocess([mutagenPath.path,"daemon","run"]) | ||
| process.environment=[ | ||
| "MUTAGEN_DATA_DIRECTORY": mutagenDataDirectory.path, | ||
| ] | ||
| logger.info("setting mutagen data directory:\(self.mutagenDataDirectory.path, privacy:.public)") | ||
| return process | ||
| } | ||
| privatefunc terminationHandler(waitForExit:@Sendable()async->Void)async{ | ||
| awaitwaitForExit() | ||
| switch state{ | ||
| case.stopped: | ||
| logger.info("mutagen daemon stopped") | ||
| default: | ||
| logger.error( | ||
| """ | ||
| mutagen daemon exited unexpectedly with code: | ||
| \(self.mutagenProcess?.exitCode.description??"unknown") | ||
| """ | ||
| ) | ||
| state=.failed(.terminatedUnexpectedly) | ||
| } | ||
| } | ||
| privatefunc streamHandler(io:Pipe.AsyncBytes)async{ | ||
| forawaitlinein io.lines{ | ||
| logger.info("\(line, privacy:.public)") | ||
| } | ||
| } | ||
| } | ||
| publicenumDaemonState{ | ||
| case running | ||
| case stopped | ||
| case failed(DaemonError) | ||
| case unavailable | ||
| vardescription:String{ | ||
| switchself{ | ||
| case.running: | ||
| "Running" | ||
| case.stopped: | ||
| "Stopped" | ||
| caselet.failed(error): | ||
| "Failed:\(error)" | ||
| case.unavailable: | ||
| "Unavailable" | ||
| } | ||
| } | ||
| } | ||
| publicenumDaemonError:Error{ | ||
| case daemonStartFailure(Error) | ||
| case connectionFailure(Error) | ||
| case terminatedUnexpectedly | ||
| vardescription:String{ | ||
| switchself{ | ||
| caselet.daemonStartFailure(error): | ||
| "Daemon start failure:\(error)" | ||
| caselet.connectionFailure(error): | ||
| "Connection failure:\(error)" | ||
| case.terminatedUnexpectedly: | ||
| "Daemon terminated unexpectedly" | ||
| } | ||
| } | ||
| varlocalizedDescription:String{ description} | ||
| } | ||
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
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.