dockerfile-rails 1.2.5 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f8b3176721310f5c043a7c2642f12b59fa7bc2952fb73f6e6164d199d24bc5a
-  data.tar.gz: 995b15167890754208baef9bc6ff48613e8cef121083f8d70c1be77593b5beb4
+  metadata.gz: 8780a8a7015d339452edf4dff330981a748ad72c72081e0cfa473c835121637c
+  data.tar.gz: ab37e68fe9d3f82f9368e45738a12f171eaaabcff8b311451d89bdbce1217d95
 SHA512:
-  metadata.gz: 7f05f65f85a29fcfc242682ab6464adb88f9e0725fffe1c65c192c342e12444c3dbaff9f855ff28ccb94ea13fa706918b71609af06a87673007407083e77dd2c
-  data.tar.gz: 5bcca34771c67bf29e28be9a0342fbd9dac8a13694f3416d0b27a2070cabf0e38017ed195ecf2b1a80a03150698cb62502e73d63ec603500bb927fa627cd73aa
+  metadata.gz: 8a1bce2d42a5916ae7bf4cc49f23d0b9077533e1447015f35bfd4835397438a8bb4bc13e48a774a7e80130cf0f99dada597fda1fa0cada1674e52073d7846fc1
+  data.tar.gz: 9793fdc06ffe7a84a1e0f40282570ea5e4ad6e08514ff8210f805254a093208cc4b98f683c44fce299dc0b71ff04c2418b847c5e33f05da407cefd617412521b

data/DEMO.md

