shipit-engine 0.40.1 → 0.41.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 331361f1d585cf851921f54504a49c6ffb6f608a5ed27d5debcba8ee53e4e908
-  data.tar.gz: 753f0e91f16d3f67f31b97ce13a2064db558c480329e15bac53f349d0c673f95
+  metadata.gz: bafbe17c7fb151098a26f705e72fa102d72a160525954fabfddb40cfaf5e102c
+  data.tar.gz: 65971811403084320352425fea9a55a6ab013e9ab45d6ee2db2b1db2d2be589e
 SHA512:
-  metadata.gz: f8f620eb8c8740c6ffe92aa8636a52ddc3892b025471b7fbf9303cc6a6978c2b08fa0740ab3a1b0ee09bf6ba8cb8c53a8f1b5f027268759d76f4ad50a359d04f
-  data.tar.gz: 7e714cb2899659ebbc72f64f56985af7ca09be4fdc22cbe281e2e53b3e5aacce8cbdf030049d873cac644d28bbdba4fcee00c25f4ed1c66ba0101e94f72e9ffb
+  metadata.gz: 72af323c05c61f27f55e7f7ec5f4cdadd3cd53b0399dd163e7ebbc2700f0eca8965d44ab502bb922e808e3b409fc6375fb96c9dc695b35f23aed82d0c9bee27d
+  data.tar.gz: c2d9c9fe1f7782cef895d38085611323ec29462022f02327124839245789b100a139b38def2e0def37645dae2eeddb369e81d45453b188660685369d1a8b611f

data/app/helpers/shipit/stacks_helper.rb

@@ -105,5 +105,13 @@ module Shipit
     def contributor_class(stacks_contributed_to, stack_id)
       stacks_contributed_to.include?(stack_id) ? "contributor" : "not-matching"
     end
+
+    def deployment_checks_message(stack)
+      if !stack.deployment_checks_passed? && Shipit.deployment_checks.respond_to?(:message)
+        Shipit.deployment_checks.message(stack)
+      else
+        "Deploys have been locked by an external system"
+      end
+    end
   end
 end

data/app/jobs/shipit/github_sync_job.rb

@@ -7,6 +7,8 @@ module Shipit
     attr_reader :stack
 
     MAX_FETCHED_COMMITS = 25
+    MAX_RETRY_ATTEMPTS = 5
+    RETRY_DELAY = 5.seconds
     queue_as :default
     on_duplicate :drop
 
@@ -15,10 +17,19 @@ module Shipit
 
     def perform(params)
       @stack = Stack.find(params[:stack_id])
+      expected_head_sha = params[:expected_head_sha]
+      retry_count = params[:retry_count] || 0
 
       handle_github_errors do
         new_commits, shared_parent = fetch_missing_commits { stack.github_commits }
 
+        # Retry on Github eventual consistency: webhook indicated new commits but we found none
+        if expected_head_sha && new_commits.empty? && !commit_exists?(expected_head_sha) &&
+           retry_count < MAX_RETRY_ATTEMPTS
+          GithubSyncJob.set(wait: RETRY_DELAY * retry_count).perform_later(params.merge(retry_count: retry_count + 1))
+          return
+        end
+
         stack.transaction do
           shared_parent&.detach_children!
           appended_commits = new_commits.map do |gh_commit|
@@ -63,5 +74,9 @@ module Shipit
     def lookup_commit(sha)
       stack.commits.find_by(sha:)
     end
+
+    def commit_exists?(sha)
+      stack.commits.exists?(sha:)
+    end
   end
 end

data/app/models/shipit/stack.rb

@@ -602,8 +602,8 @@ module Shipit
       tasks.where(type: 'Shipit::Deploy').success.order(id: :desc).limit(100).durations
     end
 
-    def sync_github
-      GithubSyncJob.perform_later(stack_id: id)
+    def sync_github(expected_head_sha: nil)
+      GithubSyncJob.perform_later(stack_id: id, expected_head_sha:)
     end
 
     def links

data/app/models/shipit/webhooks/handlers/push_handler.rb

@@ -6,12 +6,14 @@ module Shipit
       class PushHandler < Handler
         params do
           requires :ref
+          requires :after
         end
