forest_liana 9.22.9 → 9.22.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1427f49be68c4df6bbcd4fd859c13544c59d6c8c24b810cacfe2ebfcf34b20a0
-  data.tar.gz: 4987bbf28820237edab483d04752e068fe35e1a547b95784aa19cf2e70db17f4
+  metadata.gz: 23a1adeed07bf166b64953093122fc2e9c8c442d1ab52aec8227bec80f83f17d
+  data.tar.gz: 3cbea9923bf9350fbd8ad11c0a11479504c3a7b876b1c96e2c79a0cf602c88a2
 SHA512:
-  metadata.gz: b0c64c511777459d427d6e33e75698004f96436894c668ffaf2333b63e3c8d539b354155708dd15c88ce1d1b8b6c856082df12bfa555455f14d43f2689c9223f
-  data.tar.gz: bf3bf6469ac14740c7b1eeddd6e05a404ffc7805248ee6bd4974f614c2c7e6b2e7be172743c3b55fa6bcad8bbf4da474ee5ed4306103e3ce4232e2b84d5edd92
+  metadata.gz: d41d2034547eb686df156ac01a72cd9e85f3aa10fcaf272831013dcf0827f7bd1b216b35828b22cc699d88e6ed1541ddaae5769b76e16cf6caf6aace4a49edef
+  data.tar.gz: f26b8e3fb84c18d3ee198b0f474e2bf189254b0c47a32365ee775ffcb1652baee2c6eea641e22cdb753d3f552ef5cc360db7b6c76a3df3f5eef8357adec0ede0

data/app/services/forest_liana/schema_utils.rb

@@ -31,6 +31,18 @@ module ForestLiana
     end
 
     def self.find_model_from_collection_name(collection_name, logs = false)
+      model_found = LookupCache.fetch(:model_from_collection_name, collection_name) do
+        scan_models_for_collection_name(collection_name)
+      end
+
+      if logs && model_found.nil?
+        FOREST_LOGGER.warn "No model found for collection #{collection_name}"
+      end
+
+      model_found
+    end
+
+    def self.scan_models_for_collection_name(collection_name)
       model_found = nil
       ForestLiana.models.each do |model|
         if model.abstract_class?
@@ -42,10 +54,6 @@ module ForestLiana
         break if model_found
       end
 
-      if logs && model_found.nil?
-        FOREST_LOGGER.warn "No model found for collection #{collection_name}"
-      end
-
       model_found
     end
 

data/lib/forest_liana/lookup_cache.rb

@@ -0,0 +1,37 @@
+module ForestLiana
+  # Remembers lookups by name over ForestLiana.models, .apimap and .names_overriden: on a large
+  # schema each one is a linear scan, schema_for_resource a scan of scans, and every request runs
+  # several. Any of the three being replaced or growing (the bootstrapper, a Forest collection
+  # file, a code reload) drops everything remembered, so an answer never outlives what it read.
+  module LookupCache
+    # A miss is not remembered: the router resolves a request's collection before authenticating
+    # it, so caching unknown names would let any caller grow this cache without bound.
+    def self.fetch(namespace, key)
+      reset_if_stale
+      store = (@stores[namespace] ||= {})
+      return store[key] if store.key?(key)
+
+      value = yield
+      store[key] = value unless value.nil?
+      value
+    end
+
+    def self.reset!
+      @stores = nil
+    end
+
+    def self.reset_if_stale
+      models = ForestLiana.models
+      apimap = ForestLiana.apimap
+      names = ForestLiana.names_overriden
+      return if @stores && models.equal?(@models) && models.size == @models_size &&
+                apimap.equal?(@apimap) && apimap.size == @apimap_size &&
+                names.equal?(@names) && names.size == @names_size
+
+      @models, @models_size = models, models.size
+      @apimap, @apimap_size = apimap, apimap.size
+      @names, @names_size = names, names.size
+      @stores = {}
+    end
+  end
+end

data/lib/forest_liana/version.rb

@@ -1,3 +1,3 @@
 module ForestLiana
-  VERSION = "9.22.9"
+  VERSION = "9.22.10"
 end

data/lib/forest_liana.rb

@@ -1,4 +1,5 @@
 require 'forest_liana/engine'
