barbeque 2.8.0 → 2.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: febc8fb62981217cb94e9614ebe9c303045555802bb010890ff796ae94024996
-  data.tar.gz: 10953be24a7344776dfee42281a7de2004b6abbfefb10b8b994f26fc4a6b8ec6
+  metadata.gz: 7d5e37ff72ac6ed67071323a08ab28f43f33ae77c122aa6b209f2595b2ce6ddf
+  data.tar.gz: c490c08d35500bd1d5c4525a304cb523e459791324d7b6db423c2a681e68e1c6
 SHA512:
-  metadata.gz: 30d5b1f6ca098e0c932cf27266b30e2f24c50a08de8475c53fa8cc3d480b06e58ccb30a6aa26df7bc3e5672196f2f91f6f2ead8815ce27f1fca23402ea04d259
-  data.tar.gz: bdd41760b5cc5e1f04e24bd2ca3626d7b71839a381c308ccc3477579e35a12e175177e4772ab3f992187bb2e7ec73e270a4a09f1daeedf1c5080801b86c41857
+  metadata.gz: 1881c7c91adf7dbc78317684d91aa24b6bd1c26118449564cf050f16e0fae6a807a46e553b3f9b363a4aaff8bc2292f8b9d52d8aa9382bf5103efd6eb2925074
+  data.tar.gz: 8ad58ebb5f384041e5ec1ec63766f24560fc5910b0f124b3b7b46bdc9cd0a540e799f774adf1814e60dee2dc8305fb06d84703ae52dfc5b8f0890b660ebe7eb7

data/app/controllers/barbeque/job_definitions_controller.rb

@@ -60,7 +60,7 @@ class Barbeque::JobDefinitionsController < Barbeque::ApplicationController
   def destroy
     @job_definition = Barbeque::JobDefinition.find(params[:id])
     @job_definition.sns_subscriptions.each do |sns_subscription|
-      Barbeque::SNSSubscriptionService.new.unsubscribe(sns_subscription)
+      Barbeque::SnsSubscriptionService.new.unsubscribe(sns_subscription)
     end
     @job_definition.destroy
     redirect_to job_definitions_url, notice: 'Job definition was successfully destroyed.'

data/app/controllers/barbeque/sns_subscriptions_controller.rb

@@ -1,24 +1,24 @@
 class Barbeque::SnsSubscriptionsController < Barbeque::ApplicationController
   def index
-    @sns_subscriptions = Barbeque::SNSSubscription.all
+    @sns_subscriptions = Barbeque::SnsSubscription.all
   end
 
   def show
-    @sns_subscription = Barbeque::SNSSubscription.find(params[:id])
+    @sns_subscription = Barbeque::SnsSubscription.find(params[:id])
   end
 
   def new
     @sns_topic_arns = fetch_sns_topic_arns
-    @sns_subscription = Barbeque::SNSSubscription.new
+    @sns_subscription = Barbeque::SnsSubscription.new
   end
 
   def edit
-    @sns_subscription = Barbeque::SNSSubscription.find(params[:id])
+    @sns_subscription = Barbeque::SnsSubscription.find(params[:id])
   end
 
   def create
-    @sns_subscription = Barbeque::SNSSubscription.new(params.require(:sns_subscription).permit(:topic_arn, :job_queue_id, :job_definition_id))
-    if Barbeque::SNSSubscriptionService.new.subscribe(@sns_subscription)
+    @sns_subscription = Barbeque::SnsSubscription.new(params.require(:sns_subscription).permit(:topic_arn, :job_queue_id, :job_definition_id))
+    if Barbeque::SnsSubscriptionService.new.subscribe(@sns_subscription)
       redirect_to @sns_subscription, notice: 'SNS subscription was successfully created.'
     else
       @sns_topic_arns = fetch_sns_topic_arns
@@ -27,7 +27,7 @@ class Barbeque::SnsSubscriptionsController < Barbeque::ApplicationController
   end
 
   def update
