Load Parameters configurations on :action_controller only once #30045

albertoalmagro · 2017-08-02T16:53:10Z

Summary

This PR fixes the regression where ActionController::UnpermittedParameters exceptions are not being raised.

To accomplish that the following has been made:

Allow ActiveSupport::LazyLoadHooks to be executed only once.
Provide run_once: true option to on_load in case you want a hook only to be executed once. This may be useful in cases where executing a hook several times may have undesired side effects. Example: ActiveSupport.on_load(:action_controller, run_once: true)
Load Parameters configurations on :action_controller only once.
By using the new ActiveSupport::LazyLoadHooksfunctionality described above fixes regression ActionController::UnpermittedParameters not raised. The inner hook was being executed twice, once when ActionController::Base was loaded and again when ActionController::API was loaded. As options.delete operations inside the block are not idempotent, the second time it was run there was no configuration option available.

Other Information

More information can be found in Issue 30025.

rails-bot · 2017-08-02T16:53:13Z

Thanks for the pull request, and welcome! The Rails team is excited to review your changes, and you should hear from @pixeltrix (or someone else) soon.

If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes.

This repository is being automatically checked for code quality issues using Code Climate. You can see results for this analysis in the PR status below. Newly introduced issues should be fixed before a Pull Request is considered ready to review.

Please see the contribution instructions for more information.

betesh · 2017-08-02T17:44:25Z

Sign in to view

@@ -24,7 +24,7 @@ class Railtie < Rails::Railtie #:nodoc:
    initializer "action_controller.parameters_config" do |app|
      options = app.config.action_controller

-      ActiveSupport.on_load(:action_controller) do
+      ActiveSupport.on_load(:action_controller_base) do


Does ActionController::API not use strong parameters?

So the problem is because we run this block twice and after the first one we delete the values, so the second one we get the default values (which is false).

Yeah, we still need to make sure it will run for ActionController::API.

I think we need an new concept that are lazy load hooks that are only executed once. Something like:

ActiveSupport.on_load(:action_controller_base, only_once: true) do

Could you implement that?

Yes you are right, it doesn't cover ActionController::API.

@rafaelfranca where do you see that it is executed twice? Is the same hook registered twice?

No, it is executed twice. One for ActionController::Base and other for ActionController::API. This is why changing to on_load(:action_controller_base) fix the problem, because it only run for ActionController::Base

Now I see @rafaelfranca, the first time the hook is executed this line deletes the value for :action_on_unpermitted_parameters and the next time it gets executed options[:action_on_unpermitted_parameters] is nil and the value gets overwritten.

I will correct the PR accordingly.

What if we stop deleting / mutating the values in the callback? Then we wouldn't need to introduce the complexity of only_once.

albertoalmagro · 2017-08-03T21:48:27Z

@rafaelfranca @betesh changes done and PR description updated.

rafaelfranca

This is great! I made a commend about the implementation that I think can be simpler.

rafaelfranca · 2017-08-09T22:18:36Z

Sign in to view

@@ -27,19 +27,34 @@ def self.extended(base) # :nodoc:
      base.class_eval do
        @load_hooks = Hash.new { |h, k| h[k] = [] }
        @loaded     = Hash.new { |h, k| h[k] = [] }
+        @only_once  = Hash.new { |h, k| h[k] = [] }


I wonder if we can delete the hook from @load_hooks just after it is executed if :only_once is true instead of adding a new hash.

Hey! Sure I will try tomorrow, now it is 1:10 am here. Thanks!!!

Hi @rafaelfranca , I have been trying this and it gets tricky. The main issue is that on_load and run_load_hooks can be called in any given order and both execute hooks. If you run_load_hooks for two objects like I do in this test, when on_load gets executed, you don't check @load_hooks so you will need some extra structure to know if the hook was ever executed. Having tried this I find the @only_once hash more intention revealing and I like how it separates the :only_once logic without interfering with the already existing functionality. What do you think?

That makes sense to me.

rafaelfranca · 2017-08-11T20:06:01Z

Sign in to view

      end

      @load_hooks[name] << [block, options]
    end

+    # Executes a hook. If the hook was loaded providing :only_once option,
+    # it is flagged after the first time it is executed and then skipped.
+    def process_hook(name, base, options, block)


This method can be private

rafaelfranca · 2017-08-11T20:06:01Z

Sign in to view

+      execute_hook(base, options, block)
+      flag_run(name, options, block)
+    end
+
    def execute_hook(base, options, block)


This method can be private

rafaelfranca · 2017-08-11T20:06:01Z

Sign in to view

@@ -48,10 +63,20 @@ def execute_hook(base, options, block)
      end
    end

+    def already_run?(name, hook)


