lhs 19.1.0 → 19.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fce80cb737ee0b8d0cedfb8d5ff785baf20e468fcb875dcaab3a241861df1253
-  data.tar.gz: 7bd2a65ea111864756de1b9d74063db7865026f47e702a6ba005fa8dead64c3e
+  metadata.gz: bae8511bbecfd667c0139f103d932be9b15738f17ebef9c01e4205c855ba6aef
+  data.tar.gz: eb47255b3090beb319d4079c0a6dabc601a30b596ed50c5ee51f6d31c2222826
 SHA512:
-  metadata.gz: 80bda8a5f669ea96f3a4922a0a0efb69f456b68431cf844fed26392fbc5b8eb0cbab68cc69972226558c05a138290dd226c6c606342685c56d0f1d417481dcb1
-  data.tar.gz: 66bded778c0ad0ad02e71f6a81daa06ed28c640ff94064496d1dea8129200473ce11e658b9c4bcbf462ec5ea2ec5e3d4c4d11e3228218115888b79c4e20b9d19
+  metadata.gz: 1f46c168d58d08d7c78d7d7ec5db86ac5f0ff07ce4fb212387bce4b64f3774fa143434a31bafeea3cbebb112d673a33609858bdc74c175f9eeb37efdd0d82175
+  data.tar.gz: ad8ced63ed66b4697b0cf1629147bac8ca1bbc6878c8fe2bdac4c26b5e0ed0d6f658479719ebca9c06aa1d71607af352362495b08c4d700c133289e42ab09d93

data/.bundler-version

@@ -0,0 +1 @@
+_1.17.3_

data/README.md

