codex-ruby 0.1.4 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ba6980e6b87c0c4edff93f2577d49f167bf05264ba84e94077b6014deba03e9
-  data.tar.gz: 4dac330c5ddefe50cae38009aa706a2782b1673cbefe78122b934b894b92a5bb
+  metadata.gz: 8b977d75f6a42ed832175f5f2fe94a51edc5cee832e23de58ef7a154062310e9
+  data.tar.gz: 9742a0cd52e621689755eee26f7f41cf199b2f964dced853e41765ae44595a82
 SHA512:
-  metadata.gz: 920bf04a7dbc12d6129b761032c61fcf5929fe22b4370fab1f47e07eb46fa7578908c7cb448776ebfa8dbefc5d34c6728172a3bb2804e139363edbb7b7dc0ef0
-  data.tar.gz: a76ee269289b0e7441f27ca14710b51d411a31505bd8a337973e0f63d2614eaea5f0da2e3c6971381b9d95a74ea7a979458503c0f7eca90bca8e96761e43dc08
+  metadata.gz: f7f9f2b48f75d8f07bf09befcd9f5f5d85c420f4757ea11f4d9292f6421e4c7d2d345ac29b414280df2fb05815ab382f996fe2b6efa99568cae19b52c53fa5fb
+  data.tar.gz: 6cad8b57516073b897fb6465f3a8409995559cf616928cd3ae9663ffe0afa6afe8315c9ca9e904a9ea9e389727cc2909aeb3264398c0879441d53c5c729103ae

data/CHANGELOG.md

@@ -1,5 +1,30 @@
 # Changelog
 
+## 0.2.3 (2026-09-23)
+
+- Preserve provider failures when macOS reports a transient permission error for an exiting process group; verify that the group is gone before ignoring cleanup errors.
+
+## 0.2.2 (2026-09-23)
+
+- Clear the exposed PID after an already-exited CLI has been reaped, preventing stale process diagnostics.
+
+## 0.2.1 (2026-09-23)
+
+- Expose the active CLI PID through `AgentThread#pid` for worker recovery diagnostics.
+
+## 0.2.0 (2026-09-23)
+
+- Forward ordered `local_image` inputs through the public thread API; reject unsupported input types and invalid local paths instead of silently discarding them.
+- Add `ignore_user_config`, `ignore_rules`, and `ephemeral` thread options; use the documented `--json` CLI flag.
+- Honor explicit environment replacement without inheriting parent secrets.
+- Terminate and reap CLI process groups on cancellation or consumer errors, with concurrent interruption serialized.
+- Raise on streams that end without a completed turn instead of returning partial answers as success.
+
+## 0.1.5 (2026-06-17)
+
+- Include structured Codex CLI error events in non-zero exit errors, so
+  API failures such as unsupported model names are visible to callers
+
 ## 0.1.4 (2026-06-16)
 
 - Pass `web_search: true` to current Codex CLI versions as the global

data/lib/codex_sdk/agent_thread.rb

@@ -38,7 +38,8 @@ module CodexSDK
 
     # Streaming run: yields each event to the block as it arrives.
     def run_streamed(input, turn_options: TurnOptions.new, &block)
-      prompt = normalize_input(input)
+      prompt, images = normalize_input(input)
+      completed = false
 
       output_schema_path = nil
       output_schema_path = write_output_schema(turn_options.output_schema) if turn_options.output_schema
@@ -50,19 +51,27 @@ module CodexSDK
 
       @exec.run(
         prompt,
+        images: images,
         resume_thread_id: @id,
         output_schema_path: output_schema_path
       ) do |event|
         # Capture thread ID from first event
         @id = event.thread_id if event.is_a?(Events::ThreadStarted)
+        completed = true if event.is_a?(Events::TurnCompleted)
 
         block.call(event)
       end
+      raise Error, "Codex stream ended without turn completion" unless completed
     ensure
       @context_snapshot = @exec&.context_snapshot
       cleanup_output_schema(output_schema_path)
     end
 
