stackprof-route_middleware 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 93270cfc54a37b370613a770cd325d4986a6008718264fff0986938c129562c9
+  data.tar.gz: 802f0efb4202cd3e1e8ba96b80ddfb96427d1f23059a1865ca3b6098cb04a472
+SHA512:
+  metadata.gz: f91e8c04fac2d7a9cd29ae569c7f0caa6f163f2aa0ed694ba2976fbccf38765c891beb1bd72309d96692a8005983f217ee62d8ea5260cb5f4b41e9919b0a922b
+  data.tar.gz: 54f68f9d3af105c4ff52054b2bc5096858eca1e6ee80684cffd84fe209d25ab126a82d1562617c846a796f59a38dc01b6eeb7c24debfb7cedb3a095b34bdda26

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/testdouble/standard
+ruby_version: 3.0

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in stackprof-route_middleware.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "standard", "~> 1.3"

data/Gemfile.lock

@@ -0,0 +1,80 @@
+PATH
+  remote: .
+  specs:
+    stackprof-route_middleware (0.1.0)
+      stackprof
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.5.0)
+    json (2.7.1)
+    language_server-protocol (3.17.0.3)
+    lint_roller (1.1.0)
+    parallel (1.24.0)
+    parser (3.2.2.4)
+      ast (~> 2.4.1)
+      racc
+    racc (1.7.3)
+    rainbow (3.1.1)
+    rake (13.1.0)
+    regexp_parser (2.8.3)
+    rexml (3.2.6)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    rubocop (1.59.0)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.4)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.30.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.30.0)
+      parser (>= 3.2.1.0)
+    rubocop-performance (1.20.1)
+      rubocop (>= 1.48.1, < 2.0)
+      rubocop-ast (>= 1.30.0, < 2.0)
+    ruby-progressbar (1.13.0)
+    stackprof (0.2.25)
+    standard (1.33.0)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.59.0)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.3)
+    standard-custom (1.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50)
+    standard-performance (1.3.0)
+      lint_roller (~> 1.1)
+      rubocop-performance (~> 1.20.1)
+    unicode-display_width (2.5.0)
+
+PLATFORMS
+  arm64-darwin-21
+  arm64-darwin-22
+
+DEPENDENCIES
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  stackprof-route_middleware!
+  standard (~> 1.3)
+
+BUNDLED WITH
+   2.3.15

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Yusuke Sangenya
+
+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,105 @@
+# StackProf::RouteMiddleware
+
+Yet another `StackProf::Middleware` which saves dump files by each application route.
+
+## Usage
+
+### Sinatra
+
+Sample configuration:
+
+```ruby
+use StackProf::RouteMiddleware,
+    enabled: true,
+    mode: :wall,
+    interval: 1000,
+    raw: true,
+    route_calculator: proc { |env| env['sinatra.route'] }
+```
+
+Results in:
+
+```bash
+$ ls -alh tmp/
+$ ls -alh tmp  | head
+total 24632
+drwxr-xr-x@ 2261 sangenya  staff    71K  1  1 22:48 .
+drwxr-xr-x    16 sangenya  staff   512B  1  1 22:57 ..
+-rw-r--r--     1 sangenya  staff   109B  1  1 22:48 stackprof-GET__api_chair__id-wall-97768-1704116922.dump
+-rw-r--r--     1 sangenya  staff   109B  1  1 22:48 stackprof-GET__api_chair__id-wall-97768-1704116923.dump
+-rw-r--r--     1 sangenya  staff   109B  1  1 22:48 stackprof-GET__api_chair__id-wall-97768-1704116924.dump
+...
+-rw-r--r--     1 sangenya  staff   109B  1  1 22:48 stackprof-POST__api_estate_req_doc__id-wall-97783-1704116920.dump
+-rw-r--r--     1 sangenya  staff   109B  1  1 22:48 stackprof-POST__api_estate_req_doc__id-wall-97783-1704116921.dump
+-rw-r--r--     1 sangenya  staff   109B  1  1 22:48 stackprof-POST__api_estate_req_doc__id-wall-97783-1704116922.dump
+-rw-r--r--     1 sangenya  staff   109B  1  1 22:48 stackprof-POST__api_estate_req_doc__id-wall-97783-1704116923.dump
+```
+
+So you can analyze a specific route:
+
+```bash
+$ bundle exec stackprof tmp/stackprof-GET__api_estate_low_priced-wall-* --limit 5
+==================================
+  Mode: wall(1000)
+  Samples: 85 (1.16% miss rate)
+  GC: 2 (2.35%)
+==================================
+     TOTAL    (pct)     SAMPLES    (pct)     FRAME
+        71  (83.5%)          71  (83.5%)     Mysql2::Client#_query
+         4   (4.7%)           3   (3.5%)     JSON::Ext::Generator::GeneratorMethods::Hash#to_json
+         3   (3.5%)           3   (3.5%)     Mysql2::Result#each
+         2   (2.4%)           1   (1.2%)     App#camelize_keys_for_estate
+        82  (96.5%)           1   (1.2%)     Sinatra::Base#route!
+```
+
+### Ruby on Rails
+
+Sample configuration:
+
+```ruby
+use StackProf::RouteMiddleware,
+    enabled: true,
+    mode: :wall,
+    interval: 1000,
+    raw: true,
+    route_calculator:  proc { |env| "#{env['REQUEST_METHOD']}_#{env['action_dispatch.route_uri_pattern']}" }
+```
+
+Results in:
+
+```bash
+$ ls -alh tmp/stackprof-*
+-rw-r--r--  1 sangenya  staff   109B  1  1 23:36 tmp/stackprof-GET_-wall-3323-1704119802.dump
+-rw-r--r--  1 sangenya  staff   207K  1  1 23:36 tmp/stackprof-GET__users___format_-wall-3323-1704119801.dump
+-rw-r--r--  1 sangenya  staff    43K  1  1 23:36 tmp/stackprof-GET__users___format_-wall-3323-1704119805.dump
+-rw-r--r--  1 sangenya  staff    41K  1  1 23:36 tmp/stackprof-GET__users___format_-wall-3323-1704119812.dump
+-rw-r--r--  1 sangenya  staff    54K  1  1 23:36 tmp/stackprof-GET__users__id___format_-wall-3323-1704119804.dump
+-rw-r--r--  1 sangenya  staff    41K  1  1 23:36 tmp/stackprof-GET__users__id___format_-wall-3323-1704119807.dump
+-rw-r--r--  1 sangenya  staff    39K  1  1 23:36 tmp/stackprof-GET__users__id___format_-wall-3323-1704119810.dump
+-rw-r--r--  1 sangenya  staff    51K  1  1 23:36 tmp/stackprof-GET__users__id_edit___format_-wall-3323-1704119809.dump
+-rw-r--r--  1 sangenya  staff    59K  1  1 23:36 tmp/stackprof-GET__users_new___format_-wall-3323-1704119806.dump
+-rw-r--r--  1 sangenya  staff    40K  1  1 23:36 tmp/stackprof-PATCH__users__id___format_-wall-3323-1704119810.dump
+-rw-r--r--  1 sangenya  staff    53K  1  1 23:36 tmp/stackprof-POST__users___format_-wall-3323-1704119807.dump
+```
+
+## Installation
+
+Add this line to your Gemfile:
+
+```ruby
+gem 'stackprof-route_middleware'
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/genya0407/stackprof-route_middleware.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "standard/rake"
+
+task default: %i[spec standard]

data/lib/stackprof/route_middleware/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module StackProf
+  class RouteMiddleware
+    VERSION = "0.1.0"
+  end
+end

data/lib/stackprof/route_middleware.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require "stackprof"
+require_relative "route_middleware/version"
+
+module StackProf
+  class RouteMiddleware
+    def initialize(app, options = {})
+      @app = app
+      @options = options
+
+      self.class.mode = options[:mode] || :cpu
+      self.class.interval = options[:interval] || 1000
+      self.class.raw = options[:raw] || false
+      self.class.enabled = options[:enabled]
+      options[:path] = "tmp/" if options[:path].to_s.empty?
+      self.class.path = options[:path]
+      self.class.metadata = options[:metadata] || {}
+      self.class.route_calculator = options[:route_calculator]
+
+      warn "StackProf::RouteMiddleware does not support save_every option. It regards save_every is 1." if options[:save_every] && options[:save_every] != 1
+      warn "StackProf::RouteMiddleware does not support save_at_exit option." if options[:save_at_exit]
+    end
+
+    def call(env)
+      enabled = self.class.enabled?(env)
+      if enabled
+        StackProf.start(
+          mode: self.class.mode,
+          interval: self.class.interval,
+          raw: self.class.raw,
+          metadata: self.class.metadata
+        )
+      end
+      @app.call(env)
+    ensure
+      if enabled
+        StackProf.stop
+        self.class.save(env)
+      end
+    end
+
+    class << self
+      attr_accessor :enabled, :mode, :interval, :raw, :path, :metadata, :route_calculator
+
+      def enabled?(env)
+        if enabled.respond_to?(:call)
+          enabled.call(env)
+        else
+          enabled
+        end
+      end
+
+      def save(env)
+        results = StackProf.results
+        return unless results
+
+        raise "Expected path to be directory" if path == path.chomp("/")
+
+        route = route_calculator.call(env)
+        return unless route
+
+        filename = "stackprof-#{route.gsub(/\W/, "_")}-#{results[:mode]}-#{Process.pid}-#{Time.now.to_i}.dump"
+
+        FileUtils.mkdir_p(path)
+        File.binwrite(File.join(path, filename), Marshal.dump(results))
+        filename
+      end
+    end
+  end
+end

data/stackprof-route_middleware.gemspec

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative "lib/stackprof/route_middleware/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "stackprof-route_middleware"
+  spec.version = StackProf::RouteMiddleware::VERSION
+  spec.authors = ["Yusuke Sangenya"]
+  spec.email = ["longinus.eva@gmail.com"]
+
+  spec.summary = "Rack middleware to profile each route using StackProf"
+  spec.homepage = "https://github.com/genya0407/stackprof-route_middleware"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/genya0407/stackprof-route_middleware"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "stackprof"
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: stackprof-route_middleware
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yusuke Sangenya
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-01-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: stackprof
+  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:
+email:
+- longinus.eva@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".standard.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/stackprof/route_middleware.rb
+- lib/stackprof/route_middleware/version.rb
+- stackprof-route_middleware.gemspec
+homepage: https://github.com/genya0407/stackprof-route_middleware
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/genya0407/stackprof-route_middleware
+  source_code_uri: https://github.com/genya0407/stackprof-route_middleware
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.3
+signing_key:
+specification_version: 4
+summary: Rack middleware to profile each route using StackProf
+test_files: []