presto-client 0.6.0 → 0.6.5

data/Rakefile

@@ -6,9 +6,7 @@ require 'rake/clean'
 
 require 'rspec/core/rake_task'
 
-RSpec::Core::RakeTask.new(:spec) do |t|
-  t.fail_on_error = false
-end
+RSpec::Core::RakeTask.new(:spec)
 
 task :default => [:spec, :build]
 

data/lib/presto/client/faraday_client.rb

@@ -15,6 +15,8 @@
 #
 module Presto::Client
 
+  require 'cgi'
+
   module PrestoHeaders
     PRESTO_USER = "X-Presto-User"
     PRESTO_SOURCE = "X-Presto-Source"
@@ -58,7 +60,12 @@ module Presto::Client
       if options[:user] && options[:password]
         faraday.basic_auth(options[:user], options[:password])
       end
-
+      if options[:follow_redirect]
+        faraday.use FaradayMiddleware::FollowRedirects
+      end
+      if options[:gzip]
+        faraday.use FaradayMiddleware::Gzip
+      end
       faraday.response :logger if options[:http_debug]
       faraday.adapter Faraday.default_adapter
     end
@@ -155,6 +162,7 @@ module Presto::Client
       if field_value =~ HTTP11_CTL_CHARSET_REGEXP
         raise Faraday::ClientError, "Value of properties can't include HTTP/1.1 control characters"
       end
+      field_value = CGI.escape(field_value)
       "#{token}=#{field_value}"
     end
   end

data/lib/presto/client/model_versions/316.rb

@@ -198,9 +198,9 @@ module Presto::Client::ModelVersions
         end
         obj = allocate
         model_class = case hash["@type"]
-            when "CreateHandle"       then CreateHandle
-            when "InsertHandle"       then InsertHandle
-            when "DeleteHandle"       then DeleteHandle
+            when "CreateTarget"       then CreateTarget
+            when "InsertTarget"       then InsertTarget
+            when "DeleteTarget"       then DeleteTarget
         end
         if model_class
            model_class.decode(hash)

data/lib/presto/client/query.rb

@@ -16,6 +16,7 @@
 module Presto::Client
 
   require 'faraday'
+  require 'faraday_middleware'
   require 'presto/client/models'
   require 'presto/client/errors'
   require 'presto/client/faraday_client'
@@ -130,11 +131,8 @@ module Presto::Client
     end
 
     def raise_if_failed
-      if @api.closed?
+      if @api.client_aborted?
         raise PrestoClientError, "Query aborted by user"
-      elsif @api.exception?
-        # query is gone
-        raise @api.exception
       elsif @api.query_failed?
         results = @api.current_results
         error = results.error

data/lib/presto/client/statement_client.rb

@@ -31,8 +31,7 @@ module Presto::Client
 
       @options = options
       @query = query
-      @closed = false
-      @exception = nil
+      @state = :running
       @retry_timeout = options[:retry_timeout] || 120
       if model_version = @options[:model_version]
         @models = ModelVersions.const_get("V#{model_version.gsub(".", "_")}")
@@ -76,7 +75,7 @@ module Presto::Client
 
       # TODO error handling
       if response.status != 200
-        raise PrestoHttpError.new(response.status, "Failed to start query: #{response.body} (#{response.status})")
+        exception! PrestoHttpError.new(response.status, "Failed to start query: #{response.body} (#{response.status})")
       end
 
       @results_headers = response.headers
@@ -91,14 +90,20 @@ module Presto::Client
       !!@options[:debug]
     end
 
-    def closed?
-      @closed
+    def running?
+      @state == :running
     end
 
-    attr_reader :exception
+    def client_aborted?
+      @state == :client_aborted
+    end
+
+    def client_error?
+      @state == :client_error
+    end
 
-    def exception?
-      @exception
+    def finished?
+      @state == :finished
     end
 
     def query_failed?
@@ -106,7 +111,7 @@ module Presto::Client
     end
 
     def query_succeeded?
