Merge branch '173-completely-remove-pendo-integration' into 'master'

Remove Pendo from EE

Closes gitlab-org/growth/product#173

See merge request gitlab-org/gitlab!19400

app/helpers/application_settings_helper.rb

@@ -297,9 +297,7 @@ module ApplicationSettingsHelper
       :snowplow_iglu_registry_url,
       :push_event_hooks_limit,
       :push_event_activities_limit,
-      :custom_http_clone_url_root,
-      :pendo_enabled,
-      :pendo_url
+      :custom_http_clone_url_root
     ]
   end
 

app/models/application_setting.rb

@@ -6,6 +6,12 @@ class ApplicationSetting < ApplicationRecord
   include TokenAuthenticatable
   include ChronicDurationAttribute
 
+  # Only remove this >= %12.6 and >= 2019-12-01
+  self.ignored_columns += %i[
+      pendo_enabled
+      pendo_url
+    ]
+
   add_authentication_token_field :runners_registration_token, encrypted: -> { Feature.enabled?(:application_settings_tokens_optional_encryption, default_enabled: true) ? :optional : :required }
   add_authentication_token_field :health_check_access_token
   add_authentication_token_field :static_objects_external_storage_auth_token
@@ -103,11 +109,6 @@ class ApplicationSetting < ApplicationRecord
             allow_blank: true,
             if: :snowplow_enabled
 
-  validates :pendo_url,
-            presence: true,
-            public_url: true,
-            if: :pendo_enabled
-
   validates :max_attachment_size,
             presence: true,
             numericality: { only_integer: true, greater_than: 0 }

app/models/application_setting_implementation.rb

@@ -135,8 +135,6 @@ module ApplicationSettingImplementation
         snowplow_app_id: nil,
         snowplow_iglu_registry_url: nil,
         custom_http_clone_url_root: nil,
-        pendo_enabled: false,
-        pendo_url: nil,
         productivity_analytics_start_date: Time.now
       }
     end

app/views/admin/application_settings/integrations.html.haml

@@ -7,5 +7,5 @@
 = render_if_exists 'admin/application_settings/slack'
 = render 'admin/application_settings/third_party_offers'
 = render 'admin/application_settings/snowplow'
-= render_if_exists 'admin/application_settings/pendo'
 = render 'admin/application_settings/eks' if Feature.enabled?(:create_eks_clusters)
+

app/views/layouts/_head.html.haml

@@ -90,4 +90,3 @@
   = render 'layouts/google_analytics' if extra_config.has_key?('google_analytics_id')
   = render 'layouts/piwik' if extra_config.has_key?('piwik_url') && extra_config.has_key?('piwik_site_id')
   = render 'layouts/snowplow'
-  = render_if_exists 'layouts/pendo'

db/post_migrate/20191030193050_remove_pendo_from_application_settings.rb

+# frozen_string_literal: true
+
+class RemovePendoFromApplicationSettings < ActiveRecord::Migration[5.2]
+  include Gitlab::Database::MigrationHelpers
+
+  disable_ddl_transaction!
+
+  DOWNTIME = false
+
+  def up
+    remove_column :application_settings, :pendo_enabled
+    remove_column :application_settings, :pendo_url
+  end
+
+  def down
+    add_column_with_default :application_settings, :pendo_enabled, :boolean, default: false, allow_null: false
+    add_column :application_settings, :pendo_url, :string, limit: 255
+  end
+end

db/schema.rb

@@ -342,8 +342,6 @@ ActiveRecord::Schema.define(version: 2019_11_12_115317) do
     t.integer "push_event_hooks_limit", default: 3, null: false
     t.integer "push_event_activities_limit", default: 3, null: false
     t.string "custom_http_clone_url_root", limit: 511
-    t.boolean "pendo_enabled", default: false, null: false
-    t.string "pendo_url", limit: 255
     t.integer "deletion_adjourned_period", default: 7, null: false
     t.date "license_trial_ends_on"
     t.boolean "eks_integration_enabled", default: false, null: false

doc/api/settings.md

@@ -321,8 +321,6 @@ are listed in the descriptions of the relevant settings.
 | `snowplow_enabled`                       | boolean          | no                                   | Enable snowplow tracking. |
 | `snowplow_app_id`                        | string           | no                                   | The Snowplow site name / application id. (e.g. `gitlab`) |
 | `snowplow_iglu_registry_url`             | string           | no                                   | The Snowplow base Iglu Schema Registry URL to use for custom context and self describing events'|
