litestream 0.13.0-aarch64-linux

data/lib/litestream.rb

@@ -0,0 +1,198 @@
+# frozen_string_literal: true
+
+require "sqlite3"
+
+module Litestream
+  VerificationFailure = Class.new(StandardError)
+
+  class << self
+    attr_writer :configuration
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def deprecator
+      @deprecator ||= ActiveSupport::Deprecation.new("0.12.0", "Litestream")
+    end
+  end
+
+  def self.configure
+    deprecator.warn(
+      "Configuring Litestream via Litestream.configure is deprecated. Use Rails.application.configure { config.litestream.* = ... } instead.",
+      caller
+    )
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  class Configuration
+    attr_accessor :replica_bucket, :replica_key_id, :replica_access_key
+
+    def initialize
+    end
+  end
+
+  mattr_writer :username, :password, :queue, :replica_bucket, :replica_region, :replica_endpoint, :replica_key_id, :replica_access_key, :systemctl_command,
+    :config_path
+  mattr_accessor :base_controller_class, default: "::ApplicationController"
+
+  class << self
+    def verify!(database_path, replication_sleep: 10)
+      database = SQLite3::Database.new(database_path)
+      database.execute("CREATE TABLE IF NOT EXISTS _litestream_verification (id INTEGER PRIMARY KEY, uuid BLOB)")
+      sentinel = SecureRandom.uuid
+      database.execute("INSERT INTO _litestream_verification (uuid) VALUES (?)", [sentinel])
+      # give the Litestream replication process time to replicate the sentinel value
+      sleep replication_sleep
+
+      backup_path = "tmp/#{Time.now.utc.strftime("%Y%m%d%H%M%S")}_#{sentinel}.sqlite3"
+      Litestream::Commands.restore(database_path, **{"-o" => backup_path})
+
+      backup = SQLite3::Database.new(backup_path)
+      result = backup.execute("SELECT 1 FROM _litestream_verification WHERE uuid = ? LIMIT 1", sentinel) # => [[1]] || []
+
+      raise VerificationFailure, "Verification failed for `#{database_path}`" if result.empty?
+
+      true
+    ensure
+      database.execute("DELETE FROM _litestream_verification WHERE uuid = ?", sentinel)
+      database.close
+      Dir.glob(backup_path + "*").each { |file| File.delete(file) }
+    end
+
+    # use method instead of attr_accessor to ensure
+    # this works if variable set after Litestream is loaded
+    def username
+      ENV["LITESTREAM_USERNAME"] || @@username || "litestream"
+    end
+
+    def password
+      ENV["LITESTREAM_PASSWORD"] || @@password
+    end
+
+    def queue
+      ENV["LITESTREAM_QUEUE"] || @@queue || "default"
+    end
+
+    def replica_bucket
+      @@replica_bucket || configuration.replica_bucket
+    end
+
+    def replica_region
+      @@replica_region
+    end
+
+    def replica_endpoint
+      @@replica_endpoint
+    end
+
+    def replica_key_id
+      @@replica_key_id || configuration.replica_key_id
+    end
+
+    def replica_access_key
+      @@replica_access_key || configuration.replica_access_key
+    end
+
+    def systemctl_command
+      @@systemctl_command || "systemctl status litestream"
+    end
+
+    def config_path
+      @@config_path || Rails.root.join("config", "litestream.yml")
+    end
+
+    def replicate_process
+      systemctl_info || process_info || {}
+    end
+
+    def databases
+      databases = Commands.databases
+
+      databases.each do |db|
+        generations = Commands.generations(db["path"])
+        snapshots = Commands.snapshots(db["path"])
+        db["path"] = db["path"].gsub(Rails.root.to_s, "[ROOT]")
+
+        db["generations"] = generations.map do |generation|
+          id = generation["generation"]
+          replica = generation["name"]
+          generation["snapshots"] = snapshots.select { |snapshot| snapshot["generation"] == id && snapshot["replica"] == replica }
+            .map { |s| s.slice("index", "size", "created") }
+          generation.slice("generation", "name", "lag", "start", "end", "snapshots")
+        end
+      end
+    end
+
+    private
+
+    def systemctl_info
+      return if `which systemctl`.empty?
+
+      systemctl_output = `#{Litestream.systemctl_command}`
+      systemctl_exit_code = $?.exitstatus
+      return unless systemctl_exit_code.zero?
+
+      # ["● litestream.service - Litestream",
+      #  "     Loaded: loaded (/lib/systemd/system/litestream.service; enabled; vendor preset: enabled)",
+      #  "     Active: active (running) since Tue 2023-07-25 13:49:43 UTC; 8 months 24 days ago",
+      #  "   Main PID: 1179656 (litestream)",
+      #  "      Tasks: 9 (limit: 1115)",
+      #  "     Memory: 22.9M",
+      #  "        CPU: 10h 49.843s",
+      #  "     CGroup: /system.slice/litestream.service",
+      #  "             └─1179656 /usr/bin/litestream replicate",
+      #  "",
+      #  "Warning: some journal files were not opened due to insufficient permissions."]
+
+      info = {}
+      systemctl_output.chomp.split("\n").each do |line|
+        line.strip!
+        if line.start_with?("Main PID:")
+          _key, value = line.split(":")
+          pid, _name = value.strip.split(" ")
+          info[:pid] = pid
+        elsif line.start_with?("Active:")
+          value, _ago = line.split(";")
+          status, timestamp = value.split(" since ")
+          info[:started] = DateTime.strptime(timestamp.strip, "%a %Y-%m-%d %H:%M:%S %Z")
+          status_match = status.match(%r{\((?<status>.*)\)})
+          info[:status] = status_match ? status_match[:status] : nil
+        end
+      end
+      info
+    end
+
+    def process_info
+      litestream_replicate_ps = `ps -ax | grep litestream | grep replicate`
+      exit_code = $?.exitstatus
+      return unless exit_code.zero?
+
+      info = {}
+      litestream_replicate_ps.chomp.split("\n").each do |line|
+        next unless line.include?("litestream replicate")
+
+        pid, * = line.split(" ")
+        info[:pid] = pid
+        state, _, lstart = `ps -o "state,lstart" #{pid}`.chomp.split("\n").last.partition(/\s+/)
+
+        info[:status] = case state[0]
+        when "I" then "idle"
+        when "R" then "running"
+        when "S" then "sleeping"
+        when "T" then "stopped"
+        when "U" then "uninterruptible"
+        when "Z" then "zombie"
+        end
+        info[:started] = DateTime.strptime(lstart.strip, "%a %b %d %H:%M:%S %Y")
+      end
+      info
+    end
+  end
+end
+
+require_relative "litestream/version"
+require_relative "litestream/upstream"
+require_relative "litestream/commands"
+require_relative "litestream/engine" if defined?(::Rails::Engine)

