shipit-engine 0.29.0 → 0.30.0

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

@@ -0,0 +1 @@
+<%# Placeholder to be used by the host application %>

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

@@ -1,5 +1,5 @@
 <% content_for :page_title do %>
-  <h1>Shipit</h1>
+  <h1><%= Shipit.app_name %></h1>
 <% end %>
 <% content_for :primary_navigation do %>
   <%= link_to 'Add a stack', new_stack_path, class: 'btn secondary' %>
@@ -18,7 +18,7 @@
     </ul>
     <ul class="stack-lst">
       <% @stacks.each do |stack| %>
-        <li class="search-item <%= stack.undeployed_commits? ? 'undeployed' : '' %> <%= @user_stacks.include?(stack.id) ? 'contributor' : 'not-matching' %>" data-search="<%= stack.repo_name %> <%= stack.environment %> <%= stack.deploy_url %>" data-stack-id="<%= stack.id %>">
+        <li class="search-item <%= stack.archived? ? 'archived' : '' %> <%= stack.undeployed_commits? ? 'undeployed' : '' %> <%= @user_stacks.include?(stack.id) ? 'contributor' : 'not-matching' %>" data-search="<%= stack.repo_name %> <%= stack.environment %> <%= stack.deploy_url %>" data-stack-id="<%= stack.id %>">
           <%= link_to stack_path(stack), class: 'commits-path' do %>
             <span class="col"><%= stack.repo_name %></span>
             <small class="col"><%= stack.environment.capitalize %></small>
@@ -30,6 +30,11 @@
     </ul>
 
     <%= link_to 'show all stacks', '#', class: 'btn secondary show-all-stacks' %></p>
+    <% if @show_archived %>
+      <%= link_to 'hide archived stacks', '?', class: 'btn secondary' %></p>
+    <% else %>
+      <%= link_to 'show archived stacks', '?show_archived=1', class: 'btn secondary' %></p>
+    <% end %>
   </section>
 
 </div>

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

@@ -61,6 +61,7 @@
         <%- end -%>
       <% end %>
     </div>
+
     <div class="setting-section">
       <h5>Resynchronize this stack</h5>
       <table>
@@ -80,6 +81,24 @@
       <%= button_to "Fetch URL", "", class: 'btn', data: {remote: ccmenu_url_url(stack_id: @stack.to_param)} %>
     </div>
 
+    <div class="setting-section">
+      <% if @stack.archived? %>
+        <h5>Restore Stack</h5>
+        <p>This action will de-archive the Stack, restoring it in the stack list and unlocking it.</p>
+        <%= form_for @stack do |f| %>
+          <%= f.hidden_field :archived, value: false %>
+          <%= f.submit class: "btn", value: "Restore" %>
+        <% end %>
+      <% else %>
+        <h5>Archive Stack</h5>
+        <p>This action will archive the Stack, hiding it from the stack list and locking it. It can still be found if you know the URL and de-archived.</p>
+        <%= form_for @stack do |f| %>
+          <%= f.hidden_field :archived, value: true %>
+          <%= f.submit class: "btn", value: "Archive" %>
+        <% end %>
+      <% end %>
+    </div>
+
     <div class="setting-section">
       <h5>Delete this stack</h5>
       <p>This action will delete the stack from Ship it permanently. Be careful.</p>

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