-| `pendo_url`                              | string           | required by: `pendo_enabled`         | The Pendo endpoint url with js snippet. (e.g. `https://cdn.pendo.io/agent/static/your-api-key/pendo.js`) |
-| `pendo_enabled`                          | boolean          | no                                   | Enable pendo tracking. |
 | `terminal_max_session_time`              | integer          | no                                   | Maximum time for web terminal websocket connection (in seconds). Set to `0` for unlimited time. |
 | `terms`                                  | text             | required by: `enforce_terms`         | (**Required by:** `enforce_terms`) Markdown content for the ToS. |
 | `throttle_authenticated_api_enabled`     | boolean          | no                                   | (**If enabled, requires:** `throttle_authenticated_api_period_in_seconds` and `throttle_authenticated_api_requests_per_period`) Enable authenticated API request rate limit. Helps reduce request volume (e.g. from crawlers or abusive bots). |

doc/development/event_tracking/index.md

@@ -68,7 +68,3 @@ Once enabled, tracking events can be inspected locally by either:
 
 - Looking at the network panel of the browser's development tools
 - Using the [Snowplow Chrome Extension](https://chrome.google.com/webstore/detail/snowplow-inspector/maplkdomeamdlngconidoefjpogkmljm).
-
-## Additional libraries
-
-Session tracking is handled by [Pendo](https://www.pendo.io/), which is a purely client library and is a relatively minor development concern but is worth including in this documentation.

ee/app/views/admin/application_settings/_pendo.html.haml

-- expanded = true if !@application_setting.valid? && @application_setting.errors.any? { |k| k.to_s.start_with?('pendo_') }
-%section.settings.as-pendo.no-animate#js-pendo-settings{ class: ('expanded' if expanded) }
-  .settings-header
-    %h4
-      = _('Pendo')
-    %button.btn.btn-default.js-settings-toggle{ type: 'button' }
-      = expanded ? _('Collapse') : _('Expand')
-    %p
-      = _('Configure the %{link} integration.').html_safe % { link: link_to('Pendo', 'https://www.pendo.io/', target: '_blank') }
-  .settings-content
-
-    = form_for @application_setting, url: integrations_admin_application_settings_path(anchor: 'js-pendo-settings'), html: { class: 'fieldset-form' } do |f|
-      = form_errors(@application_setting) if expanded
-
-      %fieldset
-        .form-group
-          .form-check
-            = f.check_box :pendo_enabled, class: 'form-check-input'
-            = f.label :pendo_enabled, _('Enable pendo tracking'), class: 'form-check-label'
-        .form-group
-          = f.label :pendo_url, _('Pendo endpoint'), class: 'label-light'
-          = f.text_field :pendo_url, class: 'form-control', placeholder: 'https://cdn.pendo.io/agent/static/your-api-key/pendo.js'
-
-      = f.submit _('Save changes'), class: 'btn btn-success'

ee/app/views/layouts/_pendo.html.haml

-- return unless Gitlab::CurrentSettings.pendo_enabled?
-
-= javascript_tag nonce: true do
-  :plain
-    ;var trackable = !['1', 'yes'].includes(window.doNotTrack || navigator.doNotTrack || navigator.msDoNotTrack);
-    if (trackable){
-    (function(p,e,n,d,o){var v,w,x,y,z;o=p[d]=p[d]||{};o._q=[];
-    v=['initialize','identify','updateOptions','pageLoad'];for(w=0,x=v.length;w<x;++w)(function(m){
-    o[m]=o[m]||function(){o._q[m===v[0]?'unshift':'push']([m].concat([].slice.call(arguments,0)));};})(v[w]);
-    y=e.createElement(n);y.async=!0;y.src='#{Gitlab::CurrentSettings.pendo_url}';
-    z=e.getElementsByTagName(n)[0];z.parentNode.insertBefore(y,z);})(window,document,'script','pendo');
-
-    pendo.initialize({
-      visitor: {
-        id: '#{current_user&.id}',
-      }
-    });};

ee/changelogs/unreleased/173-completely-remove-pendo-integration.yml

+---
+title: Remove Pendo Snippet
+merge_request: 19400
+author:
+type: removed

lib/api/settings.rb

@@ -147,10 +147,6 @@ module API
         optional :snowplow_cookie_domain, type: String, desc: 'The Snowplow cookie domain'
         optional :snowplow_app_id, type: String, desc: 'The Snowplow site name / application id'
       end
-      optional :pendo_enabled, type: Grape::API::Boolean, desc: 'Enable Pendo tracking'
-      given pendo_enabled: ->(val) { val } do
-        requires :pendo_url, type: String, desc: 'The Pendo url endpoint'
-      end
 
       ApplicationSetting::SUPPORTED_KEY_TYPES.each do |type|
         optional :"#{type}_key_restriction",

locale/gitlab.pot

@@ -6229,9 +6229,6 @@ msgstr ""
 msgid "Enable or disable version check and usage ping."
 msgstr ""
 
-msgid "Enable pendo tracking"
-msgstr ""
-
 msgid "Enable protected paths rate limit"
 msgstr ""
 
@@ -11986,12 +11983,6 @@ msgstr ""
 msgid "Pending"
 msgstr ""
 
-msgid "Pendo"
-msgstr ""
-
-msgid "Pendo endpoint"
-msgstr ""
-
 msgid "People without permission will never get a notification and won't be able to comment."
 msgstr ""
 

spec/helpers/application_settings_helper_spec.rb

@@ -39,7 +39,6 @@ describe ApplicationSettingsHelper do
 
   context 'with tracking parameters' do
     it { expect(visible_attributes).to include(*%i(snowplow_collector_hostname snowplow_cookie_domain snowplow_enabled snowplow_app_id)) }
-    it { expect(visible_attributes).to include(*%i(pendo_enabled pendo_url)) }
   end
 
   describe '.integration_expanded?' do

spec/models/application_setting_spec.rb

@@ -82,22 +82,6 @@ describe ApplicationSetting do
       it { is_expected.to allow_value(nil).for(:snowplow_iglu_registry_url) }
     end
 
-    context 'when pendo is enabled' do
-      before do
-        setting.pendo_enabled = true
-      end
-
-      it { is_expected.not_to allow_value(nil).for(:pendo_url) }
-      it { is_expected.to allow_value(http).for(:pendo_url) }
-      it { is_expected.to allow_value(https).for(:pendo_url) }
-      it { is_expected.not_to allow_value(ftp).for(:pendo_url) }
-      it { is_expected.not_to allow_value('http://127.0.0.1').for(:pendo_url) }
-    end
-
-    context 'when pendo is not enabled' do
-      it { is_expected.to allow_value(nil).for(:pendo_url) }
-    end
-
     context "when user accepted let's encrypt terms of service" do
       before do
         setting.update(lets_encrypt_terms_of_service_accepted: true)

spec/requests/api/settings_spec.rb

@@ -223,54 +223,6 @@ describe API::Settings, 'Settings' do
       end
     end
 
-    context "pendo tracking settings" do
-      let(:settings) do
-        {
-          pendo_url: "https://pendo.example.com",
-          pendo_enabled: true
-        }
-      end
-
-      let(:attribute_names) { settings.keys.map(&:to_s) }
-
-      it "includes the attributes in the API" do
-        get api("/application/settings", admin)
-
-        expect(response).to have_gitlab_http_status(200)
-        attribute_names.each do |attribute|
-          expect(json_response.keys).to include(attribute)
-        end
-      end
-
-      it "allows updating the settings" do
-        put api("/application/settings", admin), params: settings
-
-        expect(response).to have_gitlab_http_status(200)
-        settings.each do |attribute, value|
-          expect(ApplicationSetting.current.public_send(attribute)).to eq(value)
-        end
-      end
-
-      context "missing pendo_url value when pendo_enabled is true" do
-        it "returns a blank parameter error message" do
-          put api("/application/settings", admin), params: { pendo_enabled: true }
-
-          expect(response).to have_gitlab_http_status(400)
-          expect(json_response["error"]).to eq("pendo_url is missing")
-        end
-
-        it "handles validation errors" do
-          put api("/application/settings", admin), params: settings.merge({
-                                                                            pendo_url: nil
-                                                                          })
-
-          expect(response).to have_gitlab_http_status(400)
-          message = json_response["message"]
-          expect(message["pendo_url"]).to include("can't be blank")
-        end
-      end
-    end
-
     context 'EKS integration settings' do
       let(:attribute_names) { settings.keys.map(&:to_s) }
       let(:sensitive_attributes) { %w(eks_secret_access_key) }