shipit-engine 0.38.0 → 0.40.0

data/app/controllers/shipit/github_authentication_controller.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Shipit
   class GithubAuthenticationController < ActionController::Base
     include Shipit::Engine.routes.url_helpers
@@ -11,6 +12,11 @@ module Shipit
 
       session[:user_id] = sign_in_github(auth)
 
+      # We need to set this so that the /events and /sidekiq endpoint
+      # which leverage `UserRequiredMiddleware` will recognize the user
+      # is authenticated.
+      session[:authenticated] = true
+
       redirect_to(return_url)
     end
 

data/app/controllers/shipit/merge_requests_controller.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Shipit
   class MergeRequestsController < ShipitController
     def index

data/app/controllers/shipit/merge_status_controller.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
+
 module Shipit
   class MergeStatusController < ShipitController
-    skip_authentication only: %i(check show)
+    skip_authentication only: %i[check show]
 
     etag { cache_seed }
     layout 'merge_status'
@@ -12,6 +13,7 @@ module Shipit
 
       if stack
         return render('logged_out') unless current_user.logged_in?
+
         if stale?(last_modified: [stack.updated_at, merge_request.updated_at].max, template: false)
           render(stack_status, layout: !request.xhr?)
         end
@@ -28,8 +30,8 @@ module Shipit
     end
 
     def dequeue
-      if merge_request = stack.merge_requests.find_by_number(params[:number])
-        merge_request.cancel! if merge_request.waiting?
+      if (merge_request = stack.merge_requests.find_by_number(params[:number])) && merge_request.waiting?
+        merge_request.cancel!
       end
       render(stack_status, layout: !request.xhr?)
     end
@@ -43,7 +45,7 @@ module Shipit
             render(plain: stack_status, status: 503)
           end
         end
-        format.json { render(json: { stack_status: stack_status }) }
+        format.json { render(json: { stack_status: }) }
       end
     end
 
@@ -59,23 +61,23 @@ module Shipit
 
     def stack
       @stack ||= if params[:stack_id]
-        Stack.from_param!(params[:stack_id])
-      else
-        # Null ordering is inconsistent across DBMS's, this case statement is ugly but supported universally
-        scope = Stack.order(Arel.sql('CASE WHEN locked_since IS NULL THEN 1 ELSE 0 END, locked_since'))
-          .order(merge_queue_enabled: :desc, id: :asc).includes(:repository).where(
-            repositories: {
-              owner: referrer_parser.repo_owner,
-              name: referrer_parser.repo_name,
-            },
-          )
-        scope = if params[:branch]
-          scope.where(branch: params[:branch])
-        else
-          scope.where(environment: 'production')
-        end
-        scope.first
-      end
+                   Stack.from_param!(params[:stack_id])
+                 else
+                   # Null ordering is inconsistent across DBMS's, this case statement is ugly but supported universally
+                   scope = Stack.order(Arel.sql('CASE WHEN locked_since IS NULL THEN 1 ELSE 0 END, locked_since'))
+                                .order(merge_queue_enabled: :desc, id: :asc).includes(:repository).where(
+                                  repositories: {
+                                    owner: referrer_parser.repo_owner,
+                                    name: referrer_parser.repo_name
+                                  }
+                                )
+                   scope = if params[:branch]
+                             scope.where(branch: params[:branch])
+                           else
+                             scope.where(environment: 'production')
+                           end
+                   scope.first
+                 end
     end
 
     def referrer_parser
@@ -84,12 +86,14 @@ module Shipit
 
     def merge_request
       return @merge_request if defined?(@merge_request)
+
       @merge_request = pull_request_number && stack.merge_requests.find_by_number(pull_request_number)
       @merge_request ||= UnknownMergeRequest.new
     end
 
     def pull_request_number
       return @pull_request_number if defined?(@pull_request_number)
+
       @pull_request_number = referrer_parser.pull_request_number
     end
 
@@ -113,13 +117,13 @@ module Shipit
       attr_reader :repo_owner, :repo_name, :pull_request_number
 
       def initialize(referrer)
