bard-api 0.5.1 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 247fb68f718adad762c323e0d6fc04515553de744e4a3ebe35a327707fc1e728
-  data.tar.gz: c59cf65732a9cc8d17486e2ff20ae35535677b30952b104f29d69442d8606c61
+  metadata.gz: 563830ec8c572c92d9ccfe0baacef1e2e24746600e7a8d8508a3fe2819c6650e
+  data.tar.gz: f015d645e8d3bee75b1975b496ae53a93dc7e3bceeb2f21489a954e142862209
 SHA512:
-  metadata.gz: 75e2d1c6d652fa389be4ccdf465d6678c8c84287f8fccc5fee548233c1b4fabdcce9f0759d7f530a1e446dd386ec818833f7929988d8498a37c329a2abfde3e8
-  data.tar.gz: 65c8245cafc0e13d5f5c47c3ece4fcae6b9c0ef0e8028958c2261d83f8f68ad7ecb62841b07273acd8d2a40c3a47ebcf27a0edfb5eb0d20221054ff83cd566d7
+  metadata.gz: 9f49e14b5cb6ab5b9a56c7b5f138d17c725ccdea8c995f9e9e811580ff0cb7801a65c77ce3ee7a6bc8e93cbc4dfb5748702c858873488e9551da8bc63356a518
+  data.tar.gz: ccfa6aec43edc4d1f30b23cb92b837e9535ef46f1e3b997791bcd0d0a25bb38b736682ef5a468d28652297b670cd0b80d6ebb8f30a8c9444bd446589d25b4290

data/README.md

@@ -11,19 +11,20 @@ The bard-api gem enables BARD Tracker to manage Rails applications through a RES
 
 ## Usage
 
-### Mounting in Rails
+### Mounting
 
-Add to your `config/routes.rb`:
+With `bard-rails` this mounts automatically at `/bard` — nothing to do. Otherwise add to your
+`config/routes.rb`:
 
 ```ruby
-mount Bard::Api::App.new => "/bard-api"
+mount Bard::Api::App.new => "/bard"
 ```
 
-This makes the API available at `/bard-api/*` endpoints.
+Either way the API is served at `/bard/*`.
 
 ### Endpoints
 
-#### GET /bard-api/health
+#### GET /bard/health
 
 Health check endpoint (no authentication required).
 
@@ -34,7 +35,7 @@ Health check endpoint (no authentication required).
 }
 ```
 
-#### POST /bard-api/backups
+#### POST /bard/backups
 
 Trigger a backup (requires JWT authentication).
 
@@ -67,7 +68,7 @@ Authorization: Bearer <jwt-token>
 }
 ```
 
-#### GET /bard-api/backups/latest
+#### GET /bard/backups/latest
 
 Get status of most recent backup (requires JWT authentication).
 
