image_vise 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 15bac8714b52ca8cc0a2b57037ffb1db1ac85216
-  data.tar.gz: 1ff26e91dcea4e222f98caf695d92096822c2df1
+SHA256:
+  metadata.gz: b65aacfbdbada4bb3d52c9883955ff2204ee84aa66bc82d05fc81320259ac900
+  data.tar.gz: d8576cfba12f8793a75dc36f8a5c2c206f7650f402d048432f763de82ddeb0b0
 SHA512:
-  metadata.gz: 262b64839c5aceb9230ef958629535248a60a4f62ca4ef8cc7d923419ebdaec7491fb5b8978795212b81d8231d9d0ea3575972fe72a4eaf7ebd7b866b506387f
-  data.tar.gz: 7ef5cf55c0893907abb72cede01ddfc6a0cc824d5ebf0c0112df2789c1a0453ee03182311766372e10dd5db9d69885c89c6b30c28798b067802873c859b6e0f8
+  metadata.gz: 767f28b82f290cfefdf023f83a6794901744d585eff9f0f2af92a6c408718b4663162156270d51f0ea7def4de2e14339a0bc0183b80ba62d4d16f11b69359e11
+  data.tar.gz: bb8534e292d19e51015b24586d0db5c472da2b02c3463180c35f42d8cff1d2d39aca875d5446255ea5b67b1bf59f849dda08065792438324a6ed3c9a753d9549

data/.travis.yml

@@ -1,12 +1,13 @@
 rvm:
-- 2.2
-- 2.3.0
-- 2.4.1
+- 2.2.10
+- 2.3.7
+- 2.4.4
+- 2.5.1
 sudo: false
 cache: bundler
 
 env:
   global:
     - SKIP_INTERACTIVE=yes
-
+before_install: gem install bundler
 script: bundle exec rspec

data/examples/{error_handline_appsignal.rb → error_handling_appsignal.rb}

@@ -1,7 +1,7 @@
 # Anywhere in your app code
 module ImageViseAppsignal
   ImageVise::RenderEngine.prepend self
-
+  ImageVise::Measurometer.drivers << Appsignal # to obtain ImageVise instrumentation
   def setup_error_handling(rack_env)
     txn = Appsignal::Transaction.current
     txn.set_action('%s#%s' % [self.class, 'call'])

data/image_vise.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
   else
     raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
   end
-
+  
   spec.files         = `git ls-files -z`.split("\x0")
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }

data/lib/image_vise/image_request.rb

@@ -14,9 +14,12 @@ class ImageVise::ImageRequest < Ks.strict(:src_url, :pipeline)
 
     # Check the signature before decoding JSON (since we will be creating symbols)
     unless valid_signature?(base64_encoded_params, given_signature, secrets)
+      ImageVise::Measurometer.increment_counter('image_vise.params.invalid_signatures', 1)
       raise SignatureError, "Invalid or missing signature"
     end
 
+    ImageVise::Measurometer.increment_counter('image_vise.params.valid_signatures', 1)
+
     # Decode the JSON - only AFTER the signature has been validated,
     # so we can use symbol keys
     decoded_json = Base64.decode64(base64_encoded_params)

data/lib/image_vise/pipeline.rb

@@ -46,7 +46,10 @@ class ImageVise::Pipeline
 
   def apply!(magick_image, image_metadata)
     @ops.each do |operator|
-      apply_operator_passing_metadata(magick_image, operator, image_metadata)
+      operator_short_classname = operator.class.to_s.split('::').pop
+      ImageVise::Measurometer.instrument('image_vise.op.%s' % operator_short_classname) do
+        apply_operator_passing_metadata(magick_image, operator, image_metadata)
+      end
     end
   end
 

data/lib/image_vise/render_engine.rb

@@ -283,7 +283,10 @@
     render_file_type = source_file_type
 
     # Load the first frame of the animated GIF _or_ the blended compatibility layer from Photoshop
-    image_list = Magick::Image.read(source_file_path)
+    image_list = ImageVise::Measurometer.instrument('image_vise.load_pixbuf') do
+      Magick::Image.read(source_file_path)
+    end
+      
     magick_image = image_list.first # Picks up the "precomp" PSD layer in compatibility mode, or the first frame of a GIF
 
     # If any operators want to stash some data for downstream use we use this Hash
