kamal-backup 0.4.2 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0442e12748359ee182d6fc91e5573375440c31a5a65ccf1b46079547b8e4bc21
-  data.tar.gz: 9af03ddf3ad23b99b77c717711dc66cde34bc17500e66e776aff50ca2678e653
+  metadata.gz: 0ba0b661680e0b8885935b4697cc40052f1584a2c39b0646d2e939d5874f043a
+  data.tar.gz: 3ac2499e70f17ac20b30eaba0bc507e6558fbf1406d8423e32fb1f44c642e3b8
 SHA512:
-  metadata.gz: ccd324da250d8a36f623a6c65c9cf000c80e4fbcc0308944c1074c67ce9422e1e637c55e672160399078944c83c281ccec25ff17a63d1181ed28045244a2d674
-  data.tar.gz: 80f64be478843d1695cdfa34c899ba614ee7ed45a10853f521c08ee568f003f3b0045809ef1ff0c1217e5ec834d2a607888963998af64f9643886048f0e65bf1
+  metadata.gz: 61ff158f87e67167f446b540af94a4193657bf02f8a435d7ffb9465092c32cde6a9b82b4a616fb8571454ddde085915a051be312748ef0d1e2c8647d80f159ee
+  data.tar.gz: e872f59bb07fa089fcf4477c6b2d1f315d8a6d1fed164366d52a8475753c90a951caf46b929ff71ec4b5056160b3f8f8661a833ce0c8ecfaa2a0269d2c03b253

data/lib/kamal_backup/app.rb

@@ -32,6 +32,7 @@ module KamalBackup
     def backup(force: false)
       started_at = Time.now.utc
       config.validate_backup
+      return disabled_backup_result(started_at) unless config.backup_enabled? || force
       return skipped_backup_result(started_at) unless force || backup_due?(started_at)
 
       restic.ensure_repository
@@ -136,6 +137,18 @@ module KamalBackup
       due_at.nil? || now >= due_at
     end
 
