Merge branch...

Merge branch '351853-vsa-add-empty-state-at-the-group-level-when-there-are-no-custom-value-streams' into 'master'

[VSA] Add group level empty state

See merge request gitlab-org/gitlab!81774

ee/app/assets/javascripts/analytics/cycle_analytics/components/base.vue

@@ -15,6 +15,7 @@ import { METRICS_REQUESTS } from '../constants';
 import DurationChart from './duration_chart.vue';
 import TypeOfWorkCharts from './type_of_work_charts.vue';
 import ValueStreamAggregationStatus from './value_stream_aggregation_status.vue';
+import ValueStreamEmptyState from './value_stream_empty_state.vue';
 import ValueStreamSelect from './value_stream_select.vue';
 
 export default {
@@ -26,6 +27,7 @@ export default {
     StageTable,
     PathNavigation,
     ValueStreamAggregationStatus,
+    ValueStreamEmptyState,
     ValueStreamFilters,
     ValueStreamMetrics,
     ValueStreamSelect,
@@ -74,9 +76,10 @@ export default {
       'pathNavigationData',
       'isOverviewStageSelected',
       'selectedStageCount',
+      'hasValueStreams',
     ]),
     shouldRenderEmptyState() {
-      return !this.currentGroup && !this.isLoading;
+      return this.isLoadingValueStreams || !this.hasValueStreams;
     },
     shouldDisplayFilters() {
       return !this.errorCode && !this.hasNoAccessError;
@@ -198,24 +201,25 @@ export default {
 </script>
 <template>
   <div>
+    <value-stream-empty-state
+      v-if="shouldRenderEmptyState"
+      :is-loading="isLoadingValueStreams"
+      :empty-state-svg-path="emptyStateSvgPath"
+      :has-date-range-error="!hasDateRangeSet"
+    />
+    <div v-else class="gl-max-w-full">
       <div
         class="gl-mb-3 gl-display-flex gl-flex-direction-column gl-sm-flex-direction-row gl-justify-content-space-between"
       >
         <h3>{{ __('Value Stream Analytics') }}</h3>
         <div class="gl-display-flex gl-flex-direction-row gl-align-items-center gl-mt-0 gl-sm-mt-5">
-        <value-stream-aggregation-status v-if="isAggregationStatusAvailable" :data="aggregation" />
+          <value-stream-aggregation-status
+            v-if="isAggregationStatusAvailable"
+            :data="aggregation"
+          />
           <value-stream-select v-if="shouldDisplayCreateMultipleValueStreams" />
         </div>
       </div>
-    <gl-empty-state
-      v-if="shouldRenderEmptyState"
-      :title="__('Value Stream Analytics can help you determine your team’s velocity')"
-      :description="
-        __('Filter parameters are not valid. Make sure that the end date is after the start date.')
-      "
-      :svg-path="emptyStateSvgPath"
-    />
-    <div v-else class="gl-max-w-full">
       <path-navigation
         v-if="selectedStageReady"
         data-testid="vsa-path-navigation"

ee/app/assets/javascripts/analytics/cycle_analytics/components/value_stream_empty_state.vue

@@ -76,6 +76,7 @@ export default {
       :svg-path="emptyStateSvgPath"
       :title="title"
       :description="description"
+      data-testid="vsa-empty-state"
     >
       <template v-if="!hasDateRangeError" #actions>
         <gl-button

ee/app/assets/javascripts/analytics/cycle_analytics/store/getters.js

@@ -13,6 +13,8 @@ import { DEFAULT_VALUE_STREAM_ID, OVERVIEW_STAGE_CONFIG } from '../constants';
 
 export const hasNoAccessError = (state) => state.errorCode === httpStatus.FORBIDDEN;
 
+export const hasValueStreams = ({ valueStreams }) => Boolean(valueStreams?.length);
+
 export const currentValueStreamId = ({ selectedValueStream }) =>
   selectedValueStream?.id || DEFAULT_VALUE_STREAM_ID;
 

ee/app/controllers/groups/analytics/cycle_analytics/value_streams_controller.rb

@@ -97,7 +97,13 @@ class Groups::Analytics::CycleAnalytics::ValueStreamsController < Groups::Analyt
   end
 
   def value_streams
-    @group.value_streams.preload_associated_models.presence || [in_memory_default_value_stream]
+    value_streams = @group.value_streams.preload_associated_models
+
+    if Feature.enabled?(:use_vsa_aggregated_tables, @group, default_enabled: :yaml)
+      value_streams
+    else
+      value_streams.presence || [in_memory_default_value_stream]
+    end
   end
 
   def in_memory_default_value_stream

ee/app/services/ee/analytics/cycle_analytics/stages/list_service.rb

@@ -11,8 +11,12 @@ module EE
           def execute
             return forbidden unless allowed?
 
+            if parent.is_a?(Group) && ::Feature.enabled?(:use_vsa_aggregated_tables, parent, default_enabled: :yaml)
+              success(persisted_stages)
+            else
               success(persisted_stages.presence || build_default_stages)
             end
+          end
 
           private
 

ee/spec/controllers/groups/analytics/cycle_analytics/stages_controller_spec.rb

@@ -5,6 +5,8 @@ require 'spec_helper'
 RSpec.describe Groups::Analytics::CycleAnalytics::StagesController do
   let_it_be(:user) { create(:user) }
   let_it_be(:group, refind: true) { create(:group) }
+  let_it_be(:stages) { [] }
+  let_it_be(:value_stream) { create(:cycle_analytics_group_value_stream, group: group, name: 'No stage value stream', stages: stages) }
 
   context 'when params have only group_id' do
     let(:params) { { group_id: group } }
@@ -19,6 +21,8 @@ RSpec.describe Groups::Analytics::CycleAnalytics::StagesController do
     end
 
     context 'when use_vsa_aggregated_tables FF is disabled' do
+      let_it_be(:stages) { Gitlab::Analytics::CycleAnalytics::DefaultStages.all }
+
       it_behaves_like 'Value Stream Analytics Stages controller' do
         before do
           stub_feature_flags(use_vsa_aggregated_tables: false)
@@ -28,7 +32,14 @@ RSpec.describe Groups::Analytics::CycleAnalytics::StagesController do
   end
 
   context 'when params have group_id and value_stream_id' do
-    let_it_be(:value_stream) { create(:cycle_analytics_group_value_stream, group: group) }
+    let_it_be(:stages) do
+      [
+        create(:cycle_analytics_group_stage, group: group, name: "Issue", relative_position: 1),
+        create(:cycle_analytics_group_stage, group: group, name: "Code", relative_position: 2)
+      ]
+    end
+
+    let_it_be(:value_stream) { create(:cycle_analytics_group_value_stream, group: group, name: 'First value stream', stages: stages) }
 
     let(:params) { { group_id: group, value_stream_id: value_stream.id } }
     let(:parent) { group }

ee/spec/controllers/groups/analytics/cycle_analytics/value_streams_controller_spec.rb

@@ -16,6 +16,11 @@ RSpec.describe Groups::Analytics::CycleAnalytics::ValueStreamsController do
   end
 
   describe 'GET #index' do
+    context 'when the use_vsa_aggregated_tables feature flag is off' do
+      before do
+        stub_feature_flags(use_vsa_aggregated_tables: false)
+      end
+
       it 'returns an in-memory default value stream' do
         get :index, params: params
 
@@ -25,6 +30,21 @@ RSpec.describe Groups::Analytics::CycleAnalytics::ValueStreamsController do
         expect(json_response.first['id']).to eq(Analytics::CycleAnalytics::Stages::BaseService::DEFAULT_VALUE_STREAM_NAME)
         expect(json_response.first['name']).to eq(Analytics::CycleAnalytics::Stages::BaseService::DEFAULT_VALUE_STREAM_NAME)
       end
+    end
+
+    context 'when the use_vsa_aggregated_tables feature flag is on' do
+      before do
+        stub_feature_flags(use_vsa_aggregated_tables: true)
+      end
+
+      it 'returns an empty array' do
+        get :index, params: params
+
+        expect(response).to have_gitlab_http_status(:ok)
+
+        expect(json_response.size).to eq(0)
+      end
+    end
 
     context 'when persisted value streams present' do
       let!(:value_stream) { create(:cycle_analytics_group_value_stream, group: group) }

ee/spec/features/groups/analytics/cycle_analytics/charts_spec.rb

@@ -6,11 +6,18 @@ RSpec.describe 'Value stream analytics charts', :js do
 
   let_it_be(:user) { create(:user) }
   let_it_be(:group) { create(:group, name: 'CA-test-group') }
-  let_it_be(:group2) { create(:group, name: 'CA-bad-test-group') }
   let_it_be(:project) { create(:project, :repository, namespace: group, group: group, name: 'Cool fun project') }
-  let_it_be(:group_label1) { create(:group_label, group: group) }
-  let_it_be(:group_label2) { create(:group_label, group: group) }
-  let_it_be(:label) { create(:group_label, group: group2) }
+  let_it_be(:group_with_value_stream) { create(:group, name: 'CA-vsa-test-group') }
+  let_it_be(:vsa_group_project) { create(:project, :repository, namespace: group_with_value_stream, group: group_with_value_stream) }
+  let_it_be(:value_stream) { create(:cycle_analytics_group_value_stream, group: group_with_value_stream, name: 'First value stream') }
+  let_it_be(:vsa_stages) do
+    [
+      create(:cycle_analytics_group_stage, group: group_with_value_stream, name: "Issue", relative_position: 1, value_stream: value_stream),
+      create(:cycle_analytics_group_stage, group: group_with_value_stream, name: "Code", relative_position: 2, value_stream: value_stream)
+    ]
+  end
+
+  empty_state_selector = '[data-testid="vsa-empty-state"]'
 
   3.times do |i|
     let_it_be("issue_#{i}".to_sym) { create(:issue, title: "New Issue #{i}", project: project, created_at: 2.days.ago) }
@@ -24,6 +31,7 @@ RSpec.describe 'Value stream analytics charts', :js do
 
   before_all do
     group.add_owner(user)
+    group_with_value_stream.add_owner(user)
   end
 
   before do
@@ -32,15 +40,14 @@ RSpec.describe 'Value stream analytics charts', :js do
     sign_in(user)
   end
 
-  context 'Duration chart' do
-    let(:custom_value_stream_name) { "New created value stream" }
-
-    before do
-      select_group(group)
-
-      create_custom_value_stream(custom_value_stream_name)
+  shared_examples 'has the empty state' do
+    it 'renders the empty state' do
+      expect(page).to have_selector(empty_state_selector)
+      expect(page).to have_text(s_('CycleAnalytics|Custom value streams to measure your DevSecOps lifecycle'))
+    end
   end
 
+  shared_examples 'has the duration chart' do
     it 'displays data for all stages on the overview' do
       page.within('[data-testid="vsa-path-navigation"]') do
         click_button "Overview"
@@ -58,29 +65,23 @@ RSpec.describe 'Value stream analytics charts', :js do
     end
   end
 
-  describe 'Tasks by type chart', :js do
+  shared_examples 'has the tasks by type chart' do
+    context 'with data available' do
       filters_selector = '.js-tasks-by-type-chart-filters'
 
       before do
-      stub_licensed_features(cycle_analytics_for_groups: true, type_of_work_analytics: true)
-
-      project.add_maintainer(user)
+        group_label1 = create(:group_label, group: selected_group)
+        group_label2 = create(:group_label, group: selected_group)
 
-      sign_in(user)
-    end
-
-    context 'enabled' do
-      context 'with data available' do
-        before do
-          mr_issue = create(:labeled_issue, created_at: 5.days.ago, project: create(:project, group: group), labels: [group_label2])
-          create(:merge_request, iid: mr_issue.id, created_at: 3.days.ago, source_project: project, labels: [group_label1, group_label2])
+        mr_issue = create(:labeled_issue, created_at: 5.days.ago, project: create(:project, group: selected_group), labels: [group_label2])
+        create(:merge_request, iid: mr_issue.id, created_at: 3.days.ago, source_project: selected_project, labels: [group_label1, group_label2])
 
         3.times do |i|
-            create(:labeled_issue, created_at: i.days.ago, project: create(:project, group: group), labels: [group_label1])
-            create(:labeled_issue, created_at: i.days.ago, project: create(:project, group: group), labels: [group_label2])
+          create(:labeled_issue, created_at: i.days.ago, project: create(:project, group: selected_group), labels: [group_label1])
+          create(:labeled_issue, created_at: i.days.ago, project: create(:project, group: selected_group), labels: [group_label2])
         end
 
-          select_group(group)
+        select_group(selected_group)
       end
 
       it 'displays the chart' do
@@ -117,7 +118,7 @@ RSpec.describe 'Value stream analytics charts', :js do
 
     context 'no data available' do
       before do
-          select_group(group)
+        select_group(selected_group)
       end
 
       it 'shows the no data available message' do
@@ -127,5 +128,72 @@ RSpec.describe 'Value stream analytics charts', :js do
       end
     end
   end
+
+  describe 'Duration chart', :js do
+    context 'use_vsa_aggregated_tables feature flag off' do
+      before do
+        stub_feature_flags(use_vsa_aggregated_tables: false)
+
+        select_group(group)
+      end
+
+      it_behaves_like 'has the duration chart'
+    end
+
+    context 'use_vsa_aggregated_tables feature flag on' do
+      context 'with no value streams' do
+        before do
+          select_group(group, empty_state_selector)
+        end
+
+        it_behaves_like 'has the empty state'
+      end
+
+      context 'with a value stream' do
+        before do
+          select_group(group_with_value_stream)
+        end
+
+        it_behaves_like 'has the duration chart'
+      end
+    end
+  end
+
+  describe 'Tasks by type chart', :js do
+    before do
+      stub_licensed_features(cycle_analytics_for_groups: true, type_of_work_analytics: true)
+
+      project.add_maintainer(user)
+
+      sign_in(user)
+    end
+
+    context 'use_vsa_aggregated_tables feature flag off' do
+      let(:selected_group) { group }
+      let(:selected_project) { project }
+
+      before do
+        stub_feature_flags(use_vsa_aggregated_tables: false)
+      end
+
+      it_behaves_like 'has the tasks by type chart'
+    end
+
+    context 'use_vsa_aggregated_tables feature flag on' do
+      context 'with no value streams' do
+        before do
+          select_group(group, empty_state_selector)
+        end
+
+        it_behaves_like 'has the empty state'
+      end
+
+      context 'with a value stream' do
+        let(:selected_group) { group_with_value_stream }
+        let(:selected_project) { vsa_group_project }
+
+        it_behaves_like 'has the tasks by type chart'
+      end
+    end
   end
 end

ee/spec/features/groups/analytics/cycle_analytics/filters_and_data_spec.rb

@@ -20,6 +20,8 @@ RSpec.describe 'Group value stream analytics filters and data', :js do
   path_nav_selector = '[data-testid="vsa-path-navigation"]'
   filter_bar_selector = '[data-testid="vsa-filter-bar"]'
   card_metric_selector = '[data-testid="vsa-metrics"] .gl-single-stat'
+  empty_state_selector = '[data-testid="vsa-empty-state"]'
+  empty_stage_state_selector = '.empty-state'
   new_issues_count = 3
 
   new_issues_count.times do |i|
@@ -57,9 +59,9 @@ RSpec.describe 'Group value stream analytics filters and data', :js do
     sign_in(user)
   end
 
-  shared_examples 'empty state' do
+  shared_examples 'empty value stream stage' do
     it 'displays an empty state' do
-      element = page.find('.empty-state')
+      element = page.find(empty_stage_state_selector)
 
       expect(element).to have_content(_("We don't have enough data to show this stage."))
       expect(element.find('.svg-content img')['src']).to have_content('illustrations/analytics/cycle-analytics-empty-chart')
@@ -170,6 +172,41 @@ RSpec.describe 'Group value stream analytics filters and data', :js do
     end
   end
 
+  context 'use_vsa_aggregated_tables feature flag off' do
+    before do
+      stub_feature_flags(use_vsa_aggregated_tables: false)
+
+      select_group(group)
+    end
+
+    it 'does not render the VSA empty state' do
+      expect(page).not_to have_selector(empty_state_selector)
+      expect(page).not_to have_text(s_('CycleAnalytics|Custom value streams to measure your DevSecOps lifecycle'))
+    end
+  end
+
+  context 'use_vsa_aggregated_tables feature flag on' do
+    context 'without a value stream' do
+      before do
+        select_group(group, empty_state_selector)
+      end
+
+      it 'renders the empty value stream state' do
+        expect(page).to have_text(s_('CycleAnalytics|Custom value streams to measure your DevSecOps lifecycle'))
+      end
+    end
+
+    context 'with a value stream' do
+      before do
+        value_stream = create(:cycle_analytics_group_value_stream, group: group, name: 'First value stream')
+        sub_value_stream = create(:cycle_analytics_group_value_stream, group: sub_group, name: 'First sub group value stream')
+
+        Gitlab::Analytics::CycleAnalytics::DefaultStages.all.map do |stage_params|
+          group.cycle_analytics_stages.create!(stage_params.merge(value_stream: value_stream))
+          sub_group.cycle_analytics_stages.create!(stage_params.merge(value_stream: sub_value_stream))
+        end
+      end
+
       context 'without valid query parameters set' do
         context 'with created_after date > created_before date' do
           before do
@@ -186,7 +223,7 @@ RSpec.describe 'Group value stream analytics filters and data', :js do
             select_stage("Issue")
           end
 
-      it_behaves_like 'empty state'
+          it_behaves_like 'empty value stream stage'
         end
       end
 
@@ -258,7 +295,6 @@ RSpec.describe 'Group value stream analytics filters and data', :js do
         end
 
         before do
-      stub_feature_flags(use_vsa_aggregated_tables: false)
           issue.update!(created_at: 5.days.ago)
           create_cycle(user, project, issue, mr, milestone, pipeline)
           create(:labeled_issue, created_at: 5.days.ago, project: create(:project, group: group), labels: [group_label1])
@@ -270,6 +306,9 @@ RSpec.describe 'Group value stream analytics filters and data', :js do
           deploy_master(user, project, environment: 'staging')
           deploy_master(user, project)
 
+          aggregation = Analytics::CycleAnalytics::Aggregation.safe_create_for_group(group)
+          Analytics::CycleAnalytics::AggregatorService.new(aggregation: aggregation).execute
+
           select_group(group)
         end
 
@@ -343,4 +382,6 @@ RSpec.describe 'Group value stream analytics filters and data', :js do
           end
         end
       end
+    end
+  end
 end

ee/spec/features/groups/analytics/cycle_analytics/multiple_value_streams_spec.rb

@@ -18,7 +18,7 @@ RSpec.describe 'Multiple value streams', :js do
 
   let(:extended_form_fields_selector) { '[data-testid="extended-form-fields"]' }
   let(:preset_selector) { '[data-testid="vsa-preset-selector"]' }
-  let!(:default_value_stream) { create(:cycle_analytics_group_value_stream, group: group, name: 'default') }
+  let(:empty_state_selector) { '[data-testid="vsa-empty-state"]' }
 
   3.times do |i|
     let_it_be("issue_#{i}".to_sym) { create(:issue, title: "New Issue #{i}", project: project, created_at: 2.days.ago) }
@@ -198,7 +198,7 @@ RSpec.describe 'Multiple value streams', :js do
     end
   end
 
-  describe 'With a group' do
+  shared_examples 'create group value streams' do
     name = 'group value stream'
 
     before do
@@ -210,7 +210,7 @@ RSpec.describe 'Multiple value streams', :js do
     it_behaves_like 'delete a value stream', name
   end
 
-  describe 'With a sub group' do
+  shared_examples 'create sub group value streams' do
     name = 'sub group value stream'
 
     before do
@@ -221,4 +221,42 @@ RSpec.describe 'Multiple value streams', :js do
     it_behaves_like 'update a value stream', name
     it_behaves_like 'delete a value stream', name
   end
+
+  context 'use_vsa_aggregated_tables feature flag off' do
+    before do
+      stub_feature_flags(use_vsa_aggregated_tables: false)
+    end
+
+    it_behaves_like 'create group value streams'
+    it_behaves_like 'create sub group value streams'
+  end
+
+  context 'use_vsa_aggregated_tables feature flag on' do
+    context 'without a value stream' do
+      before do
+        select_group(group, empty_state_selector)
+      end
+
+      it 'renders the empty state' do
+        expect(page).to have_text(s_('CycleAnalytics|Custom value streams to measure your DevSecOps lifecycle'))
+      end
+
+      it 'can navigate to the create value stream form' do
+        page.find('[data-testid="create-value-stream-button"]').click
+
+        expect(page).to have_selector('[data-testid="value-stream-form-modal"]')
+      end
+    end
+
+    context 'with a value stream' do
+      before do
+        # ensure we have a value stream already available
+        create(:cycle_analytics_group_value_stream, group: group, name: 'default')
+        create(:cycle_analytics_group_value_stream, group: sub_group, name: 'default')
+      end
+
+      it_behaves_like 'create group value streams'
+      it_behaves_like 'create sub group value streams'
+    end
+  end
 end

ee/spec/frontend/analytics/cycle_analytics/components/base_spec.js

@@ -9,6 +9,7 @@ import DurationChart from 'ee/analytics/cycle_analytics/components/duration_char
 import TypeOfWorkCharts from 'ee/analytics/cycle_analytics/components/type_of_work_charts.vue';
 import ValueStreamSelect from 'ee/analytics/cycle_analytics/components/value_stream_select.vue';
 import ValueStreamAggregationStatus from 'ee/analytics/cycle_analytics/components/value_stream_aggregation_status.vue';
+import ValueStreamEmptyState from 'ee/analytics/cycle_analytics/components/value_stream_empty_state.vue';
 import createStore from 'ee/analytics/cycle_analytics/store';
 import waitForPromises from 'helpers/wait_for_promises';
 import {
@@ -195,11 +196,12 @@ describe('EE Value Stream Analytics component', () => {
     expect(wrapper.findComponent(ValueStreamSelect).exists()).toBe(flag);
   };
 
-  describe('without a group', () => {
+  describe('with no value streams', () => {
     beforeEach(async () => {
-      const { group, ...stateWithoutGroup } = initialCycleAnalyticsState;
       mock = new MockAdapter(axios);
-      wrapper = await createComponent({ initialState: stateWithoutGroup });
+      wrapper = await createComponent({
+        initialState: { ...initialCycleAnalyticsState, valueStreams: [] },
+      });
     });
 
     afterEach(() => {
@@ -209,10 +211,10 @@ describe('EE Value Stream Analytics component', () => {
     });
 
     it('displays an empty state', () => {
-      const emptyState = wrapper.findComponent(GlEmptyState);
+      const emptyState = wrapper.findComponent(ValueStreamEmptyState);
 
       expect(emptyState.exists()).toBe(true);
-      expect(emptyState.props('svgPath')).toBe(emptyStateSvgPath);
+      expect(emptyState.props('emptyStateSvgPath')).toBe(emptyStateSvgPath);
     });
 
     it('does not display the metrics cards', () => {

ee/spec/services/analytics/cycle_analytics/stages/list_service_spec.rb

@@ -21,9 +21,25 @@ RSpec.describe Analytics::CycleAnalytics::Stages::ListService do
 
   it_behaves_like 'permission check for Value Stream Analytics Stage services', :cycle_analytics_for_groups
 
-  it 'returns only the default stages' do
+  context 'when the use_vsa_aggregated_tables feature is enabled' do
+    before do
+      stub_feature_flags(use_vsa_aggregated_tables: true)
+    end
+
+    it 'returns empty array' do
+      expect(stages.size).to eq(0)
+    end
+  end
+
+  context 'when the use_vsa_aggregated_tables feature is disabled' do
+    before do
+      stub_feature_flags(use_vsa_aggregated_tables: false)
+    end
+
+    it 'returns the default stages' do
       expect(stages.size).to eq(Gitlab::Analytics::CycleAnalytics::DefaultStages.all.size)
     end
+  end
 
   it 'provides the default stages as non-persisted objects' do
     expect(stages.map(&:id)).to all(be_nil)

ee/spec/support/shared_examples/controllers/analytics/cycle_analytics/shared_stage_shared_examples.rb

@@ -22,7 +22,7 @@ RSpec.shared_examples 'Value Stream Analytics Stages controller' do
       subject
 
       response_start_events = json_response['stages'].map { |s| s['start_event_identifier'] }
-      start_events = Gitlab::Analytics::CycleAnalytics::DefaultStages.all.map { |s| s['start_event_identifier'] }
+      start_events = stages.map { |s| s['start_event_identifier'] }
 
       expect(response_start_events).to eq(start_events)
     end