sqlui 0.1.19 → 0.1.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3e42ae906ab341a224ba0904cf74be9224a13e6284e2ead198a382926e84db34
-  data.tar.gz: bd8f33a32f30179057914b9f291ff4af084f6917d8123f2bba550d5974df9b6f
+  metadata.gz: 1781b502f4bf82b9a87461d495cb6776f9290bfb5a2809a7ddb12e992ce7cc5c
+  data.tar.gz: a992696d1bbd1f809290035fa23c7cfec262f827073665e9013254420794d6d4
 SHA512:
-  metadata.gz: c1f4f3c0f0e180b6aea398da508f7bc551edd19fd77e24f60825bfb33c7f4130e1299770a160947d27854cc7dbd26d76fda6436528561b82720b0652815208dc
-  data.tar.gz: 1e275114bf9e63d2182c1a4a2a2390ebe97a14ad5b15d1b21ac0e276fbadce766203e42546cf09b6bbdaf9e0bc4c8abc451aa2756dc02334b2dc89f403ae6447
+  metadata.gz: b6bfc097c3e9f427aec918c9b3eabeef74a69a3109fff6588c2a87201c9f43a7a0839463ec1cbe400b5d880ee1c3f069e6ecea6978acb02fd152633cc841f448
+  data.tar.gz: 9ec1cfb0f64cc425331723856e89aab3d2fac02f107a381a7c7ab6b2f1c4f0ee40adbe87b458c14fb537fe72ecb5eff044f02812e82fceb9c1263cff369a6ee3

data/.version

@@ -1 +1 @@
-0.1.19
+0.1.21

data/app/args.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+# Argument validation.
+class Args
+  def self.fetch_non_empty_string(hash, key)
+    value = fetch_non_nil(hash, key, String)
+    raise ArgumentError, "required parameter #{key} empty" if value.strip.empty?
+
+    value
+  end
+
+  def self.fetch_non_empty_hash(hash, key)
+    value = fetch_non_nil(hash, key, Hash)
+    raise ArgumentError, "required parameter #{key} empty" if value.empty?
+
+    value
+  end
+
+  def self.fetch_non_nil(hash, key, *classes)
+    raise ArgumentError, "required parameter #{key} missing" unless hash.key?(key)
+
+    value = hash[key]
+    raise ArgumentError, "required parameter #{key} null" if value.nil?
+
+    if classes.size.positive? && !classes.find { |clazz| value.is_a?(clazz) }
+      raise ArgumentError, "required parameter #{key} not a #{classes[0].to_s.downcase}" if classes.size == 1
+
+      raise ArgumentError, "required parameter #{key} not #{classes.map(&:to_s).map(&:downcase).join(' or ')}"
+    end
+
+    value
+  end
+end

data/app/database_config.rb

@@ -1,21 +1,21 @@
 # frozen_string_literal: true
 
 require 'mysql2'
+require_relative 'args'
 
 # Config for a single database.
 class DatabaseConfig
-  attr_reader :display_name, :description, :url_path, :saved_path, :client_params, :database
+  attr_reader :display_name, :description, :url_path, :saved_path, :client_params
 
   def initialize(hash)
-    @display_name = hash[:display_name].strip
-    @description = hash[:description].strip
-    @url_path = hash[:url_path].strip
+    @display_name = Args.fetch_non_empty_string(hash, :display_name).strip
+    @description = Args.fetch_non_empty_string(hash, :description).strip
+    @url_path = Args.fetch_non_empty_string(hash, :url_path).strip
     raise ArgumentError, 'url_path should start with a /' unless @url_path.start_with?('/')
     raise ArgumentError, 'url_path should not end with a /' if @url_path.length > 1 && @url_path.end_with?('/')
 
-    @saved_path = hash[:saved_path].strip
-    @client_params = hash[:client_params]
-    @database = @client_params[:database].strip
+    @saved_path = Args.fetch_non_empty_string(hash, :saved_path).strip
+    @client_params = Args.fetch_non_empty_hash(hash, :client_params)
   end
 
   def with_client(&block)

