fly.io-rails 0.1.6 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 77922df296b340d88899a1249c1d962f1b13976c35af4d777f4572d999c10195
-  data.tar.gz: 9a7738006ada1ce48323a0017dae4917ef974a4bbd7b1dab39c0428554a21086
+  metadata.gz: a9adb2bd6c53c8d27b9ade8898e4a5fb4621f5711781e35b8a273535e66996ec
+  data.tar.gz: 749a208099b67b3bad53c1b729ef873bb911ae7e69368f7b04863aa65519fee8
 SHA512:
-  metadata.gz: ffc9e1793531cd8b3a399dab5bdcb7a93f75a37f051bbd868e5c78686e4fa34be94559dd573317317956cc7477ef131c5157671ef57f37e83a35eb47cd64362d
-  data.tar.gz: ba8eda493ee0e6c530ee529f637e76d7c0e3ee46333a62acffcefa211914573f03ef7896c92f9f626c6aa66cdce229916eeaa3ddc998c6b6612a695fe5701cd6
+  metadata.gz: 60db97b7cf7f75b5c5485ca6395c2d6398b54148a8e5fb1547483c272366c052f2d6810a3882fe65eda906627e936555269dc71b1208404ab1d772d29082c640
+  data.tar.gz: 0fd8e2988a4ece554272b0a61e63994243bfa23ad421f2ffdd9f0fd7f5beb446ef09cad99acfbdd7c787ed21b398a597ada26f74d203310dd444667aad7a82a2

data/README.md

