kamal-backup 0.3.0.beta9 → 0.3.0.beta11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c7c67946461c23a767a12d31d82389bb4e0fb3c75a5494f102c4dad8facecb2e
-  data.tar.gz: f0265c16c92bdf291bf19f0586589af08938962c5a6b79635f782559dee75d39
+  metadata.gz: a292aa17220ba3ef9cf77c566d5530ece93450aeaa3b01e8f3eaf234ca00859a
+  data.tar.gz: 19a798a19c52f3467fabac4bd5699d0a0b717fe2e9c0da238083aea1e99766cc
 SHA512:
-  metadata.gz: f919b9df92d55407c57745e61cfa4fd011c15060ab6edd5d93b75516fef13b22f0490e7010531bb6c464578df6a25faf8a485d6a35f5431f9a6e53331cef90a5
-  data.tar.gz: d7243e236effb7c4da158c70993af8896e39764952f9dc2155a123655ddac49931804c67dd10424d10a5ddcdd0208542a28fe798256691a4cb2287ef35bba242
+  metadata.gz: aa21d79ea00396dcd2a4f0496ef79c29e9db626a6f31e9969e99ff6560149ddb8aa3cdd0819490d896e770e39a655f4d0212c6b9a02fe0be46bbe1bc8a5441ac
+  data.tar.gz: 622747a659f8d7dc0c02b65888d51693d7388772a99f6459ba919ddaa8603be18dd90299c7f7c03fbb40906154b1c9c3aeace84986b22637381e8762a37bbb5b

data/README.md

@@ -112,6 +112,8 @@ bundle exec kamal-backup check
 bundle exec kamal-backup evidence
 ```
 
+`backup` respects `backup.schedule` and skips when the latest backup is still current. Use `bundle exec kamal-backup backup --force` when you deliberately want an immediate snapshot.
+
 ## What you get
 
 - **Scheduled backups:** the accessory runs continuously and backs up on `backup.schedule`.

data/lib/kamal_backup/app.rb

@@ -29,9 +29,11 @@ module KamalBackup
       @scheduler_class = scheduler_class
     end
 
-    def backup
+    def backup(force: false)
       started_at = Time.now.utc
       config.validate_backup
+      return skipped_backup_result(started_at) unless force || backup_due?(started_at)
+
       require_restic!
 
       restic.ensure_repository
@@ -48,6 +50,7 @@ module KamalBackup
 
       backup_summary(started_at: started_at, finished_at: Time.now.utc).tap do |summary|
         validate_fresh_backup_summary!(summary, started_at: started_at)
+        write_last_backup(summary)
       end
     end
 
@@ -135,10 +138,48 @@ module KamalBackup
 
     def schedule
       config.validate_backup
-      @scheduler_class.new(config) { backup }.run
+      @scheduler_class.new(config) { backup(force: true) }.run
     end
 
     private
+      def backup_due?(now)
+        due_at = next_backup_at
+        due_at.nil? || now >= due_at
+      end
+
+      def skipped_backup_result(now)
+        {
+          kind: "backup_result",
+          status: "skipped",
+          reason: "not_due",
+          last_backup_at: last_backup_finished_at&.iso8601,
+          next_backup_at: next_backup_at&.iso8601,
+          force_command: "kamal-backup backup --force",
+          finished_at: now.iso8601
+        }
+      end
+
+      def next_backup_at
+        last_backup_finished_at + config.backup_schedule_seconds if last_backup_finished_at
+      end
+
+      def last_backup_finished_at
+        @last_backup_finished_at ||= begin
+          value = last_backup_record["finished_at"] || last_backup_record["last_backup_at"]
+          value ? Time.parse(value.to_s).utc : nil
+        rescue ArgumentError
+          nil
+        end
+      end
+
+      def last_backup_record
+        @last_backup_record ||= begin
+          JSON.parse(File.read(config.last_backup_path))
+        rescue JSON::ParserError, SystemCallError
+          {}
+        end
+      end
+
       def build_restore_result(scope, snapshot)
         started_at = Time.now.utc
         result = Schema.record(
@@ -299,6 +340,15 @@ module KamalBackup
         false
       end
 
+      def write_last_backup(result)
+        FileUtils.mkdir_p(config.state_dir)
+        File.write(config.last_backup_path, JSON.pretty_generate(result))
+        @last_backup_record = result.transform_keys(&:to_s)
+        @last_backup_finished_at = Time.parse(result.fetch(:finished_at)).utc
+      rescue SystemCallError, ArgumentError
+        nil
+      end
+
       def database_snapshot_tags(adapter)
         ["type:database", "database:#{database_config_name(adapter)}", "adapter:#{adapter.adapter_name}"]
       end

data/lib/kamal_backup/cli.rb

@@ -141,6 +141,13 @@ module KamalBackup
       def print_backup_result(result)
         return unless result.is_a?(Hash)
 
+        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)}.")
+          puts("Run `#{result.fetch(:force_command)}` to force a backup now.")
+          return
+        end
+
         puts("Backup completed at #{result.fetch(:finished_at)}")
         result.fetch(:databases).each do |database|
           puts("database #{database.fetch(:database)}: #{database.fetch(:snapshot)} at #{database.fetch(:time)}")
