puma-redeploy 0.3.3 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 487d73d4431d3a6bf5efd0fae10ef34628480e90d4bfba3e501f3dd4c4123bf1
-  data.tar.gz: 7e5eced22b688086dc465444863b86fed4c7c2a601a69d9cfd13333ee303da9d
+  metadata.gz: 9c3ab66d43e2e0873f599be9539d9ed53a3cb9e6903559d14e99e6621948bb1a
+  data.tar.gz: 16cb84d8f89796065d3447d28af9bbfefd8b9cfc7c628536010d7053402e7ee7
 SHA512:
-  metadata.gz: 0d32a5449f932d6a16677bccfd42dad90d5f70f44622506471f2310bce41291411941a506c445c9bb8ae06af5d48e5e439e0af23fb6c889f3055da7ec902f03e
-  data.tar.gz: 7c1f4c155218fd70add589f7b13f57ed5c1fe36c93c90118c0e32dba4dedb221fc7303521f9f9ff2b578449a1c4933f98a5d351a1ad208e9e19d8756755ea7b1
+  metadata.gz: 378a9de4c851ed162ef10c3c8fe374cc9a0d54aeca59c09f94059c1371c1bad4915863a9b69f8ad7140f93a35e56efc607c5e0a4701be88859cf24f99093e27d
+  data.tar.gz: ba10ba1dd934b22cc087b81a1086481c0b08bb33d47c6939c2f06a13eefd9aa0a19fa0767fef1388cc7643be7a34ec88047d787bb62b2edcdb146e9f2b22626d

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## v0.3.4
+
+**Features:**
+
+- Add support to run commands prior to redeploy using a yaml watch file. This is useful for running a migration or bundle gems.
+
 ## v0.3.3
 
 **Fixes and enhancements:**

data/README.md

@@ -51,18 +51,24 @@ redeploy_watch_delay 15
 
 ```
 
-The watch file must contain the path to the current archive. This can be a file path or S3 URL.
-
+The watch file can contain an optional list of commands to run and the required archive_location. The archive_location can be a file path or S3 URL
 For example when using a file:
-```
-/app/pkg/test_app_0.0.3.zip
+```yaml
+---
+commands:
+  - bundle 
+archive_location: /app/pkg/test_app_0.0.3.zip
 ```
 
 For example when using S3:
-```
-s3://puma-test-app-archives/test_app_0.0.3.zip
+```yaml
+---
+commands:
+  - bundle 
+archive_location: s3://puma-test-app-archives/test_app_0.0.3.zip
 ```
 
+
 ### Archive Loader
 The `archive-loader` is a cli used to fetch and deploy the application archive prior to starting the puma server. This is useful when the application code does not exist in the runtime container.
 
@@ -76,9 +82,10 @@ Usage: archive-loader [options]. Used to load the archive prior to starting the
 
 For example this will fetch and unzip the application archive and then start puma.
 ```shell
