type_fusion 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce0738a57fd5c0b08679b9ea5fd5fe16ddd786326a8269aa09905acb9b7bb7ac
-  data.tar.gz: c55387825018723f436f302d8ec6f842a9e9a635ca0c779a9a498d32a906ed91
+  metadata.gz: 7eaa132f18093b5b57b9db4e49130adb2f9ff41ae03559848e1334ee4f863bfe
+  data.tar.gz: 4bc9dcc31808f3f39707516436f28a3e73de19054f80c2d143da66dc365ae106
 SHA512:
-  metadata.gz: 9ba2541d870cd306acf5a5c8a06367117aff283a28502940424d2931641f9405c85a053684ff73e74a163cce14d15409706f00cf69de7d0c22f8caaf30586cd4
-  data.tar.gz: 4b929bacae1bc294fbdde9df386aa4833329252f46a438c8daae53049fb9687fca7296fa0ca3f4e4db9b576bc00241d249c62cf5b500e04561a9dc1ebb50590e
+  metadata.gz: '086356eb24932d3fbce347967869de8ba31672ebde52eaed096a640713ca8cb69e151ebe2a6dd71ebdb596a07cd6ea971bcf7f0147887059a344901d08e2be90'
+  data.tar.gz: 35dbb641e2ffc414aa0c42af6f2a61538f3a24f37e5bd35daf623bc7824b853fe8963711c10fd741e2e6155be6b73cf26fd7718f530b36e238c912f2ce372f7b

data/CHANGELOG.md

@@ -1,5 +1,24 @@
 ## [Unreleased]
 
+## [0.0.4] - 2023-08-16
+
+- Implement sample collection by sending samples to gem.sh endpoint
+- Introduce Litejob to enqueue samples to be collected async
+- Updates to `SampleCall`
+  - Split up `gem_and_version` to `gem` and `version` in `SampleCall`
+  - Also collect `application_name` and `type_fusion_version` with `SampleCall`
+  - Change `Tracepoint` API from `:call` to `:return` to also collect `return_value` in `SampleCall`
+- Introduce `endpoint` and `application_name` configs
+
+## [0.0.3] - 2023-08-13
+
+- Introduce `TypeFusion::Middleware` to allow type-sampling in Rack-powered apps
+- Introduce `TypeFusion::Railtie` to automatically setup type-sampling in Rails apps
+- Introduce `TypeFusion::Config` to control sampling
+  - Add `config.type_sample_call_rate` config
+  - Add `config.type_sample_request` config
+  - Add `config.type_sample_tracepoint_path` config
+
 ## [0.0.2] - 2023-08-12
 
 - Initial Proof-of-Concept release

data/Gemfile

@@ -6,4 +6,4 @@ gemspec
 
 gem "minitest", "~> 5.0"
 gem "rake", "~> 13.0"
-gem "rubocop", "~> 1.21"
+gem "rubocop", "~> 1.56"

data/Gemfile.lock

@@ -1,36 +1,80 @@
 PATH
   remote: .
   specs:
-    type_fusion (0.0.1)
+    type_fusion (0.0.4)
+      lhc (~> 15.2)
+      litejob (~> 0.2.3)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (7.0.7)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    addressable (2.8.5)
+      public_suffix (>= 2.0.2, < 6.0)
     ast (2.4.2)
+    base64 (0.1.1)
+    concurrent-ruby (1.2.2)
+    ethon (0.16.0)
+      ffi (>= 1.15.0)
+    ffi (1.15.5)
+    i18n (1.14.1)
+      concurrent-ruby (~> 1.0)
     json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    lhc (15.2.1)
+      activesupport (>= 5.2)
+      addressable
+      local_uri
+      typhoeus (>= 0.11)
+    litedb (0.2.1)
+      litescheduler (>= 0.2.0)
+      sqlite3 (>= 1.5.0)
+    litejob (0.2.3)
+      litequeue (>= 0.2.1)
+      litescheduler (>= 0.2.1)
+    litequeue (0.2.1)
+      litedb (>= 0.2.1)
+    litescheduler (0.2.1)
+    local_uri (1.2.0)
+      activesupport
+      rack
     minitest (5.19.0)
     parallel (1.23.0)
     parser (3.2.2.3)
       ast (~> 2.4.1)
       racc
+    public_suffix (5.0.3)
     racc (1.7.1)
+    rack (3.0.8)
     rainbow (3.1.1)
     rake (13.0.6)
     regexp_parser (2.8.1)
     rexml (3.2.6)
