rack_mem_prof 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a18a36ef5f7dd70c156fd5b1fd75597cd9b3069032e5f5522c13a018197d9e32
+  data.tar.gz: 8c39106036de7812b16b9934fafc5678153b758d70a9418ff85e7804888f0c75
+SHA512:
+  metadata.gz: 64d47fee0f12c47c88ab71740e6708d2738da0612e6595e227ae572f4827c50477efd35cd718d602d65d180655f3b3eac404d51d4aa6010527aedfcb5545a8ef
+  data.tar.gz: a6d75f76fd72cd2689b2b57a62c1c0abb3797db71034d646b413f5bd2f530076524265bf3a6005c22f4f9523344065687a1f6847ed2d7d593dce8aa3b4f70954

data/.gitignore

@@ -0,0 +1,3 @@
+*.gem
+Gemfile.lock
+.ruby-version

data/Gemfile

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

data/README.md

@@ -0,0 +1,28 @@
+# About
+Use this middleware to profile API requests.
+
+!!! Remember about huge overhead that enabling ObjectSpace stats gives to your application. !!!
+
+# Installation
+Add in Gemfile:
+
+`gem 'rack_mem_prof'`
+
+Install dependencies:
+
+`$ bundle install`
+
+Install middleware:
+
+`config.middleware.use(Rack::MemProf::Middleware)`
+or
+```
+require 'rack/mem_prof'
+
+use Rack::MemProf::Middleware
+```
+
+# Options
+path
+
+scale_bytes

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler'
+require 'rake/testtask'
+Bundler::GemHelper.install_tasks
+
+task :default => :test
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end

data/lib/rack/mem_prof.rb

@@ -0,0 +1,6 @@
+require 'rack/mem_prof/middleware'
+
+module Rack
+  module MemProf
+  end
+end

data/lib/rack/mem_prof/middleware.rb

@@ -0,0 +1,64 @@
+require 'fileutils'
+require 'memory_profiler'
+require 'rack'
+require 'pry'
+
+module Rack
+  module MemProf
+    class Middleware
+      REPEXT = '.txt'.freeze
+      REPDIR = 'rack_mem_prof'.freeze
+
+      def initialize(app, options = {})
+        @app = app
+        @path = options[:path] || "/tmp"
+        @scale_bytes = options[:scale_bytes] || true
+      end
+
+      def call(env)
+        MemoryProfiler.start
+        status, headers, body = @app.call(env)
+        write_report(MemoryProfiler.stop, env)
+
+        [status, headers, body]
+      rescue => e
+        MemoryProfiler.stop
+        raise e
+      end
+
+      private
+
+      # report to "/tmp/rack_mem_prof/<request path>/<query params sha1>.txt"
+      def write_report(report, env)
+        request_report_path = ensure_path(env)
+        report.pretty_print(
+          scale_bytes: @scale_bytes,
+          to_file: report_file(request_report_path, env)
+        )
+      end
+
+      def report_file(request_report_path, env)
+        filename = generate_filename(env['QUERY_STRING'])
+        ::File.join(request_report_path, filename)
+      end
+
+      def ensure_path(env)
+        request_dirname = webpath_to_dirname(env['PATH_INFO'])
+        request_report_path = ::File.join(reports_path, request_dirname)
+        FileUtils.mkdir_p request_report_path
+      end
+
+      def webpath_to_dirname(path_info)
+        path_info.gsub(/[^0-9A-Za-z]/, '').downcase
+      end
+
+      def generate_filename(query_string)
+        Digest::SHA1.hexdigest(query_string).concat(REPEXT)
+      end
+
+      def reports_path
+        ::File.join(@path, REPDIR)
+      end
+    end
+  end
+end

data/lib/rack/mem_prof/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  module MemProf
+    VERSION = '0.0.2'
+  end
+end

data/rack_mem_prof.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rack/mem_prof/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rack_mem_prof'
+  spec.version       = Rack::MemProf::VERSION
+  spec.authors       = ['Vitaly Shvedchenko']
+  spec.email         = ['vitaly.shvedchenko@gmail.com']
+  spec.summary       = 'Rack memory profiling middleware'
+  spec.description   = "Sam Saffron's memory profiler made up as a rack middleware that writes reports to tmp folder"
+  spec.homepage      = 'https://github.com/shved/rack_mem_prof'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split("\n")
+  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_dependency 'rack'
+  spec.add_dependency 'memory_profiler', '~> 0.9'
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rack-test', '~> 1.1'
+  spec.add_development_dependency 'test-unit', '~> 3.3'
+  spec.add_development_dependency 'roda', '~> 3.29'
+  spec.add_development_dependency 'mocha', '~> 1.11'
+  spec.add_development_dependency 'pry'
+end
+
+

data/test/dummy_app.rb

@@ -0,0 +1,9 @@
+require 'roda'
+
+class DummyApp < Roda
+  route do |r|
+    r.get '' do
+      "hi"
+    end
+  end
+end

data/test/rack_mem_prof_test.rb

@@ -0,0 +1,25 @@
+require 'rack/mem_prof'
+require 'test/unit'
+require 'rack/test'
+require 'mocha'
+require 'mocha/setup'
+require 'dummy_app'
+
+class RackMemProfTest < Test::Unit::TestCase
+  include Rack::Test::Methods
+
+  attr_accessor :app
+
+  def teardown
+    @app = nil
+  end
+
+  def test_report_created
+    self.app = Rack::MemProf::Middleware.new(DummyApp.freeze.app)
+    MemoryProfiler.expects(:start).once
+    MemoryProfiler.expects(:stop).once
+    app.expects(:write_report).once
+    get '/'
+    assert last_response.ok?
+  end
+end

metadata

@@ -0,0 +1,182 @@
+--- !ruby/object:Gem::Specification
+name: rack_mem_prof
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Vitaly Shvedchenko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-03-02 00:00:00.000000000 Z
+dependencies:
+- !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: memory_profiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: roda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.29'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.29'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+description: Sam Saffron's memory profiler made up as a rack middleware that writes
+  reports to tmp folder
+email:
+- vitaly.shvedchenko@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- lib/rack/mem_prof.rb
+- lib/rack/mem_prof/middleware.rb
+- lib/rack/mem_prof/version.rb
+- rack_mem_prof.gemspec
+- test/dummy_app.rb
+- test/rack_mem_prof_test.rb
+homepage: https://github.com/shved/rack_mem_prof
+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: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Rack memory profiling middleware
+test_files:
+- test/dummy_app.rb
+- test/rack_mem_prof_test.rb