praxis 2.0.pre.25 → 2.0.pre.27

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d73908c503a31cf0df282dac909e0ef1e0275177214a024af13080176bbcfc3
-  data.tar.gz: 365e044a88823e1f4941e9393bec2ac76612359c2e53cdf4e496bfc006384502
+  metadata.gz: 71228b4dd69f45eb28f8fec8782eef94fc24bdf6bb164a707d19cfade5091ac7
+  data.tar.gz: 33e2fce254db25935827d67ccc394aa7b54039212e97eaa7aae89d9006e4d5fd
 SHA512:
-  metadata.gz: efedee79c593c8ce8c16ec16133ebe3433801dbffa07266f8ae163febc231db5bd1cb362cb0670509af37642114f298b988b163100492037ce8a84309bb22992
-  data.tar.gz: 344040ab4d645a405ca9552ed3375c42163e600584bb339f9e593257ac24869685e4ae7205ce0a4ca9560cd5e7b9fb12ff2080f2b4163daae59ee713fb21e536
+  metadata.gz: 4f1bb58917fe5070e9433acdc2c2b1cbc0341eb832331f399a08bc2138fc5080397326ec2755f7e9452ec4774e931842699c4a4fa9455e0ef1231a6532f2b2d9
+  data.tar.gz: 346dbe116bab1da666e6e38b5d8a7f3863c0dcd2c97736a762fc107eaf77d879b6e9f52e5569e5ee4e4e56207b14c87b21a0cd4e4e10a2f33a34177720c682e7

data/CHANGELOG.md

@@ -2,9 +2,17 @@
 
 ## next
 
