praxis 2.0.pre.2 → 2.0.pre.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: f23deb4aca50709972c23925ed41fde1fe98baaf7e865513b7f047611bd3af3d
-  data.tar.gz: 512839b90d37a8ac2cb67a7a14f32a8353160d15ef43d0066c860ec95da3002e
+SHA1:
+  metadata.gz: d869bce23150f16857b3d92fb1e4e6fe98b0b747
+  data.tar.gz: bf2e0bac5b872453a6ae142f518591a2fae67180
 SHA512:
-  metadata.gz: 19ff50cbc1d7c9b003725f96122cfab8c8c221f54d8df5a142299ad260dcb2f9597d504e6761c18badee02a768d18dab81dc76425abda01704a9e61f0aae3769
-  data.tar.gz: 3b2885d5e46d68848541dfed03dabe8cc1df71a430d1fdd42fc330035f544fee5b05291cf8087c00a51c987c2087e4f6e2a502522566e61a88f50e0adee4a71f
+  metadata.gz: d2975bad774d35e3c7a98067442258fff5d7670f161ee4b5653dfe5b038f1af341b9fb21fefcff733d9f2a7c96a9ee742014919c29148d87826433b15291dcb0
+  data.tar.gz: cf8665de0a625dee430a30b23a07328bebd8d60cffb2aad9e7dc3aed9503c21afd463aa024ee97fefb7ce639db008716aa4996ee70e3361d91d102b5408c6adc

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Praxis Changelog
 
+## next
+- Reworked the field selection DB query generation to support full tree of eager loaded dependencies
+  - Built support for both ActiveRecord and Sequel gems
+  - Selected DB fields will include/map the defined resource properties and will always include any necessary fields on both sides of the joins for the given associations.
+  - Added a configurable option to enable debugging of those generated queries (through `Praxis::Application.instance.config.mapper.debug_queries=true`)
+
 ## 2.0.pre.1
 
 - Bring over partial functionality from praxis-mapper and remove dependency on same

data/lib/praxis/extensions/field_selection/active_record_query_selector.rb

@@ -3,51 +3,47 @@ module Praxis
   module Extensions
     module FieldSelection
       class ActiveRecordQuerySelector
-        attr_reader :selector, :query, :top_model, :resolved, :root
+        attr_reader :selector, :query
         # Gets a dataset, a selector...and should return a dataset with the selector definition applied.
-        def initialize(query:, model:, selectors:, resolved:)
+        def initialize(query:, selectors:)
           @selector = selectors
           @query = query
-          @top_model = model
-          @resolved = resolved
-          @seen = Set.new
-          @root = model.table_name
         end
 
-        def add_select(query:, model:, table_name:)
-          if (fields = fields_for(model))
-            # Note, let's always add the pk fields so that associations can load properly
-            fields = fields | [model.primary_key.to_sym]
-            query.select(*fields)
-          else
-            query
-          end
-        end
-
-        def generate
+        def generate(debug: false)
           # TODO: unfortunately, I think we can only control the select clauses for the top model 
           # (as I'm not sure ActiveRecord supports expressing it in the join...)
-          @query = add_select(query: query, model: top_model, table_name: root)
+          @query = add_select(query: query, selector_node: selector)
+          eager_hash = _eager(selector)
 
-          @query.includes(_eager(top_model, resolved) )
+          @query = @query.includes(eager_hash)          
+          explain_query(query, eager_hash) if debug
+
+          @query
         end
 
-        def _eager(model, resolved)
-          tracks = only_assoc_for(model, resolved)
-          tracks.inject([]) do |dataset, track|
-            next dataset if @seen.include?([model, track])
-            @seen << [model, track]
-            assoc_model = model._praxis_associations[track][:model]
-            dataset << { track => _eager(assoc_model, resolved[track]) }
-          end
+        def add_select(query:, selector_node:)
+          # We're gonna always require the PK of the model, as it is a special case for AR, and the app itself 
+          # might assume it is always there and not be surprised by the fact that if it isn't, it won't blow up
+          # in the same way as any other attribute not being loaded...i.e., ActiveModel::MissingAttributeError: missing attribute: xyz
+          select_fields = selector_node.select + [selector_node.resource.model.primary_key.to_sym]
+          select_fields.empty? ? query : query.select(*select_fields)
         end
 
-        def only_assoc_for(model, hash)
-          hash.keys.reject { |assoc| model._praxis_associations[assoc].nil? }
+        def _eager(selector_node)
+          selector_node.tracks.each_with_object({}) do |(track_name, track_node), h|
+            h[track_name] = _eager(track_node)
+          end
         end
 
