shipit-engine 0.39.0 → 0.40.0

data/lib/shipit/engine.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Shipit
   class Engine < ::Rails::Engine
     isolate_namespace Shipit
@@ -11,7 +12,7 @@ module Shipit
         # But if AR Encryption is already configured, we just use that
         app.credentials[:active_record_encryption] = {
           primary_key: Shipit.user_access_tokens_key,
-          key_derivation_salt: Digest::SHA256.digest("salt:".b + Shipit.user_access_tokens_key),
+          key_derivation_salt: Digest::SHA256.digest("salt:".b + Shipit.user_access_tokens_key)
         }
       end
     end
@@ -24,16 +25,16 @@ module Shipit
       Rails.application.credentials.deep_symbolize_keys!
 
       app.config.assets.paths << Emoji.images_path
-      app.config.assets.precompile += %w(
+      app.config.assets.precompile += %w[
         favicon.ico
         task.js
         shipit.js
         shipit.css
         merge_status.js
         merge_status.css
-      )
+      ]
       app.config.assets.precompile << proc do |path|
-        path =~ %r{\Aplugins/[\-\w]+\.(js|css)\Z}
+        path =~ %r{\Aplugins/[-\w]+\.(js|css)\Z}
       end
       app.config.assets.precompile << proc do |path|
         path.end_with?('.svg') || (path.start_with?('emoji/') && path.end_with?('.png'))

data/lib/shipit/environment_variables.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Shipit
   class EnvironmentVariables
     NotPermitted = Class.new(StandardError)
@@ -12,6 +13,7 @@ module Shipit
     def permit(variable_definitions)
       return {} unless @env
       raise "A whitelist is required to sanitize environment variables" unless variable_definitions
+
       sanitize_env_vars(variable_definitions)
     end
 

data/lib/shipit/first_parent_commits_iterator.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Shipit
   class FirstParentCommitsIterator < OctokitIterator
     def each
@@ -9,9 +10,7 @@ module Shipit
           next
         end
 
-        if last_ancestor.parents.empty? || last_ancestor.parents.first.sha == commit.sha
-          yield last_ancestor = commit
-        end
+        yield last_ancestor = commit if last_ancestor.parents.empty? || last_ancestor.parents.first.sha == commit.sha
       end
     end
   end

data/lib/shipit/flock.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'English'
 require 'timeout'
 require 'pathname'
@@ -16,19 +17,20 @@ module Shipit
 
     def lock(timeout:)
       return yield if @acquired
+
       path.parent.mkpath
       path.open('w') do |file|
-        if retrying(timeout: timeout) { file.flock(File::LOCK_EX | File::LOCK_NB) }
-          file.write($PROCESS_ID.to_s)
-          @acquired = true
-          begin
-            yield
-          ensure
-            @acquired = false
-          end
-        else
+        unless retrying(timeout:) { file.flock(File::LOCK_EX | File::LOCK_NB) }
           raise TimeoutError, "Couldn't acquire lock for #{path} in #{timeout} seconds"
         end
+
+        file.write($PROCESS_ID.to_s)
+        @acquired = true
+        begin
+          yield
+        ensure
+          @acquired = false
+        end
       end
     end
 

data/lib/shipit/github_app.rb

@@ -1,8 +1,7 @@
 # frozen_string_literal: true
+
 module Shipit
   class GitHubApp
-    include Mutex_m
-
     class Token
       class << self
         def from_github(github_response)
@@ -44,6 +43,7 @@ module Shipit
 
     def initialize(organization, config)
       super()
+      @mutex = Mutex.new
       @organization = organization
       @config = (config || {}).with_indifferent_access
       @domain = @config[:domain] || DOMAIN
@@ -62,9 +62,7 @@ module Shipit
 
     def api
       client = (Thread.current[:github_client] ||= new_client(access_token: token))
-      if client.access_token != token
-        client.access_token = token
-      end
+      client.access_token = token if client.access_token != token
       client
     end
 
@@ -88,7 +86,7 @@ module Shipit
       return 't0kEn' if Rails.env.test? # TODO: figure out something cleaner
       return unless private_key && app_id && installation_id
 
-      @token = @token.presence || synchronize { @token.presence || fetch_new_token }
+      @token = @token.presence || @mutex.synchronize { @token.presence || fetch_new_token }
       @token.to_s
     end
 