data/app/database_metadata.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+# Loads metadata from a database.
+class DatabaseMetadata
+  def initialize
+    raise "can't instantiate #{self.class}"
+  end
+
+  class << self
+    def lookup(client, database_config)
+      result = load_columns(client, database_config)
+      load_stats(result, client, database_config)
+
+      result
+    end
+
+    private
+
+    def load_columns(client, database_config)
+      result = {}
+      database = database_config.client_params[:database]
+      where_clause = if database
+                       "where table_schema = '#{database}'"
+                     else
+                       "where table_schema not in('mysql', 'sys', 'information_schema', 'performance_schema')"
+                     end
+      column_result = client.query(
+        <<~SQL
+          select
+            table_schema,
+            table_name,
+            column_name,
+            data_type,
+            character_maximum_length,
+            is_nullable,
+            column_key,
+            column_default,
+            extra
+          from information_schema.columns
+          #{where_clause}
+          order by table_schema, table_name, column_name, ordinal_position;
+        SQL
+      )
+      column_result.each do |row|
+        row = row.transform_keys(&:downcase).transform_keys(&:to_sym)
+        table_schema = row[:table_schema]
+        unless result[table_schema]
+          result[table_schema] = {
+            tables: {}
+          }
+        end
+        table_name = row[:table_name]
+        tables = result[table_schema][:tables]
+        unless tables[table_name]
+          tables[table_name] = {
+            indexes: {},
+            columns: {}
+          }
+        end
+        columns = result[table_schema][:tables][table_name][:columns]
+        column_name = row[:column_name]
+        columns[column_name] = {} unless columns[column_name]
+        column = columns[column_name]
+        column[:name] = column_name
+        column[:data_type] = row[:data_type]
+        column[:length] = row[:character_maximum_length]
+        column[:allow_null] = row[:is_nullable]
+        column[:key] = row[:column_key]
+        column[:default] = row[:column_default]
+        column[:extra] = row[:extra]
+      end
+      result
+    end
+
+    def load_stats(result, client, database_config)
+      database = database_config.client_params[:database]
+
+      where_clause = if database
+                       "where table_schema = '#{database}'"
+                     else
+                       "where table_schema not in('mysql', 'sys', 'information_schema', 'performance_schema')"
+                     end
+      stats_result = client.query(
+        <<~SQL
+          select
+            table_schema,
+            table_name,
+            index_name,
+            seq_in_index,
+            non_unique,
+            column_name
+          from information_schema.statistics
+          #{where_clause}
+          order by table_schema, table_name, if(index_name = "PRIMARY", 0, index_name), seq_in_index;
+      SQL
+      )
+      stats_result.each do |row|
+        row = row.transform_keys(&:downcase).transform_keys(&:to_sym)
+        table_schema = row[:table_schema]
+        tables = result[table_schema][:tables]
+        table_name = row[:table_name]
+        indexes = tables[table_name][:indexes]
+        index_name = row[:index_name]
+        indexes[index_name] = {} unless indexes[index_name]
+        index = indexes[index_name]
+        column_name = row[:column_name]
+        index[column_name] = {}
+        column = index[column_name]
+        column[:name] = index_name
+        column[:seq_in_index] = row[:seq_in_index]
+        column[:non_unique] = row[:non_unique]
+        column[:column_name] = row[:column_name]
+      end
+    end
+  end
+end

data/app/deep.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+# Deep extensions for Enumerable.
+module Enumerable
+  def deep_transform_keys!(&block)
+    each { |value| value.deep_transform_keys!(&block) if value.respond_to?(:deep_transform_keys!) }
+    self
+  end
+
+  def deep_dup(result = {})
+    map do |value|
+      value.respond_to?(:deep_dup) ? value.deep_dup : value.clone
+    end
+    result
+  end
+end
+
+# Deep extensions for Hash.
+class Hash
+  def deep_transform_keys!(&block)
+    transform_keys!(&:to_s)
+    each_value { |value| value.deep_transform_keys!(&block) if value.respond_to?(:deep_transform_keys!) }
+    self
+  end
+
+  def deep_dup(result = {})
+    each do |key, value|
+      result[key] = value.respond_to?(:deep_dup) ? value.deep_dup : value.clone
+    end
+    result
+  end
+
+  def deep_set(*path, value:)
+    raise ArgumentError, 'no path specified' if path.empty?
+
+    if path.size == 1
+      self[path[0]] = value
+    else
+      raise KeyError, "key not found: #{path[0]}" unless key?(path[0])
+      raise ArgumentError, "value for key is not a hash: #{path[0]}" unless self.[](path[0]).is_a?(Hash)
+
+      self.[](path[0]).deep_set(*path[1..], value: value)
+    end
+  end
+
+  def deep_delete(*path)
+    raise ArgumentError, 'no path specified' if path.empty?
+    raise KeyError, "key not found: #{path[0]}" unless key?(path[0])
+
+    if path.size == 1
+      delete(path[0])
+    else
+      raise ArgumentError, "value for key is not a hash: #{path[0]}" unless self.[](path[0]).is_a?(Hash)
+
+      self.[](path[0]).deep_delete(*path[1..])
+    end
+  end
+end

