fly-atc 0.0.3-x86_64-linux

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a3e73181e40f1c2b1c8e8001465b63a6c212a652b8680e6a3e7a68cf5f162ec4
+  data.tar.gz: 3a378a5b22b364599268c5bf490f387a52bf211d5ba2c8dc6f355f5a665b65d5
+SHA512:
+  metadata.gz: 4539778e9eee897c5ef2612d0cf35de36898237862ccca9072e051b3b9afb27d89da601285bb5a9cafaba07f5a909a4f1dbd1da1d406346981eac17917aee47d
+  data.tar.gz: b1cf03d2f33915db24cccca977ed85daa8b5399c63515bfc2790b69da1c58b0490354b0071687a1c951d0cdca8d3e0be0cb5ad91f5161a482f3cbed7b3821a3c

data/MIT-LICENSE

@@ -0,0 +1,85 @@
+Copyright (c) Sam Ruby
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+---
+
+Includes code made available under the same license:
+
+Copyright (c) 37signals, LLC
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+Copyright (c) 37signals, LLC
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+Copyright (c) 37signals, LLC
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,104 @@
+# fly-atc
+
+A SaaS toolkit for converting a personal application into a efficient, siloed, multi-tenant application, where each user of your application is assigned a dedicated virtual machine.
+
+** Work in Progress **
+
+## Usage
+
+### Quickstart (single tenant):
+
+```
+bundle add fly-atc
+bundle binstubs fly-atc
+```
+
+Replace `thruster` with `fly-atc` in Dockerfile.
+
+### Quickstart (multi-tenant):
+
+```
+bundle add fly-atc
+bin/rails generate atc
+```
+
+Edit `config/atc.yml` as needed.
+
+Fly.io's dockerfile generators will be able to help with this.
+
+For approximately $1 US per month, you can run:
+  * [1 performance machine with 2Gb of RAM, 10GB of bandwidth, and 5GB of storage for 15 hours/month](https://fly.io/calculator?m=0_0_0_0_0&f=c&b=iad.10&a=no_none&r=shared_0_1_iad&t=10_100_5&u=0_1_100&g=1_performance_15_1_2048_iad_1024_0).
+  * [1 shared machine with 1Gb of RAM, 10GB of bandwidth, and 5GB of storage for 80 hours/month](https://fly.io/calculator?m=0_0_0_0_0&f=c&b=iad.10&a=no_none&r=shared_0_1_iad&t=10_100_5&u=0_1_100&g=1_shared_80_1_1048_iad_1024_0).
+
+Vertical scaling can be achieved by adding more machines.
+
+## Motivation
+
+I've been running my [Showcase](https://github.com/rubys/showcase?tab=readme-ov-file#showcase) software for nearly three years.  Things have changed over time that I now want to take advantage of.  I want take the opportunity to package those changes in the form of a toolkit that others can take advantage of.
+
+From Wikipedia description of [SaaS](https://en.wikipedia.org/wiki/Software_as_a_service):
+
+> SaaS customers have the abstraction of limitless computing resources, while [economy of scale](https://en.wikipedia.org/wiki/Economy_of_scale) drives down the cost. SaaS architectures are typically [multi-tenant](https://en.wikipedia.org/wiki/Multi-tenant); usually they share resources between clients for efficiency, but sometimes they offer a siloed environment for an additional fee.
+
+The focus of this toolkit is efficient, siloed, multi-tenant applications *with no changes to the application*, taking advantage of:
+
+* [Auto-suspend](https://community.fly.io/t/autosuspend-is-here-machine-suspension-is-enabled-everywhere/20942) -  Virtual Machines that pop into existence when needed and disappear when not in use.
+* [SQLite ready for production](https://rubyonrails.org/2024/11/7/rails-8-no-paas-required#getting-sqlite-ready-for-production) - raw performance coupled with operational compression of complexity; see [Supercharge the One Person Framework with SQLite: Rails World 2024](https://fractaledmind.github.io/2024/10/16/sqlite-supercharges-rails/).
+* [Litestream](https://litestream.io/) -  No-worry backups.  Virtual machines can be literally destroyed and recreated elsewhere and start back up exactly where they left off.
+* [Tigris Global Storage](https://fly.io/docs/tigris/) - globally caching, S3-compatible object storage.
+
+That's a lot of moving parts.  I've documented my [current architecture](https://github.com/rubys/showcase/blob/main/ARCHITECTURE.md) and published a [blueprint](https://fly.io/docs/blueprints/shared-nothing/).
+
+The goal of fly-atc is to enable you configure multiple tenants and then not worry about this further, enabling you to focus on your application.
+
+## Approach
+
+For illustrative purposes consider a SaaS Calender application implemented in Ruby on Rails using SQLite3 as the database.  (My showcase application is a bit more involved than a calendar, but those details aren't important).
+
+Key concepts:
+
+* Each user/customer has a primarly location, and is assigned a single machine near that location.  Such machines can be accessed from anywhere, but have lower latency near that location.
+* Each user can have multiple calendars.  Each calendar is associated with a single tenant on the user's machine.  Each tenant consists a running instance of the web server application with one ([or more](https://rubyonrails.org/2024/11/7/rails-8-no-paas-required#a-solid-reduction-of-dependencies)) databases.
+
+With that in mind, consider the following URL paths:
+
+* `/bellevue/2025/winter/`
+* `/bellevue/2025/summer-medal-ball/`
+* `/bellevue/2025/summer-showcase/`
+* `/boston/2025/april/`
+* `/boston/2025/mini-comp/`
+* `/boston/2025/october/`
+* `/livermore/2025/the-music-of-prince/`
+* `/livermore/2025/james-bond/`
+* `/raleigh/2025/disney/`
+* `/raleigh/2025/in-house/`
+
+The first segment of the path identifies the user, and therefore the machine.  The next two segments combined identify the tenant on that machine.  This is but a subset of the planned showcases, you can see a [full list](https://smooth.fly.dev/showcase/) or even a [map](https://smooth.fly.dev/showcase/regions/) (click on the arrows under the map to move to different continents).
+
+`fly-atc`'s responsibilities are to:
+* Route requests to the correct machine
+* Ensure databases are present/restored from backup
+* Start/stop tenants as required
+* Hand off requests to tenants
+
+Rails 8 introduces [thruster](https://rubyonrails.org/2024/11/7/rails-8-no-paas-required#enter-kamal-2--thruster).  `fly-atc` is a replacement for thruster:
+  * thruster requires no configuration, is limited to a single tenant.
+  * fly-atc enables multiple tenants, based on your configuration.
+
+## Implementation
+
+Based on:
+* [Thruster](https://github.com/basecamp/thruster) ([announcement](https://dev.37signals.com/thruster-released/))
+* [tinyrp](https://github.com/pgaijin66/tinyrp) ([docs](https://prabeshthapa.medium.com/learn-reverse-proxy-by-creating-one-yourself-using-go-87be2a29d1e))
+
+Near term plans:
+
+* Remove certificate/https support
+* Add launch on request / shutdown on idle
+* Add [fly-replay](https://fly.io/docs/networking/dynamic-request-routing/)
+
+On the radar:
+
+* Support for targets other than fly.io.
+* Support for platforms other than Rails, likely starting with Node, and focusing on popular ORMs: [Prisma](https://www.prisma.io/), [TypeORM](https://typeorm.io/), and [Sequelize](https://sequelize.org/).
+* Dashboard.  One should be able to deploy new users and make other configuration changes using only your cell phone.  I [do this today](https://github.com/rubys/showcase/blob/main/ARCHITECTURE.md#administration) with my showcase application.

data/exe/fly-atc

@@ -0,0 +1,11 @@
+#! /usr/bin/env ruby
+
+PLATFORM = [ :cpu, :os ].map { |m| Gem::Platform.local.send(m) }.join("-")
+EXECUTABLE = File.expand_path(File.join(__dir__, PLATFORM, "fly-atc"))
+
+if File.exist?(EXECUTABLE)
+  exec(EXECUTABLE, *ARGV)
+else
+  STDERR.puts("ERROR: Unsupported platform: #{PLATFORM}")
+  exit 1
+end

data/lib/fly-atc/version.rb

@@ -0,0 +1,3 @@
+module FlyAtc
+  VERSION = "0.0.3"
+end

data/lib/fly-atc.rb

@@ -0,0 +1,11 @@
+module FlyAtc
+end
+
+require_relative "fly-atc/version"
+require_relative "helpers/atc-cable"
+
+class FlyAtcRailtie < Rails::Railtie
+  rake_tasks do
+    Dir[File.join(File.dirname(__FILE__),'tasks/*.rake')].each { |f| load f }
+  end
+end

data/lib/generators/atc_generator.rb

@@ -0,0 +1,44 @@
+class AtcGenerator < Rails::Generators::Base
+  def generate_app
+    source_paths.push File.expand_path("./templates", __dir__)
+
+    ### config/routes.rb
+
+    @routes = IO.read("config/routes.rb")
+
+    unless @routes.include? "fly_atc_scope"
+      _, prolog, routes = routes.split(/(.*Rails.application.routes.draw do\n)/m,2)
+      routes, epilog, _ = @routes.split(/^(end.*)/m,2)
+      routes = routes.split(/\n\s*\n/)
+      scoped = routes.select {|route| route =~ /^\s*\w/ && !route.include?('as:')}
+
+      @routes = <<~EOF
+        #{prolog.rstrip}
+          fly_atc_scope = ENV.fetch("FLY_ATC_SCOPE", "")
+
+          unless fly_atc_scope == ""
+            mount ActionCable.server => "/\#{fly_atc_scope}/cable"
+          end
+
+          scope fly_atc_scope do
+        #{scoped.join("\n\n").gsub(/^ /, "   ")}
+          end
+
+        #{(routes-scoped).join("\n\n").rstrip}
+        #{epilog.rstrip}
+      EOF
+    end
+
+    template "routes.erb", "config/routes.rb"
+
+    ### app/views/layouts/application.html.erb
+
+    @layout = IO.read("app/views/layouts/application.html.erb")
+
+    unless @layout.include? "action_cable_meta_tag_dynamic"
+      @layout[/<meta.*?\n()\r?\n/m, 1] = "    <%= action_cable_meta_tag_dynamic %>\n"
+    end
+
+    template "application.html.erb", "app/views/layouts/application.html.erb"
+  end
+end

data/lib/generators/templates/application.html.erb

@@ -0,0 +1 @@
+<%= @layout -%>

data/lib/generators/templates/routes.erb

@@ -0,0 +1 @@
+<%= @routes -%>

data/lib/helpers/atc-cable.rb

@@ -0,0 +1,17 @@
+module ApplicationHelper
+  def action_cable_meta_tag_dynamic
+    scheme = (request.env['HTTP_X_FORWARDED_PROTO'] || request.env["rack.url_scheme"] || '').split(',').last
+    return '' if scheme.blank?
+    host = request.env['HTTP_X_FORWARDED_HOST'] || request.env["HTTP_HOST"]
+    scope = ENV.fetch('FLY_ATC_SCOPE', "")
+    root = request.env['RAILS_RELATIVE_URL_ROOT']
+
+    if scope != ""
+      websocket = "#{scheme.sub('http', 'ws')}://#{host}#{root}#{scope}/cable"
+    else
+      websocket = "#{scheme.sub('http', 'ws')}://#{host}#{root}/cable"
+    end
+
+    "<meta name=\"action-cable-url\" content=\"#{websocket}\" />".html_safe
+  end
+end

data/lib/tasks/atc.rake

@@ -0,0 +1,49 @@
+actions = Rake::Task["db:prepare"].actions.clone
+
+namespace :db do
+  task :atc_prepare => "db:load_config" do
+    actions.each {|action| action.call}
+  end
+end
+
+Rake::Task["db:prepare"].clear
+
+namespace :litestream do
+  task :atc_config => "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)
+
+    @config  = ENV["LITESTREAM_CONFIG"] || Rails.root.join("config/litestream.yml")
+
+    template = File.read(File.join(File.dirname(__FILE__), "templates/litestream.yml.erb"))
+    result = eval(Erubi::Engine.new(template).src)
+
+    unless File.exist?(@config) && File.read(@config) == result
+      File.write(@config, result)
+    end
+  end
+
+  task :atc_restore => "litestream:atc_config" do
+    next unless ENV["BUCKET_NAME"]
+
+    @dbs.each do |database|
+      next if File.exist? database
+      sh "bundle exec litestream restore -config #{@config} -if-replica-exists #{database}"
+    end
+  end
+
+  task :atc_replicate => "litestream:atc_config" do
+    next unless ENV["BUCKET_NAME"]
+    sh "bundle exec litestream replicate -config #{@config}"
+  end
+end
+
+namespace :atc do
+  task :prepare => ["litestream:atc_restore", "db:atc_prepare"]
+end

data/lib/tasks/templates/litestream.yml.erb

@@ -0,0 +1,14 @@
+# 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
+        bucket: $BUCKET_NAME
+        path: storage/<%= File.basename(db) %>
+        access-key-id: $AWS_ACCESS_KEY_ID
+        secret-access-key: $AWS_SECRET_ACCESS_KEY
+<% end -%>

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: fly-atc
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: x86_64-linux
+authors:
+- Sam Ruby
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-11-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+- !ruby/object:Gem::Dependency
+  name: litestream
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.10'
+description: An HTTP/2 proxy for mutli-tenant production deployments
+email: rubys@intertwingly.net
+executables:
+- fly-atc
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- exe/fly-atc
+- exe/x86_64-linux/fly-atc
+- lib/fly-atc.rb
+- lib/fly-atc/version.rb
+- lib/generators/atc_generator.rb
+- lib/generators/templates/application.html.erb
+- lib/generators/templates/routes.erb
+- lib/helpers/atc-cable.rb
+- lib/tasks/atc.rake
+- lib/tasks/templates/litestream.yml.erb
+homepage: https://github.com/rubys/fly-atc
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/rubys/fly-atc
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.18
+signing_key:
+specification_version: 4
+summary: A SaaS toolkit
+test_files: []