marty 1.0.23 → 1.0.24

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d0f81a144144beb77d9fafc82b8d638be6fbb501
-  data.tar.gz: 49a509cc8458a156deaf186c4401acbc10411436
+  metadata.gz: 86b79d602a84a7fea3fbca2b3704a8f9ccf6b00b
+  data.tar.gz: 0720c7fe854939427a378e0cca9cfc8ebf96302f
 SHA512:
-  metadata.gz: eb8843be6891a672779cca79c29ca08b8879d58ef1f7c99a6353ecbd1cc5c28ced1f42913e891f7cb4311a0c5f59d50d906899488ea0978c87a2a75c7543a602
-  data.tar.gz: fd0588d9011f7734e478eca8a51e7f3092bd2fbb4a4734f399c2ee91dacad499b27d6ed70d062c877356c90d9be7235b191151618f7f0e8514b724a963bc3989
+  metadata.gz: b4d7f133d884839c72815a068934c54b26f7c366850fda2c313cd600a277eb93d2f438d5ad932fa5b66a9f0b9b25d7177465e209bdd1e8127d0309e4bc37fed7
+  data.tar.gz: 429013d616affaa52db3d1eaffe52bc6402fd5e70245fb61f7de855debe7cbc68cd6214cb3e2c29dee96e535f80cc0da5e996c7a8ecc37c37df90e4dda5a873d

data/.gitignore