-    @sns_subscription = Barbeque::SNSSubscription.find(params[:id])
+    @sns_subscription = Barbeque::SnsSubscription.find(params[:id])
     if @sns_subscription.update(params.require(:sns_subscription).permit(:job_definition_id))
       redirect_to @sns_subscription, notice: 'SNS subscription was successfully updated.'
     else
@@ -36,14 +36,14 @@ class Barbeque::SnsSubscriptionsController < Barbeque::ApplicationController
   end
 
   def destroy
-    sns_subscription = Barbeque::SNSSubscription.find(params[:id])
-    Barbeque::SNSSubscriptionService.new.unsubscribe(sns_subscription)
+    sns_subscription = Barbeque::SnsSubscription.find(params[:id])
+    Barbeque::SnsSubscriptionService.new.unsubscribe(sns_subscription)
     redirect_to sns_subscriptions_path, notice: 'SNS subscription was successfully destroyed.'
   end
-  
+
   private
 
   def fetch_sns_topic_arns
-    Barbeque::SNSSubscriptionService.sns_client.list_topics.flat_map(&:topics).map(&:topic_arn)
+    Barbeque::SnsSubscriptionService.sns_client.list_topics.flat_map(&:topics).map(&:topic_arn)
   end
 end

data/app/models/barbeque/job_definition.rb

@@ -1,7 +1,7 @@
 class Barbeque::JobDefinition < Barbeque::ApplicationRecord
   belongs_to :app
   has_many :job_executions
-  has_many :sns_subscriptions, class_name: 'SNSSubscription'
+  has_many :sns_subscriptions
   has_one :slack_notification, dependent: :destroy
   has_one :retry_config, dependent: :destroy
 

data/app/models/barbeque/job_queue.rb

@@ -5,7 +5,7 @@ class Barbeque::JobQueue < Barbeque::ApplicationRecord
   SQS_NAME_MAX_LENGTH = 80
 
   has_many :job_executions
-  has_many :sns_subscriptions, class_name: 'SNSSubscription', dependent: :destroy
+  has_many :sns_subscriptions, dependent: :destroy
 
   # SQS queue allows [a-zA-Z0-9_-]+ as queue name. Its maximum length is 80.
   validates :name, presence: true, uniqueness: true, format: /\A[a-zA-Z0-9_-]+\z/,

data/app/models/barbeque/sns_subscription.rb

@@ -1,5 +1,5 @@
 module Barbeque
-  class SNSSubscription < ApplicationRecord
+  class SnsSubscription < ApplicationRecord
     belongs_to :job_queue
     belongs_to :job_definition
     has_one :app, through: :job_definition

data/app/services/barbeque/sns_subscription_service.rb

@@ -1,7 +1,7 @@
 require 'aws-sdk-sns'
 require 'aws-sdk-sqs'
 
-class Barbeque::SNSSubscriptionService
+class Barbeque::SnsSubscriptionService
   def self.sqs_client
     @sqs_client ||= Aws::SQS::Client.new
   end
@@ -10,7 +10,7 @@ class Barbeque::SNSSubscriptionService
     @sns_client ||= Aws::SNS::Client.new
   end
 
-  # @param [Barbeque::SNSSubscription] sns_subscription
+  # @param [Barbeque::SnsSubscription] sns_subscription
   # @return [Boolean] `true` if succeeded to subscribe
   def subscribe(sns_subscription)
     if sns_subscription.valid?
@@ -20,10 +20,10 @@ class Barbeque::SNSSubscriptionService
         update_sqs_policy!(sns_subscription)
         true
       rescue Aws::SNS::Errors::AuthorizationError
-        sns_subscription.errors[:topic_arn] << 'is not authorized'
+        sns_subscription.errors.add(:topic_arn, 'is not authorized')
         false
       rescue Aws::SNS::Errors::NotFound
-        sns_subscription.errors[:topic_arn] << 'is not found'
+        sns_subscription.errors.add(:topic_arn, 'is not found')
         false
       end
     else
@@ -31,7 +31,7 @@ class Barbeque::SNSSubscriptionService
     end
   end
 
