workety 2.0.3

data/lib/workety.rb

@@ -0,0 +1,53 @@
+
+#  Copyright 2006-2011 Stanislav Senotrusov <stan@senotrusov.com>
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
+
+require 'pp'
+
+
+gems = lambda do |name|
+  if Gem::Specification.respond_to?(:find_all_by_name)
+    Gem::Specification.find_all_by_name(name).any?
+  elsif Gem.respond_to?(:available?)
+    Gem.available?(name)
+  else
+    raise "Don't know how to check gem availability"
+  end
+end
+
+
+if gems['exceptional']
+  require 'exceptional'
+  require 'workety/extensions/exceptional.rb'
+end
+
+if gems['toadhopper']
+  require 'toadhopper'
+end
+
+
+require 'workety/extensions/exception.rb'
+require 'workety/extensions/kernel.rb'
+require 'workety/extensions/process.rb'
+require 'workety/extensions/signal.rb'
+require 'workety/extensions/socket.rb'
+require 'workety/extensions/thread.rb'
+
+
+require 'workety/timed_exit.rb'
+
+
+require 'workety/workety.rb'
+

data/lib/workety/extensions/exception.rb

@@ -0,0 +1,140 @@
+
+#  Copyright 2006-2011 Stanislav Senotrusov <stan@senotrusov.com>
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
+
+class Exception
+  
+  def details
+    @details ||= {}
+  end
+  
+  # begin
+  #   raise StandardError.details("ALARM!", :a=>1)
+  # rescue => ex
+  #   puts ex.view
+  # end
+  #
+  def self.details message = nil, details = {}
+    if message.kind_of? Hash
+      message, details = nil, message
+    end
+    
+    ex = new message
+    ex.details.merge! details
+    ex
+  end
+  
+  def view!
+    STDERR.write "#{view}\n"
+  end
+
+  def view
+    [summary_view, details_view, backtrace_view].compact.join("\n")
+  rescue ScriptError, StandardError
+    "ERROR CREATING EXCEPTION VIEW"
+  end
+
+  def summary_view
+    "#{self.class.name}: #{message}"
+  end
+  
+  def details_view
+    "Details: #{details.inspect}" if details.any?
+  rescue ScriptError, StandardError => ex
+    "Details: ERROR CREATING DETAILS VIEW:\n" \
+    "#{ex.summary_view}\n" \
+    "#{ex.backtrace_view}"
+  end
+  
+  def backtrace_view
+    ((bt = backtrace) && bt.collect{|line|"\t#{line}\n"}.join("") || "\tBacktrace undefined")
+  rescue ScriptError, StandardError => ex
+    "\tERROR CREATING BACKTRACE VIEW: #{ex.summary_view}"
+  end
+  
+  
+  # The following methods should not be called before Rails initialization.
+   
+  def logger
+    Rails.logger
+  end
+  
+  def report!
+    log!
+    report_to_trackers! if Rails.env == "production"
+  end
+  
+  def report_to_trackers!
+    report_to_exceptional! if defined?(Exceptional)
+    report_to_airbrake! if defined?(Toadhopper)
+  end
+  
+  def log!
+    logger.error view
+    logger.flush if logger.respond_to? :flush
+  rescue ScriptError, StandardError => ex
+    STDERR.write "ERROR: LOGGING ANOTHER EXCEPTION THE FOLLOWING EXCEPTION OCCURED:\n" \
+                 "#{ex.view}\n" \
+                 "THE FOLLOWING EXCEPTION WAS NOT STORED IN LOG:\n" \
+                 "#{view}\n"
+  end
+  
+  
+  def report_to_exceptional!
+    Exceptional::Remote.error Exceptional::DetailsExceptionData.new(self)
+    Exceptional.context.clear!
+  rescue ScriptError, StandardError => ex
+    ex.log!
+  end
+  
+  
+  # Airbrake API requires the following elements to be present:
+  #   /notice/error/class
+  #   /notice/error/backtrace/line
+  #   /notice/server-environment/environment-name
+  #
+  def report_to_airbrake!
+    File.readable?(file = Rails.root + 'config' + 'airbrake.yml') &&
+      (yaml = YAML.load_file file).kind_of?(Hash) &&
+      (api_key = yaml["api-key"]).kind_of?(String) ||
+      raise("Unable to read Airbrake api-key from #{file}")
+    
+    options = if details[:request].kind_of? Hash
+      params = details.dup
+      request = params.delete :request
+      
+      { url:           request[:url],
+        component:     request[:controller],
+        action:        request[:action],
+        params:        (request[:params] || {}).merge(params),
+        session:       request[:session],
+        framework_env: Rails.env }
+      
+    else
+      { params:        details,
+        framework_env: Rails.env }
+    end
+    
+    response = Toadhopper(api_key).post!(self, options)
+    
+    if response.status != 200
+      raise StandardError.details("Tracker responded with status #{response.status}", body: response.body)
+    end
+    
+  rescue ScriptError, StandardError => ex
+    ex.log!
+  end
+end
+

