dockerfile-rails 1.6.25 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 749745baff7e3b0f67b72f9f94c2df9086c344c9665e2d67498c02c33cfbcbab
-  data.tar.gz: 1b62d4bcf87fd0872057ee0e796b8f529a3b29b811e13447e7ac7df60961ab80
+  metadata.gz: 8309aa1e1fe7194297188df68c64c458d2fc7e892c0d4b0c0dadc9fe9b1d3a6e
+  data.tar.gz: c0d684a6bde26b27aa40c12e8cdd24bbdbd15d220258f48468ac6d4780fd15d3
 SHA512:
-  metadata.gz: a88d05eac975d08d6ad47766300a996740c56e7a273488c7ec4e3f59729841d3edf132d91740a82410b7e60aff8017fb5aeabd15095b7ea0673f3088d08dd49f
-  data.tar.gz: b78e868ec797f8c2bdb01e0afc7214e60b7a134414a06b15cc2151e8fcee62e6a59cfcbdde6898af22bb38a3742f4af433187b0e3aaa323c6dd85f956df3f012
+  metadata.gz: 0444b3658976d0b1f3e363848616a0774886e24a4c156daf0102f40c983ecb902f927af387be92c0f91447fad2c521a8ea1e378ca799d0a967400f8ffadc8ada
+  data.tar.gz: b174840c7d365257c77f706d82ac979a231d2cb91c633fcc79e2806f9deaa4ccdf1818e389bd2c6d9d115e978bb823f97ff091f9344f75121cd5ef0025441ace

data/README.md