@@ -132,7 +132,7 @@ docker compose up
 # Demo 4 - API only
 
 This demo deploys a [Create React App](https://create-react-app.dev/) client and a Rails API-only server.  Ruby and Rails version information is retrieved from the server and displayed below a spinning React logo.  Note that the build process installs the
-node moddules and ruby gems in parallel.
+node modules and ruby gems in parallel.
 
 ```bash
 rails new demo --api

data/README.md

@@ -40,6 +40,7 @@ bin/rails generate dockerfile
 
 * `--ci` - include test gems in deployed image
 * `--compose` - generate a `docker-compose.yml` file
+* `--max-idle=n` - exit afer *n* seconds of inactivity.  Supports [iso 8601](https://en.wikipedia.org/wiki/ISO_8601#Durations) and [sleep](https://man7.org/linux/man-pages/man1/sleep.1.html#DESCRIPTION) syntaxes.  Uses passenger for now, awaiting [puma](https://github.com/puma/puma/issues/2580) support.
 * `--nginx` - serve static files via [nginx](https://www.nginx.com/).  May require `--root` on some targets to access `/dev/stdout`
 * `--no-link` - don't add [--link](https://docs.docker.com/engine/reference/builder/#copy---link) to COPY statements.  Some tools (like at the moment, [buildah](https://www.redhat.com/en/topics/containers/what-is-buildah)) don't yet support this feature.
 * `--no-lock` - don't add linux platforms, set `BUNDLE_DEPLOY`, or `--frozen-lockfile`.  May be needed at times to work around a [rubygems bug](https://github.com/rubygems/rubygems/issues/6082#issuecomment-1329756343).
@@ -65,16 +66,18 @@ Not all of your needs can be determined by scanning your application.  For examp
  * `--env=name:value` - add an environment variable
  * `--remove package...` - remove package from "to be added" list
 
- Each of these can be tailored to a specific build phase by adding `-base`, `-build`, or `-deploy` after the flag name (e.g `--env-build:`).  If no such suffix is found, the default for arg is `-base`, and the default for the rest is `-deploy`.  Removal of an arg or environment variable is done by leaving the value blank.
+ Each of these can be tailored to a specific build phase by adding `-base`, `-build`, or `-deploy` after the flag name (e.g `--add-build freetds-dev --add-deploy freetds-bin`).  If no such suffix is found, the default for arg is `-base`, and the default for the rest is `-deploy`.  Removal of an arg or environment variable is done by leaving the value blank (e.g `--env-build=PORT:`).
 
 ### Configuration:
 
 * `--bin-cd` - adjust binstubs to set current working directory
+[autocrlf](https://git-scm.com/book/en/v2/Customizing-Git-Git-Configuration#_core_autocrlf) enabled or may not be able to set bin stubs as executable.
 * `--label=name:value` - specify docker label.  Can be used multiple times.  See [LABEL](https://docs.docker.com/engine/reference/builder/#label) for detail
 * `--no-prepare` - omit `db:prepare`.  Useful for cloud platforms with [release](https://devcenter.heroku.com/articles/release-phase) phases
 * `--platform=s` - specify target platform.  See [FROM](https://docs.docker.com/engine/reference/builder/#from) for details
 * `--precompile=defer` - may be needed when your configuration requires access to secrets that are not available at build time.  Results in larger images and slower deployments.
 * `--root` - run application as root
+* `--windows` - make Dockerfile work for Windows users that may have set `git config --global core.autocrlf true`
 
 Options are saved between runs into `config/dockerfile.yml`.  To invert a boolean options, add or remove a `no-` prefix from the option name.
 
@@ -118,3 +121,7 @@ The following links relate to the current development status with respect to Rai
 * Fly.io [Cut over to Rails Dockerfile Generator on Sunday 29 Jan 2023](https://community.fly.io/t/cut-over-to-rails-dockerfile-generator-on-sunday-29-jan-2023/10350)
 * Fly.io [FAQ](https://fly.io/docs/rails/getting-started/dockerfiles/)
 * DDH's [target](https://github.com/rails/rails/pull/47372#issuecomment-1438971730)
+
+Parallel efforts for Hanami:
+
+* [Proposal](https://discourse.hanamirb.org/t/dockerfile-hanami/816)

data/Rakefile

@@ -39,7 +39,7 @@ namespace :test do
       sh "docker run -p 3000:3000 -e RAILS_MASTER_KEY=#{key} --rm system:test"
     end
   ensure
-    rm_rf "test/tmp/system_test"
+    rm_rf "test/tmp/system_test" unless ENV["TEST_KEEP"]
   end
 
   task all: %w(test:rubocop test test:system)

data/lib/generators/dockerfile_generator.rb

@@ -16,9 +16,11 @@ class DockerfileGenerator < Rails::Generators::Base
     "label" => {},
     "link" => true,
     "lock" => true,
+    "max-idle" => nil,
     "mysql" => false,
     "nginx" => false,
     "parallel" => false,
+    "passenger" => false,
     "platform" => nil,
     "postgresql" => false,
     "precompile" => nil,
@@ -28,6 +30,7 @@ class DockerfileGenerator < Rails::Generators::Base
     "sqlite3" => false,
     "sudo" => false,
     "swap" => nil,
+    "windows" => false,
     "yjit" => false,
   }.then { |hash| Struct.new(*hash.keys.map(&:to_sym)).new(*hash.values) }
 
@@ -84,6 +87,9 @@ class DockerfileGenerator < Rails::Generators::Base
   class_option "bin-cd", type: :boolean, default: OPTION_DEFAULTS["bin-cd"],
     desc: "modify binstubs to set working directory"
 
+  class_option "windows", type: :boolean, default: OPTION_DEFAULTS["windows"],
+    desc: "fixup CRLF in binstubs and make each executable"
+
   class_option :cache, type: :boolean, default: OPTION_DEFAULTS.cache,
     desc: "use build cache to speed up installs"
 
@@ -129,6 +135,12 @@ class DockerfileGenerator < Rails::Generators::Base
   class_option :nginx, type: :boolean, default: OPTION_DEFAULTS.nginx,
     desc: "Serve static files with nginx"
 
+  class_option :passenger, type: :boolean, default: OPTION_DEFAULTS.passenger,
+    desc: "Serve Rails application with Phusion Passsenger"
+
+  class_option "max-idle", type: :string, default: OPTION_DEFAULTS["max-idle"],
+    desc: "Exit server after application has been idle for n seconds."
+
   class_option :root, type: :boolean, default: OPTION_DEFAULTS.root,
     desc: "Run application as root user"
 
@@ -290,6 +302,17 @@ private
   end
 
   def using_redis?
+    # Note: If you have redis installed on your computer, 'rails new` will
+    # automatically add redis to your Gemfile, so having it in your Gemfile is
+    # not a reliable indicator of whether or not your application actually uses
+    # redis.
+
+    # using_redis? is currently used for two things: actually adding the redis
+    # gem if it is going to be needed in production, and adding a redis
+    # container to docker-compose.yml. Neither of these actions should be done
+    # unless there is an indication that redis is actually being used and not
+    # merely included in the Gemfile.
+
     options.redis? or @redis or @gemfile.include?("sidekiq")
   end
 
@@ -301,6 +324,10 @@ private
     @gemfile.include?("grover") or @gemfile.include?("puppeteer-ruby")
   end
 
+  def using_passenger?
+    options.passenger? or options["max-idle"]
+  end
+
   def using_sidekiq?
     @gemfile.include?("sidekiq")
   end
@@ -369,7 +396,9 @@ private
     gems = ["bundler"]
 
     if options.ci? && options.lock? && @gemfile.include?("debug")
-      gems += %w(irb reline) - @gemfile
+      # https://github.com/rails/rails/pull/47515
+      # https://github.com/rubygems/rubygems/issues/6082#issuecomment-1329756343
+      gems += %w(irb reline) - @gemfile unless Gem.ruby_version >= "3.2.2"
     end
 
     gems.sort
@@ -391,7 +420,6 @@ private
     # libicu63 in buster, libicu67 in bullseye, libiclu72 in bookworm...
     packages << "libicu-dev" if @gemfile.include? "charlock_holmes"
 
-
     if @gemfile.include? "webp-ffi"
       # https://github.com/le0pard/webp-ffi#requirements
       packages += %w(libjpeg-dev libpng-dev libtiff-dev libwebp-dev)
@@ -464,7 +492,8 @@ private
     # start with databases: sqlite3, postgres, mysql
     packages << "libsqlite3-0" if options.sqlite3? || @sqlite3
     packages << "postgresql-client" if options.postgresql? || @postgresql
-    packages << "default-mysql-client" if options.mysql || @mysql
+    packages << "default-mysql-client" if options.mysql? || @mysql
+    packages << "libjemalloc2" if options.jemalloc? && !options.fullstaq?
 
     # ActiveStorage preview support
     packages << "libvips" if @gemfile.include? "ruby-vips"
@@ -483,8 +512,11 @@ private
       end
     end
 
+    # Passenger
+    packages += %w(passenger libnginx-mod-http-passenger) if using_passenger?
+
     # nginx
-    packages << "nginx" if options.nginx?
+    packages << "nginx" if options.nginx? || using_passenger?
 
     # sudo
     packages << "sudo" if options.sudo?
@@ -494,18 +526,35 @@ private
 
   def deploy_repos
     repos = []
+    packages = []
 
     if using_puppeteer? && deploy_packages.include?("google-chrome-stable")
+      packages += %w(gnupg curl)
       repos += [
-       "curl https://dl-ssl.google.com/linux/linux_signing_key.pub |",
-       "gpg --dearmor > /etc/apt/trusted.gpg.d/google-archive.gpg &&",
+       "curl https://oss-binaries.phusionpassenger.com/auto-software-signing-gpg-key.txt |",
+       "  gpg --dearmor > /etc/apt/trusted.gpg.d/google-archive.gpg &&",
        'echo "deb http://dl.google.com/linux/chrome/deb/ stable main" >> /etc/apt/sources.list.d/google.list'
       ]
     end
 
+    if using_passenger?
+      packages += %w(gnupg curl)
+      repos += [
+       "curl https://oss-binaries.phusionpassenger.com/auto-software-signing-gpg-key.txt |",
+       "  gpg --dearmor > /etc/apt/trusted.gpg.d/phusion.gpg &&",
+       "bash -c 'echo deb https://oss-binaries.phusionpassenger.com/apt/passenger $(source /etc/os-release; echo $VERSION_CODENAME) main > /etc/apt/sources.list.d/passenger.list'"
+      ]
+    end
+
     if repos.empty?
       ""
     else
+      packages.sort!.uniq!
+      unless packages.empty?
+        repos.unshift "apt-get update -qq &&",
+          "apt-get install --no-install-recommends -y #{packages.join(" ")} &&"
+      end
+
       repos.join(" \\\n    ") + " && \\\n    "
     end
   end
@@ -552,7 +601,7 @@ private
   def deploy_env
     env = {}
 
-    env["PORT"] = "3001" if options.nginx?
+    env["PORT"] = "3001" if options.nginx? && !using_passenger?
 
     if Rails::VERSION::MAJOR < 7 || Rails::VERSION::STRING.start_with?("7.0")
       env["RAILS_LOG_TO_STDOUT"] = "1"
@@ -563,7 +612,7 @@ private
       env["RUBY_YJIT_ENABLE"] = "1"
     end
 
-    if options.jemalloc? && (not options.fullstaq?)
+    if options.jemalloc? && !options.fullstaq?
       if (options.platform || Gem::Platform.local.cpu).include? "arm"
         env["LD_PRELOAD"] = "/usr/lib/aarch64-linux-gnu/libjemalloc.so.2"
       else
@@ -648,13 +697,13 @@ private
     # none are required, but prepares for the need to do the
     # fix line endings if other fixups are required.
     has_cr = Dir["bin/*"].any? { |file| IO.read(file).include? "\r" }
-    if has_cr || (Gem.win_platform? && !binfixups.empty?)
+    if has_cr || (Gem.win_platform? && !binfixups.empty?) || options.windows?
       binfixups.unshift 'sed -i "s/\r$//g" bin/*'
     end
 
     # Windows file systems may not have the concept of executable.
     # In such cases, fix up during the build.
-    unless Dir["bin/*"].all? { |file| File.executable? file }
+    if Dir["bin/*"].any? { |file| !File.executable?(file) } || options.windows?
       binfixups.unshift "chmod +x bin/*"
     end
 
@@ -669,7 +718,7 @@ private
   def deploy_database
     if options.postgresql? || @postgresql
       "postgresql"
-    elsif options.mysql || @mysql
+    elsif options.mysql? || @mysql
       "mysql"
     else
       "sqlite3"
@@ -758,7 +807,11 @@ private
   end
 
   def procfile
-    if options.nginx?
+    if using_passenger?
+      {
+        nginx: "nginx"
+      }
+    elsif options.nginx?
       {
         nginx: '/usr/sbin/nginx -g "daemon off;"',
         rails: "./bin/rails server -p 3001"
@@ -782,4 +835,22 @@ private
 
     more
   end
+
+  def max_idle
+    option = options["max-idle"]
+
+    if option == nil || option.strip.downcase == "infinity"
+      nil
+    elsif /^\s*\d+(\.\d+)\s*/.match? option
+      option.to_f
+    elsif /^\s*P/.match? option
+      ActiveSupport::Duration.parse(option.strip).seconds
+    else
+      option.scan(/\d+\w/).map do |t|
+        ActiveSupport::Duration.parse("PT#{t.upcase}") rescue ActiveSupport::Duration.parse("P#{t.upcase}")
+      end.sum.seconds
+    end
+  rescue ArgumentError
+    nil
+  end
 end

data/lib/generators/templates/Dockerfile.erb

@@ -145,37 +145,46 @@ ARG <%= deploy_args.map {|key, value| "#{key}=#{value.inspect}"}.join(" \\\n
 <%= render partial: 'apt_install', locals: {packages: deploy_packages, clean: true, repos: deploy_repos} %>
 <% end -%>
 
-<% if options.nginx? -%>
+<% if using_passenger? -%>
+<%= render partial: 'passenger' %>
+
+<% elsif options.nginx? -%>
 <%= render partial: 'nginx' %>
 
 <% elsif procfile.size > 1 -%>
 RUN gem install foreman
 
+<% end -%>
+<% unless options.precompile == "defer" -%>
+# Copy built artifacts: gems, application
+COPY --from=build /usr/local/bundle /usr/local/bundle
+COPY --from=build /rails /rails
+<% if api_client_dir -%>
+
+# Copy built client
+COPY --from=client /rails/<%= api_client_dir %>/build /rails/public
+<% end -%>
+
 <% end -%>
 <% unless run_as_root? -%>
-# Run and own the application files as a non-root user for security
+# Run and own only the runtime files as a non-root user for security
 <% if options.compose? -%>
 ARG UID=1000 \
     GID=1000
 RUN groupadd -f -g $GID rails && \
-    useradd -u $UID -g $GID rails<% else -%>
-RUN useradd rails<% end -%> --home /rails --shell /bin/bash<% if options.nginx? %> && \
-    chown rails:rails /var/lib/nginx /var/log/nginx/*<% end %><% if deploy_packages.include?("sudo") && options.sudo? %> && \
-    sed -i 's/env_reset/env_keep="*"/' /etc/sudoers && \
-    chown rails:rails .<% end %>
-<% unless options.swap -%>
-USER rails:rails
+    useradd -u $UID -g $GID rails --create-home --shell /bin/bash && \
+<% else -%>
+RUN useradd rails --create-home --shell /bin/bash && \
 <% end -%>
-
+<% if options.nginx? -%>
+    chown rails:rails /var/lib/nginx /var/log/nginx/* && \
 <% end -%>
-<% unless options.precompile == "defer" -%>
-# Copy built artifacts: gems, application
-COPY --from=build /usr/local/bundle /usr/local/bundle
-COPY --from=build <% unless run_as_root? %>--chown=rails:rails <% end %>/rails /rails
-<% if api_client_dir -%>
-
-# Copy built client
-COPY --from=client <% unless run_as_root? %>--chown=rails:rails <% end %>/rails/<%= api_client_dir %>/build /rails/public
+<% if deploy_packages.include?("sudo") && options.sudo? -%>
+    sed -i 's/env_reset/env_keep="*"/' /etc/sudoers && \
+<% end -%>
+    chown -R rails:rails <%= Dir[*%w(db log storage tmp)].join(" ") %>
+<% unless options.swap? or using_passenger? -%>
+USER rails:rails
 <% end -%>
 
 <% end -%>
@@ -205,5 +214,5 @@ CMD ["foreman", "start", "--procfile=Procfile.prod"]
 <% else -%>
 # Start the server by default, this can be overwritten at runtime
 EXPOSE 3000
-CMD ["./bin/rails", "server"]
+CMD <%= procfile.values.first.split(" ").inspect %>
 <% end -%>

data/lib/generators/templates/_passenger.erb

@@ -0,0 +1,28 @@
+# configure nginx and passenger
+COPY <<-'EOF' /etc/nginx/sites-enabled/default
+server {
+    listen 3000;
+    root /rails/public;
+    passenger_enabled on;
+<% if options['max-idle'] -%>
+    passenger_ctl hook_detached_process /etc/nginx/hook_detached_process;
+    passenger_min_instances 0;
+    passenger_pool_idle_time <%= max_idle %>;
+<% end -%>
+}
+<% if options['max-idle'] -%>
+COPY <<-'EOF' /etc/nginx/sites-enabled/hook_detached_process
+#!/usr/bin/env ruby
+status = `passenger-status`
+processes = status[/^Processes\s*:\s*(\d*)/, 1].to_i
+system 'nginx -s stop' if processes == 0
+EOF
+<% end -%>
+EOF
+RUN echo "daemon off;" >> /etc/nginx/nginx.conf && \
+    sed -i 's/access_log\s.*;/access_log \/dev\/stdout;/' /etc/nginx/nginx.conf && \
+    sed -i 's/error_log\s.*;/error_log \/dev\/stderr info;/' /etc/nginx/nginx.conf && \
+<% if options['max-idle'] -%>
+    chmod +sx /etc/nginx/sites-enabled/hook_detached_process && \
+<% end -%>
+    mkdir /var/run/passenger-instreg

data/lib/generators/templates/docker-entrypoint.erb

@@ -1,7 +1,7 @@
 #!/bin/bash -e
 
 <% if options.swap -%>
-<% if run_as_root? -%>
+<% if run_as_root? or using_passenger? -%>
 <% @space = "" -%>
 <% else -%>
 <% @space = "  " -%>
@@ -14,7 +14,7 @@ if [ $UID -eq 0 ]; then
 <%= @space %>echo 10 > /proc/sys/vm/swappiness
 <%= @space %>swapon /swapfile
 <%= @space %>echo 1 > /proc/sys/vm/overcommit_memory
-<% unless run_as_root? -%>
+<% unless run_as_root? or using_passenger? -%>
   exec su rails $0 $@
 fi
 <% end -%>
@@ -26,7 +26,7 @@ fi
 if [ "${*}" == "foreman start --procfile=Procfile.prod" ]; then
 <% else -%>
 # If running the rails server then create or migrate existing database
-if [ "${*}" == "./bin/rails server" ]; then
+if [ "${*}" == <%= procfile.values.first.inspect %> ]; then
 <% end -%>
 <% if options.precompile == "defer" -%>
   ./bin/rails assets:precompile

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dockerfile-rails
 version: !ruby/object:Gem::Version
-  version: 1.2.5
+  version: 1.3.0
 platform: ruby
 authors:
 - Sam Ruby
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-05 00:00:00.000000000 Z
+date: 2023-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -44,6 +44,7 @@ files:
 - lib/generators/templates/_nginx.erb
 - lib/generators/templates/_node_client.erb
 - lib/generators/templates/_npm_install.erb
+- lib/generators/templates/_passenger.erb
 - lib/generators/templates/docker-compose.yml.erb
 - lib/generators/templates/docker-entrypoint.erb
 - lib/generators/templates/dockerfile.yml.erb
@@ -69,7 +70,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.4.8
 signing_key:
 specification_version: 4
 summary: Dockerfile generator for Rails