shipit-engine 0.31.0 → 0.35.0

data/app/controllers/shipit/status_controller.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
 module Shipit
   class StatusController < ActionController::Base
     def version
-      render plain: Shipit.revision
+      render(plain: Shipit.revision)
     end
   end
 end

data/app/controllers/shipit/tasks_controller.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Shipit
   class TasksController < ShipitController
     include Pagination
@@ -21,7 +22,7 @@ module Shipit
       task
       respond_to do |format|
         format.html
-        format.text { render plain: @task.chunk_output }
+        format.text { render(plain: @task.chunk_output) }
       end
     end
 
@@ -35,25 +36,25 @@ module Shipit
           env: task_params[:env],
           force: params[:force].present?,
         )
-        redirect_to [stack, @task]
+        redirect_to([stack, @task])
       rescue Task::ConcurrentTaskRunning
-        redirect_to new_stack_tasks_path(stack, @definition)
+        redirect_to(new_stack_tasks_path(stack, @definition))
       end
     end
 
     def abort
       task.abort!(rollback_once_aborted: params[:rollback].present?, aborted_by: current_user)
-      head :ok
+      head(:ok)
     end
 
     def tail
-      render json: TailTaskSerializer.new(task, context: params)
+      render(json: TailTaskSerializer.new(task, context: { last_byte: params[:last_byte].to_i }))
     end
 
     def lookup
       @task = Task.find(params[:id])
 
-      redirect_to url_for_task
+      redirect_to(url_for_task)
     end
 
     private

data/app/controllers/shipit/webhooks_controller.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
 module Shipit
   class WebhooksController < ActionController::Base
     skip_before_action :verify_authenticity_token, raise: false
-    before_action :check_if_ping, :verify_signature
+    before_action :check_if_ping, :drop_unhandled_event, :verify_signature
 
     respond_to :json
 
@@ -9,25 +10,44 @@ module Shipit
       params = JSON.parse(request.raw_post)
       Shipit::Webhooks.for_event(event).each { |handler| handler.call(params) }
 
-      head :ok
+      head(:ok)
     end
 
     private
 
+    def drop_unhandled_event
+      # Acknowledge, but do nothing
+      head(204) unless Shipit::Webhooks.for_event(event).present?
+    end
+
     def verify_signature
-      head(422) unless Shipit.github.verify_webhook_signature(request.headers['X-Hub-Signature'], request.raw_post)
+      github_app = Shipit.github(organization: repository_owner)
+      verified = github_app.verify_webhook_signature(
+        request.headers['X-Hub-Signature'],
+        request.raw_post
+      )
+      head(422) unless verified
+
+      Rails.logger.info([
+        'WebhookController#verify_signature',
+        "event=#{event}",
+        "repository_owner=#{repository_owner}",
+        "signature=#{request.headers['X-Hub-Signature']}",
+        "status=#{status}",
+      ].join(' '))
     end
 
     def check_if_ping
-      head :ok if event == 'ping'
+      head(:ok) if event == 'ping'
     end
 
     def event
       request.headers.fetch('X-Github-Event')
     end
 
-    def stack
-      @stack ||= Stack.find(params[:stack_id])
+    def repository_owner
+      # Fallback to the organization sub-object if repository isn't included in the payload
+      params.dig('repository', 'owner', 'login') || params.dig('organization', 'login')
     end
   end
 end

data/app/helpers/shipit/chunks_helper.rb

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

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
@@ -50,6 +51,14 @@ module Shipit
       github_repo_url(stack.repo_owner, stack.repo_name, 'pull', number)
     end
 
+    def stack_github_url(stack)
+      if stack.respond_to?(:pull_request) && stack.pull_request
+        github_pull_request_url(stack.pull_request)
+      else
+        github_repo_url(stack.repo_owner, stack.repo_name)
+      end
+    end
+
     def link_to_github_deploy(deploy)
       url = github_commit_range_url(deploy.stack, *deploy.commit_range)
       text = deploy.commit_range.map(&:short_sha).join('...')

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)
@@ -42,7 +43,6 @@ module Shipit
     end
 
     def missing_github_app_message
-      # TODO: Document how to create an app
       <<-MESSAGE.html_safe
         Shipit requires a GitHub App to authenticate users and perform API calls.
       MESSAGE

data/app/helpers/shipit/stacks_helper.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Shipit
   module StacksHelper
     def redeploy_button(deployed_commit)
@@ -90,5 +91,9 @@ module Shipit
     def positive_negative_class(value)
       value.to_f >= 0 ? 'positive' : 'negative'
     end