@@ -422,6 +429,10 @@ module KamalBackup
       output ||= CommandOutput.new(io: $stderr, env: env)
       output.error("(#{e.class}): #{e.message}", redactor: Redactor.new(env: env))
       exit(1)
+    rescue StandardError => e
+      output ||= CommandOutput.new(io: $stderr, env: env)
+      output.error("(#{e.class}): #{e.message}", redactor: Redactor.new(env: env))
+      exit(1)
     rescue Interrupt
       output ||= CommandOutput.new(io: $stderr, env: env)
       output.error("(Interrupt): interrupted", redactor: Redactor.new(env: env))
@@ -432,12 +443,15 @@ module KamalBackup
 
     include Helpers
 
-    desc "backup", "Run one database and Active Storage backup immediately"
+    method_option :force, type: :boolean, default: false, desc: "Run a backup even if the configured schedule is not due"
+    desc "backup", "Run a due database and Active Storage backup"
     def backup
       if remote_command_mode?
-        exec_remote(["kamal-backup", "backup"])
+        argv = ["kamal-backup", "backup"]
+        argv << "--force" if options[:force]
+        exec_remote(argv)
       else
-        print_backup_result(direct_app.backup)
+        print_backup_result(direct_app.backup(force: options[:force]))
       end
     end
 

data/lib/kamal_backup/config.rb

@@ -215,6 +215,10 @@ module KamalBackup
       File.join(state_dir, "last_check.json")
     end
 
+    def last_backup_path
+      File.join(state_dir, "last_backup.json")
+    end
+
     def last_restore_drill_path
       File.join(state_dir, "last_restore_drill.json")
     end

data/lib/kamal_backup/restic.rb

@@ -48,13 +48,20 @@ module KamalBackup
         Open3.popen3(command.env, *command.argv) do |stdin, stdout, stderr, wait_thread|
           stdout_reader = Thread.new { Command.collect_stream(stdout, command_output: output, context: context, stream: :stdout, redactor: redactor) }
           stderr_reader = Thread.new { Command.collect_stream(stderr, command_output: output, context: context, stream: :stderr, redactor: redactor) }
-          IO.copy_stream(file, stdin)
-          stdin.close
+          copy_error = nil
+          begin
+            IO.copy_stream(file, stdin)
+          rescue Errno::EPIPE => e
+            copy_error = e
+          ensure
+            stdin.close unless stdin.closed?
+          end
           out = stdout_reader.value
           err = stderr_reader.value
           status = wait_thread.value
           output&.command_exit(context, status.exitstatus)
           raise_command_error(command, status, out, err) unless status.success?
+          raise_stream_error(command, copy_error, out, err) if copy_error
 
           CommandResult.new(stdout: out, stderr: err, status: status.exitstatus)
         end
@@ -309,6 +316,15 @@ module KamalBackup
         )
       end
 
+      def raise_stream_error(command, error, stdout, stderr)
+        raise CommandError.new(
+          "failed to stream file to #{command.display(redactor)}: #{error.message}\n#{redactor.redact_string(stderr)}",
+          command: command,
+          stdout: redactor.redact_string(stdout),
+          stderr: redactor.redact_string(stderr)
+        )
+      end
+
       def write_last_check(payload)
         FileUtils.mkdir_p(config.state_dir)
         File.write(config.last_check_path, JSON.pretty_generate(payload.transform_values { |value| value.respond_to?(:iso8601) ? value.iso8601 : redactor.redact_string(value.to_s) }))

data/lib/kamal_backup/version.rb

@@ -1,3 +1,3 @@
 module KamalBackup
-  VERSION = "0.3.0.beta9"
+  VERSION = "0.3.0.beta11"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kamal-backup
 version: !ruby/object:Gem::Version
-  version: 0.3.0.beta9
+  version: 0.3.0.beta11
 platform: ruby
 authors:
 - crmne