fly.io-rails 0.1.4-x86_64-darwin → 0.1.5-x86_64-darwin

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b1f1f8eac6cd28b180df67c861408142b219c2d8523583919ca66bb12ded23cd
-  data.tar.gz: 82a84e889648133520c4819b24bd1aaa7ac752c195f414964df170d25db67de9
+  metadata.gz: 55370806937acab455f03d4971b889d1ee1b6127e9fa4a523750c90b7224a2d5
+  data.tar.gz: ae64fb18e008db2390db9ae109548c1b6874fc0a1e4ba0cac571f038b468f9d3
 SHA512:
-  metadata.gz: e741dd35010d444516d2aa0ffb1560608edd119902e4c9225753426ec7ba7f7ba537e2d0c9c2624e35b927aae17ef79909da0ef02b635c68f5dc2f909476dd91
-  data.tar.gz: 93bfc9b3eb4db893d522204387310b4f78819fda7e98c010cbb68c6f4d358a869a6ac74017fe3acf5bf2dfb59a1fc25520eefd20fbfcb1c75335fd7b381930b8
+  metadata.gz: 759a1dbc80d533824d71f5650e4e536f8a634395b9a75d0c2ce71c1fe689bee656164a3a77e3e4dc031d9a3f8e1f77500188ed6132c9e6509bf26a71c65bbe2b
+  data.tar.gz: 563d8f653b03f98b9ce40a6089f115eae7d23c5a84983c758daf6bc99fc39ed8f8a2833f4ce10888092c95bcd31c341727298928614e8c925c969cb431dc04df

data/README.md