@@ -0,0 +1,82 @@
+<%= render partial: 'shipit/stacks/header', locals: {stack: @stack} %>
+<%= render partial: 'shipit/stacks/banners', locals: {stack: @stack} %>
+
+<div class="wrapper">
+  <section>
+    <header class="section-header">
+      <h2>Statistics &ndash; Past 7 Days</h2>
+    </header>
+
+    <div class="row">
+      <div class="box">
+        <div class="box__body">
+          <div class="stats">
+            <div class="stats__amount"><%= @deploy_stats.count %></div>
+            <div class="stats__caption">Deploys</div>
+            <div class="stats__change">
+              <div class="stats__value stats__value--<%=positive_negative_class(@diffs[:count])%>"><%= number_to_percentage(@diffs[:count], precision: 1) %></div>
+              <div class="stats__period">this week</div>
+            </div>
+          </div>
+        </div>
+      </div>
+
+      <div class="box">
+        <div class="box__body">
+          <div class="stats">
+            <div class="stats__amount"><%= number_to_percentage(@deploy_stats.success_rate, precision: 1) %></div>
+            <div class="stats__caption">Deploys success rate</div>
+          </div>
+        </div>
+      </div>
+
+      <div class="box">
+        <div class="box__body">
+          <div class="stats">
+            <div class="stats__amount"><%= Shipit::Duration.new @deploy_stats.average_duration %></div>
+            <div class="stats__caption">Average deploy time</div>
+            <div class="stats__change">
+              <div class="stats__value stats__value--<%=positive_negative_class(@diffs[:average_duration])%>"><%= number_to_percentage(@diffs[:average_duration], precision: 1) %></div>
+              <div class="stats__period">this week</div>
+            </div>
+          </div>
+        </div>
+      </div>
+    </div>
+
+    <div class="row">
+      <div class="box">
+        <div class="box__body">
+          <div class="stats">
+            <div class="stats__amount"><%= Shipit::Duration.new @deploy_stats.min_duration %></div>
+            <div class="stats__caption">Min deploy time</div>
+          </div>
+        </div>
+      </div>
+
+      <div class="box">
+        <div class="box__body">
+          <div class="stats">
+            <div class="stats__amount"><%= Shipit::Duration.new @deploy_stats.median_duration %></div>
+            <div class="stats__caption">Median deploy time</div>
+            <div class="stats__change">
+              <div class="stats__value stats__value--<%=positive_negative_class(@diffs[:median_duration])%>"><%= number_to_percentage(@diffs[:median_duration], precision: 1) %></div>
+              <div class="stats__period">this week</div>
+            </div>
+          </div>
+        </div>
+      </div>
+
+      <div class="box">
+        <div class="box__body">
+          <div class="stats">
+            <div class="stats__amount"><%= Shipit::Duration.new @deploy_stats.max_duration %></div>
+            <div class="stats__caption">Max deploy time</div>
+          </div>
+        </div>
+      </div>
+    </div>
+
+  </section>
+
+</div>

data/config/locales/en.yml

@@ -20,6 +20,16 @@
 # available at http://guides.rubyonrails.org/i18n.html.
 
 en:
+  stack:
+    nav:
+      refresh: Refresh statuses & commits
+      commits: Commits & Deploys
+      settings: Settings
+      timeline: Timeline
+      statistics: Stats
+      merge_queue: "Merge Queue (%{count})"
+      view_on_github: View on GitHub
+      deploy_link: View website
   commit:
     lock: This commit is safe to deploy. Click to mark it as unsafe.
     unlock: This commit was marked as unsafe to deploy. Click to mark it as safe.
@@ -72,12 +82,14 @@ en:
       ascii: "contains non-ASCII characters"
   deployment_description:
     deploy:
-      pending: "%{author} triggered the deploy of %{stack} to %{sha}"
+      in_progress: "%{author} triggered the deploy of %{stack} to %{sha}"
+      pending: "%{author} created the deploy of %{stack} to %{sha}"
       success: "%{author} deployed %{stack} to %{sha}"
       failure: "Deploy of %{stack} to %{sha} by %{author} failed"
       error: "Deploy of %{stack} to %{sha} by %{author} failed"
     rollback:
-      pending: "%{author} triggered the rollback of %{stack} to %{sha}"
+      in_progress: "%{author} triggered the deploy of %{stack} to %{sha}"
+      pending: "%{author} created the rollback of %{stack} to %{sha}"
       success: "%{author} rolled back %{stack} to %{sha}"
       failure: "Rollback of %{stack} to %{sha} by %{author} failed"
       error: "Rollback of %{stack} to %{sha} by %{author} failed"

data/config/routes.rb

@@ -47,6 +47,7 @@ Shipit::Engine.routes.draw do
   delete '/merge_status/*stack_id/pull/:number', action: :dequeue, controller: :merge_status, id: stack_id_format, as: :dequeue_pull_request
 
   # Humans
+  resources :api_clients
   resources :stacks, only: %i(new create index)
 
   scope '/github/auth/github', as: :github_authentication, controller: :github_authentication do
@@ -61,6 +62,7 @@ Shipit::Engine.routes.draw do
     patch '/' => 'stacks#update'
     delete '/' => 'stacks#destroy'
     get :settings, controller: :stacks
+    get :statistics, controller: :stacks
     post :refresh, controller: :stacks
     get :refresh, controller: :stacks # For easier design, sorry :/
     post :clear_git_cache, controller: :stacks
@@ -74,6 +76,8 @@ Shipit::Engine.routes.draw do
     get '/commit/:sha/checks' => 'commit_checks#show', as: :commit_checks
     get '/commit/:sha/checks/tail' => 'commit_checks#tail', as: :tail_commit_checks, defaults: {format: :json}
 
+    get '/stats' => 'stats#show', as: :stats
+
     resources :rollbacks, only: %i(create)
     resources :commits, only: %i(update)
     resources :tasks, only: %i(show) do

data/db/migrate/20191209231045_create_shipit_repositories.rb

@@ -0,0 +1,12 @@
+class CreateShipitRepositories < ActiveRecord::Migration[6.0]
+  def change
+    create_table :repositories do |t|
+      t.string :owner, limit: 39, null: false
+      t.string :name, limit: 100, null: false
+
+      t.timestamps
+    end
+
+    add_index :repositories, ["owner", "name"], name: "repository_unicity", unique: true
+  end
+end

data/db/migrate/20191209231307_add_repository_reference_to_stacks.rb

@@ -0,0 +1,15 @@
+class AddRepositoryReferenceToStacks < ActiveRecord::Migration[6.0]
+  def up
+    change_table(:stacks) do |t|
+      t.references :repository
+    end
+  end
+
+  def down
+    change_column :stacks, :repo_name, :string, null: false
+    change_column :stacks, :repo_owner, :string, null: false
+    change_table(:stacks) do |t|
+      t.remove_references :repository
+    end
+  end
+end

data/db/migrate/20191216162728_backfill_repository_data.rb

@@ -0,0 +1,22 @@
+class BackfillRepositoryData < ActiveRecord::Migration[6.0]
+  def up
+    repositories = {}
+    Shipit::Stack.all.each do |stack|
+      repo_owner = stack[:repo_owner].downcase
+      repo_name = stack[:repo_name].downcase
+
+      repository = (repositories[[repo_owner, repo_name]] ||= Shipit::Repository.create_or_find_by!(
+        owner: repo_owner,
+        name: repo_name,
+      ))
+
+      stack.update_column(:repository_id, repository.id)
+    end
+  end
+
+  def down
+    Shipit::Repository.find_each do |repository|
+      repository.stacks.update_all(repo_owner: repository.owner, repo_name: repository.name)
+    end
+  end
+end

data/db/migrate/20191216163010_remove_repository_information_from_stacks.rb

@@ -0,0 +1,20 @@
+class RemoveRepositoryInformationFromStacks < ActiveRecord::Migration[6.0]
+  def up
+    change_column_null :stacks, :repository_id, false
+    change_table(:stacks) do |t|
+      t.remove_index ["repo_owner", "repo_name", "environment"]
+      t.remove :repo_owner
+      t.remove :repo_name
+      t.index ["repository_id", "environment"], name: "stack_unicity", unique: true
+    end
+  end
+
+  def down
+    change_table(:stacks) do |t|
+      t.column :repo_name, :string, limit: 100
+      t.column :repo_owner, :string, limit: 39
+      t.remove_index ["repository_id", "environment"]
+      t.index ["repo_owner", "repo_name", "environment"], name: "stack_unicity", unique: true
+    end
+  end
+end

