appsignal_extensions 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9ad075af5017ee836dccf6dd9f843e49f424244bc2bac82218e592c5bfa1a9e5
+  data.tar.gz: c2316f2602ffaaf98992b53e9c0e0b889825a1298e73616a804b307ac1d473d4
+SHA512:
+  metadata.gz: 6ffab21dd7fc9262a8eda73fa0610ef855fd21efe242899760066e742b3fecf2f750bd6d09253e347df658d92b7c21bdae8e573cbfbc56ac531daafef5d4fb0b
+  data.tar.gz: b65d17ffc37ce7c6f4e5e7db5107f35da70dc6da8160273b9aca856f5e3bc1135c1c5f076c92df28f853ef6571edf4673a6df3834fae0ed39c1f7b4416bc4ccc

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.gitignore

@@ -0,0 +1,50 @@
+# rcov generated
+coverage
+coverage.data
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# bundler
+.bundle
+Gemfile.lock
+
+# jeweler generated
+pkg
+
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore: 
+#
+# * Create a file at ~/.gitignore
+# * Include files you want ignored
+# * Run: git config --global core.excludesfile ~/.gitignore
+#
+# After doing this, these files will be ignored in all your git projects,
+# saving you from having to 'pollute' every project you touch with them
+#
+# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
+#
+# For MacOS:
+#
+#.DS_Store
+
+# For TextMate
+#*.tmproj
+#tmtags
+
+# For emacs:
+#*~
+#\#*
+#.\#*
+
+# For vim:
+#*.swp
+
+# For redcar:
+#.redcar
+
+# For rubinius:
+#*.rbc

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2016 WeTransfer
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,48 @@
+# appsignal_extensions
+
+When you want to do something more to Appsignal than the gem provides out of the box.
+
+## The Rack middleware
+
+The gem provides a customized Appsignal middleware, which makes a number of extra things
+possible. Simplest use is just like the standard Rack listener in Appsignal:
+
+    use AppsignalExtensions::Middleware
+
+Just make sure Appsignal is configured and started at some point in the code. That means
+that for information to come in `Appsignal.active?` should be true.
+
+The transaction is going to be kept open as long as the iteraion over the Rack body
+object continues. Therefore, you can use this middleware for long-polling too (long bodies
+which `yield` chunked content and so on).
+
+If you need more specific long response support, you can output a special header with your
+response called 'appsignal.suspend'. If you set that header to a truthy value, the transaction
+is not going to be closed for you. You can then close the transaction with your Thin `errback`
+proc or similar, or close it explicitly in the `close` handler of your response body.
+
+The transaction is also going to be placed in the `appsignal.transaction` Rack env variable,
+and you can do things to the transaction manually. For instance:
+  
+    ->(env) {
+      env['appsignal.transaction'].set_action('MyHandler#perform')
+      ...
+    }
+
+If Appsignal is not enabled or not configured, the middleware is going to supply you with a
+special `NullTransaction` object instead which responds to all the same methods as a real
+`Appsignal::Transaction`, so that you can avoid redundant nil checks.
+
+## Contributing to appsignal_extensions
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2016 WeTransfer. See LICENSE.txt for further details.

data/Rakefile

@@ -0,0 +1,22 @@
+# encoding: utf-8
+require 'rubygems'
+require 'bundler'
+require 'bundler/gem_tasks'
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "appsignal_extensions #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/appsignal_extensions.gemspec

@@ -0,0 +1,33 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'appsignal_extensions/version'
+
+Gem::Specification.new do |s|
+  s.name = "appsignal_extensions"
+  s.version = AppsignalExtensions::VERSION
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
+  s.authors = ["Julik Tarkhanov"]
+  s.date = "2016-03-17"
+  s.description = "Doing some more with Appsignal"
+  s.email = "me@julik.nl"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  s.homepage = "https://gitlab.wetransfer.net/julik/appsignal_extensions"
+  s.licenses = ["MIT"]
+  s.rubygems_version = "2.2.2"
+  s.summary = "Suspend an Appsignal transaction for long responses"
+  s.specification_version = 4
+  s.add_runtime_dependency(%q<appsignal>, ["~> 1"])
+  s.add_development_dependency(%q<rake>, ["~> 10"])
+  s.add_development_dependency(%q<rack-test>, [">= 0"])
+  s.add_development_dependency(%q<rspec>, ["~> 3.2.0"])
+  s.add_development_dependency(%q<rdoc>, ["~> 6"])
+  s.add_development_dependency(%q<bundler>, ["~> 1.0"])
+end

data/lib/appsignal_extensions.rb

@@ -0,0 +1,6 @@
+require 'appsignal'
+
+module AppsignalExtensions
+  require_relative 'appsignal_extensions/version'
+  require_relative 'appsignal_extensions/middleware'
+end

data/lib/appsignal_extensions/middleware.rb