@@ -10,6 +10,25 @@ For usage instructions, see the following guides:
   * [Lite FS](https://fly.io/docs/rails/advanced-guides/litefs/)
   * [Terraform](https://fly.io/docs/rails/advanced-guides/terraform/)
 
+## Generator options
+
+  * `--name` name of the application.  If a name is not provided, one will be generated for you.
+  * `--org` the organization to operate on.  Defaults to `personal`.
+  * `--region` region to launch the application in.  Accepts multiple values, and can be specified multiple times.
+  * `--nomad` generates a nomad application instead of a machines application.
+  * `--litefs` adds support for replicated sqlite3 databases via [litefs](https://fly.io/blog/introducing-litefs/).  Only works on nomad machines currently.
+  * `--passenger` run your Rails application with [nginx](https://www.nginx.com/) and [Phusion Passenger](https://www.phusionpassenger.com/).
+  * `--serverless` configures your application to exit after 5 minutes of inactivity.  Machines will automatically restart when next accessed.  Only works with passenger currently.
+
+## Automatically detected features
+
+  * _ruby_: the deployed application will use the same version of ruby and bundler as your development environment.
+  * _node_: if the use of node is detected, node, yarn, and your npm packages will be installed.
+  * _sqlite3_: if the production database is sqlite3 a volume will be allocated and the database will be put there.
+  * _postgres_: if the production database is postgres a postgres machine will be allocated
+  * _redis_: if redis is used for action cable, caching, or sidekiq your redis database will be added to this application.  If you don't currently have a redis database, one will be allocated.  If redis is used for caching, eviction will be turned on.
+  * _sidekiq_: if sidekiq is used it will be launched along side of your rails application.
+
 ## Key files
 
   * Entrypoints: [lib/tasks/fly.rake](./lib/tasks/fly.rake), [lib/generators/app_generator.rb](./lib/generators/app_generator.rb), [lib/generators/terraform_generator.rb](.lib/generators/terraform_generator.rb) contain the deploy task, fly:app generator and

data/lib/fly.io-rails/actions.rb

@@ -26,8 +26,10 @@ module Fly
       regions = options[:region]&.flatten || []
       @litefs = options[:litefs]
       @nomad = options[:nomad]
+      @passenger = options[:passenger]
+      @serverless = options[:serverless]
 
-      # prepare template variablesl
+      # prepare template variables
       @ruby_version = RUBY_VERSION
       @bundler_version = Bundler::VERSION
       @node = File.exist? 'node_modules'
@@ -56,6 +58,11 @@ module Fly
 
       # set additional variables based on application source
       scan_rails_app
+
+      # determine processes
+      @procs = {web: 'bin/rails server'}
+      @procs[:web] = "nginx -g 'daemon off;'" if @passenger
+      @procs[:worker] = 'bundle exec sidekiq' if @sidekiq
     end
 
     def app
@@ -91,6 +98,16 @@ module Fly
       app_template 'dockerignore.erb', '.dockerignore'
     end
 
+    def generate_nginx_conf
+      return unless @passenger
+      app_template 'nginx.conf.erb', 'config/nginx.conf'
+
+      if @serverless
+        app_template 'hook_detached_process.erb', 'config/hook_detached_process'
+        FileUtils.chmod 'u+x', 'config/hook_detached_process'
+      end
+    end
+
     def generate_terraform
       app_template 'main.tf.erb', 'main.tf'
     end
@@ -100,7 +117,7 @@ module Fly
     end
 
     def generate_procfile
-      return unless @sidekiq
+      return unless @procs.length > 1
       app_template 'Procfile.fly.erb', 'Procfile.fly'
     end
 
@@ -187,7 +204,7 @@ module Fly
       start = Fly::Machines.create_and_start_machine(app, config: config)
       machine = start[:id]
 
-      if !machine
+      if not machine
         STDERR.puts 'Error starting release machine'
         PP.pp start, STDERR
         exit 1
@@ -197,24 +214,27 @@ module Fly
         timeout: 60, state: 'started'
 
       # wait for release to copmlete
-      status = nil
       5.times do
         status = Fly::Machines.wait_for_machine app, machine,
-          timeout: 60, state: 'stopped'
-        return machine if status[:ok]
+          instance_id: start[:instance_id], timeout: 60, state: 'stopped'
+        break if status[:ok]
       end
 
-      # wait for release to copmlete
-      event = nil
-      90.times do
-        sleep 1
-        status = Fly::Machines.get_a_machine app, machine
-        event = status[:events]&.first
-        return machine if event && event[:type] == 'exit'
-      end
+      if status and status[:ok]
+        event = nil
+        300.times do
+          status = Fly::Machines.get_a_machine app, start[:id]
+          event = status[:events]&.first
+          break if event[:type] == 'exit'
+          sleep 0.2
+        end
 
-      STDERR.puts event.to_json
-      exit 1
+        exit_code = event&.dig(:request, :exit_event, :exit_code)
+        Fly::Machines.delete_machine app, machine if machine
+        return event, exit_code, machine
+      else
+        return status, nil, nil
+      end
     end
 
     def launch(app)
@@ -296,8 +316,14 @@ module Fly
 
         # perform release
         say_status :fly, release_config[:env]['SERVER_COMMAND']
-        machine = release(app, release_config)
-        Fly::Machines.delete_machine app, machine if machine
+        event, exit_code, machine = release(app, release_config)
+
+        if exit_code != 0
+          STDERR.puts 'Error performing release'
+          STDERR.puts (exit_code ? {exit_code: exit_code} : event).inspect
+          STDERR.puts "run 'flyctl logs --instance #{machine}' for more information"
+          exit 1
+        end
 
         # start proxy, if necessary
         endpoint = Fly::Machines::fly_api_hostname!
@@ -357,18 +383,17 @@ module Fly
     end
 
     def terraform(app, image) 
-      # update main.tf with the image name
-      tf = IO.read('main.tf')
-      tf[/^\s*image\s*=\s*"(.*?)"/, 1] = image.strip
-      IO.write 'main.tf', tf
-
-      # find first machine in terraform config file
-      machines = Fly::HCL.parse(IO.read('main.tf')).find {|block|
-        block.keys.first == :resource and
-        block.values.first.keys.first == 'fly_machine'}
+      # find first machine using the image ref in terraform config file
+      machine = Fly::HCL.parse(IO.read('main.tf')).
+        map {|block| block.dig(:resource, 'fly_machine')}.compact.
+        find {|machine| machine.values.first[:image] == 'var.image_ref'}
+      if not machine
+        STDERR.puts 'unable to find fly_machine with image = var.image_ref in main.rf'
+        exit 1
+      end
 
       # extract HCL configuration for the machine
-      config = machines.values.first.values.first.values.first
+      config = machine.values.first
 
       # delete HCL specific configuration items
       %i(services for_each region app name depends_on).each do |key|
@@ -390,40 +415,25 @@ module Fly
       config[:env] ||= {}
       config[:env]['SERVER_COMMAND'] = 'bin/rails fly:release'
 
+      # fill in image
+      config[:image] = image
+
       # start proxy, if necessary
       endpoint = Fly::Machines::fly_api_hostname!
 
-      # start release machine
-      STDERR.puts "--> #{config[:env]['SERVER_COMMAND']}"
-      start = Fly::Machines.create_and_start_machine(app, config: config)
-      machine = start[:id]
-
-      if !machine
-        STDERR.puts 'Error starting release machine'
-        PP.pp start, STDERR
-        exit 1
-      end
-
-      # wait for release to copmlete
-      event = nil
-      90.times do
-        sleep 1
-        status = Fly::Machines.get_a_machine app, machine
-        event = status[:events]&.first
-        break if event && event[:type] == 'exit'
+      # perform release, if necessary
+      if (IO.read('lib/tasks/fly.rake') rescue '') =~ /^\s*task[ \t]*+:?release"?[ \t]*\S/
+        say_status :fly, config[:env]['SERVER_COMMAND']
+        event, exit_code, machine = release(app, config)
+      else
+        exit_code = 0
       end
 
-      # extract exit code
-      exit_code = event.dig(:request, :exit_event, :exit_code)
-               
       if exit_code == 0
-        # delete release machine
-        Fly::Machines.delete_machine app, machine
-
         # use terraform apply to deploy
         ENV['FLY_API_TOKEN'] = `flyctl auth token`.chomp
         ENV['FLY_HTTP_ENDPOINT'] = endpoint if endpoint
-        system 'terraform apply -auto-approve'
+        system "terraform apply -auto-approve -var=\"image_ref=#{image}\""
       else
         STDERR.puts 'Error performing release'
         STDERR.puts (exit_code ? {exit_code: exit_code} : event).inspect

data/lib/fly.io-rails/dsl.rb

@@ -2,26 +2,26 @@ module Fly
   module DSL
     class Base
       def initialize
-	@value = {}
+        @value = {}
       end
 
       def self.option name, default=nil
-	@options ||= {}
-	@options[name] = default
-
-	define_method name do |*args|
-	  if args.length == 1
-	    @value[name] =  args.first
-	  elsif args.length > 1
-	    raise ArgumentError.new("wrong number of arguments (given #{args.length}, expected 0..1)")
-	  end
-
-	  @value.include?(name) ? @value[name] : default
-	end
+        @options ||= {}
+        @options[name] = default
+
+        define_method name do |*args|
+          if args.length == 1
+            @value[name] =  args.first
+          elsif args.length > 1
+            raise ArgumentError.new("wrong number of arguments (given #{args.length}, expected 0..1)")
+          end
+
+          @value.include?(name) ? @value[name] : default
+        end
       end
 
       def self.options
-	@options ||= {}
+        @options ||= {}
       end
     end
 
@@ -53,21 +53,21 @@ module Fly
       @@blocks = {}
 
       def initialize
-	@config = {}
+        @config = {}
       end
 
       def self.block name, kind
-	@@blocks[name] = kind
+        @@blocks[name] = kind
 
-	define_method name do |&block| 
-	  @config[name] ||= kind.new
-	  @config[name].instance_eval(&block) if block
-	  @config[name]
-	end
+        define_method name do |&block| 
+          @config[name] ||= kind.new
+          @config[name].instance_eval(&block) if block
+          @config[name]
+        end
       end
 
       def self.blocks
-	@@blocks
+        @@blocks
       end
 
       block :machine, Machine

data/lib/fly.io-rails/scanner.rb

@@ -14,8 +14,10 @@ module Fly
 
       @sidekiq = IO.read('Gemfile').include? 'sidekiq' rescue false
 
+      @cable = ! Dir['app/channels/*.rb'].empty?
+
       if (YAML.load_file('config/cable.yml').dig('production', 'adapter') rescue false)
-        @redis_cable = true
+        @redis_cable = @cable
       end
 
       if (IO.read('config/environments/production.rb') =~ /redis/i rescue false)

data/lib/fly.io-rails/version.rb

@@ -1,3 +1,3 @@
 module Fly_io
-  VERSION = '0.1.6'
+  VERSION = '0.1.8'
 end

data/lib/generators/fly/app_generator.rb

@@ -10,6 +10,8 @@ class AppGenerator < Rails::Generators::Base
   class_option :nomad, type: :boolean, default: false
 
   class_option :litefs, type: :boolean, default: false
+  class_option :passenger, type: :boolean, default: false
+  class_option :serverless, type: :boolean, default: false
 
   def generate_app
     source_paths.push File.expand_path('../templates', __dir__)
@@ -22,6 +24,7 @@ class AppGenerator < Rails::Generators::Base
     action.generate_fly_config unless File.exist? 'config/fly.rb'
     action.generate_dockerfile unless File.exist? 'Dockerfile'
     action.generate_dockerignore unless File.exist? '.dockerignore'
+    action.generate_nginx_conf unless File.exist? 'config/nginx.conf'
     action.generate_raketask unless File.exist? 'lib/tasks/fly.rake'
     action.generate_procfile unless File.exist? 'Procfile.rake'
     action.generate_litefs if options[:litefs] and not File.exist? 'config/litefs'

data/lib/generators/fly/terraform_generator.rb

@@ -9,6 +9,8 @@ class TerraformGenerator < Rails::Generators::Base
   class_option :region, type: :array, repeatable: true, default: []
 
   class_option :litefs, type: :boolean, default: false
+  class_option :passenger, type: :boolean, default: false
+  class_option :serverless, type: :boolean, default: false
 
   def terraform
     source_paths.push File.expand_path('../templates', __dir__)
@@ -20,6 +22,7 @@ class TerraformGenerator < Rails::Generators::Base
     action.generate_toml
     action.generate_dockerfile
     action.generate_dockerignore
+    action.generate_nginx_conf
     action.generate_terraform
     action.generate_raketask
     action.generate_procfile

data/lib/generators/templates/Dockerfile.erb

@@ -81,7 +81,7 @@ RUN gem update --system --no-document && \
 
 COPY Gemfile* ./
 RUN bundle install &&  rm -rf vendor/bundle/ruby/*/cache
-<% if @sidekiq -%>
+<% if @procs.length > 1 -%>
 RUN gem install foreman
 <% end -%>
 
@@ -115,6 +115,7 @@ FROM base
 
 <%
   @deploy_packages = %w(file vim curl gzip)
+  @deploy_packages += %w(nginx passenger libnginx-mod-http-passenger) if @passenger
   @deploy_packages << 'postgresql-client' if @postgresql
   @deploy_packages << 'libsqlite3-0' if @sqlite3
   @deploy_packages << 'fuse' if @litefs
@@ -122,6 +123,13 @@ FROM base
 ARG DEPLOY_PACKAGES=<%= @deploy_packages.join(' ').inspect %>
 ENV DEPLOY_PACKAGES=${DEPLOY_PACKAGES}
 
+<% if @passenger -%>
+RUN apt-get install -y dirmngr gnupg apt-transport-https ca-certificates curl && \
+  curl https://oss-binaries.phusionpassenger.com/auto-software-signing-gpg-key.txt | \
+    gpg --dearmor > /etc/apt/trusted.gpg.d/phusion.gpg && \
+  sh -c 'echo deb https://oss-binaries.phusionpassenger.com/apt/passenger bullseye main > /etc/apt/sources.list.d/passenger.list'
+
+<% end -%>
 RUN --mount=type=cache,id=prod-apt-cache,sharing=locked,target=/var/cache/apt \
     --mount=type=cache,id=prod-apt-lib,sharing=locked,target=/var/lib/apt \
     apt-get update -qq && \
@@ -150,6 +158,16 @@ ADD config/litefs.yml /etc/litefs.yml
 RUN mkdir /data
 <% end -%>
 #######################################################################
+<% if @passenger -%>
+
+# configure nginx/passenger
+COPY config/nginx.conf /etc/nginx/sites-available/rails.conf
+RUN rm /etc/nginx/sites-enabled/default && \
+    ln -s /etc/nginx/sites-available/rails.conf /etc/nginx/sites-enabled/
+<% if @serverless -%>
+COPY config/hook_detached_process /etc/nginx/
+<% end -%> 
+<% end -%>
 
 # Deploy your application
 COPY . .

data/lib/generators/templates/Procfile.fly.erb

@@ -1,4 +1,3 @@
-web: bin/rails server
-<% if @sidekiq -%>
-worker: bundle exec sidekiq
+<% @procs.each do |type, command| -%>
+<%= type %>: <%= command %>
 <% end -%>

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

@@ -28,12 +28,12 @@ namespace :fly do
   <%- else -%>
   task :server => :swapfile do
   <%- end -%>
-  <%- if @sidekiq -%>
+  <%- if @procs.length > 1 -%>
     Bundler.with_original_env do
       sh 'foreman start --procfile=Procfile.fly'
     end
   <%- else -%>
-    sh 'bin/rails server'
+    sh <%= @procs.values.first.inspect %>
   <%- end -%>
   end
 

data/lib/generators/templates/fly.toml.erb

@@ -25,8 +25,8 @@ processes = []
 <% end -%>
 
 [mounts]
-source = <%= "#{app.gsub('-', '_')}_volume".inspect %>
-destination = "/mnt/volume"
+  source = <%= "#{app.gsub('-', '_')}_volume".inspect %>
+  destination = "/mnt/volume"
 <% end -%>
 
 [experimental]
@@ -43,8 +43,13 @@ destination = "/mnt/volume"
   protocol = "tcp"
   script_checks = []
   [services.concurrency]
+<% if @cable -%>
+    hard_limit = 2500
+    soft_limit = 2000
+<% else -%>
     hard_limit = 25
     soft_limit = 20
+<% end -%>
     type = "connections"
 
   [[services.ports]]

data/lib/generators/templates/hook_detached_process.erb

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+status = `passenger-status`
+
+processes = status[/^Processes\s*:\s*(\d*)/, 1].to_i
+<% if @cable -%>
+cable = status[/^<%= @app %>-cable.*?\n\n/m]
+processes -= 1 if cable and cable =~ /Sessions:\s*[1-9]/
+<% end -%>
+
+system 'nginx -s stop' if processes == 0

data/lib/generators/templates/main.tf.erb

@@ -2,11 +2,16 @@ terraform {
   required_providers {
     fly = {
       source = "fly-apps/fly"
-      version = "0.0.18"
+      version = "0.0.20"
     }
   }
 }
 
+variable "image_ref" {
+  type        = string
+  description = "docker images containing the application"
+}
+
 /* uncomment if you want an internal tunnel
 provider "fly" {
   useinternaltunnel    = true
@@ -49,7 +54,7 @@ resource "fly_machine" "<%= @appName %>Machine" {
 
   app    = <%= @app.inspect %>
   name   = "<%= @app %>-${each.value}"
-  image  = "quay.io/evl.ms/fullstaq-ruby:<%= @ruby_version %>-jemalloc-slim"
+  image  = var.image_ref
 
   # Scale application resources
   cpus     = 1

data/lib/generators/templates/nginx.conf.erb

@@ -0,0 +1,29 @@
+<% if @serverless -%>
+passenger_ctl hook_detached_process /etc/nginx/hook_detached_process;
+passenger_min_instances 0;
+passenger_pool_idle_time 300;
+
+<% end -%>
+server {
+    listen 8080;
+    server_name <%= @app %>.fly.dev;
+    root /app/public;
+
+    passenger_enabled on;
+    passenger_ruby /usr/lib/fullstaq-ruby/versions/<%= @ruby_version %>-jemalloc/bin/ruby;
+
+<% if @cable -%>
+location / {
+  passenger_app_group_name <%= @app%>;
+}
+
+location /cable {
+  passenger_app_group_name <%= @app%>-cable;
+  passenger_force_max_concurrent_requests_per_process 0;
+}
+
+<% end -%>
+    # Nginx has a default limit of 1 MB for request bodies, which also applies
+    # to file uploads. The following line enables uploads of up to 50 MB:
+    client_max_body_size 50M;
+}

data/lib/tasks/fly.rake

@@ -37,6 +37,18 @@ namespace :fly do
       action.generate_ipv6 if @app
       action.deploy(app, image)
     end
+
+    JSON.parse(`fly apps list --json`).each do |info|
+      if info['Name'] == app
+        60.times do
+          response = Net::HTTP.get_response(URI::HTTPS.build(host: info['Hostname']))
+          puts "Server status: #{response.code} #{response.message}"
+          break
+        rescue Errno::ECONNRESET
+          sleep 0.5
+        end
+      end
+    end
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fly.io-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.8
 platform: ruby
 authors:
 - Sam Ruby
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-03 00:00:00.000000000 Z
+date: 2022-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fly-ruby
@@ -67,15 +67,17 @@ files:
 - lib/generators/templates/fly.rake.erb
 - lib/generators/templates/fly.rb.erb
 - lib/generators/templates/fly.toml.erb
+- lib/generators/templates/hook_detached_process.erb
 - lib/generators/templates/litefs.yml.erb
 - lib/generators/templates/main.tf.erb
+- lib/generators/templates/nginx.conf.erb
 - lib/generators/templates/patches/action_cable.rb
 - lib/tasks/fly.rake
-homepage: https://github.com/rubys/fly-io.rails
+homepage: https://github.com/rubys/fly.io-rails
 licenses:
 - Apache-2.0
 metadata:
-  homepage_uri: https://github.com/rubys/fly-io.rails
+  homepage_uri: https://github.com/rubys/fly.io-rails
 post_install_message:
 rdoc_options: []
 require_paths: