fly.io-rails 0.0.1-x86_64-darwin → 0.0.3-x86_64-darwin

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f6ac0bc3732ed8cdf9c621c0696f26cf856552778e0be48af5d7d68348288a8c
-  data.tar.gz: c6599e74063af9b1dd618bfc1e9cfb3f7fad56d06cb92c85c60fcee4745d0a12
+  metadata.gz: 3f76f7f8f758e7f3df3c22ed93a6ac83e543515844e6f7fce91d3902ac45f53a
+  data.tar.gz: 23741fd32ddcd05f7bd6b7aaec10143f2c3c1c03b7a92a37f8561d7685468609
 SHA512:
-  metadata.gz: 2865d142fb9d3f379109ac48ae86953f47a4314de32fa390fe51b67e85f77a877d85c43017e8847c5346737f38a565f465253f1206fc47f5e4131edc3b91078b
-  data.tar.gz: 88e26f046ca4447ad03b918de1540128dd0db162de021ed2346f50c7a98deeadc9ca97d5529be37ad7da6b5728839d221d7694403e025c6df9dfdc7288a90525
+  metadata.gz: f80a247c806c267b4ed8c8f9daff5b5669fc38c8a3377345b151ab29612a7e6e25b46905c66520f73c1f05fe6afaba17fabd50a0e0f59542e7c1482f213200ca
+  data.tar.gz: 5da664fc355d08af2b5bfb1dbd761262d743c6d387ddbe4e1bdbaf457847705d24eec78c56e45757cd89809fee3dac034ae2b91983f2d4c04425f77c5eeec11a

data/README.md

