Add dev caching toggle / server options #20961

ccallebs · 2015-07-21T04:34:21Z

Taken extensively from @Sonopa's PR (#19091). Added ability to specify caching on server start.

ccallebs · 2015-07-21T04:59:24Z

railties/test/commands/server_test.rb

+  end
+
+  def test_caching_with_option
+    args = ["-C"]


This could potentially cause some confusion, as there is already a -c option. I think it should be changed, I just didn't have a notion of what it should be.

Would be easier to grasp as just --toggle-caching - maybe we don't even need a shorthand?

Though I'm still ¯_(ツ)_/¯ about the server options in general.

@kaspth I'm ambivalent about the whole thing as well, just added it as it seemed there was support in the previous PR. I'll go with the hivemind on it.

kaspth · 2015-07-22T18:09:26Z

If you change your pull request description to say "Fixes #18875" the original issue will be closed if this is merged 😄

ccallebs · 2015-07-22T18:11:20Z

@kaspth Thank you for the suggestions -- I'll implement them this evening!

kaspth · 2015-07-22T18:12:03Z

railties/lib/rails/commands/server.rb

@@ -67,6 +69,7 @@ def start
      print_boot_information
      trap(:INT) { exit }
      create_tmp_directories
+      create_cache_file if options[:cache]


It seems like setting --perform-caching once never removes the file and leaves caching on all the time. Let's fix that 😄

ccallebs · 2015-07-23T01:34:02Z

@kaspth I implemented most of your suggestions. Instead of having a --toggle-cache option on the server, I chose to remove caching if the option wasn't specified. It made more sense to me that way, as a user will know when they start their server whether or not they would like to temporarily cache.

dhh · 2015-07-23T09:47:43Z

Awesome. Thanks for working on this!

kaspth · 2015-07-25T13:06:54Z

railties/CHANGELOG.md

@@ -1,3 +1,11 @@
+*   Make enabling or disabling caching in development mode possible with rake dev:cache
+
+    Running rake dev:cache will create or remove tmp/caching-dev.txt. When this file exists config.action_controller.perform_caching will be set to true in config/environments/development.rb.


Break the lines at 80 chars 😄

kaspth · 2015-07-25T13:10:05Z

Alright, once the final comment has been addressed, ping me. Remember to keep it to one commit, then I'll gladly merge 😁

kaspth · 2015-07-25T13:28:50Z

I just realized there's a scenario we have to make sure doesn't happen. Maybe I'm misunderstanding something, but what happens when rake dev:cache reboots the server?

There's no --perform-caching flag provided, so won't the caching be turned off again?

I'd like a test that checks against this.

ccallebs · 2015-07-27T02:27:49Z

@kaspth That's a good point! I'll write the test and if it fails find a workaround.

ccallebs · 2015-07-30T02:10:47Z

@kaspth The easiest way to fix the above is just by defaulting the server to create the cache file if options are passed. Otherwise, default to the last rake dev:cache command. I've pushed the changes up.

Additionally, I couldn't find any concrete examples of tests that check the server start. Could you point me toward some (if they exist)?

kaspth · 2015-07-30T19:50:07Z

Honestly, that --perform-caching setting doesn't make sense anymore. If I passed an option on one server start and then removed it for the next server start I wouldn't expect it to still be in effect.

Looking back to @pixeltrix's original suggestion I see --perform-caching takes an argument, which is exactly how we should do it.

Perhaps --perform-caching=true to enable and --perform-caching=false to disable could do it. There's probably a separate issue with what values can be truthy and falsy on a command line interface, but we can deal with that later.

kaspth · 2015-07-30T19:51:23Z

@ccallebs Sorry, I'm not aware of any tests checking the server start.

kaspth · 2015-08-04T20:04:37Z

@ccallebs are you up for adding an argument to --perform-caching as mentioned here: #20961 (comment)?

ccallebs · 2015-08-04T20:06:50Z

@kaspth Absolutely! Sorry, I've been busy and haven't been able to sit down and do it. I'll try to tackle it this evening.

kaspth · 2015-08-04T20:07:43Z

Cool, glad to hear it 😄

@Sonopa

Taken from @Sonopa's commits on PR #19091. Add support for dev caching via "rails s" flags. Implement suggestions from @kaspth. Remove temporary cache file if server does not have flags. Break at 80 characters in railties/CHANGELOG.md Remove ability to disable cache based on server options. Add more comprehensive options: --dev-caching / --no-dev-caching