@@ -67,6 +67,7 @@ are actually using.  But should you be using DATABASE_URL, for example, at runti
 additional support may be needed:
 
 * `--litefs` - use [LiteFS](https://fly.io/docs/litefs/)
+* `--litestream` - use [LiteFS](https://litestream.io/)
 * `--mysql` - add mysql libraries
 * `--postgresql` - add postgresql libraries
 * `--redis` - add redis libraries

data/lib/generators/dockerfile_generator.rb

@@ -2,6 +2,7 @@
 
 require "erb"
 require "json"
+require "shellwords"
 require_relative "../dockerfile-rails/scanner.rb"
 
 class DockerfileGenerator < Rails::Generators::Base
@@ -15,10 +16,11 @@ class DockerfileGenerator < Rails::Generators::Base
     "compose" => false,
     "fullstaq" => false,
     "gemfile-updates" => true,
-    "jemalloc" => false,
+    "jemalloc" => true,
     "label" => {},
     "link" => false,
     "litefs" => false,
+    "litestream" => false,
     "lock" => true,
     "max-idle" => nil,
     "migrate" => "",
@@ -74,7 +76,8 @@ class DockerfileGenerator < Rails::Generators::Base
     "node-gyp" => "gyp",
     "pkg-config" => "pkgconfig",
     "python" => "python3",
-    "python-is-python3" => "python3"
+    "python-is-python3" => "python3",
+    "sqlite3" => "sqlite",
   }
 
   # load defaults from config file
@@ -162,6 +165,9 @@ class DockerfileGenerator < Rails::Generators::Base
   class_option :litefs, type: :boolean, default: OPTION_DEFAULTS.litefs,
     desc: "replicate sqlite3 databases using litefs"
 
+  class_option :litestream, type: :boolean, default: OPTION_DEFAULTS.litestream,
+    desc: "replicate sqlite3 databases using litesream"
+
   class_option :tigris, type: :boolean, default: OPTION_DEFAULTS.tigris,
     desc: "configure active storage to use tigris"
 
@@ -346,6 +352,10 @@ class DockerfileGenerator < Rails::Generators::Base
       fly_attach_consul
     end
 
+    if using_litestream?
+      template "litestream.rake.erb", "lib/tasks/litestream.rake"
+    end
+
     if File.exist?("fly.toml") && (fly_processes || !options.prepare || options.swap || deploy_database == "sqlite3")
       if File.stat("fly.toml").size > 0
         template "fly.toml.erb", "fly.toml"
@@ -488,6 +498,10 @@ private
     @gemfile.include?("litestack")
   end
 
+  def using_litestream?
+    options.litestream?
+  end
+
   def using_node?
     return @using_node if @using_node != nil
     return if using_bun?
@@ -594,6 +608,10 @@ private
       system "bundle add mysql2 --skip-install" unless has_mysql_gem?
     end
 
+    if options.litestream?
+      system "bundle add litestream --skip-install" unless @gemfile.include? "litestream"
+    end
+
     if options.redis? || using_redis?
       system "bundle add redis --skip-install" unless @gemfile.include? "redis"
     end
@@ -662,19 +680,30 @@ private
   end
 
   def base_packages
-    packages = []
+    packages = %w(curl) # work with the default healthcheck strategy in Kamal
     packages += @@packages["base"] if @@packages["base"]
 
+    packages << "libjemalloc2" if options.jemalloc? && !options.fullstaq?
+
+    # start with databases: sqlite3, postgres, mysql
+    packages << "postgresql-client" if options.postgresql? || @postgresql
+    packages << "default-mysql-client" if options.mysql? || @mysql
+    packages << "freetds-bin" if options.sqlserver? || @sqlserver
+    if options.sqlite3? || @sqlite3
+      packages << "sqlite3" unless packages.include? "sqlite3"
+    end
+
+    # ActiveStorage preview support
+    packages << "libvips" if @gemfile.include? "ruby-vips"
+
     if using_execjs?
       if node_version == "lts"
         packages += %w(nodejs npm)
-      else
-        packages += %w(curl)
       end
     end
 
     if using_puppeteer?
-      packages += %w(curl gnupg)
+      packages += %w(gnupg)
     end
 
     # charlock_holmes.  Placed here as the library itself is
@@ -725,9 +754,6 @@ private
     # add git if needed to install gems
     packages << "git" if @git
 
-    # ActiveStorage preview support
-    packages << "libvips" if @gemfile.include? "ruby-vips"
-
     # Rmagick gem
     packages += %w[pkg-config libmagickwand-dev] if @gemfile.include? "rmagick"
 
@@ -736,7 +762,7 @@ private
       packages += %w(node-gyp pkg-config)
 
       unless using_execjs? || using_puppeteer?
-        packages << "curl"
+        # packages << "curl"
       end
 
       # module build process depends on Python, and debian changed
@@ -762,7 +788,7 @@ private
     end
 
     if using_bun?
-      packages += %w(curl unzip)
+      packages += %w(unzip)
     end
 
     if options.alpine?
@@ -773,18 +799,9 @@ private
   end
 
   def deploy_packages
-    packages = %w(curl) # work with the default healthcheck strategy in MRSK
+    packages = []
     packages += @@packages["deploy"] if @@packages["deploy"]
 
-    # start with databases: sqlite3, postgres, mysql
-    packages << "postgresql-client" if options.postgresql? || @postgresql
-    packages << "default-mysql-client" if options.mysql? || @mysql
-    packages << "freetds-bin" if options.sqlserver? || @sqlserver
-    packages << "libjemalloc2" if options.jemalloc? && !options.fullstaq?
-    if options.sqlite3? || @sqlite3
-      packages << "libsqlite3-0" unless packages.include? "sqlite3"
-    end
-
     # litefs
     packages += ["ca-certificates", "fuse3", "sudo"] if options.litefs?
 
@@ -865,7 +882,7 @@ private
     packages = []
 
     if using_passenger?
-      packages += %w(gnupg curl)
+      packages += %w(curl gnupg)
       repos += [
        "curl https://oss-binaries.phusionpassenger.com/auto-software-signing-gpg-key.txt |",
        "  gpg --dearmor > /etc/apt/trusted.gpg.d/phusion.gpg &&",
@@ -891,7 +908,7 @@ private
     packages = []
 
     if using_puppeteer? && deploy_packages.include?("google-chrome-stable")
-      packages += %w(gnupg curl)
+      packages += %w(gnupg)
       repos += [
        "curl https://dl-ssl.google.com/linux/linux_signing_key.pub |",
        "  gpg --dearmor > /etc/apt/trusted.gpg.d/google-archive.gpg &&",
@@ -979,8 +996,8 @@ private
     end
 
     if options.jemalloc? && !options.fullstaq?
-      env["LD_PRELOAD"] = "libjemalloc.so.2"
-      env["MALLOC_CONF"] = "dirty_decay_ms:1000,narenas:2,background_thread:true"
+      # env["LD_PRELOAD"] = "libjemalloc.so.2"
+      # env["MALLOC_CONF"] = "dirty_decay_ms:1000,narenas:2,background_thread:true"
     end
 
     if using_puppeteer?
@@ -1133,6 +1150,30 @@ private
     end
   end
 
+  def start_command
+    if !options.procfile.blank?
+      ["foreman", "start", "--procfile=#{options.procfile}"]
+    elsif procfile.size > 1
+      ["foreman", "start", "--procfile=Procfile.prod"]
+    else
+      command = Shellwords.split(procfile.values.first)
+
+      if command.first == "./bin/thrust"
+        command[1..]
+      else
+        command
+      end
+    end
+  end
+
+  def shellescape(string)
+    if %r{\A[-\w._/= ]+\z}.match?(string)
+      string.inspect
+    else
+      Shellwords.escape(string)
+    end
+  end
+
   def node_version
     return unless using_node? || using_execjs?
 
@@ -1252,6 +1293,10 @@ private
       }
     end
 
+    if using_litestream? && base[:rails]
+      base[:rails] = "./bin/rake litestream:run " + base[:rails]
+    end
+
     if solidq_launcher == :procfile
       base["solidq"] = "bundle exec rake solid_queue:start"
     end
@@ -1263,6 +1308,10 @@ private
     options.thruster? || @gemfile.include?("thruster")
   end
 
+  def using_kamal?
+    @gemfile.include?("kamal")
+  end
+
   def fly_processes
     return unless File.exist? "fly.toml"
     return unless using_sidekiq? || using_solidq? || using_thruster?
@@ -1468,6 +1517,10 @@ private
         list[primary] = list[primary].sub(/^.*thrust /, "")
       end
 
+      if using_litestream? && list["app"]
+        list["app"] = "./bin/rake litestream:run #{list["app"]}"
+      end
+
       if toml.include? "[processes]"
         toml.sub!(/\[processes\].*?(\n\n|\n?\z)/m, "[processes]\n" +
           list.map { |name, cmd| "  #{name} = #{cmd.inspect}" }.join("\n") + '\1')

data/lib/generators/templates/Dockerfile.erb

@@ -1,6 +1,15 @@
-# syntax = docker/dockerfile:1
+# syntax=docker/dockerfile:1
+# check=error=true
+<% if using_kamal? -%>
 
-# Make sure RUBY_VERSION matches the Ruby version in .ruby-version and Gemfile
+# This Dockerfile is designed for production, not development. Use with Kamal or build'n'run by hand:
+# docker build -t demo .
+# docker run -d -p 80:80 -e RAILS_MASTER_KEY=<value from config/master.key> --name demo demo
+
+# For a containerized dev environment, see Dev Containers: https://guides.rubyonrails.org/getting_started_with_devcontainer.html
+<% end -%>
+
+# Make sure RUBY_VERSION matches the Ruby version in .ruby-version
 ARG RUBY_VERSION=<%= RUBY_VERSION %>
 <% if api_client_dir -%>
 <%= render partial: 'node_client' %>
@@ -27,18 +36,18 @@ WORKDIR /rails
 ARG <%= base_args.map {|key, value| "#{key}=#{value.inspect}"}.join(" \\\n    ") %>
 
 <% end -%>
-# Set production environment
-ENV <%= base_env.join(" \\\n    ") %>
-
 # Update gems and bundler
 RUN gem update --system <% if RUBY_VERSION.start_with? '2' %>3.4.22 <% end %>--no-document && \
     gem install -N <%= base_gems.join(" ") %>
 
 <% unless base_packages.empty? -%>
-# Install packages<% unless base_requirements.empty? -%> needed to install <%= base_requirements %><% end %>
+# Install base packages<% unless base_requirements.empty? -%> needed to install <%= base_requirements %><% end %>
 <%= render partial: 'apt_install', locals: {packages: base_packages, clean: true, repos: base_repos} %>
 
 <% end -%>
+# Set production environment
+ENV <%= base_env.join(" \\\n    ") %>
+
 <% if using_execjs? and node_version != 'lts' -%>
 <%= render partial: 'install_node', locals: {yarn_version: nil} %>
 
@@ -54,7 +63,7 @@ FROM base AS <%= parallel? ? 'pre' : '' %>build
 
 <% end -%>
 # Install packages needed to build gems<%= using_node? ? " and node modules" : "" %>
-<%= render partial: 'apt_install', locals: {packages: build_packages, clean: false, repos: ''} %>
+<%= render partial: 'apt_install', locals: {packages: build_packages, clean: true, repos: ''} %>
 
 <% if parallel? -%>
 
@@ -113,13 +122,12 @@ RUN --mount=type=cache,id=bld-gem-cache,sharing=locked,target=/srv/vendor \
 RUN --mount=type=secret,id=gemserver_credentials,target=/kaniko/gemserver_credentials \
     <%= private_gemserver_env_variable_name %>="$(cat /kaniko/gemserver_credentials)" && \
     export <%= private_gemserver_env_variable_name %> && \
-    bundle install<% if depend_on_bootsnap? && options.precompile != "defer" -%> && \
-    bundle exec bootsnap precompile --gemfile<% end %> && \
+    bundle install && \
 <% else -%>
-RUN <% if options["precompiled-gems"] != true %>bundle config set force_ruby_platform true && \<%= "\n    " %><% end %>bundle install<% if depend_on_bootsnap? && options.precompile != "defer" -%> && \
-    bundle exec bootsnap precompile --gemfile<% end %> && \
+RUN <% if options["precompiled-gems"] != true %>bundle config set force_ruby_platform true && \<%= "\n    " %><% end %>bundle install && \
 <% end -%>
-    rm -rf ~/.bundle/ "${BUNDLE_PATH}"/ruby/*/cache "${BUNDLE_PATH}"/ruby/*/bundler/gems/*/.git
+    rm -rf ~/.bundle/ "${BUNDLE_PATH}"/ruby/*/cache "${BUNDLE_PATH}"/ruby/*/bundler/gems/*/.git<% if depend_on_bootsnap? && options.precompile != "defer" -%> && \
+    bundle exec bootsnap precompile --gemfile<% end %>
 
 <% end -%>
 <% if using_passenger? -%>
@@ -298,7 +306,11 @@ COPY <<-"EOF" /rails/Procfile.prod
 EOF
 
 <% end -%>
+<% if using_thruster? -%>
+# Start server via Thruster by default, this can be overwritten at runtime
+<% else -%>
 # Start the server by default, this can be overwritten at runtime
+<% end -%>
 EXPOSE <%= using_thruster? ? '80' : '3000' %>
 <% if deploy_database == 'sqlite3' -%>
 VOLUME /data

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

@@ -4,6 +4,14 @@
 #!/bin/bash -e
 <% end -%>
 
+<% if options.jemalloc? -%>
+# Enable jemalloc for reduced memory usage and latency.
+if [ -z "${LD_PRELOAD+x}" ]; then
+    LD_PRELOAD=$(find /usr/lib -name libjemalloc.so.2 -print -quit)
+    export LD_PRELOAD
+fi
+
+<% end -%>
 <% if options.swap && !File.exist?("fly.toml")-%>
 <% if run_as_root? or using_passenger? -%>
 <% @space = "" -%>
@@ -36,17 +44,13 @@ fi
 <% end -%>
 <% if options.prepare -%>
 <% if !options.procfile.blank? -%>
-if [ "${*}" == "foreman start --procfile=<%= options.procfile %>" ]; then
+# If running the specified procfile then create or migrate existing database
 <% elsif procfile.size > 1 -%>
 # If running the production procfile then create or migrate existing database
-if [ "${*}" == "foreman start --procfile=Procfile.prod" ]; then
-<% elsif procfile.values.first.start_with? "./bin/rails server" -%>
-# If running the rails server then create or migrate existing database
-if [ "${1}" == "./bin/rails" ] && [ "${2}" == "server" ]<% if using_litefs? %> && [ "$FLY_REGION" == "$PRIMARY_REGION" ]<%end%>; then
 <% else -%>
 # If running the rails server then create or migrate existing database
-if [ "${*}" == <%= procfile.values.first.inspect %> <% if using_litefs? %>-a "$FLY_REGION" == "$PRIMARY_REGION" <%end%>]; then
 <% end -%>
+if <%= start_command.map.with_index {|word, index| "[ \"${@: #{index - start_command.length}:1}\" == #{shellescape(word)} ]"}.join(" && ") %><% if using_litefs? %> && [ "$FLY_REGION" == "$PRIMARY_REGION" ]<%end%>; then
 <% if options.precompile == "defer" -%>
   ./bin/rails assets:precompile
 <% end -%>

data/lib/generators/templates/dockerignore.erb

@@ -2,13 +2,13 @@
 
 # Ignore git directory.
 /.git/
+/.gitignore
 
 # Ignore bundler config.
 /.bundle
 
-# Ignore all environment files (except templates).
+# Ignore all environment files.
 /.env*
-!/.env*.erb
 
 # Ignore all default key files.
 /config/master.key
@@ -50,4 +50,18 @@ GEMSERVER_CREDENTIALS.secret.txt
 <% end -%>
 /public/assets
 <% end -%>
+
+# Ignore CI service files.
+/.github
+
+# Ignore Kamal files.
+/config/deploy*.yml
+/.kamal
+
+# Ignore development files
+/.devcontainer
+
+# Ignore Docker-related files
+/.dockerignore
+/Dockerfile*
 <%= more_docker_ignores -%>

data/lib/generators/templates/litestream.rake.erb

@@ -0,0 +1,55 @@
+LITESTREAM_CONFIG = ENV["LITESTREAM_CONFIG"] || Rails.root.join("tmp/litestream.yml").to_s
+
+LITESTREAM_TEMPLATE = <<-EOF
+# This is the configuration file for litestream.
+#
+# For more details, see: https://litestream.io/reference/config/
+#
+dbs:
+<%% for db in @dbs -%>
+  - path: <%%= db %>
+    replicas:
+      - type: s3
+        endpoint: $AWS_ENDPOINT_URL_S3
+        bucket: $BUCKET_NAME
+        path: storage/<%%= File.basename(db) %>
+        access-key-id: $AWS_ACCESS_KEY_ID
+        secret-access-key: $AWS_SECRET_ACCESS_KEY
+<%% end -%>
+EOF
+
+namespace :litestream do
+  task prepare: "db:load_config" do
+    require "erubi"
+
+    @dbs =
+      ActiveRecord::Base
+        .configurations
+        .configs_for(env_name: "production", include_hidden: true)
+        .select { |config| [ "sqlite3", "litedb" ].include? config.adapter }
+        .map(&:database)
+
+    result = eval(Erubi::Engine.new(LITESTREAM_TEMPLATE).src)
+
+    unless File.exist?(LITESTREAM_CONFIG) && File.read(LITESTREAM_CONFIG) == result
+      File.write(LITESTREAM_CONFIG, result)
+    end
+
+    @dbs.each do |db|
+      next if File.exist?(db) or !ENV["BUCKET_NAME"]
+      system "litestream restore -config #{LITESTREAM_CONFIG} -if-replica-exists #{db}"
+      exit $?.exitstatus unless $?.exitstatus == 0
+    end
+  end
+
+  task :run do
+    require "shellwords"
+
+    exec(*%w[bundle exec litestream replicate -config],
+      LITESTREAM_CONFIG, "-exec", Shellwords.join(ARGV[1..-1]))
+  end
+end
+
+namespace :db do
+  task prepare: "litestream:prepare"
+end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: dockerfile-rails
 version: !ruby/object:Gem::Version
-  version: 1.6.25
+  version: 1.7.0
 platform: ruby
 authors:
 - Sam Ruby
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-12 00:00:00.000000000 Z
+date: 2025-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -24,7 +23,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
-description:
 email: rubys@intertwingly.net
 executables: []
 extensions: []
@@ -52,6 +50,7 @@ files:
 - lib/generators/templates/dockerignore.erb
 - lib/generators/templates/fly.toml.erb
 - lib/generators/templates/litefs.yml.erb
+- lib/generators/templates/litestream.rake.erb
 - lib/generators/templates/node-version.erb
 - lib/generators/templates/rollbar.rb.erb
 - lib/generators/templates/sentry.rb.erb
@@ -60,7 +59,6 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/fly-apps/dockerfile-rails
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -75,8 +73,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.18
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Dockerfile generator for Rails
 test_files: []