ops_backups 0.1.11 → 0.1.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b2fef2adc42b4749261dd1a0eb29142b0e55c84dd0465a519bdfdea0e3b86314
-  data.tar.gz: 4bf5d15d8584abfb624fc8071da8cb5afa578830e1bc4b8754b8e716692e67d6
+  metadata.gz: 9fd477dfd14deed2d6a2781ed4da42ccd0acd90e1c72111d1b577d7392f5cda5
+  data.tar.gz: c881e6740abefb06b6367a855be6a46b3231def32529c6773b1e471d57705d25
 SHA512:
-  metadata.gz: 7e70cc33d5f7d23e4f9cff8b22b0a6bcaa32d0830d4ea232c5d3e41db2f9adaca62ad484423c96ffbc9ec85d38fb2202094f3ff55c28b5a24c29c320a4a4caf3
-  data.tar.gz: 277e00a4449260ff40a4558df7bf7cd624e20a73ca72fe696d7bebd257529bbf2b175e813351401e0756d6f135ad2646b1139bdc0f35e68cf2e49a747247d55d
+  metadata.gz: a5d2218b533240662da7fa48af937ea24b7f5c7e669278c0dd352b59ba28dde091a03ebdda9202045867bbbe2d82f911b3214a16d66a343f7951b99a3a26ad6b
+  data.tar.gz: 8211a1acf5bffbb596c709e9dbc1f857fade276d017d83cd246ba03c6b084378deea6afa1ac3c9753348724ca082d41a675648ce685f8e2dce7b26f2064599c7

data/app/assets/stylesheets/ops_backups/application.css

@@ -13,3 +13,6 @@
  *= require_tree .
  *= require_self
  */
+html {
+  font-family: 'Courier New', Courier, monospace;
+}

data/app/controllers/ops_backups/backups_controller.rb

@@ -0,0 +1,40 @@
+module OpsBackups
+  class BackupsController < ApplicationController
+    def index
+      @backups = OpsBackups::Backup.all.order(updated_at: :desc)
+      @jobs = jobs
+    end
+
+    def download
+      backup = OpsBackups::Backup.find(params[:id])
+      redirect_to backup.backup_file.url(disposition: :attachment), allow_other_host: true
+    end
+
+    def destroy
+      backup = OpsBackups::Backup.find(params[:id])
+      backup.destroy
+      redirect_to backups_url, notice: "#{backup} destroyed."
+    end
+
+    def trigger_job
+      job_name = params[:job_name]
+      job_config = jobs[job_name]
+
+      job_class = job_config["class"].constantize
+      args = job_config["args"] || []
+
+      Rails.logger.info "Triggering job: #{job_name} with args: #{args.reduce({}, :merge).symbolize_keys}"
+
+      job_class.perform_later(args.reduce({}, :merge).symbolize_keys)
+
+      redirect_to backups_url, notice: "#{job_name} triggered successfully."
+    end
+
+    private
+
+    def jobs
+      jobs = YAML.load_file(Rails.root.join("config", "recurring.yml"))[Rails.env]
+      jobs&.select { |k, v| v["class"].start_with?("OpsBackups") }
+    end
+  end
+end

data/app/helpers/ops_backups/{application_helper.rb → backups_helper.rb}

@@ -1,4 +1,4 @@
 module OpsBackups
-  module ApplicationHelper
+  module BackupsHelper
   end
 end

data/app/jobs/ops_backups/backup_db_job.rb

@@ -12,6 +12,7 @@ class OpsBackups::BackupDbJob < ApplicationJob
     exclude_tables = options[:exclude_tables] || []
     tag = options[:tag] || (exclude_tables.empty? ? "db_pg_full" : "db_pg_partial")
     cleanup = options[:cleanup]
+    Rails.logger.info "Performing backup with tag: #{tag} and exclude_tables: #{exclude_tables}"
     OpsBackups::Backup.new.db_pg_backup(exclude_tables:, tag:)
     OpsBackups::Backup.send("#{cleanup}_cleanup_policy", tag: tag) if cleanup.present?
   end

data/app/models/ops_backups/backup.rb