+
         def process
           stacks
             .not_archived
             .where(branch:)
-            .find_each(&:sync_github)
+            .find_each { |stack| stack.sync_github(expected_head_sha: params.after) }
         end
 
         private

data/app/views/shipit/commits/_commit.html.erb

@@ -4,7 +4,11 @@
       <%= render 'shipit/shared/author', author: commit.author %>
     <% end %>
 
-    <%= render 'shipit/statuses/status', status: commit.status %>
+    <% if commit.status.group? %>
+      <%= render 'shipit/statuses/group', group: commit.status %>
+    <% else %>
+      <%= render 'shipit/statuses/status', status: commit.status %>
+    <% end %>
     <div class="commit-details">
       <span class="commit-title"><%= render_commit_message_with_link commit %></span>
       <p class="commit-meta">

data/app/views/shipit/stacks/_banners.html.erb

@@ -76,4 +76,15 @@
       </div>
     </div>
   </div>
+<% elsif !stack.deployment_checks_passed? %>
+  <div class="banner banner--orange">
+    <div class="banner__inner wrapper">
+      <div class="banner__content">
+        <h2 class="banner__title">Stack has been locked by external system!</h2>
+        <p class = "banner__text">
+          <%= simple_format(deployment_checks_message(stack)) %>
+        </p>
+      </div>
+    </div>
+  </div>
 <% end %>

data/lib/shipit/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Shipit
-  VERSION = '0.40.1'
+  VERSION = '0.41.1'
 end

data/test/controllers/webhooks_controller_test.rb

@@ -23,9 +23,11 @@ module Shipit
     test ":push with the target branch queues a GithubSyncJob" do
       request.headers['X-Github-Event'] = 'push'
 
-      body = JSON.parse(payload(:push_master)).to_json
-      assert_enqueued_with(job: GithubSyncJob, args: [stack_id: @stack.id]) do
-        post :create, body:, as: :json
+      parsed_body = JSON.parse(payload(:push_master))
+      expected_head_sha = parsed_body["after"]
+
+      assert_enqueued_with(job: GithubSyncJob, args: [stack_id: @stack.id, expected_head_sha:]) do
+        post :create, body: parsed_body.to_json, as: :json
       end
     end
 

data/test/jobs/github_sync_job_test.rb

@@ -118,5 +118,50 @@ module Shipit
 
       assert_equal true, @stack.reload.inaccessible_since?
     end
+
+    test "#perform retries when expected_head_sha is not found in the github response" do
+      expected_sha = "abcd1234"
+      Stack.any_instance.expects(:github_commits).returns(@github_commits)
+      @job.expects(:fetch_missing_commits).yields.returns([[], nil])
+      @job.expects(:commit_exists?).with(expected_sha).returns(false)
+
+      assert_enqueued_with(job: GithubSyncJob, args: [stack_id: @stack.id, expected_head_sha: expected_sha, retry_count: 1]) do
+        @job.perform(stack_id: @stack.id, expected_head_sha: expected_sha)
+      end
+    end
+
+    test "#perform stops retrying after MAX_RETRY_ATTEMPTS" do
+      expected_sha = "abcd1234"
+      Stack.any_instance.expects(:github_commits).returns(@github_commits)
+      @job.expects(:fetch_missing_commits).yields.returns([[], nil])
+      @job.expects(:commit_exists?).with(expected_sha).returns(false)
+
+      assert_no_enqueued_jobs(only: GithubSyncJob) do
+        @job.perform(stack_id: @stack.id, expected_head_sha: expected_sha, retry_count: GithubSyncJob::MAX_RETRY_ATTEMPTS)
+      end
+    end
+
+    test "#perform processes normally when expected_head_sha exists" do
+      expected_sha = "abcd1234"
+      Stack.any_instance.expects(:github_commits).returns(@github_commits)
+      @job.expects(:fetch_missing_commits).yields.returns([[], nil])
+      @job.expects(:commit_exists?).with(expected_sha).returns(true)
+
+      assert_enqueued_with(job: CacheDeploySpecJob, args: [@stack]) do
+        @job.perform(stack_id: @stack.id, expected_head_sha: expected_sha)
+      end
+    end
+
+    test "#perform processes normally when new commits are found" do
+      expected_sha = "abcd1234"
+      new_commit = stub(sha: expected_sha)
+      Stack.any_instance.expects(:github_commits).returns(@github_commits)
+      @job.expects(:fetch_missing_commits).yields.returns([[new_commit], nil])
+      @job.expects(:append_commit).with(new_commit).returns(stub(revert?: false))
+
+      assert_enqueued_with(job: CacheDeploySpecJob, args: [@stack]) do
+        @job.perform(stack_id: @stack.id, expected_head_sha: expected_sha)
+      end
+    end
   end
 end