-        if (match_info = URL_PATTERN.match(referrer.to_s))
-          @repo_owner = match_info[1].downcase
-          @repo_name = match_info[2].downcase
-          @pull_request_number = match_info[3].to_i
-        else
+        unless (match_info = URL_PATTERN.match(referrer.to_s))
           raise ArgumentError, "Invalid referrer: #{referrer.inspect}"
         end
+
+        @repo_owner = match_info[1].downcase
+        @repo_name = match_info[2].downcase
+        @pull_request_number = match_info[3].to_i
       end
     end
 

data/app/controllers/shipit/release_statuses_controller.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Shipit
   class ReleaseStatusesController < ShipitController
     before_action :load_stack

data/app/controllers/shipit/repositories_controller.rb

@@ -2,7 +2,7 @@
 
 module Shipit
   class RepositoriesController < ShipitController
-    before_action :load_repository, only: %i(destroy settings update new_stack)
+    before_action :load_repository, only: %i[destroy settings update new_stack]
 
     def index
       @user_repositories = current_user.repositories_contributed_to
@@ -21,9 +21,7 @@ module Shipit
 
     def create
       @repository = Repository.new(create_params)
-      unless @repository.save
-        flash[:warning] = @repository.errors.full_messages.to_sentence
-      end
+      flash[:warning] = @repository.errors.full_messages.to_sentence unless @repository.save
       respond_with(@repository)
     end
 
@@ -45,8 +43,7 @@ module Shipit
       redirect_to(params[:return_to].presence || repository_settings_path(@repository), options)
     end
 
-    def settings
-    end
+    def settings; end
 
     def new_stack
       @stack = @repository.stacks.new
@@ -63,7 +60,7 @@ module Shipit
       params.require(:repository).permit(
         :review_stacks_enabled,
         :provisioning_behavior,
-        :provisioning_label_name,
+        :provisioning_label_name
       )
     end
 

data/app/controllers/shipit/rollbacks_controller.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Shipit
   class RollbacksController < ShipitController
     before_action :load_stack
@@ -8,7 +9,7 @@ module Shipit
       @rollback = @deploy.trigger_rollback(
         current_user,
         env: rollback_params[:env]&.to_unsafe_hash,
-        force: params[:force].present?,
+        force: params[:force].present?
       )
       redirect_to(stack_deploy_path(@stack, @rollback))
     rescue Task::ConcurrentTaskRunning

data/app/controllers/shipit/shipit_controller.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Shipit
   class ShipitController < ApplicationController
     layout 'shipit'

data/app/controllers/shipit/stacks_controller.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
+
 module Shipit
   class StacksController < ShipitController
-    before_action :load_stack, only: %i(update destroy settings statistics clear_git_cache refresh)
+    before_action :load_stack, only: %i[update destroy settings statistics clear_git_cache refresh]
 
     def new
       @stack = Stack.new
@@ -13,10 +14,10 @@ module Shipit
       @stacks = Stack.all
       if params[:repo]
         @stacks = if (repository = Repository.from_github_repo_name(params[:repo]))
-          repository.stacks
-        else
-          Stack.none
-        end
+                    repository.stacks
+                  else
+                    Stack.none
+                  end
       end
 
       @stacks = @stacks.order(Arel.sql('(undeployed_commits_count > 0) desc'), tasks_count: :desc)
@@ -37,7 +38,7 @@ module Shipit
         scope.preload(:author, :statuses, :check_runs, :lock_author)
       end
 
-      next_expected_commit_to_deploy = @stack.next_expected_commit_to_deploy(commits: commits)
+      next_expected_commit_to_deploy = @stack.next_expected_commit_to_deploy(commits:)
 
       @active_commits = []
       @undeployed_commits = []
@@ -48,11 +49,11 @@ module Shipit
 
       @active_commits = map_to_undeployed_commit(
         @active_commits,
-        next_expected_commit_to_deploy: next_expected_commit_to_deploy,
+        next_expected_commit_to_deploy:
       )
       @undeployed_commits = map_to_undeployed_commit(
         @undeployed_commits,
-        next_expected_commit_to_deploy: next_expected_commit_to_deploy,
+        next_expected_commit_to_deploy:
       )
     end
 
@@ -64,9 +65,7 @@ module Shipit
     def create
       @stack = Stack.new(create_params)
       @stack.repository = repository
-      unless @stack.save
-        flash[:warning] = @stack.errors.full_messages.to_sentence
-      end
+      flash[:warning] = @stack.errors.full_messages.to_sentence unless @stack.save
       respond_with(@stack)
     end
 
@@ -75,8 +74,7 @@ module Shipit
       redirect_to(stacks_url)
     end
 
-    def settings
-    end
+    def settings; end
 
     def all_tasks
       @stack = Stack.from_param!(params[:id])
@@ -103,9 +101,7 @@ module Shipit
 
     def update
       options = {}
-      unless @stack.update(update_params)
-        options = { flash: { warning: @stack.errors.full_messages.to_sentence } }
-      end
+      options = { flash: { warning: @stack.errors.full_messages.to_sentence } } unless @stack.update(update_params)
 
       update_lock
       update_archived
@@ -122,30 +118,30 @@ module Shipit
     private
 
     def update_lock
-      if params[:stack].key?(:lock_reason)
-        reason = params[:stack][:lock_reason]
-        if reason.present?
-          @stack.lock(reason, current_user)
-        elsif @stack.locked?
-          @stack.unlock
-        end
+      return unless params[:stack].key?(:lock_reason)
+
+      reason = params[:stack][:lock_reason]
+      if reason.present?
+        @stack.lock(reason, current_user)
+      elsif @stack.locked?
+        @stack.unlock
       end
     end
 
     def update_archived
-      if params[:stack][:archived].present?
-        if params[:stack][:archived] == "true"
-          @stack.archive!(current_user)
-        elsif @stack.archived?
-          @stack.unarchive!
-        end
+      return unless params[:stack][:archived].present?
+
+      if params[:stack][:archived] == "true"
+        @stack.archive!(current_user)
+      elsif @stack.archived?
+        @stack.unarchive!
       end
     end
 
     def map_to_undeployed_commit(commits, next_expected_commit_to_deploy:)
       commits.map.with_index do |c, i|
         index = commits.size - i - 1
-        UndeployedCommit.new(c, index: index, next_expected_commit_to_deploy: next_expected_commit_to_deploy)
+        UndeployedCommit.new(c, index:, next_expected_commit_to_deploy:)
       end
     end
 
@@ -163,7 +159,7 @@ module Shipit
         :environment,
         :continuous_deployment,
         :ignore_ci,
-        :merge_queue_enabled,
+        :merge_queue_enabled
       )
     end
 

data/app/controllers/shipit/status_controller.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Shipit
   class StatusController < ActionController::Base
     def version

data/app/controllers/shipit/tasks_controller.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Shipit
   class TasksController < ShipitController
     include Pagination
@@ -34,7 +35,7 @@ module Shipit
           params[:definition_id],
           current_user,
           env: task_params[:env],
-          force: params[:force].present?,
+          force: params[:force].present?
         )
         redirect_to([stack, @task])
       rescue Task::ConcurrentTaskRunning
@@ -75,6 +76,7 @@ module Shipit
 
     def task_params
       return {} unless params[:task]
+
       @definition = stack.find_task_definition(params[:definition_id])
       @task_params ||= params.require(:task).permit(env: @definition.variables.map(&:name))
     end

data/app/controllers/shipit/webhooks_controller.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Shipit
   class WebhooksController < ActionController::Base
     skip_before_action :verify_authenticity_token, raise: false
@@ -33,7 +34,7 @@ module Shipit
         "event=#{event}",
         "repository_owner=#{repository_owner}",
         "signature=#{request.headers['X-Hub-Signature']}",
-        "status=#{status}",
+        "status=#{status}"
       ].join(' '))
     end
 

data/app/helpers/shipit/api_clients_helper.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Shipit
   module ApiClientsHelper
     def api_client_token(api_client)

data/app/helpers/shipit/chunks_helper.rb

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
+
 module Shipit
   module ChunksHelper
     def next_chunks_url(task, last_byte: 0)
       return if task.finished?
-      tail_stack_task_path(task.stack, task, last_byte: last_byte)
+
+      tail_stack_task_path(task.stack, task, last_byte:)
     end
   end
 end

data/app/helpers/shipit/deploys_helper.rb

@@ -1,19 +1,23 @@
 # frozen_string_literal: true