data/lib/puma/plugin/litestream.rb

@@ -0,0 +1,69 @@
+require "puma/plugin"
+
+# Copied from https://github.com/rails/solid_queue/blob/15408647f1780033dad223d3198761ea2e1e983e/lib/puma/plugin/solid_queue.rb
+Puma::Plugin.create do
+  attr_reader :puma_pid, :litestream_pid, :log_writer
+
+  def start(launcher)
+    @log_writer = launcher.log_writer
+    @puma_pid = $$
+
+    launcher.events.on_booted do
+      @litestream_pid = fork do
+        Thread.new { monitor_puma }
+        Litestream::Commands.replicate(async: true)
+      end
+
+      in_background do
+        monitor_litestream
+      end
+    end
+
+    launcher.events.on_stopped { stop_litestream }
+    launcher.events.on_restart { stop_litestream }
+  end
+
+  private
+
+  def stop_litestream
+    Process.waitpid(litestream_pid, Process::WNOHANG)
+    log_writer.log "Stopping Litestream..."
+    Process.kill(:INT, litestream_pid) if litestream_pid
+    Process.wait(litestream_pid)
+  rescue Errno::ECHILD, Errno::ESRCH
+  end
+
+  def monitor_puma
+    monitor(:puma_dead?, "Detected Puma has gone away, stopping Litestream...")
+  end
+
+  def monitor_litestream
+    monitor(:litestream_dead?, "Detected Litestream has gone away, stopping Puma...")
+  end
+
+  def monitor(process_dead, message)
+    loop do
+      if send(process_dead)
+        log message
+        Process.kill(:INT, $$)
+        break
+      end
+      sleep 2
+    end
+  end
+
+  def litestream_dead?
+    Process.waitpid(litestream_pid, Process::WNOHANG)
+    false
+  rescue Errno::ECHILD, Errno::ESRCH
+    true
+  end
+
+  def puma_dead?
+    Process.ppid != puma_pid
+  end
+
+  def log(...)
+    log_writer.log(...)
+  end
+end

data/lib/tasks/litestream_tasks.rake

