litestream 0.13.0-x86_64-linux → 0.14.0-x86_64-linux

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f9ea3fe713b91a413cc6b1c44878298ba0e1762e0563598eadbd60172d813fd
-  data.tar.gz: 42461b3b37fa3de160071c17dbaeecbc94b37b7eef92a00d903ac6d1a3493ad4
+  metadata.gz: f5472149be2f48a05e36c2e2f1c3feb212355100f4e3085f90ed821559d49200
+  data.tar.gz: 7d745ffdd094a4148b7660f7ec32c531c125279ecb8d78ceef72bdea149f5394
 SHA512:
-  metadata.gz: 9d3fa92c6e7d0a863604a8a6e559d327511b010089ffe31bd5c84a42a17b2b77550dc8bfad75ec85d7e313c91be47e5f3f5d343e5ac3684d55a08b56df3e42f5
-  data.tar.gz: eb711c8d6f3d0ae32f69740b96040d432b6400342f0fc1a28d654328dde909bfbb13c63da059a3e70ff238a32bbb5ca200cd949f2239d990e76d04fd84452888
+  metadata.gz: a5ef0cfce7f7fd68d235f873882f8651c9141bb5fabf7b9a4d2b8f5144de4f0658e741f2a3c0e7f09ef381b4016f897673c5b2d80064dad58c6d4778647f801c
+  data.tar.gz: a959c042fd3c62118cad6976ce554c014ecf6259ca62e1949c398f4cd5697d6ebe0aaa4121f7fd108bcfbdfee8facb9a0cd6391f4024e982116f9a5ed52adaf2

data/README.md

