Automatic merge of gitlab-org/gitlab master

changelogs/unreleased/use-json-pretty_generate_in_usage_data_rake_tasks.yml

+---
+title: Add usage data rake tasks to prettify JSON output
+merge_request: 49137
+author:
+type: added

doc/raketasks/README.md

@@ -42,6 +42,7 @@ The following are available Rake tasks:
 | [Repository storage](../administration/raketasks/storage.md)                                        | List and migrate existing projects and attachments from legacy storage to hashed storage. |
 | [Uploads migrate](../administration/raketasks/uploads/migrate.md)                                   | Migrate uploads between storage local and object storage.                                 |
 | [Uploads sanitize](../administration/raketasks/uploads/sanitize.md)                                 | Remove EXIF data from images uploaded to earlier versions of GitLab.                      |
+| [Usage data](../administration/troubleshooting/gitlab_rails_cheat_sheet.md#generate-usage-ping)     | Generate and troubleshoot [Usage Ping](../development/product_analytics/usage_ping.md).|
 | [User management](user_management.md)                                                               | Perform user management tasks.                                                            |
 | [Webhooks administration](web_hooks.md)                                                             | Maintain project Webhooks.                                                                |
 | [X.509 signatures](x509_signatures.md)                                                              | Update X.509 commit signatures, useful if certificate store has changed.                  |

ee/app/helpers/billing_plans_helper.rb

@@ -79,6 +79,21 @@ module BillingPlansHelper
     _('Seats usage data is updated every day at 12:00pm UTC')
   end
 
+  def upgrade_button_css_classes(namespace, plan, is_current_plan)
+    css_classes = %w[btn btn-success gl-button]
+
+    css_classes << 'disabled' if is_current_plan && !namespace.trial_active?
+    css_classes << 'invisible' if plan.deprecated?
+
+    css_classes.join(' ')
+  end
+
+  def available_plans(plans_data, current_plan)
+    return plans_data unless ::Feature.enabled?(:hide_deprecated_billing_plans)
+
+    plans_data.filter { |plan_data| !plan_data.deprecated? || plan_data.code == current_plan&.code }
+  end
+
   private
 
   def plan_purchase_url(group, plan)

ee/app/views/shared/billings/_billing_plan.html.haml

 - purchase_link = plan.purchase_link
+- plan_name = plan.name
+- show_deprecated_plan = ::Feature.enabled?(:hide_deprecated_billing_plans) && plan.deprecated?
+- if show_deprecated_plan
+  - plan_name      += ' (Legacy)'
+  - faq_link_url   = 'https://about.gitlab.com/gitlab-com/#faq'
+  - faq_link_start = '<a href="%{url}" target="_blank" rel="noopener noreferrer">'.html_safe % { url: faq_link_url }
 
-.card.h-100{ class: ("card-active" if is_current) }
+.card.h-100{ class: ("card-active" if is_current || show_deprecated_plan) }
   .card-header.gl-font-weight-bold.d-flex.flex-row.justify-content-between.flex-wrap
     %div
-      = plan.name
+      = plan_name
     - if is_current
       .text-muted
         = _("Current Plan")
 
   .card-body
-    .price-per-month
-      .gl-mr-2
-        = number_to_plan_currency(plan.price_per_month)
+    - if show_deprecated_plan
+      = s_("The %{plan_name} is no longer available to purchase. For more information about how this will impact you, check our %{faq_link_start}frequently asked questions%{faq_link_end}.").html_safe % { plan_name: plan.name, faq_link_start: faq_link_start, faq_link_end: '</a>'.html_safe }
+    - else
+      .price-per-month
+        .gl-mr-2
+          = number_to_plan_currency(plan.price_per_month)
 
-      %ul.conditions.gl-p-0.gl-my-auto
-        %li= s_("BillingPlans|per user")
-        %li= s_("BillingPlans|monthly")
-    .price-per-year.text-left{ class: ("invisible" unless plan.price_per_year > 0) }
-      - price_per_year = number_to_plan_currency(plan.price_per_year)
-      = s_("BillingPlans|billed annually at %{price_per_year}") % { price_per_year: price_per_year }
+        %ul.conditions.gl-p-0.gl-my-auto
+          %li= s_("BillingPlans|per user")
+          %li= s_("BillingPlans|monthly")
+      .price-per-year.text-left{ class: ("invisible" unless plan.price_per_year > 0) }
+        - price_per_year = number_to_plan_currency(plan.price_per_year)
+        = s_("BillingPlans|billed annually at %{price_per_year}") % { price_per_year: price_per_year }
 
-    %hr.gl-my-3
+      %hr.gl-my-3
 
-    %ul.unstyled-list
-      - plan_feature_short_list(plan).each do |feature|
-        - feature_class = "gl-p-0!"
-        - if feature.highlight
-          - feature_class += " gl-font-weight-bold"
-        %li{ class: "#{feature_class}" }
-          = feature.title
-      %li.gl-p-0.gl-pt-3
-        - if plan.about_page_href
-          = link_to s_("BillingPlans|See all %{plan_name} features") % { plan_name: plan.name }, EE::SUBSCRIPTIONS_COMPARISON_URL
+      %ul.unstyled-list
+        - plan_feature_short_list(plan).each do |feature|
+          - feature_class = "gl-p-0!"
+          - if feature.highlight
+            - feature_class += " gl-font-weight-bold"
+          %li{ class: "#{feature_class}" }
+            = feature.title
+        %li.gl-p-0.gl-pt-3
+          - if plan.about_page_href
+            = link_to s_("BillingPlans|See all %{plan_name} features") % { plan_name: plan.name }, EE::SUBSCRIPTIONS_COMPARISON_URL
 
   - if purchase_link
     .card-footer
       .float-right{ class: ("invisible" unless purchase_link.action == 'upgrade' || is_current) }
         - if show_contact_sales_button?(purchase_link.action)
           = link_to s_('BillingPlan|Contact sales'), "#{contact_sales_url}?test=inappcontactsales#{plan.code}", class: "btn btn-success-secondary gl-button", data: { **experiment_tracking_data_for_button_click('contact_sales') }
-        - upgrade_button_class = "disabled" if is_current && !namespace.trial_active?
         - cta_class = '-new' if use_new_purchase_flow?(namespace)
-        = link_to s_('BillingPlan|Upgrade'), plan_purchase_or_upgrade_url(namespace, plan), class: "btn btn-success gl-button #{upgrade_button_class} billing-cta-purchase#{cta_class}", data: { **experiment_tracking_data_for_button_click('upgrade') }
+        - upgrade_button_classes = upgrade_button_css_classes(namespace, plan, is_current)
+        = link_to s_('BillingPlan|Upgrade'), plan_purchase_or_upgrade_url(namespace, plan), class: "#{upgrade_button_classes} billing-cta-purchase#{cta_class}", data: { **experiment_tracking_data_for_button_click('upgrade') }

ee/app/views/shared/billings/_billing_plans.html.haml

@@ -5,8 +5,10 @@
   = render 'shared/billings/billing_plan_header', namespace: namespace, plan: current_plan
 
 - if show_plans?(namespace)
-  .billing-plans.gl-mt-5.row
-    - plans_data.each do |plan|
+  - plans = available_plans(plans_data, current_plan)
+
+  .billing-plans.gl-mt-5.row.justify-content-center
+    - plans.each do |plan|
       - is_default_plan = current_plan.nil? && plan.default?
       - is_current = plan.code == current_plan&.code || is_default_plan
       .col-md-6.col-lg-3.gl-mb-5

ee/config/feature_flags/development/hide_deprecated_billing_plans.yml

+---
+name: hide_deprecated_billing_plans
+introduced_by_url:
+rollout_issue_url:
+milestone: '13.7'
+type: development
+group: group::purchase
+default_enabled: false

ee/spec/features/billings/billing_plans_spec.rb

@@ -18,6 +18,7 @@ RSpec.describe 'Billing plan pages', :feature do
   end
 
   before do
+    stub_feature_flags(hide_deprecated_billing_plans: false)
     stub_experiment_for_subject(contact_sales_btn_in_app: true)
     stub_full_request("#{EE::SUBSCRIPTIONS_URL}/gitlab_plans?plan=#{plan.name}")
       .to_return(status: 200, body: plans_data.to_json)
@@ -479,4 +480,46 @@ RSpec.describe 'Billing plan pages', :feature do
       end
     end
   end
+
+  context 'when ff purchase_deprecated_plans is enabled' do
+    before do
+      stub_feature_flags(hide_deprecated_billing_plans: true)
+    end
+
+    context 'when deprecated plan is active' do
+      let(:plan) { bronze_plan }
+      let!(:subscription) do
+        create(:gitlab_subscription, namespace: namespace, hosted_plan: plan, seats: 15)
+      end
+
+      let(:expected_card_header) { "#{plans_data[1][:name]} (Legacy)" }
+
+      it 'renders the plan card marked as Legacy' do
+        visit profile_billings_path
+
+        page.within('.billing-plans') do
+          panels = page.all('.card')
+          expect(panels.length).to eq(plans_data.length)
+
+          panel_with_legacy_plan = panels[1] # free [0], bronze [1]
+
+          expect(panel_with_legacy_plan.find('.card-header')).to have_content(expected_card_header)
+          expect(panel_with_legacy_plan.find('.card-body')).to have_link('frequently asked questions')
+        end
+      end
+    end
+
+    context 'when deprecated plan is inactive' do
+      let(:plan) { free_plan }
+
+      it 'does not render the card for that plan' do
+        visit profile_billings_path
+
+        page.within('.billing-plans') do
+          panels = page.all('.card')
+          expect(panels.length).to eq(plans_data.length - 1)
+        end
+      end
+    end
+  end
 end

ee/spec/fixtures/gitlab_com_plans.json

@@ -90,7 +90,8 @@
         "purchase_link": {
             "action": "upgrade",
             "href": "http://customers.gitlab.com/subscriptions/new?plan_id=2c92a0ff5a840412015aa3cde86f2ba6"
-        }
+        },
+        "deprecated": true
     },
     {
         "id": "silver-external-id",

ee/spec/helpers/billing_plans_helper_spec.rb

@@ -179,4 +179,58 @@ RSpec.describe BillingPlansHelper do
       helper.plan_purchase_or_upgrade_url(group, plan)
     end
   end
+
+  describe '#upgrade_button_css_classe' do
+    using RSpec::Parameterized::TableSyntax
+
+    let(:plan) { double('Plan', deprecated?: false) }
+
+    it 'returns button-related classes only' do
+      expect(helper.upgrade_button_css_classes(nil, plan, false)).to eq('btn btn-success gl-button')
+    end
+
+    where(:is_current_plan, :trial_active, :result) do
+      false | false | 'btn btn-success gl-button'
+      false | true  | 'btn btn-success gl-button'
+      true  | true  | 'btn btn-success gl-button'
+      true  | false | 'btn btn-success gl-button disabled'
+      false | false | 'btn btn-success gl-button'
+    end
+
+    with_them do
+      let(:namespace) { Hashie::Mash.new(trial_active: trial_active) }
+
+      subject { helper.upgrade_button_css_classes(namespace, plan, is_current_plan) }
+
+      it { is_expected.to include(result) }
+    end
+
+    context 'when plan is deprecated' do
+      let(:deprecated_plan) { double('Plan', deprecated?: true) }
+
+      it 'returns invisible class' do
+        expect(helper.upgrade_button_css_classes(nil, deprecated_plan, false)).to include('invisible')
+      end
+    end
+  end
+
+  describe '#available_plans' do
+    let(:plan) { double('Plan', deprecated?: false, code: 'silver') }
+    let(:deprecated_plan) { double('Plan', deprecated?: true, code: 'bronze') }
+    let(:plans_data) { [plan, deprecated_plan] }
+
+    context 'when namespace is on an active plan' do
+      it 'returns plans without deprecated' do
+        expect(helper.available_plans(plans_data, nil)).to eq([plan])
+      end
+    end
+
+    context 'when namespace is on a deprecated plan' do
+      let(:current_plan) { Hashie::Mash.new(code: 'bronze') }
+
+      it 'returns plans with a deprecated plan' do
+        expect(helper.available_plans(plans_data, current_plan)).to eq(plans_data)
+      end
+    end
+  end
 end

lib/gitlab/usage_data.rb

@@ -769,7 +769,7 @@ module Gitlab
       end
 
       def report_snowplow_events?
-        self_monitoring_project && Feature.enabled?(:product_analytics, self_monitoring_project)
+        self_monitoring_project && Feature.enabled?(:product_analytics_tracking, type: :ops)
       end
 
       def distinct_count_service_desk_enabled_projects(time_period)

lib/tasks/gitlab/usage_data.rake

@@ -12,13 +12,14 @@ namespace :gitlab do
 
     desc 'GitLab | UsageData | Generate usage ping in JSON'
     task generate: :environment do
-      puts Gitlab::UsageData.to_json(force_refresh: true)
+      puts Gitlab::Json.pretty_generate(Gitlab::UsageData.uncached_data)
     end
 
     desc 'GitLab | UsageData | Generate usage ping and send it to Versions Application'
     task generate_and_send: :environment do
       result = SubmitUsagePingService.new.execute
-      puts result.inspect
+
+      puts Gitlab::Json.pretty_generate(result.attributes)
     end
   end
 end

locale/gitlab.pot

@@ -27113,6 +27113,9 @@ msgstr ""
 msgid "The %{link_start}true-up model%{link_end} allows having more users, and additional users will incur a retroactive charge on renewal."
 msgstr ""
 
+msgid "The %{plan_name} is no longer available to purchase. For more information about how this will impact you, check our %{faq_link_start}frequently asked questions%{faq_link_end}."
+msgstr ""
+
 msgid "The %{type} contains the following error:"
 msgid_plural "The %{type} contains the following errors:"
 msgstr[0] ""

spec/lib/gitlab/usage_data_spec.rb

@@ -1313,7 +1313,7 @@ RSpec.describe Gitlab::UsageData, :aggregate_failures do
 
       context 'and product_analytics FF is enabled for it' do
         before do
-          stub_feature_flags(product_analytics: project)
+          stub_feature_flags(product_analytics_tracking: true)
 
           create(:product_analytics_event, project: project, se_category: 'epics', se_action: 'promote')
           create(:product_analytics_event, project: project, se_category: 'epics', se_action: 'promote', collector_tstamp: 2.days.ago)
@@ -1329,7 +1329,7 @@ RSpec.describe Gitlab::UsageData, :aggregate_failures do
 
       context 'and product_analytics FF is disabled' do
         before do
-          stub_feature_flags(product_analytics: false)
+          stub_feature_flags(product_analytics_tracking: false)
         end
 
         it 'returns an empty hash' do