@@ -99,14 +97,15 @@ module Shipit
       Rails.cache.fetch(
         "github:integration:#{cache_key}access-token",
         expires_in: GITHUB_TOKEN_RAILS_CACHE_LIFETIME,
-        race_condition_ttl: 4.minutes,
+        race_condition_ttl: 4.minutes
       ) do
         response = new_client(bearer_token: authentication_payload).create_app_installation_access_token(
-          installation_id,
+          installation_id
         )
         token = Token.from_github(response)
         raise AuthenticationFailed if token.blank?
-        Rails.logger.info("Created GitHub access token ending #{token.to_s[-5..-1]}, expires at #{token.expires_at}"\
+
+        Rails.logger.info("Created GitHub access token ending #{token.to_s[-5..]}, expires at #{token.expires_at}"\
           " and will be refreshed at #{token&.refresh_at}")
         token
       end
@@ -122,14 +121,14 @@ module Shipit
         options = {
           site: api_endpoint,
           authorize_url: url('/login/oauth/authorize'),
-          token_url: url('/login/oauth/access_token'),
+          token_url: url('/login/oauth/access_token')
         }
       end
 
       [
         oauth_id,
         oauth_secret,
-        client_options: options,
+        { client_options: options }
       ]
     end
 
@@ -153,8 +152,8 @@ module Shipit
     def new_client(options = {})
       if enterprise?
         options = options.reverse_merge(
-          api_endpoint: api_endpoint,
-          web_endpoint: web_endpoint,
+          api_endpoint:,
+          web_endpoint:
         )
       end
       client = Octokit::Client.new(options)
@@ -173,7 +172,7 @@ module Shipit
           shared_cache: false,
           store: Rails.cache,
           logger: Rails.logger,
-          serializer: NullSerializer,
+          serializer: NullSerializer
         )
         builder.use(GitHubHTTPCacheMiddleware)
         builder.use(Octokit::Response::RaiseError)
@@ -197,7 +196,7 @@ module Shipit
       payload = {
         iat: Time.now.to_i,
         exp: 10.minutes.from_now.to_i,
-        iss: app_id,
+        iss: app_id
       }
       key = OpenSSL::PKey::RSA.new(private_key)
       JWT.encode(payload, key, 'RS256')

data/lib/shipit/github_http_cache_middleware.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Shipit
   class GitHubHTTPCacheMiddleware < Faraday::Middleware
     def call(request_env)

data/lib/shipit/null_serializer.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Shipit
   module NullSerializer
     extend self

data/lib/shipit/octokit_check_runs.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module OctokitCheckRuns
   def check_runs(repo, sha, options = {})
     paginate("#{Octokit::Repository.path(repo)}/commits/#{sha}/check-runs", options)

data/lib/shipit/octokit_iterator.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Shipit
   class OctokitIterator
     include Enumerable
@@ -20,6 +21,7 @@ module Shipit
 
         response.data.each(&block)
         return unless response.rels[:next]
+
         response = response.rels[:next].get
       end
     end

data/lib/shipit/paginator.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Shipit
   class Paginator
     def initialize(resources, controller, order: { id: :desc }, max_page_size: 100, default_page_size: 30)

data/lib/shipit/rollback_commands.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Shipit
   class RollbackCommands < DeployCommands
     def steps
@@ -7,7 +8,7 @@ module Shipit
 
     def env
       super.merge(
-        'ROLLBACK' => '1',
+        'ROLLBACK' => '1'
       )
     end
   end

data/lib/shipit/same_site_cookie_middleware.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Shipit
   class SameSiteCookieMiddleware
     COOKIE_SEPARATOR = "\n"

data/lib/shipit/simple_message_verifier.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Shipit
   class SimpleMessageVerifier < ActiveSupport::MessageVerifier
     def initialize(secret, **options)

data/lib/shipit/stack_commands.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
-# rubocop:disable Lint/MissingSuper
+
+# rubocop:disable Lint/MissingCopEnableDirective, Lint/MissingSuper
 require 'pathname'
 require 'fileutils'
 
@@ -16,26 +17,26 @@ module Shipit
     def fetch_commit(commit)
       create_directories
       if valid_git_repository?(@stack.git_path)
-        git('fetch', 'origin', '--quiet', '--tags', commit.sha, env: env, chdir: @stack.git_path)
+        git('fetch', 'origin', *quiet_git_arg, '--tags', '--force', commit.sha, env:, chdir: @stack.git_path)
       else
         @stack.clear_git_cache!
