shipit-engine 0.38.0 → 0.40.0

data/app/views/shipit/_variables.html.erb

@@ -9,7 +9,7 @@
           <% if variable.select %>
             <%= field.select variable.name, options_for_select([["Please select...", { disabled: "disabled" }]] + variable.select, variable.default || "Please select...") %>
           <% else %>
-            <%= field.text_field variable.name, value: variable.default %>
+            <%= field.text_field variable.name, value: params[variable.name].presence || variable.default %>
           <% end %>
           <%= field.label variable.name, variable.title || variable.name %>
         </p>

data/app/views/shipit/ccmenu/project.xml.builder

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Derived from http://timnew.me/blog/2013/04/07/multiple-project-summary-reporting-standard-cctray-xml-feed/
 status_map = { 'backlogged' => 'failure', 'locked' => 'failure' }
 xml.instruct!
@@ -10,6 +11,6 @@ xml.Projects do
     activity: deploy.running? ? 'Building' : 'Sleeping',
     lastBuildTime: deploy.ended_at || deploy.started_at || deploy.created_at,
     lastBuildLabel: deploy.id,
-    webUrl: stack_url(stack),
+    webUrl: stack_url(stack)
   )
 end

data/app/views/shipit/continuous_delivery_schedules/show.html.erb

@@ -0,0 +1,59 @@
+<%= render partial: 'shipit/stacks/header', locals: { stack: @stack } %>
+
+<div class="wrapper continuous-delivery-schedule">
+    <section>
+        <header class="section-header">
+            <h2>Continuous Delivery Schedule (Stack #<%= @stack.id %>)</h2>
+        </header>
+    </section>
+    <div class="setting-section">
+        <% if @continuous_delivery_schedule.errors.any? %>
+            <div class="validation-errors">
+                <p>Validation errors prevented your schedule from being saved</p>
+                <ul>
+                    <% @continuous_delivery_schedule.errors.full_messages.each do |full_message| %>
+                        <li><%= full_message %></li>
+                    <% end %>
+                </ul>
+            </div>
+        <% end %>
+        <%= form_for(@continuous_delivery_schedule, url: stack_continuous_delivery_schedule_path, method: :patch) do |f| %>
+            <table class="field-wrapper">
+                <tbody>
+                    <% Shipit::ContinuousDeliverySchedule::DAYS.rotate.each do |day| %>
+                        <tr>
+                            <td>
+                                <%= f.check_box("#{day}_enabled") %>
+                            </td>
+                            <td>
+                                <%= f.label("#{day}_enabled", day.titlecase) %>
+                            </td>
+                            <td>
+                                <%= f.time_field("#{day}_start", include_seconds: false) %>
+                            </td>
+                            <td>&rarr;</td>
+                            <td>
+                                <%= f.time_field("#{day}_end", include_seconds: false) %>
+                            </td>
+                            <td>
+                                <% if day == "monday" %>
+                                    <button data-action="copy-to-all" type="button">Copy to all &darr;</button>
+                                <% end %>
+                            </td>
+                        </tr>
+                    <% end %>
+                </tbody>
+            </table>
+            
+            <p>
+                &#x2139;&#xFE0F; 
+                All times are in <%= Time.zone.name %>
+                (the <a href="https://guides.rubyonrails.org/configuring.html#config-time-zone">default time zone</a>).
+            </p>
+
+            <div class="field-wrapper">
+                <%= f.submit("Save", class: "btn") %>
+            </div>
+        <% end %>
+    </div>
+</div>

data/app/views/shipit/merge_status/failure.html.erb

@@ -15,7 +15,7 @@
   </h4>
   <span class="status-meta">
     <%= link_to @stack.to_param, stack_url(@stack), target: '_blank', rel: 'noopener' %>
-    <strong>master branch is failing!</strong>
+    <strong>main branch is failing!</strong>
   </span>
   <%= render 'commit_count_warning' if display_commit_count_warning?(params[:commits].to_i) %>
 </div>

data/app/views/shipit/missing_settings.html.erb

@@ -22,7 +22,7 @@
 
     <p id="github_app">
       Config:
-    <% if Rails.application.secrets.github.present? %>
+    <% if Rails.application.credentials.github.present? %>
        Success!
     <% else %>
       <span class="missing">

data/app/views/shipit/stacks/_settings_form.erb

@@ -17,6 +17,7 @@
 		<div class="field-wrapper">
 			<%= f.check_box :continuous_deployment %>
 			<%= f.label :continuous_deployment, 'Enable continuous deployment' %>
+			(<%= link_to("Edit schedule", stack_continuous_delivery_schedule_path) %>)
 		</div>
 
 		<div class="field-wrapper">

data/config/initializers/inflections.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 ActiveSupport::Inflector.inflections(:en) do |inflect|
   inflect.acronym('CCMenu')
 end

data/config/locales/en.yml

@@ -81,6 +81,7 @@ en:
     messages:
       subset: "is not a strict subset of %{of}"
       ascii: "contains non-ASCII characters"
+      must_be_after_start: "must be after start (%{start})"
   deployment_description:
     deploy:
       in_progress: "%{author} triggered the deploy of %{stack} to %{sha}"

data/config/routes.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 Shipit::Engine.routes.draw do
   stack_id_format = %r{[^/]+/[^/]+/[^/]+}
   repository_id_format = %r{[^/]+/[^/]+}
@@ -15,7 +16,7 @@ Shipit::Engine.routes.draw do
   # API
   namespace :api do
     root to: 'base#index'
-    resources :stacks, only: %i(index create)
+    resources :stacks, only: %i[index create]
     scope '/stacks/*id', id: stack_id_format, as: :stack do
       get '/' => 'stacks#show'
       delete '/' => 'stacks#destroy'
@@ -25,24 +26,24 @@ Shipit::Engine.routes.draw do
 
     scope '/stacks/*stack_id', stack_id: stack_id_format, as: :stack do
       get '/ccmenu' => 'ccmenu#show', as: :ccmenu
-      resource :lock, only: %i(create update destroy)
-      resources :tasks, only: %i(index show) do
+      resource :lock, only: %i[create update destroy]
+      resources :tasks, only: %i[index show] do
         resource :output, only: :show
         member do
           put :abort
         end
       end
-      resources :deploys, only: %i(index create) do
-        resources :release_statuses, only: %i(create)
+      resources :deploys, only: %i[index create] do
+        resources :release_statuses, only: %i[create]
       end
-      resources :rollbacks, only: %i(create)
-      resources :commits, only: %i(index)
-      resources :merge_requests, only: %i(index show update destroy)
+      resources :rollbacks, only: %i[create]
+      resources :commits, only: %i[index]
+      resources :merge_requests, only: %i[index show update destroy]
       post '/task/:task_name' => 'tasks#trigger', as: :trigger_task
-      resources :hooks, only: %i(index create show update destroy)
+      resources :hooks, only: %i[index create show update destroy]
     end
 
-    resources :hooks, only: %i(index create show update destroy)
+    resources :hooks, only: %i[index create show update destroy]
   end
 
   scope '/ccmenu/*stack_id', stack_id: stack_id_format, as: :ccmenu_url do
@@ -57,7 +58,7 @@ Shipit::Engine.routes.draw do
   # Humans
   resources :api_clients
 
-  resources :repositories, only: %i(new index create)
+  resources :repositories, only: %i[new index create]
   scope '/repositories/*id', id: repository_id_format, as: :repository do
     get '/' => 'repositories#show'
     patch '/' => 'repositories#update'
@@ -73,7 +74,7 @@ Shipit::Engine.routes.draw do
     get :logout
   end
 
-  resources :stacks, only: %i(new create index)
+  resources :stacks, only: %i[new create index]
   scope '/*id', id: stack_id_format, as: :stack do
     get '/' => 'stacks#show'
     patch '/' => 'stacks#update'
@@ -84,6 +85,8 @@ Shipit::Engine.routes.draw do
     post :refresh, controller: :stacks
     get :refresh, controller: :stacks # For easier design, sorry :/
     post :clear_git_cache, controller: :stacks
+
+    resource :continuous_delivery_schedule, only: %i[show update]
   end
 
   scope '/task/:id', controller: :tasks do
@@ -96,9 +99,9 @@ Shipit::Engine.routes.draw do
 
     get '/stats' => 'stats#show', as: :stats
 
-    resources :rollbacks, only: %i(create)
-    resources :commits, only: %i(update)
-    resources :tasks, only: %i(show) do
+    resources :rollbacks, only: %i[create]
+    resources :commits, only: %i[update]
+    resources :tasks, only: %i[show] do
       collection do
         get '' => 'tasks#index', as: :index
         get ':definition_id/new' => 'tasks#new', as: :new
@@ -111,17 +114,17 @@ Shipit::Engine.routes.draw do
       end
     end
 
-    resources :deploys, only: %i(show create) do
+    resources :deploys, only: %i[show create] do
       get ':sha', sha: sha_format, on: :new, action: :new, as: ''
       member do
         get :rollback
         get :revert
       end
 
-      resources :release_statuses, only: %i(create)
+      resources :release_statuses, only: %i[create]
     end
 
-    resources :merge_requests, only: %i(index destroy create)
+    resources :merge_requests, only: %i[index destroy create]
   end
   get '/stacks/:id' => 'stacks#lookup'
 

data/config/secrets.development.example.yml

@@ -1,7 +1,7 @@
 host: 'localhost:3000'
 redis_url: 'redis://127.0.0.1:6379/0'
 
-# For creating an app see: https://github.com/Shopify/shipit-engine/blob/master/docs/setup.md#creating-the-github-app
+# For creating an app see: https://github.com/Shopify/shipit-engine/blob/main/docs/setup.md#creating-the-github-app
 # Can be obtained there: https://github.com/settings/apps
 # Set the "Authorization callback URL" as `<host>/github/auth/github/callback`
 

data/config/secrets.development.shopify.yml

@@ -1,7 +1,7 @@
 host: 'shipit-engine.myshopify.io'
 redis_url: 'redis://shipit-engine.railgun:6379'
 
-# For creating an app see: https://github.com/Shopify/shipit-engine/blob/master/docs/setup.md#creating-the-github-app
+# For creating an app see: https://github.com/Shopify/shipit-engine/blob/main/docs/setup.md#creating-the-github-app
 
 github:
   somegithuborg:

data/db/migrate/20240821003007_add_continuous_delivery_schedules.rb

@@ -0,0 +1,13 @@
+class AddContinuousDeliverySchedules < ActiveRecord::Migration[7.1]
+  def change
+    create_table(:continuous_delivery_schedules) do |t|
+      t.references(:stack, null: false, index: { unique: true })
+      %w[sunday monday tuesday wednesday thursday friday saturday].each do |day|
+        t.boolean("#{day}_enabled", null: false, default: true)
+        t.time("#{day}_start", null: false, default: "00:00")
+        t.time("#{day}_end", null: false, default: "23:59")
+      end
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20250207203053_embiggen_github_ids.rb

@@ -0,0 +1,8 @@
+class EmbiggenGithubIds < ActiveRecord::Migration[7.2]
+  def change
+    change_column(:commit_deployments, :github_id, :bigint)
+    change_column(:github_hooks, :github_id, :bigint)
+    change_column(:teams, :github_id, :bigint)
+    change_column(:users, :github_id, :bigint)
+  end
+end

data/lib/shipit/cast_value.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Shipit
   module CastValue
     def to_boolean(value)

data/lib/shipit/command.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'pty'
 require 'shellwords'
 require 'fileutils'
@@ -27,9 +28,9 @@ module Shipit
 
     attr_reader :out, :chdir, :env, :args, :pid, :timeout
 
-    def initialize(*args, default_timeout: Shipit.default_inactivity_timeout, env: {}, chdir:)
+    def initialize(*args, chdir:, default_timeout: Shipit.default_inactivity_timeout, env: {})
       @args, options = parse_arguments(args)
-      @timeout = options['timeout'] || options[:timeout] || default_timeout
+      @timeout = parse_timeout(options['timeout'] || options[:timeout]) || default_timeout
       @env = env.transform_values { |v| v&.to_s }
       @chdir = chdir.to_s
       @timed_out = false
@@ -83,6 +84,7 @@ module Shipit
 
     def start(&block)
       return if @started
+
       @control_block = block
       @out = @pid = nil
       FileUtils.mkdir_p(@chdir)
@@ -106,10 +108,10 @@ module Shipit
       start
       begin
         read_stream(@out, &block)
-      rescue TimedOut => error
-        yield red("No output received in the last #{timeout} seconds.") + "\n"
+      rescue TimedOut => e
+        yield "#{red("No output received in the last #{timeout} seconds.")}\n"
         terminate!(&block)
-        raise error
+        raise e
       rescue Errno::EIO # Somewhat expected on Linux: http://stackoverflow.com/a/10306782
       end
 
@@ -125,6 +127,7 @@ module Shipit
     def stream!(&block)
       stream(&block)
       raise Failed.new(exit_message, code) unless success?
+
       self
     end
 
@@ -173,7 +176,7 @@ module Shipit
     ensure
       begin
         read_stream(@out, &block)
-      rescue
+      rescue StandardError
       end
     end
 
@@ -187,9 +190,8 @@ module Shipit
       rescue TimedOut
       rescue Errno::EIO # EIO is somewhat expected on Linux: http://stackoverflow.com/a/10306782
         # If we try to read the stream right after sending a signal, we often get an Errno::EIO.
-        if reap_child!(block: false)
-          return true
-        end
+        return true if reap_child!(block: false)
+
         # If we let the child a little bit of time, it solves it.
         retry_count -= 1
         if retry_count > 0
@@ -206,6 +208,22 @@ module Shipit
       Process.kill(sig, @pid)
     end
 
+    def parse_timeout(timeout)
+      case timeout
+      when String
+        begin
+          Duration.parse(timeout).to_i
+        rescue Duration::ParseError
+          # If given garbage we fallback to the default.
+          # It's not ideal but we don't have a good way to notify about
+          # syntax errors.
+          nil
+        end
+      else
+        timeout
+      end
+    end
+
     def parse_arguments(arguments)
       options = {}
       args = arguments.flatten.map do |argument|
@@ -217,6 +235,7 @@ module Shipit
           argument
         end
       end
+
       [args.map(&:to_s), options]
     end
 
@@ -235,6 +254,7 @@ module Shipit
     def reap_child!(block: true)
       return @status if @status
       return unless running? # Command was never started e.g. permission denied, not found etc
+
       if block
         _, @status = Process.waitpid2(@pid)
       elsif res = Process.waitpid2(@pid, Process::WNOHANG)

data/lib/shipit/commands.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Shipit
   class Commands
     class << self
@@ -7,12 +8,13 @@ module Shipit
       end
 
       def git_version
-        @git_version ||= parse_git_version(%x(git --version))
+        @git_version ||= parse_git_version(`git --version`)
       end
 
       def parse_git_version(raw_git_version)
         match_info = raw_git_version.match(/(\d+\.\d+\.\d+)/)
         raise 'git command not found' unless match_info
+
         Gem::Version.new(match_info[1])
       end
     end
@@ -36,7 +38,7 @@ module Shipit
       @base_env ||= Shipit.env.merge(
         'GITHUB_DOMAIN' => github.domain,
         'GITHUB_TOKEN' => github.token,
-        'GIT_ASKPASS' => Shipit::Engine.root.join('lib', 'snippets', 'git-askpass').realpath.to_s,
+        'GIT_ASKPASS' => Shipit::Engine.root.join('lib', 'snippets', 'git-askpass').realpath.to_s
       )
     end
 

data/lib/shipit/csv_serializer.rb

@@ -1,15 +1,18 @@
 # frozen_string_literal: true
+
 module Shipit
   module CSVSerializer
     extend self
 
     def load(payload)
       return [] if payload.blank?
+
       payload.split(',')
     end
 
     def dump(array)
       return nil if array.blank?
+
       Array.wrap(array).join(',')
     end
   end

data/lib/shipit/deploy_commands.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Shipit
   class DeployCommands < TaskCommands
     def steps
@@ -10,7 +11,7 @@ module Shipit
       super.merge(
         'SHA' => commit.sha,
         'REVISION' => commit.sha,
-        'DIFF_LINK' => diff_url,
+        'DIFF_LINK' => diff_url
       )
     end
 

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
@@ -21,19 +22,19 @@ module Shipit
       Shipit::Engine.routes.default_url_options[:host] = Shipit.host
       Pubsubstub.redis_url = Shipit.redis_url.to_s
 
-      Rails.application.secrets.deep_symbolize_keys!
+      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,15 +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,
-          accept: 'application/vnd.github.machine-man-preview+json',
+          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
@@ -123,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
 
@@ -154,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)
@@ -174,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)
@@ -198,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')