blazer 1.9.0 → 2.0.0

data/app/mailers/blazer/slack_notifier.rb

@@ -0,0 +1,76 @@
+require "net/http"
+
+module Blazer
+  class SlackNotifier
+    def self.state_change(check, state, state_was, rows_count, error, check_type)
+      check.split_slack_channels.each do |channel|
+        text =
+          if error
+            error
+          elsif rows_count > 0 && check_type == "bad_data"
+            pluralize(rows_count, "row")
+          end
+
+        payload = {
+          channel: channel,
+          attachments: [
+            {
+              title: escape("Check #{state.titleize}: #{check.query.name}"),
+              title_link: query_url(check.query_id),
+              text: escape(text),
+              color: state == "passing" ? "good" : "danger"
+            }
+          ]
+        }
+
+        post(Blazer.slack_webhook_url, payload)
+      end
+    end
+
+    def self.failing_checks(channel, checks)
+      text =
+        checks.map do |check|
+          "<#{query_url(check.query_id)}|#{escape(check.query.name)}> #{escape(check.state)}"
+        end
+
+      payload = {
+        channel: channel,
+        attachments: [
+          {
+            title: escape("#{pluralize(checks.size, "Check")} Failing"),
+            text: text.join("\n"),
+            color: "warning"
+          }
+        ]
+      }
+
+      post(Blazer.slack_webhook_url, payload)
+    end
+
+    # https://api.slack.com/docs/message-formatting#how_to_escape_characters
+    # - Replace the ampersand, &, with &amp;
+    # - Replace the less-than sign, < with &lt;
+    # - Replace the greater-than sign, > with &gt;
+    # That's it. Don't HTML entity-encode the entire message.
+    def self.escape(str)
+      str.gsub("&", "&amp;").gsub("<", "&lt;").gsub(">", "&gt;") if str
+    end
+
+    def self.pluralize(*args)
+      ActionController::Base.helpers.pluralize(*args)
+    end
+
+    def self.query_url(id)
+      Blazer::Engine.routes.url_helpers.query_url(id, ActionMailer::Base.default_url_options)
+    end
+
+    def self.post(url, payload)
+      uri = URI.parse(url)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+      http.open_timeout = 3
+      http.read_timeout = 5
+      http.post(uri.request_uri, payload.to_json)
+    end
+  end
+end

data/app/models/blazer/check.rb

@@ -14,6 +14,14 @@ module Blazer
       emails.to_s.downcase.split(",").map(&:strip)
     end
 
+    def split_slack_channels
+      if Blazer.slack?
+        slack_channels.to_s.downcase.split(",").map(&:strip)
+      else
+        []
+      end
+    end
+
     def update_state(result)
       check_type =
         if respond_to?(:check_type)
@@ -61,6 +69,7 @@ module Blazer
       # do not notify on creation, except when not passing
       if (state_was != "new" || state != "passing") && state != state_was && emails.present?
         Blazer::CheckMailer.state_change(self, state, state_was, result.rows.size, message, result.columns, result.rows.first(10).as_json, result.column_types, check_type).deliver_now
+        Blazer::SlackNotifier.state_change(self, state, state_was, result.rows.size, message, check_type)
       end
       save! if changed?
     end

data/app/views/blazer/_variables.html.erb

@@ -1,4 +1,13 @@
 <% if @bind_vars.any? %>
+  <script>
+    <%= blazer_js_var "timeZone", Blazer.time_zone.tzinfo.name %>
+    var now = moment.tz(timeZone)
+    var format = "YYYY-MM-DD"
+
+    function toDate(time) {
+      return moment.tz(time.format(format), timeZone)
+    }
+  </script>
   <form id="bind" method="get" action="<%= action %>" class="form-inline" style="margin-bottom: 10px;">
     <% date_vars = ["start_time", "end_time"] %>
     <% if (date_vars - @bind_vars).empty? %>
@@ -16,18 +25,37 @@
             create: true
           });
         </script>
