sqlui 0.1.41 → 0.1.43

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4307dfb13604d60040248f4a4135756f52310be559dfd3a65778e8400ab5454
-  data.tar.gz: 00ea3b80ba354e767521943cf83058cceebd53d5d3f112fdabc09952ee375471
+  metadata.gz: 27a06365c7119cba4bff1e78df66d107910a0cbe45422139ec34902828eda0a4
+  data.tar.gz: 3a1e8662d710c6b6f4d7c8331c95073f58a3365cc6d12efe32f3ef3774fb91d5
 SHA512:
-  metadata.gz: 1aab467177964e30d47233e5f8e60922732de9cdb0238104dc7b74eecf9271ce80e3ac449c3afaac5c4ea91863160cd7edbf352b88cc8ae11274b738abe60271
-  data.tar.gz: 2d644c6ecd81b489acad2986be0d60f0dee3c20e5165943938279148af8f4f9f7a923a410bed570be71aad99b3f591ff92c050cd2a27df9ae06bdbb4b63ef8d7
+  metadata.gz: 404e9bde7c78d0837c0cbdaae300e9424b88f58dc03344651ad4ac24111f96a6061db6248f49184f7c76321dfe95b599839c118564850ff382ea7567b3abc5fe
+  data.tar.gz: 1ad31d5edc998e57ef2be13ef6ba27b83071cd887b0438c1024895c058a0cb554ea25a1edf1cd4863f47e1e56b5c3c7f4adfa02682be4fa630f38093d3174a38

data/.version

@@ -1 +1 @@
-0.1.41
+0.1.43

data/app/server.rb

@@ -1,9 +1,12 @@
 # frozen_string_literal: true
 
+require 'base64'
+require 'csv'
 require 'erb'
 require 'json'
 require 'sinatra/base'
 require 'uri'
+require 'webrick/log'
 require_relative 'database_metadata'
 require_relative 'mysql_types'
 require_relative 'sql_parser'
@@ -24,6 +27,8 @@ class Server < Sinatra::Base
     set :raise_errors,    false
     set :show_exceptions, false
 
+    logger = WEBrick::Log.new
+
     get '/-/health' do
       status 200
       body 'OK'
@@ -91,43 +96,54 @@ class Server < Sinatra::Base
         params.merge!(JSON.parse(request.body.read, symbolize_names: true))
         break client_error('missing sql') unless params[:sql]
 
-        full_sql = params[:sql]
-        sql = params[:sql]
         variables = params[:variables] || {}
-        if params[:selection]
-          selection = params[:selection]
-          if selection.include?('-')
-            # sort because the selection could be in either direction
-            selection = params[:selection].split('-').map { |v| Integer(v) }.sort
-          else
-            selection = Integer(selection)
-            selection = [selection, selection]
-          end
-
-          sql = if selection[0] == selection[1]
-                  SqlParser.find_statement_at_cursor(params[:sql], selection[0])
-                else
-                  full_sql[selection[0], selection[1]]
-                end
-
-          break client_error("can't find query at selection") unless sql
-        end
+        sql = find_selected_query(params[:sql], params[:selection])
 
         result = database.with_client do |client|
-          variables.each do |name, value|
-            client.query("SET @#{name} = #{value};")
-          end
-          execute_query(client, sql)
+          query_result = execute_query(client, variables, sql)
+          # NOTE: the call to result.field_types must go before other interaction with the result. Otherwise you will
+          # get a seg fault. Seems to be a bug in Mysql2.
+          # TODO: stream this and render results on the client as they are returned?
+          {
+            columns: query_result.fields,
+            column_types: MysqlTypes.map_to_google_charts_types(query_result.field_types),
+            total_rows: query_result.size,
+            rows: (query_result.to_a || []).take(Sqlui::MAX_ROWS)
+          }
         end
 
         result[:selection] = params[:selection]
-        result[:query] = full_sql
+        result[:query] = params[:sql]
 
         status 200
         headers 'Content-Type' => 'application/json; charset=utf-8'
         body result.to_json
       end
 