+    # PID of the running CLI, for external lifecycle diagnostics.
+    def pid
+      @exec&.pid
+    end
+
     # Interrupt the running subprocess.
     def interrupt
       @exec&.interrupt
@@ -73,13 +82,32 @@ module CodexSDK
     def normalize_input(input)
       case input
       when String
-        input
+        [input, []]
       when Array
-        input.filter_map do |entry|
-          entry[:text] if entry[:type] == "text"
-        end.join("\n\n")
+        texts = []
+        images = []
+        input.each do |entry|
+          raise ArgumentError, "Unsupported input entry" unless entry.is_a?(Hash)
+
+          case entry[:type]
+          when "text"
+            raise ArgumentError, "Text input must be a string" unless entry[:text].is_a?(String)
+
+            texts << entry[:text]
+          when "local_image"
+            path = entry[:path]
+            unless path.is_a?(String) && path.start_with?(File::SEPARATOR) && File.file?(path) && File.readable?(path)
+              raise ArgumentError, "Local image must be an absolute readable file path"
+            end
+
+            images << path
+          else
+            raise ArgumentError, "Unsupported input type: #{entry[:type].inspect}"
+          end
+        end
+        [texts.join("\n\n"), images]
       else
-        input.to_s
+        raise ArgumentError, "Unsupported input: expected string or array"
       end
     end
 

data/lib/codex_sdk/exec.rb

@@ -5,7 +5,7 @@ require "json"
 
 module CodexSDK
   # Internal: manages the codex CLI subprocess.
-  # Spawns `codex exec --experimental-json`, writes prompt to stdin,
+  # Spawns `codex exec --json`, writes prompt to stdin,
   # reads JSONL events from stdout.
   class Exec
     SHUTDOWN_TIMEOUT = 10 # seconds to wait after SIGTERM before SIGKILL
@@ -30,8 +30,11 @@ module CodexSDK
       sessions_root = codex_sessions_root(env)
       started_at = Time.now
       @context_snapshot = nil
+      diagnostics = []
 
-      @stdin, @stdout, @stderr, @wait_thread = Open3.popen3(env, *args)
+      @stdin, @stdout, @stderr, @wait_thread = Open3.popen3(env, *args, unsetenv_others: !@options.env.nil?,
+                                                                        pgroup: true)
+      @pid = @wait_thread.pid
 
       # Write prompt and close stdin (one-shot, matching TypeScript SDK)
       @stdin.write(prompt.to_s)
@@ -56,6 +59,7 @@ module CodexSDK
         end
 
         event = Events.parse(data)
+        capture_diagnostic(event, diagnostics)
         block.call(event)
       end
 
@@ -64,9 +68,9 @@ module CodexSDK
 
       unless status.success?
         code = status.exitstatus || status.termsig
-        truncated = stderr_buf.length > 500 ? "#{stderr_buf[0, 497]}..." : stderr_buf
+        diagnostic = exit_diagnostic(diagnostics, stderr_buf)
         raise ExecError.new(
-          "Codex exited with code #{code}: #{truncated}",
+          "Codex exited with code #{code}: #{diagnostic}",
           exit_code: code,
           stderr: stderr_buf
         )
@@ -83,32 +87,72 @@ module CodexSDK
     # Sends SIGTERM to the subprocess, waits, then SIGKILL if needed.
     def interrupt
       @mutex.synchronize do
-        return unless @wait_thread&.alive?
+        return unless @pid
 
         begin
-          Process.kill("TERM", @wait_thread.pid)
+          signal_group("TERM")
         rescue Errno::ESRCH
+          @wait_thread.value
+          @pid = nil
           return
         end
 
         # Wait for graceful shutdown
