Merge branch 'clusters-group-cte' into 'master'

EE: Clusters hierarchy CTE

See merge request gitlab-org/gitlab-ee!14480

app/models/clusters/clusters_hierarchy.rb

+# frozen_string_literal: true
+
+module Clusters
+  class ClustersHierarchy
+    DEPTH_COLUMN = :depth
+
+    def initialize(clusterable)
+      @clusterable = clusterable
+    end
+
+    # Returns clusters in order from deepest to highest group
+    def base_and_ancestors
+      cte = recursive_cte
+      cte_alias = cte.table.alias(model.table_name)
+
+      model
+        .unscoped
+        .where('clusters.id IS NOT NULL')
+        .with
+        .recursive(cte.to_arel)
+        .from(cte_alias)
+        .order(DEPTH_COLUMN => :asc)
+    end
+
+    private
+
+    attr_reader :clusterable
+
+    def recursive_cte
+      cte = Gitlab::SQL::RecursiveCTE.new(:clusters_cte)
+
+      base_query = case clusterable
+                   when ::Group
+                     group_clusters_base_query
+                   when ::Project
+                     project_clusters_base_query
+                   else
+                     raise ArgumentError, "unknown type for #{clusterable}"
+                   end
+
+      cte << base_query
+      cte << parent_query(cte)
+
+      cte
+    end
+
+    def group_clusters_base_query
+      group_parent_id_alias = alias_as_column(groups[:parent_id], 'group_parent_id')
+      join_sources = ::Group.left_joins(:clusters).join_sources
+
+      model
+        .unscoped
+        .select([clusters_star, group_parent_id_alias, "1 AS #{DEPTH_COLUMN}"])
+        .where(groups[:id].eq(clusterable.id))
+        .from(groups)
+        .joins(join_sources)
+    end
+
+    def project_clusters_base_query
+      projects = ::Project.arel_table
+      project_parent_id_alias = alias_as_column(projects[:namespace_id], 'group_parent_id')
+      join_sources = ::Project.left_joins(:clusters).join_sources
+
+      model
+        .unscoped
+        .select([clusters_star, project_parent_id_alias, "1 AS #{DEPTH_COLUMN}"])
+        .where(projects[:id].eq(clusterable.id))
+        .from(projects)
+        .joins(join_sources)
+    end
+
+    def parent_query(cte)
+      group_parent_id_alias = alias_as_column(groups[:parent_id], 'group_parent_id')
+
+      model
+        .unscoped
+        .select([clusters_star, group_parent_id_alias, cte.table[DEPTH_COLUMN] + 1])
+        .from([cte.table, groups])
+        .joins('LEFT OUTER JOIN cluster_groups ON cluster_groups.group_id = namespaces.id')
+        .joins('LEFT OUTER JOIN clusters ON cluster_groups.cluster_id = clusters.id')
+        .where(groups[:id].eq(cte.table[:group_parent_id]))
+    end
+
+    def model
+      Clusters::Cluster
+    end
+
+    def clusters
+      @clusters ||= model.arel_table
+    end
+
+    def groups
+      @groups ||= ::Group.arel_table
+    end
+
+    def clusters_star
+      @clusters_star ||= clusters[Arel.star]
+    end
+
+    def alias_as_column(value, alias_to)
+      Arel::Nodes::As.new(value, Arel::Nodes::SqlLiteral.new(alias_to))
+    end
+  end
+end

app/models/concerns/deployment_platform.rb

@@ -12,11 +12,26 @@ module DeploymentPlatform
   private
 
   def find_deployment_platform(environment)
-    find_cluster_platform_kubernetes(environment: environment) ||
-      find_group_cluster_platform_kubernetes(environment: environment) ||
+    find_platform_kubernetes(environment) ||
       find_instance_cluster_platform_kubernetes(environment: environment)
   end
 
+  def find_platform_kubernetes(environment)
+    if Feature.enabled?(:clusters_cte)
+      find_platform_kubernetes_with_cte(environment)
+    else
+      find_cluster_platform_kubernetes(environment: environment) ||
+        find_group_cluster_platform_kubernetes(environment: environment)
+    end
+  end
+
+  # EE would override this and utilize environment argument
+  def find_platform_kubernetes_with_cte(_environment)
+    Clusters::ClustersHierarchy.new(self).base_and_ancestors
+      .enabled.default_environment
+      .first&.platform_kubernetes
+  end
+
   # EE would override this and utilize environment argument
   def find_cluster_platform_kubernetes(environment: nil)
     clusters.enabled.default_environment

changelogs/unreleased/clusters-group-cte.yml

+---
+title: Use CTE to fetch clusters hierarchy in single query
+merge_request: 30063
+author:
+type: performance

ee/app/models/concerns/ee/deployment_platform.rb

@@ -4,6 +4,16 @@ module EE
   module DeploymentPlatform
     extend ::Gitlab::Utils::Override
 