@@ -1,16 +1,31 @@
 module OpsBackups
   class Backup < ActiveRecord::Base
-    # has_one_attached :backup_file, service: :backup_storage
-    has_one_attached :backup_file, service: :backups
+    include ActionView::Helpers::NumberHelper
+
     self.table_name = "ops_backups"
 
+    has_one_attached :backup_file, service: :backups
+
     default_scope { order(updated_at: :desc) }
 
     def self.ransackable_attributes(auth_object = nil)
       [ "created_at", "id", "name", "new_id", "tag", "updated_at" ]
     end
 
+    def size
+      backup_file.attached? ? number_to_human_size(backup_file.byte_size) : "N/A"
+    end
+
+    def duration
+      Time.at((updated_at - created_at)).utc.strftime("%H:%M:%S")
+    end
+
     def db_pg_backup(tag: nil, exclude_tables: [])
+      if ENV["DATABASE_URL"].blank?
+        Rails.logger.error("Failed to backup database: DATABASE_URL is not set")
+        return
+      end
+
       db_url = ENV["DATABASE_URL"]
       tag ||= exclude_tables.empty? ? "db_pg_full" : "db_pg_partial" # if tag.empty?
       self.tag = tag

data/app/views/layouts/ops_backups/application.html.erb

@@ -1,13 +1,13 @@
 <!DOCTYPE html>
 <html>
 <head>
-  <title>Ops backups</title>
+  <title>Ops Backups</title>
   <%= csrf_meta_tags %>
   <%= csp_meta_tag %>
 
   <%= yield :head %>
 
-  <%= stylesheet_link_tag    "ops_backups/application", media: "all" %>
+  <%= stylesheet_link_tag  "ops_backups/application", media: "all" %>
 </head>
 <body>
 

data/app/views/ops_backups/backups/index.html.erb

@@ -0,0 +1,111 @@
+<style>
+  @keyframes fadeOut {
+    to {
+      opacity: 0;
+    }
+  }
+  /* all elements have a border */
+  ops-backups * {
+    /* border: 1px solid red; */
+  }
+  ops-backups {
+    display: flex;
+    padding: 0.5em;
+    flex-direction: column;
+    & h1 {
+      margin: 0;
+      margin-bottom: 0.25em;
+    }
+    & ops-backup {
+      display: grid;
+      grid-template-columns: 3em 1fr 1fr 6em 8em 16em 8em;
+      gap: 0.5em;
+      padding: 0.25em;
+      & ops-backup-index,
+        ops-backup-size,
+        ops-backup-duration,
+        ops-backup-created_at,
+        ops-backup-actions {
+        text-align: right;
+      }
+      & ops-backup-actions {
+        display: flex;
+        flex-direction: row;
+        justify-content: flex-end;
+        gap: 0.5em;
+      }
+    }
+    & ops-backup.header {
+      font-weight: bold;
+      border-bottom: 1px solid black;
+      margin-bottom: 0.25em;
+    }
+    & ops-backup-jobs {
+      display: flex;
+      gap: 0.5em;
+      margin-bottom: 0.5em;
+      /* padding: 0.5em; */
+    }
+  }
+  .alerts {
+    /* position these alerts at the bottom right */
+    position: fixed;
+    bottom: 1em;
+    right: 1em;
+    animation: fadeOut 3s forwards 3s;
+    display: flex;
+    flex-direction: column;
+    align-items: flex-end;
+    gap: 0.5em;
+    & .alert {
+      padding: 0.5em;
+      border-radius: 0.25em;
+    }
+    & .alert-notice {
+      background-color: lightgreen;
+    }
+    & .alert-danger {
+      background-color: lightcoral;
+    }
+  }
+</style>
+<ops-backups>
+  <h1>Backups</h1>
+  <% if @jobs.present? %>
+    <ops-backup-jobs>
+      <% @jobs.each do |name, config| %>
+        <%= button_to name, trigger_job_path(job_name: name), method: :post %>
+      <% end %>
+    </ops-backup-jobs>
+  <% end %>
+  <ops-backup class="header">
+    <ops-backup-index>Index</ops-backup-index>
+    <ops-backup-name>Name</ops-backup-name>
+    <ops-backup-tag>Tag</ops-backup-tag>
+    <ops-backup-size>Size</ops-backup-size>
+    <ops-backup-duration>Duration</ops-backup-duration>
+    <ops-backup-created_at>Created At</ops-backup-created_at>
+    <ops-backup-actions>Actions</ops-backup-actions>
+  </ops-backup>
+  <% @backups.each.with_index do |backup, i| %>
+    <ops-backup id="ops-backup-<%= i %>">
+      <ops-backup-index><%= i %></ops-backup-index>
+      <ops-backup-name><%= backup.name %></ops-backup-name>
+      <ops-backup-tag><%= backup.name %></ops-backup-tag>
+      <ops-backup-size><%= backup.size %></ops-backup-size>
+      <ops-backup-duration><%= backup.duration %></ops-backup-duration>
+      <ops-backup-created_at><%= backup.created_at %></ops-backup-created_at>
+      <ops-backup-actions>
+        <% if backup.backup_file.attached? %>
+          <%= button_to "📎", download_backup_path(backup), method: :get %>
+        <% end %>
+        <%= button_to "🗑️", backup_path(backup), method: :delete %>
+      </ops-backup-actions>
+    </ops-backup>
+  <% end %>
+</ops-backups>
+<div class="alerts">
+  <% flash.each do |key, value| %>
+    <div class="alert alert-<%= key %>"><%= value %></div>
+  <% end %>
+</div>