data/app/mysql_types.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+# Maps MySQL data types to type descriptions the client can use.
+class MysqlTypes
+  def initialize
+    raise "can't instantiate #{self.class}"
+  end
+
+  class << self
+    def map_to_google_charts_types(types)
+      types.map do |type|
+        type = type.gsub(/\([^)]*\)/, '').strip
+        case type
+        when 'bool', 'boolean'
+          'boolean'
+        when /double/, 'bigint', 'bit', 'dec', 'decimal', 'float', 'int', 'integer', 'mediumint', 'smallint', 'tinyint'
+          'number'
+        when /char/, /binary/, /blob/, /text/, 'enum', 'set', /image/
+          'string'
+        when 'date', 'year'
+          'date'
+        when 'datetime', 'timestamp'
+          'datetime'
+        when 'time'
+          'timeofday'
+        else
+          puts "unexpected MySQL type: #{type}"
+          'string'
+        end
+      end
+    end
+  end
+end

data/app/server.rb

@@ -4,112 +4,137 @@ require 'erb'
 require 'json'
 require 'sinatra/base'
 require 'uri'
+require_relative 'database_metadata'
 require_relative 'environment'
+require_relative 'mysql_types'
 require_relative 'sql_parser'
-require_relative 'sqlui_config'
-
-if ARGV.include?('-v') || ARGV.include?('--version')
-  puts File.read('.version')
-  exit
-end
-
-raise 'you must specify a configuration file' unless ARGV.size == 1
-raise 'configuration file does not exist' unless File.exist?(ARGV[0])
+require_relative 'sqlui'
 
 # SQLUI Sinatra server.
 class Server < Sinatra::Base
-  MAX_ROWS = 1_000
-
-  CONFIG = SqluiConfig.new(ARGV[0])
-
-  def initialize(app = nil, **_kwargs)
-    super
-    @config = Server::CONFIG
-    @resources_dir = File.join(File.expand_path('..', File.dirname(__FILE__)), 'client', 'resources')
-  end
+  def self.init_and_run(config, resources_dir)
+    set :logging,         true
+    set :bind,            '0.0.0.0'
+    set :port,            Environment.server_port
+    set :env,             Environment.server_env
+    set :raise_errors,    false
+    set :show_exceptions, false
+
+    get '/-/health' do
+      status 200
+      body 'OK'
+    end
 
-  set :logging, true
-  set :bind,    '0.0.0.0'
-  set :port,    Environment.server_port
-  set :env,     Environment.server_env
+    get "#{config.list_url_path}/?" do
+      erb :databases, locals: { config: config }
+    end
 
-  get '/-/health' do
-    status 200
-    body 'OK'
-  end
+    config.database_configs.each do |database|
+      get database.url_path.to_s do
+        redirect "#{database.url_path}/app", 301
+      end
 
-  get "#{CONFIG.list_url_path}/?" do
-    erb :databases, locals: { config: @config }
-  end
+      get "#{database.url_path}/app" do
+        @html ||= File.read(File.join(resources_dir, 'sqlui.html'))
+        status 200
+        headers 'Content-Type': 'text/html'
+        body @html
+      end
 
-  CONFIG.database_configs.each do |database|
-    get database.url_path.to_s do
-      redirect "#{params[:database]}/app", 301
-    end
+      get "#{database.url_path}/sqlui.css" do
+        @css ||= File.read(File.join(resources_dir, 'sqlui.css'))
+        status 200
+        headers 'Content-Type': 'text/css'
+        body @css
+      end
 
-    get "#{database.url_path}/app" do
-      @html ||= File.read(File.join(@resources_dir, 'sqlui.html'))
-      status 200
-      headers 'Content-Type': 'text/html'
-      body @html
-    end
+      get "#{database.url_path}/sqlui.js" do
+        @js ||= File.read(File.join(resources_dir, 'sqlui.js'))
+        status 200
+        headers 'Content-Type': 'text/javascript'
+        body @js
+      end
 