ccallebs · 2015-08-05T03:55:06Z

@kaspth After looking at the OptionParser documentation, I ended up changing the name of the keyword. (http://docs.ruby-lang.org/en/2.2.0/OptionParser.html)

Now, it would be rails s --dev-caching or rails s --no-dev-caching. It seemed to be the way to define boolean arguments according to that class. If we want to change it to perform-caching=[true|false] I'm completely fine with that, but it looked like this followed OptionParser conventions more closely.

Add dev caching toggle / server options

kaspth · 2015-08-05T19:38:11Z

@ccallebs Thanks ❤️

On a new Rails app, [`config/development.rb`](https://github.com/rails/rails/blob/master/railties/lib/rails/generators/rails/app/templates/config/environments/development.rb.tt#L19) is set up to support [`rails dev:cache`](rails#20961). This PR explains how to enable caching in development in https://guides.rubyonrails.org/caching_with_rails.html, replacing the old advice that looks like it came before rails#20961.

sdhull · 2021-11-10T20:40:04Z

Apologies for resurrecting an ancient PR thread but... wouldn't it make more sense to have the task called rails dev:toggle-cache or something like that? I was assuming rails dev:cache would turn on caching and I came looking for a way to turn it off (rails dev:nocache or something).

ccallebs reviewed Jul 21, 2015
View reviewed changes

kaspth reviewed Jul 22, 2015
View reviewed changes

kaspth reviewed Jul 25, 2015
View reviewed changes

kaspth added a commit that referenced this pull request Aug 5, 2015

Merge pull request #20961 from ccallebs/add-dev-mode-caching

2d00aa7

Add dev caching toggle / server options

kaspth merged commit 2d00aa7 into rails:master Aug 5, 2015

ccallebs deleted the add-dev-mode-caching branch August 5, 2015 21:13

magikid mentioned this pull request Dec 18, 2015

Add rake dev:cache task to enable development mode caching #19091

Closed

ghiculescu mentioned this pull request Dec 23, 2020

Mention rails dev:cache in Caching with Rails guide [ci skip] [docs] #40919

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add dev caching toggle / server options #20961

Add dev caching toggle / server options #20961

ccallebs commented Jul 21, 2015

ccallebs Jul 21, 2015

kaspth Jul 22, 2015

ccallebs Jul 22, 2015

kaspth commented Jul 22, 2015

ccallebs commented Jul 22, 2015

kaspth Jul 22, 2015

ccallebs commented Jul 23, 2015

dhh commented Jul 23, 2015

kaspth Jul 25, 2015

kaspth commented Jul 25, 2015

kaspth commented Jul 25, 2015

ccallebs commented Jul 27, 2015

ccallebs commented Jul 30, 2015

kaspth commented Jul 30, 2015

kaspth commented Jul 30, 2015

kaspth commented Aug 4, 2015

ccallebs commented Aug 4, 2015

kaspth commented Aug 4, 2015

ccallebs commented Aug 5, 2015

kaspth commented Aug 5, 2015

sdhull commented Nov 10, 2021

		@@ -1,3 +1,11 @@
		* Make enabling or disabling caching in development mode possible with rake dev:cache

		Running rake dev:cache will create or remove tmp/caching-dev.txt. When this file exists config.action_controller.perform_caching will be set to true in config/environments/development.rb.

Add dev caching toggle / server options #20961

Add dev caching toggle / server options #20961

Conversation

ccallebs commented Jul 21, 2015

ccallebs Jul 21, 2015

Choose a reason for hiding this comment

kaspth Jul 22, 2015

Choose a reason for hiding this comment

ccallebs Jul 22, 2015

Choose a reason for hiding this comment

kaspth commented Jul 22, 2015

ccallebs commented Jul 22, 2015

kaspth Jul 22, 2015

Choose a reason for hiding this comment

ccallebs commented Jul 23, 2015

dhh commented Jul 23, 2015

kaspth Jul 25, 2015

Choose a reason for hiding this comment

kaspth commented Jul 25, 2015

kaspth commented Jul 25, 2015

ccallebs commented Jul 27, 2015

ccallebs commented Jul 30, 2015

kaspth commented Jul 30, 2015

kaspth commented Jul 30, 2015

kaspth commented Aug 4, 2015

ccallebs commented Aug 4, 2015

kaspth commented Aug 4, 2015

ccallebs commented Aug 5, 2015

kaspth commented Aug 5, 2015

sdhull commented Nov 10, 2021