@@ -297,7 +300,9 @@
     # it so that we get a KeyError if some operator has deleted it without providing a replacement.
     # If no operators touched the writer we are going to use the automatic format selection
     writer = metadata.fetch(:writer, ImageVise::AutoWriter.new)
-    writer.write_image!(magick_image, metadata, render_to_path)
+    ImageVise::Measurometer.instrument('image_vise.write_image') do
+      writer.write_image!(magick_image, metadata, render_to_path)
+    end
 
     # Another metadata element is the expire_after, which we default to an app-wide setting
     metadata.fetch(:expire_after_seconds, ImageVise.cache_lifetime_seconds)

data/lib/image_vise/version.rb

@@ -1,3 +1,3 @@
 class ImageVise
-  VERSION = '0.4.0'
+  VERSION = '0.5.0'
 end

data/lib/image_vise.rb

@@ -9,8 +9,10 @@ require 'rack'
 
 class ImageVise
   require_relative 'image_vise/version'
+
   S_MUTEX = Mutex.new
   private_constant :S_MUTEX
+
   # The default cache liftime is 30 days, and will be used if no custom lifetime is set.
   DEFAULT_CACHE_LIFETIME = 2_592_000
 
@@ -158,7 +160,9 @@ class ImageVise
     return unless maybe_image
     return unless maybe_image.respond_to?(:destroy!)
     return if maybe_image.destroyed?
-    maybe_image.destroy!
+    ImageVise::Measurometer.instrument('image_vise.image_destroy_dealloc') do
+      maybe_image.destroy!
+    end
   end
 
   # Used as a shorthand to force-dealloc Tempfiles in an ensure() blocks. Since
@@ -166,8 +170,10 @@ class ImageVise
   # in scope but not yet set to an image) we take the possibility of nils into account.
   def self.close_and_unlink(maybe_tempfile)
     return unless maybe_tempfile
-    maybe_tempfile.close unless maybe_tempfile.closed?
-    maybe_tempfile.unlink
+    ImageVise::Measurometer.instrument('image_vise.tempfile_unlink') do
+      maybe_tempfile.close unless maybe_tempfile.closed?
+      maybe_tempfile.unlink
+    end
   end
 end
 

data/lib/measurometer.rb

@@ -0,0 +1,92 @@
+# Measurometer is 1-1 API compatible with Appsignal,
+# which we use a lot
+class ImageVise::Measurometer
+  class << self
+    # Permits adding instrumentation drivers. To magically
+    # obtain all Appsignal instrumentation, add the Appsignal module
+    # as a driver.
+    #
+    #   Measurometer.drivers << Appsignal
+    #
+    # A driver must be reentrant and thread-safe - it should be possible
+    # to have multiple `instrument` calls open from different threads at the
+    # same time.
+    #
+    # The driver must support the same interface as the Measurometer class
+    # itself, minus the `drivers` and `instrument_instance_method` methods.
+    #
+    # @return Array
+    def drivers
+      @drivers ||= []
+      @drivers
+    end
+
+    # Runs a given block within a cascade of `instrument` blocks of all the
+    # added drivers.
+    #
+    #   Measurometer.instrument('do_foo') { compute! }
+    #
+    # unfolds to
+    #
+    #   Appsignal.instrument('do_foo') do
+    #     Statsd.timing('do_foo') do
+    #       compute!
+    #     end
+    #   end
+    #
+    # Note that it is _imperative_ that the block return value is preserved
+    # by the drivers and passed as the result of the block.
+    #
+    # @param block_name[String] under which path to push the metric
+    # @param blk[#call] the block to instrument
+    # @return [Object] the return value of &blk
+    def instrument(block_name, &blk)
+      return yield unless @drivers && @drivers.any? # The block wrapping business is not free
+      @drivers.inject(blk) { |outer_block, driver|
+        -> {
+          driver.instrument(block_name, &outer_block)
+        }
+      }.call
+    end
+
+    # Adds a distribution value (sample) under a given path
+    #
+    # @param value_path[String] under which path to push the metric
+    # @param value[Numeric] distribution value
+    # @return nil
+    def add_distribution_value(value_path, value)
+      (@drivers || []).each { |d| d.add_distribution_value(value_path, value) }
+      nil
+    end
+
+    # Increment a named counter under a given path
+    #
+    # @param counter_path[String] under which path to push the metric
+    # @param by[Integer] the counter increment to apply
+    # @return nil
+    def increment_counter(counter_path, by)
+      (@drivers || []).each { |d| d.increment_counter(counter_path, by) }
+      nil
+    end
+
+    # Wrap an anonymous module around an instance method in the given class to have
+    # it instrumented automatically. The name of the measurement will be interpolated as:
+    #
+    #   "#{prefix}.#{rightmost_class_constant_name}.#{instance_method_name}"
+    #
+    # @param target_class[Class] the class to instrument
+    # @param instance_method_name_to_instrument[Symbol] the method name to instrument
+    # @param path_prefix[String] under which path to push the instrumented metric
+    # @return void
+    def instrument_instance_method(target_class, instance_method_name_to_instrument, path_prefix)
+      short_class_name = target_class.to_s.split('::').last
+      instrumentation_name = [path_prefix, short_class_name, instance_method_name_to_instrument].join('.')
+      instrumenter_module = Module.new do
+        define_method(instance_method_name_to_instrument) do |*any|
+          ::ImageVise::Measurometer.instrument(instrumentation_name) { super(*any) }
+        end
+      end
+      target_class.prepend(instrumenter_module)
+    end
+  end
+end

