dockerfile-rails 1.5.2 → 1.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8ce323b4347b43694278ab3b78c36c300deef6c88acff15e3a5c6e66ef5a0ad
-  data.tar.gz: 507e7a76e5f38761f3d729b665d93f231185ffc07edd3665ca88a034244a1dc3
+  metadata.gz: fb14492c49c1cf3daf989207c2188413c0311a317a95727330fcec570f79632c
+  data.tar.gz: c18d7c536626010b3befe71e23ef8c99b53095680e7050dfbcfecd59960cba91
 SHA512:
-  metadata.gz: d9d99879f76d1e9d1e4f601db989b5d6a80e3b4113456827e2b0ab17a495163fb14925c6a6ea34ed760f2921fe482ccfc377e89382e40c10681d3423da6c3f16
-  data.tar.gz: 40a0a469845941a12367aa5f1a7e54f7834a8b07ac081b9bdcf922d30c57d02d75dc994c7b6d1c77e301fac2142e7dcac29551b443286a9c51342582ac043aaa
+  metadata.gz: 50725e7ac313645b93fddb4742a2e711b08e01ba1c593bd0126a70135d04f7467b9d2caa476eb2642903392fc805e2a38ff811aede86c4a2c23843aa30be0189
+  data.tar.gz: 85c0608fc27c115b95d42ddeef4b86b2e5c6be63f652338d01d4b24886686036e2572bab94356f41b3f6e18123d07370b2982f4b224eba34997ef0707381f557

data/README.md

@@ -44,9 +44,12 @@ bin/rails generate dockerfile
 * `--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).
-* `--sentry` -- install gems and a starter initializer for sentry
 * `--sudo` - install and configure sudo to enable `sudo -iu rails` access to full environment
 
+#### Error Tracking & Alerting:
+* `--rollbar` - install gem and a default initializer for [Rollbar](https://rollbar.com/#)
+* `--sentry` - install gems and a default initializer for [Sentry](https://sentry.io/welcome/)
+
 ### Add a Database:
 
 Generally the dockerfile generator will be able to determine what dependencies you
@@ -82,6 +85,7 @@ Not all of your needs can be determined by scanning your application.  For examp
 * `--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`
+* `--private-gemserver-domain=gems.example.com` - set the domain name of your private gemserver.  This is used to tell bundler for what domain to use the credentials of a private gemserver provided via a docker secret
 
 ### Advanced Customization:
 
@@ -116,7 +120,7 @@ rake test
 ruby test/test_minimal.rb
 ```
 