@@ -0,0 +1,94 @@
+namespace :litestream do
+  desc "Print the ENV variables needed for the Litestream config file"
+  task env: :environment do
+    puts "LITESTREAM_REPLICA_BUCKET=#{Litestream.replica_bucket}"
+    puts "LITESTREAM_REPLICA_REGION=#{Litestream.replica_region}"
+    puts "LITESTREAM_REPLICA_ENDPOINT=#{Litestream.replica_endpoint}"
+    puts "LITESTREAM_ACCESS_KEY_ID=#{Litestream.replica_key_id}"
+    puts "LITESTREAM_SECRET_ACCESS_KEY=#{Litestream.replica_access_key}"
+
+    true
+  end
+
+  desc 'Monitor and continuously replicate SQLite databases defined in your config file, for example `rake litestream:replicate -- -exec "foreman start"`'
+  task replicate: :environment do
+    options = {}
+    if (separator_index = ARGV.index("--"))
+      ARGV.slice(separator_index + 1, ARGV.length)
+        .map { |pair| pair.split("=") }
+        .each { |opt| options[opt[0]] = opt[1] || nil }
+    end
+    options.symbolize_keys!
+
+    Litestream::Commands.replicate(async: true, **options)
+  end
+
+  desc "Restore a SQLite database from a Litestream replica, for example `rake litestream:restore -- -database=storage/production.sqlite3`"
+  task restore: :environment do
+    options = {}
+    if (separator_index = ARGV.index("--"))
+      ARGV.slice(separator_index + 1, ARGV.length)
+        .map { |pair| pair.split("=") }
+        .each { |opt| options[opt[0]] = opt[1] || nil }
+    end
+    database = options.delete("--database") || options.delete("-database")
+    options.symbolize_keys!
+
+    Litestream::Commands.restore(database, async: true, **options)
+  end
+
+  desc "List all databases and associated replicas in the config file, for example `rake litestream:databases -- -no-expand-env`"
+  task databases: :environment do
+    options = {}
+    if (separator_index = ARGV.index("--"))
+      ARGV.slice(separator_index + 1, ARGV.length)
+        .map { |pair| pair.split("=") }
+        .each { |opt| options[opt[0]] = opt[1] || nil }
+    end
+    options.symbolize_keys!
+
+    Litestream::Commands.databases(async: true, **options)
+  end
+
+  desc "List all generations for a database or replica, for example `rake litestream:generations -- -database=storage/production.sqlite3`"
+  task generations: :environment do
+    options = {}
+    if (separator_index = ARGV.index("--"))
+      ARGV.slice(separator_index + 1, ARGV.length)
+        .map { |pair| pair.split("=") }
+        .each { |opt| options[opt[0]] = opt[1] || nil }
+    end
+    database = options.delete("--database") || options.delete("-database")
+    options.symbolize_keys!
+
+    Litestream::Commands.generations(database, async: true, **options)
+  end
+
+  desc "List all snapshots for a database or replica, for example `rake litestream:snapshots -- -database=storage/production.sqlite3`"
+  task snapshots: :environment do
+    options = {}
+    if (separator_index = ARGV.index("--"))
+      ARGV.slice(separator_index + 1, ARGV.length)
+        .map { |pair| pair.split("=") }
+        .each { |opt| options[opt[0]] = opt[1] || nil }
+    end
+    database = options.delete("--database") || options.delete("-database")
+    options.symbolize_keys!
+
+    Litestream::Commands.snapshots(database, async: true, **options)
+  end
+
+  desc "List all wal files for a database or replica, for example `rake litestream:wal -- -database=storage/production.sqlite3`"
+  task wal: :environment do
+    options = {}
+    if (separator_index = ARGV.index("--"))
+      ARGV.slice(separator_index + 1, ARGV.length)
+        .map { |pair| pair.split("=") }
+        .each { |opt| options[opt[0]] = opt[1] || nil }
+    end
+    database = options.delete("--database") || options.delete("-database")
+    options.symbolize_keys!
+
+    Litestream::Commands.wal(database, async: true, **options)
+  end
+end

metadata

@@ -0,0 +1,208 @@
+--- !ruby/object:Gem::Specification
+name: litestream
+version: !ruby/object:Gem::Version
+  version: 0.13.0
+platform: aarch64-linux
+authors:
+- Stephen Margheim
+bindir: exe
+cert_chain: []
+date: 2025-06-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: logfmt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.10
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.10
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: actionview
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: activejob
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+email:
+- stephen.margheim@gmail.com
+executables:
+- litestream
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- LICENSE-DEPENDENCIES
+- README.md
+- Rakefile
+- app/controllers/litestream/application_controller.rb
+- app/controllers/litestream/processes_controller.rb
+- app/controllers/litestream/restorations_controller.rb
+- app/jobs/litestream/verification_job.rb
+- app/views/layouts/litestream/_style.html
+- app/views/layouts/litestream/application.html.erb
+- app/views/litestream/processes/show.html.erb
+- config/routes.rb
+- exe/aarch64-linux/litestream
+- exe/litestream
+- lib/litestream.rb
+- lib/litestream/commands.rb
+- lib/litestream/engine.rb
+- lib/litestream/generators/litestream/install_generator.rb
+- lib/litestream/generators/litestream/templates/config.yml.erb
+- lib/litestream/generators/litestream/templates/initializer.rb
+- lib/litestream/upstream.rb
+- lib/litestream/version.rb
+- lib/puma/plugin/litestream.rb
+- lib/tasks/litestream_tasks.rake
+homepage: https://github.com/fractaledmind/litestream-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/fractaledmind/litestream-ruby
+  rubygems_mfa_required: 'true'
+  source_code_uri: https://github.com/fractaledmind/litestream-ruby
+  changelog_uri: https://github.com/fractaledmind/litestream-ruby/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.3
+specification_version: 4
+summary: Integrate Litestream with the RubyGems infrastructure.
+test_files: []