trino-client 2.2.5 → 2.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52373d10e6b2a747763c91f89a5f2da08824fa239b97808b6fb50229f0501b6b
-  data.tar.gz: 15678aba8084b3ed6845c5784d7fcc2d68699ad5f002776d6fd5897206f2bf23
+  metadata.gz: 63abc1ae1264778be0bd76aa0fb7225376a4a2169e6224823bfcdf551e8de741
+  data.tar.gz: c4a1cc7797f2f6e64602a7db829484942f437efde7fd568e82a416c48b26125a
 SHA512:
-  metadata.gz: 83a93c0ed41734746f4e69a0b752c7acb978b143188e4d088ef348632ebb2df040b523eae8243b31ee1a94908d61444591405fa0d5f06cfecb2e5767e6d974d4
-  data.tar.gz: 32dfdb8fb542c3cd8b7ebe3e01678baa2f2146c21e05a30c185b8a27b84845be96a2a3b57471bb8e667edf9c1a9449354b59e72b9149d4978cd7b8a223a55dc4
+  metadata.gz: 8ce7ae32f6e438f0558a4b2346b2480e860fc2a6111287c0e9c43f1226af7c832cca0a69a2f7a1ae19e02a9ef6d9bf1b9198881ebcda516d4b77d6ee3dece51b
+  data.tar.gz: 3bf7c96b9382ce83830902657b5eff930e63621afc70dda55aa21e71185e36057e5d68d4a99cec29392ee6e8411986bd06ee2099ccc1781cd78adde36eb5d98a

data/ChangeLog.md

@@ -1,5 +1,18 @@
 trino-client-ruby
 ====