-    get "#{database.url_path}/sqlui.css" do
-      @css ||= File.read(File.join(@resources_dir, 'sqlui.css'))
-      status 200
-      headers 'Content-Type': 'text/css'
-      body @css
-    end
+      get "#{database.url_path}/metadata" do
+        metadata = database.with_client do |client|
+          {
+            server: config.name,
+            schemas: DatabaseMetadata.lookup(client, database),
+            saved: Dir.glob("#{database.saved_path}/*.sql").map do |path|
+              comment_lines = File.readlines(path).take_while do |l|
+                l.start_with?('--')
+              end
+              description = comment_lines.map { |l| l.sub(/^-- */, '') }.join
+              {
+                filename: File.basename(path),
+                description: description
+              }
+            end
+          }
+        end
+        status 200
+        headers 'Content-Type': 'application/json'
+        body metadata.to_json
+      end
 
-    get "#{database.url_path}/sqlui.js" do
-      @js ||= File.read(File.join(@resources_dir, 'sqlui.js'))
-      status 200
-      headers 'Content-Type': 'text/javascript'
-      body @js
-    end
+      get "#{database.url_path}/query_file" do
+        break client_error('missing file param') unless params[:file]
 
-    get "#{database.url_path}/metadata" do
-      database_config = @config.database_config_for(url_path: database.url_path)
-      metadata = database_config.with_client do |client|
-        load_metadata(client, database_config.database, database_config.saved_path)
-      end
-      status 200
-      headers 'Content-Type': 'application/json'
-      body metadata.to_json
-    end
+        file = File.join(database.saved_path, params[:file])
+        break client_error('no such file') unless File.exist?(file)
 
-    get "#{database.url_path}/query_file" do
-      return client_error('missing file param') unless params[:file]
-      return client_error('no such file') unless File.exist?(params[:file])
+        sql = File.read(file)
+        result = database.with_client do |client|
+          execute_query(client, sql).tap { |r| r[:file] = params[:file] }
+        end
 
-      database_config = @config.database_config_for(url_path: database.url_path)
-      sql = File.read(File.join(database_config.saved_path, params[:file]))
-      result = database_config.with_client do |client|
-        execute_query(client, sql).tap { |r| r[:file] = params[:file] }
+        status 200
+        headers 'Content-Type': 'application/json'
+        body result.to_json
       end
 
-      status 200
-      headers 'Content-Type': 'application/json'
-      body result.to_json
-    end
+      post "#{database.url_path}/query" do
+        params.merge!(JSON.parse(request.body.read, symbolize_names: true))
+        break client_error('missing sql') unless params[:sql]
+
+        sql = params[:sql]
+        selection = params[:selection]
+        if selection
+          selection = selection.split(':').map { |v| Integer(v) }
+
+          sql = if selection[0] == selection[1]
+                  SqlParser.find_statement_at_cursor(params[:sql], selection[0])
+                else
+                  params[:sql][selection[0], selection[1]]
+                end
+          break client_error("can't find query at selection") unless sql
+        end
 
-    post "#{database.url_path}/query" do
-      params.merge!(JSON.parse(request.body.read, symbolize_names: true))
-      return client_error('missing sql') unless params[:sql]
-      return client_error('missing cursor') unless params[:cursor]
+        result = database.with_client do |client|
+          execute_query(client, sql)
+        end
 
-      sql = SqlParser.find_statement_at_cursor(params[:sql], Integer(params[:cursor]))
-      raise "can't find query at cursor" unless sql
+        result[:selection] = params[:selection]
 
-      database_config = @config.database_config_for(url_path: database.url_path)
-      result = database_config.with_client do |client|
-        execute_query(client, sql)
+        status 200
+        headers 'Content-Type': 'application/json'
+        body result.to_json
       end
+    end
 
-      status 200
+    error do |e|
+      status 500
       headers 'Content-Type': 'application/json'
+      message = e.message.lines.first&.strip || 'unexpected error'
+      message = "#{message[0..80]}…" if message.length > 80
+      result = {
+        error: message,
+        stacktrace: e.backtrace.map { |b| b }.join("\n")
+      }
       body result.to_json
     end
+
+    run!
   end
 
   private
@@ -117,151 +142,34 @@ class Server < Sinatra::Base
   def client_error(message, stacktrace: nil)
     status(400)
     headers('Content-Type': 'application/json')