@@ -3,6 +3,7 @@ log/*.log
 pkg/
 spec/dummy/db/*.sqlite3
 spec/dummy/log/*.log
+spec/dummy/log/*.sql
 spec/dummy/tmp/
 spec/dummy/.sass-cache
 

data/Gemfile

@@ -10,6 +10,7 @@ gem 'daemons', '~> 1.1.9'
 gem 'mime-types', '< 3.0', platforms: :ruby_19
 gem 'rails', '~> 4.2.1'
 gem 'pg', '~> 0.18.4'
+gem 'sqlite3'
 
 group :development, :test do
   gem 'pry-rails'

data/app/components/marty/grid.rb

@@ -32,13 +32,14 @@ class Marty::Grid < ::Netzke::Grid::Base
     super
 
     c.permissions = {
-      create:      class_can?(:create),
-      read:        class_can?(:read),
-      update:      class_can?(:update),
-      delete:      class_can?(:delete)
+      create: class_can?(:create),
+      read:   class_can?(:read),
+      update: class_can?(:update),
+      delete: class_can?(:delete)
     }
-    c.editing                = :both
-    c.store_config           = {page_size: 30}
+
+    c.editing      = :both
+    c.store_config = {page_size: 30}
   end
 
   def has_search_action?

data/app/components/marty/log_view.rb

@@ -0,0 +1,76 @@
+class Marty::LogView < Marty::Grid
+  include Marty::Extras::Layout
+  has_marty_permissions read: [:admin],
+                        update: [:admin]
+
+  def configure(c)
+    super
+
+    c.title    ||= I18n.t('log_viewer', default: "Log Viewer")
+    c.model      = "Marty::Log"
+    c.paging     = :buffered
+    c.editing    = :in_form
+    c.attributes = [
+      :timestamp,
+      :message_type,
+      :message,
+      :details
+    ]
+
+    c.store_config.merge!(sorters: [{property: :timestamp, direction: 'DESC'}])
+  end
+
+  def default_context_menu
+    []
+  end
+
+  def default_form_items
+    [
+      :timestamp,
+      :message_type,
+      :message,
+      textarea_field(:details).merge!({height: 400})
+    ]
+  end
+
+  component :edit_window do |c|
+    super(c)
+    c.width = 1200
+  end
+
+  attribute :message_type do |c|
+    c.text         = I18n.t("log_grid.message_type")
+    c.width        = 100
+    c.read_only    = true
+  end
+
+  attribute :message do |c|
+    c.text         = I18n.t("log_grid.message")
+    c.width        = 400
+    c.read_only    = true
+  end
+
+  attribute :timestamp do |c|
+    c.text         = I18n.t("log_grid.timestamp")
+    c.width        = 200
+    c.read_only    = true
+    c.xtype        = :datecolumn
+    c.format       = 'Y-m-d h:i:s.u'
+    c.field_config = {
+      xtype: :displayfield,
+    }
+    c.getter = lambda { |r| Time.at(r.timestamp) }
+  end
+
+  column :details do |c|
+    c.getter = lambda { |r| CGI.escapeHTML(r.details) }
+  end
+
+  attribute :details do |c|
+    c.text      = I18n.t("log_grid.details")
+    c.width     = 900
+    c.read_only = true
+  end
+end
+
+LogView = Marty::LogView

data/app/components/marty/main_auth_app.rb

@@ -47,6 +47,20 @@ class Marty::MainAuthApp < Marty::AuthApp
     }
   end
 
+  def log_menu
+    [
+      {
+        text: 'Log Maintenance',
+        icon:  icon_hack(:wrench),
+        disabled: !self.class.has_admin_perm?,
+        menu: [
+          :log_view,
+          :log_cleanup,
+        ]
+      }
+    ]
+  end
+
   def system_menu
     {
       text:  I18n.t("system"),
@@ -60,7 +74,7 @@ class Marty::MainAuthApp < Marty::AuthApp
         :event_view,
         :reload_scripts,
         :load_seed,
-      ] + background_jobs_menu
+      ] + background_jobs_menu + log_menu
     }
   end
 
@@ -235,6 +249,21 @@ class Marty::MainAuthApp < Marty::AuthApp
     a.disabled = !self.class.has_admin_perm?
   end
 
+  action :log_view do |a|
+    a.text     = 'View Log'
+    a.tooltip  = 'View Log'
+    a.handler  = :netzke_load_component_by_action
+    a.icon      = :cog
+    a.disabled = !self.class.has_admin_perm?
+  end
+
+  action :log_cleanup do |a|
+    a.text     = 'Cleanup Log Table'
+    a.tooltip  = 'Delete old log records'
+    a.icon      = :cog
+    a.disabled = !self.class.has_admin_perm?
+  end
+
    ######################################################################
 
   def bg_command(param)
@@ -268,6 +297,15 @@ class Marty::MainAuthApp < Marty::AuthApp
     client.show_detail res.html_safe.gsub("\n","<br/>"), 'Delayed Job Restart'
   end
 
+  endpoint :log_cleanup do |params|
+    begin
+      Marty::Log.cleanup(params)
+    rescue => e
+      res = e.message
+      client.show_detail res.html_safe.gsub("\n","<br/>"), 'Log Cleanup'
+    end
+  end
+
   ######################################################################
   # Postings
 
@@ -401,6 +439,23 @@ class Marty::MainAuthApp < Marty::AuthApp
       this.server.bgStatus({});
     }
     JS
+
+    c.netzke_on_log_cleanup = l(<<-JS)
+    function(params) {
+       var me = this;
+       Ext.Msg.show({
+         title: 'Log Cleanup',
+         msg: 'Enter number of days to keep',
+         width: 375,
+         buttons: Ext.Msg.OKCANCEL,
+         prompt: true,
+         fn: function (btn, value) {
+           btn == "ok" && me.server.logCleanup(value);
+         }
+       });
+    }
+    JS
+
   end
 
   action :select_posting do |a|
@@ -444,6 +499,10 @@ class Marty::MainAuthApp < Marty::AuthApp
     c.disabled = Marty::Util.warped?
   end
 
+  component :log_view do |c|
+    c.klass = Marty::LogView
+  end
+
   endpoint :reload_scripts do |params|
     Marty::Script.load_scripts
     client.netzke_notify 'Scripts have been reloaded'

data/app/models/marty/log.rb

@@ -0,0 +1,56 @@
+class Marty::Log < Marty::Base
+
+  def self.logfile
+    @logfile ||= Rails.root.join('log', Rails.env + '.sql').to_s
+  end
+
+  establish_connection({
+                         adapter:  "sqlite3",
+                         database: logfile
+                       })
+  self.table_name = "log"
+  self.primary_key = "id"
+
+  def self.db_init
+    db = SQLite3::Database.new(Marty::Log.logfile)
+    db.execute <<-SQL
+      CREATE TABLE IF NOT EXISTS log (
+      id INTEGER PRIMARY KEY,
+      message_type TEXT,
+      message TEXT,
+      timestamp REAL,
+      details BLOB )
+      SQL
+    db
+  end
+
+  def self.write_log(type, message, details)
+    begin
+      @db ||= db_init
+      stmt = @db.prepare <<-SQL
+          INSERT INTO log (message_type, message, timestamp, details)
+            values (?, ?, ?, ?)
+          SQL
+      stmt.bind_param(1, type.to_s)
+      stmt.bind_param(2, message)
+      stmt.bind_param(3, Time.zone.now.to_f)
+      stmt.bind_param(4, details.pretty_inspect)
+
+      stmt.execute
+    rescue => e
+      Marty::Util.logger.error("Marty::Logger failure: #{e.message}")
+    ensure
+      stmt.close if stmt rescue nil
+    end
+  end
+
+  def self.cleanup(days_to_keep)
+    raise "Must give numeric value. (Got '#{days_to_keep}')" unless
+      (Float(days_to_keep) rescue false)
+    @db ||= db_init
+    cutoff = Time.zone.now.to_i - days_to_keep.to_i*60*60*24
+    @db.execute <<-SQL
+       delete from log where timestamp <= #{cutoff}
+    SQL
+  end
+end

data/config/locales/en.yml

@@ -48,6 +48,12 @@ en:
     created_dt: Create Date/Time
     delete: Delete Script
 
+  log_grid:
+    message_type: Type
+    message: Message
+    timestamp: Timestamp
+    details: Details
+
   user_grid:
     title: Users
     new:   New User

data/lib/marty/logger.rb

@@ -0,0 +1,26 @@
+require 'sqlite3'
+
+class Marty::Logger
+
+  def self.method_missing(m, *args, &block)
+    return super unless
+      [:debug, :info, :warn, :error, :fatal, :unknown].include?(m)
+    Marty::Util.logger.send(m, args[0]) if Marty::Util.logger.respond_to?(m)
+    log(m, *args)
+  end
+
+  def self.log(type, message, details=nil)
+    Marty::Log.write_log(type, message, details)
+  end
+
+  def self.with_logging(error_message, error_data)
+    begin
+      yield
+    rescue => e
+      error(error_message, { message: e.message,
+                             data: error_data })
+      raise "#{error_message}: #{e.message}"
+    end
+  end
+
+end

data/lib/marty/version.rb

@@ -1,3 +1,3 @@
 module Marty
-  VERSION = "1.0.23"
+  VERSION = "1.0.24"
 end

data/marty.gemspec

@@ -40,4 +40,5 @@ Gem::Specification.new do |s|
   s.add_dependency 'coderay'
   s.add_dependency 'net-ldap', '~> 0.12.0'
   s.add_dependency 'rubyzip'
+  s.add_dependency 'sqlite3'
 end

data/spec/dummy/config/application.rb

@@ -32,6 +32,8 @@ module Dummy
     # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
     # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
     # config.time_zone = 'Central Time (US & Canada)'
+    config.active_record.default_timezone = :local
+    config.time_zone = 'Pacific Time (US & Canada)'
 
     # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
     # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]

data/spec/features/log_view_spec.rb

@@ -0,0 +1,90 @@
+require 'spec_helper'
+
+feature 'logger view', js: true, capybara: true do
+
+  def manual_insert(type, message, ts, detail)
+    stmt = @db.prepare <<-SQL
+       INSERT INTO log (message_type, message, timestamp, details)
+       VALUES (?, ?, ?, ?)
+    SQL
+    stmt.bind_param(1, type)
+    stmt.bind_param(2, message)
+    stmt.bind_param(3, ts)
+    stmt.bind_param(4, detail)
+    stmt.execute
+    stmt.close
+  end
+
+  before(:all) do
+    self.use_transactional_fixtures = false
+    @db =  SQLite3::Database.new(Marty::Log.logfile)
+
+    info_s = { info: 'message' }
+    error_s = [1, 2, 3, { error: 'message' }]
+    fatal_s = ["string", 123, { fatal: "message", another_key: 'value' }]
+    Marty::Logger.info('info message', nil)
+    Marty::Logger.error('error message', error_s)
+    Marty::Logger.fatal('fatal message', fatal_s)
+    manual_insert("debug", "hi mom", (Time.zone.now - 5.days).to_i,
+                  ["one", "two", 3, 4.0].pretty_inspect)
+    manual_insert("warn", "all your base", (Time.zone.now - 10.days).to_i,
+                  [5].pretty_inspect)
+    @ts = (@db.execute "select timestamp from log order by timestamp desc").map do
+      |(ts)|
+      Time.zone.at(ts).strftime('%Y-%m-%dT%H:%M:%S.%L%:z')
+    end
+
+    @clean_file = "/tmp/clean_#{Process.pid}.psql"
+    save_clean_db(@clean_file)
+    populate_test_users
+  end
+
+  after(:all) do
+    restore_clean_db(@clean_file)
+    @db.execute "delete from log"
+    @db.close
+    self.use_transactional_fixtures = true
+  end
+
+  let(:logview) { netzke_find('log_view') }
+  it "updates views correctly" do
+    log_in_as('marty')
+    press('System')
+    show_submenu('Log Maintenance')
+    press('View Log')
+    wait_for_ready
+    exp_types = ["fatal", "error", "info", "debug", "warn"]
+    exp_messages = ["fatal message", "error message",
+                    "info message", "hi mom", "all your base"]
+    exp_details = [ "[\"string\", 123, {:fatal=>\"message\", "\
+                     ":another_key=>\"value\"}]\n",
+                    "[1, 2, 3, {:error=>\"message\"}]\n",
+                    "nil\n",
+                    "[\"one\", \"two\", 3, 4.0]\n",
+                    "[5]\n"]
+    [[nil, 5], [7, 4], [3, 3], [0, 0]].each do |days, exp_count|
+      if days
+        press('System')
+        show_submenu('Log Maintenance')
+        press('Cleanup Log Table')
+        wait_for_ajax
+        find(:xpath, "//input[contains(@id, 'textfield')]", wait: 5).set(days)
+        press('OK')
+        wait_for_ready
+        find(:refresh).click
+        wait_for_ready
+      end
+      cnt = logview.row_count()
+      expect(cnt).to eq(exp_count)
+      types = logview.col_values('message_type', cnt, 0)
+      messages = logview.col_values('message', cnt, 0)
+      details = logview.col_values('details', cnt, 0).
+                map { |d| CGI.unescapeHTML(d) }
+      ts = logview.col_values('timestamp', cnt, 0)
+      expect(ts).to eq(@ts.slice(0,exp_count))
+      expect(types).to eq(exp_types.slice(0,exp_count))
+      expect(messages).to eq(exp_messages.slice(0,exp_count))
+      expect(details).to eq(exp_details.slice(0,exp_count))
+    end
+  end
+end

data/spec/lib/logger_spec.rb

@@ -0,0 +1,100 @@
+require 'spec_helper'
+
+module Marty
+  describe Logger do
+    before(:all) do
+      self.use_transactional_fixtures = false
+    end
+    before(:each) do
+      @db =  SQLite3::Database.new(Marty::Log.logfile)
+    end
+    after(:each) do
+      @db.execute "delete from log"
+      @db.close
+    end
+    after(:all) do
+      self.use_transactional_fixtures = true
+    end
+
+    it "logs" do
+      File.open(Rails.root.join("log/test.log")) do |f|
+        f.seek(0, IO::SEEK_END)
+        info_s = { info: 'message' }
+        error_s = [1, 2, 3, { error: 'message' }]
+        fatal_s = ["string", 123, { fatal: "message", another_key: 'value' }]
+        Marty::Logger.info('info message', info_s)
+        Marty::Logger.error('error message', error_s)
+        Marty::Logger.fatal('fatal message', fatal_s)
+        rails_log = f.readlines
+        log = @db.execute "select * from log"
+        log_detail = []
+        log_ts = []
+        log.each do |l|
+          id, type, msg, ts, detail_str = l
+          log_detail[id] = [type, msg, detail_str]
+          log_ts[id] = ts
+        end
+        expect(rails_log).to eq(["info message\n",
+                                 "error message\n",
+                                 "fatal message\n"])
+        expect(log_detail[1]).to eq(["info", "info message",
+                                     info_s.pretty_inspect])
+        expect(log_detail[2]).to eq(["error", "error message",
+                                     error_s.pretty_inspect])
+        expect(log_detail[3]).to eq(["fatal", "fatal message",
+                                     fatal_s.pretty_inspect])
+        (1..3).each do |idx|
+          expect(log_ts[idx]).to be_within(5).of(Time.zone.now.to_i)
+        end
+      end
+    end
+    it "with_logging" do
+      bd = 'block description'
+      the_error = 'error during my block'
+      data = [1, 2, 3, Marty::User.first]
+      begin
+        Marty::Logger.with_logging(bd, data) do
+          raise the_error
+        end
+      rescue => e
+        raised = e.message
+      end
+      expect(raised).to eq("#{bd}: #{the_error}")
+      log = Marty::Log.first
+      expect(log.message_type).to eq('error')
+      expect(log.message).to eq(bd)
+      expect(log.details).to eq({ message: the_error,
+                                  data: data }.pretty_inspect)
+    end
+  end
+  describe "Logger errors" do
+    it "fails gracefully" do
+      allow(Marty::Log).to receive(:db_init).
+                            and_raise("Error initializing DB")
+      Marty::Log.instance_variable_set(:@db, nil)
+      File.open(Rails.root.join("log/test.log")) do |f|
+        f.seek(0, IO::SEEK_END)
+        expect{Marty::Logger.info('info message', [1,2,3])}.not_to raise_error
+        rails_log = f.readlines
+        expect(rails_log).to eq(["info message\n",
+                                 "Marty::Logger failure: Error initializing DB\n"])
+      end
+    end
+    it "fails gracefully in ensure" do
+      Marty::Logger.info('init db', [])
+      close_err = 'Error closing statement'
+      allow_any_instance_of(SQLite3::Statement).to receive(:close).
+                                                   and_raise(close_err)
+      File.open(Rails.root.join("log/test.log")) do |f|
+        f.seek(0, IO::SEEK_END)
+        expect{Marty::Logger.info('ensure message', [1,2,3])}.not_to raise_error
+        rails_log = f.readlines
+        expect(rails_log).to eq(["ensure message\n"])
+        allow_any_instance_of(SQLite3::Statement).to receive(:close).
+                                                      and_call_original
+        sleep 1
+        Marty::Log.cleanup(0)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -11,9 +11,12 @@ ActiveRecord::Migrator.migrate File.expand_path("../dummy/db/migrate/", __FILE__
 
 Dir[Rails.root.join("../support/**/*.rb")].each { |f| require f }
 
