Skip to content

Fix regression in API controllers with view_cache_dependencies helper#575

Merged
rafaelfranca merged 1 commit intorails:mainfrom
excid3:fix-caching-with-api-controllers
Jul 18, 2025
Merged

Fix regression in API controllers with view_cache_dependencies helper#575
rafaelfranca merged 1 commit intorails:mainfrom
excid3:fix-caching-with-api-controllers

Conversation

@excid3
Copy link
Contributor

@excid3 excid3 commented Sep 23, 2024 •
edited
Loading

Rails 8's API controllers now includes the Caching module by default (to support rate_limit in API controllers), but does not include the Helpers module.

This causes the jbuilder cache method to raise an exception because the Rails caching module does not add the helper_method :view_cache_dependencies since that's only added if helper_method exists.

helper_method :view_cache_dependencies if respond_to?(:helper_method)

Example error:

ActionView::Template::Error: undefined local variable or method `view_cache_dependencies' for an instance of #<Class:0x000000012a6da468>
    /Users/chris/.local/share/mise/installs/ruby/3.3.5/lib/ruby/gems/3.3.0/bundler/gems/rails-a5d1e10449c6/actionview/lib/action_view/helpers/cache_helper.rb:257:in `digest_path_from_template'
    /Users/chris/.local/share/mise/installs/ruby/3.3.5/lib/ruby/gems/3.3.0/bundler/gems/rails-a5d1e10449c6/actionview/lib/action_view/helpers/cache_helper.rb:271:in `fragment_name_with_digest'
    /Users/chris/.local/share/mise/installs/ruby/3.3.5/lib/ruby/gems/3.3.0/bundler/gems/rails-a5d1e10449c6/actionview/lib/action_view/helpers/cache_helper.rb:252:in `cache_fragment_name'
    /Users/chris/.local/share/mise/installs/ruby/3.3.5/lib/ruby/gems/3.3.0/gems/jbuilder-2.13.0/lib/jbuilder/jbuilder_template.rb:227:in `_fragment_name_with_digest'
    /Users/chris/.local/share/mise/installs/ruby/3.3.5/lib/ruby/gems/3.3.0/gems/jbuilder-2.13.0/lib/jbuilder/jbuilder_template.rb:214:in `_cache_key'
    /Users/chris/.local/share/mise/installs/ruby/3.3.5/lib/ruby/gems/3.3.0/gems/jbuilder-2.13.0/lib/jbuilder/jbuilder_template.rb:194:in `_cache_fragment_for'
    /Users/chris/.local/share/mise/installs/ruby/3.3.5/lib/ruby/gems/3.3.0/gems/jbuilder-2.13.0/lib/jbuilder/jbuilder_template.rb:69:in `cache!'
    app/views/users/_user.json.jbuilder:1:in `_app_views_users__user_json_jbuilder___1927266165303472685_95340'

This adds the helper method to jbuilder to ensure that caching still works without having to include Helpers in API controllers.

Previously, this worked because you could include both the Helpers and Caching modules in API controllers in the correct order.

jbuilder doesn't have a test/dummy app to write tests for this.

@excid3 excid3 force-pushed the fix-caching-with-api-controllers branch from fdf4510 to fa54436 Compare September 23, 2024 18:42
@mguidetti
Copy link

mguidetti commented Nov 5, 2024

I ran into this issue as well, but on rails 7.2.2. (I believe the API controller gained the Caching module there first?)

I found I needed to add the :combined_fragment_cache_key helper as well to get this to work in my jbuilder views

@Earlopain Earlopain mentioned this pull request Nov 8, 2024
Closed
@dwightwatson
Copy link

dwightwatson commented Nov 9, 2024

Yeah, perhaps this PR should include combined_fragment_cache_key as well, as it's affected by the same issue in AbstractController::Caching::Fragments which is loaded by AbstractController::Caching.

@excid3 excid3 force-pushed the fix-caching-with-api-controllers branch from 66add2d to b928550 Compare November 9, 2024 16:24
@excid3
Copy link
Contributor Author

excid3 commented Nov 9, 2024

Added that helper. 👍

Now that Rails 8 has shipped, I imagine more people will run into this. cc @rafaelfranca

Failing test is because Ruby 3.1 isn't support on Rails head.

@eddygarcas
Copy link

eddygarcas commented Nov 14, 2024 •
edited
Loading

Yes, same issue here running Rails 8.0 too, so far I'm using @excid3 branch and works, waiting for the merge.

@dwightwatson
Copy link

dwightwatson commented Dec 16, 2024

@rafaelfranca apologies to re-ping but any chance this could be reviewed? It's blocking upgrades to ~> 7.2.2/~> 8.0.0 which have both had security patches applied

@palin
Copy link

palin commented Jan 6, 2025

+1 here, having the same issue on rails 7.2.2, ruby 3.3, jbuilder 2.13.0

applied the fix manually in my application_controller

class ApplicationController < ActionController::API
  helper_method :combined_fragment_cache_key
  helper_method :view_cache_dependencies
...
end

@kgorazd
Copy link

kgorazd commented Apr 7, 2025

+1 here, rails 8.0.2, ruby 3.2.1, jbuilder 2.13.0

Thanks @palin, your fix worked perfectly!

@rafaelfranca rafaelfranca merged commit 9013595 into rails:main Jul 18, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@MatheusRich MatheusRich MatheusRich approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

8 participants

@excid3 @mguidetti @dwightwatson @eddygarcas @palin @kgorazd @MatheusRich @rafaelfranca