-      @results.error == nil && !@exception && !@closed
+      @results.error == nil && finished?
     end
 
     def current_results
@@ -117,16 +122,29 @@ module Presto::Client
       @results_headers
     end
 
+    def query_id
+      @results.id
+    end
+
     def has_next?
       !!@results.next_uri
     end
 
+    def exception!(e)
+      @state = :client_error
+      raise e
+    end
+
     def advance
-      if closed? || !has_next?
+      return false unless running?
+
+      unless has_next?
+        @state = :finished
         return false
       end
 
       uri = @results.next_uri
+
       response = faraday_get_with_retry(uri)
       @results_headers = response.headers
       @results = decode_model(uri, parse_body(response), @models::QueryResults)
@@ -150,8 +168,7 @@ module Presto::Client
         if body.size > 1024 + 3
           body = "#{body[0, 1024]}..."
         end
-        @exception = PrestoHttpError.new(500, "Presto API returned unexpected structure at #{uri}. Expected #{body_class} but got #{body}: #{e}")
-        raise @exception
+        exception! PrestoHttpError.new(500, "Presto API returned unexpected structure at #{uri}. Expected #{body_class} but got #{body}: #{e}")
       end
     end
 
@@ -166,8 +183,7 @@ module Presto::Client
           JSON.parse(response.body, opts = JSON_OPTIONS)
         end
       rescue => e
-        @exception = PrestoHttpError.new(500, "Presto API returned unexpected data format. #{e}")
-        raise @exception
+        exception! PrestoHttpError.new(500, "Presto API returned unexpected data format. #{e}")
       end
     end
 
@@ -184,8 +200,7 @@ module Presto::Client
           # temporally error to retry
           response = nil
         rescue => e
-          @exception = e
-          raise @exception
+          exception! e
         end
 
         if response
@@ -195,8 +210,7 @@ module Presto::Client
 
           if response.status != 503  # retry only if 503 Service Unavailable
             # deterministic error
-            @exception = PrestoHttpError.new(response.status, "Presto API error at #{uri} returned #{response.status}: #{response.body}")
-            raise @exception
+            exception! PrestoHttpError.new(response.status, "Presto API error at #{uri} returned #{response.status}: #{response.body}")
           end
         end
 
@@ -204,18 +218,14 @@ module Presto::Client
 
         attempts += 1
         sleep attempts * 0.1
-      end while (Process.clock_gettime(Process::CLOCK_MONOTONIC) - start) < @retry_timeout && !@closed
+      end while (Process.clock_gettime(Process::CLOCK_MONOTONIC) - start) < @retry_timeout && !client_aborted?
 
-      @exception = PrestoHttpError.new(408, "Presto API error due to timeout")
-      raise @exception
+      exception! PrestoHttpError.new(408, "Presto API error due to timeout")
     end
 
     def raise_if_timeout!
       if @started_at
-        if @results && @results.next_uri == nil
-          # query is already done
-          return
-        end
+        return if finished?
 
         elapsed = Process.clock_gettime(Process::CLOCK_MONOTONIC) - @started_at
 
@@ -234,9 +244,9 @@ module Presto::Client
 
     def raise_timeout_error!
       if query_id = @results && @results.id
-        raise PrestoQueryTimeoutError, "Query #{query_id} timed out"
+        exception! PrestoQueryTimeoutError.new("Query #{query_id} timed out")
       else
-        raise PrestoQueryTimeoutError, "Query timed out"
+        exception! PrestoQueryTimeoutError.new("Query timed out")
       end
     end
 
@@ -249,7 +259,9 @@ module Presto::Client
     end
 
     def close
-      return if @closed
+      return unless running?
+
+      @state = :client_aborted
 
       begin
         if uri = @results.next_uri
@@ -260,7 +272,6 @@ module Presto::Client
       rescue => e
       end
 
-      @closed = true
       nil
     end
   end

data/lib/presto/client/version.rb

@@ -15,6 +15,6 @@
 #
 module Presto
   module Client