data/test/models/shipit/review_stack_test.rb

@@ -70,7 +70,7 @@ module Shipit
         stack.archive!(shipit_users(:codertocat))
       end
 
-      assert_enqueued_with(job: GithubSyncJob, args: [stack_id: stack.id]) do
+      assert_enqueued_with(job: GithubSyncJob, args: [stack_id: stack.id, expected_head_sha: nil]) do
         stack.unarchive!
       end
     end

data/test/models/shipit/stack_test.rb

@@ -997,13 +997,13 @@ module Shipit
         @stack.archive!(shipit_users(:codertocat))
       end
 
-      assert_enqueued_with(job: GithubSyncJob, args: [stack_id: @stack.id]) do
+      assert_enqueued_with(job: GithubSyncJob, args: [stack_id: @stack.id, expected_head_sha: nil]) do
         @stack.unarchive!
       end
     end
 
     test "#update that changes the branch name triggers a GithubSync job" do
-      assert_enqueued_with(job: GithubSyncJob, args: [stack_id: @stack.id]) do
+      assert_enqueued_with(job: GithubSyncJob, args: [stack_id: @stack.id, expected_head_sha: nil]) do
         @stack.update!(branch: 'test')
       end
     end

data/test/models/shipit/webhooks/handlers/pull_request/review_stack_adapter_test.rb

@@ -26,7 +26,7 @@ module Shipit
               scope: stack.repository.stacks
             )
 
-            assert_enqueued_with(job: GithubSyncJob, args: [stack_id: stack.id]) do
+            assert_enqueued_with(job: GithubSyncJob, args: [stack_id: stack.id, expected_head_sha: nil]) do
               review_stack.unarchive!
             end
           end

data/test/unit/stack_helper_test.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+module Shipit
+  class StackHelperTest < ActionView::TestCase
+    include Shipit::StacksHelper
+
+    def setup
+      @stack = shipit_stacks(:shipit)
+    end
+
+    test "deployment_checks_message default" do
+      assert_equal "Deploys have been locked by an external system", deployment_checks_message(@stack)
+    end
+
+    test "deployment_checks_message custom message" do
+      module FakeDeploymentCheck
+        extend self
+
+        def call(_stack)
+          false
+        end
+
+        def message(_stack)
+          "test message"
+        end
+      end
+      begin
+        original_deployment_checks = Shipit.deployment_checks
+        Shipit.deployment_checks = FakeDeploymentCheck
+        assert_equal "test message", deployment_checks_message(@stack)
+      ensure
+        Shipit.deployment_checks = original_deployment_checks
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shipit-engine
 version: !ruby/object:Gem::Version
-  version: 0.40.1
+  version: 0.41.1
 platform: ruby
 authors:
 - Jean Boussier
@@ -1023,6 +1023,7 @@ files:
 - test/unit/shipit_helper_test.rb
 - test/unit/shipit_task_execution_strategy_test.rb
 - test/unit/shipit_test.rb
+- test/unit/stack_helper_test.rb
 - test/unit/user_serializer_test.rb
 - test/unit/variable_definition_test.rb
 - vendor/assets/javascripts/clusterize.js
@@ -1050,7 +1051,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.7.1
+rubygems_version: 3.7.2
 specification_version: 4
 summary: Application deployment software
 test_files:
@@ -1254,5 +1255,6 @@ test_files:
 - test/unit/shipit_helper_test.rb
 - test/unit/shipit_task_execution_strategy_test.rb
 - test/unit/shipit_test.rb
+- test/unit/stack_helper_test.rb
 - test/unit/user_serializer_test.rb
 - test/unit/variable_definition_test.rb