Merge pull request #406 from lalunamel/main

Add log_errors option to enable/disable logging of errors.

Author: alexrudall

README.md

@@ -22,7 +22,9 @@ Stream text with GPT-4, transcribe and translate audio with Whisper, or create i
     - [With Config](#with-config)
       - [Custom timeout or base URI](#custom-timeout-or-base-uri)
       - [Extra Headers per Client](#extra-headers-per-client)
-      - [Verbose Logging](#verbose-logging)
+      - [Logging](#logging)
+        - [Errors](#errors)
+        - [Faraday middleware](#faraday-middleware)
       - [Azure](#azure)
       - [Ollama](#ollama)
     - [Counting Tokens](#counting-tokens)
@@ -148,6 +150,7 @@ or when configuring the gem:
 ```ruby
 OpenAI.configure do |config|
     config.access_token = ENV.fetch("OPENAI_ACCESS_TOKEN")
+    config.log_errors = true # Optional
     config.organization_id = ENV.fetch("OPENAI_ORGANIZATION_ID") # Optional
     config.uri_base = "https://oai.hconeai.com/" # Optional
     config.request_timeout = 240 # Optional
@@ -168,7 +171,19 @@ client = OpenAI::Client.new(access_token: "access_token_goes_here")
 client.add_headers("X-Proxy-TTL" => "43200")
 ```
 
-#### Verbose Logging
+#### Logging
+
+##### Errors
+
+By default, `ruby-openai` does not log any `Faraday::Error`s encountered while executing a network request to avoid leaking data (e.g. 400s, 500s, SSL errors and more - see [here](https://www.rubydoc.info/github/lostisland/faraday/Faraday/Error) for a complete list of subclasses of `Faraday::Error` and what can cause them).
+
+If you would like to enable this functionality, you can set `log_errors` to `true` when configuring the client:
+
+```ruby
+  client = OpenAI::Client.new(log_errors: true)
+```
+
+##### Faraday middleware
 
 You can pass [Faraday middleware](https://lostisland.github.io/faraday/#/middleware/index) to the client in a block, eg. to enable verbose logging with Ruby's [Logger](https://ruby-doc.org/3.2.2/stdlibs/logger/Logger.html):
 

lib/openai.rb

@@ -37,17 +37,25 @@ def call(env)
   end
 
   class Configuration
-    attr_accessor :access_token, :api_type, :api_version, :organization_id,
-                  :uri_base, :request_timeout, :extra_headers
+    attr_accessor :access_token,
+                  :api_type,
+                  :api_version,
+                  :log_errors,
+                  :organization_id,
+                  :uri_base,
+                  :request_timeout,
+                  :extra_headers
 
     DEFAULT_API_VERSION = "v1".freeze
     DEFAULT_URI_BASE = "https://api.openai.com/".freeze
     DEFAULT_REQUEST_TIMEOUT = 120
+    DEFAULT_LOG_ERRORS = false
 
     def initialize
       @access_token = nil
       @api_type = nil
       @api_version = DEFAULT_API_VERSION
+      @log_errors = DEFAULT_LOG_ERRORS
       @organization_id = nil
       @uri_base = DEFAULT_URI_BASE
       @request_timeout = DEFAULT_REQUEST_TIMEOUT

lib/openai/client.rb

@@ -6,6 +6,7 @@ class Client
       api_type
       api_version
       access_token
+      log_errors
       organization_id
       uri_base
       request_timeout
@@ -17,7 +18,10 @@ def initialize(config = {}, &faraday_middleware)
       CONFIG_KEYS.each do |key|
         # Set instance variables like api_type & access_token. Fall back to global config
         # if not present.
-        instance_variable_set("@#{key}", config[key] || OpenAI.configuration.send(key))
+        instance_variable_set(
+          "@#{key}",
+          config[key].nil? ? OpenAI.configuration.send(key) : config[key]
+        )
       end
       @faraday_middleware = faraday_middleware
     end

lib/openai/http.rb

@@ -74,7 +74,7 @@ def conn(multipart: false)
       connection = Faraday.new do |f|
         f.options[:timeout] = @request_timeout
         f.request(:multipart) if multipart
-        f.use MiddlewareErrors
+        f.use MiddlewareErrors if @log_errors
         f.response :raise_error
         f.response :json
       end

spec/openai/client/http_spec.rb

@@ -271,4 +271,58 @@
       }
     end
   end
+
+  describe "logging errors" do
+    let(:cassette) { "http get with error response".downcase }
+
+    before do
+      @original_stdout = $stdout
+      $stdout = StringIO.new
+    end
+
+    after do
+      $stdout = @original_stdout
+    end
+
+    it "is disabled by default" do
+      VCR.use_cassette(cassette, record: :none) do
+        expect { OpenAI::Client.new.models.retrieve(id: "text-ada-001") }
+          .to raise_error Faraday::Error
+
+        $stdout.rewind
+        captured_stdout = $stdout.string
+        expect(captured_stdout).not_to include("OpenAI HTTP Error")
+      end
+    end
+
+    describe "when log_errors is set to true" do
+      let(:log_errors) { true }
+
+      it "logs errors" do
+        VCR.use_cassette(cassette, record: :none) do
+          expect { OpenAI::Client.new(log_errors: log_errors).models.retrieve(id: "text-ada-001") }
+            .to raise_error Faraday::Error
+
+          $stdout.rewind
+          captured_stdout = $stdout.string
+          expect(captured_stdout).to include("OpenAI HTTP Error")
+        end
+      end
+    end
+
+    describe "when log_errors is set to false" do
+      let(:log_errors) { false }
+
+      it "does not log errors" do
+        VCR.use_cassette(cassette, record: :none) do
+          expect { OpenAI::Client.new(log_errors: log_errors).models.retrieve(id: "text-ada-001") }
+            .to raise_error Faraday::Error
+
+          $stdout.rewind
+          captured_stdout = $stdout.string
+          expect(captured_stdout).not_to include("OpenAI HTTP Error")
+        end
+      end
+    end
+  end
 end