sqlui 0.1.51 → 0.1.53

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1726ad80d8643d99cff2dd4dcf330d35cd109b8277bc6aaa09ae265a66b6018f
-  data.tar.gz: 9b61be584f56fb65d3239566d79bab94c6a45352201555c853ab726e682c0e86
+  metadata.gz: aecad7b8b4d0000efae09f66acce234f8d0617e83103c2d21a7e19c2b14f4de0
+  data.tar.gz: 0e35efaf9d1116e7d758dee9a409343654963608ec14e2f5f9714866db85365f
 SHA512:
-  metadata.gz: 57ea926197ec2949eea9af1ed9a55f0ddee7f3985fbfd8515d0401bbe4404a060f6514cbe71ac0f808aec1fc4d4670f3bd80029eda03b4f7a4bf88806f443225
-  data.tar.gz: 850c957b833956feb133189cfb1ff0dbffbfa8d31e1ef7065038f26b7cd4a3f3035cc47dd122c344746a130b4bf4e6f6f40a4e24ff7a88a96d8a4c3d4f006475
+  metadata.gz: b8871b41338fff2bec4a4130d783e6fed8d5a9ee80e2b2786f48740ca2ed5d17887a37df2b9c0e3cc8c9a4b2bb13dcc3d74ca3a3f54b5f318f20f9d98df92f6e
+  data.tar.gz: 1bf1575c392641fb2d3710a093e467382ab69c8656315ec801c837e0afdde5a36c0e0a8134f271c0f38a9249f92156255d5f7ddfb3dd56685b26a20ea0fed791

data/.release-version

@@ -0,0 +1 @@
+0.1.53

data/app/server.rb

@@ -4,12 +4,16 @@ require 'base64'
 require 'csv'
 require 'erb'
 require 'json'
+require 'prometheus/middleware/collector'
+require 'prometheus/middleware/exporter'
 require 'sinatra/base'
 require 'uri'
+require 'webrick'
 require_relative 'database_metadata'
 require_relative 'mysql_types'
 require_relative 'sql_parser'
 require_relative 'sqlui'
+require_relative 'version'
 
 # SQLUI Sinatra server.
 class Server < Sinatra::Base
@@ -18,6 +22,30 @@ class Server < Sinatra::Base
   end
 
   def self.init_and_run(config, resources_dir)
+    logger.info("Starting SQLUI v#{Version::SQLUI}")
+    logger.info("Airbrake enabled: #{config.airbrake[:server]&.[](:enabled) || false}")
+    if config.airbrake[:server]&.[](:enabled)
+      require 'airbrake'
+      require 'airbrake/rack'
+
+      Airbrake.configure do |c|
+        c.app_version = Version::SQLUI
+        c.environment = config.environment
+        c.logger.level = Logger::DEBUG if config.environment != :production?
+        config.airbrake[:server].each do |key, value|
+          c.send("#{key}=".to_sym, value) unless key == :enabled
+        end
+      end
+      Airbrake.add_filter(Airbrake::Rack::RequestBodyFilter.new)
+      Airbrake.add_filter(Airbrake::Rack::HttpParamsFilter.new)
+      Airbrake.add_filter(Airbrake::Rack::HttpHeadersFilter.new)
+      use Airbrake::Rack::Middleware
+    end
+
+    use Rack::Deflater
+    use Prometheus::Middleware::Collector
+    use Prometheus::Middleware::Exporter
+
     Mysql2::Client.default_query_options[:as] = :array
     Mysql2::Client.default_query_options[:cast_booleans] = true
     Mysql2::Client.default_query_options[:database_timezone] = :utc
@@ -53,17 +81,13 @@ class Server < Sinatra::Base
       end
 
       get "#{database.url_path}/sqlui.css" do
-        @css ||= File.read(File.join(resources_dir, 'sqlui.css'))
-        status 200
         headers 'Content-Type' => 'text/css; charset=utf-8'
-        body @css
+        send_file File.join(resources_dir, 'sqlui.css')
       end
 
       get "#{database.url_path}/sqlui.js" do
-        @js ||= File.read(File.join(resources_dir, 'sqlui.js'))
-        status 200
         headers 'Content-Type' => 'text/javascript; charset=utf-8'
-        body @js
+        send_file File.join(resources_dir, 'sqlui.js')
       end
 
       post "#{database.url_path}/metadata" do
@@ -99,7 +123,9 @@ class Server < Sinatra::Base
       end
 
       post "#{database.url_path}/query" do