-        git_clone(@stack.repo_git_url, @stack.git_path, branch: @stack.branch, env: env, chdir: @stack.deploys_path)
+        git_clone(@stack.repo_git_url, @stack.git_path, branch: @stack.branch, env:, chdir: @stack.deploys_path)
       end
     end
 
     def fetch
       create_directories
       if valid_git_repository?(@stack.git_path)
-        git('fetch', 'origin', '--quiet', '--tags', @stack.branch, env: env, chdir: @stack.git_path)
+        git('fetch', 'origin', *quiet_git_arg, '--tags', '--force', @stack.branch, env:, chdir: @stack.git_path)
       else
         @stack.clear_git_cache!
-        git_clone(@stack.repo_git_url, @stack.git_path, branch: @stack.branch, env: env, chdir: @stack.deploys_path)
+        git_clone(@stack.repo_git_url, @stack.git_path, branch: @stack.branch, env:, chdir: @stack.deploys_path)
       end
     end
 
     def fetched?(commit)
       if valid_git_repository?(@stack.git_path)
-        git('rev-parse', '--quiet', '--verify', "#{commit.sha}^{commit}", env: env, chdir: @stack.git_path)
+        git('rev-parse', *quiet_git_arg, '--verify', "#{commit.sha}^{commit}", env:, chdir: @stack.git_path)
       else
         # When the stack's git cache is not valid, the commit is
         # NOT fetched. To keep the interface of this method
@@ -43,53 +44,55 @@ module Shipit
         # method returns false - has a non-zero exit status. We utilize
         # the POSIX 'test' command with no arguments which should
         # always have an exit status of 1.
-        Command.new('test', env: env, chdir: @stack.deploys_path)
+        Command.new('test', env:, chdir: @stack.deploys_path)
       end
     end
 
     def fetch_deployed_revision
       with_temporary_working_directory(commit: @stack.commits.reachable.last) do |dir|
-        spec = DeploySpec::FileSystem.new(dir, @stack.environment)
+        spec = DeploySpec::FileSystem.new(dir, @stack)
         outputs = spec.fetch_deployed_revision_steps!.map do |command_line|
-          Command.new(command_line, env: env, chdir: dir).run
+          Command.new(command_line, env:, chdir: dir).run
         end
         outputs.find(&:present?).try(:strip)
       end
     end
 
     def build_cacheable_deploy_spec
-      with_temporary_working_directory do |dir|
-        DeploySpec::FileSystem.new(dir, @stack.environment).cacheable
+      with_temporary_working_directory(recursive: false) do |dir|
+        DeploySpec::FileSystem.new(dir, @stack).cacheable
       end
     end
 
-    def with_temporary_working_directory(commit: nil)
+    def with_temporary_working_directory(commit: nil, recursive: true)
       commit ||= @stack.last_deployed_commit.presence || @stack.commits.reachable.last
 
       if !commit || !fetched?(commit).tap(&:run).success?
         @stack.acquire_git_cache_lock do
-          unless fetched?(commit).tap(&:run).success?
-            fetch.run!
-          end
+          fetch.run! unless fetched?(commit).tap(&:run).success?
         end
       end
 
+      git_args = []
+      git_args << '--recursive' if recursive
       Dir.mktmpdir do |dir|
         git(
           'clone', @stack.git_path, @stack.repo_name,
-          '--recursive', '--origin', 'cache',
+          *git_args, '--origin', 'cache',
           chdir: dir
         ).run!
 
         git_dir = File.join(dir, @stack.repo_name)
-        git(
-          '-c',
-          'advice.detachedHead=false',
-          'checkout',
-          '--quiet',
-          commit.sha,
-          chdir: git_dir
-        ).run! if commit
+        if commit
+          git(
+            '-c',
+            'advice.detachedHead=false',
+            'checkout',
+            *quiet_git_arg,
+            commit.sha,
+            chdir: git_dir
+          ).run!
+        end
         yield Pathname.new(git_dir)
       end
     end
@@ -107,18 +110,23 @@ module Shipit
     end
 
     def git_clone(url, path, branch: 'main', **kwargs)