@@ -131,6 +131,7 @@ record.review # "Lunch was great
       * [Request Cycle Cache](#request-cycle-cache)
          * [Change store for LHS' request cycle cache](#change-store-for-lhs-request-cycle-cache)
          * [Disable request cycle cache](#disable-request-cycle-cache)
+      * [Request tracing](#request-tracing)
       * [Testing with LHS](#testing-with-lhs)
          * [Test helper for request cycle cache](#test-helper-for-request-cycle-cache)
          * [Test query chains](#test-query-chains)
@@ -2234,9 +2235,9 @@ The LHS Request Cycle Cache is opt-out, so it's enabled by default and will requ
 By default the LHS Request Cycle Cache will use `ActiveSupport::Cache::MemoryStore` as its cache store. Feel free to configure a cache that is better suited for your needs by:
 
 ```ruby
-# config/initializers/lhc.rb
+# config/initializers/lhs.rb
 
-LHC.configure do |config|
+LHS.configure do |config|
   config.request_cycle_cache = ActiveSupport::Cache::MemoryStore.new
 end
 ```
@@ -2246,12 +2247,64 @@ end
 If you want to disable the LHS Request Cycle Cache, simply disable it within configuration:
 
 ```ruby
-# config/initializers/lhc.rb
+# config/initializers/lhs.rb
 
-LHC.configure do |config|
+LHS.configure do |config|
   config.request_cycle_cache_enabled = false
 end
 ```
+## Request tracing
+
+LHS supports tracing the source (in your application code) of http requests being made with methods like `find find_by find_by! first first! last last!`.
+
+Following links, and using `includes` are not traced (just yet).
+
+In order to enable tracing you need to enable it via LHS configuration:
+
+```ruby
+# config/initializers/lhs.rb
+
+LHS.configure do |config|
+  config.trace = Rails.env.development? || Rails.logger.level == 0 # debug
+end
+```
+
+```ruby
+# app/controllers/application_controller.rb
+
+code = Code.find(code: params[:code])
+```
+```
+Called from onboarding/app/controllers/concerns/access_code_concern.rb:11:in `access_code'
+```
+
+However, following links and includes won't get traced (just yet):
+
+```ruby
+# app/controllers/application_controller.rb
+
+code = Code.includes(:places).find(123)
+```
+
+```
+# Nothing is traced
+{
+  places: [...]
+}
+```
+
+```ruby
+code.places
+```
+```
+{ 
+  token: "XYZABCDEF",
+  places:
+    [
+      { href: "http://storage-stg.preprod-local.ch/v2/places/egZelgYhdlg" }
+    ]
+}
+```
 
 ## Testing with LHS
 

data/cider-ci/bin/bundle

@@ -42,10 +42,10 @@ if [ ! -f  $CACHE_SIGNATURE_FILE ] ; then
     fi
   else
     echo "bundle install"
-    bundle install
+    bundle $BUNDLER install
   fi
   touch $CACHE_SIGNATURE_FILE
 fi
 
 echo "bundle install"
-bundle install
+bundle $BUNDLER install

data/cider-ci/task_components/bundle.yml

@@ -7,6 +7,10 @@ trial_attachments:
     include_match: Gemfile
     content_type: text/plain
 
+environment_variables:
+  BUNDLER:
+    read_and_replace_with: .bundler-version
+
 scripts:
 
   bundle:

data/cider-ci/task_components/rspec.yml

@@ -9,6 +9,8 @@ ports:
 environment_variables:
   RUBY:
     read_and_replace_with: .ruby-version
+  BUNDLER:
+    read_and_replace_with: .bundler-version
 
 scripts:
   rspec:
@@ -17,7 +19,7 @@ scripts:
       set -eux
       mkdir -p tmp/cache
       export PATH=~/.rubies/$RUBY/bin:$PATH
-      if [ ! -z ${ACTIVESUPPORT:-} ]; then BUNDLE_GEMFILE=Gemfile.activesupport$ACTIVESUPPORT bundle exec rspec; else bundle exec rspec; fi
+      if [ ! -z ${ACTIVESUPPORT:-} ]; then BUNDLE_GEMFILE=Gemfile.activesupport$ACTIVESUPPORT bundle $BUNDLER exec rspec; else bundle exec rspec; fi
     
     start_when:
       'bundled':

data/lhs.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |s|
 
   s.add_dependency 'activemodel'
   s.add_dependency 'activesupport', '>= 4.2.11'
-  s.add_dependency 'lhc', '~> 10.1.1'
+  s.add_dependency 'lhc', '~> 10.2'
 
   s.add_development_dependency 'capybara'
   s.add_development_dependency 'json', '>=  1.8.2'

data/lib/lhs/concerns/record/find.rb

@@ -11,6 +11,7 @@ class LHS::Record
       # Find a single uniqe record
       def find(*args)
         args, options = process_args(args)
+        options = trace!(options)
         raise(LHS::Unprocessable.new, 'Cannot find Record without an ID') if args.blank? && !args.is_a?(Array)
         data =
           if args.present? && args.is_a?(Array)

data/lib/lhs/concerns/record/find_by.rb

@@ -10,14 +10,14 @@ class LHS::Record
     module ClassMethods
       # Fetch some record by parameters
       def find_by(params = {}, options = nil)
-        _find_by(params, options)
+        _find_by(params, trace!(options))
       rescue LHC::NotFound
         nil
       end
 
       # Raise if no record was found
       def find_by!(params = {}, options = nil)
-        _find_by(params, options)
+        _find_by(params, trace!(options))
       end
 
       private

data/lib/lhs/concerns/record/first.rb

@@ -9,11 +9,11 @@ class LHS::Record
 
     module ClassMethods
       def first(options = nil)
-        find_by({}, options)
+        find_by({}, trace!(options))
       end
 
       def first!(options = nil)
-        find_by!({}, options)
+        find_by!({}, trace!(options))
       end
     end
   end

data/lib/lhs/concerns/record/last.rb

@@ -9,6 +9,7 @@ class LHS::Record
 
     module ClassMethods
       def last(options = nil)
+        options = trace!(options)
         first_batch = find_by({}, options).parent
         if first_batch.paginated?
           pagination = first_batch._pagination
@@ -19,7 +20,7 @@ class LHS::Record
       end
 
       def last!(options = nil)
-        find_by!({}, options)
+        find_by!({}, trace!(options))
       end
     end
   end

data/lib/lhs/concerns/record/tracing.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'active_support'
+
+class LHS::Record
+
+  module Tracing
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      # Needs to be called directly from the first method (level) within LHS
+      def trace!(options = {})
+        return options unless LHS.config.trace
+
+        (options || {}).tap do |options|
+          source = caller.detect do |source|
+            !source.match?(%r{/lib/lhs})
+          end
+          options[:source] = source
+        end
+      end
+    end
+  end
+end

data/lib/lhs/config.rb

@@ -5,12 +5,20 @@ require 'singleton'
 class LHS::Config
   include Singleton
 
-  attr_accessor :request_cycle_cache_enabled, :request_cycle_cache
+  attr_accessor :request_cycle_cache_enabled, :request_cycle_cache, :trace
 
   def initialize
     self.request_cycle_cache_enabled ||= true
+    self.trace ||= false
     if defined?(ActiveSupport::Cache::MemoryStore)
       self.request_cycle_cache ||= ActiveSupport::Cache::MemoryStore.new
     end
   end
+
+  def reset
+    self.request_cycle_cache_enabled = nil
+    self.trace = nil
+    self.request_cycle_cache = nil
+    initialize
+  end
 end

data/lib/lhs/record.rb

@@ -37,6 +37,8 @@ class LHS::Record
     'lhs/concerns/record/relations'
   autoload :Scope,
     'lhs/concerns/record/scope'
+  autoload :Tracing,
+    'lhs/concerns/record/tracing'
 
   module RequestCycleCache
     autoload :RequestCycleThreadRegistry,
@@ -65,6 +67,7 @@ class LHS::Record
   include Relations
   include RequestCycleCache
   include Scope
+  include Tracing
 
   delegate :_proxy, :_endpoint, :merge_raw!, :select, :becomes, :respond_to?, to: :_data
 

data/lib/lhs/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LHS
-  VERSION = '19.1.0'
+  VERSION = '19.2.0'
 end

data/spec/dummy/config/environments/test.rb

@@ -19,7 +19,7 @@ Rails.application.configure do
   config.action_controller.perform_caching = false
 
   # Raise exceptions instead of rendering exception templates.
-  config.action_dispatch.show_exceptions = false
+  config.action_dispatch.show_exceptions = true
 
   # Disable request forgery protection in test environment.
   config.action_controller.allow_forgery_protection = false
@@ -34,4 +34,7 @@ Rails.application.configure do
 
   # Raises error for missing translations
   # config.action_view.raise_on_missing_translations = true
+
+  # Use the log level higher than debug to make sure LHS tracing is disabled globally. Then enable it in tests as needed
+  config.log_level = :warn
 end

data/spec/rails_helper.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
+ENV["RAILS_ENV"] ||= 'test'
+
 require 'spec_helper'
 require File.expand_path("../dummy/config/environment", __FILE__)
 require 'rspec/rails'
 
-ENV["RAILS_ENV"] ||= 'test'
-
 RSpec.configure do |config|
   config.infer_spec_type_from_file_location!
 end

data/spec/record/endpoint_options_spec.rb

@@ -15,7 +15,14 @@ describe LHS::Record do
     end
 
     it 'uses the options that are configured for an endpoint' do
-      expect(LHC).to receive(:request).with(cache_expires_in: 1.day, retry: 2, cache: true, url: 'backend/v2/feedbacks/1').and_call_original
+      expect(LHC).to receive(:request)
+        .with(
+          cache_expires_in: 1.day,
+          retry: 2,
+          cache: true,
+          url: 'backend/v2/feedbacks/1'
+        ).and_call_original
+
       stub_request(:get, "http://backend/v2/feedbacks/1").to_return(status: 200)
       Record.find(1)
     end

data/spec/record/tracing_spec.rb

@@ -0,0 +1,155 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe LHS::Record do
+
+  context 'tracing' do
+    context 'with tracing enabled' do
+
+      before do
+        allow(LHS.config).to receive(:trace).and_return(true)
+      end
+
+      context 'with non-paginated methods' do
+
+        let(:request) do
+          stub_request(:get, "https://records/3jg781")
+            .to_return(status: 204)
+        end
+
+        before do
+          class Record < LHS::Record
+            endpoint 'https://records'
+          end
+
+          expect(LHC).to receive(:request).with(anything) do |arguments|
+            expect(arguments[:source]).to include(__FILE__)
+            spy(:response)
+          end
+        end
+
+        %w[find find_by find_by! first first! last!].each do |method|
+          context method do
+            it 'forwards tracing options to lhc' do
+              Record.public_send(method, color: :blue)
+            end
+          end
+        end
+      end
+
+      context 'with paginated method last' do
+
+        before do
+          class Place < LHS::Record
+            endpoint 'http://datastore/places'
+          end
+
+          stub_request(:get, "http://datastore/places?limit=1")
+            .to_return(
+              body: {
+                items:  [
+                  { id: 'first-1', company_name: 'Localsearch AG' }
+                ],
+                total:  500,
+                limit:  1,
+                offset: 0
+              }.to_json
+            )
+
+          stub_request(:get, "http://datastore/places?limit=1&offset=499")
+            .to_return(
+              body: {
+                items:  [
+                  { id: 'last-500', company_name: 'Curious GmbH' }
+                ],
+                total:  500,
+                limit:  1,
+                offset: 0
+              }.to_json
+            )
+
+          expect(LHC).to receive(:request).and_call_original
+          expect(LHC).to receive(:request).with(hash_including(params: { offset: 499, limit: 1 })) do |arguments|
+            expect(arguments[:source]).to include(__FILE__)
+            spy(:response)
+          end
+        end
+
+        it 'forwards tracing options to lhc' do
+          # binding.pry
+          Place.last
+        end
+      end
+    end
+
+    context 'tracing disabled (default)' do
+      context 'non-paginated methods' do
+
+        before do
+          class Record < LHS::Record
+            endpoint 'https://records'
+          end
+
+          expect(LHC).to receive(:request).with(anything) do |arguments|
+            expect(arguments).not_to include(:source)
+            spy(:response)
+          end
+        end
+
+        %w[find find_by find_by! first first! last!].each do |method|
+          context method do
+            it 'does not forward tracing options to lhc' do
+              Record.public_send(method, color: :blue)
+            end
+          end
+        end
+      end
+
+      context 'with paginated method last' do
+        before do
+          class Place < LHS::Record
+            endpoint 'http://datastore/places'
+          end
+
+          stub_request(:get, "http://datastore/places?limit=1")
+            .to_return(
+              body: {
+                items:  [
+                  { id: 'first-1', company_name: 'Localsearch AG' }
+                ],
+                total:  500,
+                limit:  1,
+                offset: 0
+              }.to_json
+            )
+
+          stub_request(:get, "http://datastore/places?limit=1&offset=499")
+            .to_return(
+              body: {
+                items:  [
+                  { id: 'last-500', company_name: 'Curious GmbH' }
+                ],
+                total:  500,
+                limit:  1,
+                offset: 0
+              }.to_json
+            )
+        end
+
+        it 'does not forward tracing options to lhc' do
+          # for first pagination requets (first-1)
+          expect(LHC).to receive(:request).and_call_original
+
+          # for second reques (last-500)
+          expect(LHC).to receive(:request).with(hash_including(params: { offset: 499, limit: 1 })) do |arguments|
+            expect(arguments).not_to include(:source)
+            spy(:response)
+          end
+
+          Place.last
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lhs
 version: !ruby/object:Gem::Version
-  version: 19.1.0
+  version: 19.2.0
 platform: ruby
 authors:
 - https://github.com/local-ch/lhs/graphs/contributors
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 10.1.1
+        version: '10.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 10.1.1
+        version: '10.2'
 - !ruby/object:Gem::Dependency
   name: capybara
   requirement: !ruby/object:Gem::Requirement
@@ -192,6 +192,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".bundler-version"
 - ".gitignore"
 - ".rubocop.localch.yml"
 - ".rubocop.yml"
@@ -256,6 +257,7 @@ files:
 - lib/lhs/concerns/record/request_cycle_cache/interceptor.rb
 - lib/lhs/concerns/record/request_cycle_cache/request_cycle_thread_registry.rb
 - lib/lhs/concerns/record/scope.rb
+- lib/lhs/concerns/record/tracing.rb
 - lib/lhs/config.rb
 - lib/lhs/data.rb
 - lib/lhs/endpoint.rb
@@ -439,6 +441,7 @@ files:
 - spec/record/to_ary_spec.rb
 - spec/record/to_hash_spec.rb
 - spec/record/to_json_spec.rb
+- spec/record/tracing_spec.rb
 - spec/record/where_chains_spec.rb
 - spec/record/where_spec.rb
 - spec/record/where_values_hash_spec.rb
@@ -640,6 +643,7 @@ test_files:
 - spec/record/to_ary_spec.rb
 - spec/record/to_hash_spec.rb
 - spec/record/to_json_spec.rb
+- spec/record/tracing_spec.rb
 - spec/record/where_chains_spec.rb
 - spec/record/where_spec.rb
 - spec/record/where_values_hash_spec.rb