-        params.merge!(JSON.parse(request.body.read, symbolize_names: true))
+        data = request.body.read
+        request.body.rewind # since Airbrake will read the body on error
+        params.merge!(JSON.parse(data, symbolize_names: true))
         break client_error('missing sql') unless params[:sql]
 
         variables = params[:variables] || {}
@@ -111,29 +137,42 @@ class Server < Sinatra::Base
         database.with_client do |client|
           query_result = execute_query(client, variables, sql)
           stream do |out|
-            json = <<~RES.chomp
-              {
-                "columns": #{query_result.fields.to_json},
-                "column_types": #{MysqlTypes.map_to_google_charts_types(query_result.field_types).to_json},
-                "total_rows": #{query_result.size.to_json},
-                "selection": #{params[:selection].to_json},
-                "query": #{params[:sql].to_json},
-                "rows": [
-            RES
-            out << json
-            bytes = json.bytesize
-            query_result.each_with_index do |row, i|
-              json = "#{i.zero? ? '' : ','}\n    #{row.to_json}"
-              bytes += json.bytesize
-              break if i == Sqlui::MAX_ROWS || bytes > Sqlui::MAX_BYTES
-
+            if query_result
+              json = <<~RES.chomp
+                {
+                  "columns": #{query_result.fields.to_json},
+                  "column_types": #{MysqlTypes.map_to_google_charts_types(query_result.field_types).to_json},
+                  "total_rows": #{query_result.size.to_json},
+                  "selection": #{params[:selection].to_json},
+                  "query": #{params[:sql].to_json},
+                  "rows": [
+              RES
               out << json
-            end
-            out << <<~RES
+              bytes = json.bytesize
+              query_result.each_with_index do |row, i|
+                json = "#{i.zero? ? '' : ','}\n    #{row.to_json}"
+                bytes += json.bytesize
+                break if i == Sqlui::MAX_ROWS || bytes > Sqlui::MAX_BYTES
+
+                out << json
+              end
+              out << <<~RES
 
-                ]
-              }
-            RES
+                  ]
+                }
+              RES
+            else
+              out << <<~RES
+                {
+                  "columns": [],
+                  "column_types": [],
+                  "total_rows": 0,
+                  "selection": #{params[:selection].to_json},
+                  "query": #{params[:sql].to_json},
+                  "rows": []
+                }
+              RES
+            end
           end
         end
       end