@@ -6,26 +6,7 @@ Add [Fly.io](https://fly.io) support to [Rails](https://rubyonrails.org/).
 
 <u>pre-alpha</u>.
 
-In fact, the gem has not been yet been pushed to the rubygems
-repository as while creating a github repository is an easily reversible act,
-wiping all memory of a mis-named gem is considerably more challenging.
-
-It currently is possible to build the gem files, install the prerequisite
-`ruby-fly` gem, and then install the platform specific gem using `--local`.
-You can also add the gem to your Gemfile using the `path:` argument to the
-`gem` statement/method call.  Of course, all of this will be taken care of
-for you once this gem has been published.
-
-## Quickstart/summary
-
-```sh
-rails new demo
-cd demo
-bundle add fly.io-rails
-flyctl auth login
-bin/rails fly:launch
-bin/rails deploy
-```
+For usage instructions, see [Fly.io Rails Advanced Guide: Terraform](https://fly.io/docs/rails/advanced-guides/terraform/).
 
 ## Build instructions
 
@@ -38,152 +19,3 @@ every supported platform as well as an additional gem that doesn't
 include a binary.
 
 To download new binaries, run `rake clobber` then `rake package` agein.
-
-## Description
-
- -  `bundle add fly.io-rails`
-    
-    This will install `ruby-fly` middleware, add new Rails tasks, extend the
-    channel and job generatotors, and platform binaries for
-    [flyctl](https://github.com/superfly/flyctl#readme).  I've followed the
-    trail blazed by [nokogiri](https://nokogiri.org/) and others to make
-    platform binaries happen.
-
- - `bin/rails fly:launch`
-
-   This won't be a mere front enty to [`flyctl
-   launch`](https://fly.io/docs/flyctl/launch/).  It will use
-   [`thor`](https://github.com/rails/thor#thor) to rewrite the configuration
-   for the `production` environment as well as tweak the `Dockerfile` and
-   `fly.toml` based on your application - in particular the configuration for
-   ActiveRecord, ActiveJob, and ActionCable.  The people at Fly will know what
-   databases and message queing systems work best on their platform and should
-   make it easy to do the right thing.
-
-   As an example, the default production database for a new application in
-   Rails is sqlite3.  Either this will need to be replaced by Postgre in
-   the Rails configuration *or* a volume will need to be defined, mounted,
-   and the Rails configuration modified to point to the new mount point.
-
-   This gem should pick one of those paths as the default, and provide an option to chose other paths.
-
- - `bin/rails generate channel`, `bin/rails generate job`, etc.
-
-   Rails applications are generally not invented fully formed.  They evolve and
-   add features.  I don't want people to think about having to configure rails
-   AND configure fly when then add features.  Generators that developers
-   already use today should be able to update both the Rails and Fly
-   configurations in a consistent manner.
-
-For now, both the Rails tasks and generators don't actually modify the Rails
-configuratio to support Fly, instead they merely output the string `Configuring
-fly...`.  Let your imagination run wild.
-
-## Motivation
-
-Oversimplifying and exagerating to make a point, `flyctl launch` generates an
-initial fly configuration based on the state of the application at launch time
-but leaves configuring your Rails application up to you.  The initial Fly
-configuration may need to be tweaked, and both the fly and Rails configurations
-will need to be maintained as the application evolves.
-
-From a Rails developer perspective, this makes fly an additional framework that
-must be learned and attended to.
-
-This can all be changed with a single `bundle add` command.  Everything from
-new `rails` tasks to extending the behavior of existing generators to making
-changes to configuration to monkeypatching Rails internals itself are on the
-table.
-
-A few sublte but important mindset changes are necessary to pull this off:
-
-  * Instead of "we support every (or perhaps even only 'most') Rails
-    configuration" the mindset we should strive for is "we provide a default
-    production configuration that works for most, and provide options to add or
-    replace components as desired".
-
-    We should be bold and daring.  We should chose a default web server, a
-    default database, a default active job queue adapter, a default action
-    cable subscription adapter, etc., etc., etc.
-
-    Over time, this should encompas everything needed for monitoring and
-    deployment.  Requirements for things like log file management should be
-    anticipated and accounted for.
-
-  * Any configuration artifact that is generated and needs to be checked into
-    the application's source control repository needs to be [beautiful
-    code](https://rubyonrails.org/doctrine#beautiful-code).  If you look at
-    configuration files provided by either `rails new` or by rails generators,
-    they have comments.  They don't configure things that don't apply to you.
-
-    A concrete example: Rails 7 applications default to import maps.  A
-    `Dockerfile` generated for such an app should not contain code that deals
-    with `yarn` or `node_modules`. 
-
-And as a closing remark - to be fair adding Rails support to Fly and adding Fly
-support to Rails are more complementary than competing efforts.  
-
-## Future
-
-> Que sera, sera
-
--- Doris Day
-
-I don't know what the future is going to hold, but some guesses:
-
-  * It is plausible that a code base written in Ruby and with access to
-    libraries like [Thos](http://whatisthor.com/) and focused exclusively on
-    Rails may attract more contributions from the Rails community than a
-    codebase written in Go and targetting many disparate frameworks.
-  * Flyctl launch can continue to provide a basic Fly configuration for Rails,
-    but if this effort is successful these configurations would largely be
-    replaced by more tailors configurations that are updated by generators and
-    rake tasks as the application evolves.
-  * Not every flyctl command needs to have a Rails wrapper -- only the common
-    task do.  It is quiet OK for developers to deal directly with fly when it
-    makes sence to do so.  But those flyctl command that are wrapped may need
-    options added that enable them to be run without the need to prompt the
-    user.
-  * This gem could be built and published alongside the flyctl executables, and
-    `flyctl version update` could detect whether or not it was installed as a
-    gem and react appropriately.
-
-## Call to Action
-
-> good ideas and bad code build communities, the other three combinations do
-> not
-
--- Stefano Mazzocchi
-
-> the best way to get the right answer on the internet is not to ask a
-> question; it's to post the wrong answer.
-
--- Ward Cunningham
-
-I don't presume that any specific line of code in this initial implementation
-will last the test of time.  Heck, I'm not even confident enough in the
-proposed name to register the gem, though the name does feel *rails-like* -
-just take a look at any Rails `Gemfile` to see.
-
-My hope is that there is enough scaffolding here to not only make clear what
-the possibilities are, but also enough structure so that it is fairly obvious
-where new logic should go, together there is not only enough promise and
-structure to attract a community.
-
-Some starter ideas:
-
- * Can we make `bin/rails deploy` smart enough to invoke `flyctl auth login` if
-   you are not logged in and `bin/rails fly:launch` if the application had not
-   previously been launched, with the goal of reducing the number of commands a
-   user has to issue to get started.  Also I'm impressed by the way auth login
-   launches a browser, can we do the same for fly launch?
-
- * While a number of application configuration changes are made through
-   generators, not all are.  For example, upgrading the version of Ruby to be
-   used.  Perhaps we could create tasks for some of these, but likely it will
-   be worthwhile to create a `fly:reconfig` task.
-
-Finally, once this repository is in the superfly github organization and
-a gem has been published, this README should be rewritten from focus on
-raison d'être and to a focus on what value it would bring to those that
-install and use it.

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

@@ -0,0 +1,36 @@
+require 'open3'
+
+module FlyIoRails
+  module Utils
+
+    def tee cmd
+      say_status :run, cmd
+      FlyIoRails::Utils.tee cmd
+    end
+    
+    def self.tee cmd
+      data = {:out => [], :err => []}
+
+      Open3.popen3(cmd) do |stdin, stdout, stderr, thread|
+	{ out: stdout, err: stderr }.each do |key, stream|
+	  Thread.new do
+	    until (raw_line = stream.gets).nil? do
+	      data[key].push raw_line
+	      
+	      if key == :out
+		STDOUT.print raw_line
+	      else
+		STDERR.print raw_line
+	      end
+	    end
+	  end
+	end
+
+	thread.join
+      end
+
+      [data[:out].join, data[:err].join]
+    end
+
+  end
+end

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

@@ -1,3 +1,3 @@
 module Fly_io
-  VERSION = '0.0.1'
+  VERSION = '0.0.3'
 end

data/lib/fly.io-rails.rb

@@ -1,5 +1,6 @@
 require 'rails'
 require 'fly.io-rails/generators'
+require 'fly.io-rails/utils'
 
 class FlyIoRailtie < Rails::Railtie
   rake_tasks do

data/lib/generators/templates/Dockerfile.erb

@@ -0,0 +1,114 @@
+# syntax = docker/dockerfile:experimental
+
+# Dockerfile used to build a deployable image for a Rails application.
+# Adjust as required.
+#
+# Common adjustments you may need to make over time:
+#  * Modify version numbers for Ruby, Bundler, and other products.
+#  * Add library packages needed at build time for your gems, node modules.
+#  * Add deployment packages needed by your application
+#  * Add (often fake) secrets needed to compile your assets
+
+#######################################################################
+
+# Learn more about the chosen Ruby stack, Fullstaq Ruby, here:
+#   https://github.com/evilmartians/fullstaq-ruby-docker.
+#
+# We recommend using the highest patch level for better security and
+# performance.
+
+ARG RUBY_VERSION=<%= @ruby_version %>
+ARG VARIANT=jemalloc-slim
+FROM quay.io/evl.ms/fullstaq-ruby:${RUBY_VERSION}-${VARIANT} as base
+
+ARG BUNDLER_VERSION=<%= @bundler_version %>
+
+ARG RAILS_ENV=production
+ENV RAILS_ENV=${RAILS_ENV}
+
+ENV RAILS_SERVE_STATIC_FILES true
+ENV RAILS_LOG_TO_STDOUT true
+
+ARG BUNDLE_WITHOUT=development:test
+ARG BUNDLE_PATH=vendor/bundle
+ENV BUNDLE_PATH ${BUNDLE_PATH}
+ENV BUNDLE_WITHOUT ${BUNDLE_WITHOUT}
+
+RUN mkdir /app
+WORKDIR /app
+RUN mkdir -p tmp/pids
+
+#######################################################################
+
+# install packages only needed at build time
+
+FROM base as build_deps
+
+ARG BUILD_PACKAGES="git build-essential libpq-dev wget vim curl gzip xz-utils libsqlite3-dev"
+ENV BUILD_PACKAGES ${BUILD_PACKAGES}
+
+RUN --mount=type=cache,id=dev-apt-cache,sharing=locked,target=/var/cache/apt \
+    --mount=type=cache,id=dev-apt-lib,sharing=locked,target=/var/lib/apt \
+    apt-get update -qq && \
+    apt-get install --no-install-recommends -y ${BUILD_PACKAGES} \
+    && rm -rf /var/lib/apt/lists /var/cache/apt/archives
+
+#######################################################################
+
+# install gems
+
+FROM build_deps as gems
+
+RUN gem update --system --no-document && \
+    gem install -N bundler -v ${BUNDLER_VERSION}
+
+COPY Gemfile* ./
+RUN bundle install &&  rm -rf vendor/bundle/ruby/*/cache
+
+#######################################################################
+
+# install deployment packages
+
+FROM base
+
+ARG DEPLOY_PACKAGES="postgresql-client file vim curl gzip libsqlite3-0"
+ENV DEPLOY_PACKAGES=${DEPLOY_PACKAGES}
+
+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 && \
+    apt-get install --no-install-recommends -y \
+    ${DEPLOY_PACKAGES} \
+    && rm -rf /var/lib/apt/lists /var/cache/apt/archives
+
+# copy installed gems
+COPY --from=gems /app /app
+COPY --from=gems /usr/lib/fullstaq-ruby/versions /usr/lib/fullstaq-ruby/versions
+COPY --from=gems /usr/local/bundle /usr/local/bundle
+
+#######################################################################
+
+# Deploy your application
+COPY . .
+
+# Adjust binstubs to run on Linux and set current working directory
+RUN chmod +x /app/bin/* && \
+    sed -i 's/ruby.exe/ruby/' /app/bin/* && \
+    sed -i '/^#!/aDir.chdir File.expand_path("..", __dir__)' /app/bin/*
+
+# The following enable assets to precompile on the build server.  Adjust
+# as necessary.  If no combination works for you, see:
+# https://fly.io/docs/rails/getting-started/existing/#access-to-environment-variables-at-build-time
+ENV SECRET_KEY_BASE 1
+# ENV AWS_ACCESS_KEY_ID=1
+# ENV AWS_SECRET_ACCESS_KEY=1
+
+# Run build task defined in lib/tasks/fly.rake
+ARG BUILD_COMMAND="bin/rails fly:build"
+RUN ${BUILD_COMMAND}
+
+# Default server start instructions.  Generally Overridden by fly.toml.
+ENV PORT 8080
+ARG SERVER_COMMAND="bin/rails fly:server"
+ENV SERVER_COMMAND ${SERVER_COMMAND}
+CMD ${SERVER_COMMAND}

data/lib/generators/templates/dockerignore.erb

@@ -0,0 +1,16 @@
+.git
+tmp
+!tmp/pids
+log
+public/assets
+public/packs
+.bundle
+
+db/*.sqlite3
+db/*.sqlite3-*
+
+storage
+config/master.key
+config/credentials/*.key
+
+node_modules

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

@@ -0,0 +1,23 @@
+# commands used to deploy a Rails application
+namespace :fly do
+  # BUILD step:
+  #  - changes to the filesystem made here DO get deployed
+  #  - NO access to secrets, volumes, databases
+  #  - Failures here prevent deployment
+  task :build => 'assets:precompile'
+
+  # RELEASE step:
+  #  - changes to the filesystem made here are DISCARDED
+  #  - full access to secrets, databases
+  #  - failures here prevent deployment
+  task :release => 'db:migrate'
+
+  # SERVER step:
+  #  - changes to the filesystem made here are deployed
+  #  - full access to secrets, databases
+  #  - failures here result in VM being stated, shutdown, and rolled back
+  #    to last successful deploy (if any).
+  task :server do
+    sh 'bin/rails server'
+  end
+end

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

@@ -0,0 +1,42 @@
+terraform {
+  required_providers {
+    fly = {
+      source = "fly-apps/fly"
+      version = "0.0.10"
+    }
+  }
+}
+
+resource "fly_ip" "<%= @appName %>Ipv4" {
+  app        = <%= @app.inspect %>
+  type       = "v4"
+}
+
+resource "fly_ip" "<%= @appName %>Ipv6" {
+  app        = <%= @app.inspect %>
+  type       = "v6"
+}
+
+resource "fly_machine" "<%= @appName %>Machine" {
+  for_each = toset(<%= @regions.inspect %>)
+  app    = <%= @app.inspect %>
+  region = each.value
+  name   = "<%= @app %>-${each.value}"
+  image  = "quay.io/evl.ms/fullstaq-ruby:<%= @ruby_version %>-jemalloc-slim"
+  services = [
+    {
+      ports = [
+        {
+          port     = 443
+          handlers = ["tls", "http"]
+        },
+        {
+          port     = 80
+          handlers = ["http"]
+        }
+      ]
+      "protocol" : "tcp",
+      "internal_port" : 8080
+    },
+  ]
+}

data/lib/generators/terraform_generator.rb

@@ -0,0 +1,44 @@
+require 'open3'
+
+class TerraformGenerator < Rails::Generators::Base
+  include FlyIoRails::Utils
+
+  class_option :name, type: :string, required: false
+  class_option :org, type: :string, default: 'personal'
+  class_option :region, type: :array, repeatable: true, default: []
+
+  def terraform
+    cmd = if options[:name]
+      "flyctl apps create #{options[:name].inspect} --org #{options[:org].inspect}"
+    else
+      "flyctl apps create --generate-name --org #{options[:org].inspect}"
+    end
+
+    output, error = tee cmd
+    exit 1 unless output =~ /^New app created: /
+
+    @app = output.split.last
+    create_file 'fly.toml', "app = #{@app.inspect}\n"
+
+    if options[:region].empty?
+      @regions = JSON.parse(`flyctl regions list --json`)['Regions'].
+        map {|region| region['Code']}
+    else
+      @regions = options[:regions].flatten
+    end
+
+    source_paths.push File.expand_path('./templates', __dir__)
+
+    @ruby_version = RUBY_VERSION
+    @bundler_version = Bundler::VERSION
+    @appName = @app.gsub('-', '_').camelcase(:lower)
+    template 'Dockerfile.erb', 'Dockerfile'
+    template 'dockerignore.erb', '.dockerignore'
+    template 'main.tf.erb', 'main.tf'
+    template 'fly.rake.erb', 'lib/tasks/fly.rake'
+
+    ENV['FLY_API_TOKEN'] = `flyctl auth token`
+    tee 'terraform init'
+  end
+end
+

data/lib/tasks/fly.rake

@@ -1,26 +1,20 @@
 namespace :fly do
-  desc 'Launch a new app'
-  task :launch do
-    sh 'flyctl launch'
-
-    # note: Rake task argument syntax isn't particularly user friendy,
-    # but Rake is a Ruby program and we have full access to ARGV,
-    # meaning we can do our own thing with OptionParser or whatever.
-    # The only real caveat if we do so is that we need to exit the
-    # program at the completion of the task lest Rails tries to interpet
-    # the next argument as the name of the next task to execute.
-
-    Rake.rake_output_message 'Customizing Dockerfile...'
-
-    exit
-  end
-
   desc 'Deploy fly application'
   task :deploy do
-    sh 'flyctl deploy'
+    out, err = FlyIoRails::Utils.tee 'fly deploy --build-only --push'
+    image = err[/image:\s+(.*)/, 1]
+
+    if image
+      tf = IO.read('main.tf')
+      tf[/^\s*image\s*=\s*"(.*?)"/, 1] = image
+      IO.write 'main.tf', tf
+
+      ENV['FLY_API_TOKEN'] = `flyctl auth token`
+      FlyIoRails::Utils.tee 'terraform apply -auto-approve'
+    end
   end
 end
 
 # Alias, for convenience
 desc 'Deploy fly application'
-task deploy: 'fly:deploy'
+task deploy: 'fly:deploy'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fly.io-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: x86_64-darwin
 authors:
 - Sam Ruby
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-09-13 00:00:00.000000000 Z
+date: 2022-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fly-ruby
@@ -39,7 +39,13 @@ files:
 - lib/fly.io-rails.rb
 - lib/fly.io-rails/generators.rb
 - lib/fly.io-rails/platforms.rb
+- lib/fly.io-rails/utils.rb
 - lib/fly.io-rails/version.rb
+- lib/generators/templates/Dockerfile.erb
+- lib/generators/templates/dockerignore.erb
+- lib/generators/templates/fly.rake.erb
+- lib/generators/templates/main.tf.erb
+- lib/generators/terraform_generator.rb
 - lib/tasks/fly.rake
 homepage: https://github.com/rubys/fly-io.rails
 licenses:
@@ -61,7 +67,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.22
+rubygems_version: 3.3.11
 signing_key:
 specification_version: 4
 summary: Rails support for Fly-io