+require 'forest_liana/lookup_cache'
 
 module Forest
 end
@@ -69,14 +70,16 @@ module ForestLiana
   end
 
   def self.schema_for_resource resource
-    self.apimap.find do |collection|
-      SchemaUtils.find_model_from_collection_name(collection.name)
-        .try(:name) == resource.name
+    LookupCache.fetch(:schema_for_resource, resource.name) do
+      self.apimap.find do |collection|
+        SchemaUtils.find_model_from_collection_name(collection.name)
+          .try(:name) == resource.name
+      end
     end
   end
 
   def self.name_for(model)
-    self.names_overriden[model] || model.try(:name).gsub('::', '__')
+    LookupCache.fetch(:name_for, model) { self.names_overriden[model] || model.try(:name).gsub('::', '__') }
   end
 
   # TODO: Remove once lianas prior to 2.0.0 are not supported anymore.

data/spec/lib/forest_liana/lookup_cache_spec.rb

@@ -0,0 +1,68 @@
+require 'rails_helper'
+
+describe 'Lookups by name over the schema' do
+  describe 'ForestLiana.name_for' do
+    after { ForestLiana.names_overriden.delete(Tree) }
+
+    it 'answers an override registered after a first lookup' do
+      expect(ForestLiana.name_for(Tree)).to eq 'Tree'
+
+      ForestLiana.names_overriden[Tree] = 'Orchard'
+
+      expect(ForestLiana.name_for(Tree)).to eq 'Orchard'
+    end
+  end
+
+  describe 'ForestLiana::SchemaUtils.find_model_from_collection_name' do
+    let(:ghost) { Class.new(ActiveRecord::Base) { self.table_name = 'trees' } }
+
+    after do
+      ForestLiana.models.delete(ghost)
+      ForestLiana.names_overriden.delete(ghost)
+    end
+
+    it 'scans the models once for repeated lookups of a name' do
+      expect(ForestLiana::SchemaUtils).to receive(:scan_models_for_collection_name).with('Tree').once.and_call_original
+
+      3.times { expect(ForestLiana::SchemaUtils.find_model_from_collection_name('Tree')).to eq Tree }
+    end
+
+    it 'does not remember an unknown name, which any caller can send before authenticating' do
+      expect(ForestLiana::SchemaUtils).to receive(:scan_models_for_collection_name).with('Ghost').twice.and_call_original
+
+      2.times { expect(ForestLiana::SchemaUtils.find_model_from_collection_name('Ghost')).to be_nil }
+    end
+
+    it 'still warns on each lookup of an unknown name' do
+      expect(FOREST_LOGGER).to receive(:warn).with('No model found for collection Ghost').twice
+
+      2.times { expect(ForestLiana::SchemaUtils.find_model_from_collection_name('Ghost', true)).to be_nil }
+    end
+
+    it 'finds a model added after a first lookup missed it' do
+      expect(ForestLiana::SchemaUtils.find_model_from_collection_name('Ghost')).to be_nil
+
+      ForestLiana.names_overriden[ghost] = 'Ghost'
+      ForestLiana.models << ghost
+
+      expect(ForestLiana::SchemaUtils.find_model_from_collection_name('Ghost')).to eq ghost
+    end
+  end
+
+  describe 'ForestLiana.schema_for_resource' do
+    it 'resolves the collection of a resource once for repeated lookups' do
+      expect(ForestLiana.schema_for_resource(Tree).name).to eq 'Tree'
+      expect(ForestLiana::SchemaUtils).not_to receive(:find_model_from_collection_name)
+
+      expect(ForestLiana.schema_for_resource(Tree).name).to eq 'Tree'
+    end
+
+    it 'answers from the apimap in place when it is replaced' do
+      expect(ForestLiana.schema_for_resource(Tree).name).to eq 'Tree'
+      replacement = ForestLiana::Model::Collection.new(name: 'Tree', fields: [])
+      allow(ForestLiana).to receive(:apimap).and_return([replacement])
+
+      expect(ForestLiana.schema_for_resource(Tree)).to equal replacement
+    end
+  end
+end

data/spec/rails_helper.rb