+    def disabled_backup_result(now)
+      Schema.record(
+        kind: 'backup_result',
+        status: 'skipped',
+        reason: 'disabled',
+        last_backup_at: last_backup_finished_at&.iso8601,
+        next_backup_at: nil,
+        force_command: 'kamal-backup backup --force',
+        finished_at: now.iso8601
+      )
+    end
+
     def skipped_backup_result(now)
       Schema.record(
         kind: 'backup_result',
@@ -467,6 +480,10 @@ module KamalBackup
       config.validate_restic
       config.validate_database_backup
       config.validate_backup_paths
+      # Check writability up front. This used to be discovered only after
+      # restic had pulled the entire file snapshot, so a read-only mount cost a
+      # full download before failing — the wrong moment to learn about it.
+      config.backup_paths.each { |path| ensure_writable_restore_target(path) }
     end
 
     def validate_production_drill(file_target, database_name, sqlite_path)

data/lib/kamal_backup/cli/helpers.rb

@@ -140,6 +140,13 @@ module KamalBackup
       end
 
       def print_backup_result(result)
+        if result[:status] == 'skipped' && result[:reason] == 'disabled'
+          puts('Backups are disabled for this app (backup.enabled is false).')
+          puts('Set backup.enabled to true and redeploy the accessory to resume scheduled backups.')
+          puts("Run `#{result.fetch(:force_command)}` to take one anyway.")
+          return
+        end
+
         if result[:status] == 'skipped'
           puts("No backup due. Last backup finished at #{result.fetch(:last_backup_at)}.")
           puts("Next backup is due at #{result.fetch(:next_backup_at)}.")

data/lib/kamal_backup/config.rb

@@ -168,6 +168,10 @@ module KamalBackup
       truthy?('KAMAL_BACKUP_ALLOW_SUSPICIOUS_PATHS')
     end
 
+    def backup_enabled?
+      !falsey?('BACKUP_ENABLED')
+    end
+
     def backup_schedule_seconds
       integer('BACKUP_SCHEDULE_SECONDS', 86_400, minimum: 1)
     end

data/lib/kamal_backup/config_file.rb

@@ -271,6 +271,7 @@ module KamalBackup
       hash = require_mapping(raw_value, "#{@path} backup")
       env = {}
       env['BACKUP_SCHEDULE_SECONDS'] = normalize_duration(hash['schedule'], "#{@path} backup.schedule") if hash.key?('schedule')
+      env['BACKUP_ENABLED'] = normalize_value(hash['enabled']) if hash.key?('enabled')
       env.compact
     end
 

data/lib/kamal_backup/databases/postgres.rb

@@ -34,6 +34,28 @@ module KamalBackup
         CommandSpec.new(argv: argv, env: current_connection)
       end
 
+      # Replace the target schema before restoring.
+      #
+      # pg_restore --clean emits DROP TABLE for each object in the dump, but
+      # PostgreSQL refuses to drop a table another table still references, and
+      # the dump's ordering cannot account for constraints that only exist in
+      # the target. Restoring over a schema Rails already created — which is
+      # every restore onto a freshly deployed host, since Kamal runs db:prepare
+      # on boot — leaves the drops failing, the CREATEs failing as "already
+      # exists", the COPYs never running, and the foreign keys rejected because
+      # the tables they point at are still empty.
+      #
+      # Dropping the schema first sidesteps the ordering problem entirely. This
+      # only runs for restore-to-current, which already means "replace this
+      # database"; scratch restores target a separate database and are
+      # untouched.
+      def restore_to_current(restic, snapshot, filename)
+        reset_current_schema
+        result = super
+        ensure_restore_reported_no_errors(result)
+        result
+      end
+
       def current_restore_command
         connection = current_connection
         database = connection.fetch('PGDATABASE')
@@ -61,6 +83,38 @@ module KamalBackup
 
       private
 
+      # pg_restore exits 0 even when individual objects fail, reporting only
+      # "errors ignored on restore: N" on stderr. A restore that half-applied
+      # and claimed success is worse than one that failed, because the damage
+      # is only discovered later, from the data.
+      def ensure_restore_reported_no_errors(result)
+        stderr = result.respond_to?(:stderr) ? result.stderr.to_s : ''
+        match = stderr.match(/errors ignored on restore:\s*(\d+)/i)
+        return if match.nil? || match[1].to_i.zero?
+
+        raise CommandError.new(
+          "pg_restore reported #{match[1]} ignored error(s); the database is only partially restored. " \
+          'Inspect the output above, resolve the cause, and restore again.',
+          command: current_restore_command,
+          stderr: stderr
+        )
+      end
+
+      def reset_current_schema
+        connection = current_connection
+        argv = ['psql', '--quiet', '--no-psqlrc', '--set', 'ON_ERROR_STOP=1', '--command', RESET_SCHEMA_SQL]
+        Command.capture(CommandSpec.new(argv: argv, env: connection), redactor: redactor)
+      rescue CommandError => e
+        raise CommandError.new(
+          "failed to reset the public schema before restoring: #{e.message}",
+          command: e.command,
+          stderr: e.stderr
+        )
+      end
+
+      RESET_SCHEMA_SQL = 'DROP SCHEMA IF EXISTS public CASCADE; CREATE SCHEMA public;'
+      private_constant :RESET_SCHEMA_SQL
+
       def validate_scratch_restore_target(target)
         raise ConfigurationError, 'scratch database must differ from the current PostgreSQL database' if current_connection.fetch('PGDATABASE') == target
 

data/lib/kamal_backup/scheduler.rb

@@ -15,6 +15,17 @@ module KamalBackup
       $stderr.sync = true
 
       install_signal_handlers
+
+      unless @config.backup_enabled?
+        # Stay up rather than exit: the accessory is still how restore, list, check and
+        # evidence reach the repository, and exiting would restart-loop under Kamal's
+        # `--restart unless-stopped`. Set backup.enabled to true and redeploy to resume.
+        log('scheduled backups are disabled (backup.enabled is false); no backups will be taken')
+        idle_until_stopped
+        log("scheduler stopped at #{Time.now.utc.iso8601}")
+        return
+      end
+
       sleep_interruptibly(@config.backup_start_delay_seconds)
 
       until @stop
@@ -43,6 +54,10 @@ module KamalBackup
       end
     end
 
+    def idle_until_stopped
+      sleep 1 until @stop
+    end
+
     def sleep_interruptibly(seconds)
       deadline = Time.now + seconds
       sleep([deadline - Time.now, 1].min) while !@stop && Time.now < deadline

data/lib/kamal_backup/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module KamalBackup
-  VERSION = '0.4.2'
+  VERSION = '0.5.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kamal-backup
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.1
 platform: ruby
 authors:
 - crmne