chore: add mutagen prompting gRPC

Author: ethanndickson

Diff for: Coder-Desktop/VPNLib/FileSync/FileSyncDaemon.swift

@@ -19,7 +19,7 @@ public protocol FileSyncDaemon: ObservableObject {
 
 @MainActor
 public class MutagenDaemon: FileSyncDaemon {
-    private let logger = Logger(subsystem: Bundle.main.bundleIdentifier!, category: "mutagen")
+    let logger = Logger(subsystem: Bundle.main.bundleIdentifier!, category: "mutagen")
 
     @Published public var state: DaemonState = .stopped {
         didSet {
@@ -42,9 +42,9 @@ public class MutagenDaemon: FileSyncDaemon {
     private let mutagenDaemonSocket: URL
 
     // Non-nil when the daemon is running
+    var client: DaemonClient?
     private var group: MultiThreadedEventLoopGroup?
     private var channel: GRPCChannel?
-    private var client: DaemonClient?
 
     // Protect start & stop transitions against re-entrancy
     private let transition = AsyncSemaphore(value: 1)
@@ -171,7 +171,8 @@ public class MutagenDaemon: FileSyncDaemon {
             )
             client = DaemonClient(
                 mgmt: Daemon_DaemonAsyncClient(channel: channel!),
-                sync: Synchronization_SynchronizationAsyncClient(channel: channel!)
+                sync: Synchronization_SynchronizationAsyncClient(channel: channel!),
+                prompt: Prompting_PromptingAsyncClient(channel: channel!)
             )
             logger.info(
                 "Successfully connected to mutagen daemon, socket: \(self.mutagenDaemonSocket.path, privacy: .public)"
@@ -301,6 +302,7 @@ public class MutagenDaemon: FileSyncDaemon {
 struct DaemonClient {
     let mgmt: Daemon_DaemonAsyncClient
     let sync: Synchronization_SynchronizationAsyncClient
+    let prompt: Prompting_PromptingAsyncClient
 }
 
 public enum DaemonState {
@@ -342,6 +344,8 @@ public enum DaemonError: Error {
     case connectionFailure(Error)
     case terminatedUnexpectedly
     case grpcFailure(Error)
+    case invalidGrpcResponse(String)
+    case unexpectedStreamClosure
 
     public var description: String {
         switch self {
@@ -355,6 +359,10 @@ public enum DaemonError: Error {
             "The daemon must be started first"
         case let .grpcFailure(error):
             "Failed to communicate with daemon: \(error)"
+        case let .invalidGrpcResponse(response):
+            "Invalid gRPC response: \(response)"
+        case .unexpectedStreamClosure:
+            "Unexpected stream closure"
         }
     }
 

Diff for: Coder-Desktop/VPNLib/FileSync/FileSyncPrompting.swift

@@ -0,0 +1,53 @@
+import GRPC
+
+extension MutagenDaemon {
+    typealias PromptStream = GRPCAsyncBidirectionalStreamingCall<Prompting_HostRequest, Prompting_HostResponse>
+
+    func host(allowPrompts: Bool = true) async throws(DaemonError) -> (PromptStream, identifier: String) {
+        let stream = client!.prompt.makeHostCall()
+
+        do {
+            try await stream.requestStream.send(.with { req in req.allowPrompts = allowPrompts })
+        } catch {
+            throw .grpcFailure(error)
+        }
+
+        // We can't make call `makeAsyncIterator` more than once
+        // (as a for-loop would do implicitly)
+        var iter = stream.responseStream.makeAsyncIterator()
+
+        // "Receive the initialization response, validate it, and extract the prompt identifier"
+        let initResp: Prompting_HostResponse?
+        do {
+            initResp = try await iter.next()
+        } catch {
+            throw .grpcFailure(error)
+        }
+        guard let initResp else {
+            throw .unexpectedStreamClosure
+        }
+        // TODO: we'll always accept prompts for now
+        try initResp.ensureValid(first: true, allowPrompts: allowPrompts)
+
+        Task.detached(priority: .background) {
+            do {
+                while let msg = try await iter.next() {
+                    try msg.ensureValid(first: false, allowPrompts: allowPrompts)
+                    var reply: Prompting_HostRequest = .init()
+                    if msg.isPrompt {
+                        // Handle SSH key prompts
+                        if msg.message.contains("yes/no/[fingerprint]") {
+                            reply.response = "yes"
+                        }
+                        // Any other messages that require a non-empty response will
+                        // cause the create op to fail, showing an error. This is ok for now.
+                    }
+                    try await stream.requestStream.send(reply)
+                }
+            } catch {
+                self.logger.critical("Prompt stream failed: \(error)")
+            }
+        }
+        return (stream, identifier: initResp.identifier)
+    }
+}

Diff for: Coder-Desktop/VPNLib/FileSync/MutagenConvert.swift

@@ -57,3 +57,26 @@ func accumulateErrors(from state: Synchronization_State) -> [FileSyncError] {
 func humanReadableBytes(_ bytes: UInt64) -> String {
     ByteCountFormatter().string(fromByteCount: Int64(bytes))
 }
+
+extension Prompting_HostResponse {
+    func ensureValid(first: Bool, allowPrompts: Bool) throws(DaemonError) {
+        if first {
+            if identifier.isEmpty {
+                throw .invalidGrpcResponse("empty prompter identifier")
+            }
+            if isPrompt {
+                throw .invalidGrpcResponse("unexpected message type specification")
+            }
+            if !message.isEmpty {
+                throw .invalidGrpcResponse("unexpected message")
+            }
+        } else {
+            if !identifier.isEmpty {
+                throw .invalidGrpcResponse("unexpected prompter identifier")
+            }
+            if isPrompt, !allowPrompts {
+                throw .invalidGrpcResponse("disallowed prompt message type")
+            }
+        }
+    }
+}

Diff for: Coder-Desktop/VPNLib/FileSync/MutagenSDK/service_prompting_prompting.grpc.swift

@@ -4,9 +4,9 @@
 # It is very similar to `Update-Proto.ps1` on `coder/coder-desktop-windows`.
 # It's very unlikely that we'll use this script regularly.
 #
-# Unlike the Go compiler, the Swift compiler does not support multiple files 
-# with the same name in different directories. 
-# To handle this, this script flattens the directory structure of the proto 
+# Unlike the Go compiler, the Swift compiler does not support multiple files
+# with the same name in different directories.
+# To handle this, this script flattens the directory structure of the proto
 # files into the filename, i.e. `service/synchronization/synchronization.proto`
 # becomes `service_synchronization_synchronization.proto`.
 # It also updates the proto imports to use these paths.
@@ -24,7 +24,7 @@ mutagen_tag="$1"
 repo="mutagen-io/mutagen"
 proto_prefix="pkg"
 # Right now, we only care about the synchronization and daemon management gRPC
-entry_files=("service/synchronization/synchronization.proto" "service/daemon/daemon.proto")
+entry_files=("service/synchronization/synchronization.proto" "service/daemon/daemon.proto" "service/prompting/prompting.proto")
 
 out_folder="Coder-Desktop/VPNLib/FileSync/MutagenSDK"
 
@@ -33,7 +33,7 @@ if [ -d "$clone_dir" ]; then
     echo "Found existing mutagen repo at $clone_dir, checking out $mutagen_tag..."
     pushd "$clone_dir" > /dev/null
     git clean -fdx
-    
+
     current_tag=$(git name-rev --name-only HEAD)
     if [ "$current_tag" != "tags/$mutagen_tag" ]; then
         git fetch --all
@@ -62,27 +62,27 @@ add_file() {
     local proto_path="${filepath#"$clone_dir"/"$proto_prefix"/}"
     local flat_name
     flat_name=$(echo "$proto_path" | sed 's/\//_/g')
-    
+
     # Skip if already processed
     if [[ -n "${file_map[$proto_path]:-}" ]]; then
         return
     fi
-    
+
     echo "Adding $proto_path -> $flat_name"
     file_map[$proto_path]=$flat_name
     file_paths+=("$filepath")
-    
+
     # Process imports
     while IFS= read -r line; do
         if [[ $line =~ ^import\ \"(.+)\" ]]; then
             import_path="${BASH_REMATCH[1]}"
-            
+
             # Ignore google imports, as they're not vendored
             if [[ $import_path =~ ^google/ ]]; then
                 echo "Skipping $import_path"
                 continue
             fi
-            
+
             import_file_path="$clone_dir/$proto_prefix/$import_path"
             if [ -f "$import_file_path" ]; then
                 add_file "$import_file_path"
@@ -109,24 +109,24 @@ for file_path in "${file_paths[@]}"; do
     proto_path="${file_path#"$clone_dir"/"$proto_prefix"/}"
     flat_name="${file_map[$proto_path]}"
     dst_path="$out_folder/$flat_name"
-    
+
     cp -f "$file_path" "$dst_path"
-    
+
     file_header="/*\n * This file was taken from\n * https://github.com/$repo/tree/$mutagen_tag/$proto_prefix/$proto_path\n *\n$license_header\n */\n\n"
     content=$(cat "$dst_path")
     echo -e "$file_header$content" > "$dst_path"
-    
+
     tmp_file=$(mktemp)
     while IFS= read -r line; do
         if [[ $line =~ ^import\ \"(.+)\" ]]; then
             import_path="${BASH_REMATCH[1]}"
-            
+
             # Retain google imports
             if [[ $import_path =~ ^google/ ]]; then
                 echo "$line" >> "$tmp_file"
                 continue
             fi
-            
+
             # Convert import path to flattened format
             flat_import=$(echo "$import_path" | sed 's/\//_/g')
             echo "import \"$flat_import\";" >> "$tmp_file"
@@ -135,7 +135,7 @@ for file_path in "${file_paths[@]}"; do
         fi
     done < "$dst_path"
     mv "$tmp_file" "$dst_path"
-    
+
     echo "Processed $proto_path -> $flat_name"
 done