-archive-loader -a /app -w /app/pkg/watch.me && bundle exec puma -C config/puma.rb
+archive-loader -a /app -w /app/pkg/watch.yml && bundle exec puma -C config/puma.rb
 ```
 
+
 ## Development
 
 After checking out the repo, run `bundle` to install dependencies. Then, run `rake spec` to run the tests and `rake rubocop` to check for rubocop offences. 

data/bin/archive-loader

@@ -9,7 +9,12 @@ require 'optparse'
 def deploy_archive(app_dir, watch_file, logger)
   handler = Puma::Redeploy::DeployerFactory.create(target: app_dir, watch_file:,
                                                    logger:)
-  handler.deploy(source: handler.archive_file)
+
+  watch_file_data = handler.watch_file_data
+
+  archive_file = handler.archive_file(watch_file_data[:archive_location])
+
+  handler.deploy(source: archive_file)
 end
 
 def option_parser(opts)

data/lib/puma/plugin/redeploy.rb

@@ -27,9 +27,15 @@ def monitor_loop(handler, delay, launcher, logger)
 
     next unless handler.needs_redeploy?
 
-    logger.info "Puma phased_restart begin file=#{handler.watch_file} archive=#{handler.archive_file}"
+    watch_file_data = handler.watch_file_data
 
-    handler.deploy(source: handler.archive_file)
+    archive_file = handler.archive_file(watch_file_data[:archive_location])
+
+    logger.info "Puma phased_restart begin file=#{handler.watch_file} archive=#{archive_file}"
+
+    Puma::Redeploy::CommandRunner.new(commands: watch_file_data[:commands], logger:).run
+
+    handler.deploy(source: archive_file)
 
     launcher.phased_restart
   end

data/lib/puma/redeploy/base_handler.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'forwardable'
+require 'yaml'
 
 module Puma
   module Redeploy
@@ -24,6 +25,15 @@ module Puma
 
       def_delegators :@deployer, :deploy
 
+      def watch_file_data
+        watch_file_content = read_watch_object
+        results = YAML.safe_load(watch_file_content, symbolize_names: true)
+        return results if results.is_a?(Hash)
+
+        # old style where the file contains only the archive location
+        { commands: [], archive_location: results }
+      end
+
       private
 
       attr_accessor :logger

data/lib/puma/redeploy/command_runner.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'open3'
+
+module Puma
+  module Redeploy
+    # Runs commands before redeploy process
+    class CommandRunner
+      attr_reader :commands, :runner
+
+      def initialize(commands:, logger:, runner: Open3)
+        @logger = logger
+        @commands = commands || []
+        @runner = runner
+      end
+
+      def run
+        commands.each do |command|
+          @logger.info "running command: #{command}"
+          stdout, stderr, status = runner.capture3(command)
+          @logger.info "command stdout: #{stdout}"
+          @logger.info "command status: #{status.exitstatus}"
+          @logger.error "command stderr: #{stderr}" if status.exitstatus != 0
+        end
+      end
+    end
+  end
+end

data/lib/puma/redeploy/file_handler.rb

@@ -11,12 +11,18 @@ module Puma
         @touched_at = touched_at
       end
 
-      def archive_file
-        File.read(watch_file).strip
+      def archive_file(archive_location)
+        archive_location
       end
 
       private
 
+      def read_watch_object
+        File.read(watch_file).strip
+      rescue StandardError => e
+        logger.warn "Error reading watch file #{watch_file}. Error:#{e.message}"
+      end
+
       def touched_at
         if File.exist?(watch_file)
           File.mtime(watch_file)

data/lib/puma/redeploy/s3_handler.rb

@@ -16,11 +16,10 @@ module Puma
         @touched_at = touched_at
       end
 
-      def archive_file
-        s3_url = read_watch_object
-        return unless s3_url
+      def archive_file(archive_location)
+        return unless archive_location
 
-        archive_bucket_name, archive_object_key = s3_object_reference(s3_url)
+        archive_bucket_name, archive_object_key = s3_object_reference(archive_location)
 
         response = s3_client.get_object(bucket: archive_bucket_name, key: archive_object_key)
 
@@ -29,7 +28,7 @@ module Puma
         File.binwrite(file_name, response.body.read)
         file_name
       rescue StandardError => e
-        logger.warn "Error reading fetching archive file for #{s3_url}. Error:#{e.message}"
+        logger.warn "Error reading fetching archive file for #{archive_location}. Error:#{e.message}"
       end
 
       private
@@ -49,7 +48,7 @@ module Puma
 
         object.body.read.strip
       rescue StandardError => e
-        logger.warn "Error reading url from  watch file #{bucket_name}/#{object_key}. Error:#{e.message}"
+        logger.warn "Error reading watch file #{bucket_name}/#{object_key}. Error:#{e.message}"
       end
 
       def touched_at

data/lib/puma/redeploy/version.rb

@@ -2,6 +2,6 @@
 
 module Puma
   module Redeploy
-    VERSION = '0.3.3'
+    VERSION = '0.3.4'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puma-redeploy
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.4
 platform: ruby
 authors:
 - tbeauvais
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-11-04 00:00:00.000000000 Z
+date: 2024-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-s3
@@ -50,6 +50,7 @@ files:
 - lib/puma-redeploy.rb
 - lib/puma/plugin/redeploy.rb
 - lib/puma/redeploy/base_handler.rb
+- lib/puma/redeploy/command_runner.rb
 - lib/puma/redeploy/deployer_factory.rb
 - lib/puma/redeploy/dsl.rb
 - lib/puma/redeploy/file_handler.rb