+CLASSES_TO_EXCLUDE_FROM_SHARED = ["Marty::Log"]
 class ActiveRecord::Base
   mattr_accessor :shared_connection
-
+  class << self
+    alias_method :orig_connection, :connection
+  end
   def self.clear_connection
     @@shared_connection = nil
   end
@@ -21,7 +24,8 @@ class ActiveRecord::Base
   clear_connection
 
   def self.connection
-    @@shared_connection || retrieve_connection
+    CLASSES_TO_EXCLUDE_FROM_SHARED.include?(model_name) ? orig_connection :
+      @@shared_connection || retrieve_connection
   end
 
   def self.reset_shared_connection

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: marty
 version: !ruby/object:Gem::Version
-  version: 1.0.23
+  version: 1.0.24
 platform: ruby
 authors:
 - Arman Bostani
@@ -14,7 +14,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-01 00:00:00.000000000 Z
+date: 2017-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg
@@ -156,6 +156,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Marty is a framework for viewing and reporting on versioned data.
 email:
 - arman.bostani@pnmac.com
@@ -187,6 +201,7 @@ files:
 - app/components/marty/grid_append_only.rb
 - app/components/marty/import_type_view.rb
 - app/components/marty/live_search_grid_panel.rb
+- app/components/marty/log_view.rb
 - app/components/marty/main_auth_app.rb
 - app/components/marty/mcfly_grid_panel.rb
 - app/components/marty/new_posting_form.rb