data/config/routes.rb

@@ -1,2 +1,6 @@
 OpsBackups::Engine.routes.draw do
+  get "backups", to: "backups#index"
+  get "backups/:id/download", to: "backups#download", as: "download_backup"
+  delete "backups/:id", to: "backups#destroy", as: "backup"
+  post "backups/trigger_job", to: "backups#trigger_job", as: "trigger_job"
 end

data/lib/generators/ops_backups/install/install_generator.rb

@@ -39,7 +39,7 @@ class OpsBackups::InstallGenerator < Rails::Generators::Base
       recurring_config = <<~YAML.lines.map { |line| "  #{line}" }.join
         backup_db:
           class: OpsBackups::BackupDbJob
-          args: [tag: "db_pg_backup", cleanup: "retain_tiered_cleanup_policy"]
+          args: [tag: "db_pg_backup", cleanup: "retain_tiered"]
           schedule: every hour
       YAML
 

data/lib/ops_backups/version.rb

@@ -1,3 +1,3 @@
 module OpsBackups
-  VERSION = "0.1.11"
+  VERSION = "0.1.13"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ops_backups
 version: !ruby/object:Gem::Version
-  version: 0.1.11
+  version: 0.1.13
 platform: ruby
 authors:
 - Koen Handekyn
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-28 00:00:00.000000000 Z
+date: 2024-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -38,15 +38,16 @@ files:
 - Rakefile
 - app/assets/stylesheets/ops_backups/application.css
 - app/controllers/ops_backups/application_controller.rb
-- app/helpers/ops_backups/application_helper.rb
+- app/controllers/ops_backups/backups_controller.rb
+- app/helpers/ops_backups/backups_helper.rb
 - app/jobs/ops_backups/application_job.rb
 - app/jobs/ops_backups/backup_db_job.rb
 - app/jobs/ops_backups/cleanup_limit_job.rb
 - app/jobs/ops_backups/cleanup_tiered_job.rb
-- app/mailers/ops_backups/application_mailer.rb
 - app/models/ops_backups/application_record.rb
 - app/models/ops_backups/backup.rb
 - app/views/layouts/ops_backups/application.html.erb
+- app/views/ops_backups/backups/index.html.erb
 - bin/pgdb
 - bin/pgdb.sh
 - config/locales/en.yml

data/app/mailers/ops_backups/application_mailer.rb

@@ -1,6 +0,0 @@
-module OpsBackups
-  class ApplicationMailer < ActionMailer::Base
-    default from: "from@example.com"
-    layout "mailer"
-  end
-end