data/lib/workety/extensions/exceptional.rb

@@ -0,0 +1,52 @@
+
+#  Copyright 2006-2011 Stanislav Senotrusov <stan@senotrusov.com>
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
+
+class Exceptional::DetailsExceptionData < Exceptional::ExceptionData
+  def initialize exception
+    @exception = exception
+    @details   = @exception.details.dup
+    @name      = @details.delete(:name)
+    @request   = @details[:request].kind_of?(Hash) && @details.delete(:request)
+  end
+  
+  alias_method :context_stuff_orig, :context_stuff
+  
+  def context_stuff
+    data = context_stuff_orig
+    
+    if @details.any?
+      if data['context']
+        data['context'].merge! @details
+      else
+        data['context'] = @details
+      end
+    end
+    
+    if @request
+      data['request'] = {
+        'url'        => @request[:url],
+        'controller' => @request[:controller],
+        'action'     => @request[:action],
+        'parameters' => @request[:params],
+        'headers'    => @request[:headers],
+        'session'    => @request[:session]
+        }
+    end
+    
+    data
+  end
+end
+

data/lib/workety/extensions/kernel.rb

@@ -0,0 +1,28 @@
+
+#  Copyright 2006-2011 Stanislav Senotrusov <stan@senotrusov.com>
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
+
+module Kernel
+  def rescue_exit
+    yield
+  rescue ScriptError, StandardError => exception
+    begin
+      exception.report!
+    ensure
+      Process.exit(false)
+    end              
+  end
+end
+

data/lib/workety/extensions/process.rb

@@ -0,0 +1,38 @@
+
+#  Copyright 2006-2011 Stanislav Senotrusov <stan@senotrusov.com>
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
+
+require 'etc'
+
+module Process
+
+  # Drop privilegies and chown logfile
+  #
+  # http://timetobleed.com/5-things-you-dont-know-about-user-ids-that-will-destroy-you/
+  # http://www.ruby-forum.com/topic/110492
+  #
+  def self.change_privilegies user, group
+    user = user ? Etc.getpwnam(user) : Etc.getpwuid(Process.euid)
+    group = group ? Etc.getgrnam(group) : Etc.getgrgid(user.gid)
+    
+    Rails.logger.chown_logfile(user.uid, group.gid) if Rails.logger.respond_to?(:chown_logfile)
+    
+    Process.initgroups(user.name, group.gid)
+    
+    Process::GID.change_privilege(group.gid) 
+    Process::UID.change_privilege(user.uid)
+  end
+end
+

data/lib/workety/extensions/signal.rb

@@ -0,0 +1,31 @@
+
+#  Copyright 2006-2011 Stanislav Senotrusov <stan@senotrusov.com>
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
+
+module Signal
+  def self.threaded_trap(signal)
+    trap(signal) do
+      rescue_exit do # This rescue_exit is the case for ThreadError: can't create Thread (see example below)        
+        Thread.rescue_exit { yield }
+      end
+    end
+  end
+end
+
+
+# 1000000.times { |i| begin; Thread.new {sleep 100}; rescue => e; puts i; raise e; end }
+# 2848
+# ThreadError: can't create Thread (1)
+

data/lib/workety/extensions/socket.rb