+    override :find_platform_kubernetes_with_cte
+    def find_platform_kubernetes_with_cte(environment)
+      return super unless environment && feature_available?(:multiple_clusters)
+
+      ::Clusters::ClustersHierarchy.new(self).base_and_ancestors
+        .enabled
+        .on_environment(environment, relevant_only: true)
+        .first&.platform_kubernetes
+    end
+
     override :find_cluster_platform_kubernetes
     def find_cluster_platform_kubernetes(environment: nil)
       return super unless environment && feature_available?(:multiple_clusters)
@@ -31,7 +41,7 @@ module EE
     def find_instance_cluster_platform_kubernetes(environment: nil)
       return super unless environment && feature_available?(:multiple_clusters)
 
-      ::Clusters::Instance.new.clusters.enabled.on_environment(environment)
+      ::Clusters::Instance.new.clusters.enabled.on_environment(environment, relevant_only: true)
         .first&.platform_kubernetes
     end
   end

ee/spec/models/concerns/ee/deployment_platform_spec.rb

 require 'rails_helper'
 
 describe EE::DeploymentPlatform do
-  describe '#deployment_platform' do
+  shared_examples '#deployment_platform' do
     let(:group) { create(:group) }
     let(:project) { create(:project, group: group) }
 
@@ -265,4 +265,20 @@ describe EE::DeploymentPlatform do
       end
     end
   end
+
+  context 'legacy implementation' do
+    before do
+      stub_feature_flags(clusters_cte: false)
+    end
+
+    include_examples '#deployment_platform'
+  end
+
+  context 'CTE implementation' do
+    before do
+      stub_feature_flags(clusters_cte: true)
+    end
+
+    include_examples '#deployment_platform'
+  end
 end

spec/models/clusters/clusters_hierarchy_spec.rb

+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Clusters::ClustersHierarchy do
+  describe '#base_and_ancestors' do
+    def base_and_ancestors(clusterable)
+      described_class.new(clusterable).base_and_ancestors
+    end
+
+    context 'project in nested group with clusters at every level' do
+      let!(:cluster) { create(:cluster, :project, projects: [project]) }
+      let!(:child) { create(:cluster, :group, groups: [child_group]) }
+      let!(:parent) { create(:cluster, :group, groups: [parent_group]) }
+      let!(:ancestor) { create(:cluster, :group, groups: [ancestor_group]) }
+
+      let(:ancestor_group) { create(:group) }
+      let(:parent_group) { create(:group, parent: ancestor_group) }
+      let(:child_group) { create(:group, parent: parent_group) }
+      let(:project) { create(:project, group: child_group) }
+
+      it 'returns clusters for project' do
+        expect(base_and_ancestors(project)).to eq([cluster, child, parent, ancestor])
+      end
+
+      it 'returns clusters for child_group' do
+        expect(base_and_ancestors(child_group)).to eq([child, parent, ancestor])
+      end
+
+      it 'returns clusters for parent_group' do
+        expect(base_and_ancestors(parent_group)).to eq([parent, ancestor])
+      end
+
+      it 'returns clusters for ancestor_group' do
+        expect(base_and_ancestors(ancestor_group)).to eq([ancestor])
+      end
+    end
+
+    context 'project in a namespace' do
+      let!(:cluster) { create(:cluster, :project) }
+
+      it 'returns clusters for project' do
+        expect(base_and_ancestors(cluster.project)).to eq([cluster])
+      end
+    end
+
+    context 'project in nested group with clusters at some levels' do
+      let!(:child) { create(:cluster, :group, groups: [child_group]) }
+      let!(:ancestor) { create(:cluster, :group, groups: [ancestor_group]) }
+
+      let(:ancestor_group) { create(:group) }
+      let(:parent_group) { create(:group, parent: ancestor_group) }
+      let(:child_group) { create(:group, parent: parent_group) }
+      let(:project) { create(:project, group: child_group) }
+
+      it 'returns clusters for project' do
+        expect(base_and_ancestors(project)).to eq([child, ancestor])
+      end
+
+      it 'returns clusters for child_group' do
+        expect(base_and_ancestors(child_group)).to eq([child, ancestor])
+      end
+
+      it 'returns clusters for parent_group' do
+        expect(base_and_ancestors(parent_group)).to eq([ancestor])
+      end
+
+      it 'returns clusters for ancestor_group' do
+        expect(base_and_ancestors(ancestor_group)).to eq([ancestor])
+      end
+    end
+  end
+end

spec/models/concerns/deployment_platform_spec.rb

@@ -5,7 +5,7 @@ require 'rails_helper'
 describe DeploymentPlatform do
   let(:project) { create(:project) }
 
-  describe '#deployment_platform' do
+  shared_examples '#deployment_platform' do
     subject { project.deployment_platform }
 
     context 'with no Kubernetes configuration on CI/CD, no Kubernetes Service' do
@@ -84,4 +84,20 @@ describe DeploymentPlatform do
       end
     end
   end
+
+  context 'legacy implementation' do
+    before do
+      stub_feature_flags(clusters_cte: false)
+    end
+
+    include_examples '#deployment_platform'
+  end
+
+  context 'CTE implementation' do
+    before do
+      stub_feature_flags(clusters_cte: true)
+    end
+
+    include_examples '#deployment_platform'
+  end
 end