-    VERSION = "0.6.0"
+    VERSION = "0.6.5"
   end
 end

data/modelgen/model_versions.rb

@@ -198,9 +198,9 @@ module Presto::Client::ModelVersions
         end
         obj = allocate
         model_class = case hash["@type"]
-            when "CreateHandle"       then CreateHandle
-            when "InsertHandle"       then InsertHandle
-            when "DeleteHandle"       then DeleteHandle
+            when "CreateTarget"       then CreateTarget
+            when "InsertTarget"       then InsertTarget
+            when "DeleteTarget"       then DeleteTarget
         end
         if model_class
            model_class.decode(hash)

data/presto-client.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |gem|
   gem.description   = %q{Presto client library}
   gem.summary       = %q{Presto client library}
   gem.homepage      = "https://github.com/treasure-data/presto-client-ruby"
-  gem.license       = "Apache 2.0"
+  gem.license       = "Apache-2.0"
 
   gem.files         = `git ls-files`.split($\)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
@@ -20,6 +20,7 @@ Gem::Specification.new do |gem|
   gem.required_ruby_version = ">= 1.9.1"
 
   gem.add_dependency "faraday", ["~> 0.12"]
+  gem.add_dependency "faraday_middleware", ["~> 0.12.2"]
     gem.add_dependency "msgpack", [">= 0.7.0"]
 
   gem.add_development_dependency "rake", [">= 0.9.2", "< 11.0"]

data/release.rb