+
+    def contributor_class(stacks_contributed_to, stack_id)
+      stacks_contributed_to.include?(stack_id) ? "contributor" : "not-matching"
+    end
   end
 end

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/unique.rb

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

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/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,17 @@
+# frozen_string_literal: true
 module Shipit
   class CreateOnGithubJob < BackgroundJob
     include BackgroundJob::Unique
 
     queue_as :default
+    on_duplicate :drop
+
+    # 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,9 +1,10 @@
+# frozen_string_literal: true
 module Shipit
   class DeliverHookJob < BackgroundJob
     queue_as :hooks
 
     def perform(delivery)
-      delivery = Hook::DeliverySpec.new(delivery) if delivery.is_a?(Hash)
+      delivery = Hook::DeliverySpec.new(**delivery) if delivery.is_a?(Hash)
       delivery.send!
     end
   end

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_repository_job.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+module Shipit
+  class DestroyRepositoryJob < BackgroundJob
+    queue_as :default
+
+    # repository
+    # +-- stacks
+    #     +-- api_clients
+    #     +-- commits
+    #     |   +-- commit_deployments
+    #     |   |   +-- statuses
+    #     |   +-- statuses
+    #     +-- github_hooks
+    #     +-- hooks
+    #     +-- pull_requests
+    #     +-- tasks
+    #         +-- chunks
+
+    def perform(repository)
+      repository.stacks.each { |stack| DestroyStackJob.perform_now(stack) }
+      repository.destroy!
+    end
+  end
+end

data/app/jobs/shipit/destroy_stack_job.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Shipit
   class DestroyStackJob < BackgroundJob
     queue_as :default
@@ -10,7 +11,7 @@ module Shipit
     # |   +-- statuses
     # +-- github_hooks
     # +-- hooks
-    # +-- pull_requests
+    # +-- merge_requests
     # +-- tasks
     #     +-- chunks
 
@@ -25,7 +26,7 @@ module Shipit
       Shipit::Commit.where(id: commits_ids).delete_all
       Shipit::GithubHook.where(stack_id: stack.id).destroy_all
       Shipit::Hook.where(stack_id: stack.id).delete_all
-      Shipit::PullRequest.where(stack_id: stack.id).delete_all
+      Shipit::MergeRequest.where(stack_id: stack.id).delete_all
       tasks_ids.each_slice(100) do |ids|
         Shipit::OutputChunk.where(task_id: ids).delete_all
         Shipit::Task.where(id: ids).delete_all

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,9 +1,13 @@
+# frozen_string_literal: true
 module Shipit
   class GithubSyncJob < BackgroundJob
     include BackgroundJob::Unique
 
+    attr_reader :stack
+
     MAX_FETCHED_COMMITS = 25
     queue_as :default
+    on_duplicate :drop
 
     self.timeout = 60
     self.lock_timeout = 20
@@ -12,26 +16,27 @@ module Shipit
       @stack = Stack.find(params[:stack_id])
 
       handle_github_errors do
-        new_commits, shared_parent = fetch_missing_commits { @stack.github_commits }
+        new_commits, shared_parent = fetch_missing_commits { stack.github_commits }
 
-        @stack.transaction do
+        stack.transaction do
           shared_parent&.detach_children!
           appended_commits = new_commits.map do |gh_commit|
             append_commit(gh_commit)
           end
-          @stack.lock_reverted_commits! if appended_commits.any?(&:revert?)
+          stack.lock_reverted_commits! if appended_commits.any?(&:revert?)
         end
       end
-      CacheDeploySpecJob.perform_later(@stack)
+      CacheDeploySpecJob.perform_later(stack)
     end
 
     def append_commit(gh_commit)
-      @stack.commits.create_from_github!(gh_commit)
+      stack.commits.create_from_github!(gh_commit)
     end
 
     def fetch_missing_commits(&block)
       commits = []
-      iterator = Shipit::FirstParentCommitsIterator.new(&block)
+      github_api = stack&.github_api
+      iterator = Shipit::FirstParentCommitsIterator.new(github_api: github_api, &block)
       iterator.each_with_index do |commit, index|
         break if index >= MAX_FETCHED_COMMITS
 
@@ -40,7 +45,7 @@ module Shipit
         end
         commits.unshift(commit)
       end
-      return commits, nil
+      [commits, nil]
     end
 
     protected
@@ -48,13 +53,13 @@ module Shipit
     def handle_github_errors
       yield
     rescue Octokit::NotFound
-      @stack.mark_as_inaccessible!
+      stack.mark_as_inaccessible!
     else
-      @stack.mark_as_accessible!
+      stack.mark_as_accessible!
     end
 
     def lookup_commit(sha)
-      @stack.commits.find_by(sha: sha)
+      stack.commits.find_by(sha: sha)
     end
   end
 end