-    body({ message: message, stacktrace: stacktrace }.compact.to_json)
-  end
-
-  def load_metadata(client, database, saved_path)
-    result = {
-      server: @config.name,
-      schemas: {},
-      saved: Dir.glob("#{saved_path}/*.sql").map do |path|
-        {
-          filename: File.basename(path),
-          description: File.readlines(path).take_while { |l| l.start_with?('--') }.map { |l| l.sub(/^-- */, '') }.join
-        }
-      end
-    }
-
-    where_clause = if database
-                     "where table_schema = '#{database}'"
-                   else
-                     "where table_schema not in('mysql', 'sys', 'information_schema', 'performance_schema')"
-                   end
-    column_result = client.query(
-      <<~SQL
-        select
-          table_schema,
-          table_name,
-          column_name,
-          data_type,
-          character_maximum_length,
-          is_nullable,
-          column_key,
-          column_default,
-          extra
-        from information_schema.columns
-        #{where_clause}
-        order by table_schema, table_name, column_name, ordinal_position;
-    SQL
-    )
-    column_result.each do |row|
-      row = row.transform_keys(&:downcase).transform_keys(&:to_sym)
-      table_schema = row[:table_schema]
-      unless result[:schemas][table_schema]
-        result[:schemas][table_schema] = {
-          tables: {}
-        }
-      end
-      table_name = row[:table_name]
-      tables = result[:schemas][table_schema][:tables]
-      unless tables[table_name]
-        tables[table_name] = {
-          indexes: {},
-          columns: {}
-        }
-      end
-      columns = result[:schemas][table_schema][:tables][table_name][:columns]
-      column_name = row[:column_name]
-      columns[column_name] = {} unless columns[column_name]
-      column = columns[column_name]
-      column[:name] = column_name
-      column[:data_type] = row[:data_type]
-      column[:length] = row[:character_maximum_length]
-      column[:allow_null] = row[:is_nullable]
-      column[:key] = row[:column_key]
-      column[:default] = row[:column_default]
-      column[:extra] = row[:extra]
-    end
-
-    where_clause = if database
-                     "where table_schema = '#{database}'"
-                   else
-                     "where table_schema not in('mysql', 'sys', 'information_schema', 'performance_schema')"
-                   end
-    stats_result = client.query(
-      <<~SQL
-        select
-          table_schema,
-          table_name,
-          index_name,
-          seq_in_index,
-          non_unique,
-          column_name
-        from information_schema.statistics
-        #{where_clause}
-        order by table_schema, table_name, if(index_name = "PRIMARY", 0, index_name), seq_in_index;
-    SQL
-    )
-    stats_result.each do |row|
-      row = row.transform_keys(&:downcase).transform_keys(&:to_sym)
-      table_schema = row[:table_schema]
-      tables = result[:schemas][table_schema][:tables]
-      table_name = row[:table_name]
-      indexes = tables[table_name][:indexes]
-      index_name = row[:index_name]
-      indexes[index_name] = {} unless indexes[index_name]
-      index = indexes[index_name]
-      column_name = row[:column_name]
-      index[column_name] = {}
-      column = index[column_name]
-      column[:name] = index_name
-      column[:seq_in_index] = row[:seq_in_index]
-      column[:non_unique] = row[:non_unique]
-      column[:column_name] = row[:column_name]
-    end
-
-    result
+    body({ error: message, stacktrace: stacktrace }.compact.to_json)
   end
 
   def execute_query(client, sql)
-    result = client.query(sql, cast: false)
-    rows = result.map(&:values)
-    columns = result.first&.keys || []
-    # TODO: use field_types
-    column_types = columns.map { |_| 'string' }
-    unless rows.empty?
-      maybe_non_null_column_value_exemplars = columns.each_with_index.map do |_, index|
-        row = rows.find do |current|
-          !current[index].nil?
-        end
-        row.nil? ? nil : row[index]
-      end
-      column_types = maybe_non_null_column_value_exemplars.map do |value|
-        case value
-        when String, NilClass
-          'string'
-        when Integer, Float
-          'number'
-        when Date
-          'date'
-        when Time
-          'datetime'
-        when TrueClass, FalseClass
-          'boolean'
-        else
-          # TODO: report an error
-          value.class.to_s
-        end
-      end
+    queries = if sql.include?(';')
+                sql.split(/(?<=;)/).map(&:strip).reject(&:empty?)
+              else
+                [sql]
+              end
+    results = queries.map { |current| client.query(current) }
+    result = results[-1]
+    # NOTE: the call to result.field_types must go before any other interaction with the result. Otherwise you will
+    # get a seg fault. Seems to be a bug in Mysql2.
+    if result
+      column_types = MysqlTypes.map_to_google_charts_types(result.field_types)
+      rows = result.map(&:values)
+      columns = result.first&.keys || []
+    else
+      column_types = []
+      rows = []
+      columns = []
     end
     {
       query: sql,
       columns: columns,
       column_types: column_types,
       total_rows: rows.size,
-      rows: rows.take(MAX_ROWS)
+      rows: rows.take(Sqlui::MAX_ROWS)
     }
   end
-
-  run!
 end