-      <% else %>
-        <%= text_field_tag var, params[var], style: "width: 120px; margin-right: 20px;", autofocus: i == 0 && !var.end_with?("_at") && !params[var], class: "form-control" %>
-        <% if var.end_with?("_at") %>
-          <script>
-            $("#<%= var %>").daterangepicker({singleDatePicker: true, locale: {format: "YYYY-MM-DD"}, autoUpdateInput: false});
+      <% elsif var.end_with?("_at") || var == "start_time" || var == "end_time" %>
+        <%= hidden_field_tag var, params[var] %>
+
+        <div class="selectize-control single" style="width: 200px;">
+          <div id="<%= var %>-select" class="selectize-input" style="display: inline-block;">
+            <span>Select a date</span>
+          </div>
+        </div>
+
+        <script>
+          (function() {
+            var input = $("#<%= var %>")
+            var datePicker = $("#<%= var %>-select")
+            datePicker.daterangepicker({
+              singleDatePicker: true,
+              locale: {format: format},
+              autoUpdateInput: false,
+              startDate: input.val().length > 0 ? moment.tz(input.val(), timeZone) : now
+            })
             // hack to start with empty date
-            $("#<%= var %>").on("apply.daterangepicker", function(ev, picker) {
-              $(this).val(picker.startDate.format("YYYY-MM-DD"));
-              $(this).change();
+            datePicker.on("apply.daterangepicker", function(ev, picker) {
+              datePicker.find("span").html(toDate(picker.startDate).format("MMMM D, YYYY"))
+              input.val(toDate(picker.startDate).utc().format())
+              submitIfCompleted($("#<%= var %>").closest("form"))
             });
-          </script>
-        <% end %>
+            var picker = datePicker.data("daterangepicker")
+            datePicker.find("span").html(toDate(picker.startDate).format("MMMM D, YYYY"))
+          })()
+        </script>
+      <% else %>
+        <%= text_field_tag var, params[var], style: "width: 120px; margin-right: 20px;", autofocus: i == 0 && !var.end_with?("_at") && !params[var], class: "form-control" %>
       <% end %>
     <% end %>
 
@@ -44,18 +72,10 @@
       </div>
 
       <script>
-        <%= blazer_js_var "timeZone", Blazer.time_zone.tzinfo.name %>
-        var format = "YYYY-MM-DD"
-        var now = moment.tz(timeZone)
-
         function dateStr(daysAgo) {
           return now.clone().subtract(daysAgo || 0, "days").format(format)
         }
 
-        function toDate(time) {
-          return moment.tz(time.format(format), timeZone)
-        }
-
         function setTimeInputs(start, end) {
           $("#start_time").val(toDate(start).utc().format())
           $("#end_time").val(toDate(end).endOf("day").utc().format())

data/app/views/blazer/checks/_form.html.erb

@@ -60,7 +60,15 @@
     <%= f.label :emails %>
     <%= f.text_field :emails, placeholder: "Optional, comma separated", class: "form-control" %>
   </div>
-  <p class="text-muted">Emails are sent when a check starts failing, and when it starts passing again.
+
+  <% if Blazer.slack? %>
+    <div class="form-group">
+      <%= f.label :slack_channels %>
+      <%= f.text_field :slack_channels, placeholder: "Optional, comma separated", class: "form-control" %>
+    </div>
+  <% end %>
+
+  <p class="text-muted">Emails <%= Blazer.slack? ? "and Slack notifications " : nil %>are sent when a check starts failing, and when it starts passing again.
   <p>
     <% if @check.persisted? %>
       <%= link_to "Delete", check_path(@check), method: :delete, "data-confirm" => "Are you sure?", class: "btn btn-danger" %>

data/app/views/blazer/checks/index.html.erb

@@ -9,7 +9,7 @@
       <th>Query</th>
       <th style="width: 10%;">State</th>
       <th style="width: 10%;">Run</th>
-      <th style="width: 20%;">Emails</th>
+      <th style="width: 20%;">Notify</th>
       <th style="width: 15%;"></th>
     </tr>
   </thead>
@@ -28,6 +28,9 @@
             <% check.split_emails.each do |email| %>
               <li><%= email %></li>
             <% end %>
+            <% check.split_slack_channels.each do |channel| %>
+              <li><%= channel %></li>
+            <% end %>
           </ul>
         </td>
         <td style="text-align: right; padding: 1px;">

data/app/views/blazer/queries/_form.html.erb

@@ -16,7 +16,7 @@
           <div class="pull-left" style="margin-top: 9px;">
             <%= link_to "Back", :back %>
           </div>
-          <a :href="dataSourcePath" target="_blank" style="margin-right: 10px;">Schema</a>
+          <a :href="dataSourcePath" target="_blank" style="margin-right: 10px;">Docs</a>
           <%= f.select :data_source, Blazer.data_sources.values.select { |ds| q = @query.dup; q.data_source = ds.id; q.editable?(blazer_user) }.map { |ds| [ds.name, ds.id] }, {}, class: ("hide" if Blazer.data_sources.size <= 1), style: "width: 140px;" %>
           <div id="tables" style="display: inline-block; width: 250px; margin-right: 10px;">
             <select id="table_names" style="width: 240px;" placeholder="Preview table"></select>
@@ -173,7 +173,7 @@
         editor.focus()
       },
       adjustHeight: function() {
-        // http://stackoverflow.com/questions/11584061/
+        // https://stackoverflow.com/questions/11584061/
         var editor = this.editor
         var lines = editor.getSession().getScreenLength()
         if (lines < 9) {

data/app/views/blazer/queries/docs.html.erb

@@ -0,0 +1,138 @@
+<% blazer_title @data_source.name %>
+
+<h1><%= @data_source.name %></h1>
+
+<h2>Smart Variables</h2>
+
+<p>Use these variable names to get a dropdown.</p>
+
+<table class="table" style="max-width: 500px;">
+  <thead>
+    <tr>
+      <th>Variable</th>
+    </tr>
+  </thead>
+  <tbody>
+    <% @data_source.smart_variables.each do |k, _| %>
+      <tr>
+        <td><code>{<%= k %>}</code></td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>
+
+<p>Use <code>{start_time}</code> and <code>{end_time}</code> for a date range selector. End a variable name with <code>_at</code> for a date selector.</p>
+
+<h2>Linked Columns</h2>
+
+<p>Use these column names to link results to other pages.</p>
+
+<table class="table" style="max-width: 500px;">
+  <thead>
+    <tr>
+      <th style="width: 20%;">Name</th>
+      <th>URL</th>
+    </tr>
+  </thead>
+  <tbody>
+    <% @data_source.linked_columns.each do |k, v| %>
+      <tr>
+        <td><%= k %></td>
+        <td><%= v %></td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>
+
+<p>Values that match the format of a URL will be linked automatically.</p>
+
+<h2>Smart Columns</h2>
+
+<p>Use these column names to show additional data.</p>
+
+<table class="table" style="max-width: 500px;">
+  <thead>
+    <tr>
+      <th>Name</th>
+    </tr>
+  </thead>
+  <tbody>
+    <% @data_source.smart_columns.each do |k, _| %>
+      <tr>
+        <td><%= k %></td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>
+
+<h2>Charts</h2>
+
+<p>Use specific combinations of column types to generate charts.</p>
+
+<table class="table" style="max-width: 500px;">
+  <thead>
+    <tr>
+      <th style="width: 20%;">Chart</th>
+      <th>Column Types</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td>Line</td>
+      <td>2+ columns - timestamp, numeric(s)</td>
+    </tr>
+    <tr>
+      <td>Line</td>
+      <td>3 columns - timestamp, string, numeric</td>
+    </tr>
+    <tr>
+      <td>Column</td>
+      <td>2+ columns - string, numeric(s)</td>
+    </tr>
+    <tr>
+      <td>Column</td>
+      <td>3 columns - string, string, numeric</td>
+    </tr>
+    <tr>
+      <td>Scatter</td>
+      <td>2 columns - both numeric</td>
+    </tr>
+    <tr>
+      <td>Map</td>
+      <td>
+        Named <code>latitude</code> and <code>longitude</code>, or <code>lat</code> and <code>lon</code>, or <code>lat</code> and <code>lng</code>
+        <% if !blazer_maps? %>
+          <br />
+          <strong>Needs configured</strong>
+        <% end %>
+      </td>
+    </tr>
+  </tbody>
+</table>
+
+<p>Use the column name <code>target</code> to draw a line for goals.</p>
+
+<h2>Schema</h2>
+
+<% @schema.each do |table| %>
+  <table class="table" style="max-width: 500px;">
+    <thead>
+      <tr>
+        <th colspan="2">
+          <%= table[:table] %>
+          <% if table[:schema] != "public" %>
+            <span class="text-muted" style="font-weight: normal;"><%= table[:schema] %></span>
+          <% end %>
+        </th>
+      </tr>
+    </thead>
+    <tbody>
+      <% table[:columns].each do |column| %>
+        <tr>
+          <td style="width: 60%;"><%= column[:name] %></td>
+          <td class="text-muted"><%= column[:data_type] %></td>
+        </tr>
+      <% end %>
+    </tbody>
+  </table>
+<% end %>

data/app/views/blazer/queries/show.html.erb

@@ -62,7 +62,7 @@
   </script>
 <% end %>
 
-<% unless %w(mongodb elasticsearch).include?(Blazer.data_sources[@query.data_source].adapter) %>
+<% unless %w(mongodb).include?(Blazer.data_sources[@query.data_source].adapter) %>
   <script>
     // do not highlight really long queries
     // this can lead to performance issues

data/app/views/layouts/blazer/application.html.erb

@@ -11,8 +11,8 @@
       <%= blazer_js_var "rootPath", root_path %>
     </script>
     <% if blazer_maps? %>
-      <%= stylesheet_link_tag "https://api.mapbox.com/mapbox.js/v2.4.0/mapbox.css" %>
-      <%= javascript_include_tag "https://api.mapbox.com/mapbox.js/v2.4.0/mapbox.js" %>
+      <%= stylesheet_link_tag "https://api.mapbox.com/mapbox.js/v3.1.1/mapbox.css", integrity: "sha384-o8tecBIfqi9yU5yYK2Ne/9A9hlOGFV9MBvCpmemvJH1XxqOe6h8Bl4mLxMi6PgjG", crossorigin: "anonymous" %>
+      <%= javascript_include_tag "https://api.mapbox.com/mapbox.js/v3.1.1/mapbox.js", integrity: "sha384-j81LqvtvYigFzGSUgAoFijpvoq4yGoCJSOXI9DFaUEpenR029MBE3E/X5Gr+WdO0", crossorigin: "anonymous" %>
     <% end %>
     <%= csrf_meta_tags %>
   </head>

data/config/routes.rb

@@ -4,7 +4,7 @@ Blazer::Engine.routes.draw do
     post :cancel, on: :collection
     post :refresh, on: :member
     get :tables, on: :collection
-    get :schema, on: :collection
+    get :docs, on: :collection
   end
   resources :checks, except: [:show] do
     get :run, on: :member

data/lib/blazer.rb

@@ -39,6 +39,8 @@ module Blazer
     attr_accessor :images
     attr_accessor :query_viewable
     attr_accessor :query_editable
+    attr_accessor :override_csp
+    attr_accessor :slack_webhook_url
   end
   self.audit = true
   self.user_name = :name
@@ -46,6 +48,7 @@ module Blazer
   self.anomaly_checks = false
   self.async = false
   self.images = false
+  self.override_csp = false
 
   TIMEOUT_MESSAGE = "Query timed out :("
   TIMEOUT_ERRORS = [
@@ -93,20 +96,11 @@ module Blazer
 
   def self.data_sources
     @data_sources ||= begin
-      ds = Hash[
-        settings["data_sources"].map do |id, s|
-          [id, Blazer::DataSource.new(id, s)]
-        end
-      ]
-      ds.default = ds.values.first
+      ds = Hash.new { |hash, key| raise Blazer::Error, "Unknown data source: #{key}" }
+      settings["data_sources"].each do |id, s|
+        ds[id] = Blazer::DataSource.new(id, s)
+      end
       ds
-
-      # TODO Blazer 2.0
-      # ds2 = Hash.new { |hash, key| raise Blazer::Error, "Unknown data source: #{key}" }
-      # ds.each do |k, v|
-      #   ds2[k] = v
-      # end
-      # ds2
     end
   end
 
@@ -126,8 +120,6 @@ module Blazer
   end
 
   def self.run_check(check)
-    rows = nil
-    error = nil
     tries = 1
 
     ActiveSupport::Notifications.instrument("run_check.blazer", check_id: check.id, query_id: check.query.id, state_was: check.state) do |instrument|
@@ -173,10 +165,15 @@ module Blazer
 
   def self.send_failing_checks
     emails = {}
+    slack_channels = {}
+
     Blazer::Check.includes(:query).where(state: ["failing", "error", "timed out", "disabled"]).find_each do |check|
       check.split_emails.each do |email|
         (emails[email] ||= []) << check
       end
+      check.split_slack_channels.each do |channel|
+        (slack_channels[channel] ||= []) << check
+      end
     end
 
     emails.each do |email, checks|
@@ -184,6 +181,16 @@ module Blazer
         Blazer::CheckMailer.failing_checks(email, checks).deliver_now
       end
     end
+
+    slack_channels.each do |channel, checks|
+      Safely.safely do
+        Blazer::SlackNotifier.failing_checks(channel, checks)
+      end
+    end
+  end
+
+  def self.slack?
+    slack_webhook_url.present?
   end
 
   def self.adapters