This method can be private

rafaelfranca · 2017-08-11T20:06:01Z

Sign in to view

+      @only_once[name].include?(hook)
+    end
+
+    def flag_run(name, options, hook)


This method can be private

albertoalmagro · 2017-08-11T23:09:15Z

@rafaelfranca done, I made methods private and rebased. Thanks!

kaspth · 2017-08-14T18:59:09Z

Sign in to view

+        if options[:only_once]
+          @only_once[name] << hook
+        end
+      end


This seems a little too abstracted for my taste. I think it would be clearer if we kept the once checking responsibility within the same method:

def execute_hook(name, base, options, block) with_once_execution(name, block, options[:only_once]) do if options[:yield] block.call(base) else base.instance_eval(&block) end end end def with_once_execution(name, block, once) unless @only_once[name].include?(block) @only_once[name] << block if once yield end end

(I'd probably just call the option once: true since the only_ is already implied.)

Provide run_once: true option to on_load in case you want a hook only to be executed once. This may be useful in cases where executing a hook several times may have undesired side effects

Fixes regression ActionController::UnpermittedParameters not raised. The inner hook was being executed twice, once when ActionController::Base was loaded and again when ActionController::API was loaded. As options.delete operations inside the block are not idempotent, the second time it was run there was no configuration option available

albertoalmagro · 2017-08-14T22:12:22Z

@kaspth I really like your proposal, I have applied it but changing the method's name to with_execution_control instead of with_once_execution. with_execution_control suggests me that we are doing some control to determine if the hook will be executed or not whereas with_once_execution feels to me like it will always be one single execution.

I have also renamed the option to :run_once because I think it expresses better its intention.

@rafaelfranca please also review last changes.

rafaelfranca · 2017-08-15T20:20:24Z

Just to confirm, does the application that you are reproducing this bug has ActionController::Api classes?

Test case for #30045

…arameters-regression Load Parameters configurations on :action_controller only once

Test case for #30045

albertoalmagro · 2017-08-15T21:36:52Z

Yes @rafaelfranca , I can confirm it. I have debugged it and I see how the hook is registered for both ActionController::Base and ActionController::API. I have also created a Rails app using this branch and reproduced the bug without using :run_once. After adding :run_once the problem is solved 😄

…arameters-regression Load Parameters configurations on :action_controller only once

Test case for #30045

kaspth · 2017-08-16T18:05:50Z

activesupport/lib/active_support/lazy_load_hooks.rb

+      end
+
+      def execute_hook(base, options, block)
+        with_execution_control(name, block, options[:run_once]) do


Where is name coming from here? Previously execute_hook was changed to pass it in.

Good catch @kaspth I wonder why tests didn't blow up. Since this is merged, please tell me how should I fix it?

@kaspth I already have a branch to pass the name. Should I open a new PR and reference this one?

@rafaelfranca @kaspth Done please check PR #30285

…ler::Base and ActionController::API. Rails [introduced](rails/rails#30045) `has_one` option to limit executions to one This will fix merit-gem#173 for rails 5.1.4 and above

Rails execute `action_controller` onload hooks for Both ActionController::Base and ActionController::API. Rails [introduced](rails/rails#30045) `has_one` option to limit executions to one This will fix merit-gem#173 for rails 5.1.4 and above

rails-bot assigned pixeltrix Aug 2, 2017

albertoalmagro mentioned this pull request Aug 2, 2017

UnpermittedParameters not raised #30025

Closed

betesh reviewed Aug 2, 2017

View changes

albertoalmagro changed the title ~~Load Parameters configurations on :action_controller_base~~ Load Parameters configurations on :action_controller only once Aug 7, 2017

rafaelfranca reviewed Aug 9, 2017

View changes

rafaelfranca requested changes Aug 11, 2017

View changes

kaspth reviewed Aug 14, 2017

View changes

Alberto Almagro added 2 commits Aug 3, 2017

Allow lazy load hooks to be executed only once

10bf93e

Provide run_once: true option to on_load in case you want a hook only to be executed once. This may be useful in cases where executing a hook several times may have undesired side effects

rafaelfranca merged commit c171890 into rails:master Aug 15, 2017
2 checks passed

2 checks passed

codeclimate All good!
Details

continuous-integration/travis-ci/pr The Travis CI build passed
Details

rafaelfranca added a commit that referenced this pull request Aug 15, 2017

Add test case to make sure Parameters configuration are executed once

Loading status checks…

11fd246

Test case for #30045

rafaelfranca added a commit that referenced this pull request Aug 15, 2017

Merge pull request #30045 from albertoalmagro/fix-raise-unpermitted-p…

2aca09e

…arameters-regression Load Parameters configurations on :action_controller only once

rafaelfranca added a commit that referenced this pull request Aug 15, 2017

Add test case to make sure Parameters configuration are executed once

Loading status checks…

6893de7

Test case for #30045

rafaelfranca added a commit that referenced this pull request Aug 15, 2017

Merge pull request #30045 from albertoalmagro/fix-raise-unpermitted-p…

a564af6

…arameters-regression Load Parameters configurations on :action_controller only once

rafaelfranca added a commit that referenced this pull request Aug 15, 2017

Add test case to make sure Parameters configuration are executed once

Loading status checks…

5064332

Test case for #30045

kaspth reviewed Aug 16, 2017

View changes

tute mentioned this pull request Nov 3, 2017

warning: already initialized constant Merit::AppBadgeRules merit-gem/merit#173

Closed

redtachyons mentioned this pull request Nov 3, 2017

Run action controller load hook only once merit-gem/merit#282

Merged

rails / rails

Load Parameters configurations on :action_controller only once #30045

Load Parameters configurations on :action_controller only once #30045

albertoalmagro commented Aug 2, 2017 •

edited

rails-bot commented Aug 2, 2017

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

albertoalmagro commented Aug 3, 2017

rafaelfranca left a comment

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

albertoalmagro commented Aug 11, 2017

This comment has been minimized.

albertoalmagro commented Aug 14, 2017

rafaelfranca commented Aug 15, 2017

albertoalmagro commented Aug 15, 2017

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

rails / rails

Load Parameters configurations on :action_controller only once #30045

Load Parameters configurations on :action_controller only once #30045

Conversation

albertoalmagro commented Aug 2, 2017 • edited

Summary

Other Information

rails-bot commented Aug 2, 2017

This comment has been minimized.

betesh Aug 2, 2017 Contributor

This comment has been minimized.

rafaelfranca Aug 2, 2017 Member

This comment has been minimized.

albertoalmagro Aug 2, 2017 Author Contributor

This comment has been minimized.

rafaelfranca Aug 2, 2017 Member

This comment has been minimized.

albertoalmagro Aug 2, 2017 • edited Author Contributor

This comment has been minimized.

kirs Aug 9, 2017 Member

albertoalmagro commented Aug 3, 2017

rafaelfranca left a comment

This comment has been minimized.

rafaelfranca Aug 9, 2017 • edited Member

This comment has been minimized.

albertoalmagro Aug 9, 2017 Author Contributor

This comment has been minimized.

albertoalmagro Aug 10, 2017 Author Contributor

This comment has been minimized.

rafaelfranca Aug 11, 2017 Member

This comment has been minimized.

rafaelfranca Aug 11, 2017 Member

This comment has been minimized.

rafaelfranca Aug 11, 2017 Member

This comment has been minimized.

rafaelfranca Aug 11, 2017 Member

This comment has been minimized.

rafaelfranca Aug 11, 2017 Member

albertoalmagro commented Aug 11, 2017

This comment has been minimized.

kaspth Aug 14, 2017 Member

albertoalmagro commented Aug 14, 2017

rafaelfranca commented Aug 15, 2017

albertoalmagro commented Aug 15, 2017

This comment has been minimized.

kaspth Aug 16, 2017 Member

This comment has been minimized.

albertoalmagro Aug 16, 2017 Author Contributor

This comment has been minimized.

albertoalmagro Aug 16, 2017 Author Contributor

This comment has been minimized.

rafaelfranca Aug 16, 2017 Member

This comment has been minimized.

albertoalmagro Aug 16, 2017 Author Contributor

albertoalmagro commented Aug 2, 2017 •

edited

betesh Aug 2, 2017
Contributor

rafaelfranca Aug 2, 2017
Member

albertoalmagro Aug 2, 2017
Author Contributor

rafaelfranca Aug 2, 2017
Member

albertoalmagro Aug 2, 2017 •

edited

Author Contributor

kirs Aug 9, 2017
Member

rafaelfranca Aug 9, 2017 •

edited

Member

albertoalmagro Aug 9, 2017
Author Contributor

albertoalmagro Aug 10, 2017
Author Contributor

rafaelfranca Aug 11, 2017
Member

rafaelfranca Aug 11, 2017
Member

rafaelfranca Aug 11, 2017
Member

rafaelfranca Aug 11, 2017
Member

rafaelfranca Aug 11, 2017
Member

kaspth Aug 14, 2017
Member

kaspth Aug 16, 2017
Member

albertoalmagro Aug 16, 2017
Author Contributor

albertoalmagro Aug 16, 2017
Author Contributor

rafaelfranca Aug 16, 2017
Member

albertoalmagro Aug 16, 2017
Author Contributor