-        def fields_for(model)
-          selector[model][:select].to_a
+        def explain_query(query, eager_hash)
+          prev = ActiveRecord::Base.logger
+          ActiveRecord::Base.logger = Logger.new(STDOUT)
+          ActiveRecord::Base.logger.debug("Query plan for ...#{selector.resource.model} with selectors: #{JSON.generate(selector.dump)}")
+          ActiveRecord::Base.logger.debug(" ActiveRecord query: #{selector.resource.model}.includes(#{eager_hash})")
+          query.explain
+          ActiveRecord::Base.logger.debug("Query plan end")
+          ActiveRecord::Base.logger = prev
         end
       end
     end

data/lib/praxis/extensions/field_selection/sequel_query_selector.rb

@@ -1,63 +1,59 @@
 # frozen_string_literal: true
+
+require 'sequel'
+
 module Praxis
   module Extensions
     module FieldSelection
       class SequelQuerySelector
-        attr_reader :selector, :ds, :top_model, :resolved, :root
+        attr_reader :selector, :query
         # Gets a dataset, a selector...and should return a dataset with the selector definition applied.
-        def initialize(query:, model:, selectors:, resolved:)
+        def initialize(query:, selectors:)
           @selector = selectors
-          @ds = query
-          @top_model = model
-          @resolved = resolved
-          @seen = Set.new
-          @root = model.table_name
+          @query = query
         end
 
-        def add_select(ds:, model:, table_name:)
-          if (fields = fields_for(model))
-            # Note, let's always add the pk fields so that associations can load properly
-            fields = fields | model.primary_key | [:id]
-            qualified = fields.map { |f| Sequel.qualify(table_name, f) }
-            ds.select(*qualified)
-          else
-            ds
+        def generate(debug: false)
+          @query = add_select(query: query, selector_node: @selector)
+          
+          @query = @selector.tracks.inject(@query) do |ds, (track_name, track_node)|
+            ds.eager(track_name => _eager(track_node) )
           end
-        end
 
-        def generate
-          @ds = add_select(ds: ds, model: top_model, table_name: root)
-
-          tracks = only_assoc_for(top_model, resolved)
-          @ds = tracks.inject(@ds) do |dataset, track|
-            next dataset if @seen.include?([top_model, track])
-            @seen << [top_model, track]
-            assoc_model = top_model._praxis_associations[track][:model]
-            #      hash[track] = _eager(assoc_model, resolved[track])
-            dataset.eager(track => _eager(assoc_model, resolved[track]))
-          end
+          explain_query(query) if debug
+          @query
         end
 
-        def _eager(model, resolved)
+        def _eager(selector_node)
           lambda do |dset|
-            d = add_select(ds: dset, model: model, table_name: model.table_name)
+            dset = add_select(query: dset, selector_node: selector_node)
 
-            tracks = only_assoc_for(model, resolved)
-            tracks.inject(d) do |dataset, track|
-              next dataset if @seen.include?([model, track])
-              @seen << [model, track]
-              assoc_model = model._praxis_associations[track][:model]
-              dataset.eager(track => _eager(assoc_model, resolved[track]))
+            dset = selector_node.tracks.inject(dset) do |ds, (track_name, track_node)|
+              ds.eager(track_name => _eager(track_node) )
             end
+
           end
         end
 
-        def only_assoc_for(model, hash)
-          hash.keys.reject { |assoc| model._praxis_associations[assoc].nil? }
+        def add_select(query:, selector_node:)
+          # We're gonna always require the PK of the model, as it is a special case for Sequel, and the app itself 
+          # might assume it is always there and not be surprised by the fact that if it isn't, it won't blow up
+          # in the same way as any other attribute not being loaded...i.e., NoMethodError: undefined method `foobar' for #<...>
+          select_fields = selector_node.select + [selector_node.resource.model.primary_key.to_sym]
+    
+          table_name = selector_node.resource.model.table_name
+          qualified = select_fields.map { |f| Sequel.qualify(table_name, f) }
+          query.select(*qualified)
         end
 
-        def fields_for(model)
-          selector[model][:select].to_a
+        def explain_query(ds)
+          prev_loggers = Sequel::Model.db.loggers
+          stdout_logger = Logger.new($stdout)
+          Sequel::Model.db.loggers = [stdout_logger]
+          stdout_logger.debug("Query plan for ...#{selector.resource.model} with selectors: #{JSON.generate(selector.dump)}")
+          ds.all
+          stdout_logger.debug("Query plan end")
+          Sequel::Model.db.loggers = prev_loggers
         end
       end
     end

data/lib/praxis/mapper/active_model_compat.rb