data/db/migrate/20191219205202_add_archived_since_to_stacks.rb

@@ -0,0 +1,6 @@
+class AddArchivedSinceToStacks < ActiveRecord::Migration[6.0]
+  def change
+    add_column :stacks, :archived_since, :datetime
+    add_index :stacks, :archived_since
+  end
+end

data/db/migrate/20200102175621_optional_task_commits.rb

@@ -0,0 +1,6 @@
+class OptionalTaskCommits < ActiveRecord::Migration[6.0]
+  def change
+    change_column_null :tasks, :since_commit_id, true
+    change_column_null :tasks, :until_commit_id, true
+  end
+end

data/db/migrate/20200109132519_add_sha_to_commit_deployments.rb

@@ -0,0 +1,5 @@
+class AddShaToCommitDeployments < ActiveRecord::Migration[6.0]
+  def change
+    add_column :commit_deployments, :sha, :string, limit: 40
+  end
+end

data/lib/shipit/github_app.rb

@@ -9,6 +9,8 @@ module Shipit
         end
       end
 
+      attr_reader :expires_at, :refresh_at
+
       def to_s
         @token
       end
@@ -16,10 +18,16 @@ module Shipit
       def initialize(token, expires_at)
         @token = token
         @expires_at = expires_at
+
+        # This needs to be lower than the token's lifetime, but higher than the cache expiry setting.
+        @refresh_at = expires_at - GITHUB_TOKEN_REFRESH_WINDOW
       end
 
       def blank?
-        @expires_at.past?
+        # Old tokens missing @refresh_at may be used upon deploy, so we should auto-correct for now.
+        # TODO: Remove this assignment at a later date.
+        @refresh_at ||= @expires_at - GITHUB_TOKEN_REFRESH_WINDOW
+        @refresh_at.past?
       end
     end
 
@@ -27,6 +35,10 @@ module Shipit
     AuthenticationFailed = Class.new(StandardError)
     API_STATUS_ID = 'brv1bkgrwx7q'.freeze
 
+    GITHUB_EXPECTED_TOKEN_LIFETIME = 60.minutes
+    GITHUB_TOKEN_RAILS_CACHE_LIFETIME = 50.minutes
+    GITHUB_TOKEN_REFRESH_WINDOW = GITHUB_EXPECTED_TOKEN_LIFETIME - GITHUB_TOKEN_RAILS_CACHE_LIFETIME - 2.minutes
+
     attr_reader :oauth_teams, :domain, :bot_login
 
     def initialize(config)
@@ -79,13 +91,21 @@ module Shipit
     end
 
     def fetch_new_token
-      Rails.cache.fetch('github:integration:access-token', expires_in: 50.minutes, race_condition_ttl: 10.minutes) do
+      # Rails can add 5 minutes to the cache entry expiration time when any TTL is provided,
+      # so our TTL setting can be lower, and TTL + expires_in should be lower than the GitHub token expiration.
+      Rails.cache.fetch(
+        'github:integration:access-token',
+        expires_in: GITHUB_TOKEN_RAILS_CACHE_LIFETIME,
+        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',
         )
         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}"\
+          " and will be refreshed at #{token&.refresh_at}")
         token
       end
     end
@@ -120,12 +140,21 @@ module Shipit
       url('/api/v3/') if enterprise?
     end
 
+    def web_endpoint
+      url if enterprise?
+    end
+
     def enterprise?
       domain != DOMAIN
     end
 
     def new_client(options = {})