@@ -98,7 +99,7 @@ Authorization: Bearer <jwt-token>
 }
 ```
 
-#### GET /bard-api/config
+#### GET /bard/config
 
 Read the project's live backup and uptime configuration (requires JWT authentication). Used by axis to discover what each project actually has deployed.
 

data/lib/bard/api/app.rb

@@ -2,12 +2,51 @@
 
 require "rack"
 require "json"
+require "bundler"
 require_relative "auth"
 require "bard/backup"
 
 module Bard
   module Api
     class App
+      class << self
+        attr_writer :backup_runner, :deploy_runner
+
+        # Runs the backup task out-of-band so the request returns immediately.
+        # Override to wire backups into a project's own job queue.
+        def backup_runner
+          @backup_runner ||= ->(task) { Thread.new { task.call } }
+        end
+
+        # bin/setup restarts Puma via `procsd restart` → `systemctl --user restart`, which
+        # SIGKILLs the app unit's whole cgroup. So the deploy can't run in this worker (or any
+        # plain child of it) — it'd be killed mid-deploy. We run it in its own systemd --user
+        # scope: a separate cgroup that survives the restart.
+        def deploy_runner
+          @deploy_runner ||= method(:spawn_detached_deploy)
+        end
+
+        # with_unbundled_env is essential: this worker runs under the app's bundle
+        # (RUBYOPT=-rbundler/setup, BUNDLE_GEMFILE). Inherited into the deploy, that makes every
+        # ruby command — bundle install included — crash at startup the moment git pull lands a
+        # lockfile with not-yet-installed gems. The deploy must start from a clean env.
+        def spawn_detached_deploy(command)
+          Bundler.with_unbundled_env do
+            pid = Process.spawn(
+              "systemd-run", "--user", "--scope", "--collect", "--quiet", "bash", "-lc", command,
+              :in => "/dev/null", %i[out err] => ["log/bard-deploy.log", "a"],
+            )
+            Process.detach(pid)
+          end
+        end
+      end
+
+      DEPLOY_LOCK = "tmp/bard-deploy.lock"
+      DEPLOYED_SHA = "tmp/bard-deployed.sha"
+      # Record the deployed sha only after bin/setup fully succeeds — a bare `git pull` advances
+      # HEAD before the bundle/migrate/restart run, so HEAD alone would read as "done" too early.
+      DEPLOY_COMMAND = "flock -n #{DEPLOY_LOCK} -c 'git pull --ff-only origin master && bin/setup && git rev-parse HEAD > #{DEPLOYED_SHA}'"
+
       def call(env)
         request = Rack::Request.new(env)
         method = request.request_method
@@ -22,6 +61,8 @@ module Bard
           latest_backup(request)
         when ["GET", "/config"]
           config(request)
+        when ["POST", "/deploy"]
+          create_deploy(request)
         else
           not_found
         end
@@ -40,13 +81,30 @@ module Bard
           s3 = payload["s3"].transform_keys(&:to_sym)
           project_name = Bard::Config.current.project_name
 
-          backup = Bard::Backup.create!(
-            type: :s3,
-            path: "bard-backup/#{project_name}",
-            **s3,
-          )
+          self.class.backup_runner.call(-> { run_backup(project_name, s3) })
 
-          json_response(200, backup.as_json)
+          json_response(202, { status: "started" })
+        end
+      end
+
+      def run_backup(project_name, s3)
+        Bard::Backup.create!(
+          type: :s3,
+          path: "bard-backup/#{project_name}",
+          **s3,
+        )
+      rescue => e
+        log_backup_error(e)
+      end
+
+      def log_backup_error(error)
+        message = "[bard-api] backup failed: #{error.class}: #{error.message}"
+        if defined?(Rails) && Rails.respond_to?(:logger) && Rails.logger
+          Rails.logger.error(message)
+          Rails.logger.error(error.backtrace.join("\n")) if error.backtrace
+        else
+          warn message
+          warn error.backtrace.join("\n") if error.backtrace
         end
       end
 
@@ -65,6 +123,39 @@ module Bard
         end
       end
 
+      # Unauthenticated on purpose: it can only fast-forward prod to origin/master (master IS prod)
+      # and is a no-op when already there.
+      #
+      # bin/setup restarts Puma, so we can't run the deploy in this worker thread — the restart
+      # would kill it mid-flight. We hand off to an out-of-band process (its own systemd scope,
+      # see .deploy_runner), serialize concurrent deploys with an flock, and return 202
+      # immediately. The caller polls until HEAD == sha.
+      def create_deploy(request)
+        target = JSON.parse(request.body.read)["sha"]
+        sha = current_sha
+        return json_response(200, { status: "noop", sha: sha }) if target == sha
+        return json_response(409, { status: "deploying", sha: sha }) if deploy_in_progress?
+
+        self.class.deploy_runner.call(DEPLOY_COMMAND)
+        json_response(202, { status: "deploying", sha: sha })
+      end
+
+      # The last FULLY deployed sha (bin/setup succeeded), not merely where git HEAD points.
+      # Absent marker => nothing has completed yet, so it can never match the requested sha and
+      # the caller keeps polling until bin/setup writes it — or times out on a real failure.
+      def current_sha
+        return "" unless File.exist?(DEPLOYED_SHA)
+        File.read(DEPLOYED_SHA).chomp
+      end
+
+      def deploy_in_progress?
+        File.open(DEPLOY_LOCK, File::RDWR | File::CREAT, 0o644) do |lock|
+          acquired = lock.flock(File::LOCK_EX | File::LOCK_NB)
+          lock.flock(File::LOCK_UN) if acquired
+          !acquired
+        end
+      end
+
       def serialize_config(bard_config)
         backup = bard_config.backup
         production = bard_config.targets[:production]

data/lib/bard/api/version.rb

@@ -2,6 +2,6 @@
 
 module Bard
   module Api
-    VERSION = "0.5.1"
+    VERSION = "0.6.1"
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: bard-api
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.1
 platform: ruby
 authors:
 - Micah Geisel
 bindir: exe
 cert_chain: []
-date: 2026-05-17 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jwt
@@ -131,7 +131,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 4.0.6
 specification_version: 4
 summary: REST API for BARD-managed Rails projects
 test_files: []