@@ -392,6 +407,7 @@ files:
 - app/models/marty/grid_index_numrange.rb
 - app/models/marty/grid_index_string.rb
 - app/models/marty/import_type.rb
+- app/models/marty/log.rb
 - app/models/marty/name_validator.rb
 - app/models/marty/pg_enum.rb
 - app/models/marty/posting.rb
@@ -450,6 +466,7 @@ files:
 - lib/marty/data_importer.rb
 - lib/marty/engine.rb
 - lib/marty/lazy_column_loader.rb
+- lib/marty/logger.rb
 - lib/marty/mcfly_query.rb
 - lib/marty/migrations.rb
 - lib/marty/monkey.rb
@@ -1556,6 +1573,7 @@ files:
 - spec/features/javascripts/job_dashboard_live_search.js.coffee
 - spec/features/javascripts/login.js.coffee
 - spec/features/jobs_dashboard_spec.rb
+- spec/features/log_view_spec.rb
 - spec/features/reporting_spec.rb
 - spec/features/scripting_spec.rb
 - spec/features/scripting_test_spec.rb
@@ -1565,6 +1583,7 @@ files:
 - spec/job_helper.rb
 - spec/lib/data_exporter_spec.rb
 - spec/lib/data_importer_spec.rb
+- spec/lib/logger_spec.rb
 - spec/lib/migrations/vw_marty_postings.sql.expected
 - spec/lib/migrations_spec.rb
 - spec/lib/xl_spec.rb