Use one-off Shells, Test with All Supported Shells

Author: thecoolwinter

CodeEdit/Features/Tasks/Models/CEActiveTask.swift

@@ -44,14 +44,15 @@ class CEActiveTask: ObservableObject, Identifiable, Hashable {
     }
 
     @MainActor
-    func run(workspaceURL: URL?) {
+    func run(workspaceURL: URL?, shell: Shell? = nil) {
         self.workspaceURL = workspaceURL
         self.activeTaskID = UUID() // generate a new ID for this run
 
         createStatusTaskNotification()
+        updateTaskStatus(to: .running)
 
         let view = output ?? CEActiveTaskTerminalView(activeTask: self)
-        view.startProcess(workspaceURL: workspaceURL, shell: nil)
+        view.startProcess(workspaceURL: workspaceURL, shell: shell)
 
         output = view
     }
@@ -107,35 +108,35 @@ class CEActiveTask: ObservableObject, Identifiable, Hashable {
 
     @MainActor
     func suspend() {
-        if let groupPID = output?.getProcessGroup(), status == .running {
-            kill(groupPID, SIGSTOP)
+        if let shellPID = output?.runningPID(), status == .running {
+            kill(shellPID, SIGSTOP)
             updateTaskStatus(to: .stopped)
         }
     }
 
     @MainActor
     func resume() {
-        if let groupPID = output?.getProcessGroup(), status == .running {
-            kill(groupPID, SIGCONT)
+        if let shellPID = output?.runningPID(), status == .running {
+            kill(shellPID, SIGCONT)
             updateTaskStatus(to: .running)
         }
     }
 
     func terminate() {
-        if let groupPID = output?.getProcessGroup() {
-            kill(groupPID, SIGTERM)
+        if let shellPID = output?.runningPID() {
+            kill(shellPID, SIGTERM)
         }
     }
 
     func interrupt() {
-        if let groupPID = output?.getProcessGroup() {
-            kill(groupPID, SIGINT)
+        if let shellPID = output?.runningPID() {
+            kill(shellPID, SIGINT)
         }
     }
 
     func waitForExit() {
-        if let groupPID = output?.getProcessGroup() {
-            waitid(P_PGID, UInt32(groupPID), nil, 0)
+        if let shellPID = output?.runningPID() {
+            waitid(P_PGID, UInt32(shellPID), nil, 0)
         }
     }
 

CodeEdit/Features/TerminalEmulator/Model/Shell.swift

@@ -28,56 +28,6 @@ enum Shell: String, CaseIterable {
         }
     }
 
-    /// Executes a shell command using a specified shell, with optional environment variables.
-    ///
-    /// - Parameters:
-    ///   - process: The `Process` instance to be configured and run.
-    ///   - command: The shell command to execute.
-    ///   - environmentVariables: A dictionary of environment variables to set for the process. Default is `nil`.
-    ///   - shell: The shell to use for executing the command. Default is `.bash`.
-    ///   - outputPipe: The `Pipe` instance to capture standard output and standard error.
-    /// - Throws: An error if the process fails to run.
-    ///
-    /// ### Example
-    /// ```swift
-    /// let process = Process()
-    /// let outputPipe = Pipe()
-    /// try executeCommandWithShell(
-    ///     process: process,
-    ///     command: "echo 'Hello, World!'",
-    ///     environmentVariables: ["PATH": "/usr/bin"],
-    ///     shell: .bash,
-    ///     outputPipe: outputPipe
-    /// )
-    /// let outputData = outputPipe.fileHandleForReading.readDataToEndOfFile()
-    /// let outputString = String(data: outputData, encoding: .utf8)
-    /// print(outputString) // Output: "Hello, World!"
-    /// ```
-    public static func executeCommandWithShell(
-        process: Process,
-        command: String,
-        environmentVariables: [String: String]? = nil,
-        shell: Shell = .bash,
-        outputPipe: Pipe
-    ) throws {
-        // Setup envs'
-        process.environment = environmentVariables
-        // Set the executable to bash
-        process.executableURL = URL(fileURLWithPath: shell.url)
-
-        // Pass the command as an argument
-        // `--login` argument is needed when using a shell with a process in Swift to ensure
-        // that the shell loads the user's profile settings (like .bash_profile or .profile),
-        // which configure the environment variables and other shell settings.
-        process.arguments = ["--login", "-c", command]
-
-        process.standardOutput = outputPipe
-        process.standardError = outputPipe
-
-        // Run the process
-        try process.run()
-    }
-
     var defaultPath: String {
         switch self {
         case .bash:
@@ -86,6 +36,28 @@ enum Shell: String, CaseIterable {
             "/bin/zsh"
         }
     }
+    
+    /// Create the exec arguments for a new shell with the given behavior.
+    /// - Parameters:
+    ///   - interactive: The shell is interactive, accepts user input.
+    ///   - login: A login shell.
+    /// - Returns: The argument string.
+    func execArguments(interactive: Bool, login: Bool) -> String? {
+        var args = ""
+
+        switch self {
+        case .bash, .zsh:
+            if interactive {
+                args.append("i")
+            }
+
+            if login {
+                args.append("l")
+            }
+        }
+
+        return args.isEmpty ? nil : "-" + args
+    }
 
     /// Gets the default shell from the current user and returns the string of the shell path.
     ///

CodeEdit/Features/TerminalEmulator/Model/ShellIntegration.swift

@@ -65,11 +65,15 @@ enum ShellIntegration {
             // Enable injection in our scripts.
             environment.append("\(Variables.ceInjection)=1")
 
+            if let execArgs = shell.execArguments(interactive: interactive, login: useLogin) {
+                args.append(execArgs)
+            }
+
             switch shell {
             case .bash:
-                try bash(&args, interactive)
+                try bash(&args)
             case .zsh:
-                try zsh(&args, &environment, useLogin, interactive)
+                try zsh(&args, &environment)
             }
 
             if useLogin {
@@ -95,7 +99,7 @@ enum ShellIntegration {
     /// - Parameters:
     ///   - args: The args to use for shell exec, will be modified by this function.
     ///   - interactive: Set to true to use an interactive shell.
-    private static func bash(_ args: inout [String], _ interactive: Bool) throws {
+    private static func bash(_ args: inout [String]) throws {
         // Inject our own bash script that will execute the user's init files, then install our pre/post exec functions.
         guard let scriptURL = Bundle.main.url(
             forResource: "codeedit_shell_integration",
@@ -104,9 +108,6 @@ enum ShellIntegration {
             throw Error.bashShellFileNotFound
         }
         args.append(contentsOf: ["--init-file", scriptURL.path()])
-        if interactive {
-            args.append("-i")
-        }
     }
 
     /// Sets up the `zsh` shell integration.
@@ -125,22 +126,8 @@ enum ShellIntegration {
     ///   - interactive: Whether to use an interactive shell.
     private static func zsh(
         _ args: inout [String],
-        _ environment: inout [String],
-        _ useLogin: Bool,
-        _ interactive: Bool
+        _ environment: inout [String]
     ) throws {
-        // Interactive, login shell.
-        switch (useLogin, interactive) {
-        case (true, true):
-            args.append("-il")
-        case (false, true):
-            args.append("-i")
-        case (true, false):
-            args.append("-l")
-        default:
-            break
-        }
-
         // All injection script URLs
         guard let profileScriptURL = Bundle.main.url(
             forResource: "codeedit_shell_integration_profile",

CodeEdit/Features/TerminalEmulator/Views/CEActiveTaskTerminalView.swift

@@ -26,90 +26,43 @@ class CEActiveTaskTerminalView: CELocalShellTerminalView {
         fatalError("init(coder:) has not been implemented")
     }
 
-    override func setup() {
-        super.setup()
-        terminal.parser.oscHandlers[133] = { [weak self] slice in
-            guard let string = String(bytes: slice, encoding: .utf8), let self else { return }
-            // There's some more commands we could handle but don't right now. See the section on the FinalTerm codes
-            // here: https://iterm2.com/documentation-escape-codes.html
-            // There's also a few codes we don't emit. This should be improved in the future.
-
-            switch string.first {
-            case "C":
-                if self.cachedCaretColor == nil {
-                    self.cachedCaretColor = self.caretColor
-                }
-                self.caretColor = self.cachedCaretColor ?? self.caretColor
-                self.activeTask.updateTaskStatus(to: .running)
-
-                self.sendOutputMessage("Starting task: " + self.activeTask.task.name)
-                self.sendOutputMessage(self.activeTask.task.command)
-                self.newline()
-
-                // Command started
-                self.enableOutput = true
-            case "D":
-                // Disabled before we've received the first C CMD from the task
-                guard enableOutput else { return }
-                // Command terminated with code
-                let chunks = string.split(separator: ";")
-                guard chunks.count == 2, let status = Int32(chunks[1]) else { return }
-                self.activeTask.handleProcessFinished(terminationStatus: status)
-
-                self.enableOutput = false
-                self.caretColor = .clear
-            default:
-                break
-            }
-        }
-    }
-
     override func startProcess(
         workspaceURL url: URL?,
         shell: Shell? = nil,
         environment: [String] = [],
         interactive: Bool = true
     ) {
-        // Start the shell
-        do {
-            let terminalSettings = Settings.shared.preferences.terminal
-
-            var terminalEnvironment: [String] = Terminal.getEnvironmentVariables()
-            terminalEnvironment.append("TERM_PROGRAM=CodeEditApp_Terminal")
-
-            guard let (shell, shellPath) = getShell(shell, userSetting: terminalSettings.shell) else {
-                return
-            }
-
-            let shellArgs = try ShellIntegration.setUpIntegration(
-                for: shell,
-                environment: &terminalEnvironment,
-                useLogin: terminalSettings.useLoginShell,
-                interactive: interactive
-            )
-
-            terminalEnvironment.append(contentsOf: environment)
-            terminalEnvironment.append("\(ShellIntegration.Variables.disableHistory)=1")
-            terminalEnvironment.append(
-                contentsOf: activeTask.task.environmentVariables.map({ $0.key + "=" + $0.value })
-            )
-
-            process.startProcess(
-                executable: shellPath,
-                args: shellArgs,
-                environment: terminalEnvironment,
-                execName: shell.rawValue,
-                currentDirectory: URL(filePath: activeTask.task.workingDirectory, relativeTo: url).absolutePath
-            )
-
-            // Feed the command and run it
-            process.send(text: activeTask.task.command)
-            process.send(data: EscapeSequences.cmdRet[0..<1])
-        } catch {
-            newline()
-            sendOutputMessage("Failed to start a terminal session: \(error.localizedDescription)")
-            newline()
+        let terminalSettings = Settings.shared.preferences.terminal
+
+        var terminalEnvironment: [String] = Terminal.getEnvironmentVariables()
+        terminalEnvironment.append("TERM_PROGRAM=CodeEditApp_Terminal")
+
+        guard let (shell, shellPath) = getShell(shell, userSetting: terminalSettings.shell) else {
+            return
         }
+        let shellArgs = ["-lic", activeTask.task.command]
+
+        terminalEnvironment.append(contentsOf: environment)
+        terminalEnvironment.append("\(ShellIntegration.Variables.disableHistory)=1")
+        terminalEnvironment.append(
+            contentsOf: activeTask.task.environmentVariables.map({ $0.key + "=" + $0.value })
+        )
+
+        sendOutputMessage("Starting task: " + self.activeTask.task.name)
+        sendOutputMessage(self.activeTask.task.command)
+        newline()
+
+        process.startProcess(
+            executable: shellPath,
+            args: shellArgs,
+            environment: terminalEnvironment,
+            execName: shell.rawValue,
+            currentDirectory: URL(filePath: activeTask.task.workingDirectory, relativeTo: url).absolutePath
+        )
+    }
+
+    override func processTerminated(_ source: LocalProcess, exitCode: Int32?) {
+        activeTask.handleProcessFinished(terminationStatus: exitCode ?? 1)
     }
 
     func sendOutputMessage(_ message: String) {
@@ -139,31 +92,10 @@ class CEActiveTaskTerminalView: CELocalShellTerminalView {
         return nil
     }
 
-    func getProcessGroup() -> pid_t? {
-        guard let shellPID = runningPID() else { return nil }
-        let group = getpgid(shellPID)
-        guard group >= 0 else { return nil }
-        return group
-    }
-
     func getBufferAsString() -> String {
         terminal.getText(
             start: .init(col: 0, row: 0),
             end: .init(col: terminal.cols, row: terminal.rows + terminal.buffer.yDisp)
         )
     }
-
-    override func dataReceived(slice: ArraySlice<UInt8>) {
-        if enableOutput {
-            super.dataReceived(slice: slice)
-        } else if slice.count >= 5 {
-            // ESC [ 1 3 3
-            let sequence: [UInt8] = [0x1B, 0x5D, 0x31, 0x33, 0x33]
-            // Ignore until we see an OSC 133 code
-            for idx in 0..<(slice.count - 5) where slice[idx..<idx + 5] == sequence[0..<5] {
-                super.dataReceived(slice: slice[idx..<slice.count])
-                return
-            }
-        }
-    }
 }

CodeEdit/ShellIntegration/codeedit_shell_integration.bash

@@ -447,12 +447,10 @@ unset -f _install_bash_preexec
 __codeedit_status="$?"
 
 __codeedit_preexec() {
-    builtin printf "\033]133;C\007"
     builtin printf "\033]0;%s\007" "$1"
 }
 
 __codeedit_precmd() {
-    builtin printf "\033]133;D;%s\007" "$?"
     builtin printf "\033]0;bash\007"
 }
 

CodeEdit/ShellIntegration/codeedit_shell_integration_rc.zsh

@@ -47,12 +47,10 @@ fi
 builtin autoload -Uz add-zsh-hook
 
 __codeedit_preexec() {
-    builtin printf "\033]133;C\007"
     builtin printf "\033]0;%s\007" "$1"
 }
 
 __codeedit_precmd() {
-    builtin printf "\033]133;D;%s\007" "$?"
     builtin printf "\033]0;zsh\007"
 }