-    rubocop (1.48.1)
+    rubocop (1.56.0)
+      base64 (~> 0.1.1)
       json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.2.0.0)
+      parser (>= 3.2.2.3)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.26.0, < 2.0)
+      rubocop-ast (>= 1.28.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
     rubocop-ast (1.29.0)
       parser (>= 3.2.1.0)
     ruby-progressbar (1.13.0)
+    sqlite3 (1.6.3-x86_64-darwin)
+    sqlite3 (1.6.3-x86_64-linux)
+    typhoeus (1.4.0)
+      ethon (>= 0.9.0)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
     unicode-display_width (2.4.2)
 
 PLATFORMS
@@ -40,7 +84,7 @@ PLATFORMS
 DEPENDENCIES
   minitest (~> 5.0)
   rake (~> 13.0)
-  rubocop (~> 1.21)
+  rubocop (~> 1.56)
   type_fusion!
 
 BUNDLED WITH

data/README.md

@@ -14,16 +14,101 @@ If bundler is not being used to manage dependencies, install the gem by executin
 gem install type_fusion
 ```
 
-## Usage
+#### Rack
 
 ```ruby
+require "type_fusion/rack/middleware"
+
+use TypeFusion::Middleware
+```
+
+#### Rails
+
+Adding the gem to your applications Gemfile will automatically setup `type_fusion`.
+
+
+## Configuration
+
+Setup `TypeFusion` in an initializer
+
+```ruby
+# config/initializers/type_fusion.rb
+
 require "type_fusion"
+
+TypeFusion.config do |config|
+
+  # === application_name
+  #
+  # Set application_name to a string which is used to know where the samples
+  # came from. Set application_name to an empty string if you wish to not
+  # send the application name alongside the samples.
+  #
+  # Default: "TypeFusion"
+  # Default when using Rails: Rails.application.class.module_parent_name
+  #
+  # config.application_name = "YourApplication"
+
+
+  # === endpoint
+  #
+  # Set endpoint to an URL where TypeFusion should send the samples to.
+  #
+  # Default: "https://gem.sh/api/v1/types/samples"
+  #
+  # config.endpoint = "https://your-domain.com/api/v1/types/samples"
+
+
+  # === type_sample_request
+  #
+  # Set type_sample_request to a lambda which resolves to true/false
+  # to set if type sampling should be enabled for the whole rack request.
+  #
+  # Default: ->(rack_env) { [true, false, false, false].sample }
+  #
+  # config.type_sample_request = ->(rack_env) { [true, false, false, false].sample }
+
+
+  # === type_sample_tracepoint_path
+  #
+  # Set type_sample_tracepoint_path to a lambda which resolves
+  # to true/false to check if a tracepoint_path should be sampled
+  # or not.
+  #
+  # This can be useful when you want to only sample method calls for
+  # certain gems or want to exclude a gem from being sampled.
+  #
+  # Example:
+  # config.type_sample_tracepoint_path = ->(tracepoint_path) {
+  #   return false if tracepoint_path.include?("activerecord")
+  #   return false if tracepoint_path.include?("sprockets")
+  #   return false if tracepoint_path.include?("some-private-gem")
+  #
+  #   true
+  # }
+  #
+  # Default: ->(tracepoint_path) { true }
+  #
+  # config.type_sample_tracepoint_path = ->(tracepoint_path) { true }
+
+
+  # === type_sample_call_rate
+  #
+  # Set type_sample_call_rate to 1.0 to capture 100% of method calls
+  # within a rack request.
+  #
+  # Default: 0.001
+  #
+  # config.type_sample_call_rate = 0.001
+end
 ```
 
+## Usage
+
 #### Type sample inside a block
 
 ```ruby
-TypeFusion::Sampler.instance.with_sampling do
+TypeFusion.with_sampling do
   # run code you want to type sample here
 end
 ```
@@ -31,22 +116,22 @@ end
 #### Type sample globally
 
 ```ruby
-TypeFusion::Sampler.instance.trace.enable
+TypeFusion.start
 
 # run code you want to type sample here
 
-TypeFusion::Sampler.instance.trace.disable
+TypeFusion.stop
 ```
 
 #### Retrieve the samples
 
 ```ruby
-TypeFusion::Sampler.instance.trace.samples
+TypeFusion::Sampler.instance.samples
 # => [...]
 ```
 
 ```ruby
-TypeFusion::Sampler.instance.trace.samples.first
+TypeFusion::Sampler.instance.samples.first
 
 # => #<struct TypeFusion::SampleCall
 #      gem_and_version="nokogiri-1.15.4-x86_64-darwin",

data/lib/type_fusion/config.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require "singleton"
+
+module TypeFusion
+  class << self
+    def config
+      @config ||= Config.instance
+
+      yield @config if block_given?
+
+      @config
+    end
+    alias configure config
+  end
+
+  class Config
+    include Singleton
+
+    attr_accessor :type_sample_call_rate, :type_sample_request, :type_sample_tracepoint_path, :endpoint, :application_name
+
+    def initialize
+      @type_sample_call_rate = 0.001
+      @type_sample_request = ->(_env) { [true, false, false, false].sample }
+      @type_sample_tracepoint_path = ->(_tracepoint_path) { true }
+      @endpoint = "http://localhost:3000/api/v1/types/samples"
+      @application_name = "TypeFusion"
+    end
+
+    def type_sample_request?(env)
+      type_sample_request&.call(env)
+    end
+
+    def type_sample_tracepoint_path?(env)
+      type_sample_tracepoint_path&.call(env)
+    end
+
+    def type_sample_call?
+      type_sample_call_rate > rand
+    end
+  end
+end

data/lib/type_fusion/litejob.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require "litejob"
+
+# Litequeue.configure do |config|
+#   config.path = "db/type_fusion/queue.sqlite3"
+# end

data/lib/type_fusion/rack/middleware.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "type_fusion/sampler"
+
+module TypeFusion
+  class Middleware
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      if TypeFusion.config.type_sample_request?(env)
+        puts "[TypeFusion] Type-sampling this request"
+        TypeFusion.start
+      end
+
+      @app.call(env)
+    ensure
+      TypeFusion.stop
+    end
+  end
+end

data/lib/type_fusion/rails/railtie.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module TypeFusion
+  class Railtie < ::Rails::Railtie
+    initializer "type_fusion.middleware" do |app|
+      require "type_fusion/rack/middleware"
+
+      TypeFusion.config.application_name = app.class.module_parent_name
+
+      app.config.middleware.use TypeFusion::Middleware
+    end
+  end
+end

data/lib/type_fusion/sample_call.rb

@@ -1,9 +1,15 @@
 # frozen_string_literal: true
 
+require "json"
+
 module TypeFusion
-  SampleCall = Struct.new(:gem_and_version, :receiver, :method_name, :location, :parameters) do
+  SampleCall = Struct.new(:gem_name, :gem_version, :receiver, :method_name, :application_name, :location, :type_fusion_version, :parameters, :return_value) do
     def to_s
       JSON.pretty_generate(to_h)
     end
+
+    def inspect
+      "#<TypeFusion::SampleCall receiver=#{receiver.inspect} method_name=#{method_name.inspect} gem_name=#{gem_name.inspect}>"
+    end
   end
 end

data/lib/type_fusion/sample_job.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "lhc"
+
+module TypeFusion
+  class SampleJob
+    include Litejob
+
+    queue_as :default
+
+    def perform(sample)
+      LHC.json.post(TypeFusion.config.endpoint, body: { sample: JSON.parse(sample) })
+    rescue StandardError => e
+      puts e.inspect
+    end
+  end
+end

data/lib/type_fusion/sampler.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require "singleton"
-require "json"
 
 module TypeFusion
   class Sampler
@@ -11,6 +10,7 @@ module TypeFusion
 
     def initialize
       @samples = []
+      @litejob_server ||= Litejob::Server.new([["default", 1]])
     end
 
     def with_sampling
@@ -22,8 +22,8 @@ module TypeFusion
     end
 
     def trace
-      @trace ||= TracePoint.trace(:call) do |tracepoint|
-        if tracepoint.path.start_with?(gem_path)
+      @trace ||= TracePoint.trace(:return) do |tracepoint|
+        if sample?(tracepoint.path)
           receiver = begin
             tracepoint.binding.receiver.name
           rescue StandardError
@@ -31,18 +31,27 @@ module TypeFusion
           end
 
           method_name = tracepoint.method_id
-          location = tracepoint.binding.source_location
-          gem_and_version = location.first.gsub(gem_path, "").split("/").first
-          args = tracepoint.parameters.map(&:reverse).to_h
+          location = tracepoint.binding.source_location.join(":")
+          gem_and_version = location.gsub(gem_path, "").split("/").first
+          gem, version = gem_and_version_from(gem_and_version)
+          args = tracepoint.parameters.to_h(&:reverse)
           parameters = extract_parameters(args, tracepoint.binding)
+          return_value = type_for_object(tracepoint.return_value)
 
-          samples << SampleCall.new(
-            gem_and_version: gem_and_version,
+          sample = SampleCall.new(
+            gem_name: gem,
+            gem_version: version,
             receiver: receiver,
             method_name: method_name,
             location: location,
+            type_fusion_version: VERSION,
             parameters: parameters,
+            application_name: TypeFusion.config.application_name,
+            return_value: return_value,
           )
+
+          samples << sample
+          SampleJob.perform_async(sample)
         end
       end.tap(&:disable)
     end
@@ -62,6 +71,12 @@ module TypeFusion
 
     private
 
+    def sample?(tracepoint_path)
+      TypeFusion.config.type_sample_call? &&
+        TypeFusion.config.type_sample_tracepoint_path?(tracepoint_path) &&
+        tracepoint_path.start_with?(gem_path)
+    end
+
     def type_for_object(object)
       case object
       when Hash
@@ -73,6 +88,31 @@ module TypeFusion
       end
     end
 
+    def gem_and_version_from(gem_and_version)
+      return [] if gem_and_version.nil?
+
+      splits = gem_and_version.split("-")
+
+      if splits.length == 1
+        [splits.first, nil]
+      elsif splits.length == 2
+        splits
+      else
+        *name, version = splits
+
+        # TODO: there must be a better way to do this
+        if ["darwin", "java", "linux", "ucrt", "mingw32"].include?(version)
+          amount = (version == "ucrt") ? 3 : 2
+
+          version = [*name.pop(amount), version].join("-")
+        end
+
+        gem = name.join("-")
+
+        [gem, version]
+      end
+    end
+
     def extract_parameters(args, binding)
       args.map do |name, kind|
         variable = name.to_s.gsub("*", "").gsub("&", "").to_sym

data/lib/type_fusion/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TypeFusion
-  VERSION = "0.0.2"
+  VERSION = "0.0.4"
 end

data/lib/type_fusion.rb

@@ -1,8 +1,36 @@
 # frozen_string_literal: true
 
 require_relative "type_fusion/version"
+require_relative "type_fusion/config"
+require_relative "type_fusion/litejob"
 require_relative "type_fusion/sample_call"
+require_relative "type_fusion/sample_job"
 require_relative "type_fusion/sampler"
 
 module TypeFusion
+  class << self
+    def start
+      return if Sampler.instance.trace.enabled?
+
+      puts "[TypeFusion] Starting Sampler..."
+      Sampler.instance.trace.enable
+    end
+
+    def stop
+      return unless Sampler.instance.trace.enabled?
+
+      puts "[TypeFusion] Stopping Sampler..."
+      Sampler.instance.trace.disable
+    end
+
+    def with_sampling
+      start
+
+      yield if block_given?
+
+      stop
+    end
+  end
 end
+
+require_relative "type_fusion/rails/railtie" if defined?(Rails::Railtie)

data/test.rb

@@ -3,9 +3,17 @@
 require "nokogiri"
 require_relative "lib/type_fusion"
 
-TypeFusion::Sampler.instance.with_sampling do
+TypeFusion.config do |config|
+  config.type_sample_call_rate = 1.0
+
+  config.type_sample_tracepoint_path = lambda do |tracepoint_path|
+    tracepoint_path.include?("nokogiri")
+  end
+end
+
+TypeFusion.with_sampling do
   Nokogiri.parse("<h1></h1>")
 end
 
 puts TypeFusion::Sampler.instance.samples
-puts TypeFusion::Sampler.instance.to_s
+puts TypeFusion::Sampler.instance

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: type_fusion
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
 platform: ruby
 authors:
 - Marco Roth
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-08-12 00:00:00.000000000 Z
-dependencies: []
+date: 2023-08-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lhc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '15.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '15.2'
+- !ruby/object:Gem::Dependency
+  name: litejob
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.3
 description: Community-contributed sample data for Ruby types
 email:
 - marco.roth@intergga.ch
@@ -26,7 +54,12 @@ files:
 - README.md
 - Rakefile
 - lib/type_fusion.rb
+- lib/type_fusion/config.rb
+- lib/type_fusion/litejob.rb
+- lib/type_fusion/rack/middleware.rb
+- lib/type_fusion/rails/railtie.rb
 - lib/type_fusion/sample_call.rb
+- lib/type_fusion/sample_job.rb
 - lib/type_fusion/sampler.rb
 - lib/type_fusion/version.rb
 - sig/type_fusion.rbs