Skip to content

Business intelligence made simple

Added support for archiving queries

Andrew Kane2bc3fc4fd507
diff --git a/CHANGELOG.md b/CHANGELOG.md
index fd841066..73ec214f 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,3 +1,7 @@
+## 2.3.0 (unreleased)
+
+- Added support for archiving queries
+
## 2.2.8 (2020-11-01)
- Fixed error when deleting dashboard
diff --git a/README.md b/README.md
index 01c36cba..69385f9c 100644
--- a/README.md
+++ b/README.md
@@ -859,6 +859,14 @@ async: true
config.cache_store = :mem_cache_store
```
+## Archiving
+
+Archive queries that haven’t been viewed in over 90 days.
+
+```sh
+rake blazer:archive_queries
+```
+
## Content Security Policy
If views are stuck with a `Loading...` message, there might be a problem with strict CSP settings in your app. This can be checked with Firefox or Chrome dev tools. You can allow Blazer to override these settings for its controllers with:
@@ -869,6 +877,21 @@ override_csp: true
## Upgrading
+### 2.3
+
+To archive queries, create a migration
+
+```sh
+rails g migration add_status_to_blazer_queries
+```
+
+with:
+
+```ruby
+add_column :blazer_queries, :status, :string
+Blazer::Query.update_all(status: "active")
+```
+
### 2.0
To use Slack notifications, create a migration
diff --git a/app/controllers/blazer/queries_controller.rb b/app/controllers/blazer/queries_controller.rb
index 1cc116f6..d8cf6555 100644
--- a/app/controllers/blazer/queries_controller.rb
+++ b/app/controllers/blazer/queries_controller.rb
@@ -43,6 +43,7 @@ module Blazer
def create
@query = Blazer::Query.new(query_params)
@query.creator = blazer_user if @query.respond_to?(:creator)
+ @query.status = "active" if @query.respond_to?(:status)
if @query.save
redirect_to query_path(@query, variable_params(@query))
@@ -64,6 +65,8 @@ module Blazer
@sql_errors << error if error
end
+ @query.update!(status: "active") if @query.try(:status) == "archived"
+
Blazer.transform_statement.call(data_source, @statement) if Blazer.transform_statement
end
@@ -279,7 +282,7 @@ module Blazer
@queries = queries_by_ids(Blazer::Audit.where(user_id: blazer_user.id).order(created_at: :desc).limit(500).pluck(:query_id).uniq)
else
@queries = @queries.limit(limit) if limit
- @queries = @queries.order(:name)
+ @queries = @queries.active.order(:name)
end
@queries = @queries.to_a
@@ -300,7 +303,7 @@ module Blazer
end
def queries_by_ids(favorite_query_ids)
- queries = Blazer::Query.named.where(id: favorite_query_ids)
+ queries = Blazer::Query.active.named.where(id: favorite_query_ids)
queries = queries.includes(:creator) if Blazer.user_class
queries = queries.index_by(&:id)
favorite_query_ids.map { |query_id| queries[query_id] }.compact
diff --git a/app/models/blazer/query.rb b/app/models/blazer/query.rb
index 1a100612..0b392092 100644
--- a/app/models/blazer/query.rb
+++ b/app/models/blazer/query.rb
@@ -8,6 +8,7 @@ module Blazer
validates :statement, presence: true
+ scope :active, -> { column_names.include?("status") ? where(status: "active") : all }
scope :named, -> { where("blazer_queries.name <> ''") }
def to_param
diff --git a/app/views/blazer/checks/_form.html.erb b/app/views/blazer/checks/_form.html.erb
index d3f2a703..ceaf4e44 100644
--- a/app/views/blazer/checks/_form.html.erb
+++ b/app/views/blazer/checks/_form.html.erb
@@ -13,7 +13,7 @@
<%= f.select :query_id, [], {include_blank: true} %>
</div>
<script>
- <%= blazer_js_var "queries", Blazer::Query.named.order(:name).select("id, name").map { |q| {text: q.name, value: q.id} } %>
+ <%= blazer_js_var "queries", Blazer::Query.active.named.order(:name).select("id, name").map { |q| {text: q.name, value: q.id} } %>
<%= blazer_js_var "items", [@check.query_id].compact %>
$("#check_query_id").selectize({options: queries, items: items, highlight: false, maxOptions: 100}).parents(".hide").removeClass("hide");
diff --git a/app/views/blazer/dashboards/_form.html.erb b/app/views/blazer/dashboards/_form.html.erb
index f6ef1396..a57d3031 100644
--- a/app/views/blazer/dashboards/_form.html.erb
+++ b/app/views/blazer/dashboards/_form.html.erb
@@ -31,7 +31,7 @@
<% end %>
<script>
- <%= blazer_js_var "queries", Blazer::Query.named.order(:name).select("id, name").map { |q| {text: q.name, value: q.id} } %>
+ <%= blazer_js_var "queries", Blazer::Query.active.named.order(:name).select("id, name").map { |q| {text: q.name, value: q.id} } %>
<%= blazer_js_var "dashboardQueries", @queries || @dashboard.dashboard_queries.order(:position).map(&:query) %>
var app = new Vue({
diff --git a/lib/generators/blazer/templates/install.rb.tt b/lib/generators/blazer/templates/install.rb.tt
index 999b09fd..bf199930 100644
--- a/lib/generators/blazer/templates/install.rb.tt
+++ b/lib/generators/blazer/templates/install.rb.tt
@@ -6,6 +6,7 @@ class <%= migration_class_name %> < ActiveRecord::Migration<%= migration_version
t.text :description
t.text :statement
t.string :data_source
+ t.string :status
t.timestamps null: false
end
diff --git a/lib/tasks/blazer.rake b/lib/tasks/blazer.rake
index dff27306..fcc9f0f4 100644
--- a/lib/tasks/blazer.rake
+++ b/lib/tasks/blazer.rake
@@ -8,4 +8,13 @@ namespace :blazer do
task send_failing_checks: :environment do
Blazer.send_failing_checks
end
+
+ desc "archive queries"
+ task archive_queries: :environment do
+ abort "Audits must be enabled to archive" unless Blazer.audit
+ abort "Missing status column - see https://github.com/ankane/blazer#23" unless Blazer::Query.column_names.include?("status")
+
+ viewed_query_ids = Blazer::Audit.where("created_at > ?", 90.days.ago).group(:query_id).count.keys.compact
+ Blazer::Query.active.where.not(id: viewed_query_ids).update_all(status: "archived")
+ end
end