data/spec/measurometer_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+
+describe ImageVise::Measurometer do
+  RSpec::Matchers.define :include_counter_or_measurement_named do |named|
+    match do |actual|
+      actual.any? do |e|
+        e[0] == named && e[1] > 0
+      end
+    end
+  end
+
+  it 'instruments a full cycle FormatParser.parse' do
+    driver_class = Class.new do
+      attr_accessor :timings, :counters, :distributions
+      def initialize
+        @timings = []
+        @distributions = []
+        @counters = []
+      end
+
+      def instrument(block_name)
+        s = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+        yield.tap do
+          delta = Process.clock_gettime(Process::CLOCK_MONOTONIC) - s
+          @timings << [block_name, delta * 1000]
+        end
+      end
+
+      def add_distribution_value(value_path, value)
+        @distributions << [value_path, value]
+      end
+
+      def increment_counter(value_path, value)
+        @counters << [value_path, value]
+      end
+    end
+
+    instrumenter = driver_class.new
+    described_class.drivers << instrumenter
+
+    builder = ImageVise::Pipeline.new
+    pipeline = builder.
+      auto_orient.
+      fit_crop(width: 48, height: 48, gravity: 'c').
+      sharpen(radius: 2, sigma: 0.5).
+      ellipse_stencil.
+      strip_metadata
+
+    image = Magick::Image.read(test_image_path)[0]
+    pipeline.apply! image, {}
+
+    described_class.drivers.delete(instrumenter)
+    expect(described_class.drivers).not_to include(instrumenter)
+
+    expect(instrumenter.timings).to include_counter_or_measurement_named('image_vise.op.AutoOrient')
+    expect(instrumenter.timings).to include_counter_or_measurement_named('image_vise.op.StripMetadata')
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: image_vise
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Julik Tarkhanov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-27 00:00:00.000000000 Z
+date: 2018-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: patron
@@ -215,7 +215,7 @@ files:
 - SECURITY.md
 - examples/config.ru
 - examples/custom_image_operator.rb
-- examples/error_handline_appsignal.rb
+- examples/error_handling_appsignal.rb
 - examples/error_handling_sentry.rb
 - image_vise.gemspec
 - lib/image_vise.rb
@@ -240,6 +240,7 @@ files:
 - lib/image_vise/version.rb
 - lib/image_vise/writers/auto_writer.rb
 - lib/image_vise/writers/jpeg_writer.rb
+- lib/measurometer.rb
 - spec/image_vise/auto_orient_spec.rb
 - spec/image_vise/background_fill_spec.rb
 - spec/image_vise/crop_spec.rb
@@ -261,6 +262,7 @@ files:
 - spec/image_vise/writers/jpeg_writer_spec.rb
 - spec/image_vise_spec.rb
 - spec/layers-with-blending.psd
+- spec/measurometer_spec.rb
 - spec/spec_helper.rb
 - spec/test_server.rb
 - spec/waterside_magic_hour.jpg
@@ -290,7 +292,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Runtime thumbnailing proxy