praxis 2.0.pre.25 → 2.0.pre.26

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d73908c503a31cf0df282dac909e0ef1e0275177214a024af13080176bbcfc3
-  data.tar.gz: 365e044a88823e1f4941e9393bec2ac76612359c2e53cdf4e496bfc006384502
+  metadata.gz: dcecd5fd9fb69d436e75297f383ffeaa63373caf8ddfbefdb7361230c981ffc8
+  data.tar.gz: a5e00599183864a2fec4a3f197accaa8c8724fdd40400d91917a460bbd72f8aa
 SHA512:
-  metadata.gz: efedee79c593c8ce8c16ec16133ebe3433801dbffa07266f8ae163febc231db5bd1cb362cb0670509af37642114f298b988b163100492037ce8a84309bb22992
-  data.tar.gz: 344040ab4d645a405ca9552ed3375c42163e600584bb339f9e593257ac24869685e4ae7205ce0a4ca9560cd5e7b9fb12ff2080f2b4163daae59ee713fb21e536
+  metadata.gz: cf23dd0e2cd395df1a956216987023b1427e50268a964a770d2b1649206a115ae345a91adefaf067d612c64f04b312f1e508e1dc8f56dfa1157a395c038ac31f
+  data.tar.gz: fd01611ba7921490e8fdfee9073ab83fab85130e4428271e1d0f448cde5afd844da6a2a930bbff206f6b9832589bc425d5fc15231eb44a7c47842942305e4b40

data/CHANGELOG.md

@@ -2,9 +2,12 @@
 
 ## next
 
+## 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/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.26'
 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/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

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.26
 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-11-14 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.