-      git('clone', '--quiet', *modern_git_args, '--recursive', '--branch', branch, url, path, **kwargs)
+      git('clone', *quiet_git_arg, *modern_git_args, '--recursive', '--branch', branch, url, path, **kwargs)
     end
 
     def modern_git_args
       return [] unless git_version >= Gem::Version.new('1.7.10')
-      %w(--single-branch)
+
+      %w[--single-branch]
     end
 
     def create_directories
       FileUtils.mkdir_p(@stack.deploys_path)
     end
 
+    def quiet_git_arg
+      Shipit.git_progress_output ? [] : ['--quiet']
+    end
+
     private
 
     def github

data/lib/shipit/stat.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Shipit
   module Stat
     extend self

data/lib/shipit/task_commands.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
-# rubocop:disable Lint/MissingSuper
+
+# rubocop:disable Lint/MissingCopEnableDirective, Lint/MissingSuper
 module Shipit
   class TaskCommands < Commands
     delegate :fetch_commit, :fetch, :fetched?, to: :stack_commands
@@ -10,18 +11,18 @@ module Shipit
     end
 
     def deploy_spec
-      @deploy_spec ||= DeploySpec::FileSystem.new(@task.working_directory, @stack.environment)
+      @deploy_spec ||= DeploySpec::FileSystem.new(@task.working_directory, @stack)
     end
 
     def install_dependencies
       deploy_spec.dependencies_steps!.map do |command_line|
-        Command.new(command_line, env: env, chdir: steps_directory)
+        Command.new(command_line, env:, chdir: steps_directory)
       end
     end
 
     def perform
       steps.map do |command_line|
-        Command.new(command_line, env: env, chdir: steps_directory)
+        Command.new(command_line, env:, chdir: steps_directory)
       end
     end
 
@@ -40,7 +41,7 @@ module Shipit
           'TASK_ID' => @task.id.to_s,
           'IGNORED_SAFETIES' => @task.ignored_safeties? ? '1' : '0',
           'GIT_COMMITTER_NAME' => @task.user&.name || Shipit.committer_name,
-          'GIT_COMMITTER_EMAIL' => @task.user&.email || Shipit.committer_email,
+          'GIT_COMMITTER_EMAIL' => @task.user&.email || Shipit.committer_email
         )
         .merge(deploy_spec.machine_env)
         .merge(@task.env)
@@ -68,7 +69,7 @@ module Shipit
           @task.working_directory,
           chdir: @stack.deploys_path
         ),
-        git('remote', 'add', 'origin', @stack.repo_git_url, chdir: @task.working_directory),
+        git('remote', 'add', 'origin', @stack.repo_git_url, chdir: @task.working_directory)
       ]
     end
 

data/lib/shipit/version.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Shipit
-  VERSION = '0.39.0'
+  VERSION = '0.40.0'
 end

data/lib/shipit.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'active_support/all'
 require 'active_model_serializers'
 require 'state_machines-activerecord'
@@ -60,17 +61,17 @@ module Shipit
   extend self
 
   GithubOrganizationUnknown = Class.new(StandardError)
-  TOP_LEVEL_GH_KEYS = [:app_id, :installation_id, :webhook_secret, :private_key, :oauth, :domain]
+  TOP_LEVEL_GH_KEYS = [:app_id, :installation_id, :webhook_secret, :private_key, :oauth, :domain].freeze
 
   delegate :table_name_prefix, to: :secrets
 
   attr_accessor :disable_api_authentication, :timeout_exit_codes, :deployment_checks, :respect_bare_shipit_file,
-    :database_serializer
+                :database_serializer
   attr_writer(
     :internal_hook_receivers,
     :preferred_org_emails,
     :task_execution_strategy,
-    :task_logger,
+    :task_logger
   )
 
   def task_execution_strategy
@@ -80,7 +81,7 @@ module Shipit
   self.timeout_exit_codes = [].freeze
   self.respect_bare_shipit_file = true
 
-  alias_method :respect_bare_shipit_file?, :respect_bare_shipit_file
+  alias respect_bare_shipit_file? respect_bare_shipit_file
 
   def authentication_disabled?
     ENV['SHIPIT_DISABLE_AUTH'].present?
@@ -95,7 +96,7 @@ module Shipit
   end
 
   def redis_url
-    secrets.redis_url.present? ? URI(secrets.redis_url) : nil
+    secrets.redis_url.present? ? URI(secrets.redis_url) : ENV["REDIS_URL"]
   end
 
   def redis
@@ -104,14 +105,19 @@ module Shipit
       logger: Rails.logger,
       reconnect_attempts: 3,
       reconnect_delay: 0.5,
-      reconnect_delay_max: 1,
+      reconnect_delay_max: 1
     )
   end
 
+  def redis=(client)
+    @redis ||= client
+  end
+
   module SafeJSON
     class << self
       def load(serial)
         return nil if serial.nil?
+
         # JSON.load is unsafe, we should use parse instead
         JSON.parse(serial)
       end
@@ -136,6 +142,7 @@ module Shipit
 
       def dump(object)
         return if object.nil?
+
         JSON.dump(object)
       end
     end
@@ -144,7 +151,7 @@ module Shipit
   self.database_serializer = TransitionalSerializer
 
   def serialized_column(attribute_name, type: nil, coder: nil)
-    column = Paquito::SerializedColumn.new(database_serializer, type, attribute_name: attribute_name)
+    column = Paquito::SerializedColumn.new(database_serializer, type, attribute_name:)
     if coder
       Paquito.chain(coder, column)
     else
@@ -167,12 +174,14 @@ module Shipit
 
   def github_default_organization
     return nil unless secrets&.github
+
     org = secrets.github.keys.first
     TOP_LEVEL_GH_KEYS.include?(org) ? nil : org
   end
 
   def github_organizations
     return [nil] unless github_default_organization
+
     secrets.github.keys
   end
 
@@ -183,9 +192,9 @@ module Shipit
   end
 
   def legacy_github_api
-    if secrets&.github_api.present?
-      @legacy_github_api ||= github.new_client(access_token: secrets.github_api[:access_token])
-    end
+    return unless secrets&.github_api.present?
+
+    @legacy_github_api ||= github.new_client(access_token: secrets.github_api[:access_token])
   end
 
   def user
@@ -204,7 +213,7 @@ module Shipit
     if secrets.user_access_tokens_key.present?
       secrets.user_access_tokens_key
     elsif secrets.secret_key_base
-      Digest::SHA256.digest("user_access_tokens_key" + secrets.secret_key_base)
+      Digest::SHA256.digest("user_access_tokens_key#{secrets.secret_key_base}")
     end
   end
 
@@ -220,6 +229,10 @@ module Shipit
     secrets.update_latest_deployed_ref
   end
 
+  def git_progress_output
+    secrets.git_progress_output || false
+  end
+
   def enforce_publish_config
     secrets.enforce_publish_config.presence
   end
@@ -240,7 +253,7 @@ module Shipit
     @all_settings_present ||= [
       secrets.github, # TODO: handle GitHub settings
       redis_url,
-      host,
+      host
     ].all?(&:present?)
   end
 
@@ -254,10 +267,10 @@ module Shipit
 
   def revision
     @revision ||= if revision_file.exist?
-      revision_file.read
-    else
-      %x(git rev-parse HEAD)
-    end.strip
+                    revision_file.read
+                  else
+                    `git rev-parse HEAD`
+                  end.strip
   end
 
   def default_inactivity_timeout

data/lib/tasks/cron.rake

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 namespace :cron do
   desc "Updates deployed revisions"
   task minutely: :environment do
@@ -10,7 +11,7 @@ namespace :cron do
     Shipit::ReviewStackProvisioningQueue.work
   end
 
-  task hourly: %i(rollup refresh_users clear_stale_caches delete_old_deployment_directories)
+  task hourly: %i[rollup refresh_users clear_stale_caches delete_old_deployment_directories]
 
   desc "Rolls-up output chunks for completed deploys older than an hour"
   task rollup: :environment do

data/lib/tasks/dev.rake

@@ -1,9 +1,10 @@
 # frozen_string_literal: true
+
 namespace :dev do
   desc "Appends chunks to the last deploy, or specify with DEPLOY=id"
   task stream: :environment do
     require 'faker'
-    logger = Logger.new(STDOUT)
+    logger = Logger.new($stdout)
 
     deploy = Shipit::Deploy.find(ENV['DEPLOY']) if ENV['DEPLOY']
     deploy ||= Deploy.last
@@ -25,7 +26,7 @@ namespace :dev do
 
       logger.error(sentence)
 
-      deploy.chunks.create(text: sentence + "\n")
+      deploy.chunks.create(text: "#{sentence}\n")
       sleep 1
     end
   end