-  # @param [Barbeque::SNSSubscription] sns_subscription
+  # @param [Barbeque::SnsSubscription] sns_subscription
   def unsubscribe(sns_subscription)
     sns_subscription.destroy
     update_sqs_policy!(sns_subscription)
@@ -42,14 +42,14 @@ class Barbeque::SNSSubscriptionService
   private
 
   def sqs_client
-    Barbeque::SNSSubscriptionService.sqs_client
+    Barbeque::SnsSubscriptionService.sqs_client
   end
 
   def sns_client
-    Barbeque::SNSSubscriptionService.sns_client
+    Barbeque::SnsSubscriptionService.sns_client
   end
 
-  # @param [Barbeque::SNSSubscription] sns_subscription
+  # @param [Barbeque::SnsSubscription] sns_subscription
   def update_sqs_policy!(sns_subscription)
     attrs = sqs_client.get_queue_attributes(
       queue_url: sns_subscription.job_queue.queue_url,
@@ -90,7 +90,7 @@ class Barbeque::SNSSubscriptionService
     }.to_json
   end
 
-  # @param [Barbeque::SNSSubscription] sns_subscription
+  # @param [Barbeque::SnsSubscription] sns_subscription
   def subscribe_topic!(sns_subscription)
     sqs_attrs = sqs_client.get_queue_attributes(
       queue_url: sns_subscription.job_queue.queue_url,
@@ -105,7 +105,7 @@ class Barbeque::SNSSubscriptionService
     )
   end
 