@@ -0,0 +1,51 @@
+
+#  Copyright 2006-2011 Stanislav Senotrusov <stan@senotrusov.com>
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
+
+
+require 'socket'
+
+# rescue *(Socket::NETWORK_EXEPTIONS) => exception
+
+class Socket
+  NETWORK_EXEPTIONS = [
+    IOError,
+    EOFError,
+    Errno::EBADF,
+    Errno::ECONNRESET,
+    Errno::ECONNREFUSED,
+    Errno::EPIPE,
+    Errno::ETIMEDOUT,
+    Errno::EHOSTUNREACH,
+    Errno::ESHUTDOWN,
+    Errno::ENETDOWN,
+    Errno::ENETUNREACH,
+    Errno::ENETRESET,
+    Errno::EIO,
+    Errno::EHOSTDOWN,
+    Errno::ECONNABORTED,
+    Errno::ENOTCONN, # In attempt to shutdown() socket with remote side disconnected (send responds with Errno::EPIPE: Broken pipe)
+    ]  
+  
+  # At least Windows XP does not have it
+  NETWORK_EXEPTIONS.push(Errno::EPROTO) if defined?(Errno::EPROTO)
+  NETWORK_EXEPTIONS.push(Errno::ECOMM)  if defined?(Errno::ECOMM)
+  
+  def self.may_fail
+    yield
+  rescue *(Socket::NETWORK_EXEPTIONS)
+  end
+end
+

data/lib/workety/extensions/thread.rb

@@ -0,0 +1,109 @@
+
+#  Copyright 2006-2011 Stanislav Senotrusov <stan@senotrusov.com>
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
+
+require 'thread'
+
+class Thread
+  
+  def self.workety(*args)
+    new do
+      begin
+        Workety.rescue_abort { yield(*args) }
+        
+      ensure
+        # That block is executed on Thread#kill as well
+        #
+        # I think an error in clear_active_connections! is not the case
+        # for panic and instant process shutdown but for normal shutdown procedure.
+        #  
+        Workety.rescue_abort { ActiveRecord::Base.clear_active_connections! }
+         
+      end
+    end
+  end
+  
+  
+  def self.networkety(*args)
+    workety do
+      begin
+        yield(*args)
+      rescue *(Socket::NETWORK_EXEPTIONS) => exception
+        Rails.logger.warn "Thread stopped due a network error listed in Socket::NETWORK_EXEPTIONS"
+        Rails.logger.warn exception.view
+        Rails.logger.flush if Rails.logger.respond_to?(:flush)
+
+        # If thread is blocked by Socket#read and then are forced to unblock by using Socket#shutdown and then Socket#close methods,
+        # that will raise an exception. That exception has no value to set Workety.aborted? flag.
+        # If Workety.must_stop? is set we suggest that such technique was used.
+        Workety.abort unless Workety.must_stop? 
+      end
+    end
+  end
+  
+  
+  def self.rescue_exit
+    new do
+      Kernel.rescue_exit { yield }
+    end
+  end
+
+  
+  def view
+    "#{summary_view}\n#{thread_local_vars_view}#{backtrace_view}"
+  end
+
+  def summary_view
+    "#{self.class.name} 0x#{object_id.to_s(16)}: #{status_view}"
+  end
+  
+  def status_view
+    st = status; (st == false) ? "terminated normally" : (st || "terminated with an exception")
+  end
+
+  def thread_local_vars_view
+    if (ks = keys).any?
+      vars = {}; ks.each {|k| vars[k] = self[k]}
+      "Thread-local variables: #{vars.inspect}\n"
+    end
+  end
+
+  def backtrace_view
+    ((bt = backtrace) && bt.collect{|line| "\t#{line}\n"}.join("") || "\tBacktrace undefined")
+  end
+  
+  
+  def self.log message = nil
+    threads = self.list
+    Rails.logger.warn(message) if message
+    Rails.logger.warn "Thread list: #{threads.length} threads total at #{Time.now}"
+    
+    threads.each_with_index do |item, index|
+      Rails.logger.warn msg = "Thread #{index + 1} of #{threads.length}"
+      Rails.logger.warn "-" * msg.length
+      Rails.logger.warn item.view
+    end
+    
+    Rails.logger.flush if Rails.logger.respond_to?(:flush)
+  end
+  
+  
+  def log_join(message, limit = nil)
+    join limit
+    Rails.logger.info message
+  end
+
+end
+