+## 2.0.pre.26
+  * Introduce a new `as:` option for resource's `property`, to indicate that the underlying association method it is connected to, has a different name.
+    * This also will create a delegation function for the property name, that instead of calling the underlying association on the record, and wrapping the result with a resource instance, it will simply call the aliased method name (which is likely gonna hit the autogenerated code for that properyty, unless we have overriden it)
+    * With this change, the selector generator (i.e., the thing that looks at the incoming `fields` parameters and calculates which select and includes are necessary to query all the data we need), will be able to understand this aliasing cases, and properly pass along, and continue expanding any nested fields that are under the property name (before this, and further inner fields would be not included as soon as we hit a property that didn't have that direct association underneath).
+
+## 2.0.pre.26
+  * Make POST action forwarding more robust against technically malformed GET requests with no body but passing `Content-Type`. This could cause issues when using the `enable_large_params_proxy_action` DSL.
+
 ## 2.0.pre.25
   * Improve surfacing of requirement attributes in Structs for OpenApi generated documentation
-  * Introduction of a new `dsl enable_large_params_proxy_action` for GET verb action definitions. When used, two things will happen:
+  * Introduction of a new dsl `enable_large_params_proxy_action` for GET verb action definitions. When used, two things will happen:
     * A new POST verb equivalent action will be defined:
       * It will have a `payload` matching the shape of the original GET's params (with the exception of any param that was originally in the URL)
       * By default, the route for this new POST request is gonna have the same URL as the original GET action, but appending `/actions/<action_name>` to it. This can be customized by passing the path with the `at:` parameter of the DSL. I.e., `enable_large_params_proxy_action at: /actions/myspecialname` will change the generated path (can use the `//...` syntax to not include the prefix defined for the endpoint). NOTE: this route needs to be compatible with any params that might be defined for the URL (i.e., `:id` and such).

data/lib/praxis/bootloader_stages/routing.rb

@@ -14,8 +14,14 @@ module Praxis
 
         def call(request)
           dispatcher = Dispatcher.current(application: @application)
-          # Switch to the sister get action if configured that way
-          action = @action.sister_get_action || @action
+          # Switch to the sister get action if configured that way (and mark the request as forwarded)
+          action = \
+            if @action.sister_get_action
+              request.forwarded_from_action = @action
+              @action.sister_get_action
+            else
+              @action
+            end
           dispatcher.dispatch(@controller, action, request)
         end
       end

data/lib/praxis/mapper/resource.rb

@@ -60,8 +60,10 @@ module Praxis
         end
       end
 
-      def self.property(name, dependencies: nil, through: nil)
-        properties[name] = { dependencies: dependencies, through: through }
+      # The `as:` can be used for properties that correspond to an underlying association of a different name. With this the selector generator, is able to not only add
+      # any extra dependencies needed for the property, but it also follow and pass any incoming nested fields when necessary (as opposed to only add dependencies and discard nested fields)
+      def self.property(name, dependencies: nil, through: nil, as: name) # rubocop:disable Naming/MethodParameterName
+        properties[name] = { dependencies: dependencies, through: through, as: as }
       end
 
       def self.batch_computed(attribute, with_instance_method: true, &block)
@@ -119,11 +121,27 @@ module Praxis
       def self.define_model_accessors
         return if model.nil?
 
+        define_aliased_methods
+
         model._praxis_associations.each do |k, v|
           define_model_association_accessor(k, v) unless instance_methods.include? k
         end
       end
 
+      def self.define_aliased_methods
+        with_different_alias_name = properties.reject { |name, opts| name == opts[:as] }
+        with_different_alias_name.each do |prop_name, opts|
+          next if instance_methods.include? prop_name
+
+          # Straight call to another association method (that we will generate automatically in our association accessors)
+          module_eval <<-RUBY, __FILE__, __LINE__ + 1
+            def #{prop_name}
+              #{opts[:as]}
+            end
+          RUBY
+        end
+      end
+
       def self.hookup_callbacks
         return unless ancestors.include?(Praxis::Mapper::Resources::Callbacks)
 

data/lib/praxis/mapper/selector_generator.rb

@@ -66,8 +66,10 @@ module Praxis
       def add_property(name, fields)
         dependencies = resource.properties[name][:dependencies]
         # Always add the underlying association if we're overriding the name...
-        praxis_compat_model = resource.model&.respond_to?(:_praxis_associations)
-        add_association(name, fields) if praxis_compat_model && resource.model._praxis_associations.key?(name)
+        if (praxis_compat_model = resource.model&.respond_to?(:_praxis_associations))
+          aliased_as = resource.properties[name][:as]
+          add_association(aliased_as, fields) if resource.model._praxis_associations[aliased_as]
+        end
         dependencies&.each do |dependency|
           # 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

data/lib/praxis/request.rb

@@ -3,7 +3,7 @@
 module Praxis
   class Request < Praxis.request_superclass
     attr_reader :env, :query
-    attr_accessor :route_params, :action, :headers, :params, :payload
+    attr_accessor :route_params, :action, :headers, :params, :payload, :forwarded_from_action
 
     PATH_VERSION_PREFIX = '/v'
     CONTENT_TYPE_NAME = 'CONTENT_TYPE'
@@ -123,15 +123,16 @@ module Praxis
       return unless action.params
 
       self.params = action.params.load(raw_params, context)
-      return unless action.sister_post_action && content_type
+      return unless forwarded_from_action && content_type
 
+      # If it is coming from a forwarded action, and has a content type, let's parse it, and merge it to the params as well
       raw = if (handler = Praxis::Application.instance.handlers[content_type.handler_name])
               handler.parse(raw_payload)
             else
               # TODO: is this a good default?
               raw_payload
             end
-      loaded_payload = action.sister_post_action.payload.load(raw, context, content_type: content_type.to_s)
+      loaded_payload = forwarded_from_action.payload.load(raw, context, content_type: content_type.to_s)
       self.params = params.merge(loaded_payload)
     end
 

data/lib/praxis/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Praxis
-  VERSION = '2.0.pre.25'
+  VERSION = '2.0.pre.27'
 end

data/spec/functional_spec.rb

@@ -111,8 +111,30 @@ describe 'Functional specs' do
         end
       end
     end
+    context 'with a valid request but misusing request content-type' do
+      it 'is still successful and does not get confused about the sister post action' do
+        the_body = StringIO.new('') # This is a GET request passing a body
+        get '/api/clouds/1/instances?api_version=1.0', nil, 'rack.input' => the_body, 'CONTENT_TYPE' => 'application/json', 'global_session' => session
+        expect(last_response.status).to eq(200)
+        expect(last_response.headers['Content-Type']).to(
+          eq('application/vnd.acme.instance;type=collection')
+        )
+      end
+    end
   end
 
+  context 'index using POST sister action' do
+    context 'with a valid request' do
+      it 'is successful and round trips the content type we pass in the body' do
+        payload = { response_content_type: 'application/vnd.acme.instance; type=collection; other=thing' }
+        post '/api/clouds/1/instances/actions/index_using_post?api_version=1.0', JSON.dump(payload), 'CONTENT_TYPE' => 'application/json', 'global_session' => session
+        expect(last_response.status).to eq(200)
+        expect(last_response.headers['Content-Type']).to(
+          eq(payload[:response_content_type])
+        )
+      end
+    end
+  end
   it 'works' do
     the_body = StringIO.new('{}') # This is a funny, GET request expecting a body
     get '/api/clouds/1/instances/2?junk=foo&api_version=1.0', nil, 'rack.input' => the_body, 'CONTENT_TYPE' => 'application/json', 'global_session' => session

data/spec/praxis/mapper/resource_spec.rb

@@ -5,6 +5,8 @@ require 'spec_helper'
 describe Praxis::Mapper::Resource do
   let(:parent_record) { ParentModel.new(id: 100, name: 'george sr') }
   let(:parent_records) { [ParentModel.new(id: 101, name: 'georgia'), ParentModel.new(id: 102, name: 'georgina')] }
+  let(:other_model) { OtherModel.new(name: 'other george') }
+
   let(:record) { SimpleModel.new(id: 103, name: 'george xvi') }
   let(:model) { SimpleModel }
 
@@ -16,15 +18,19 @@ describe Praxis::Mapper::Resource do
       subject(:properties) { resource.properties }
 
       it 'includes directly-set properties' do
-        expect(properties[:other_resource]).to eq(dependencies: [:other_model], through: nil)
+        expect(properties[:other_resource]).to eq(dependencies: [:other_model], through: nil, as: :other_resource)
+      end
+
+      it 'includes aliases as well if different from name' do
+        expect(properties[:aliased_association]).to eq(dependencies: [:name], through: nil, as: :other_model)
       end
 
       it 'inherits from a superclass' do
-        expect(properties[:href]).to eq(dependencies: [:id], through: nil)
+        expect(properties[:href]).to eq(dependencies: [:id], through: nil, as: :href)
       end
 
       it 'properly overrides a property from the parent' do
-        expect(properties[:name]).to eq(dependencies: [:simple_name], through: nil)
+        expect(properties[:name]).to eq(dependencies: [:simple_name], through: nil, as: :name)
       end
     end
   end
@@ -106,6 +112,19 @@ describe Praxis::Mapper::Resource do
         expect(parents.collect(&:record)).to match_array(parent_records)
       end
     end
+
+    context 'for aliased properties' do
+      before { expect(record).to receive(:other_model).and_return(other_model) }
+      it 'skips creation of aliased method if the resource already has it defined' do
+        expect(subject.overriden_aliased_association).to be_kind_of(OtherModel) # Our override return a bare model
+        expect(subject.method(:overriden_aliased_association).source_location).to_not include(%r{/mapper/resource.rb$}) # Not created by us
+      end
+
+      it 'creates the aliased method name, instead of the property name' do
+        expect(subject.aliased_association).to be_kind_of(OtherResource) # Calling the other generated method also wraps it
+        expect(subject.method(:aliased_association).source_location).to include(%r{/mapper/resource.rb$}) # created by us
+      end
+    end
   end
 
   context 'resource_delegate' do

data/spec/praxis/mapper/selector_generator_spec.rb

@@ -213,6 +213,29 @@ describe Praxis::Mapper::SelectorGenerator do
         end
         it_behaves_like 'a proper selector'
       end
+      context 'Aliased underlying associations follows any nested fields...' do
+        let(:fields) do
+          {
+            parent_id: true,
+            aliased_association: {
+              display_name: true
+            }
+          }
+        end
+        let(:selectors) do
+          {
+            model: SimpleModel,
+            columns: %i[other_model_id parent_id simple_name],
+            tracks: {
+              other_model: {
+                model: OtherModel,
+                columns: %i[id name]
+              }
+            }
+          }
+        end
+        it_behaves_like 'a proper selector'
+      end
     end
 
     context 'string associations' do

data/spec/spec_app/design/resources/instances.rb

@@ -24,6 +24,8 @@ module ApiResources
     end
 
     action :index do
+      enable_large_params_proxy_action at: '/actions/index_using_post'
+
       routing do
         get ''
       end

data/spec/support/spec_resources.rb

@@ -125,6 +125,12 @@ class SimpleResource < BaseResource
     other_model
   end
 
+  def overriden_aliased_association
+    # My custom override (instead of the auto-generated delegator)
+    # For fun, we'll just return the raw model, without wrapping it in the resource
+    record.other_model
+  end
+
   batch_computed(:computed_name) do |rows_by_id:|
     rows_by_id.transform_values do |v|
       "BATCH_COMPUTED_#{v.name}"
@@ -146,6 +152,8 @@ class SimpleResource < BaseResource
   property :no_deps, dependencies: []
 
   property :deep_nested_deps, dependencies: ['parent.simple_children.other_model.parent.display_name']
+  property :aliased_association, as: :other_model, dependencies: [:name]
+  property :overriden_aliased_association, as: :other_model, dependencies: [:name]
 
   before(:update!, :do_before_update)
   around(:update!, :do_around_update_nested)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: praxis
 version: !ruby/object:Gem::Version
-  version: 2.0.pre.25
+  version: 2.0.pre.27
 platform: ruby
 authors:
 - Josep M. Blanquer
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-26 00:00:00.000000000 Z
+date: 2022-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -676,7 +676,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Building APIs the way you want it.