-  # @param [Barbeque::SNSSubscription] sns_subscription
+  # @param [Barbeque::SnsSubscription] sns_subscription
   def unsubscribe_topic!(sns_subscription)
     sqs_attrs = sqs_client.get_queue_attributes(
       queue_url: sns_subscription.job_queue.queue_url,

data/db/migrate/20240415080757_fix_collations.rb

@@ -0,0 +1,34 @@
+# In MySQL 8.0, the default collation for utf8mb4 is changed to utf8mb4_0900_ai_ci.
+# The column collations are utf8mb4_0900_ai_ci after we ran migrations prior to this
+# on MySQL 8.0 because we did not specify collation in create_table (thus the default is used).
+# This happens on testing/development but we want to keep utf8mb4_general_ci.
+#
+# Note that running this should not affect the actual schema and data
+# unless you've ran prior migrations on MySQL 8.0.
+class FixCollations < ActiveRecord::Migration[6.1]
+  def change
+    reversible do |direction|
+      direction.up do
+        # alter column collations and default collation of every tables defined to utf8mb4_general_ci
+        execute 'ALTER TABLE barbeque_apps CONVERT TO CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci'
+        execute 'ALTER TABLE barbeque_docker_containers CONVERT TO CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci'
+        execute 'ALTER TABLE barbeque_ecs_hako_tasks CONVERT TO CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci'
+        execute 'ALTER TABLE barbeque_job_executions CONVERT TO CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci'
+        execute 'ALTER TABLE barbeque_job_queues CONVERT TO CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci'
+        execute 'ALTER TABLE barbeque_job_retries CONVERT TO CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci'
+        execute 'ALTER TABLE barbeque_retry_configs CONVERT TO CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci'
+        execute 'ALTER TABLE barbeque_slack_notifications CONVERT TO CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci'
+        execute 'ALTER TABLE barbeque_sns_subscriptions CONVERT TO CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci'
+
+        # barbeque_job_definitions contains a column with explicitly specified collation
+        execute 'ALTER TABLE barbeque_job_definitions DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci'
+        change_column :barbeque_job_definitions, :command, :string, collation: 'utf8mb4_general_ci'
+        change_column :barbeque_job_definitions, :description, :text, collation: 'utf8mb4_general_ci'
+      end
+
+      direction.down do
+        raise ActiveRecord::IrreversibleMigration
+      end
+    end
+  end
+end

data/lib/barbeque/exception_handler.rb

@@ -51,5 +51,32 @@ module Barbeque
         ::Raven.capture_exception(e)
       end
     end
+
+    class Sentry
+      def initialize
+        ::Sentry.get_current_hub.push_scope
+      end
+
+      def clear_context
+        ::Sentry.get_current_hub.pop_scope
+        ::Sentry.get_current_hub.push_scope
+      end
+
+      # @param [String] message_id
+      # @param [String, nil] message_type
+      def set_message_context(message_id, message_type)
+        ::Sentry.configure_scope do |scope|
+          scope.set_tags(
+            message_id: message_id,
+            message_type: message_type
+          )
+        end
+      end
+
+      # @param [Exception] e
+      def handle_exception(e)
+        ::Sentry.capture_exception(e)
+      end
+    end
   end
 end

data/lib/barbeque/executor/docker.rb

@@ -9,7 +9,7 @@ module Barbeque
       class DockerCommandError < StandardError
       end
 
-      def initialize(_options)
+      def initialize(**)
       end
 
       # @param [Barbeque::JobExecution] job_execution

data/lib/barbeque/executor/hako.rb

@@ -18,7 +18,7 @@ module Barbeque
       # @param [String] yaml_dir (deprecated: renamed to definition_dir)
       def initialize(hako_dir:, hako_env: {}, yaml_dir: nil, definition_dir: nil, oneshot_notification_prefix:)
         @hako_dir = hako_dir
-        @hako_env = hako_env
+        @hako_env = hako_env.stringify_keys
         @definition_dir =
           if definition_dir
             definition_dir

data/lib/barbeque/executor.rb

@@ -23,7 +23,7 @@ module Barbeque
   module Executor
     def self.create
       klass = const_get(Barbeque.config.executor, false)
-      klass.new(Barbeque.config.executor_options)
+      klass.new(**Barbeque.config.executor_options)
     end
   end
 end

data/lib/barbeque/message/notification.rb

@@ -8,7 +8,7 @@ module Barbeque
       attr_reader :application # [String] To specify `job_definitions.app.name`
       attr_reader :job         # [String] To specify `job_definitions.job`
 
-      # @param [Barneque::SNSSubscription] subscription
+      # @param [Barneque::SnsSubscription] subscription
       # @return [Barbeque::Message::Notification]
       def set_params_from_subscription(subscription)
         @application = subscription.app.name

data/lib/barbeque/message_handler/notification.rb

@@ -9,7 +9,7 @@ module Barbeque
         @message = message
         @message_queue = message_queue
 
-        subscription = SNSSubscription.find_by!(topic_arn: @message.topic_arn, job_queue_id: @message_queue.job_queue.id)
+        subscription = SnsSubscription.find_by!(topic_arn: @message.topic_arn, job_queue_id: @message_queue.job_queue.id)
         @message.set_params_from_subscription(subscription)
       end
     end

data/lib/barbeque/version.rb

@@ -1,3 +1,3 @@
 module Barbeque
-  VERSION = '2.8.0'
+  VERSION = '2.9.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: barbeque
 version: !ruby/object:Gem::Version
-  version: 2.8.0
+  version: 2.9.0
 platform: ruby
 authors:
 - Takashi Kokubun
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-23 00:00:00.000000000 Z
+date: 2025-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: adminlte2-rails
@@ -156,14 +156,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.2.0
+        version: 6.1.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.2.0
+        version: 6.1.4
 - !ruby/object:Gem::Dependency
   name: rinku
   requirement: !ruby/object:Gem::Requirement
@@ -426,6 +426,7 @@ files:
 - db/migrate/20190311034445_add_notify_failure_only_if_retry_limit_reached_to_barbeque_slack_notifications.rb
 - db/migrate/20190315052951_change_barbeque_retry_configs_base_delay_default_value.rb
 - db/migrate/20191029105530_change_job_name_to_case_sensitive.rb
+- db/migrate/20240415080757_fix_collations.rb
 - lib/barbeque.rb
 - lib/barbeque/config.rb
 - lib/barbeque/docker_image.rb
@@ -476,7 +477,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.2.33
 signing_key:
 specification_version: 4
 summary: Job queue system to run job with Docker