@@ -161,10 +200,14 @@ class Server < Sinatra::Base
       end
 
       get(%r{#{Regexp.escape(database.url_path)}/(query|graph|structure|saved)}) do
-        @html ||= File.read(File.join(resources_dir, 'sqlui.html'))
         status 200
-        headers 'Content-Type' => 'text/html; charset=utf-8'
-        body @html
+        client_config = config.airbrake[:client] || {}
+        erb :sqlui, locals: {
+          environment: config.environment.to_s,
+          airbrake_enabled: client_config[:enabled] || false,
+          airbrake_project_id: client_config[:project_id] || '',
+          airbrake_project_key: client_config[:project_key] || ''
+        }
       end
     end
 

data/app/sqlui.rb

@@ -2,6 +2,7 @@
 
 require_relative 'sqlui_config'
 require_relative 'server'
+require_relative 'version'
 
 # Main entry point.
 class Sqlui
@@ -25,7 +26,7 @@ class Sqlui
 
   def self.from_command_line(args)
     if args.include?('-v') || args.include?('--version')
-      puts File.read('.version')
+      puts Version::SQLUI
       exit
     end
 

data/app/sqlui_config.rb

@@ -8,7 +8,7 @@ require_relative 'deep'
 
 # App config including database configs.
 class SqluiConfig
-  attr_reader :name, :port, :environment, :list_url_path, :database_configs
+  attr_reader :name, :port, :environment, :list_url_path, :database_configs, :airbrake
 
   def initialize(filename, overrides = {})
     config = YAML.safe_load(ERB.new(File.read(filename)).result, aliases: true).deep_merge!(overrides)
@@ -29,6 +29,7 @@ class SqluiConfig
     @database_configs = databases.map do |_, current|
       DatabaseConfig.new(current)
     end
+    @airbrake = Args.fetch_optional_hash(config, :airbrake) || { enabled: false }
   end
 
   def database_config_for(url_path:)

data/app/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class Version
+  SQLUI = File.read(File.expand_path(File.join(__dir__, '..', '.release-version'))).strip
+end

data/app/views/databases.erb

@@ -1,3 +1,4 @@
+<!DOCTYPE html>
 <html lang="en">
 <head>
   <meta charset="utf-8">

data/app/views/error.erb

@@ -1,3 +1,4 @@
+<!DOCTYPE html>
 <html>
 <html lang="en">
 <head>

data/{client/resources/sqlui.html → app/views/sqlui.erb}

@@ -3,7 +3,22 @@
     <meta charset="utf-8">
     <title>SQLUI</title>
     <link rel="icon" type="image/x-icon" href="/favicon.svg">
-    <script src="sqlui.js"></script>
+    <!-- Initialize Airbrake before loading the main app JS so that we can catch errors as early as possible. -->
+    <script type="text/javascript" src="https://cdn.jsdelivr.net/npm/@airbrake/browser"></script>
+    <script type="text/javascript">
+      <% if airbrake_enabled %>
+        window.airbrake = new Airbrake.Notifier({
+          environment: "<%= environment %>",
+          projectId: "<%= airbrake_project_id %>",
+          projectKey: "<%= airbrake_project_key %>"
+        })
+      <% end %>
+
+      window.notifyAirbrake = function (error) {
+        window.airbrake?.notify(error)
+      }
+    </script>
+    <script type="text/javascript" src="sqlui.js"></script>
     <script type="text/javascript" src="https://www.gstatic.com/charts/loader.js"></script>
     <link rel="stylesheet" href="sqlui.css">
   </head>

data/client/resources/sqlui.css

@@ -245,6 +245,9 @@ p {
     display: flex;
     flex-direction: column;
 }
+#result-table tbody tr td{
+  height: calc(21px + 10px); // 21 for text, 10 for top and bottom padding of 5
+}
 
 #result-table tbody tr td abbr a {
     color: #555;

data/client/resources/sqlui.js

@@ -23922,6 +23922,7 @@
      const schemas = Object.entries(metadata.schemas);
      const editorSchema = {};
      const tables = [];
+     const aliases = [];
      schemas.forEach(([schemaName, schema]) => {
        Object.entries(schema.tables).forEach(([tableName, table]) => {
          const qualifiedTableName = schemas.length === 1 ? tableName : `${schemaName}.${tableName}`;
@@ -23929,30 +23930,48 @@
          const columns = Object.keys(table.columns);
          editorSchema[qualifiedTableName] = columns;
          const alias = metadata.tables[qualifiedTableName]?.alias;
-         const boost = metadata.tables[qualifiedTableName]?.boost;
+         if (alias) {
+           aliases.push(alias);
+           aliases.push(`\`${alias}\``);
+         }
+
+         let boost = metadata.tables[qualifiedTableName]?.boost;
+         boost = boost ? boost * 2 : null;
          if (alias) {
            editorSchema[alias] = columns;
+           // Add a completion which inserts the table name and alias for use just after join or from.
            tables.push({
-             label: qualifiedTableName,
-             detail: alias,
-             boost,
-             alias_type: 'with',
+             label: `${qualifiedTableName} ${alias}`,
+             boost: boost + 1,
+             completion_types: ['table_with_alias'],
              quoted: `${quotedQualifiedTableName} \`${alias}\``,
              unquoted: `${qualifiedTableName} ${alias}`
            });
+           // Add a completion which only inserts the alias for use with "select" or "where" or "on".
            tables.push({
-             label: qualifiedTableName,
-             detail: alias,
-             boost,
-             alias_type: 'only',
+             label: `${qualifiedTableName} ${alias}`,
+             boost: boost + 1,
+             type: 'constant',
+             completion_types: ['alias_only'],
              quoted: '`' + alias + '`',
              unquoted: alias
            });
-         } else {
            tables.push({
-             label: qualifiedTableName
+             label: alias,
+             boost: boost + 1,
+             type: 'constant',
+             completion_types: ['alias_only'],
+             quoted: '`' + alias + '`',
+             unquoted: alias
            });
          }
+         tables.push({
+           label: qualifiedTableName,
+           boost,
+           completion_types: ['table_with_alias', 'alias_only', 'table_only'],
+           quoted: quotedQualifiedTableName,
+           unquoted: qualifiedTableName
+         });
        });
      });
      // I prefer to use Cmd-Enter/Ctrl-Enter to submit the query. Here I am replacing the default mapping.
@@ -23992,66 +24011,52 @@
        tables
      };
      const originalSchemaCompletionSource = schemaCompletionSource(sqlConfig);
-     const originalKeywordCompletionSource = keywordCompletionSource(MySQL, true);
-     const keywordCompletions = [];
+
+     const joinCompletions = [];
      metadata.joins.forEach((join) => {
-       ['JOIN', 'INNER JOIN', 'LEFT JOIN', 'RIGHT JOIN', 'CROSS JOIN'].forEach((type) => {
-         keywordCompletions.push({ label: `${type} ${join.label}`, apply: `${type} ${join.apply}`, type: 'keyword' });
-       });
+       joinCompletions.push({ label: join.label, apply: join.apply, type: 'keyword' });
      });