@@ -80,24 +80,27 @@ LITESTREAM_INSTALL_DIR=.bin
 
 You configure the Litestream executable through the [`config/litestream.yml` file](https://litestream.io/reference/config/), which is a standard Litestream configuration file as if Litestream was running in a traditional installation.
 
-The gem streamlines the configuration process by providing a default configuration file for you. This configuration file will backup all SQLite databases defined in your `config/database.yml` file to one replication bucket. In order to ensure that no secrets are stored in plain-text in your repository, this configuration file leverages Litestream's support for environment variables. The default configuration file looks like this if you only have one SQLite database:
+The gem streamlines the configuration process by providing a default configuration file for you. This configuration file will backup all SQLite databases defined in your `config/database.yml` file to one replication bucket. In order to ensure that no secrets are stored in plain-text in your repository, this configuration file leverages Litestream's support for environment variables. Inspect which environment variables are available by running the `bin/rails litestream:env` command.
+
+The default configuration file looks like this if you only have one SQLite database:
 
 ```yaml
 dbs:
   - path: storage/production.sqlite3
     replicas:
       - type: s3
-        bucket: $LITESTREAM_REPLICA_BUCKET
         path: storage/production.sqlite3
+        bucket: $LITESTREAM_REPLICA_BUCKET
         access-key-id: $LITESTREAM_ACCESS_KEY_ID
         secret-access-key: $LITESTREAM_SECRET_ACCESS_KEY
 ```
 
 This is the default for Amazon S3. The full range of possible replica types (e.g. other S3-compatible object storage servers) are covered in Litestream's [replica guides](https://litestream.io/guides/#replica-guides).
 
-The gem also provides a default initializer file at `config/initializers/litestream.rb` that allows you to configure these three environment variables referenced in the configuration file in Ruby. By providing a Ruby interface to these environment variables, you can use any method of storing secrets that you prefer. For example, the default generated file uses Rails' encrypted credentials to store your secrets:
+The gem also provides a default initializer file at `config/initializers/litestream.rb` that allows you to configure various variables referenced in the configuration file in Ruby. By providing a Ruby interface to these environment variables, you can use your preferred method of storing secrets. For example, the default generated file uses Rails' encrypted credentials to store your secrets.
 
 ```ruby
+# config/initializers/litestream.rb
 Rails.application.configure do
   litestream_credentials = Rails.application.credentials.litestream
 
@@ -107,7 +110,21 @@ Rails.application.configure do
 end
 ```
 
-However, if you need manual control over the Litestream configuration, you can manually edit the `config/litestream.yml` file. The full range of possible configurations are covered in Litestream's [configuration reference](https://litestream.io/reference/config/).  NB: If you configure a longer `sync-interval`, you may need to adjust `replication_sleep` when calling `Litestream.verify!`.
+Outside of configuring Litestream's replication, you may also configure various other aspects of `litestream-ruby` itself. 
+
+```ruby
+# config/initializers/litestream.rb
+Rails.application.configure do
+  # ...
+
+  # Base controller used for Litestream dashboard
+  config.litestream.base_controller_class = "MyApplicationController"
+  # Set the location of the Litestream config
+  config.litestream.config_path = "config/litestream.yml"
+end
+```
+
+However, if you need manual control over the Litestream configuration, you can edit the `config/litestream.yml` file. The full range of possible configurations are covered in Litestream's [configuration reference](https://litestream.io/reference/config/).  
 
 ### Replication
 
@@ -232,6 +249,7 @@ You can verify the integrity of your backed-up databases using the gem's provide
 
 ```ruby
 Litestream.verify! "storage/production.sqlite3"
+Litestream.verify!(replication_sleep: 10) "storage/production.sqlite3"
 ```
 
 In order to verify that the backup for that database is both restorable and fresh, the method will add a new row to that database under the `_litestream_verification` table, which it will create if needed. It will then wait `replication_sleep` seconds (defaults to 10) to give the Litestream utility time to replicate that change to whatever storage providers you have configured. After that, it will download the latest backup from that storage provider and ensure that this verification row is present in the backup. If the verification row is _not_ present, the method will raise a `Litestream::VerificationFailure` exception. This check ensures that the restored database file:
@@ -242,6 +260,9 @@ In order to verify that the backup for that database is both restorable and fres
 
 After restoring the backup, the `Litestream.verify!` method will delete the restored database file. If you need the restored database file, use the `litestream:restore` rake task or `Litestream::Commands.restore` method instead.
 
+> [!NOTE]
+> If you configure Litestream's [`sync-interval`](https://litestream.io/reference/config/#replica-settings) to be longer than the default `replication_sleep` value of 10 seconds, you will need to adjust `replication_sleep` to a value larger than `sync-interval`; otherwise, `Litestream.verify!` may appear to fail where it actually simply didn't wait long enough for replication. 
+
 ### Dashboard
 
 The gem provides a web dashboard for monitoring the status of your Litestream replication. To mount the dashboard in your Rails application, add the following to your `config/routes.rb` file:
@@ -506,7 +527,7 @@ time=YYYY-MM-DDTHH:MM:SS level=INFO msg="replicating to" name=s3 type=s3 sync-in
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`.
+To install this gem onto your local machine, run `bundle exec rake install`. To download the Litestream binaries run `bundle exec rake download`.
 
 For maintainers, to release a new version, run `bin/release $VERSION`, which will create a git tag for the version, push git commits and tags, and push all of the platform-specific `.gem` files to [rubygems.org](https://rubygems.org).
 

data/app/controllers/litestream/restorations_controller.rb

@@ -9,7 +9,7 @@ module Litestream
       now = Time.now.utc.strftime("%Y%m%d%H%M%S")
       backup = File.join(dir, "#{base}-#{now}#{ext}")
 
-      Litestream::Commands.restore(database, async: false, **{"-o" => backup})
+      Litestream::Commands.restore(database, **{"-o" => backup})
 
       redirect_to root_path, notice: "Restored to <code>#{backup}</code>."
     end

data/lib/litestream/commands.rb

@@ -1,5 +1,4 @@
 require_relative "upstream"
-require "logfmt"
 
 module Litestream
   module Commands
@@ -21,6 +20,24 @@ module Litestream
     # raised when a litestream command fails
     CommandFailedException = Class.new(StandardError)
 
+    module Output
+      class << self
+        def format(data)
+          return "" if data.nil? || data.empty?
+
+          headers = data.first.keys.map(&:to_s)
+          widths = headers.map.with_index { |h, i|
+            [h.length, data.map { |r| r[data.first.keys[i]].to_s.length }.max].max
+          }
+
+          format_str = widths.map { |w| "%-#{w}s" }.join("  ")
+          ([headers] + data.map(&:values)).map { |row|
+            sprintf(format_str, *row.map(&:to_s))
+          }.join("\n")
+        end
+      end
+    end
+
     class << self
       def platform
         [:cpu, :os].map { |m| Gem::Platform.local.send(m) }.join("-")
@@ -77,44 +94,49 @@ module Litestream
         exe_file
       end
 
+      # Replicate can be run either as a fork or in the same process, depending on the context.
+      # Puma will start replication as a forked process, while running replication from a rake
+      # tasks won't.
       def replicate(async: false, **argv)
-        execute("replicate", argv, async: async, tabled_output: false)
+        cmd = prepare("replicate", argv)
+        run_replicate(cmd, async: async)
+      rescue
+        raise CommandFailedException, "Failed to execute `#{cmd.join(" ")}`"
       end
 
-      def restore(database, async: false, **argv)
+      def restore(database, **argv)
         raise DatabaseRequiredException, "database argument is required for restore command, e.g. litestream:restore -- --database=path/to/database.sqlite" if database.nil?
-        argv.stringify_keys!
 
-        execute("restore", argv, database, async: async, tabled_output: false)
+        execute("restore", argv, database, tabled_output: false)
       end
 
-      def databases(async: false, **argv)
-        execute("databases", argv, async: async, tabled_output: true)
+      def databases(**argv)
+        execute("databases", argv)
       end
 
-      def generations(database, async: false, **argv)
+      def generations(database, **argv)
         raise DatabaseRequiredException, "database argument is required for generations command, e.g. litestream:generations -- --database=path/to/database.sqlite" if database.nil?
 
-        execute("generations", argv, database, async: async, tabled_output: true)
+        execute("generations", argv, database)
       end
 
-      def snapshots(database, async: false, **argv)
+      def snapshots(database, **argv)
         raise DatabaseRequiredException, "database argument is required for snapshots command, e.g. litestream:snapshots -- --database=path/to/database.sqlite" if database.nil?
 
-        execute("snapshots", argv, database, async: async, tabled_output: true)
+        execute("snapshots", argv, database)
       end
 
-      def wal(database, async: false, **argv)
+      def wal(database, **argv)
         raise DatabaseRequiredException, "database argument is required for wal command, e.g. litestream:wal -- --database=path/to/database.sqlite" if database.nil?
 
-        execute("wal", argv, database, async: async, tabled_output: true)
+        execute("wal", argv, database)
       end
 
       private
 
-      def execute(command, argv = {}, database = nil, async: false, tabled_output: false)
+      def execute(command, argv = {}, database = nil, tabled_output: true)
         cmd = prepare(command, argv, database)
-        results = run(cmd, async: async, tabled_output: tabled_output)
+        results = run(cmd, tabled_output: tabled_output)
 
         if Array === results && results.one? && results[0]["level"] == "ERROR"
           raise CommandFailedException, "Failed to execute `#{cmd.join(" ")}`; Reason: #{results[0]["error"]}"
@@ -139,21 +161,24 @@ module Litestream
         cmd
       end
 
-      def run(cmd, async: false, tabled_output: false)
+      def run(cmd, tabled_output:)
+        stdout = `#{cmd.join(" ")}`.chomp
+        return stdout unless tabled_output
+
+        keys, *rows = stdout.split("\n").map { _1.split(/\s+/) }
+        rows.map { keys.zip(_1).to_h }
+      end
+
+      def run_replicate(cmd, async:)
         if async
-          # To release the resources of the Ruby process, just fork and exit.
-          # The forked process executes litestream and replaces itself.
           exec(*cmd) if fork.nil?
         else
-          stdout = `#{cmd.join(" ")}`.chomp
-          tabled_output ? text_table_to_hashes(stdout) : stdout.split("\n").map { Logfmt.parse(_1) }
+          # When running in-process, we capture output continuously and write to stdout.
+          IO.popen(cmd, err: [:child, :out]) do |io|
+            io.each_line { |line| puts line }
+          end
         end
       end
-
-      def text_table_to_hashes(string)
-        keys, *rows = string.split("\n").map { _1.split(/\s+/) }
-        rows.map { keys.zip(_1).to_h }
-      end
     end
   end
 end

data/lib/litestream/generators/litestream/templates/initializer.rb

@@ -5,29 +5,41 @@
 # or some other mechanism where the values are only available at runtime.
 
 Rails.application.configure do
-  # An example of using Rails encrypted credentials to configure Litestream.
+  # Configure Litestream through environment variables. Use Rails encrypted credentials for secrets.
   # litestream_credentials = Rails.application.credentials.litestream
 
-  # Replica-specific bucket location.
-  # This will be your bucket's URL without the `https://` prefix.
+  # Replica-specific bucket location. This will be your bucket's URL without the `https://` prefix.
   # For example, if you used DigitalOcean Spaces, your bucket URL could look like:
+  #
   #   https://myapp.fra1.digitaloceanspaces.com
+  #
   # And so you should set your `replica_bucket` to:
+  #
   #   myapp.fra1.digitaloceanspaces.com
-  # Litestream supports Azure Blog Storage, Backblaze B2, DigitalOcean Spaces,
-  # Scaleway Object Storage, Google Cloud Storage, Linode Object Storage, and
-  # any SFTP server.
-  # In this example, we are using Rails encrypted credentials to store the URL to
-  # our storage provider bucket.
+  #
   # config.litestream.replica_bucket = litestream_credentials&.replica_bucket
-
-  # Replica-specific authentication key.
-  # Litestream needs authentication credentials to access your storage provider bucket.
-  # In this example, we are using Rails encrypted credentials to store the access key ID.
+  #
+  # Replica-specific authentication key. Litestream needs authentication credentials to access your storage provider bucket.
   # config.litestream.replica_key_id = litestream_credentials&.replica_key_id
-
-  # Replica-specific secret key.
-  # Litestream needs authentication credentials to access your storage provider bucket.
-  # In this example, we are using Rails encrypted credentials to store the secret access key.
+  #
+  # Replica-specific secret key. Litestream needs authentication credentials to access your storage provider bucket.
   # config.litestream.replica_access_key = litestream_credentials&.replica_access_key
+  #
+  # Replica-specific region. Set the bucket’s region. Only used for AWS S3 & Backblaze B2.
+  # config.litestream.replica_region = "us-east-1"
+  #
+  # Replica-specific endpoint. Set the endpoint URL of the S3-compatible service. Only required for non-AWS services.
+  # config.litestream.replica_endpoint = "endpoint.your-objectstorage.com"
+
+  # Configure the default Litestream config path
+  # config.config_path = Rails.root.join("config", "litestream.yml")
+
+  # Configure the Litestream dashboard
+  #
+  # Set the default base controller class
+  # config.litestream.base_controller_class = "MyApplicationController"
+  #
+  # Set authentication credentials for Litestream dashboard
+  # config.litestream.username = litestream_credentials&.username
+  # config.litestream.password = litestream_credentials&.password
 end

data/lib/litestream/version.rb

@@ -1,3 +1,3 @@
 module Litestream
-  VERSION = "0.13.0"
+  VERSION = "0.14.0"
 end

data/lib/litestream.rb

@@ -33,8 +33,7 @@ module Litestream
     end
   end
 
-  mattr_writer :username, :password, :queue, :replica_bucket, :replica_region, :replica_endpoint, :replica_key_id, :replica_access_key, :systemctl_command,
-    :config_path
+  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

data/lib/tasks/litestream_tasks.rake

@@ -12,83 +12,61 @@ namespace :litestream do
 
   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!
+    options = parse_argv_options
 
-    Litestream::Commands.replicate(async: true, **options)
+    Litestream::Commands.replicate(**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!
+    options = parse_argv_options
+    database = options.delete(:"--database") || options.delete(:"-database")
 
-    Litestream::Commands.restore(database, async: true, **options)
+    puts Litestream::Commands.restore(database, **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!
+    options = parse_argv_options
 
-    Litestream::Commands.databases(async: true, **options)
+    puts Litestream::Commands::Output.format(Litestream::Commands.databases(**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!
+    options = parse_argv_options
+    database = options.delete(:"--database") || options.delete(:"-database")
 
-    Litestream::Commands.generations(database, async: true, **options)
+    puts Litestream::Commands::Output.format(Litestream::Commands.generations(database, **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!
+    options = parse_argv_options
+    database = options.delete(:"--database") || options.delete(:"-database")
 
-    Litestream::Commands.snapshots(database, async: true, **options)
+    puts Litestream::Commands::Output.format(Litestream::Commands.snapshots(database, **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 = parse_argv_options
+    database = options.delete(:"--database") || options.delete(:"-database")
+
+    puts Litestream::Commands::Output.format(
+      Litestream::Commands.wal(database, **options)
+    )
+  end
+
+  private
+
+  def parse_argv_options
     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

@@ -1,28 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: litestream
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.14.0
 platform: x86_64-linux
 authors:
 - Stephen Margheim
 bindir: exe
 cert_chain: []
-date: 2025-06-03 00:00:00.000000000 Z
+date: 2025-06-13 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
@@ -66,7 +52,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '7.0'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: activejob
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -80,7 +66,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '7.0'
 - !ruby/object:Gem::Dependency
-  name: activejob
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -107,20 +93,6 @@ dependencies:
     - - ">="
       - !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
@@ -136,7 +108,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: rubyzip
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="