-      options.reverse_merge(api_endpoint: api_endpoint) if api_endpoint
+      if enterprise?
+        options = options.reverse_merge(
+          api_endpoint: api_endpoint,
+          web_endpoint: web_endpoint,
+        )
+      end
       client = Octokit::Client.new(options)
       client.middleware = faraday_stack
       client

data/lib/shipit/task_commands.rb

@@ -28,19 +28,21 @@ module Shipit
     end
 
     def env
-      normalized_name = ActiveSupport::Inflector.transliterate(@task.author.name)
       super.merge(
         'ENVIRONMENT' => @stack.environment,
         'BRANCH' => @stack.branch,
-        'SHIPIT_USER' => "#{@task.author.login} (#{normalized_name}) via Shipit",
+        'SHIPIT_USER' => "#{@task.author.login} (#{normalized_author_name}) via Shipit",
         'EMAIL' => @task.author.email,
         'BUNDLE_PATH' => Rails.root.join('data', 'bundler').to_s,
         'SHIPIT_LINK' => @task.permalink,
         'LAST_DEPLOYED_SHA' => @stack.last_deployed_commit.sha,
         'TASK_ID' => @task.id.to_s,
+        'DEPLOY_URL' => @stack.deploy_url,
         '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,
+        'GITHUB_REPO_OWNER' => @stack.repository.owner,
+        'GITHUB_REPO_NAME' => @stack.repository.name,
       ).merge(deploy_spec.machine_env).merge(@task.env)
     end
 
@@ -70,6 +72,12 @@ module Shipit
       FileUtils.rm_rf(@task.working_directory) if deploy_spec.clear_working_directory?
     end
 
+    private
+
+    def normalized_author_name
+      ActiveSupport::Inflector.transliterate(@task.author.name)
+    end
+
     protected
 
     def steps_directory

data/lib/shipit/version.rb

@@ -1,3 +1,3 @@
 module Shipit
-  VERSION = '0.29.0'.freeze
+  VERSION = '0.30.0'.freeze
 end

data/test/controllers/api/ccmenu_controller_test.rb

@@ -43,7 +43,7 @@ module Shipit
       end
 
       test "stacks with no deploys render correctly" do
-        stack = Stack.create!(repo_owner: 'foo', repo_name: 'bar')
+        stack = Stack.create!(repository: Repository.new(owner: "foo", name: "bar"))
         get :show, params: {stack_id: stack.to_param}
         assert_payload 'lastBuildStatus', 'Success'
       end

data/test/controllers/api/stacks_controller_test.rb

@@ -25,7 +25,7 @@ module Shipit
           post :create, params: {repo_owner: 'some', repo_name: 'owner/path'}
         end
         assert_response :unprocessable_entity
-        assert_json 'errors', 'repo_name' => ['is invalid']
+        assert_json 'errors', 'repository' => ['is invalid']
       end
 
       test "#create creates a stack and renders it back" do
@@ -38,19 +38,27 @@ module Shipit
       end
 
       test "#create fails to create stack if it already exists" do
-        Stack.create!(
-          repo_name: 'rails',
-          repo_owner: 'rails',
+        repository = shipit_repositories(:rails)
+        existing_stack = Stack.create!(
+          repository: repository,
           environment: 'staging',
           branch: 'staging',
         )
 
         assert_no_difference -> { Stack.count } do
-          post :create, params: {repo_name: 'rails', repo_owner: 'rails', environment: 'staging', branch: 'staging'}
+          post :create,
+               params: {
+                 repo_name: existing_stack.repo_name,
+                 repo_owner: existing_stack.repo_owner,
+                 environment: existing_stack.environment,
+                 branch: existing_stack.branch,
+               }
         end
 
         assert_response :unprocessable_entity
-        assert_json 'errors', 'repo_name' => ['cannot be used more than once with this environment']
+        assert_json 'errors', 'repository' => [
+          'cannot be used more than once with this environment. Check archived stacks.',
+        ]
       end
 
       test "#index returns a list of stacks" do