rack-mp 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 22895b209bd2e1a98ef961edeaba34a147f7f107
+  data.tar.gz: 014e5fdf5e5847cc1836c8ff8a726221e579ceb2
+SHA512:
+  metadata.gz: ab9631e11ee6057099e88204e73767150f3e58d2f0ea8fcd2f0e4d6a9d37f002062873cec5d3e8b78b5598a2add6f33b5ddff8402c5644b0d49963badc54660b
+  data.tar.gz: 71b4e6518226d5bfae0074306b856495b8f2f5e66cf25d5928df22742cb5ed1a56b034e1cf9ccb4a1c1ce569f4ed35409779352077584a79e09c239e4373b4fc

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+test/*.data

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mp.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 JJ Buckley
+
+MIT License
+
+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,40 @@
+# MP
+
+Memory profiler for Rack apps (on Ruby 2)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'mp'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mp
+
+## Usage
+
+Mount MP as a middleware.
+
+Visit a path with `__mp__=counts` somewhere in the query string.
+
+Check the response headers for `X-MP-ObjectCounts`.
+
+
+## TODO
+
+* Make the header smaller (serialize to "OBJNAME:N1:N2,...", for example)
+* Use Ruby 2.1's excellent objspace library to do full object profiling, and
+  serve beautiful graphs and whatnot. Mañana.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/mp/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.libs << "test"
+end
+
+task default: :test

data/lib/rack/mp.rb

@@ -0,0 +1,6 @@
+require 'rack/mp/middleware'
+
+module Rack
+  module MP
+  end
+end

data/lib/rack/mp/middleware.rb

@@ -0,0 +1,64 @@
+require 'multi_json'
+
+module Rack
+  module MP
+    # Small middleware to count Ruby objects before and after a request. Puts
+    # the values in the X-MP-ObjectCounts response header. Just pass
+    # __mp__=counts in the query string.
+    #
+    # That's all it does at the moment - probably only useful for identifying
+    # which type of object is causing a memory leak. And, possibly, confirming
+    # which queries are contributing.
+    class Middleware
+
+      # New middleware instance.
+      def initialize(app)
+        @app = app
+      end
+
+      # Run the middleware. Will count the objects, run the app, count the
+      # objects, and output how long the whole thing took, and the number of
+      # objects before and after.
+      #
+      # NOTE - the header string will be JSON! Yuck. But it was the quickest
+      # way to do it for now.
+      def call(env)
+        return @app.call(env) unless active?(env)
+        before, t0 = time { count_objects }
+        result, t1 = time { @app.call(env.merge('mp.counting' => true)) }
+        after,  t2 = time { count_objects }
+        timings = { before: t0, request: t1, after: t2 }
+        data = serialize(before: before, after: after, timings: timings)
+        status, headers, body = *result
+        [status, headers.merge('X-MP-ObjectCounts' => data), result]
+      end
+
+      private
+      # Check whether we need to do anything.
+      # Just looks for __mp__=counts in the query string. Not very
+      # sophisticated. Could be extended to check authentication, etc.
+      def active?(env)
+        env['QUERY_STRING'] =~ %r{__mp__=counts}
+      end
+
+      # The simplest object counter. Could potentially be expanded to ask all
+      # apps in a cluster, and sum them!
+      def count_objects
+        ObjectSpace.count_objects
+      end
+
+      # Make a string for the response.
+      # Easiest output for now seems to be JSON
+      def serialize(*args)
+        MultiJson.dump(*args)
+      end
+
+      # Time an operation, returning the operation's result and the time it
+      # took.
+      def time(&block)
+        t = Time.now
+        [yield, Time.now - t]
+      end
+    end
+  end
+end

data/lib/rack/mp/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  module MP
+    VERSION = "0.0.1"
+  end
+end

data/rack-mp.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rack/mp/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rack-mp"
+  spec.version       = Rack::MP::VERSION
+  spec.authors       = ["JJ Buckley"]
+  spec.email         = ["jj@bjjb.org"]
+  spec.summary       = %q{Rack Memory Profiler}
+  spec.description   = %q{Helps analyse memory usage in your Rack apps}
+  spec.homepage      = "http://bjjb.github.io/rack-mp"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rack-test"
+  spec.add_dependency "rack" # obviously
+  spec.add_dependency "multi_json" # chooses the fastest JSON available
+  spec.add_dependency "hipsterhash" # faster than an OpenStruct
+end

data/test/rack/mp/middleware_test.rb

@@ -0,0 +1,38 @@
+require 'test_helper'
+require 'json'
+require 'rack/mp/middleware'
+
+describe Rack::MP::Middleware do
+  include Rack::Test::Methods
+
+  let(:middleware) do
+    Rack::MP::Middleware
+  end
+
+  let(:app) do
+    Rack::Builder.new do
+      use Rack::MP::Middleware
+      run lambda { |env| [200, {}, ["OK"]] }
+    end
+  end
+
+  let(:data) do
+    JSON.parse(last_response.body)
+  end
+
+  let(:header) do
+    JSON.parse(last_response.header['X-MP-ObjectCounts'])
+  end
+
+  it "can be used to see object counts" do
+    get "/"
+    last_response.must_be :ok?
+    last_response.header.keys.wont_include 'X-MP-ObjectCounts'
+    get "/?__mp__=counts"
+    last_response.must_be :ok?
+    last_response.header.keys.must_include 'X-MP-ObjectCounts'
+    header.keys.must_include("before")
+    header.keys.must_include("after")
+    header.keys.must_include("timings")
+  end
+end

data/test/rack/mp_test.rb

@@ -0,0 +1,6 @@
+require 'test_helper'
+require 'rack/mp'
+
+describe Rack::MP do
+  # No tests, yet.
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'minitest/autorun'
+require 'minitest/spec'
+require 'rack/test'

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: rack-mp
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- JJ Buckley
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: 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: rack
+  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'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  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'
+- !ruby/object:Gem::Dependency
+  name: hipsterhash
+  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: Helps analyse memory usage in your Rack apps
+email:
+- jj@bjjb.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rack/mp.rb
+- lib/rack/mp/middleware.rb
+- lib/rack/mp/version.rb
+- rack-mp.gemspec
+- test/rack/mp/middleware_test.rb
+- test/rack/mp_test.rb
+- test/test_helper.rb
+homepage: http://bjjb.github.io/rack-mp
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Rack Memory Profiler
+test_files:
+- test/rack/mp/middleware_test.rb
+- test/rack/mp_test.rb
+- test/test_helper.rb