-To assis with this process, outputs of tests can be captured automatically.  This is useful when adding new tests and when making a change that affects many tests.  Be sure to inspect the output (e.g., by using `git diff`) before committing.
+To assist with this process, outputs of tests can be captured automatically.  This is useful when adding new tests and when making a change that affects many tests.  Be sure to inspect the output (e.g., by using `git diff`) before committing.
 
 ```
 rake test:capture

data/lib/generators/dockerfile_generator.rb

@@ -28,9 +28,11 @@ class DockerfileGenerator < Rails::Generators::Base
     "postgresql" => false,
     "precompile" => nil,
     "prepare" => true,
+    "private-gemserver-domain" => nil,
     "procfile" => "",
     "redis" => false,
     "registry" => "",
+    "rollbar" => false,
     "root" => false,
     "sqlite3" => false,
     "sentry" => false,
@@ -171,7 +173,10 @@ class DockerfileGenerator < Rails::Generators::Base
     desc: "Install and configure sudo to enable running as rails with full environment"
 
   class_option :sentry, type: :boolean, default: OPTION_DEFAULTS.sentry,
-    desc: "Install gems and a starter initializer for sentry"
+    desc: "Install gems and a default initializer for Sentry"
+
+  class_option :rollbar, type: :boolean, default: OPTION_DEFAULTS.rollbar,
+    desc: "Install gem and a default initializer for Rollbar"
 
   class_option "migrate", type: :string, default: OPTION_DEFAULTS.migrate,
     desc: "custom migration/db:prepare script"
@@ -179,6 +184,9 @@ class DockerfileGenerator < Rails::Generators::Base
   class_option "procfile", type: :string, default: OPTION_DEFAULTS.procfile,
     desc: "custom procfile to start services"
 
+  class_option "private-gemserver-domain", type: :string, default: OPTION_DEFAULTS["private-gemserver-domain"],
+    desc: "domain name of a private gemserver used when installing application gems"
+
 
   class_option "add-base", type: :array, default: [],
     desc: "additional packages to install for both build and deploy"
@@ -299,6 +307,10 @@ class DockerfileGenerator < Rails::Generators::Base
       template "sentry.rb.erb", "config/initializers/sentry.rb"
     end
 
+    if options.rollbar? && (not File.exist?("config/initializers/rollbar.rb"))
+      template "rollbar.rb.erb", "config/initializers/rollbar.rb"
+    end
+
     if @gemfile.include?("vite_ruby")
       package = JSON.load_file("package.json")
       unless package.dig("scripts", "build")
@@ -445,6 +457,10 @@ private
       system "bundle add sentry-rails --skip-install" unless @gemfile.include? "sentry-rails"
     end
 
+    if options.rollbar?
+      system "bundle add rollbar --skip-install" unless @gemfile.include? "rollbar"
+    end
+
     # https://stackoverflow.com/questions/70500220/rails-7-ruby-3-1-loaderror-cannot-load-such-file-net-smtp/70500221#70500221
     if @gemfile.include? "mail"
       %w(net-smtp net-imap net-pop).each do |gem|
@@ -526,6 +542,7 @@ private
     # start with the essentials
     packages = %w(build-essential)
     packages += @@packages["build"] if @@packages["build"]
+    packages += %w(nodejs npm) if node_version == "lts"
 
     # add databases: sqlite3, postgres, mysql
     packages << "pkg-config" if options.sqlite3? || @sqlite3
@@ -837,7 +854,9 @@ private
 
   def binfile_fixups
     # binfiles may have OS specific paths to ruby.  Normalize them.
-    shebangs = Dir["bin/*"].map { |file| IO.read(file).lines.first }.join
+    shebangs = Dir["bin/*"].map do |file|
+      IO.read(file).lines.first.encode("UTF-8", "binary", invalid: :replace, undef: :replace, replace: "")
+    end.join
     rubies = shebangs.scan(%r{#!/usr/bin/env (ruby.*)}).flatten.uniq
 
     binfixups = (rubies - %w(ruby)).map do |ruby|
@@ -1027,6 +1046,19 @@ private
     nil
   end
 
+  # Takes the domain of the private gemserver and returns the name of the
+  # environment variable, as expected by bundler.
+  #
+  # For example, if the domain is "gems.example.com", the environment variable
+  # name will be "BUNDLE_GEMS__EXAMPLE__COM".
+  def private_gemserver_env_variable_name
+    option = options["private-gemserver-domain"]
+
+    return nil if option.blank?
+
+    "BUNDLE_#{option.upcase.gsub(".", "__")}"
+  end
+
   # if running on fly v2, make a best effort to attach consul
   def fly_attach_consul
     # certainly not fly unless there is a fly.toml

data/lib/generators/templates/Dockerfile.erb

@@ -86,10 +86,15 @@ ENV <%= build_env.join(" \\\n    ") %>
 COPY<% if options.link? %> --link<% end %> Gemfile Gemfile.lock ./
 <% if options.cache? -%>
 RUN --mount=type=cache,id=bld-gem-cache,sharing=locked,target=/srv/vendor \
+<% if private_gemserver_env_variable_name -%>
+    --mount=type=secret,id=gemserver_credentials,dst=/kaniko/gemserver_credentials \
+    <%= private_gemserver_env_variable_name %>="$(cat /kaniko/gemserver_credentials)" && \
+    export <%= private_gemserver_env_variable_name %> && \
+<% end -%>
     bundle config set app_config .bundle && \
     bundle config set path /srv/vendor && \
     bundle install && \
-<% if depend_on_bootsnap? -%>
+<% if depend_on_bootsnap? && options.precompile != "defer" -%>
     bundle exec bootsnap precompile --gemfile && \
 <% end -%>
     bundle clean && \
@@ -98,8 +103,16 @@ RUN --mount=type=cache,id=bld-gem-cache,sharing=locked,target=/srv/vendor \
     cp -ar /srv/vendor .
 
 <% else -%>
-RUN bundle install<% if depend_on_bootsnap? -%> && \
+<% if private_gemserver_env_variable_name -%>
+RUN --mount=type=secret,id=gemserver_credentials,dst=/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 %> && \
+<% else -%>
+RUN bundle install<% if depend_on_bootsnap? && options.precompile != "defer" -%> && \
+    bundle exec bootsnap precompile --gemfile<% end %> && \
+<% end -%>
     rm -rf ~/.bundle/ $BUNDLE_PATH/ruby/*/cache $BUNDLE_PATH/ruby/*/bundler/gems/*/.git
 
 <% end -%>
@@ -115,7 +128,7 @@ COPY --from=node /usr/local/node /usr/local/node
 ENV PATH=/usr/local/node/bin:$PATH
 
 <% elsif using_node? -%>
-<%= render partial: 'npm_install', locals: {sources: Dir[*%w(package.json package-lock.json yarn.lock)]} %>
+<%= render partial: 'npm_install', locals: {sources: Dir[*%w(.npmrc .yarnrc package.json package-lock.json yarn.lock)]} %>
 
 <% end -%>
 # Copy application code

data/lib/generators/templates/_install_node.erb

@@ -5,13 +5,13 @@
 <% elsif yarn_version -%>
 # Install yarn
 <% end -%>
-<% if node_version -%>
+<% if node_version && node_version != 'lts' -%>
 ARG NODE_VERSION=<%= node_version %>
 <% end -%>
 <% if yarn_version -%>
 ARG YARN_VERSION=<%= yarn_version %>
 <% end -%>
-<% if node_version -%>
+<% if node_version && node_version != 'lts' -%>
 ENV PATH=/usr/local/node/bin:$PATH
 RUN curl -sL https://github.com/nodenv/node-build/archive/master.tar.gz | tar xz -C /tmp/ && \
     /tmp/node-build-master/bin/node-build "${NODE_VERSION}" /usr/local/node && \

data/lib/generators/templates/_nginx.erb

@@ -3,14 +3,14 @@ RUN gem install foreman && \
 <% unless run_as_root? -%>
     sed -i 's|pid /run|pid /rails/tmp/pids|' /etc/nginx/nginx.conf && \
 <% end -%>
-    sed -i 's/access_log\s.*;/access_log stdout;/' /etc/nginx/nginx.conf && \
-    sed -i 's/error_log\s.*;/error_log stderr info;/' /etc/nginx/nginx.conf
+    sed -i 's/access_log\s.*;/access_log <% unless run_as_root? %>\/dev\/<% end %>stdout;/' /etc/nginx/nginx.conf && \
+    sed -i 's/error_log\s.*;/error_log <% unless run_as_root? %>\/dev\/<% end %>stderr info;/' /etc/nginx/nginx.conf
 
 COPY <<-"EOF" /etc/nginx/sites-available/default
 server {
   listen 3000 default_server;
   listen [::]:3000 default_server;
-  access_log stdout;
+  access_log <% unless run_as_root? %>/dev/<% end %>stdout;
 
   root /rails/public;
 
@@ -28,7 +28,7 @@ server {
 
   location @backend {
     proxy_pass http://localhost:3001;
-    proxy_set_header origin 'http://localhost:3000';
+    proxy_set_header Host $http_host;
   }
 }
 EOF

data/lib/generators/templates/_npm_install.erb

@@ -1,5 +1,8 @@
 # Install node modules
 COPY<% if options.link? %> --link<% end %> <%= sources.join(' ') %> ./
+<% if sources.join.include?('.yarnrc') && !Dir['.yarn/releases/*'].empty? -%>
+COPY<% if options.link? %> --link<% end %> .yarn/releases/* .yarn/releases/
+<% end -%>
 <% if sources.join.include? 'yarn' -%>
 RUN <% if options.cache? -%>--mount=type=cache,id=bld-yarn-cache,target=/root/.yarn \
     YARN_CACHE_FOLDER=/root/.yarn <% end -%>yarn install<% if options.lock? %> --frozen-lockfile<% end %>

data/lib/generators/templates/_passenger.erb

@@ -10,6 +10,7 @@ server {
     passenger_pool_idle_time <%= max_idle %>;
 <% end -%>
 }
+EOF
 <% if options['max-idle'] -%>
 COPY <<-'EOF' /etc/nginx/sites-enabled/hook_detached_process
 #!/usr/bin/env ruby
@@ -18,7 +19,6 @@ 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 stdout;/' /etc/nginx/nginx.conf && \
     sed -i 's/error_log\s.*;/error_log stderr info;/' /etc/nginx/nginx.conf && \

data/lib/generators/templates/docker-compose.yml.erb

@@ -3,6 +3,10 @@ services:
   web:
 <% if all_args.empty? -%>
     build: .
+<% if private_gemserver_env_variable_name -%>
+    secrets:
+      - gemserver_credentials
+<% end -%>
 <% else -%>
     build:
       context: .
@@ -10,6 +14,10 @@ services:
 <% all_args.each do |name, value| -%>
         <%= name %>: <%= value.html_safe? ? value : "\"#{Shellwords.escape(value)}\"" %>
 <% end -%>
+<% if private_gemserver_env_variable_name -%>
+    secrets:
+      - gemserver_credentials
+<% end -%>
 <% end -%>
     ports:
       - "3000:3000"
@@ -110,3 +118,9 @@ services:
         condition: service_healthy
 <% end -%>
 <% end -%>
+<% if private_gemserver_env_variable_name -%>
+
+secrets:
+  gemserver_credentials:
+    file: ./GEMSERVER_CREDENTIALS.secret.txt
+<% end -%>

data/lib/generators/templates/dockerignore.erb

@@ -39,6 +39,11 @@
 <% end -%>
 <% unless options.api? -%>
 
+<% if private_gemserver_env_variable_name -%>
+# Ignore gemserver credentials.
+GEMSERVER_CREDENTIALS.secret.txt
+
+<% end -%>
 # Ignore assets.
 /node_modules/
 /app/assets/builds/*

data/lib/generators/templates/rollbar.rb.erb

@@ -0,0 +1,73 @@
+if ENV['ROLLBAR_ENV']
+  Rollbar.configure do |config|
+    # Without configuration, Rollbar is enabled in all environments.
+    # To disable in specific environments, set config.enabled=false.
+
+    config.access_token = ENV['ROLLBAR_ACCESS_TOKEN']
+
+    # Here we'll disable in 'test':
+    if Rails.env.test?
+      config.enabled = false
+    end
+
+    # By default, Rollbar will try to call the `current_user` controller method
+    # to fetch the logged-in user object, and then call that object's `id`
+    # method to fetch this property. To customize:
+    # config.person_method = "my_current_user"
+    # config.person_id_method = "my_id"
+
+    # Additionally, you may specify the following:
+    # config.person_username_method = "username"
+    # config.person_email_method = "email"
+
+    # If you want to attach custom data to all exception and message reports,
+    # provide a lambda like the following. It should return a hash.
+    # config.custom_data_method = lambda { {:some_key => "some_value" } }
+
+    # Add exception class names to the exception_level_filters hash to
+    # change the level that exception is reported at. Note that if an exception
+    # has already been reported and logged the level will need to be changed
+    # via the rollbar interface.
+    # Valid levels: 'critical', 'error', 'warning', 'info', 'debug', 'ignore'
+    # 'ignore' will cause the exception to not be reported at all.
+    # config.exception_level_filters.merge!('MyCriticalException' => 'critical')
+    #
+    # You can also specify a callable, which will be called with the exception instance.
+    # config.exception_level_filters.merge!('MyCriticalException' => lambda { |e| 'critical' })
+
+    # Enable asynchronous reporting (uses girl_friday or Threading if girl_friday
+    # is not installed)
+    # config.use_async = true
+    # Supply your own async handler:
+    # config.async_handler = Proc.new { |payload|
+    #  Thread.new { Rollbar.process_from_async_handler(payload) }
+    # }
+
+    # Enable asynchronous reporting (using sucker_punch)
+    # config.use_sucker_punch
+
+    # Enable delayed reporting (using Sidekiq)
+    # config.use_sidekiq
+    # You can supply custom Sidekiq options:
+    # config.use_sidekiq 'queue' => 'default'
+
+    # If your application runs behind a proxy server, you can set proxy parameters here.
+    # If https_proxy is set in your environment, that will be used. Settings here have precedence.
+    # The :host key is mandatory and must include the URL scheme (e.g. 'http://'), all other fields
+    # are optional.
+    #
+    # config.proxy = {
+    #   host: 'http://some.proxy.server',
+    #   port: 80,
+    #   user: 'username_if_auth_required',
+    #   password: 'password_if_auth_required'
+    # }
+
+    # If you run your staging application instance in production environment then
+    # you'll want to override the environment reported by `Rails.env` with an
+    # environment variable like this: `ROLLBAR_ENV=staging`. This is a recommended
+    # setup for Heroku. See:
+    # https://devcenter.heroku.com/articles/deploying-to-a-custom-rails-environment
+    config.environment = ENV['ROLLBAR_ENV'].presence || Rails.env
+  end
+end

data/lib/generators/templates/sentry.rb.erb

@@ -1,3 +1,5 @@
+if ENV["SENTRY_DSN"]
+
 Sentry.init do |config|
   config.dsn = ENV["SENTRY_DSN"]
   config.breadcrumbs_logger = [:active_support_logger, :http_logger]
@@ -10,4 +12,6 @@ Sentry.init do |config|
   config.traces_sampler = lambda do |context|
     true
   end
-end
+end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dockerfile-rails
 version: !ruby/object:Gem::Version
-  version: 1.5.2
+  version: 1.5.4
 platform: ruby
 authors:
 - Sam Ruby
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-24 00:00:00.000000000 Z
+date: 2023-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -52,6 +52,7 @@ files:
 - lib/generators/templates/fly.toml.erb
 - lib/generators/templates/litefs.yml.erb
 - lib/generators/templates/node-version.erb
+- lib/generators/templates/rollbar.rb.erb
 - lib/generators/templates/sentry.rb.erb
 homepage: https://github.com/fly-apps/dockerfile-rails
 licenses: