shipit-engine 0.31.0 → 0.32.0

data/app/controllers/shipit/webhooks_controller.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Shipit
   class WebhooksController < ActionController::Base
     skip_before_action :verify_authenticity_token, raise: false
@@ -9,7 +10,7 @@ module Shipit
       params = JSON.parse(request.raw_post)
       Shipit::Webhooks.for_event(event).each { |handler| handler.call(params) }
 
-      head :ok
+      head(:ok)
     end
 
     private
@@ -19,7 +20,7 @@ module Shipit
     end
 
     def check_if_ping
-      head :ok if event == 'ping'
+      head(:ok) if event == 'ping'
     end
 
     def event

data/app/helpers/shipit/chunks_helper.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Shipit
   module ChunksHelper
     def next_chunks_url(task)

data/app/helpers/shipit/deploys_helper.rb

@@ -1,18 +1,19 @@
+# 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: checklist)
     end
 
     def render_monitoring(stack)
       return unless stack.monitoring?
-      render 'shipit/deploys/monitoring', stack: stack
+      render('shipit/deploys/monitoring', stack: stack)
     end
 
     def render_checks(commit)
       return unless commit.stack.checks?
-      render 'shipit/commit_checks/checks', commit: commit
+      render('shipit/commit_checks/checks', commit: commit)
     end
 
     def render_monitoring_panel(panel_spec)

data/app/helpers/shipit/github_url_helper.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Shipit
   module GithubUrlHelper
     private

data/app/helpers/shipit/merge_status_helper.rb

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

data/app/helpers/shipit/shipit_helper.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Shipit
   module ShipitHelper
     def subscribe(url, *selectors)

data/app/helpers/shipit/stacks_helper.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Shipit
   module StacksHelper
     def redeploy_button(deployed_commit)

data/app/helpers/shipit/tasks_helper.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Shipit
   module TasksHelper
     def task_description(task)

data/app/jobs/shipit/background_job.rb

@@ -1,9 +1,13 @@
+# frozen_string_literal: true
 module Shipit
   class BackgroundJob < ActiveJob::Base
     class << self
       attr_accessor :timeout
     end
 
+    # Write actions can sometimes fail intermittently, particulary for large and/or busy repositories
+    retry_on(Octokit::BadGateway, Octokit::InternalServerError)
+
     def perform(*)
       with_timeout do
         super

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Shipit
   class BackgroundJob
     module Unique

data/app/jobs/shipit/cache_deploy_spec_job.rb

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

data/app/jobs/shipit/chunk_rollup_job.rb

@@ -1,9 +1,13 @@
+# frozen_string_literal: true
 module Shipit
   class ChunkRollupJob < BackgroundJob
     include BackgroundJob::Unique
 
     queue_as :default
 
+    self.timeout = 60
+    self.lock_timeout = 30
+
     def perform(task)
       unless task.finished?
         logger.error("Task ##{task.id} is not finished (current state: #{task.status}). Aborting.")

data/app/jobs/shipit/clear_git_cache_job.rb

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

data/app/jobs/shipit/continuous_delivery_job.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
 module Shipit
   class ContinuousDeliveryJob < BackgroundJob
     include BackgroundJob::Unique
 
-    queue_as :default
+    queue_as :deploys
     on_duplicate :drop
 
     def perform(stack)

data/app/jobs/shipit/create_on_github_job.rb

@@ -1,11 +1,16 @@
+# frozen_string_literal: true
 module Shipit
   class CreateOnGithubJob < BackgroundJob
     include BackgroundJob::Unique
 
     queue_as :default
 
+    # We observe that some objects regularly take longer than the default 10 seconds to create, e.g. deployments
+    self.timeout = 40
+    self.lock_timeout = 20
+
     def perform(record)
-      record.create_on_github!
+      record.reload.create_on_github!
     end
   end
 end

data/app/jobs/shipit/create_release_statuses_job.rb

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

data/app/jobs/shipit/deferred_touch_job.rb

@@ -1,9 +1,13 @@
+# frozen_string_literal: true
 module Shipit
   class DeferredTouchJob < BackgroundJob
     include BackgroundJob::Unique
 
     queue_as :default
 
+    self.timeout = 30
+    self.lock_timeout = 15
+
     def perform
       DeferredTouch.touch_now!
     end

data/app/jobs/shipit/deliver_hook_job.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Shipit
   class DeliverHookJob < BackgroundJob
     queue_as :hooks

data/app/jobs/shipit/destroy_job.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Shipit
   class DestroyJob < BackgroundJob
     queue_as :default

data/app/jobs/shipit/destroy_stack_job.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Shipit
   class DestroyStackJob < BackgroundJob
     queue_as :default

data/app/jobs/shipit/emit_event_job.rb

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
 module Shipit
   class EmitEventJob < BackgroundJob
     queue_as :hooks
 
     def perform(params)
       event, stack_id, payload = params.with_indifferent_access.values_at('event', 'stack_id', 'payload')
-      Hook.deliver(event, stack_id, JSON.load(payload))
+      Hook.deliver(event, stack_id, JSON.parse(payload))
     end
   end
 end

data/app/jobs/shipit/fetch_commit_stats_job.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Shipit
   class FetchCommitStatsJob < BackgroundJob
     queue_as :default

data/app/jobs/shipit/fetch_deployed_revision_job.rb

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

data/app/jobs/shipit/github_sync_job.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Shipit
   class GithubSyncJob < BackgroundJob
     include BackgroundJob::Unique
@@ -40,7 +41,7 @@ module Shipit
         end
         commits.unshift(commit)
       end
-      return commits, nil
+      [commits, nil]
     end
 
     protected

data/app/jobs/shipit/mark_deploy_healthy_job.rb

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

data/app/jobs/shipit/merge_pull_requests_job.rb

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

data/app/jobs/shipit/perform_commit_checks_job.rb

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

data/app/jobs/shipit/perform_task_job.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Shipit
   class PerformTaskJob < BackgroundJob
     queue_as :deploys
@@ -15,6 +16,7 @@ module Shipit
     end
 
     def run
+      @task.ping
       @task.run!
       checkout_repository
       perform_task
@@ -56,20 +58,25 @@ module Shipit
     end
 
     def perform_task
-      capture_all! @commands.install_dependencies
-      capture_all! @commands.perform
+      capture_all!(@commands.install_dependencies)
+      capture_all!(@commands.perform)
     end
 
     def checkout_repository
       unless @commands.fetched?(@task.until_commit).tap(&:run).success?
+        # acquire_git_cache_lock can take upto 15 seconds
+        # to process. Try to make sure that the job isn't
+        # marked dead while we attempt to acquire the lock.
+        @task.ping
         @task.acquire_git_cache_lock do
+          @task.ping
           unless @commands.fetched?(@task.until_commit).tap(&:run).success?
-            capture! @commands.fetch
+            capture!(@commands.fetch)
           end
         end
       end
-      capture_all! @commands.clone
-      capture! @commands.checkout(@task.until_commit)
+      capture_all!(@commands.clone)
+      capture!(@commands.checkout(@task.until_commit))
     end
 
     def capture_all!(commands)

data/app/jobs/shipit/purge_old_deliveries_job.rb

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

data/app/jobs/shipit/reap_dead_tasks_job.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+module Shipit
+  class ReapDeadTasksJob < BackgroundJob
+    include BackgroundJob::Unique
+    queue_as :default
+
+    def perform
+      Rails.logger.info("Reaping #{zombie_tasks.size} running tasks.")
+      zombie_tasks.each do |task|
+        Rails.logger.info("Reaping task #{task.id}: #{task.title}")
+        task.report_dead!
+      end
+    end
+
+    private
+
+    def zombie_tasks
+      @zombie_tasks ||= Task.zombies
+    end
+  end
+end

data/app/jobs/shipit/refresh_check_runs_job.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Shipit
   class RefreshCheckRunsJob < BackgroundJob
     queue_as :default

data/app/jobs/shipit/refresh_github_user_job.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Shipit
   class RefreshGithubUserJob < BackgroundJob
     queue_as :default

data/app/jobs/shipit/refresh_pull_request_job.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Shipit
   class RefreshPullRequestJob < BackgroundJob
     queue_as :default