-     let combinedKeywordCompletionSource;
-     if (keywordCompletions.length > 0) {
-       const customKeywordCompletionSource = ifNotIn(['QuotedIdentifier', 'SpecialVar', 'String', 'LineComment', 'BlockComment', '.'], completeFromList(keywordCompletions));
-       combinedKeywordCompletionSource = function (context) {
-         const original = originalKeywordCompletionSource(context);
-         const custom = customKeywordCompletionSource(context);
-         if (original?.options && custom?.options) {
-           original.options = original.options.concat(custom.options);
-         }
-         return original
-       };
-     } else {
-       combinedKeywordCompletionSource = originalKeywordCompletionSource;
-     }
+     const customJoinCompletionSource = completeFromList(joinCompletions);
+
      const sqlExtension = new LanguageSupport(
        MySQL.language,
        [
          MySQL.language.data.of({
            autocomplete: (context) => {
              const result = originalSchemaCompletionSource(context);
-             if (!result?.options) return result
+             if (!result?.options || result.options.length === 0) return result
 
              const tree = syntaxTree(context.state);
              let node = tree.resolveInner(context.pos, -1);
              if (!node) return result
 
-             // We are trying to identify the case where we are autocompleting a table name after "from" or "join"
-
-             // TODO: we don't handle the case where a user typed "select table.foo from". In that case we probably
-             // shouldn't autocomplete the alias. Though, if the user typed "select table.foo, t.bar", we won't know
-             // what to do. Maybe it is ok to force users to simply delete the alias after autocompleting.
-
-             // TODO: if table aliases aren't enabled, we don't need to override autocomplete.
-
+             // We want to customize the autocomplete options based on context. For instance, after select or where, we
+             // should autocomplete aliases, if they are defined, otherwise table names. After from, we should autocomplete
+             // table names with aliases. Etc. We start by trying to identify the node before our current position. The
+             // method for accomplishing this seems to vary based on the user's context.
              let foundSchema;
              if (node.name === 'Statement') {
-               // The node can be a Statement if the cursor is at the end of "from " and there is a complete
-               // statement in the editor (semicolon present). In that case we want to find the node just before the
-               // current position so that we can check whether it is "from" or "join".
+               // The current node can be a Statement if the cursor is at the end of "from " (for instance) and there is a
+               // complete statement in the editor (semicolon present). In that case we want to find the node just before
+               // the current position.
                node = node.childBefore(context.pos);
              } else if (node.name === 'Script') {
                // It seems the node can sometimes be a Script if the cursor is at the end of the last statement in the
                // editor and the statement doesn't end in a semicolon. In that case we can find the last statement in the
-               // Script so that we can check whether it is "from" or "join".
+               // Script.
                node = node.lastChild?.childBefore(context.pos);
+             } else if (node.name === 'Parens') {
+               // The current node can be a Parens if we are inside of a function or sub query, for instance just after a
+               // space after a "select" in "select * from (select ) as foo". In that case we can find the last statement
+               // in the Parens.
+               node = node.childBefore(context.pos);
              } else if (['Identifier', 'QuotedIdentifier', 'Keyword', '.'].includes(node.name)) {
                // If the node is an Identifier, we might be in the middle of typing the table name. If the node is a
-               // Keyword but isn't "from" or "join", we might be in the middle of typing a table name that is similar
-               // to a Keyword, for instance "orders" or "selections" or "fromages". In these cases, look for the previous
-               // sibling so that we can check whether it is "from" or "join". If we found a '.' or if the previous
-               // sibling is a '.', we might be in the middle of typing something like "schema.table" or
-               // "`schema`.table" or "`schema`.`table`". In these cases we need to record the schema used so that we
-               // can autocomplete table names with aliases.
+               // Keyword, we might be in the middle of typing a table name that is similar to a Keyword, for instance
+               // "orders" or "selections" or "fromages". In these cases, look for the previous sibling. If the node is a
+               // '.' or if the previous sibling is a '.', we might be in the middle of typing something like
+               // "schema.table" or "`schema`.table" or "`schema`.`table`". In these cases we need to record the schema
+               // used so that we can autocomplete table names with aliases.
                if (node.name !== '.') {
                  node = node.prevSibling;
                }
@@ -24068,29 +24073,54 @@
                }
              }
 
+             // We now have the node before the node the user is currently creating. Step back or up until we find a Keyword.
+             while (true) {
+               const nodeText = node ? context.state.doc.sliceString(node.from, node.to).toLowerCase() : null;
+               if (!node || (node.name === 'Keyword' &&
+                 ['where', 'select', 'from', 'into', 'join', 'straight_join', 'database', 'as'].includes(nodeText))) {
+                 break
+               }
+
+               node = node?.prevSibling || node?.parent;
+             }
              const nodeText = node ? context.state.doc.sliceString(node.from, node.to).toLowerCase() : null;
-             if (node?.name === 'Keyword' && ['from', 'join'].includes(nodeText)) {
-               result.options = result.options.filter((option) => {
-                 return option.alias_type === undefined || option.alias_type === 'with'
-               });
-             } else {
-               result.options = result.options.filter((option) => {
-                 return option.alias_type === undefined || option.alias_type === 'only'
-               });
+             let completionType = 'table_only';
+             if (node?.name === 'Keyword') {
+               if (['from', 'join', 'straight_join'].includes(nodeText)) {
+                 completionType = 'table_with_alias';
+               } else if (['where', 'select'].includes(nodeText)) {
+                 completionType = 'alias_only';
+               }
+
+               if (['join', 'straight_join'].includes(nodeText)) {
+                 const customJoins = customJoinCompletionSource(context);
+                 if (customJoins?.options) {
+                   result.options = result.options.concat(customJoins.options);
+                 }
+               }
              }
+             result.options = result.options.filter((option) => {
+               if (option.completion_types === undefined && option.type === 'constant' && aliases.includes(option.label)) {
+                 // The default options already include an alias if the statement includes one in the from clause.
+                 // In that case we want to remove it in favor of our own alias option.
+                 return false
+               }
+               // Allow any options we didn't create plus options we created which are of the expected type.
+               return option.completion_types === undefined || option.completion_types.includes(completionType)
+             });
              result.options = result.options.map((option) => {
                // Some shenanigans. If the default autocomplete function quoted the label, we want to ensure the quote
                // only applies to the table name and not the alias. You might think we could do this by overriding the
                // apply function but apply is set to null when quoting.
                // See https://github.com/codemirror/lang-sql/blob/ebf115fffdbe07f91465ccbd82868c587f8182bc/src/complete.ts#L90
-               if (option.alias_type) {
+               if (option.quoted) {
                  if (option.label.match(/^`.*`$/)) {
                    option.apply = option.quoted;
                  } else {
                    option.apply = option.unquoted;
                  }
                }
-               if (foundSchema) {
+               if (foundSchema && completionType === 'table_with_alias') {
                  const unquotedLabel = unquoteSqlId(option.label);
                  const quoted = unquotedLabel !== option.label;
                  const tableConfig = metadata.tables[`${foundSchema}.${unquotedLabel}`];
@@ -24113,7 +24143,7 @@
            }
          }),
          MySQL.language.data.of({
-           autocomplete: combinedKeywordCompletionSource
+           autocomplete: keywordCompletionSource(MySQL, true)
          })
        ]
      );
@@ -24952,9 +24982,11 @@
      const cellRenderer = function (rowElement, column, value) {
        if (window.metadata.columns[column]?.links?.length > 0) {
          const linksColumnElement = document.createElement('td');
-         window.metadata.columns[column].links.forEach((link) => {
-           linksColumnElement.appendChild(createLink(link, value));
-         });
+         if (value) {
+           window.metadata.columns[column].links.forEach((link) => {
+             linksColumnElement.appendChild(createLink(link, value));
+           });
+         }
          rowElement.appendChild(linksColumnElement);
          const textColumnElement = document.createElement('td');
          textColumnElement.innerText = value;

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: sqlui
 version: !ruby/object:Gem::Version
-  version: 0.1.51
+  version: 0.1.53
 platform: ruby
 authors:
 - Nick Dower
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-28 00:00:00.000000000 Z
+date: 2022-12-01 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: airbrake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: mysql2
   requirement: !ruby/object:Gem::Requirement
@@ -24,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.0'
+- !ruby/object:Gem::Dependency
+  name: prometheus-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
@@ -129,7 +157,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".version"
+- ".release-version"
 - app/args.rb
 - app/database_config.rb
 - app/database_metadata.rb
@@ -139,12 +167,13 @@ files:
 - app/sql_parser.rb
 - app/sqlui.rb
 - app/sqlui_config.rb
+- app/version.rb
 - app/views/databases.erb
 - app/views/error.erb
+- app/views/sqlui.erb
 - bin/sqlui
 - client/resources/favicon.svg
 - client/resources/sqlui.css
-- client/resources/sqlui.html
 - client/resources/sqlui.js
 homepage: https://github.com/nicholasdower/sqlui
 licenses:

data/.version

@@ -1 +0,0 @@
-0.1.51