@@ -2,11 +2,28 @@
 
 Add [Fly.io](https://fly.io) support to [Rails](https://rubyonrails.org/).
 
-## Status
+## Usage
+
+For usage instructions, see the following guides:
+
+  * [Machine API](https://fly.io/docs/rails/advanced-guides/machine/)
+  * [Lite FS](https://fly.io/docs/rails/advanced-guides/litefs/)
+  * [Terraform](https://fly.io/docs/rails/advanced-guides/terraform/)
+
+## 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
+  fly:terraform generator respectively.
+  * [lib/fly.io-rails/actions.rb](./lib/fly.io-rails/actions.rb) contains Thor actions used by the
+  rake task and generators.  Does some funky stuff to allow Thor actions to
+  be called from Rake.
+  * [lib/fly.io-rails/machines.rb](./lib/fly.io-rails/machines.rb) wraps Fly.io's machine API as a Ruby module.
+  * [lib/generators/templates](./lib/generators/templates) contains erb
+  templates for all of the files produced primarily by the generator, but also
+  by the deploy task.
+  * [Rakefile](./Rakefile) used to build gems.  Includes native binaries for each supported platform.
 
-<u>pre-alpha</u>.
 
-For usage instructions, see [Fly.io Rails Advanced Guide: Terraform](https://fly.io/docs/rails/advanced-guides/terraform/).
 
 ## Build instructions
 
@@ -19,3 +36,46 @@ 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.
+
+## Debugging instructions
+
+This gem provides a Railtie, with rake tasks and a generator that uses
+Thor and templates.  Being in Ruby, there is no "compile" step.  That
+coupled with Bundler "local overrides" makes testing a breeze.  And
+Rails 7 applications without node dependencies are quick to create.
+
+A script like the following will destroy previous fly applications,
+create a new rails app, add and then override this gem, and finally
+copy in any files that would need to be manually edited.
+
+```
+if [ -e welcome/fly.toml ]; then
+  app=$(awk -e '/^app\s+=/ { print $3 }' welcome/fly.toml | sed 's/"//g')
+  fly apps destroy -y $app
+fi
+rm -rf welcome
+rails new welcome
+cd welcome
+bundle config disable_local_branch_check true
+bundle config set --local local.fly.io-rails /Users/rubys/git/fly.io-rails
+bundle add fly.io-rails --git https://github.com/rubys/fly.io-rails.git
+cp ../routes.rb config
+# bin/rails generate terraform
+# fly secrets set FLY_API_TOKEN=$(fly auth token)
+# bin/rails generate controller job start complete status
+# bin/rails generate job machine
+# cp ../job_controller.rb app/controllers/
+# cp ../machine_job.rb app/jobs/
+```
+
+Once created, I rerun using:
+
+```
+cd ..; sh redo-welcome; cd welcome; 
+```
+
+Generally after the finaly semicolon, I have commands like
+`bin/rails generate fly:app --litefs; fly deploy`.  Rerunning
+after I make a change is a matter of pushing the up arrow until
+I find this command and then pressing enter.
+

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

@@ -17,11 +17,17 @@ module Fly
     attr_accessor :options
 
     def initialize(app, options={})
+      # placate thor
+      @options = {}
+      @destination_stack = [Dir.pwd]
+
+      # extract options
       self.app = app
-      regions = options[:region].flatten || []
+      regions = options[:region]&.flatten || []
       @litefs = options[:litefs]
-      @set_stage = options[:nomad] ? 'set' : 'set --stage'
+      @nomad = options[:nomad]
 
+      # prepare template variablesl
       @ruby_version = RUBY_VERSION
       @bundler_version = Bundler::VERSION
       @node = File.exist? 'node_modules'
@@ -29,9 +35,9 @@ module Fly
       @node_version = @node ? `node --version`.chomp.sub(/^v/, '') : '16.17.0'
       @org = Fly::Machines.org
 
-      @options = {}
-      @destination_stack = [Dir.pwd]
+      @set_stage = @nomad ? 'set' : 'set --stage'
 
+      # determine region
       if !regions or regions.empty?
         @regions = JSON.parse(`flyctl regions list --json --app #{app}`)['Regions'].
           map {|region| region['Code']} rescue []
@@ -42,11 +48,13 @@ module Fly
       @region = @regions.first || 'iad'
       @regions = [@region] if @regions.empty?
 
+      # Process DSL
       @config = Fly::DSL::Config.new
       if File.exist? 'config/fly.rb'
         @config.instance_eval IO.read('config/fly.rb')
       end
 
+      # set additional variables based on application source
       scan_rails_app
     end
 
@@ -91,6 +99,11 @@ module Fly
       app_template 'fly.rake.erb', 'lib/tasks/fly.rake'
     end
 
+    def generate_procfile
+      return unless @sidekiq
+      app_template 'Procfile.fly.erb', 'Procfile.fly'
+    end
+
     def generate_litefs
       app_template 'litefs.yml.erb', 'config/litefs.yml'
     end
@@ -147,6 +160,7 @@ module Fly
 
     def create_postgres(app, org, region, vm_size, volume_size, cluster_size)
       cmd = "flyctl postgres create --name #{app}-db --org #{org} --region #{region} --vm-size #{vm_size} --volume-size #{volume_size} --initial-cluster-size #{cluster_size}"
+      cmd += ' --machines' unless @nomad
       say_status :run, cmd
       output = FlyIoRails::Utils.tee(cmd)
       output[%r{postgres://\S+}]

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

@@ -10,7 +10,7 @@ module Fly
   # the caller is trusted and does pass through unsanitized user input.
   #
   module Machines
-    @@api_token = nil
+    @@api_token = ENV['FLY_API_TOKEN']
     @@fly_api_hostname = nil
 
     # determine fly api hostname.  Returns nil if no proxy is running
@@ -160,14 +160,25 @@ module Fly
       api(path) {|uri| request = Net::HTTP::Delete.new(uri) }
     end
 
+    # graphql -- see https://til.simonwillison.net/fly/undocumented-graphql-api
+    def self.graphql(query)
+      api('/graphql', 'https://api.fly.io/') do |path|
+        request = Net::HTTP::Post.new(path)
+        request.body = { query: query }.to_json
+        request
+      end
+    end
+
     # common processing for all APIs
-    def self.api(path, &make_request)
-      uri = URI("http://#{fly_api_hostname}#{path}")
+    def self.api(path, host=nil, &make_request)
+      host ||= "http://#{fly_api_hostname}"
+      uri = URI.join(host, path)
       http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true if uri.instance_of? URI::HTTPS
 
       request = make_request.call(uri.request_uri)
 
-      @@api_token ||= `fly auth token`.chomp
+      @@api_token ||= `flyctl auth token`.chomp
       headers = {
         "Authorization" => "Bearer #{@@api_token}",
         "Content-Type" => "application/json",

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

@@ -12,6 +12,8 @@ module Fly
         @postgresql = true
       end
 
+      @sidekiq = IO.read('Gemfile').include? 'sidekiq' rescue false
+
       if (YAML.load_file('config/cable.yml').dig('production', 'adapter') rescue false)
         @redis_cable = true
       end
@@ -20,7 +22,7 @@ module Fly
         @redis_cache = true
       end
 
-      @redis = @redis_cable || @redis_cache
+      @redis = @redis_cable || @redis_cache || @sidekiq
     end
   end
 end

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

@@ -1,3 +1,3 @@
 module Fly_io
-  VERSION = '0.1.4'
+  VERSION = '0.1.5'
 end

data/lib/fly.io-rails.rb

@@ -3,9 +3,25 @@ require 'fly.io-rails/generators'
 require 'fly.io-rails/utils'
 
 class FlyIoRailtie < Rails::Railtie
+  # load rake tasks
   rake_tasks do
     Dir[File.expand_path('tasks/*.rake', __dir__)].each do |file|
       load file
     end
   end
+
+  # set FLY_IMAGE_NAME on Nomad VMs
+  if not ENV['FLY_IMAGE_NAME'] and ENV['FLY_APP_NAME'] and ENV['FLY_API_TOKEN']
+    require 'fly.io-rails/machines'
+
+    ENV['FLY_IMAGE_REF'] = Fly::Machines.graphql(%{
+      query {
+	app(name: "#{ENV['FLY_APP_NAME']}") {
+	  currentRelease {
+	    imageRef
+	  }
+	}
+      }
+    }).dig(:data, :app, :currentRelease, :imageRef)
+  end
 end

data/lib/generators/fly/app_generator.rb

@@ -23,6 +23,7 @@ class AppGenerator < Rails::Generators::Base
     action.generate_dockerfile unless File.exist? 'Dockerfile'
     action.generate_dockerignore unless File.exist? '.dockerignore'
     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'
     action.generate_patches
     action.generate_ipv4

data/lib/generators/fly/terraform_generator.rb

@@ -22,6 +22,7 @@ class TerraformGenerator < Rails::Generators::Base
     action.generate_dockerignore
     action.generate_terraform
     action.generate_raketask
+    action.generate_procfile
     action.generate_patches
 
     action.generate_key

data/lib/generators/templates/Dockerfile.erb

@@ -81,6 +81,9 @@ RUN gem update --system --no-document && \
 
 COPY Gemfile* ./
 RUN bundle install &&  rm -rf vendor/bundle/ruby/*/cache
+<% if @sidekiq -%>
+RUN gem install foreman
+<% end -%>
 
 <% if @node -%>
 #######################################################################

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

@@ -0,0 +1,4 @@
+web: bin/rails server
+<% if @sidekiq -%>
+worker: bundle exec sidekiq
+<% end -%>

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

@@ -28,7 +28,13 @@ namespace :fly do
   <%- else -%>
   task :server => :swapfile do
   <%- end -%>
+  <%- if @sidekiq -%>
+    Bundler.with_original_env do
+      sh 'foreman start --procfile=Procfile.fly'
+    end
+  <%- else -%>
     sh 'bin/rails server'
+  <%- end -%>
   end
 
   # optional SWAPFILE task:

data/lib/tasks/fly.rake

@@ -22,6 +22,7 @@ namespace :fly do
     action.generate_dockerfile unless File.exist? 'Dockerfile'
     action.generate_dockerignore unless File.exist? '.dockerignore'
     action.generate_raketask unless File.exist? 'lib/tasks/fly.rake'
+    action.generate_procfile unless File.exist? 'Procfile.fly'
 
     # build and push an image
     out = FlyIoRails::Utils.tee 'fly deploy --build-only --push'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fly.io-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: x86_64-darwin
 authors:
 - Sam Ruby
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-09-27 00:00:00.000000000 Z
+date: 2022-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fly-ruby
@@ -63,6 +63,7 @@ files:
 - lib/generators/fly/app_generator.rb
 - lib/generators/fly/terraform_generator.rb
 - lib/generators/templates/Dockerfile.erb
+- lib/generators/templates/Procfile.fly.erb
 - lib/generators/templates/dockerignore.erb
 - lib/generators/templates/fly.rake.erb
 - lib/generators/templates/fly.rb.erb