From 7d5b8993f47f02488cb37811719193d4ecb45e0a Mon Sep 17 00:00:00 2001
From: Bob Van Landuyt <bob@gitlab.com>
Date: Thu, 16 Mar 2017 10:53:48 +0100
Subject: [PATCH] Build project cache key in a helper

---
 app/helpers/ci_status_helper.rb              |  4 ++
 app/helpers/projects_helper.rb               |  7 ++++
 app/views/shared/projects/_project.html.haml |  3 +-
 spec/helpers/ci_status_helper_spec.rb        |  7 ++++
 spec/helpers/projects_helper_spec.rb         | 40 ++++++++++++++++++++
 5 files changed, 59 insertions(+), 2 deletions(-)

diff --git a/app/helpers/ci_status_helper.rb b/app/helpers/ci_status_helper.rb
index a91d19dc347..2de9e0de310 100644
--- a/app/helpers/ci_status_helper.rb
+++ b/app/helpers/ci_status_helper.rb
@@ -59,6 +59,10 @@ module CiStatusHelper
     custom_icon(icon_name)
   end
 
+  def pipeline_status_cache_key(pipeline_status)
+    "pipeline-status/#{pipeline_status.sha}-#{pipeline_status.status}"
+  end
+
   def render_project_pipeline_status(pipeline_status, tooltip_placement: 'auto left')
     project = pipeline_status.project
     path = pipelines_namespace_project_commit_path(
diff --git a/app/helpers/projects_helper.rb b/app/helpers/projects_helper.rb
index 4befeacc135..bd0c2cd661e 100644
--- a/app/helpers/projects_helper.rb
+++ b/app/helpers/projects_helper.rb
@@ -159,6 +159,13 @@ module ProjectsHelper
       choose a GitLab CI Yaml template and commit your changes. #{link_to_autodeploy_doc}".html_safe
   end
 
+  def project_list_cache_key(project)
+    key = [project.namespace.cache_key, project.cache_key, controller.controller_name, controller.action_name, current_application_settings.cache_key, 'v2.3']
+    key << pipeline_status_cache_key(project.pipeline_status) if project.pipeline_status.has_status?
+
+    key
+  end
+
   private
 
   def repo_children_classes(field)
diff --git a/app/views/shared/projects/_project.html.haml b/app/views/shared/projects/_project.html.haml
index 119bdb12390..df21857e1ad 100644
--- a/app/views/shared/projects/_project.html.haml
+++ b/app/views/shared/projects/_project.html.haml
@@ -6,8 +6,7 @@
 - css_class = '' unless local_assigns[:css_class]
 - show_last_commit_as_description = false unless local_assigns[:show_last_commit_as_description] == true && project.commit
 - css_class += " no-description" if project.description.blank? && !show_last_commit_as_description
-- cache_key = [project.namespace.cache_key, project.cache_key, controller.controller_name, controller.action_name, current_application_settings.cache_key, 'v2.3']
-- cache_key.push "pipeline-status/#{project.pipeline_status.sha}-#{project.pipeline_status.status}" if project.pipeline_status.has_status?
+- cache_key = project_list_cache_key(project)
 
 %li.project-row{ class: css_class }
   = cache(cache_key) do
diff --git a/spec/helpers/ci_status_helper_spec.rb b/spec/helpers/ci_status_helper_spec.rb
index 637b02d9388..174cc84a97b 100644
--- a/spec/helpers/ci_status_helper_spec.rb
+++ b/spec/helpers/ci_status_helper_spec.rb
@@ -16,4 +16,11 @@ describe CiStatusHelper do
       helper.ci_icon_for_status(failed_commit.status)
     end
   end
+
+  describe "#pipeline_status_cache_key" do
+    it "builds a cache key for pipeline status" do
+      pipeline_status = Ci::PipelineStatus.new(build(:project), sha: "123abc", status: "success")
+      expect(helper.pipeline_status_cache_key(pipeline_status)).to eq("pipeline-status/123abc-success")
+    end
+  end
 end
diff --git a/spec/helpers/projects_helper_spec.rb b/spec/helpers/projects_helper_spec.rb
index aca0bb1d794..fc6ad6419ac 100644
--- a/spec/helpers/projects_helper_spec.rb
+++ b/spec/helpers/projects_helper_spec.rb
@@ -63,6 +63,46 @@ describe ProjectsHelper do
     end
   end
 
+  describe "#project_list_cache_key" do
+    let(:project) { create(:project) }
+
+    it "includes the namespace" do
+      expect(helper.project_list_cache_key(project)).to include(project.namespace.cache_key)
+    end
+
+    it "includes the project" do
+      expect(helper.project_list_cache_key(project)).to include(project.cache_key)
+    end
+
+    it "includes the controller name" do
+      expect(helper.controller).to receive(:controller_name).and_return("testcontroller")
+
+      expect(helper.project_list_cache_key(project)).to include("testcontroller")
+    end
+
+    it "includes the controller action" do
+      expect(helper.controller).to receive(:action_name).and_return("testaction")
+
+      expect(helper.project_list_cache_key(project)).to include("testaction")
+    end
+
+    it "includes the application settings" do
+      settings = Gitlab::CurrentSettings.current_application_settings
+
+      expect(helper.project_list_cache_key(project)).to include(settings.cache_key)
+    end
+
+    it "includes a version" do
+      expect(helper.project_list_cache_key(project)).to include("v2.3")
+    end
+
+    it "includes the pipeline status when there is a status" do
+      create(:ci_pipeline, :success, project: project, sha: project.commit.sha)
+
+      expect(helper.project_list_cache_key(project)).to include("pipeline-status/#{project.commit.sha}-success")
+    end
+  end
+
   describe 'link_to_member' do
     let(:group)   { create(:group) }
     let(:project) { create(:empty_project, group: group) }