+
 module Shipit
   module DeploysHelper
     def render_checklist(checklist)
       return if checklist.blank?
-      render('shipit/deploys/checklist', checklist: checklist)
+
+      render('shipit/deploys/checklist', checklist:)
     end
 
     def render_monitoring(stack)
       return unless stack.monitoring?
-      render('shipit/deploys/monitoring', stack: stack)
+
+      render('shipit/deploys/monitoring', stack:)
     end
 
     def render_checks(commit)
       return unless commit.stack.checks?
-      render('shipit/commit_checks/checks', commit: commit)
+
+      render('shipit/commit_checks/checks', commit:)
     end
 
     def render_monitoring_panel(panel_spec)

data/app/helpers/shipit/github_url_helper.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Shipit
   module GithubUrlHelper
     private
@@ -44,10 +45,10 @@ module Shipit
     def github_pull_request_url(pull_request_or_commit)
       stack = pull_request_or_commit.stack
       number = if pull_request_or_commit.respond_to?(:pull_request_number)
-        pull_request_or_commit.pull_request_number
-      else
-        pull_request_or_commit.number
-      end
+                 pull_request_or_commit.pull_request_number
+               else
+                 pull_request_or_commit.number
+               end
       github_repo_url(stack.repo_owner, stack.repo_name, 'pull', number)
     end
 

data/app/helpers/shipit/merge_status_helper.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Shipit
   module MergeStatusHelper
     def display_commit_count_warning?(commits)

data/app/helpers/shipit/shipit_helper.rb

@@ -1,20 +1,22 @@
 # frozen_string_literal: true
+
 module Shipit
   module ShipitHelper
     def subscribe(url, *selectors)
       content_for(:update_subscription) do
         [
           tag('meta', name: 'subscription-channel', content: url),
-          *selectors.map { |s| tag('meta', name: 'subscription-selector', content: s) },
+          *selectors.map { |s| tag('meta', name: 'subscription-selector', content: s) }
         ].join("\n").html_safe
       end
     end
 
     def emojify(content)