@@ -65,6 +65,7 @@ RSpec.configure do |config|
   # own comment) — cleared before every example so one spec's warning can't silence another's,
   # regardless of run order or which file exercises the valve.
   config.before { ForestLiana::MissingAttributeValve::WARNED_ONCE.clear }
+  config.before { ForestLiana::LookupCache.reset! }
 
   # Filter lines from Rails gems in backtraces.
   config.filter_rails_from_backtrace!

data/spec/services/forest_liana/ability/assert_can_read_query_fields_spec.rb

@@ -67,10 +67,9 @@ module ForestLiana
           expect { dummy_class.assert_can_read_query_fields(user, Tree) }.not_to raise_error
         end
 
-        it 'reads the apimap once, however many paths are checked' do
+        it 'indexes the apimap once, however many paths are checked' do
           write_permissions('Tree' => true, 'User' => true, 'Island' => true)
-          reads = 0
-          allow(ForestLiana).to receive(:apimap).and_wrap_original { |original| reads += 1; original.call }
+          expect(ForestLiana::Ability::ApimapIndex).to receive(:new).with(ForestLiana.apimap).once.and_call_original
 
           expect do
             dummy_class.assert_can_read_query_fields(
@@ -78,7 +77,6 @@ module ForestLiana
                           search_paths: %w[owner:title]
             )
           end.not_to raise_error
-          expect(reads).to eq 1
         end
 
         it 'serves a filter, a sort and a search on an unreadable collection once the option is on' do

data/spec/services/forest_liana/ability/redact_fields_spec.rb

@@ -169,10 +169,9 @@ module ForestLiana
 
         # Resolving each field against the apimap rescans every collection: on a wide collection and
         # a large schema, that cost outweighs the request it guards.
-        it 'reads the apimap once, however many fields are requested' do
+        it 'indexes the apimap once, however many fields are requested' do
           write_permissions('Tree' => true, 'User' => true, 'Island' => true)
-          reads = 0
-          allow(ForestLiana).to receive(:apimap).and_wrap_original { |original| reads += 1; original.call }
+          expect(ForestLiana::Ability::ApimapIndex).to receive(:new).with(ForestLiana.apimap).once.and_call_original
 
           redacted = dummy_class.redact_fields(
             user, Tree, { 'Tree' => 'id,name,age,owner,cutter,island', 'owner' => 'name', 'island' => 'name' },
@@ -180,7 +179,6 @@ module ForestLiana
           )
 
           expect(redacted).to eq('Tree' => 'id,name,age,owner,cutter,island', 'owner' => 'name', 'island' => 'name')
-          expect(reads).to eq 1
         end
 
         it 'checks nothing at all when only root collection fields are requested' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: forest_liana
 version: !ruby/object:Gem::Version
-  version: 9.22.9
+  version: 9.22.10
 platform: ruby
 authors:
 - Sandro Munda
@@ -365,6 +365,7 @@ files:
 - lib/forest_liana/collection.rb
 - lib/forest_liana/engine.rb
 - lib/forest_liana/json_printer.rb
+- lib/forest_liana/lookup_cache.rb
 - lib/forest_liana/mixpanel_event.rb
 - lib/forest_liana/schema_file_updater.rb
 - lib/forest_liana/version.rb
@@ -471,6 +472,7 @@ files:
 - spec/lib/forest_liana/bootstrapper_spec.rb
 - spec/lib/forest_liana/collection_spec.rb
 - spec/lib/forest_liana/engine_spec.rb
+- spec/lib/forest_liana/lookup_cache_spec.rb
 - spec/lib/forest_liana/schema_file_updater_spec.rb
 - spec/models/forest_liana/model/action_spec.rb
 - spec/models/forest_liana/model/collection_spec.rb
@@ -829,6 +831,7 @@ test_files:
 - spec/lib/forest_liana/bootstrapper_spec.rb
 - spec/lib/forest_liana/collection_spec.rb
 - spec/lib/forest_liana/engine_spec.rb
+- spec/lib/forest_liana/lookup_cache_spec.rb
 - spec/lib/forest_liana/schema_file_updater_spec.rb
 - spec/models/forest_liana/model/action_spec.rb
 - spec/models/forest_liana/model/collection_spec.rb