@@ -0,0 +1,56 @@
+#!/usr/bin/env ruby
+
+require 'fileutils'
+
+PREFIX = 'https://github.com/treasure-data/presto-client-ruby'
+RELEASE_NOTES_FILE = "ChangeLog.md"
+
+last_tag = `git describe --tags --abbrev=0`.chomp
+last_version = last_tag.sub("v", "")
+puts "last version: #{last_version}"
+
+print "next version? "
+next_version = STDIN.gets.chomp
+
+abort("Can't use empty version string") if next_version.empty?
+
+logs = `git log #{last_tag}..HEAD --pretty=format:'%h %s'`
+# Add links to GitHub issues
+logs = logs.gsub(/\#([0-9]+)/, "[#\\1](#{PREFIX}/issues/\\1)")
+
+new_release_notes = []
+new_release_notes <<= "\#\# #{next_version}\n"
+new_release_notes <<= logs.split(/\n/)
+  .reject{|line| line.include?("#{last_version} release notes")}
+  .map{|x|
+    rev = x[0..6]
+    "- #{x[8..-1]} [[#{rev}](#{PREFIX}/commit/#{rev})]\n"
+  }
+
+release_notes = []
+notes = File.readlines(RELEASE_NOTES_FILE)
+
+release_notes <<= notes[0..1]
+release_notes <<= new_release_notes
+release_notes <<= "\n"
+release_notes <<= notes[2..-1]
+
+TMP_RELEASE_NOTES_FILE = "#{RELEASE_NOTES_FILE}.tmp"
+File.delete(TMP_RELEASE_NOTES_FILE) if File.exists?(TMP_RELEASE_NOTES_FILE)
+File.write("#{TMP_RELEASE_NOTES_FILE}", release_notes.join)
+system("cat #{TMP_RELEASE_NOTES_FILE} | vim - -c ':f #{TMP_RELEASE_NOTES_FILE}' -c ':9'")
+
+abort("The release note file is not saved. Aborted") unless File.exists?(TMP_RELEASE_NOTES_FILE)
+
+def run(cmd)
+  puts cmd
+  system cmd
+end
+
+FileUtils.cp(TMP_RELEASE_NOTES_FILE, RELEASE_NOTES_FILE)
+File.delete(TMP_RELEASE_NOTES_FILE)
+
+# run "git commit #{RELEASE_NOTES_FILE} -m \"Add #{next_version} release notes\""
+# run "git tag v#{next_version}"
+# run "git push"
+# run "git push --tags"

data/spec/basic_query_spec.rb

@@ -0,0 +1,82 @@
+require 'spec_helper'
+
+describe Presto::Client::Client do
+  before(:all) do
+    WebMock.disable!
+    @cluster = TinyPresto::Cluster.new('ghcr.io/trinodb/presto', '316')
+    @container = @cluster.run
+    @client = Presto::Client.new(server: 'localhost:8080', catalog: 'memory', user: 'test-user', schema: 'default')
+    loop do
+      begin
+        @client.run('show schemas')
+        break
+      rescue StandardError => exception
+        puts "Waiting for cluster ready... #{exception}"
+        sleep(3)
+      end
+    end
+    puts 'Cluster is ready'
+  end
+
+  after(:all) do
+    @cluster.stop
+    WebMock.enable!
+  end
+
+  it 'show schemas' do
+    columns, rows = run_with_retry(@client, 'show schemas')
+    expect(columns.length).to be(1)
+    expect(rows.length).to be(2)
+  end
+
+  it 'ctas' do
+    expected = [[1, 'a'], [2, 'b']]
+    run_with_retry(@client, "create table ctas1 as select * from (values (1, 'a'), (2, 'b')) t(c1, c2)")
+    columns, rows = run_with_retry(@client, 'select * from ctas1')
+    expect(columns.map(&:name)).to match_array(%w[c1 c2])
+    expect(rows).to eq(expected)
+  end
+
+  it 'next_uri' do
+    @client.query('show schemas') do |q|
+      expect(q.next_uri).to start_with('http://localhost:8080/v1/statement/')
+    end
+  end
+
+  it 'advance' do
+    @client.query('show schemas') do |q|
+      expect(q.advance).to be(true)
+    end
+  end
+
+  it 'current query result' do
+    @client.query('show schemas') do |q|
+      expect(q.current_results.info_uri).to start_with('http://localhost:8080/ui/query.html')
+    end
+  end
+
+  it 'statement stats' do
+    @client.query('show schemas') do |q|
+      stats = q.current_results.stats
+      # Immediate subsequent request should get queued result
+      expect(stats.queued).to be(true)
+      expect(stats.scheduled).to be(false)
+    end
+  end
+
+  it 'partial cancel' do
+    @client.query('show schemas') do |q|
+      q.cancel
+      expect { q.query_info }.to raise_error(Presto::Client::PrestoHttpError, /Error 410 Gone/)
+    end
+  end
+
+  it 'row chunk' do
+    expected_schemas = %w[default information_schema]
+    @client.query('show schemas') do |q|
+      q.each_row do |r|
+        expect(expected_schemas).to include(r[0])
+      end
+    end
+  end
+end

data/spec/gzip_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe Presto::Client::Client do
+  before(:all) do
+    @spec_path = File.dirname(__FILE__)
+    WebMock.disable!
+    @cluster = TinyPresto::Cluster.new('ghcr.io/trinodb/presto', '316')
+    @container = @cluster.run
+    @client = Presto::Client.new(server: 'localhost:8080', catalog: 'tpch', user: 'test-user', schema: 'tiny', gzip: true, http_debug: true)
+    loop do
+      begin
+        # Make sure to all workers are available.
+        @client.run('select 1234')
+        break
+      rescue StandardError => exception
+        puts "Waiting for cluster ready... #{exception}"
+        sleep(5)
+      end
+    end
+    puts 'Cluster is ready'
+  end
+
+  after(:all) do
+    @cluster.stop
+    WebMock.enable!
+  end
+
+  it 'tpch q01 with gzip option' do
+    $stdout = StringIO.new
+    begin
+      q = File.read("#{@spec_path}/tpch/q01.sql")
+      columns, rows = run_with_retry(@client, q)
+      expect(columns.length).to be(10)
+      expect(rows.length).to be(4)
+      expect($stdout.string).to include ('content-encoding: "gzip"')
+    ensure
+      $stdout = STDOUT
+    end
+  end
+end