@@ -0,0 +1,139 @@
+require 'delegate'
+
+# Used to open an Appsignal transaction, but to let the callee close
+# it when it is done. The standard Rack middleware for Appsignal
+# closes the transaction as soon as the response triplet gets returned,
+# we need to keep the transaction open as long as the response is being read.
+class AppsignalExtensions::Middleware
+  
+  def self.appsignal_defined_and_active?
+    !!(defined?(Appsignal) && Appsignal.active?)
+  end
+  
+  # Appsignal::Transaction has no #close method, you have to use a global
+  # function call instead. We wrap it with a simple proxy that provides
+  # close
+  class Close < SimpleDelegator
+    # Closes the current Appsignal transaction
+    def close
+      if AppsignalExtensions::Middleware.appsignal_defined_and_active?
+        Appsignal::Transaction.complete_current!
+      end
+    end
+  end
+  
+  # Acts as a null-object replacement for the Appsignal transaction if there is no
+  # transaction to provide (when Appsignal is not defined under jRuby or when
+  # Appsignal is not configured or disabled). Supports the basic method set
+  # that is important for us.
+  class NullTransaction
+    # @return [void]
+    def set_action(*);end
+    
+    # @return [void]
+    def set_metadata(*);end
+    
+    # @return [void]
+    def set_http_or_background_queue_start(*);end
+    
+    # @return [void]
+    def set_error(*); end
+    
+    # @return [void]
+    def close(*);end
+  end
+  
+  # Acts as a wrapper for Rack response bodies. Ensures that the transaction attached to
+  # the request gets closed after the body #each returns or raises
+  class TransactionClosingBody
+    def initialize(body, transaction)
+      @body, @transaction = body, transaction
+    end
+    
+    def each
+      @body.each{|b| yield(b) }
+    rescue Exception => e
+      @transaction.set_error(e)
+      raise e
+    ensure
+      @transaction.close
+    end
+    
+    def close
+      @body.close if @body.respond_to?(:close)
+    end
+  end
+  
+  # Creates a new Appsignal middleware handler with the given Rack app as a callee
+  #
+  # @param app[#call] the Rack app
+  def initialize(app)
+    @app = app
+  end
+  
+  # Calls the application, captures errors, sets up wrappers and so forth
+  #
+  # @param env[Hash] the Rack env
+  # @return [Array] the Rack response triplet from upstream
+  def call(env)
+    request = ::Rack::Request.new(env)
+    env['action_dispatch.request_id'] ||= SecureRandom.uuid
+    if self.class.appsignal_defined_and_active?
+      call_with_appsignal(env, request)
+    else
+      call_with_null_transaction(env, request)
+    end
+  end
+  
+  private
+  
+  def call_and_capture(env, transaction, request)
+    env['appsignal.transaction'] = transaction
+    app_name = @app.is_a?(Module) ? @app.to_s : @app.class.to_s # Set the class name properly
+    transaction.set_action('%s#%s' % [app_name, 'call'])
+    transaction.set_metadata('path', request.path)
+    transaction.set_metadata('method', request.request_method)
+    transaction.set_http_or_background_queue_start
+    s, h, b = @app.call(env)
+    
+    # If the app we called wants to close the transaction on it's own, return the response. This
+    # is useful if the app will clean up or close the transaction within an async.callback block,
+    # or within the long response body, or within a hijack proc.
+    return [s, h, b] if h.delete('appsignal.suspend')
+    
+    # If the app didn't ask for the explicit suspend, Wrap the response in a self-closing wrapper
+    # so that the transaction is closed once the response is read in full. This wrapper only works
+    # with response bodies that support #each().
+    closing_wrapper = TransactionClosingBody.new(b, transaction)
+    [s, h, closing_wrapper]
+  rescue Exception => e
+    # If the raise happens immediately (not in the response read cycle)
+    # set the error and close the transaction so that the data gets sent
+    # to Appsignal right away, and ensure it gets closed
+    transaction.set_error(e)
+    transaction.close
+    raise e
+  end
+  
+  def call_with_null_transaction(env, request)
+    # Supply the app with a null transaction
+    call_and_capture(env, NullTransaction.new, request)
+  end
+  
+  def call_with_appsignal(env, request)
+    bare_transaction = Appsignal::Transaction.create(
+      env.fetch('action_dispatch.request_id'),
+      Appsignal::Transaction::HTTP_REQUEST,
+      request
+    )
+    
+    # Let the app do something to the appsignal transaction if it wants to
+    # Instrument a `process_action`, to set params/action name
+    transaction = Close.new(bare_transaction)
+    status, headers, body = ActiveSupport::Notifications.instrument('process_action.rack') do
+      call_and_capture(env, transaction, request)
+    end
+    
+    [status, headers, body]
+  end
+end

data/lib/appsignal_extensions/version.rb

@@ -0,0 +1,3 @@
+module AppsignalExtensions
+  VERSION = '0.0.4'
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: appsignal_extensions
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+platform: ruby
+authors:
+- Julik Tarkhanov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: appsignal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Doing some more with Appsignal
+email: me@julik.nl
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- ".document"
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- appsignal_extensions.gemspec
+- lib/appsignal_extensions.rb
+- lib/appsignal_extensions/middleware.rb
+- lib/appsignal_extensions/version.rb
+homepage: https://gitlab.wetransfer.net/julik/appsignal_extensions
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: Suspend an Appsignal transaction for long responses
+test_files: []