-        unless wait_for_exit(SHUTDOWN_TIMEOUT)
-          begin
-            Process.kill("KILL", @wait_thread.pid)
-          rescue Errno::ESRCH
-            # already gone
-          end
+        wait_for_exit(SHUTDOWN_TIMEOUT)
+        begin
+          # Also stop descendants that outlive the immediate CLI child.
+          signal_group("KILL")
+        rescue Errno::ESRCH
+          # already gone
         end
+        @wait_thread.value
+        @pid = nil
       end
     end
 
     private
 
+    def signal_group(signal)
+      Process.kill(signal, -@pid)
+    rescue Errno::EPERM
+      # macOS can report EPERM while the last group member is exiting.
+      # Only treat it as gone when a subsequent group probe confirms ESRCH.
+      @wait_thread.join(0.1)
+      Process.kill(0, -@pid)
+      raise
+    end
+
+    def capture_diagnostic(event, diagnostics)
+      message =
+        case event
+        when Events::TurnFailed
+          event.error_message
+        when Events::Error
+          event.message
+        when Events::ItemStarted, Events::ItemUpdated, Events::ItemCompleted
+          event.item.message if event.item.is_a?(Items::Error)
+        end
+      diagnostics << readable_error_message(message) if message.to_s.strip != ""
+    end
+
+    def exit_diagnostic(diagnostics, stderr)
+      diagnostic = diagnostics.compact.uniq.join("\n")
+      diagnostic = stderr.to_s if diagnostic == ""
+      diagnostic.length > 500 ? "#{diagnostic[0, 497]}..." : diagnostic
+    end
+
+    def readable_error_message(message)
+      parsed = JSON.parse(message.to_s)
+      parsed.dig("error", "message") || parsed["message"] || message.to_s
+    rescue JSON::ParserError
+      message.to_s
+    end
+
     def build_args(resume_thread_id: nil, images: [], output_schema_path: nil)
       codex_path = @options.codex_path || find_codex_path
       args = [codex_path]
       args << "--search" if @thread_options.web_search
-      args.concat(["exec", "--experimental-json"])
+      args.concat(["exec", "--json"])
 
       # Global config overrides
       args.concat(ConfigSerializer.to_flags(@options.config)) if @options.config.any?
@@ -125,6 +169,9 @@ module CodexSDK
       args.concat(["--cd", to.working_directory]) if to.working_directory
       args << "--dangerously-bypass-approvals-and-sandbox" if to.dangerously_bypass_approvals_and_sandbox
       args << "--skip-git-repo-check" if to.skip_git_repo_check
+      args << "--ignore-user-config" if to.ignore_user_config
+      args << "--ignore-rules" if to.ignore_rules
+      args << "--ephemeral" if to.ephemeral
 
       to.additional_directories.each { |dir| args.concat(["--add-dir", dir]) }
 
@@ -199,6 +246,7 @@ module CodexSDK
     end
 
     def cleanup
+      interrupt
       @stdin&.close unless @stdin&.closed?
       @stdout&.close unless @stdout&.closed?
       @stderr&.close unless @stderr&.closed?

data/lib/codex_sdk/options.rb

@@ -31,7 +31,10 @@ module CodexSDK
     :network_access,
     :web_search,
     :additional_directories,
-    :skip_git_repo_check
+    :skip_git_repo_check,
+    :ignore_user_config,
+    :ignore_rules,
+    :ephemeral
   ) do
     def initialize(
       model: nil,
@@ -43,7 +46,10 @@ module CodexSDK
       network_access: nil,
       web_search: nil,
       additional_directories: [],
-      skip_git_repo_check: false
+      skip_git_repo_check: false,
+      ignore_user_config: false,
+      ignore_rules: false,
+      ephemeral: false
     )
       super
     end

data/lib/codex_sdk/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CodexSDK
-  VERSION = "0.1.4"
+  VERSION = "0.2.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: codex-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.3
 platform: ruby
 authors:
 - Anton Kopylov
@@ -51,7 +51,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.7.2
+rubygems_version: 4.0.20
 specification_version: 4
 summary: Ruby SDK for the Codex CLI
 test_files: []