data/app/jobs/shipit/refresh_statuses_job.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Shipit
   class RefreshStatusesJob < BackgroundJob
     queue_as :default

data/app/jobs/shipit/setup_github_hook_job.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Shipit
   class SetupGithubHookJob < BackgroundJob
     queue_as :default

data/app/jobs/shipit/update_estimated_deploy_duration_job.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Shipit
   class UpdateEstimatedDeployDurationJob < BackgroundJob
     queue_as :default

data/app/jobs/shipit/update_github_last_deployed_ref_job.rb

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
 module Shipit
   class UpdateGithubLastDeployedRefJob < BackgroundJob
     queue_as :default
 
     # We do not prefix 'refs/' because Octokit methods will do this automatically.
-    BRANCH_REF_PREFIX = 'heads'.freeze
-    DEPLOY_PREFIX = 'shipit-deploy'.freeze
+    BRANCH_REF_PREFIX = 'heads'
+    DEPLOY_PREFIX = "#{Shipit.app_name.downcase}-deploy"
 
     def perform(stack)
       stack_sha = stack.last_successful_deploy_commit&.sha
@@ -33,7 +34,7 @@ module Shipit
       client.update_ref(repo_name, ref, new_sha)
     rescue Octokit::UnprocessableEntity => e
       error_msg = e.message
-      if error_msg.include? "Reference does not exist"
+      if error_msg.include?("Reference does not exist")
         create_ref(client: client, repo_name: repo_name, ref: ref, sha: new_sha)
       else
         raise

data/app/models/concerns/shipit/deferred_touch.rb

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
 module Shipit
   module DeferredTouch
     extend ActiveSupport::Concern
 
-    SET_KEY = 'shipit:deferred_touches'.freeze
-    TMP_KEY = "#{SET_KEY}:updating".freeze
-    CACHE_KEY = "#{SET_KEY}:scheduled".freeze
+    SET_KEY = 'shipit:deferred_touches'
+    TMP_KEY = "#{SET_KEY}:updating"
+    CACHE_KEY = "#{SET_KEY}:scheduled"
     THROTTLE_TTL = 1.second
 
     included do

data/app/models/shipit/anonymous_user.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Shipit
   class AnonymousUser
     def present?
@@ -54,5 +55,9 @@ module Shipit
     def github_api
       Shipit.github.api
     end
+
+    def serializer_class
+      AnonymousUserSerializer
+    end
   end
 end

data/app/models/shipit/api_client.rb

@@ -1,5 +1,6 @@
+# frozen_string_literal: true
 module Shipit
-  class ApiClient < ActiveRecord::Base
+  class ApiClient < Record
     InsufficientPermission = Class.new(StandardError)
 
     belongs_to :creator, class_name: 'User'
@@ -16,7 +17,7 @@ module Shipit
       read:hook
       write:hook
     ).freeze
-    validates :permissions, subset: {of: PERMISSIONS}
+    validates :permissions, subset: { of: PERMISSIONS }
 
     class << self
       def authenticate(token)

data/app/models/shipit/application_record.rb

@@ -1,5 +1,6 @@
+# frozen_string_literal: true
 module Shipit
-  class ApplicationRecord < ActiveRecord::Base
+  class ApplicationRecord < Record
     self.abstract_class = true
   end
 end

data/app/models/shipit/check_run.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
 module Shipit
   class CheckRun < ApplicationRecord
-    CONCLUSIONS = %w(success failure neutral cancelled timed_out action_required).freeze
+    CONCLUSIONS = %w(success failure neutral cancelled timed_out action_required stale).freeze
     include DeferredTouch
     include Status::Common
 
@@ -9,7 +10,7 @@ module Shipit
 
     deferred_touch commit: :updated_at
 
-    validates :conclusion, inclusion: {in: CONCLUSIONS, allow_nil: true}
+    validates :conclusion, inclusion: { in: CONCLUSIONS, allow_nil: true }
 
     after_create :enable_ci_on_stack
 
@@ -45,7 +46,7 @@ module Shipit
         'pending'
       when 'success', 'neutral'
         'success'
-      when 'failure', 'cancelled'
+      when 'failure', 'cancelled', 'stale'
         'failure'
       when 'timed_out'
         'error'