-      if content.present?
-        h(content).to_str.gsub(/:([\w+-]+):/) do |match|
-          if emoji = Emoji.find_by_alias($1)
-            %(
+      return unless content.present?
+
+      h(content).to_str.gsub(/:([\w+-]+):/) do |match|
+        if emoji = Emoji.find_by_alias($1)
+          %(
               <img
                 alt="##{$1}"
                 src="#{image_path("emoji/#{emoji.image_filename}")}"
@@ -23,11 +25,10 @@ module Shipit
                 height="20"
               />
             )
-          else
-            match
-          end
-        end.html_safe
-      end
+        else
+          match
+        end
+      end.html_safe
     end
 
     def include_plugins(stack)

data/app/helpers/shipit/stacks_helper.rb

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
+
 module Shipit
   module StacksHelper
     def redeploy_button(deployed_commit)
       commit = UndeployedCommit.new(deployed_commit, index: 0)
       url = new_stack_deploy_path(commit.stack, sha: commit.sha)
-      classes = %W(btn btn--primary deploy-action #{commit.state})
+      classes = %W[btn btn--primary deploy-action #{commit.state}]
 
       unless commit.stack.deployable?
         classes.push(bypass_safeties? ? 'btn--warning' : 'btn--disabled')
@@ -19,21 +20,19 @@ module Shipit
 
     def deploy_button(commit)
       url = new_stack_deploy_path(commit.stack, sha: commit.sha)
-      classes = %W(btn btn--primary deploy-action #{commit.state})
+      classes = %W[btn btn--primary deploy-action #{commit.state}]
       deploy_state = commit.deploy_state(bypass_safeties?)
       data = {}
 
       if commit.deploy_disallowed?
         classes.push(bypass_safeties? ? 'btn--warning' : 'btn--disabled')
-        if deploy_state == 'blocked'
-          data[:tooltip] = t('deploy_button.hint.blocked')
-        end
+        data[:tooltip] = t('deploy_button.hint.blocked') if deploy_state == 'blocked'
       elsif commit.deploy_discouraged?
         classes.push('btn--warning')
         data[:tooltip] = t('deploy_button.hint.max_commits', maximum: commit.stack.maximum_commits_per_deploy)
       end
 
-      link_to(t("deploy_button.caption.#{deploy_state}"), url, class: classes, data: data)
+      link_to(t("deploy_button.caption.#{deploy_state}"), url, class: classes, data:)
     end
 
     def rollback_button(deploy)
@@ -41,7 +40,7 @@ module Shipit
         link_to('Deploy in progress...', '#', class: 'btn disabled deploy-action')
       else
         url = rollback_stack_deploy_path(deploy.stack, deploy)
-        classes = %w(btn btn--delete deploy-action rollback-action)
+        classes = %w[btn btn--delete deploy-action rollback-action]
 
         link_to('Rollback to this deploy...', url, class: classes)
       end
@@ -80,10 +79,10 @@ module Shipit
 
     def pull_request_link(pull_request_or_commit)
       number = if pull_request_or_commit.respond_to?(:pull_request_number)
-        pull_request_or_commit.pull_request_number
-      else
-        pull_request_or_commit.number
-      end
+                 pull_request_or_commit.pull_request_number
+               else
+                 pull_request_or_commit.number
+               end
       link_to("##{number}", github_pull_request_url(pull_request_or_commit), target: '_blank', class: 'number')
     end
 

data/app/helpers/shipit/tasks_helper.rb

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
+
 module Shipit
   module TasksHelper
     def task_description(task)
-      if task.class == Task
+      if task.instance_of?(Task)
         task.definition.action
       else
         t("#{task.class.name.demodulize.underscore.pluralize}.description", sha: task.until_commit.short_sha)

data/app/jobs/shipit/background_job/unique.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Shipit
   class BackgroundJob
     module Unique
@@ -18,7 +19,7 @@ module Shipit
           lock_key(*arguments),
           Shipit.redis,
           expiration: self.class.timeout || DEFAULT_TIMEOUT,
-          timeout: self.class.lock_timeout || 0,
+          timeout: self.class.lock_timeout || 0
         )
         mutex.lock(&block)
       rescue Redis::Lock::LockTimeout
@@ -30,7 +31,7 @@ module Shipit
       end
 
       module ClassMethods
-        ACTIONS = %i(retry drop).freeze
+        ACTIONS = %i[retry drop].freeze
         ACTIONS_LIST = ACTIONS.map(&:inspect).join(', ').freeze
         def on_duplicate(action)
           unless ACTIONS.include?(action)

data/app/jobs/shipit/background_job.rb

@@ -1,12 +1,19 @@
 # frozen_string_literal: true
+
 module Shipit
   class BackgroundJob < ActiveJob::Base
     class << self
       attr_accessor :timeout
     end
 
+    DEFAULT_RETRY_TIME_IN_SECONDS = 30
+
     # Write actions can sometimes fail intermittently, particulary for large and/or busy repositories
-    retry_on(Octokit::BadGateway, Octokit::InternalServerError)
+    retry_on(Octokit::ServerError)
+
+    rescue_from(Octokit::TooManyRequests, Octokit::AbuseDetected) do |exception|
+      retry_job wait: exception.response_headers.fetch("Retry-After", DEFAULT_RETRY_TIME_IN_SECONDS).to_i.seconds
+    end
 
     def perform(*)
       with_timeout do
@@ -18,6 +25,7 @@ module Shipit
 
     def with_timeout(&block)
       return yield unless timeout
+
       Timeout.timeout(timeout, &block)
     end
 

data/app/jobs/shipit/cache_deploy_spec_job.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Shipit
   class CacheDeploySpecJob < BackgroundJob
     include BackgroundJob::Unique
@@ -11,7 +12,7 @@ module Shipit
 
       commands = Commands.for(stack)
       commands.with_temporary_working_directory(commit: stack.commits.reachable.last) do |path|
-        stack.update!(cached_deploy_spec: DeploySpec::FileSystem.new(path, stack.environment))
+        stack.update!(cached_deploy_spec: DeploySpec::FileSystem.new(path, stack))
       end
     end
   end

data/app/jobs/shipit/chunk_rollup_job.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Shipit
   class ChunkRollupJob < BackgroundJob
     include BackgroundJob::Unique

data/app/jobs/shipit/clear_git_cache_job.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Shipit
   class ClearGitCacheJob < BackgroundJob
     queue_as :deploys