@@ -46,18 +46,53 @@ module Praxis
               else
                 raise "Unknown association type: #{v.class.name} on #{v.klass.name} for #{v.name}"
               end
+            # Call out any local (i.e., of this model) columns that participate in the association 
+            info[:local_key_columns] = local_columns_used_for_the_association(info[:type], v)
+            info[:remote_key_columns] = remote_columns_used_for_the_association(info[:type], v)
 
             if v.is_a?(ActiveRecord::Reflection::ThroughReflection)
               info[:through] = v.through_reflection.name # TODO: is this correct?
             end
-
-            # TODO: add more keys for the association to make true praxis mapper functions happy
             hash[k.to_sym] = info
           end
         end
 
+        private
+        def local_columns_used_for_the_association(type, assoc_reflection)
+          case type
+          when :one_to_many
+            # The associated table  will point to us by key (usually the PK, but not always)
+            [assoc_reflection.join_keys.foreign_key.to_sym]
+          when :many_to_one
+            # We have the FKs to the associated model
+            [assoc_reflection.join_keys.foreign_key.to_sym]
+          when :many_to_many
+            ref = resolve_closest_through_reflection(assoc_reflection)
+            # The associated middle table will point to us by key (usually the PK, but not always)
+            [ref.join_keys.foreign_key.to_sym] # The foreign key that the last through table points to
+          else 
+            raise "association type #{type} not supported"
+          end
+        end
+
+        def remote_columns_used_for_the_association(type, assoc_reflection)
+          # It seems that since the reflection is the target of the association, using the join_keys.key
+          # will always get us the right column
+          case type
+          when :one_to_many, :many_to_one, :many_to_many
+            [assoc_reflection.join_keys.key.to_sym]
+          else 
+            raise "association type #{type} not supported"
+          end
+        end
+  
+        # Keep following the association reflections as long as there are middle ones (i.e., through)
+        # until we come to the one next to the source
+        def resolve_closest_through_reflection(ref)
+          return ref unless ref.through_reflection?
+          resolve_closest_through_reflection( ref.through_reflection )
+        end
       end
-    
     end
   end
 end

data/lib/praxis/mapper/resource.rb

@@ -212,10 +212,10 @@ module Praxis::Mapper
       base_query
     end
 
-    def self.craft_field_selection_query(base_query, selectors:, resolved:) # rubocop:disable Metrics/AbcSize
+    def self.craft_field_selection_query(base_query, selectors:) # rubocop:disable Metrics/AbcSize
       if selectors && model._field_selector_query_builder_class
-        base_query = model._field_selector_query_builder_class.new(query: base_query, model: self.model,
-                                          selectors: selectors, resolved: resolved).generate
+        debug = Praxis::Application.instance.config.mapper.debug_queries
+        base_query = model._field_selector_query_builder_class.new(query: base_query, selectors: selectors).generate(debug: debug)
       end
       
       base_query

data/lib/praxis/mapper/selector_generator.rb

@@ -1,101 +1,82 @@
 module Praxis::Mapper
-  # Generates a set of selectors given a resource and
-  # list of resource attributes.
-  class SelectorGenerator
-    attr_reader :selectors
 
-    def initialize
-      @selectors = Hash.new do |hash, key|
-        hash[key] = {select: Set.new, track: Set.new}
-      end
-      @seen = Hash.new do |hash, resource|
-        hash[resource] = Set.new
-      end
-    end
+  class SelectorGeneratorNode
+    attr_reader :select, :model, :resource, :tracks
 
-    def add(resource, fields)
-      return if @seen[resource].include? fields
-      @seen[resource] << fields
+    def initialize(resource)
+      @resource = resource
 
-      fields.each do |name, field|
-        map_property(resource, name, field)
-      end
+      @select = Set.new
+      @select_star = false
+      @tracks = Hash.new 
     end
 
-    def select_all(resource)
-      selectors[resource.model][:select] = true
+    def add(fields)
+      fields.each do |name, field|
+        map_property(name, field)
+      end
+      self
     end
 
-    def map_property(resource, name, fields)
+    def map_property(name, fields)
       if resource.properties.key?(name)
-        add_property(resource, name, fields)
+        add_property(name, fields)
       elsif resource.model._praxis_associations.key?(name)
-        add_association(resource, name, fields)
+        add_association(name, fields)
       else
-        add_select(resource, name)
+        add_select(name)
       end
     end
 
-    def add_select(resource, name)
-      return select_all(resource) if name == :*
-      return if selectors[resource.model][:select] == true
-
-      selectors[resource.model][:select] << name
-    end
-
-    def add_track(resource, name)
-      selectors[resource.model][:track] << name
-    end
-
-    def add_association(resource, name, fields)
+    def add_association(name, fields)
+      
       association = resource.model._praxis_associations.fetch(name) do
         raise "missing association for #{resource} with name #{name}"
       end
       associated_resource = resource.model_map[association[:model]]