+      get "#{database.url_path}/download_csv" do
+        break client_error('missing sql') unless params[:sql]
+
+        sql = Base64.decode64(params[:sql]).force_encoding('UTF-8')
+        logger.info "sql: #{sql}"
+        variables = params.map { |k, v| k[0] == '_' ? [k, v] : nil }.compact.to_h
+        sql = find_selected_query(sql, params[:selection])
+        logger.info "sql: #{sql}"
+
+        content_type 'application/csv; charset=utf-8'
+        attachment 'result.csv'
+        status 200
+
+        database.with_client do |client|
+          query_result = execute_query(client, variables, sql)
+          stream do |out|
+            out << CSV::Row.new(query_result.fields, query_result.fields, header_row: true).to_s.strip
+            query_result.each do |row|
+              out << "\n#{CSV::Row.new(query_result.fields, row).to_s.strip}"
+            end
+          end
+        end
+      end
+
       get(%r{#{Regexp.escape(database.url_path)}/(query|graph|structure|saved)}) do
         @html ||= File.read(File.join(resources_dir, 'sqlui.html'))
         status 200
@@ -158,30 +174,33 @@ class Server < Sinatra::Base
     body({ error: message, stacktrace: stacktrace }.compact.to_json)
   end
 
-  def execute_query(client, sql)
+  def find_selected_query(full_sql, selection)
+    return full_sql unless selection
+
+    if selection.include?('-')
+      # sort because the selection could be in either direction
+      selection = selection.split('-').map { |v| Integer(v) }.sort
+    else
+      selection = Integer(selection)
+      selection = [selection, selection]
+    end
+
+    if selection[0] == selection[1]
+      SqlParser.find_statement_at_cursor(full_sql, selection[0])
+    else
+      full_sql[selection[0], selection[1]]
+    end
+  end
+
+  def execute_query(client, variables, sql)
+    variables.each do |name, value|
+      client.query("SET @#{name} = #{value};")
+    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.to_a
-      columns = result.fields
-    else
-      column_types = []
-      rows = []
-      columns = []
-    end
-    {
-      columns: columns,
-      column_types: column_types,
-      total_rows: rows.size,
-      rows: rows.take(Sqlui::MAX_ROWS)
-    }
+    queries.map { |current| client.query(current) }.last
   end
 end

data/app/sqlui.rb

@@ -5,7 +5,7 @@ require_relative 'server'
 
 # Main entry point.
 class Sqlui
-  MAX_ROWS = 1_000
+  MAX_ROWS = 10_000
 
   def initialize(config_file)
     raise 'you must specify a configuration file' unless config_file

data/client/resources/sqlui.css

@@ -218,6 +218,15 @@ p {
     outline: none
 }
 
+.submit-dropdown-content-button.disabled {
+    color: #888 !important;
+    cursor: auto !important;
+}
+
+.submit-dropdown-content-button.disabled:hover {
+    background: none !important;
+}
+
 .status {
     display: flex;
     justify-content: center;

data/client/resources/sqlui.html

@@ -41,8 +41,9 @@
               <input id="submit-dropdown-button-toggle" class="submit-dropdown-content-button" type="button" value="toggle default"></input>
             </div>
             <div class="submit-dropdown-content-section">
-              <input id="submit-dropdown-button-copy-csv" class="submit-dropdown-content-button" type="button" value="copy to clipboard (csv)"></input>
-              <input id="submit-dropdown-button-copy-tsv" class="submit-dropdown-content-button" type="button" value="copy to clipboard (tsv)"></input>
+              <input id="submit-dropdown-button-copy-csv" class="submit-dropdown-content-button disabled" type="button" value="copy to clipboard (csv)"></input>
+              <input id="submit-dropdown-button-copy-tsv" class="submit-dropdown-content-button disabled" type="button" value="copy to clipboard (tsv)"></input>
+              <input id="submit-dropdown-button-download-csv" class="submit-dropdown-content-button disabled" type="button" value="download (csv)"></input>
             </div>
           </div>
         </div>

data/client/resources/sqlui.js

@@ -23271,7 +23271,7 @@
      LineComment = 1,
      BlockComment = 2,
      String$1 = 3,
-     Number = 4,
+     Number$1 = 4,
      Bool = 5,
      Null = 6,
      ParenL = 7,
@@ -23540,18 +23540,18 @@
                    input.advance();
                if (quoted && input.next == 39 /* Ch.SingleQuote */)
                    input.advance();
-               input.acceptToken(Number);
+               input.acceptToken(Number$1);
            }
            else if (next == 46 /* Ch.Dot */ && input.next >= 48 /* Ch._0 */ && input.next <= 57 /* Ch._9 */) {
                readNumber(input, true);
-               input.acceptToken(Number);
+               input.acceptToken(Number$1);
            }
            else if (next == 46 /* Ch.Dot */) {
                input.acceptToken(Dot);
            }
            else if (next >= 48 /* Ch._0 */ && next <= 57 /* Ch._9 */) {
                readNumber(input, false);
-               input.acceptToken(Number);
+               input.acceptToken(Number$1);
            }
            else if (inString(next, d.operatorChars)) {
                while (inString(input.next, d.operatorChars))
@@ -23867,6 +23867,31 @@
      return match ? match[1] : identifier
    }
 
+   function base64Encode (str) {
+     // https://stackoverflow.com/questions/30106476/using-javascripts-atob-to-decode-base64-doesnt-properly-decode-utf-8-strings
+     return btoa(encodeURIComponent(str).replace(/%([0-9A-F]{2})/g,
+       function toSolidBytes (match, p1) {
+         return String.fromCharCode(Number(`0x${p1}`))
+       }))
+   }
+
+   function getSqlFromUrl (url) {
+     const params = url.searchParams;
+     if (params.has('file') && params.has('sql')) {
+       // TODO: show an error.
+       throw new Error('You can only specify a file or sql param, not both.')
+     }
+     if (params.has('sql')) {
+       return params.get('sql')
+     } else if (params.has('file')) {
+       const file = params.get('file');
+       const fileDetails = window.metadata.saved[file];
+       if (!fileDetails) throw new Error(`no such file: ${file}`)
+       return fileDetails.contents
+     }
+     throw new Error('You must specify a file or sql param')
+   }
+
    function init (parent, onSubmit, onShiftSubmit) {
      addClickListener(document.getElementById('query-tab-button'), (event) => selectTab(event, 'query'));
      addClickListener(document.getElementById('saved-tab-button'), (event) => selectTab(event, 'saved'));
@@ -23907,9 +23932,7 @@
 
      const copyListenerFactory = (delimiter) => {
        return () => {
-         if (
-           !window.sqlFetch?.result
-         ) {
+         if (!window.sqlFetch?.result) {
            return
          }
          const type = 'text/plain';
@@ -23935,6 +23958,21 @@
      };
      addClickListener(document.getElementById('submit-dropdown-button-copy-csv'), copyListenerFactory(','));
      addClickListener(document.getElementById('submit-dropdown-button-copy-tsv'), copyListenerFactory('\t'));
+     addClickListener(document.getElementById('submit-dropdown-button-download-csv'), () => {
+       if (!window.sqlFetch?.result) return
+
+       const url = new URL(window.location);
+       url.searchParams.set('sql', base64Encode(getSqlFromUrl(url)));
+       url.searchParams.delete('file');
+       setActionInUrl(url, 'download_csv');
+
+       const link = document.createElement('a');
+       link.setAttribute('download', 'result.csv');
+       link.setAttribute('href', url.href);
+       link.click();
+
+       focus(getSelection());
+     });
 
      document.addEventListener('click', function (event) {
        if (event.target !== dropdownButton) {
@@ -24223,8 +24261,8 @@
      });
    }
 
-   function setTabInUrl (url, tab) {
-     url.pathname = url.pathname.replace(/\/[^/]+$/, `/${tab}`);
+   function setActionInUrl (url, action) {
+     url.pathname = url.pathname.replace(/\/[^/]+$/, `/${action}`);
    }
 
    function getTabFromUrl (url) {
@@ -24238,19 +24276,19 @@
 
    function updateTabs () {
      const url = new URL(window.location);
-     setTabInUrl(url, 'graph');
+     setActionInUrl(url, 'graph');
      document.getElementById('graph-tab-button').href = url.pathname + url.search;
-     setTabInUrl(url, 'saved');
+     setActionInUrl(url, 'saved');
      document.getElementById('saved-tab-button').href = url.pathname + url.search;
-     setTabInUrl(url, 'structure');
+     setActionInUrl(url, 'structure');
      document.getElementById('structure-tab-button').href = url.pathname + url.search;
-     setTabInUrl(url, 'query');
+     setActionInUrl(url, 'query');
      document.getElementById('query-tab-button').href = url.pathname + url.search;
    }
 
    function selectTab (event, tab) {
      const url = new URL(window.location);
-     setTabInUrl(url, tab);
+     setActionInUrl(url, tab);
      route(event.target, event, url, true);
    }
 
@@ -24459,6 +24497,7 @@
      document.getElementById('graph-status').style.display = 'flex';
      document.getElementById('fetch-sql-box').style.display = 'none';
      document.getElementById('cancel-button').style.display = 'none';
+     updateDownloadButtons(window?.sqlFetch);
      maybeFetchResult(internal);
 
      focus(getSelection());
@@ -24493,7 +24532,7 @@
      setSavedStatus(`${numFiles} file${numFiles === 1 ? '' : 's'}`);
      Object.values(saved).forEach(file => {
        const viewUrl = new URL(window.location.origin + window.location.pathname);
-       setTabInUrl(viewUrl, 'query');
+       setActionInUrl(viewUrl, 'query');
        viewUrl.searchParams.set('file', file.filename);
 
        const viewLinkElement = document.createElement('a');
@@ -24506,7 +24545,7 @@
        });
 
        const runUrl = new URL(window.location.origin + window.location.pathname);
-       setTabInUrl(runUrl, 'query');
+       setActionInUrl(runUrl, 'query');
        runUrl.searchParams.set('file', file.filename);
        runUrl.searchParams.set('run', 'true');
 
@@ -24607,6 +24646,7 @@
      clearGraphStatus();
      clearResultBox();
      clearResultStatus();
+     disableDownloadButtons();
    }
 
    function clearResultStatus () {
@@ -24876,7 +24916,28 @@
      });
    }
 
+   function disableDownloadButtons () {
+     document.getElementById('submit-dropdown-button-download-csv').classList.add('disabled');
+     document.getElementById('submit-dropdown-button-copy-csv').classList.add('disabled');
+     document.getElementById('submit-dropdown-button-copy-tsv').classList.add('disabled');
+   }
+
+   function enableDownloadButtons () {
+     document.getElementById('submit-dropdown-button-download-csv').classList.remove('disabled');
+     document.getElementById('submit-dropdown-button-copy-csv').classList.remove('disabled');
+     document.getElementById('submit-dropdown-button-copy-tsv').classList.remove('disabled');
+   }
+
+   function updateDownloadButtons (fetch) {
+     if (fetch?.state === 'success') {
+       enableDownloadButtons();
+     } else {
+       disableDownloadButtons();
+     }
+   }
+
    function displaySqlFetch (fetch) {
+     updateDownloadButtons(fetch);
      if (window.tab === 'query') {
        displaySqlFetchInResultTab(fetch);
      } else if (window.tab === 'graph') {
@@ -25005,7 +25066,7 @@
      if (result.total_rows === 1) {
        statusElement.innerText = `${result.total_rows} row (${elapsed}s)`;
      } else {
-       statusElement.innerText = `${result.total_rows} rows (${elapsed}s)`;
+       statusElement.innerText = `${result.total_rows.toLocaleString()} rows (${elapsed}s)`;
      }
 
      if (result.total_rows > result.rows.length) {

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sqlui
 version: !ruby/object:Gem::Version
-  version: 0.1.41
+  version: 0.1.43
 platform: ruby
 authors:
 - Nick Dower
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-18 00:00:00.000000000 Z
+date: 2022-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mysql2