+## 2.3.0
+- Reuse a Faraday client per Trino::Client instance @p623 (#168)
+
+## 2.2.6
+- fix: improve POST retry tests and document idempotency assumption ([#159](https://github.com/treasure-data/trino-client-ruby/issues/159)) [[e64c2a9](https://github.com/treasure-data/trino-client-ruby/commit/e64c2a9)]
+- Add retry to POST /v1/statement ([#157](https://github.com/treasure-data/trino-client-ruby/issues/157)) [[64a5c66](https://github.com/treasure-data/trino-client-ruby/commit/64a5c66)]
+- Update psych requirement from ~> 3 to ~> 5 ([#140](https://github.com/treasure-data/trino-client-ruby/issues/140)) [[eeb3333](https://github.com/treasure-data/trino-client-ruby/commit/eeb3333)]
+- Update dependabot.yaml to change the update interval from weekly to monthly and set commit message prefix to "chore". [[2fde3f2](https://github.com/treasure-data/trino-client-ruby/commit/2fde3f2)]
+- Minor fix [[db03c07](https://github.com/treasure-data/trino-client-ruby/commit/db03c07)]
+- Update addressable requirement from ~> 2.8.1 to ~> 2.9.0 [[1a56064](https://github.com/treasure-data/trino-client-ruby/commit/1a56064)]
+- Update README.md for release instructions [skip ci] [[dda6a06](https://github.com/treasure-data/trino-client-ruby/commit/dda6a06)]
+- v2.2.5 [[12ce8e8](https://github.com/treasure-data/trino-client-ruby/commit/12ce8e8)]
+
 ## 2.2.5
 - Merge pull request [#155](https://github.com/treasure-data/trino-client-ruby/issues/155) from murakami-ta/add-http-debug-logger-option [[143a801](https://github.com/treasure-data/trino-client-ruby/commit/143a801)]
 - Fix http_debug_logger test to work with both Faraday 1 and 2 [[0976be7](https://github.com/treasure-data/trino-client-ruby/commit/0976be7)]

data/README.md

@@ -88,8 +88,8 @@ $ bundle exec rake modelgen:latest
 
 ## Options
 
-* **server** sets address (and port) of a Trino coordinator server.
-* **ssl** enables https.
+* **server** sets address (and port) of a Trino coordinator server. Changes after client initialization are not applied; create a new client to change this option.
+* **ssl** enables https. Changes after client initialization are not applied; create a new client to change this option.
   * Setting `true` enables SSL and verifies server certificate using system's built-in certificates.
   * Setting `{verify: false}` enables SSL but doesn't verify server certificate.
   * Setting a Hash object enables SSL and verify server certificate with options:
@@ -104,20 +104,21 @@ $ bundle exec rake modelgen:latest
 * **client_info** sets client info to queries. It can be a string to pass a raw string, or an object that can be encoded to JSON.
 * **client_tags** sets client tags to queries. It needs to be an array of strings. The tags are shown on web interface.
 * **user** sets user name to connect to a Trino.
-* **password** sets a password to connect to Trino using basic auth.
+* **password** sets a password to connect to Trino using basic auth. Requires the client's connection to use HTTPS.
 * **time_zone** sets time zone of queries. Time zone affects some functions such as `format_datetime`.
 * **language** sets language of queries. Language affects some functions such as `format_datetime`.
 * **properties** set session properties. Session properties affect internal behavior such as `hive.force_local_scheduling: true`, `raptor.reader_stream_buffer_size: "32MB"`, etc.
 * **query_timeout** sets timeout in seconds for the entire query execution (from the first API call until there're no more output data). If timeout happens, client raises TrinoQueryTimeoutError. Default is nil (disabled).
 * **plan_timeout** sets timeout in seconds for query planning execution (from the first API call until result columns become available). If timeout happens, client raises TrinoQueryTimeoutError. Default is nil (disabled).
 * **http_headers** sets custom HTTP headers. It must be a Hash of string to string.
-* **http_proxy** sets host:port of a HTTP proxy server.
-* **http_debug** enables debug message to STDOUT for each HTTP requests.
-* **http_debug_logger** sets a custom `Logger` instance for HTTP debug logs. Requires **http_debug** to be `true`.
+* **http_proxy** sets host:port of a HTTP proxy server. Changes after client initialization are not applied; create a new client to change this option.
+* **http_debug** enables debug message to STDOUT for each HTTP requests. Changes after client initialization are not applied; create a new client to change this option.
+* **http_debug_logger** sets a custom `Logger` instance for HTTP debug logs. Requires **http_debug** to be `true`. Changes after client initialization are not applied; create a new client to change this option.
 * **http_open_timeout** sets timeout in seconds to open new HTTP connection.
 * **http_timeout** sets timeout in seconds to read data from a server.
-* **gzip** enables gzip compression.
-* **follow_redirect** enables HTTP redirection support.
+* **gzip** enables gzip compression. Changes after client initialization are not applied; create a new client to change this option.
+* **follow_redirect** enables HTTP redirection support. Changes after client initialization are not applied; create a new client to change this option.
+* **faraday_adapter** sets the Faraday adapter to use. Default is `Faraday.default_adapter`. To reuse persistent HTTP connections, install `faraday-net_http_persistent` and specify `:net_http_persistent`. Changes after client initialization are not applied; create a new client to change this option.
 * **model_version** set the Trino version to which a job is submitted. Supported versions are 351, 316, 303, 0.205, 0.178, 0.173, 0.153 and 0.149. Default is 351.
 
 See [RDoc](http://www.rubydoc.info/gems/presto-client/) for the full documentation.
@@ -126,20 +127,17 @@ See [RDoc](http://www.rubydoc.info/gems/presto-client/) for the full documentati
 
 ### Releasing a new version
 
-1. First update `lib/trino/client/version.rb` to the next version.
-2. Run the following command which will update `ChangeLog.md` file automatically.
+1. Run the following command which will prompt for the new version, update `lib/trino/client/version.rb`, and generate/let you edit `ChangeLog.md`.
 ```
 $ ruby release.rb
 ```
 
-3. Create tag
+2. Commit and tag
 ```
 $ git commit -am "vX.Y.Z"
 $ git tag "vX.Y.Z"
-% git push --tags
+$ git push origin master
+$ git push --tags
 ```
 
-4. Push package by the following command which will build and push `trino-client-X.Y.Z.gem` and `trino-client-ruby-X.Y.Z.gem` automatically.
-```
-$ ruby publish.rb
-```
+Pushing a `v*` tag triggers the GitHub Actions publisher workflow, which automatically builds and publishes the gem to RubyGems.org.

data/lib/trino/client/client.rb

@@ -19,12 +19,20 @@ module Trino::Client
   require 'trino/client/query'
 
   class Client
+    # Creates a reusable Faraday connection using the initial options.
+    # Connection settings are not reapplied after initialization.
+    # These include server, ssl, proxy, and faraday_adapter; see the README for the full list.
+    # Create a new Client to change these settings.
+    #
+    # Query-specific headers, including Basic Auth, use the options at query start.
+    # Password authentication requires the actual connection to use HTTPS, regardless of later changes to options[:ssl].
     def initialize(options)
       @options = options
+      @faraday = Trino::Client.faraday_client(options)
     end
 
     def query(query, &block)
-      q = Query.start(query, @options)
+      q = Query.start(query, @options, @faraday)
       if block
         begin
           yield q
@@ -37,15 +45,15 @@ module Trino::Client
     end
 
     def resume_query(next_uri)
-      return Query.resume(next_uri, @options)
+      return Query.resume(next_uri, @options, @faraday)
     end
 
     def kill(query_id)
-      return Query.kill(query_id, @options)
+      return Query.kill(query_id, @options, @faraday)
     end
 
     def run(query)
-      q = Query.start(query, @options)
+      q = Query.start(query, @options, @faraday)
       begin
         columns = q.columns
         if columns.empty?

data/lib/trino/client/faraday_client.rb

@@ -14,9 +14,8 @@
 #    limitations under the License.
 #
 module Trino::Client
-  FARADAY1_USED = Faraday::VERSION.start_with?("1.")
-  private_constant :FARADAY1_USED
 
+  require 'base64'
   require 'cgi'
 
   module TrinoHeaders
@@ -77,14 +76,6 @@ module Trino::Client
     faraday_options[:ssl] = ssl if ssl
 
     faraday = Faraday.new(faraday_options) do |faraday|
-      if options[:user] && options[:password]
-        # https://lostisland.github.io/faraday/middleware/authentication
-        if FARADAY1_USED
-          faraday.request(:basic_auth, options[:user], options[:password])
-        else
-          faraday.request :authorization, :basic, options[:user], options[:password]
-        end
-      end
       if options[:follow_redirect]
         faraday.response :follow_redirects
       end
@@ -92,11 +83,10 @@ module Trino::Client
         faraday.request :gzip
       end
       faraday.response :logger, options[:http_debug_logger] if options[:http_debug]
-      faraday.adapter Faraday.default_adapter
+      faraday.adapter(options[:faraday_adapter] || Faraday.default_adapter)
     end
 
     faraday.headers.merge!(HEADERS)
-    faraday.headers.merge!(optional_headers(options))
 
     return faraday
   end
@@ -129,71 +119,82 @@ module Trino::Client
     return ssl
   end
 
-  def self.optional_headers(options)
-    usePrestoHeader = false
-    if options[:model_version] && options[:model_version] < 351
-      usePrestoHeader = true
+  def self.build_query_headers(options, faraday:)
+    if options[:password] && faraday.url_prefix.scheme != "https"
+      raise ArgumentError, "Protocol must be https when passing a password"
+    end
+    use_presto_headers = false
+    if options[:model_version] && options[:model_version].to_i < 351
+      use_presto_headers = true
     end
 
     headers = {}
+
+    if options[:user] && options[:password]
+      credentials = Base64.strict_encode64(
+        "#{options[:user]}:#{options[:password]}"
+      )
+      headers["Authorization"] = "Basic #{credentials}"
+    end
+
     if v = options[:user]
-      if usePrestoHeader
+      if use_presto_headers
         headers[PrestoHeaders::PRESTO_USER] = v
       else
         headers[TrinoHeaders::TRINO_USER] = v
       end
     end
     if v = options[:source]
-      if usePrestoHeader
+      if use_presto_headers
         headers[PrestoHeaders::PRESTO_SOURCE] = v
       else
         headers[TrinoHeaders::TRINO_SOURCE] = v
       end
     end
     if v = options[:catalog]
-      if usePrestoHeader
+      if use_presto_headers
         headers[PrestoHeaders::PRESTO_CATALOG] = v
       else
         headers[TrinoHeaders::TRINO_CATALOG] = v
       end
     end
     if v = options[:schema]
-      if usePrestoHeader
+      if use_presto_headers
         headers[PrestoHeaders::PRESTO_SCHEMA] = v
       else
         headers[TrinoHeaders::TRINO_SCHEMA] = v
       end
     end
     if v = options[:time_zone]
-      if usePrestoHeader
+      if use_presto_headers
         headers[PrestoHeaders::PRESTO_TIME_ZONE] = v
       else
         headers[TrinoHeaders::TRINO_TIME_ZONE] = v
       end
     end
     if v = options[:language]
-      if usePrestoHeader
+      if use_presto_headers
         headers[PrestoHeaders::PRESTO_LANGUAGE] = v
       else
         headers[TrinoHeaders::TRINO_LANGUAGE] = v
       end
     end
     if v = options[:properties]
-      if usePrestoHeader
+      if use_presto_headers
         headers[PrestoHeaders::PRESTO_SESSION] = encode_properties(v)
       else
         headers[TrinoHeaders::TRINO_SESSION] = encode_properties(v)
       end
     end
     if v = options[:client_info]
-      if usePrestoHeader
+      if use_presto_headers
         headers[PrestoHeaders::PRESTO_CLIENT_INFO] = encode_client_info(v)
       else
         headers[TrinoHeaders::TRINO_CLIENT_INFO] = encode_client_info(v)
       end
     end
     if v = options[:client_tags]
-      if usePrestoHeader
+      if use_presto_headers
         headers[PrestoHeaders::PRESTO_CLIENT_TAGS] = encode_client_tags(v)
       else
         headers[TrinoHeaders::TRINO_CLIENT_TAGS] = encode_client_tags(v)
@@ -245,6 +246,6 @@ module Trino::Client
     Array(tags).join(",")
   end
 
-  private_class_method :faraday_ssl_options, :optional_headers, :encode_properties, :encode_client_info, :encode_client_tags
+  private_class_method :faraday_ssl_options, :encode_properties, :encode_client_info, :encode_client_tags
 
 end

data/lib/trino/client/query.rb

@@ -25,17 +25,21 @@ module Trino::Client
   require 'trino/client/statement_client'
 
   class Query
-    def self.start(query, options)
-      new StatementClient.new(faraday_client(options), query, options)
+    def self.start(query, options, faraday = nil)
+      faraday ||= faraday_client(options)
+      new StatementClient.new(faraday, query, options)
     end
 
-    def self.resume(next_uri, options)
-      new StatementClient.new(faraday_client(options), nil, options, next_uri)
+    def self.resume(next_uri, options, faraday = nil)
+      faraday ||= faraday_client(options)
+      new StatementClient.new(faraday, nil, options, next_uri)
     end
 
-    def self.kill(query_id, options)
-      faraday = faraday_client(options)
+    def self.kill(query_id, options, faraday = nil)
+      faraday ||= faraday_client(options)
+      headers = Trino::Client.build_query_headers(options, faraday: faraday)
       response = faraday.delete do |req|
+        req.headers.merge!(headers)
         req.url "/v1/query/#{query_id}"
       end
       return response.status / 100 == 2

data/lib/trino/client/statement_client.rb

@@ -26,8 +26,11 @@ module Trino::Client
         :max_nesting => false
     }
 
+    RETRYABLE_STATUSES = [502, 503, 504]
+
     def initialize(faraday, query, options, next_uri=nil)
       @faraday = faraday
+      @headers = Trino::Client.build_query_headers(options, faraday: @faraday)
 
       @options = options
       @query = query
@@ -66,16 +69,32 @@ module Trino::Client
 
     def post_query_request!
       uri = "/v1/statement"
-      response = @faraday.post do |req|
-        req.url uri
+      response = with_retry_loop do
+        begin
+          r = @faraday.post do |req|
+            req.url uri
+            req.headers.merge!(@headers)
 
-        req.body = @query
-        init_request(req)
-      end
+            req.body = @query
+            init_request(req)
+          end
+        rescue Faraday::TimeoutError, Faraday::ConnectionFailed
+          # POST /v1/statement is not idempotent; retrying transport-level errors
+          # (timeouts/connection failures) can submit duplicate queries. This is
+          # intentional under the assumption the failure happened before Trino
+          # received the request (e.g. rejected by a load balancer upstream).
+          throw :retry_with_backoff
+        rescue => e
+          exception! e
+        end
 
-      # TODO error handling
-      if response.status != 200
-        exception! TrinoHttpError.new(response.status, "Failed to start query: #{response.body} (#{response.status})")
+        if r.status == 200
+          r
+        elsif RETRYABLE_STATUSES.include?(r.status)
+          throw :retry_with_backoff
+        else
+          exception! TrinoHttpError.new(r.status, "Failed to start query: #{r.body} (#{r.status})")
+        end
       end
 
       @results_headers = response.headers
@@ -189,31 +208,12 @@ module Trino::Client
 
     private :parse_body
 
-    def faraday_get_with_retry(uri, &block)
+    def with_retry_loop
       start = Process.clock_gettime(Process::CLOCK_MONOTONIC)
       attempts = 0
 
       loop do
-        begin
-          response = @faraday.get(uri)
-        rescue Faraday::TimeoutError, Faraday::ConnectionFailed
-          # temporally error to retry
-          response = nil
-        rescue => e
-          exception! e
-        end
-
-        if response
-          if response.status == 200 && !response.body.to_s.empty?
-            return response
-          end
-
-          # retry if 502, 503, 504 according to the trino protocol
-          unless [502, 503, 504].include?(response.status)
-            # deterministic error
-            exception! TrinoHttpError.new(response.status, "Trino API error at #{uri} returned #{response.status}: #{response.body}")
-          end
-        end
+        catch(:retry_with_backoff) { return yield }
 
         raise_if_timeout!
 
@@ -226,6 +226,30 @@ module Trino::Client
       exception! TrinoHttpError.new(408, "Trino API error due to timeout")
     end
 
+    private :with_retry_loop
+
+    def faraday_get_with_retry(uri)
+      with_retry_loop do
+        begin
+          response = @faraday.get(uri) do |req|
+            req.headers.merge!(@headers)
+          end
+        rescue Faraday::TimeoutError, Faraday::ConnectionFailed
+          throw :retry_with_backoff
+        rescue => e
+          exception! e
+        end
+
+        if response.status == 200 && !response.body.to_s.empty?
+          response
+        elsif RETRYABLE_STATUSES.include?(response.status)
+          throw :retry_with_backoff
+        else
+          exception! TrinoHttpError.new(response.status, "Trino API error at #{uri} returned #{response.status}: #{response.body}")
+        end
+      end
+    end
+
     def raise_if_timeout!
       if @started_at
         return if finished?
@@ -258,6 +282,7 @@ module Trino::Client
     def cancel_leaf_stage
       if uri = @results.partial_cancel_uri
         @faraday.delete do |req|
+          req.headers.merge!(@headers)
           req.url uri
         end
       end
@@ -271,6 +296,7 @@ module Trino::Client
       begin
         if uri = @results.next_uri
           @faraday.delete do |req|
+            req.headers.merge!(@headers)
             req.url uri
           end
         end

data/lib/trino/client/version.rb

@@ -15,6 +15,6 @@
 #
 module Trino
   module Client
-    VERSION = "2.2.5"
+    VERSION = "2.3.1"
   end
 end

data/trino-client.gemspec

@@ -29,8 +29,8 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency "rake", [">= 0.9.2", "< 14.0"]
   gem.add_development_dependency "rspec", "~> 3.13.0"
   gem.add_development_dependency "webmock", ["~> 3.0"]
-  gem.add_development_dependency "addressable", "~> 2.8.1" # 2.5.0 doesn't support Ruby 1.9.3
+  gem.add_development_dependency "addressable", "~> 2.9.0"
   gem.add_development_dependency "simplecov", "~> 0.22.0"
   gem.add_development_dependency "standard", "~> 1.54.0"
-  gem.add_development_dependency "psych", "~> 3"
+  gem.add_development_dependency "psych", "~> 5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trino-client
 version: !ruby/object:Gem::Version
-  version: 2.2.5
+  version: 2.3.1
 platform: ruby
 authors:
 - Sadayuki Furuhashi
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-05-27 00:00:00.000000000 Z
+date: 2026-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -126,14 +126,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.8.1
+        version: 2.9.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.8.1
+        version: 2.9.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -168,14 +168,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '5'
 description: Trino client library
 email:
 - sf@treasure-data.com