-
-      case association[:type]
-      when :many_to_one
-        add_track(resource, name)
-        Array(association[:key]).each do |akey|
-          add_select(resource, akey)
-        end
-      when :one_to_many
-        add_track(resource, name)
-        Array(association[:key]).each do |akey|
-          add_select(associated_resource, akey)
-        end
-      when :many_to_many
-        # If we haven't explicitly added the "through" option in the association
-        # then we'll assume the underlying ORM is able to fill in the gap. We will
-        # simply add the fields for the associated resource below
-        if association.key? :through
-          head, *tail = association[:through]
-          new_fields = tail.reverse.inject(fields) do |thing, step|
-            {step => thing}
-          end
-          return add_association(resource, head, new_fields)
-        else
-          add_track(resource, name)
+      unless associated_resource
+        raise "Whoops! could not find a resource associated with model #{association[:model]} (root resource #{resource})"
+      end
+      # Add the required columns in this model to make sure the association can be loaded
+      association[:local_key_columns].each {|col| add_select(col) }
+      
+      node = SelectorGeneratorNode.new(associated_resource)
+      if association[:remote_key_columns].nil?
+        binding.pry
+        puts association
+      end
+      unless association[:remote_key_columns].empty?
+        # Make sure we add the required columns for this association to the remote model query
+        fields = {} if fields == true
+        new_fields_as_hash = association[:remote_key_columns].each_with_object({}) do|name, hash|
+          hash[name] = true
         end
-      else
-        raise "no select applicable for #{association[:type].inspect}"
+        fields.merge!(new_fields_as_hash) 
       end
 
-      unless fields == true
-        # recurse into the field
-        add(associated_resource,fields)
-      end
+      node.add(fields) unless fields == true
+
+      self.merge_track(name, node)
+    end
+
+    def add_select(name)
+      return @select_star = true if name == :*
+      return if @select_star
+      @select.add name
     end
 
-    def add_property(resource, name, fields)
+    def add_property(name, fields)
       dependencies = resource.properties[name][:dependencies]
+      # Always add the underlying association if we're overriding the name...
+      add_association(name, fields) if resource.model._praxis_associations.key?(name)
       if dependencies
         dependencies.each do |dependency|
-          # if dependency includes the name, then map it directly as the field
-          if dependency == name
-            add_select(resource, name)
+          # To detect recursion, let's allow mapping depending fields to the same name of the property
+          # but properly detecting if it's a real association...in which case we've already added it above
+          if dependency == name 
+            add_select(name) unless resource.model._praxis_associations.key?(name)
           else
-            apply_dependency(resource, dependency)
+            apply_dependency(dependency)
           end
         end
       end
@@ -107,20 +88,62 @@ module Praxis::Mapper
         {step => thing}
       end
 
-      add_association(resource, head, new_fields)
+      add_association(head, new_fields)
     end
 
-    def apply_dependency(resource, dependency)
+    def apply_dependency(dependency)
       case dependency
       when Symbol
-        map_property(resource, dependency, {})
+        map_property(dependency, true)
       when String
         head, tail = dependency.split('.').collect(&:to_sym)
         raise "String dependencies can not be singular" if tail.nil?
 
-        add_association(resource, head, {tail => true})
+        add_association(head, {tail => true})
+      end
+    end
+
+    def merge_track( track_name, node )
+      raise "Cannot merge another node for association #{track_name}: incompatible model" unless node.model == self.model
+
+      existing = self.tracks[track_name]
+      if existing
+        node.select.each do|col_name|
+          existing.add_select(col_name)
+        end
+        node.tracks.each do |name, n|
+          existing.merge(name, n)
+        end
+      else
+        self.tracks[track_name] = node
       end
+
     end
 
+    def dump
+      hash = {}
+      hash[:model] = resource.model
+      if !@select.empty? || @select_star
+        hash[:columns] = @select_star ? [ :* ] : @select.to_a 
+      end
+      unless @tracks.empty?
+        hash[:tracks] = @tracks.each_with_object({}) {|(name, node), hash|  hash[name] = node.dump }
+      end
+      hash
+    end
+  end
+
+  # Generates a set of selectors given a resource and
+  # list of resource attributes.
+  class SelectorGenerator
+    # Entry point
+    def add(resource, fields)
+      @root = SelectorGeneratorNode.new(resource)
+      @root.add(fields)
+    end
+
+    def selectors
+      @root
+    end
   end
 end